More fixes: make sure done() called once and only once for async operations. Change annTopK tests to use await/rejects idiom which is easier to understand. Skip the cloud test that tries to connect to support.beta.marklogic.cloud. That DNS name is not resolving as of today.

Author: stevebio

test-basic/annTopK.js

@@ -13,99 +13,89 @@ let serverConfiguration = {};
 const execPlan = pbb.execPlan;
 
 describe('tests for annTopK', function () {
-    this.timeout(5000)
-    before(function (done) {
-        try {
-            testlib.findServerConfiguration(serverConfiguration);
-            setTimeout(() => {
-                if (serverConfiguration.serverVersion < 12) {
-                    this.skip();
-                }
-                done();
-            }, 3000);
-        } catch (error) {
-            done(error);
+    this.timeout(5000);
+    before(async function () {
+        await testlib.findServerConfigurationPromise(serverConfiguration);
+        
+        if (serverConfiguration.serverVersion < 12) {
+            this.skip();
         }
     });
 
-    it('annTopK without PlanAnnTopKOptions', function (done) {
-        execPlan(p
+    it('annTopK without PlanAnnTopKOptions', async function () {
+        const response = await execPlan(p
             .fromView('vectors', 'persons', '')
             .annTopK(10, p.col('embedding'), p.vec.vector([1.1, 2.2, 3.3]), p.col('distance'))
             .orderBy(p.col('name'))
-        )
-            .then(function (response) {
-                verifyResults(response.rows, done);
-            })
-            .catch(error => done(error));
+        );
+        verifyResults(response.rows);
     });
 
-    it('annTopK with PlanAnnTopKOptions as a single string', function (done) {
-        execPlan(p
+    it('annTopK with PlanAnnTopKOptions as a single string', async function () {
+        const response = await execPlan(p
             .fromView('vectors', 'persons', '')
             .annTopK(10, p.col('embedding'), p.vec.vector([1.1, 2.2, 3.3]), p.col('distance'), 'onlyIndex')
             .orderBy(p.col('name'))
-        )
-            .then(function (response) {
-                verifyResults(response.rows, done);
-            })
-            .catch(error => done(error));
+        );
+        verifyResults(response.rows);
     });
 
-    it('annTopK with PlanAnnTopKOptions as an array of string', function (done) {
-        execPlan(p
+    it('annTopK with PlanAnnTopKOptions as an array of string', async function () {
+        const response = await execPlan(p
             .fromView('vectors', 'persons', '')
             .annTopK(10, p.col('embedding'), p.vec.vector([1.1, 2.2, 3.3]), p.col('distance'),
                 ['onlyIndex', "maxDistance=0.15", "searchFactor=1.0"])
             .orderBy(p.col('name'))
-        ).then(function (response) {
-                verifyResults(response.rows, done);
-        }).catch(error => done(error));
+        );
+        verifyResults(response.rows);
     });
 
-    it('annTopK with PlanAnnTopKOptions as a map', function (done) {
+    it('annTopK with PlanAnnTopKOptions as a map', async function () {
         const planAnnTopKOptionsMap = new Map();
         planAnnTopKOptionsMap.set("maxDistance", 0.158454656600952);
         planAnnTopKOptionsMap.set("searchFactor", 10.0);
-        execPlan(p
+        const response = await execPlan(p
             .fromView('vectors', 'persons', '')
             .annTopK(10, p.col('embedding'), p.vec.vector([1.1, 2.2, 3.3]), p.col('distance'),
                 planAnnTopKOptionsMap)
             .orderBy(p.col('name'))
-        )
-            .then(function (response) {
-                verifyResults(response.rows, done);
-            })
-            .catch(error => done(error));
+        );
+        verifyResults(response.rows);
     });
 
-    it('annTopK with invalid PlanAnnTopKOptions', function (done) {
+    it('annTopK with invalid PlanAnnTopKOptions', async function () {
         const planAnnTopKOptionsMap = new Map();
         planAnnTopKOptionsMap.set('invalid', 10.0);
-        try{
-            execPlan(p
-                .fromView('vectors', 'persons', '')
-                .annTopK(10, p.col('embedding'), p.vec.vector([1.1, 2.2, 3.3]), p.col('distance'),
-                    planAnnTopKOptionsMap)
-                .orderBy(p.col('name'))
-            );
-            done(new Error('Expecting an error to be thrown due to invalid key in options argument'));
-        } catch(error){
-            assert(error.message.toString().includes('options argument at 4 of PlanModifyPlan.annTopK() has invalid key- invalid'))
-            done();
-        }
+        
+        await assert.rejects(
+            async () => {
+                await execPlan(p
+                    .fromView('vectors', 'persons', '')
+                    .annTopK(10, p.col('embedding'), p.vec.vector([1.1, 2.2, 3.3]), p.col('distance'),
+                        planAnnTopKOptionsMap)
+                    .orderBy(p.col('name'))
+                );
+            },
+            (error) => {
+                return error.message.toString().includes('options argument at 4 of PlanModifyPlan.annTopK() has invalid key- invalid');
+            }
+        );
     });
 
-    function  verifyResults(rows, done){
-        try {
-            assert(rows.length === 2, 'Expecting both rows in the view to be returned.');
-            assert(rows[0].name.value === 'Alice');
-            assert(rows[0].distance.type === 'xs:float', 'Verifying that the distance column was populated.');
-            assert(rows[1].name.value === 'Bob');
-            assert(rows[1].distance.type === 'xs:float',  'Verifying that the distance column was populated.');
-            done();
-        } catch (error){
-            done(error)
-        }
+    function verifyResults(rows) {
+
+        assert(Array.isArray(rows), 'Expected rows to be an array');
+        assert(rows.length === 2, 'Expecting both rows in the view to be returned.');
+        assert(rows[0].name.value === 'Alice');
+        assert(rows[0].distance.type === 'xs:float', 'Verifying that the distance column was populated.');
+        assert(rows[1].name.value === 'Bob');
+        assert(rows[1].distance.type === 'xs:float',  'Verifying that the distance column was populated.');
+        
+        // Verify each row has the expected structure
+        rows.forEach((row, index) => {
+            assert(row.name && row.name.value, `Row ${index} should have a name with a value`);
+            assert(row.distance && row.distance.type === 'xs:float', 
+                `Row ${index} should have a distance column of type xs:float`);
+        });
     }
 });

test-basic/cloud_authentication-test.js

@@ -36,7 +36,9 @@ describe('cloud-authentication tests', function() {
         }
     });
 
-    it('should throw error with invalid apiKey.', function (done) {
+    // skip for now, support.beta.marklogic.cloud is not working for me. Not sure if this should be in test suite anyway.
+    it.skip('should throw error with invalid apiKey.', function (done) {
+        this.timeout(10000);
         let db = marklogic.createDatabaseClient({
             host: 'support.beta.marklogic.cloud',
             authType: 'cloud',
@@ -47,7 +49,6 @@ describe('cloud-authentication tests', function() {
         try {
             // Also verified that it throws 'Error: User's API Key is expired.' when API key has expired a few seconds ago.
             expect(()=>db.documents.write(writeObject).throws(Error('API Key is not valid.')));
-            done();
         } catch (error) {
             done(error);
         }

test-basic/docColTypes-test.js

@@ -46,6 +46,7 @@ describe('optic-update docColTypes tests', function() {
                 const plan = op.fromParam('bindingParam', null, op.docColTypes(op.col('uri')));
                 const temp = {bindingParam: rows};
                 db.rows.query(plan, null, temp);
+                done(new Error("Expected an error to be thrown due to only 1 argument to fromParam"));
             } catch (e) {
                 e.toString().includes('Error: PlanBuilder.docColTypes takes a maximum of 0 arguments but received: 1');
                 done();

test-basic/documents-data-movement-queryAll.js

@@ -49,14 +49,14 @@ describe('data movement queryAll', function() {
             .result(function(response){
                 done();
             })
-            .catch(err=> done(err))
             .catch(done);
     }));
 
     it('queryAll should throw error if queryType is not cts', function(done){
         try{
             const query = q.directory('/test/dataMovement/requests/queryAll/');
             dbWriter.documents.queryAll(query);
+            done(new Error('Expected an error to be thrown because query is not a cts query.'));
         } catch(err){
             err.toString().should.equal('Error: Query needs to be a cts query.');
             done();
@@ -94,12 +94,12 @@ describe('data movement queryAll', function() {
     });
 
     it('queryAll should throw error if no query is provided',  function (done){
-
         try{
             dbWriter.documents.queryAll();
+            return done(new Error('Expected an error to be thrown because no query was provided'));
         } catch(err){
             err.toString().should.equal('Error: Query cannot be null or undefined.');
-            done();
+            return done();
         }
     });
 
@@ -118,14 +118,14 @@ describe('data movement queryAll', function() {
     });
 
     it('queryAll should throw error with batchSize=100001',  function (done){
-
         try{
             dbWriter.documents.queryAll(query, {
                 batchSize:100001
             });
+            return done(new Error('Expected an error to be thrown because batchSize greater than 100000'));
         } catch(err){
             err.toString().should.equal('Error: batchSize cannot be greater than 100000');
-            done();
+            return done();
         }
     });
 
@@ -259,14 +259,14 @@ describe('data movement queryAll', function() {
     });
 
     it('queryAll should throw error with consistentSnapshot as Integer',  function (done){
-
         try{
             dbWriter.documents.queryAll(query, {
                 consistentSnapshot: 1
             });
+            return done(new Error('Expected an error to be thrown because consistentSnapshot is invalid'));
         } catch(err){
             err.toString().should.equal('Error: consistentSnapshot needs to be a boolean or DatabaseClient.Timestamp object.');
-            done();
+            return done();
         }
     });
 });