feat(NODE-4696): add FaaS env information to client metadata #3626

nbbeeken · 2023-04-04T21:45:05Z

Description

What is changing?

Adds getFaasEnv() that gathers environment information as specified
- https://github.com/mongodb/specifications/blob/master/source/mongodb-handshake/handshake.rst#client-env
Modifies makeClientMetadata to build the metadata document with an es map that checks the BSON size of every input preventing us from exceeding 512 bytes
- Map offers a few conveniences over objects: key iteration, element count, set/delete is typical method syntax rather than bracket notation
Introduces an error if driverInfo properties name/version/platform use up the 512 bytes, this would prevent us from having a helloDoc.client.driver.name property which is required server side
if metadata document is at capacity, we will attempt to remove fields from os until it can fit, followed by the same logic for env
- We do predict this is unlikely, but the hard restriction is that we never construct a document larger than 512 bytes.

Is there new documentation needed for these changes?

No mongodb manual changes.

I changed the API docs above MongoOptions, this is made public by the client.options getter and represents the parsed options, the type isn't necessarily an accurate representation of the runtime value because there are properties that are set after SRV lookup.

What is the motivation for this change?

FaaS environments have a unique impact on the driver's approach to it's distributed systems logic (SDAM). If we can better understand the environments & resources being used we can provide the best FaaS experience possible.

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
- Example: feat(NODE-1234)!: rewriting everything in coffeescript
Changes are covered by tests
New TODOs have a related JIRA ticket

nbbeeken · 2023-04-05T16:04:59Z

~~https://spruce.mongodb.com/version/642d9be73e8e86b01cc1498f/tasks~~

https://spruce.mongodb.com/version/642da7647742ae0b86876e30/tasks

src/cmap/handshake/client_metadata.ts

test/unit/cmap/handshake/client_metadata.test.ts

src/cmap/handshake/client_metadata.ts

test/integration/mongodb-handshake/mongodb-handshake.prose.test.ts

test/integration/mongodb-handshake/mongodb-handshake.test.ts

…dates

test/integration/mongodb-handshake/mongodb-handshake.test.ts

src/cmap/handshake/client_metadata.ts

test/integration/mongodb-handshake/mongodb-handshake.prose.test.ts

test/integration/mongodb-handshake/mongodb-handshake.test.ts

test/tools/cmap_spec_runner.ts

test/unit/cmap/handshake/client_metadata.test.ts

Co-authored-by: Daria Pardue <daria.pardue@mongodb.com>

durran · 2023-04-12T12:53:41Z

@dariakp Are your comments all adequately addressed? And @nbbeeken I think we have just one merge conflict now.

…dates

test/unit/cmap/handshake/client_metadata.test.ts

Co-authored-by: Bailey Pearson <bailey.pearson@mongodb.com> Co-authored-by: Daria Pardue <daria.pardue@mongodb.com>

baileympearson added 8 commits April 2, 2023 21:27

FAAS metadata commit

c623356

fix lint

1b86b2d

misc fixes

ed44549

remove truncated client metadata

da62ec4

chore: everything but truncation

a98a423

chore: misc updates

ef58d3f

misc changes

51ae18b

use Int32

6853019

nbbeeken added the wip label Apr 4, 2023

nbbeeken added 7 commits April 5, 2023 13:36

Merge branch 'main' into NODE-4696-faas-metadata-handshake-5x

c81552a

refactor(NODE-4696): use an additive approach toward metadata limit

cc1bf22

test: env omission

21dc9e3

fix

b8108a7

test: make sure there's a failure with too large a document

4be609f

fix: tests

70da1d6

fix: lb mode error

871d208

nbbeeken force-pushed the NODE-4696-faas-metadata-handshake-5x-spec-updates branch from 9aee3fe to 871d208 Compare April 5, 2023 17:36

nbbeeken changed the base branch from NODE-4696-faas-metadata-handshake-5x to main April 5, 2023 17:51

nbbeeken changed the title ~~refactor(NODE-4696): use an additive approach toward metadata limit~~ feat(NODE-4696): add FaaS env information to client metadata Apr 5, 2023

nbbeeken added 2 commits April 5, 2023 18:27

test: os type omission, env omission, merge faas logic

6bccf1e

inheritdoc unsupported

01b9140

nbbeeken removed the wip label Apr 6, 2023

nbbeeken marked this pull request as ready for review April 6, 2023 14:05

nbbeeken mentioned this pull request Apr 6, 2023

feat(NODE-4696): include FAAS metadata in the mongodb handshake #3616

Closed

5 tasks

nbbeeken commented Apr 6, 2023

View reviewed changes

durran self-assigned this Apr 6, 2023

durran added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label Apr 6, 2023

nbbeeken requested a review from durran April 6, 2023 15:20

durran requested changes Apr 7, 2023

View reviewed changes

nbbeeken added Team Review Needs review from team and removed Primary Review In Review with primary reviewer, not yet ready for team's eyes labels Apr 7, 2023

dariakp self-requested a review April 7, 2023 15:11

nbbeeken added 7 commits April 7, 2023 15:29

fix: vercel having aws env vars

8f28668

fix: gcp bool

beba14a

style: early return = no else

d82591d

chore: add comment about vercel

85a4551

Merge branch 'main' into NODE-4696-faas-metadata-handshake-5x-spec-up…

52000e2

…dates

fix: update error message

d20c333

fix: rm vercel_url

69c01d7

baileympearson reviewed Apr 10, 2023

View reviewed changes

test/integration/mongodb-handshake/mongodb-handshake.test.ts Show resolved Hide resolved

nbbeeken requested a review from baileympearson April 11, 2023 17:01

dariakp requested changes Apr 11, 2023

View reviewed changes

nbbeeken and others added 6 commits April 11, 2023 17:34

titles

5cc2efb

Co-authored-by: Daria Pardue <daria.pardue@mongodb.com>

undo cmap change

6c82746

titles2

83f5e6c

Co-authored-by: Daria Pardue <daria.pardue@mongodb.com>

lint

6c4d67d

moved throwing tests

2c9b4c4

fix before/after inside loop

f7b1ea3

nbbeeken requested a review from dariakp April 11, 2023 22:04

Merge branch 'main' into NODE-4696-faas-metadata-handshake-5x-spec-up…

92c0a18

…dates

dariakp reviewed Apr 12, 2023

View reviewed changes

test/unit/cmap/handshake/client_metadata.test.ts Outdated Show resolved Hide resolved

fix: test locations

ec0372f

dariakp approved these changes Apr 12, 2023

View reviewed changes

durran approved these changes Apr 12, 2023

View reviewed changes

durran merged commit 0424080 into main Apr 12, 2023
14 of 19 checks passed

durran deleted the NODE-4696-faas-metadata-handshake-5x-spec-updates branch April 12, 2023 16:00

W-A-James pushed a commit that referenced this pull request Apr 12, 2023

feat(NODE-4696): add FaaS env information to client metadata (#3626)

4c97ffa

Co-authored-by: Bailey Pearson <bailey.pearson@mongodb.com> Co-authored-by: Daria Pardue <daria.pardue@mongodb.com>

baileympearson added a commit that referenced this pull request Apr 13, 2023

feat(NODE-4696): add FaaS env information to client metadata (#3626)

3118fd9

Co-authored-by: Bailey Pearson <bailey.pearson@mongodb.com> Co-authored-by: Daria Pardue <daria.pardue@mongodb.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(NODE-4696): add FaaS env information to client metadata #3626

feat(NODE-4696): add FaaS env information to client metadata #3626

nbbeeken commented Apr 4, 2023 •

edited

nbbeeken commented Apr 5, 2023 •

edited

durran commented Apr 12, 2023

feat(NODE-4696): add FaaS env information to client metadata #3626

feat(NODE-4696): add FaaS env information to client metadata #3626

Conversation

nbbeeken commented Apr 4, 2023 • edited

Description

What is changing?

Is there new documentation needed for these changes?

What is the motivation for this change?

Double check the following

nbbeeken commented Apr 5, 2023 • edited

durran commented Apr 12, 2023

nbbeeken commented Apr 4, 2023 •

edited

nbbeeken commented Apr 5, 2023 •

edited