bypass pulling the schema field from C['schema']

Author: lerouxb

package-lock.json

@@ -63,12 +63,14 @@
     "@mongodb-js/mocha-config-devtools": "^1.0.5",
     "@mongodb-js/prettier-config-devtools": "^1.0.2",
     "@mongodb-js/tsconfig-devtools": "^1.0.3",
+    "@mongodb-js/mql-typescript": "^0.2.3",
     "@mongosh/shell-api": "^3.13.0",
     "@types/chai": "^4.2.21",
     "@types/mocha": "^9.1.1",
     "@types/node": "^22.15.30",
     "@types/sinon-chai": "^3.2.5",
     "bson": "^6.10.3",
+    "mongodb": "^6.9.0",
     "chai": "^4.5.0",
     "depcheck": "^1.4.7",
     "eslint": "^7.25.0",

packages/mongodb-ts-autocomplete/package.json

@@ -16,7 +16,19 @@ async function loadSources(sources: Record<string, string>) {
 async function run() {
   const input: Record<string, string> = {
     '/bson.ts': path.join(require.resolve('bson'), '..', '..', 'bson.d.ts'),
-    '/mql.ts': path.join(__dirname, '..', 'src', 'fixtures', 'mql.ts'),
+    '/mongodb.ts': path.join(
+      require.resolve('mongodb'),
+      '..',
+      '..',
+      'mongodb.d.ts',
+    ),
+    '/mql.ts': path.join(
+      require.resolve('@mongodb-js/mql-typescript'),
+      '..',
+      '..',
+      'out',
+      'schema.d.ts',
+    ),
   };
   const files = await loadSources(input);
   const code = `

packages/mongodb-ts-autocomplete/scripts/extract-types.ts

@@ -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 () {
     const completions = await autocompleter.autocomplete('db.foo.find({ fo');
 
     expect(
       completions.filter((c) => /^(foo|bar|baz)$/.test(c.name)),
     ).to.deep.equal([
-      {
-        kind: 'property',
-        name: 'bar',
-        result: 'db.foo.find({ bar',
-      },
-      {
-        kind: 'property',
-        name: 'baz',
-        result: 'db.foo.find({ baz',
-      },
       {
         kind: 'property',
         name: 'foo',
@@ -196,8 +186,8 @@ describe('MongoDBAutocompleter', function () {
       connection.addCollectionSchema(databaseName, collectionName, schema);
       const code = autocompleter.getConnectionCode(connectionId);
       expect(code).to.equal(`
-import * as ShellAPI from '/shell-api.ts';
 import * as bson from '/bson.ts';
+import * as mql from '/mql.ts';
 
 export type ServerSchema = {
   ${JSON.stringify(databaseName)}: {

packages/mongodb-ts-autocomplete/src/autocompleter.spec.ts

@@ -163,7 +163,7 @@ export class MongoDBAutocompleter {
 
     this.autocompleter.updateCode({
       ...autocompleteTypes,
-      '/shell-api.ts': replaceImports(ShellApiText),
+      //'/shell-api.ts': replaceImports(ShellApiText),
     });
   }
 
@@ -176,29 +176,55 @@ export class MongoDBAutocompleter {
 
   getConnectionCode(connectionId: string): string {
     return `
-import * as ShellAPI from '/shell-api.ts';
 import * as bson from '/bson.ts';
+import * as mql from '/mql.ts';
 
 export type ServerSchema = ${this.connectionSchemas[
       connectionId
     ].toTypescriptTypeDefinition()};
 `;
   }
 
-  getCurrentGlobalsCode(connectionId: string, databaseName: string) {
-    return `
-import * as ShellAPI from '/shell-api.ts';
+  getCurrentGlobalsCode(
+    connectionId: string,
+    databaseName: string,
+    schemaType: string,
+  ): string {
+    const template = `
+import * as mql from '/mql.ts';
 import { ServerSchema } from '/${connectionId}.ts';
 
 type CurrentDatabaseSchema = ServerSchema[${JSON.stringify(databaseName)}];
 
+type MyMQLQuery = mql.Query<${schemaType}>;
+
+/*
+This will have to be restructured and cached maybe as part of
+/{connectionId}.ts and not filled in every time we autocomplete, but let's
+just see if it works first.
+*/
+SHELL_API_GOES_HERE
+
 declare global {
-  const db: ShellAPI.DatabaseWithSchema<ServerSchema, CurrentDatabaseSchema>;
-  const rs: ShellAPI.ReplicaSet<ServerSchema, CurrentDatabaseSchema>;
-  const sh: ShellAPI.Shard<ServerSchema, CurrentDatabaseSchema>;
-  const sp: ShellAPI.Streams<ServerSchema, CurrentDatabaseSchema>;
+  const db: DatabaseWithSchema<ServerSchema, CurrentDatabaseSchema>;
+  const rs: ReplicaSet<ServerSchema, CurrentDatabaseSchema>;
+  const sh: Shard<ServerSchema, CurrentDatabaseSchema>;
+  const sp: Streams<ServerSchema, CurrentDatabaseSchema>;
 }
 `;
+
+    const shellAPI = replaceImports(ShellApiText as string)
+      /*
+    Shell API would ideally have this as find(query: MQLQuery,) and then specify type MQLQuery = Document;
+    Then in mongosh' shell-api it is unchanged from what it is now, but MQLQuery,
+    MQLPipeline, etc. are things we can then easily find/replace.
+
+    For now this pattern is just a hack.
+    */
+      .replace('find(query?: Document_2,', 'find(query: MyMQLQuery,');
+
+    // This is just in two steps so we can print the template without all of the shell API.
+    return template.replace('SHELL_API_GOES_HERE', shellAPI);
   }
 
   async autocomplete(code: string): Promise<AutoCompletion[]> {
@@ -232,10 +258,14 @@ declare global {
     this.autocompleter.updateCode({
       [`/${connectionId}.ts`]: this.getConnectionCode(connectionId),
     });
+    const schemaType = collectionNames.includes(collectionName)
+      ? `CurrentDatabaseSchema[${JSON.stringify(collectionName)}]['schema']`
+      : '{}';
     this.autocompleter.updateCode({
       '/current-globals.ts': this.getCurrentGlobalsCode(
         connectionId,
         databaseName,
+        schemaType,
       ),
     });
 

packages/mongodb-ts-autocomplete/src/autocompleter.ts

@@ -1,5 +1,7 @@
 export function replaceImports(code: string) {
   // This just makes it possible to work on mql.ts because then the
   // IDE finds the import.
-  return code.replace(/'bson'/g, "'/bson.ts'");
+  return code
+    .replace(/'bson'/g, "'/bson.ts'")
+    .replace(/'mongodb'/g, "'/mongodb.ts'");
 }

packages/mongodb-ts-autocomplete/src/utils.ts

@@ -165,7 +165,10 @@ function filterDiagnostics(diagnostics: ts.Diagnostic[]): {
       ..._.pick(item, 'messageText'),
     };
 
-    if (result.fileName === '/shell-api.ts') {
+    if (
+      result.fileName === '/shell-api.ts' ||
+      result.fileName === '/current-globals.ts'
+    ) {
       delete result.text;
     }