add stage tests

Author: nirinchev

packages/mql-typescript/mongo-php-library

@@ -11,7 +11,7 @@ type AlternativeType<T> =
   T extends ReadonlyArray<infer U> ? T | RegExpOrString<U> : RegExpOrString<T>;
 type RegExpOrString<T> = T extends string ? Regex | T : T;
 type KeysOfAType<T, Type> = {
-  [k in keyof T]: NonNullable<T[k]> extends Type ? k : never;
+  [k in keyof T]: Extract<T[k], Type> extends never ? never : k;
 }[keyof T];
 type RecordWithStaticFields<T extends Record<string, any>, TValue> = T & {
   [key: string]: TValue | T[keyof T];
@@ -4944,7 +4944,7 @@ export namespace Aggregation.Stage {
        * The pipeline cannot include the $out stage or the $merge stage. Starting in v6.0, the pipeline can contain the Atlas Search $search stage as the first stage inside the pipeline.
        * The pipeline cannot directly access the joined document fields. Instead, define variables for the joined document fields using the let option and then reference the variables in the pipeline stages.
        */
-      pipeline?: Pipeline<S>;
+      pipeline?: UntypedPipeline;
 
       /**
        * Specifies the name of the new array field to add to the input documents. The new array field contains the matching documents from the from collection. If the specified name already exists in the input document, the existing field is overwritten.
@@ -4994,7 +4994,7 @@ export namespace Aggregation.Stage {
       /**
        * The behavior of $merge if a result document and an existing document in the collection have the same value for the specified on field(s).
        */
-      whenMatched?: WhenMatched | Pipeline<S>;
+      whenMatched?: WhenMatched | UntypedPipeline;
 
       /**
        * The behavior of $merge if a result document does not match an existing document in the out collection.
@@ -5036,7 +5036,9 @@ export namespace Aggregation.Stage {
      * Reshapes each document in the stream, such as by adding new fields or removing existing fields. For each input document, outputs one document.
      * @see {@link https://www.mongodb.com/docs/manual/reference/operator/aggregation/project/}
      */
-    $project: {} & { [specification: string]: Expression<S> };
+    $project: {} & {
+      [specification: string]: Expression<S> | ExpressionMap<S>;
+    };
   }
 
   /**
@@ -5292,7 +5294,7 @@ export namespace Aggregation.Stage {
        * An aggregation pipeline to apply to the specified coll.
        * The pipeline cannot include the $out and $merge stages. Starting in v6.0, the pipeline can contain the Atlas Search $search stage as the first stage inside the pipeline.
        */
-      pipeline?: Pipeline<S>;
+      pipeline?: UntypedPipeline;
     };
   }
 
@@ -5452,7 +5454,9 @@ export type Expression<S> =
   | BsonPrimitive
   | FieldExpression<S>
   | FieldPath<S>[];
-export type ExpressionMap<S> = { [k: string]: Expression<S> };
+export type ExpressionMap<S> = {
+  [k: string]: Expression<S> | ExpressionMap<S>;
+};
 export type Stage<S> =
   | StageOperator<S>
   | Aggregation.Stage.$addFields<S>
@@ -5499,6 +5503,7 @@ export type Stage<S> =
   | Aggregation.Stage.$unwind<S>
   | Aggregation.Stage.$vectorSearch<S>;
 export type Pipeline<S> = Stage<S>[];
+export type UntypedPipeline = Pipeline<any>;
 export type Query<S> =
   | QueryOperator<S>
   | Partial<{ [k in keyof S]: Condition<S[k]> }>

packages/mql-typescript/out/schema-export.js

@@ -1619,6 +1619,9 @@ const staticSchemas: SchemaMap = {
     searchMeta: mflixMoviesSchema,
     shardedDataDistribution: dummySchema,
     skip: dummySchema,
+    vectorSearch: {
+      'ANN Filter': mflixMoviesSchema,
+    },
   },
 };
 

packages/mql-typescript/out/schema.ts

@@ -119,9 +119,12 @@ export class SchemaGenerator extends GeneratorBase {
       'FieldExpression<S>',
       'FieldPath<S>[]',
     ],
-    expressionMap_S: [`{ [k: string]: ${this.toTypeName('Expression<S>')} }`],
+    expressionMap_S: [
+      `{ [k: string]: ${this.toTypeName('Expression<S>')} | ${this.toTypeName('ExpressionMap<S>')} }`,
+    ],
     stage_S: [this.toTypeName('StageOperator<S>')],
     pipeline_S: [this.toTypeName('stage<S>[]')],
+    untypedPipeline: [this.toTypeName('Pipeline<any>')],
     query_S: [
       this.toTypeName('QueryOperator<S>'),
       'Partial<{ [k in keyof S]: Condition<S[k]> }>',
@@ -266,8 +269,8 @@ export class SchemaGenerator extends GeneratorBase {
         T extends ReadonlyArray<infer U> ? T | RegExpOrString<U> : RegExpOrString<T>;
       type RegExpOrString<T> = T extends string ? Regex | T : T;
       type KeysOfAType<T, Type> = {
-        [k in keyof T]: NonNullable<T[k]> extends Type ? k : never;
-      }[keyof T];
+        [k in keyof T]: Extract<T[k], Type> extends never ? never : k;
+      }[keyof T]
       type RecordWithStaticFields<T extends Record<string, any>, TValue> = T & {
         [key: string]: TValue | T[keyof T];
       };
@@ -293,6 +296,7 @@ export class SchemaGenerator extends GeneratorBase {
 
     if (this.typeMappings[`${type}_S`]) {
       let genericArg = 'S';
+
       if (syntheticVariables) {
         // If we have synthetic variables for this argument, we need to construct a temporary type and merge it with S
         const syntheticFields = syntheticVariables

packages/mql-typescript/src/driverSchema/static-schemas.ts

@@ -183,16 +183,6 @@ export class TestGenerator extends GeneratorBase {
 
   protected override async generateImpl(yamlFiles: YamlFiles): Promise<void> {
     for await (const file of yamlFiles) {
-      if (
-        file.category !== 'query' &&
-        file.category !== 'expression' &&
-        file.category !== 'accumulator' &&
-        file.category !== 'search'
-      ) {
-        // TODO: enable for others
-        continue;
-      }
-
       const namespace = `${capitalize(file.category)}Operators`;
 
       const basePath = path.resolve(

packages/mql-typescript/src/metaschema.ts

@@ -179,4 +179,90 @@ export const unsupportedAggregations: {
       },
     },
   },
+  stage: {
+    addFields: {
+      'Using Two $addFields Stages': {
+        stage: 1,
+      },
+    },
+    bucket: {
+      'Bucket by Year and Filter by Bucket Results': {
+        stage: 1,
+        comment:
+          'the output field of the $bucket stage generates new fields that are not available statically',
+      },
+    },
+    currentOp: {
+      'Inactive Sessions': {
+        stage: 1,
+        comment:
+          '$currentOp emits new fields that are not available statically',
+      },
+      'Sampled Queries': {
+        stage: 1,
+        comment:
+          '$currentOp emits new fields that are not available statically',
+      },
+    },
+    group: {
+      'Group by Item Having': {
+        stage: 1,
+      },
+      'Group Documents by author': {
+        stage: 1,
+      },
+    },
+    planCacheStats: {
+      'Find Cache Entry Details for a Query Hash': {
+        stage: 1,
+        comment:
+          '$planCacheStats emits new fields that are not available statically',
+      },
+    },
+    replaceRoot: {
+      'with a Document Nested in an Array': {
+        stage: 1,
+        comment: nestedFieldsExplanation,
+      },
+    },
+    replaceWith: {
+      'a Document Nested in an Array': {
+        stage: 1,
+        comment: nestedFieldsExplanation,
+      },
+    },
+    search: {
+      Example: {
+        stage: 3,
+        comment:
+          '$search emits new fields that are not available statically, such as $$SEARCH_META',
+      },
+      'Number Search and Sort': {
+        stage: 0,
+        comment: nestedFieldsExplanation,
+      },
+      'Return Stored Source Fields': {
+        stage: 1,
+        comment: nestedFieldsExplanation,
+      },
+    },
+    set: {
+      'Using Two $set Stages': {
+        stage: 1,
+        comment: 'second $set stage references fields created in the first',
+      },
+    },
+    unset: {
+      'Remove Embedded Fields': {
+        stage: 0,
+        comment: nestedFieldsExplanation,
+      },
+    },
+    unwind: {
+      'Unwind Embedded Arrays': {
+        stage: 1,
+        comment: nestedFieldsExplanation,
+      },
+    },
+  },
 };