add new spec test

Author: baileympearson

test/manual/search-index-management.prose.test.ts

@@ -4,7 +4,7 @@ import { Readable } from 'stream';
 import { clearTimeout, setTimeout as setTimeoutCb } from 'timers';
 import { setInterval } from 'timers/promises';
 
-import { type Collection, type Document, type MongoClient, ObjectId } from '../mongodb';
+import { type Collection, type Document, type MongoClient, ObjectId, MongoServerError } from '../mongodb';
 
 class TimeoutController extends AbortController {
   timeoutId: NodeJS.Timeout;
@@ -283,5 +283,157 @@ describe('Index Management Prose Tests', function () {
         await collection.dropSearchIndex('test-search-index');
       }
     );
+
+    it('Case 7: Driver can successfully handle search index types when creating indexes', metadata, async function () {
+      // 01. Create a collection with the "create" command using a randomly generated name (referred to as `coll0`).
+      const coll0 = await client.db('node-test').collection(new ObjectId().toHexString());
+      {
+        // 02. Create a new search index on `coll0` with the `createSearchIndex` helper. Use the following definition:
+        //     ```typescript
+        //       {
+        //         name: 'test-search-index-case7-implicit',
+        //         definition: {
+        //           mappings: { dynamic: false }
+        //         }
+        //       }
+        //     ```
+        const indexName = await coll0.createSearchIndex({
+          name: 'test-search-index-case7-implicit',
+          definition: {
+            mappings: { dynamic: false }
+          }
+        })
+        // 03. Assert that the command returns the name of the index: `"test-search-index-case7-implicit"`.
+        expect(indexName).to.equal('test-search-index-case7-implicit')
+        // 04. Run `coll0.listSearchIndexes('test-search-index-case7-implicit')` repeatedly every 5 seconds until the following
+        //     condition is satisfied and store the value in a variable `index1`:
+
+        //     - An index with the `name` of `test-search-index-case7-implicit` is present and the index has a field `queryable`
+        //       with a value of `true`.
+
+        const [index1] = await waitForIndexes({
+          predicate: indexes => indexes.every(index => index.queryable),
+          indexNames: 'test-search-index-case7-implicit'
+        });
+
+        // 05. Assert that `index1` has a property `type` whose value is `search`.
+        expect(index1).to.have.property('type', 'search');
+      }
+      {
+        // 06. Create a new search index on `coll0` with the `createSearchIndex` helper. Use the following definition:
+        //     ```typescript
+        //       {
+        //         name: 'test-search-index-case7-explicit',
+        //         type: 'search',
+        //         definition: {
+        //           mappings: { dynamic: false }
+        //         }
+        //       }
+        //     ```
+        const indexName = await coll0.createSearchIndex({
+          name: 'test-search-index-case7-explicit',
+          type: 'search',
+          definition: {
+            mappings: { dynamic: false }
+          }
+        }
+        )
+        // 07. Assert that the command returns the name of the index: `"test-search-index-case7-explicit"`.
+        expect(indexName).to.equal('test-search-index-case7-explicit')
+        // 08. Run `coll0.listSearchIndexes('test-search-index-case7-explicit')` repeatedly every 5 seconds until the following
+        //     condition is satisfied and store the value in a variable `index2`:
+
+        //     - An index with the `name` of `test-search-index-case7-explicit` is present and the index has a field `queryable`
+        //       with a value of `true`.
+
+        const [index2] = await waitForIndexes({
+          predicate: indexes => indexes.every(index => index.queryable),
+          indexNames: 'test-search-index-case7-explicit'
+        });
+        // 09. Assert that `index2` has a property `type` whose value is `search`.
+        expect(index2).to.have.property('type', 'search');
+      }
+      {
+        // 10. Create a new vector search index on `coll0` with the `createSearchIndex` helper. Use the following definition:
+        // ```typescript
+        //   {
+        //     name: 'test-search-index-case7-vector',
+        //     type: 'vectorSearch',
+        //     definition: {
+        //       "fields": [
+        //          {
+        //              "type": "vector",
+        //              "path": "plot_embedding",
+        //              "numDimensions": 1536,
+        //              "similarity": "euclidean",
+        //          },
+        //       ]
+        //     }
+        //   }
+        // ```
+
+        const indexName = await coll0.createSearchIndex({
+          name: 'test-search-index-case7-vector',
+          type: 'vectorSearch',
+          definition: {
+            "fields": [
+              {
+                "type": "vector",
+                "path": "plot_embedding",
+                "numDimensions": 1536,
+                "similarity": "euclidean",
+              },
+            ]
+          }
+        }
+        )
+        // 11. Assert that the command returns the name of the index: `"test-search-index-case7-vector"`.
+        expect(indexName).to.equal("test-search-index-case7-vector");
+        // 12. Run `coll0.listSearchIndexes('test-search-index-case7-vector')` repeatedly every 5 seconds until the following
+        //     condition is satisfied and store the value in a variable `index3`:
+        //     - An index with the `name` of `test-search-index-case7-vector` is present and the index has a field `queryable` with
+        //       a value of `true`.
+        const [index3] = await waitForIndexes({
+          predicate: indexes => indexes.every(index => index.queryable),
+          indexNames: 'test-search-index-case7-vector'
+        });
+
+        // 13. Assert that `index3` has a property `type` whose value is `vectorSearch`.
+        expect(index3).to.have.property('type', 'vectorSearch');
+      }
+      {
+        // 14. Create a new vector search index on `coll0` with the `createSearchIndex` helper. Use the following definition:
+        // ```typescript
+        //   {
+        //     name: 'test-search-index-case7-error',
+        //     definition: {
+        //       "fields": [
+        //          {
+        //              "type": "vector",
+        //              "path": "plot_embedding",
+        //              "numDimensions": 1536,
+        //              "similarity": "euclidean",
+        //          },
+        //       ]
+        //     }
+        //   }
+        // ```
+        const error = await coll0.createSearchIndex({
+          name: 'test-search-index-case7-error',
+              definition: {
+                "fields": [
+                   {
+                       "type": "vector",
+                       "path": "plot_embedding",
+                       "numDimensions": 1536,
+                       "similarity": "euclidean",
+                   },
+                ]
+              }
+        }).catch(e => e)
+        // 15. Assert that the command throws an exception due to the `mappings` field missing.
+        expect(error).to.be.instanceOf(MongoServerError).to.match(/mappings/i);
+      }
+    })
   });
 });