Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(NODE-3813): unexpected type conversion of read preference tags #3138

Merged
merged 14 commits into from Feb 11, 2022
Merged

fix(NODE-3813): unexpected type conversion of read preference tags #3138

merged 14 commits into from Feb 11, 2022

Conversation

baileympearson
Copy link
Contributor

@baileympearson baileympearson commented Feb 8, 2022 •
edited

Description

What is changing?

This PR does two things:

  • fixes options parsing for arrays of options.
  • refactors how we parse key-value pairs of options for a particular option. In particular, it removes logic from parsing readPreference that was converting string values to native JS types, causing spec tests to fail
Is there new documentation needed for these changes?

No.

Double check the following

  • Ran npm run check:lint script
  • Self-review completed using the steps outlined here
  • PR title follows the correct format: <type>(NODE-xxxx)<!>: <description>
  • Changes are covered by tests
  • New TODOs have a related JIRA ticket

@baileympearson baileympearson marked this pull request as ready for review February 9, 2022 14:50
@durran durran added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label Feb 9, 2022
@durran
Copy link
Member

durran commented Feb 9, 2022

CSFLE failures unrelated and fixed in #3070

durran
durran requested changes Feb 9, 2022
View reviewed changes
src/connection_string.ts Outdated Show resolved Hide resolved
dariakp
dariakp requested changes Feb 9, 2022
View reviewed changes
Copy link
Contributor

@dariakp dariakp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make sure to either unskip or update the TODO tagged to this ticket in uri_options.spec.test

@baileympearson baileympearson force-pushed the NODE-3813-parse-readpreference-tags-correctly branch from 6545f24 to 991c0eb Compare February 9, 2022 20:01
@durran
Copy link
Member

durran commented Feb 9, 2022

There's an eslint error on latest: https://spruce.mongodb.com/task/mongo_node_driver_next_lint_run_checks_patch_44bbd6e94d58fac9eb07a07e5437662eb6409dc5_62041da20305b97e46960d87_22_02_09_20_01_39/logs?execution=0

durran
durran previously approved these changes Feb 10, 2022
View reviewed changes
@durran durran added Team Review Needs review from team and removed Primary Review In Review with primary reviewer, not yet ready for team's eyes labels Feb 10, 2022
nbbeeken
nbbeeken reviewed Feb 10, 2022
View reviewed changes
src/connection_string.ts Outdated Show resolved Hide resolved
nbbeeken
nbbeeken requested changes Feb 10, 2022
View reviewed changes
src/connection_string.ts Outdated Show resolved Hide resolved
@baileympearson baileympearson force-pushed the NODE-3813-parse-readpreference-tags-correctly branch from a9195e3 to c996fa4 Compare February 10, 2022 18:52
nbbeeken
nbbeeken requested changes Feb 10, 2022
View reviewed changes
src/connection_string.ts Outdated Show resolved Hide resolved
src/connection_string.ts Outdated Show resolved Hide resolved
nbbeeken
nbbeeken requested changes Feb 10, 2022
View reviewed changes
src/connection_string.ts Outdated Show resolved Hide resolved
nbbeeken
nbbeeken requested changes Feb 11, 2022
View reviewed changes
src/connection_string.ts Outdated Show resolved Hide resolved
@baileympearson baileympearson force-pushed the NODE-3813-parse-readpreference-tags-correctly branch from c93902e to 98b1448 Compare February 11, 2022 18:20
nbbeeken
nbbeeken previously approved these changes Feb 11, 2022
View reviewed changes
Copy link
Contributor

@nbbeeken nbbeeken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

dariakp
dariakp reviewed Feb 11, 2022
View reviewed changes
src/connection_string.ts Outdated
for (const [key, _value] of entriesFromString(value)) {
if (validKeys.includes(key)) {
if (key === 'CANONICALIZE_HOST_NAME') {
mechanismProperties[key] = getBoolean(key, _value);
Copy link
Contributor

@dariakp dariakp Feb 11, 2022 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a note that this is probably going to conflict with Durran's PR to expand the CANONICALIZE_HOST_NAME options (#3131)

src/connection_string.ts Outdated
@@ -631,7 +634,28 @@ export const OPTIONS = {
target: 'credentials',
transform({ options, values: [value] }): MongoCredentials {
if (typeof value === 'string') {
value = toRecord(value);
const validKeys = [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we going to intentionally silently ignore invalid keys here? Does this actually produce the same behavior as before?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This array might be unnecessary, the idea was to only translate the type of the keys we know about and leave whatever remains as is (strings). I spoke generally about the options, so that might be where the inspiration came from but I think CANONICALIZE_HOST_NAME, and gssapiCannoncializeHostname (which we need to add here, whoops!) are the only ones that need translating to boolean. the rest can remain as strings

@nbbeeken nbbeeken changed the title fix(NODE-3813): fix parsing of read preference tags fix(NODE-3813): unexpected type conversion of read preference tags Feb 11, 2022
@nbbeeken nbbeeken merged commit 3e7b894 into main Feb 11, 2022
@nbbeeken nbbeeken deleted the NODE-3813-parse-readpreference-tags-correctly branch February 11, 2022 23:24
@baileympearson baileympearson mentioned this pull request Apr 7, 2022
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nbbeeken nbbeeken nbbeeken approved these changes

@dariakp dariakp dariakp approved these changes

@durran durran Awaiting requested review from durran

Assignees
No one assigned
Labels
Team Review Needs review from team
Projects
None yet
Milestone
No milestone
4 participants
@baileympearson @durran @nbbeeken @dariakp