feat: bypass pulling the schema field from C['schema'] MONGOSH-2170 #552
+369
−250
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lerouxb
commented
Jun 25, 2025
| @@ -152,22 +152,12 @@ describe('MongoDBAutocompleter', function () { | |||
| // TODO: We need MONGOSH-2170 so that we can use the generated MQL types via | |||
| // the Shell API to autocomplete fields in | |||
| // ServerSchema[databaseName][collectionName].schema | |||
| it.skip('completes a collection field name in a query', async function () { | |||
| it('completes a collection field name in a query', async function () { | |||
There was a problem hiding this comment.
This test got unskipped, showing it now works.
addaleax
reviewed
Jun 25, 2025
aa24eda to
54c9a9e
Compare
54c9a9e to
0db8a85
Compare
0db8a85 to
b398740
Compare
lerouxb
commented
Jun 26, 2025
|
|
||
| const completions = await autocompleter.autocomplete('db.'); | ||
| expect(completions).to.deep.equal([]); | ||
| for (let i = 0; i < 2; i++) { |
There was a problem hiding this comment.
I just did all these twice so that the caching code gets exercised.
lerouxb
commented
Jun 26, 2025
| } | ||
|
|
||
| // then hit a different collection to make sure the caching works | ||
| const completions = await autocompleter.autocomplete('db.bar.find({ myF'); |
There was a problem hiding this comment.
And then here I check that autocompleting on a different collection does break through the cache.
b398740 to
0d6be54
Compare
lerouxb
commented
Jun 26, 2025
| }); | ||
| } | ||
|
|
||
| debug({ |
There was a problem hiding this comment.
This is handy for debugging the caching:
~/mongo/devtools-shared/packages/mongodb-ts-autocomplete % DEBUG=ts-autocomplete:*,mongodb-ts-autocomplete npm test -- --bail
b2282cd to
d1b8d13
Compare
d1b8d13 to
92e31a5
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is not quite the way this was originally planned to work. For that (and the problems encountered with it) see mongodb-js/mongosh#2478.
In this case shell-api has placeholder types called
MQLQuery,MQLPipelineandMQLDocument which are just (from the point of view of shell-api inside mongosh) aliased toDocument,Document[]andDocument`. So Typescript never sees complicated generics and then never crashes as it recursively tries to figure out.. something.So what we're doing here is find/replace on those three types to alias them to something specific to the active collection that we're doing autocomplete for. ie.
mql.Query<theCollectionSchema>,mql.Pipeline<theCollectionSchema>andmql.Document<theCollectionSchema>. This way the mql types still see the schema generic parameter and therefore we can autocomplete inferred schema field names, but mongosh is none the wiser.This does mean that we have to make a customised shell-api per connection/database/collection which is potentially relatively expensive given that the language server has to parse/analyse a lot of code, so to mitigate that I also added caching so that we only recalculate these types when necessary. This was already a "TODO" for the future anyway.