fix(NODE-4423): better type support for nested objects in query & update

[coyotte508]

Description

What is changing?

Better typing for update & query

Is there new documentation needed for these changes?

What is the motivation for this change?

	interface User {
		pet: {
			name: {
				first: string;
				last: string;
			};
		};
	}
	
	// This works when it shouldn't
	const query: mongodb.Filter<User> = { "pet.name": { first: 1 } };
	// This doesn't work when it should
	const update: mongodb.UpdateFilter<User> = { $set: { "pet.name": { first: "a", last: "b" } } };

The second error is a regression. This PR fixes both issues

Tickets:

• https://jira.mongodb.org/browse/NODE-4423
• https://jira.mongodb.org/browse/NODE-4450 (duplicate)

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

[dariakp]

Thanks for the submission! The tests look solid, I'm adding a few clean up items and will revisit once this passes our CI.

[dariakp]

lint fix

[coyotte508]

PS: Would it be possible after this and the previous PR #3259 to get a mention in the release notes for 4.8 and / or be added to https://github.com/mongodb/node-mongodb-native/blob/main/CONTRIBUTORS.md ?

All the best!

[dariakp]

@coyotte508 Apologies for the oversight on the release notes - we always want to give credit to the community for the contributions, so I'll get that fixed right away. The contributors file is currently not maintained, but we have plans to start generating it from github data.

[jaydenseric]

When is this going to be published? I can't use v4.8 it seems due to the problems this PR intends to fix:

[dariakp]

@jaydenseric We're looking to put out a patch tomorrow!

[jer-sen]

@coyotte508 this kind of updates fail type check:

{ $set: { 'aaa.$.bbb': "ccc" } }

{ $set: { 'aaa.$[].bbb': "ccc" } }

{ $set: { 'aaa.$[ddd].bbb': "ccc" } } (arrayFilters option)

Any idea how to fix?

[coyotte508]

@jer-sen for me there are no TS errors, but it's more lax (allows invalid types).

[jer-sen]

@coyotte508 I also have an issue with variables in keys:

{ $set: { [`aaa.${1 + 1}`]: "bbb" } }

It seems that TS give to { [`aaa.${1 + 1}`]: "bbb" } the type Record<string, 'bbb'>.

Any idea how to fix this without a forced cast?

[jer-sen]

@jer-sen for me there are no TS errors, but it's more lax (allows invalid types).

I think it's because I use readonly arrays:

const _: MatchKeysAndValues<{ aaa: { bbb: 'ccc' }[] }> = { 'aaa.$.bbb': 'ccc' }; is ok
const _: MatchKeysAndValues<{ aaa: readonly { bbb: 'ccc' }[] }> = { 'aaa.$.bbb': 'ccc' }; is not ok

Could you improve your PR to handle this case?

[coyotte508]

I think https://github.com/mongodb/node-mongodb-native/blob/main/src/mongo_types.ts#L532 is the problem, you could change [Key, ...NestedPaths<Type[Key]>] to [Key, ...NestedPaths<Type[Key]>] | [Key] like https://github.com/mongodb/node-mongodb-native/blob/main/src/mongo_types.ts#L534 two lines below.

You can do the PR if this changes fixes your issue :), or open an issue for someone of the mongodb team on JIRA.

I'm going on holiday myself!

[jer-sen]

Thanks @coyotte508 but I am a bit lost...
@dariakp maybe you could have a look?

[jer-sen]

@coyotte508 @dariakp I have created:

• an issue in TS repo for variables in keys: Error with multiple templates as indexes microsoft/TypeScript#50220
• a PR for complex nested names which fixes also issue with readonly arrays: fix(NODE-4513): type for nested objects in query & update #3349