@natlibfi/melinda-rest-api-commons 6.2.0-alpha.0 → 6.2.0-alpha.2

package/test/mongo-error-branches.test.ts

@@ -1,5 +1,5 @@
 import assert from 'node:assert';
-import {test} from 'node:test';
+import {test, after} from 'node:test';
 import {Readable, PassThrough} from 'node:stream';
 import httpStatus from 'http-status';
 import {MongoDriverError} from 'mongodb';
@@ -9,6 +9,9 @@ import createMongoLog from '../src/mongoLog.ts';
 
 const DUMMY_URI = 'mongodb://stub:27017/rest-api';
 const COLLECTION = 'foobar';
+// every test creates its own (stubbed) operators; close them all at the
+// end - close is a no-op for stubbed factories, which is the point
+const stubOperators: any[] = [];
 
 // the deps seam takes unknown-typed dependencies, so plain stub objects
 // are fine to inject (the driver types are never exercised here)
@@ -35,7 +38,9 @@ function makeGridFSBucket(overrides: Record<string, any> = {}) {
  * @param deps the injected stub operator/gridFSBucket
  */
 async function makeMongo(deps: Record<string, any>) {
-  return createMongo(DUMMY_URI, COLLECTION, 'rest-api', deps);
+  const mongo = await createMongo(DUMMY_URI, COLLECTION, 'rest-api', deps);
+  stubOperators.push(mongo);
+  return mongo;
 }
 
 // The 400-guard tests pass intentionally malformed inputs (non-string
@@ -214,6 +219,88 @@ test('checkTimeOut returns false (no crash) when the queueItem does not exist',
   assert.equal(result, false);
 });
 
+// checkAndSetState / checkAndSetImportJobState must report a missing item
+// as 'unchanged' (with a null queueItem) — not as a timeout
+
+test('checkAndSetState returns {status: "unchanged", queueItem: null} when the queueItem does not exist', async () => {
+  const mongo = await makeMongo({
+    operator: makeOperator({findOne: async () => null}),
+    gridFSBucket: makeGridFSBucket()
+  });
+  const result = await mongo.checkAndSetState({correlationId: 'NOPE', state: 'VALIDATING'});
+  assert.deepStrictEqual(result, {status: 'unchanged', queueItem: null});
+});
+
+test('checkAndSetImportJobState returns {status: "unchanged", queueItem: null} when the queueItem does not exist', async () => {
+  const mongo = await makeMongo({
+    operator: makeOperator({findOne: async () => null}),
+    gridFSBucket: makeGridFSBucket()
+  });
+  const result = await mongo.checkAndSetImportJobState({correlationId: 'NOPE', operation: 'FIX', importJobState: 'DONE'});
+  assert.deepStrictEqual(result, {status: 'unchanged', queueItem: null});
+});
+
+// a pre-existing ABORT item must be reported as 'unchanged' (not
+// 'timeout', which is reserved for items aborted by checkTimeOut in this
+// call) and the document must be left untouched
+
+test('checkAndSetState reports a pre-existing ABORT as "unchanged" without writing', async () => {
+  const doc = {correlationId: 'FOO', queueItemState: 'ABORT', errorStatus: 408, errorMessage: 'Timeout in VALIDATING'};
+  const writes: unknown[] = [];
+  const mongo = await makeMongo({
+    operator: makeOperator({
+      findOne: async () => doc,
+      findOneAndUpdate: async (filter: unknown, update: unknown) => {
+        writes.push({filter, update});
+        return doc;
+      }
+    }),
+    gridFSBucket: makeGridFSBucket()
+  });
+  const result = await mongo.checkAndSetState({correlationId: 'FOO', state: 'VALIDATING'});
+  assert.deepStrictEqual(result, {status: 'unchanged', queueItem: doc});
+  assert.deepStrictEqual(writes, []);
+});
+
+test('checkAndSetImportJobState reports a pre-existing ABORT as "unchanged" without writing', async () => {
+  const doc = {correlationId: 'FOO', queueItemState: 'ABORT', errorStatus: 408, errorMessage: 'Timeout in VALIDATING'};
+  const writes: unknown[] = [];
+  const mongo = await makeMongo({
+    operator: makeOperator({
+      findOne: async () => doc,
+      findOneAndUpdate: async (filter: unknown, update: unknown) => {
+        writes.push({filter, update});
+        return doc;
+      }
+    }),
+    gridFSBucket: makeGridFSBucket()
+  });
+  const result = await mongo.checkAndSetImportJobState({correlationId: 'FOO', operation: 'FIX', importJobState: 'DONE'});
+  assert.deepStrictEqual(result, {status: 'unchanged', queueItem: doc});
+  assert.deepStrictEqual(writes, []);
+});
+
+// a pre-existing DONE item is terminal too (like ABORT/ERROR) and must be
+// reported as 'unchanged' without touching the document
+
+test('checkAndSetState reports a pre-existing DONE as "unchanged" without writing', async () => {
+  const doc = {correlationId: 'FOO', queueItemState: 'DONE'};
+  const writes: unknown[] = [];
+  const mongo = await makeMongo({
+    operator: makeOperator({
+      findOne: async () => doc,
+      findOneAndUpdate: async (filter: unknown, update: unknown) => {
+        writes.push({filter, update});
+        return doc;
+      }
+    }),
+    gridFSBucket: makeGridFSBucket()
+  });
+  const result = await mongo.checkAndSetState({correlationId: 'FOO', state: 'VALIDATING'});
+  assert.deepStrictEqual(result, {status: 'unchanged', queueItem: doc});
+  assert.deepStrictEqual(writes, []);
+});
+
 test('setOperation rejects with ApiError 404 for a non-matching correlationId', async () => {
   const mongo = await makeMongo({
     operator: makeOperator({findOne: async () => null}),
@@ -286,21 +373,26 @@ test('createBulk (stream) returns the normalized {correlationId, acknowledged, q
 
 test('checkTimeOut honours MONGO_TIMEOUT_MINUTES (older item than the window is aborted)', async () => {
   process.env['MONGO_TIMEOUT_MINUTES'] = '5';
-  const oldDate = new Date(Date.now() - 4 * 60 * 1000); // 4 min old: fine at 5m, not at 1m
-  const mongo = await makeMongo({
-    operator: makeOperator({
-      findOne: async () => ({
-        correlationId: 'FOO',
-        queueItemState: 'VALIDATING',
-        modificationTime: oldDate,
-        importJobState: {CREATE: 'DONE', UPDATE: 'DONE', FIX: 'DONE'}
-      })
-    }),
-    gridFSBucket: makeGridFSBucket()
-  });
-  const result = await mongo.checkTimeOut({correlationId: 'FOO'});
-  delete process.env['MONGO_TIMEOUT_MINUTES'];
-  assert.equal(result, true);
+  try {
+    const oldDate = new Date(Date.now() - 4 * 60 * 1000); // 4 min old: fine at 5m, not at 1m
+    const mongo = await makeMongo({
+      operator: makeOperator({
+        findOne: async () => ({
+          correlationId: 'FOO',
+          queueItemState: 'VALIDATING',
+          modificationTime: oldDate,
+          importJobState: {CREATE: 'DONE', UPDATE: 'DONE', FIX: 'DONE'}
+        })
+      }),
+      gridFSBucket: makeGridFSBucket()
+    });
+    const result = await mongo.checkTimeOut({correlationId: 'FOO'});
+    assert.equal(result, true);
+  } finally {
+    // restore the env even on failure so a later operator does not inherit a
+    // 5-minute timeout window
+    delete process.env['MONGO_TIMEOUT_MINUTES'];
+  }
 });
 
 // createBulk stream path used to have no error handling on the GridFS
@@ -745,9 +837,17 @@ function makeLogCollection(overrides: Record<string, any> = {}) {
  * @param deps the injected stub collection
  */
 async function makeMongoLog(deps: Record<string, any>) {
-  return createMongoLog(DUMMY_URI, 'rest-api', deps);
+  const mongoLog = await createMongoLog(DUMMY_URI, 'rest-api', deps);
+  stubOperators.push(mongoLog);
+  return mongoLog;
 }
 
+after(async () => {
+  for (const op of stubOperators) {
+    await op.close();
+  }
+});
+
 function mongoErrored500(text: string) {
   return (error: unknown) => {
     assert.ok(error instanceof ApiError);

package/test/mongo-get-one.test.ts

@@ -8,6 +8,7 @@ import {getMongoOperator, handleError} from './testUtils.ts';
 
 
 let mongoFixtures: any;
+const openedOperators: any[] = [];
 const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:get-one:test');
 
 generateTests({
@@ -34,6 +35,10 @@ generateTests({
     },
     after: async () => {
       //debug(`<< After`);
+      // close the operators the tests opened (one per test) before the server
+      for (const op of openedOperators) {
+        await op.close();
+      }
       await mongoFixtures.close();
     }
   }
@@ -60,6 +65,7 @@ async function callback(callbackParams: Record<string, any>) {
   } = callbackParams;
 
   const mongoOperator = await getMongoOperator(mongoFixtures);
+  openedOperators.push(mongoOperator);
   //const expectedResult = await getFixture('expectedResult.json');
 
   await doPreFillDb(preFillDb);

package/test/mongo-get-stream.test.ts

@@ -7,6 +7,7 @@ import createDebugLogger from 'debug';
 import {getMongoOperator, handleError, streamToString} from './testUtils.ts';
 
 let mongoFixtures: any;
+const openedOperators: any[] = [];
 const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:get-stream:test');
 
 generateTests({
@@ -33,6 +34,10 @@ generateTests({
     },
     after: async () => {
       //debug(`<< After`);
+      // close the operators the tests opened (one per test) before the server
+      for (const op of openedOperators) {
+        await op.close();
+      }
       await mongoFixtures.close();
     }
   }
@@ -60,6 +65,7 @@ async function callback(callbackParams: Record<string, any>) {
   } = callbackParams;
 
   const mongoOperator = await getMongoOperator(mongoFixtures);
+  openedOperators.push(mongoOperator);
   //const expectedResult = await getFixture('expectedResult.json');
 
   await doPreFillDb(preFillDb);

package/test/mongo-push-ids.test.ts

@@ -7,6 +7,7 @@ import {getMongoOperator, handleError, compareToFirstDbEntry} from './testUtils.
 
 
 let mongoFixtures: any;
+const openedOperators: any[] = [];
 const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:push-ids:test');
 
 generateTests({
@@ -33,6 +34,10 @@ generateTests({
     },
     after: async () => {
       //debug(`<< After`);
+      // close the operators the tests opened (one per test) before the server
+      for (const op of openedOperators) {
+        await op.close();
+      }
       await mongoFixtures.close();
     }
   }
@@ -59,6 +64,7 @@ async function callback(callbackParams: Record<string, any>) {
   } = callbackParams;
 
   const mongoOperator = await getMongoOperator(mongoFixtures);
+  openedOperators.push(mongoOperator);
   const expectedResult = await getFixture('expectedResult.json');
 
   await doPreFillDb(preFillDb);

package/test/mongo-push-messages.test.ts

@@ -7,6 +7,7 @@ import createDebugLogger from 'debug';
 import {getMongoOperator, handleError, compareToFirstDbEntry} from './testUtils.ts';
 
 let mongoFixtures: any;
+const openedOperators: any[] = [];
 const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:push-messages:test');
 
 generateTests({
@@ -33,6 +34,10 @@ generateTests({
     },
     after: async () => {
       //debug(`<< After`);
+      // close the operators the tests opened (one per test) before the server
+      for (const op of openedOperators) {
+        await op.close();
+      }
       await mongoFixtures.close();
     }
   }
@@ -59,6 +64,7 @@ async function callback(callbackParams: Record<string, any>) {
   } = callbackParams;
 
   const mongoOperator = await getMongoOperator(mongoFixtures);
+  openedOperators.push(mongoOperator);
   const expectedResult = await getFixture('expectedResult.json');
 
   await doPreFillDb(preFillDb);

package/test/mongo-query-by-id.test.ts

@@ -8,6 +8,7 @@ import {getMongoOperator, handleError, compareToDbEntry, formatQueueItem} from '
 
 
 let mongoFixtures: any;
+const openedOperators: any[] = [];
 const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:query-by-id:test');
 
 generateTests({
@@ -34,6 +35,10 @@ generateTests({
     },
     after: async () => {
       //debug(`<< After`);
+      // close the operators the tests opened (one per test) before the server
+      for (const op of openedOperators) {
+        await op.close();
+      }
       await mongoFixtures.close();
     }
   }
@@ -63,6 +68,7 @@ async function callback(callbackParams: Record<string, any>) {
   } = callbackParams;
 
   const mongoOperator = await getMongoOperator(mongoFixtures);
+  openedOperators.push(mongoOperator);
   const expectedResult = await getFixture('expectedResult.json');
 
   await doPreFillDb(preFillDb);

package/test/mongo-query.test.ts

@@ -7,6 +7,7 @@ import createDebugLogger from 'debug';
 import {getMongoOperator, handleError} from './testUtils.ts';
 
 let mongoFixtures: any;
+const openedOperators: any[] = [];
 const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:test');
 
 generateTests({
@@ -33,6 +34,10 @@ generateTests({
     },
     after: async () => {
       //debug(`<< After`);
+      // close the operators the tests opened (one per test) before the server
+      for (const op of openedOperators) {
+        await op.close();
+      }
       await mongoFixtures.close();
     }
   }
@@ -59,6 +64,7 @@ async function callback(callbackParams: Record<string, any>) {
   } = callbackParams;
 
   const mongoOperator = await getMongoOperator(mongoFixtures);
+  openedOperators.push(mongoOperator);
   //const expectedResult = await getFixture('expectedResult.json');
 
   await doPreFillDb(preFillDb);

package/test/mongo-read-content.test.ts

@@ -8,6 +8,7 @@ import {getMongoOperator, handleError, streamToString} from './testUtils.ts';
 
 
 let mongoFixtures: any;
+const openedOperators: any[] = [];
 const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:read-content:test');
 
 generateTests({
@@ -34,6 +35,10 @@ generateTests({
     },
     after: async () => {
       //debug(`<< After`);
+      // close the operators the tests opened (one per test) before the server
+      for (const op of openedOperators) {
+        await op.close();
+      }
       await mongoFixtures.close();
     }
   }
@@ -61,6 +66,7 @@ async function callback(callbackParams: Record<string, any>) {
   } = callbackParams;
 
   const mongoOperator = await getMongoOperator(mongoFixtures);
+  openedOperators.push(mongoOperator);
   //const expectedResult = await getFixture('expectedResult.json');
 
   await doPreFillDb(preFillDb);

package/test/mongo-remove.test.ts

@@ -8,6 +8,7 @@ import {getMongoOperator, handleError, compareToFirstDbEntry} from './testUtils.
 
 
 let mongoFixtures: any;
+const openedOperators: any[] = [];
 const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:remove:test');
 
 generateTests({
@@ -34,6 +35,10 @@ generateTests({
     },
     after: async () => {
       //debug(`<< After`);
+      // close the operators the tests opened (one per test) before the server
+      for (const op of openedOperators) {
+        await op.close();
+      }
       await mongoFixtures.close();
     }
   }
@@ -64,6 +69,7 @@ async function callback(callbackParams: Record<string, any>) {
   } = callbackParams;
 
   const mongoOperator = await getMongoOperator(mongoFixtures);
+  openedOperators.push(mongoOperator);
   const expectedResult = await getFixture('expectedResult.json');
 
   await doPreFillDb(preFillDb);

package/test/mongo-set-blob-size.test.ts

@@ -7,6 +7,7 @@ import createDebugLogger from 'debug';
 import {getMongoOperator, handleError, compareToFirstDbEntry} from './testUtils.ts';
 
 let mongoFixtures: any;
+const openedOperators: any[] = [];
 const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:set-blob-size:test');
 
 generateTests({
@@ -33,6 +34,10 @@ generateTests({
     },
     after: async () => {
       //debug(`<< After`);
+      // close the operators the tests opened (one per test) before the server
+      for (const op of openedOperators) {
+        await op.close();
+      }
       await mongoFixtures.close();
     }
   }
@@ -59,6 +64,7 @@ async function callback(callbackParams: Record<string, any>) {
   } = callbackParams;
 
   const mongoOperator = await getMongoOperator(mongoFixtures);
+  openedOperators.push(mongoOperator);
   const expectedResult = await getFixture('expectedResult.json');
 
   await doPreFillDb(preFillDb);

package/test/mongo-set-import-job-state.test.ts

@@ -8,6 +8,7 @@ import {getMongoOperator, handleError, compareToFirstDbEntry} from './testUtils.
 
 
 let mongoFixtures: any;
+const openedOperators: any[] = [];
 const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:set-import-job-state:test');
 
 generateTests({
@@ -34,6 +35,10 @@ generateTests({
     },
     after: async () => {
       //debug(`<< After`);
+      // close the operators the tests opened (one per test) before the server
+      for (const op of openedOperators) {
+        await op.close();
+      }
       await mongoFixtures.close();
     }
   }
@@ -60,6 +65,7 @@ async function callback(callbackParams: Record<string, any>) {
   } = callbackParams;
 
   const mongoOperator = await getMongoOperator(mongoFixtures);
+  openedOperators.push(mongoOperator);
   const expectedResult = await getFixture('expectedResult.json');
 
   await doPreFillDb(preFillDb);

package/test/mongo-set-operation.test.ts

@@ -7,6 +7,7 @@ import createDebugLogger from 'debug';
 import {getMongoOperator, handleError, compareToFirstDbEntry} from './testUtils.ts';
 
 let mongoFixtures: any;
+const openedOperators: any[] = [];
 const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:set-operation:test');
 
 generateTests({
@@ -33,6 +34,10 @@ generateTests({
     },
     after: async () => {
       //debug(`<< After`);
+      // close the operators the tests opened (one per test) before the server
+      for (const op of openedOperators) {
+        await op.close();
+      }
       await mongoFixtures.close();
     }
   }
@@ -59,6 +64,7 @@ async function callback(callbackParams: Record<string, any>) {
   } = callbackParams;
 
   const mongoOperator = await getMongoOperator(mongoFixtures);
+  openedOperators.push(mongoOperator);
   const expectedResult = await getFixture('expectedResult.json');
 
   await doPreFillDb(preFillDb);

package/test/mongo-set-operations.test.ts

@@ -7,6 +7,7 @@ import createDebugLogger from 'debug';
 import {getMongoOperator, handleError, compareToFirstDbEntry} from './testUtils.ts';
 
 let mongoFixtures: any;
+const openedOperators: any[] = [];
 const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:set-operations:test');
 
 generateTests({
@@ -33,6 +34,10 @@ generateTests({
     },
     after: async () => {
       //debug(`<< After`);
+      // close the operators the tests opened (one per test) before the server
+      for (const op of openedOperators) {
+        await op.close();
+      }
       await mongoFixtures.close();
     }
   }
@@ -59,6 +64,7 @@ async function callback(callbackParams: Record<string, any>) {
   } = callbackParams;
 
   const mongoOperator = await getMongoOperator(mongoFixtures);
+  openedOperators.push(mongoOperator);
   const expectedResult = await getFixture('expectedResult.json');
 
   await doPreFillDb(preFillDb);

package/test/mongo-set-state.test.ts

@@ -8,6 +8,7 @@ import {getMongoOperator, handleError, compareToFirstDbEntry} from './testUtils.
 
 
 let mongoFixtures: any;
+const openedOperators: any[] = [];
 const debug = createDebugLogger('@natlibfi/melinda-rest-api-commons/mongo:set-state:test');
 
 generateTests({
@@ -34,6 +35,10 @@ generateTests({
     },
     after: async () => {
       //debug(`<< After`);
+      // close the operators the tests opened (one per test) before the server
+      for (const op of openedOperators) {
+        await op.close();
+      }
       await mongoFixtures.close();
     }
   }
@@ -60,6 +65,7 @@ async function callback(callbackParams: Record<string, any>) {
   } = callbackParams;
 
   const mongoOperator = await getMongoOperator(mongoFixtures);
+  openedOperators.push(mongoOperator);
   const expectedResult = await getFixture('expectedResult.json');
 
   await doPreFillDb(preFillDb);

package/test/mongoLog-protect.test.ts

@@ -26,6 +26,7 @@ async function initMongofixtures() {
 
 async function cleanup() {
   await mongoFixtures.clear();
+  await mongoLogOperator.close();
   await mongoFixtures.close();
 }
 

package/test/mongoLog.test.ts

@@ -6,6 +6,7 @@ import mongoFixturesFactory from '@natlibfi/fixura-mongo';
 import createMongoLogOperator from '../src/mongoLog.ts';
 
 let mongoFixtures: any;
+const openedOperators: any[] = [];
 
 generateTests({
   callback,
@@ -23,6 +24,10 @@ generateTests({
     beforeEach: () => mongoFixtures.clear(),
     afterEach: () => mongoFixtures.clear(),
     after: async () => {
+      // close the operators the tests opened (one per test) before the server
+      for (const op of openedOperators) {
+        await op.close();
+      }
       await mongoFixtures.close();
     }
   }
@@ -58,6 +63,7 @@ async function callback(callbackParams: Record<string, any>) {
   } = callbackParams;
   const mongoUri = await mongoFixtures.getUri();
   const mongoLogOperator = await createMongoLogOperator(mongoUri, '');
+  openedOperators.push(mongoLogOperator);
   const expectedResult = expectError ? undefined : await getFixture('expectedResult.json');
 
   if (expectError) {