feat(NODE-5968): Container and Kubernetes Awareness

[aditi-khare-mongoDB]

Description

Track user usage of containers.

What is changing?

When kubernetes is in process.env, we add a {orchestrator: 'kubernetes'} field to the client.env field of the handshake document (if this does not make the document exceed 512 bytes).

When '/.dockerenv' exists, we add a {runtime: 'docker'} field to the client.env field of the handshake document (if this does not make the document exceed 512 bytes).

Note: We do not unit test docker, but I tested our logic for detecting docker on an EVG Host, ran Docker and detection succeeds for both root and non-root user cases.

Is there new documentation needed for these changes?

No, non-user facing change.

What is the motivation for this change?

Product wants to track user usage of docker and kubernetes.

Release Highlight

Container and Kubernetes Awareness

The Node.js driver now keeps track of container metadata in the client.env.container field of the handshake document.

If space allows, the following metadata will be included in client.env.container:

env?: { 
  container?: {
    orchestrator?: 'kubernetes' // if process.env.KUBERNETES_SERVICE_HOST is set
    runtime?: 'docker' // if the '/.dockerenv' file exists
  } 
}

Note: If neither Kubernetes nor Docker is present, client.env will not have the container property.

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

[baileympearson]

two small comments, otherwise LGTM.

[baileympearson]

we might want to add a catch block, like Anna did when parallelizing dns lookup and srv resolution, so that this doesn't result in an unhandled promise rejection on the off chance it rejects

[nbbeeken]

Good catch.

Why are we calling this up here again? seems like addContainerMetadata has what it needs down in prepareHandshake no?

Could we pass the LimitedSizeDocument down on options a different key?

[baileympearson]

We cache the promise during options parsing so that we only construct the extended metadata once. Then we just await it during every call to connect. Aditi filed https://jira.mongodb.org/browse/NODE-5994 to make metadata private, remove extendedMetadata and just store its result in metadata in driver v7

[nbbeeken]

Ah ok, thanks for the context sorry I missed that.

[aditi-khare-mongoDB]

Added in the catch block!

[baileympearson]

(optional) the original suggestion was intended to make it unnecessary to cache two variables. but we can leave it as-is too.

Suggested change

	if (isDocker == null) {
	dockerPromise ??= fs.access('/.dockerenv').then(
	() => true,
	() => false
	);
	isDocker = await dockerPromise;
	}
	dockerPromise ??= fs.access('/.dockerenv').then(
	() => true,
	() => false
	);
	const isDocker = await dockerPromise;

[aditi-khare-mongoDB]

Sounds good, made the change.