@neofinancial/chrono-mongo-datastore 0.1.2 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1,7 +1,18 @@
|
|
|
1
1
|
import { type ClaimTaskInput, type Datastore, type DeleteInput, type DeleteOptions, type ScheduleInput, type Task, type TaskMappingBase } from '@neofinancial/chrono';
|
|
2
2
|
import { type ClientSession, type Db, type WithId } from 'mongodb';
|
|
3
3
|
export type ChronoMongoDatastoreConfig = {
|
|
4
|
-
|
|
4
|
+
/**
|
|
5
|
+
* The TTL (in seconds) for completed documents.
|
|
6
|
+
*
|
|
7
|
+
* @default 60 * 60 * 24 * 30 // 30 days
|
|
8
|
+
* @type {number}
|
|
9
|
+
*/
|
|
10
|
+
completedDocumentTTLSeconds?: number;
|
|
11
|
+
/**
|
|
12
|
+
* The name of the collection to use for the datastore.
|
|
13
|
+
*
|
|
14
|
+
* @type {string}
|
|
15
|
+
*/
|
|
5
16
|
collectionName: string;
|
|
6
17
|
};
|
|
7
18
|
export type MongoDatastoreOptions = {
|
|
@@ -11,14 +11,14 @@ class ChronoMongoDatastore {
|
|
|
11
11
|
constructor(database, config) {
|
|
12
12
|
this.database = database;
|
|
13
13
|
this.config = {
|
|
14
|
-
|
|
14
|
+
completedDocumentTTLSeconds: config?.completedDocumentTTLSeconds,
|
|
15
15
|
collectionName: config?.collectionName || DEFAULT_COLLECTION_NAME,
|
|
16
16
|
};
|
|
17
17
|
}
|
|
18
18
|
static async create(database, config) {
|
|
19
19
|
const datastore = new ChronoMongoDatastore(database, config);
|
|
20
|
-
await (0, mongo_indexes_1.ensureIndexes)(
|
|
21
|
-
|
|
20
|
+
await (0, mongo_indexes_1.ensureIndexes)(database.collection(datastore.config.collectionName), {
|
|
21
|
+
expireAfterSeconds: datastore.config.completedDocumentTTLSeconds,
|
|
22
22
|
});
|
|
23
23
|
return datastore;
|
|
24
24
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"chrono-mongo-datastore.js","sourceRoot":"","sources":["../src/chrono-mongo-datastore.ts"],"names":[],"mappings":";;;AAAA,iDAS8B;AAC9B,qCAQiB;AACjB,mDAA4D;AAE5D,MAAM,uBAAuB,GAAG,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"chrono-mongo-datastore.js","sourceRoot":"","sources":["../src/chrono-mongo-datastore.ts"],"names":[],"mappings":";;;AAAA,iDAS8B;AAC9B,qCAQiB;AACjB,mDAA4D;AAE5D,MAAM,uBAAuB,GAAG,cAAc,CAAC;AAyB/C,MAAa,oBAAoB;IAGvB,MAAM,CAA6B;IACnC,QAAQ,CAAK;IAErB,YAAoB,QAAY,EAAE,MAA4C;QAC5E,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG;YACZ,2BAA2B,EAAE,MAAM,EAAE,2BAA2B;YAChE,cAAc,EAAE,MAAM,EAAE,cAAc,IAAI,uBAAuB;SAClE,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,QAAY,EACZ,MAA4C;QAE5C,MAAM,SAAS,GAAG,IAAI,oBAAoB,CAAc,QAAQ,EAAE,MAAM,CAAC,CAAC;QAE1E,MAAM,IAAA,6BAAa,EAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE;YACxE,kBAAkB,EAAE,SAAS,CAAC,MAAM,CAAC,2BAA2B;SACjE,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,KAA4E;QAE5E,MAAM,WAAW,GAA8D;YAC7E,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,MAAM,EAAE,mBAAU,CAAC,OAAO;YAC1B,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,cAAc,EAAE,KAAK,CAAC,cAAc;YACpC,oBAAoB,EAAE,KAAK,CAAC,IAAI;YAChC,WAAW,EAAE,KAAK,CAAC,IAAI;YACvB,UAAU,EAAE,CAAC;SACd,CAAC;QAEF,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE;gBAChG,GAAG,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;gBAC/F,eAAe,EAAE,IAAI;aACtB,CAAC,CAAC;YAEH,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;gBACzB,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,UAAU,EAAE,GAAG,WAAW,EAAE,CAAC,CAAC;YACpE,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IACE,KAAK,CAAC,cAAc;gBACpB,KAAK,YAAY,KAAK;gBACtB,MAAM,IAAI,KAAK;gBACf,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,EAC9C,CAAC;gBACD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,EAAY,CAAC,OAAO,CAC5D;oBACE,cAAc,EAAE,KAAK,CAAC,cAAc;iBACrC,EACD;oBACE,IAAI,EAAE,0BAAU,CAAC,qBAAqB;oBACtC,GAAG,CAAC,KAAK,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBAC/F,CACF,CAAC;gBAEF,IAAI,YAAY,EAAE,CAAC;oBACjB,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;gBACrC,CAAC;gBAED,MAAM,IAAI,KAAK,CACb,qDAAqD,KAAK,CAAC,cAAc,6BAA6B,CACvG,CAAC;YACJ,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,oBAAoB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,CAAC,MAAM,CACV,GAA0B,EAC1B,OAAuB;QAEvB,MAAM,MAAM,GACV,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,kBAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,cAAc,EAAE,GAAG,CAAC,cAAc,EAAE,CAAC;QAChH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,EAAY,CAAC,gBAAgB,CAAC;YAC9D,GAAG,MAAM;YACT,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,mBAAU,CAAC,OAAO,EAAE,CAAC;SAC1D,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,OAAO,EAAE,KAAK,EAAE,CAAC;gBACnB,OAAO;YACT,CAAC;YAED,MAAM,WAAW,GACf,OAAO,GAAG,KAAK,QAAQ;gBACrB,CAAC,CAAC,WAAW,GAAG,EAAE;gBAClB,CAAC,CAAC,aAAa,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,uBAAuB,GAAG,CAAC,cAAc,EAAE,CAAC;YAE/E,MAAM,IAAI,KAAK,CAAC,QAAQ,WAAW,wEAAwE,CAAC,CAAC;QAC/G,CAAC;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,KAAK,CACT,KAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,EAAY,CAAC,gBAAgB,CAC7D;YACE,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE;YAC1B,GAAG,EAAE;gBACH,EAAE,MAAM,EAAE,mBAAU,CAAC,OAAO,EAAE;gBAC9B;oBACE,MAAM,EAAE,mBAAU,CAAC,OAAO;oBAC1B,SAAS,EAAE;wBACT,IAAI,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,mBAAmB,CAAC;qBAC1D;iBACF;aACF;SACF,EACD,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,mBAAU,CAAC,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,EACxD;YACE,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE;YACtC,gEAAgE;YAChE,cAAc,EAAE,OAAO;SACxB,CACF,CAAC;QAEF,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,KAAK,CACT,MAAc,EACd,OAAa;QAEb,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,aAAa,CAAW,MAAM,EAAE;YAC9D,IAAI,EAAE;gBACJ,MAAM,EAAE,mBAAU,CAAC,OAAO;gBAC1B,WAAW,EAAE,OAAO;aACrB;YACD,IAAI,EAAE;gBACJ,UAAU,EAAE,CAAC;aACd;SACF,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,QAAQ,CAAqC,MAAc;QAC/D,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QAEvB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,aAAa,CAAW,MAAM,EAAE;YACtD,IAAI,EAAE;gBACJ,MAAM,EAAE,mBAAU,CAAC,SAAS;gBAC5B,WAAW,EAAE,GAAG;gBAChB,cAAc,EAAE,GAAG;aACpB;SACF,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,IAAI,CAAqC,MAAc;QAC3D,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QAEvB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,aAAa,CAAW,MAAM,EAAE;YACtD,IAAI,EAAE;gBACJ,MAAM,EAAE,mBAAU,CAAC,MAAM;gBACzB,cAAc,EAAE,GAAG;aACpB;SACF,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAEO,KAAK,CAAC,aAAa,CACzB,MAAc,EACd,MAAmE;QAEnE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,EAAY,CAAC,gBAAgB,CAAC,EAAE,GAAG,EAAE,IAAI,kBAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE;YACzG,cAAc,EAAE,OAAO;SACxB,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,gBAAgB,MAAM,YAAY,CAAC,CAAC;QACtD,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,UAAU;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAgD,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAC7G,CAAC;IAEO,QAAQ,CACd,QAAuD;QAEvD,OAAO;YACL,EAAE,EAAE,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE;YAC9B,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,QAAQ,EAAE,QAAQ,CAAC,QAAQ,IAAI,SAAS;YACxC,cAAc,EAAE,QAAQ,CAAC,cAAc,IAAI,SAAS;YACpD,oBAAoB,EAAE,QAAQ,CAAC,oBAAoB;YACnD,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,SAAS,EAAE,QAAQ,CAAC,SAAS,IAAI,SAAS;YAC1C,WAAW,EAAE,QAAQ,CAAC,WAAW,IAAI,SAAS;YAC9C,UAAU,EAAE,QAAQ,CAAC,UAAU;SAChC,CAAC;IACJ,CAAC;CACF;AAvND,oDAuNC"}
|
package/build/mongo-indexes.d.ts
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import type { Collection } from 'mongodb';
|
|
2
|
-
export declare const
|
|
2
|
+
export declare const DEFAULT_EXPIRY_SECONDS: number;
|
|
3
3
|
export declare const IndexNames: {
|
|
4
4
|
COMPLETED_DOCUMENT_TTL_INDEX: string;
|
|
5
5
|
CLAIM_DOCUMENT_INDEX: string;
|
|
6
6
|
IDEMPOTENCY_KEY_INDEX: string;
|
|
7
7
|
};
|
|
8
8
|
export type IndexDefinitionOptions = {
|
|
9
|
-
|
|
9
|
+
expireAfterSeconds?: number;
|
|
10
10
|
};
|
|
11
11
|
export declare function ensureIndexes(collection: Collection, options: IndexDefinitionOptions): Promise<void>;
|
package/build/mongo-indexes.js
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.IndexNames = exports.
|
|
3
|
+
exports.IndexNames = exports.DEFAULT_EXPIRY_SECONDS = void 0;
|
|
4
4
|
exports.ensureIndexes = ensureIndexes;
|
|
5
5
|
const chrono_1 = require("@neofinancial/chrono");
|
|
6
|
-
exports.
|
|
6
|
+
exports.DEFAULT_EXPIRY_SECONDS = 60 * 60 * 24 * 30; // 30 days
|
|
7
7
|
exports.IndexNames = {
|
|
8
8
|
COMPLETED_DOCUMENT_TTL_INDEX: 'chrono-completed-document-ttl-index',
|
|
9
9
|
CLAIM_DOCUMENT_INDEX: 'chrono-claim-document-index',
|
|
@@ -15,7 +15,7 @@ async function ensureIndexes(collection, options) {
|
|
|
15
15
|
completedAt: { $exists: true },
|
|
16
16
|
status: { $eq: chrono_1.TaskStatus.COMPLETED },
|
|
17
17
|
},
|
|
18
|
-
expireAfterSeconds: options.
|
|
18
|
+
expireAfterSeconds: options.expireAfterSeconds || exports.DEFAULT_EXPIRY_SECONDS,
|
|
19
19
|
name: exports.IndexNames.COMPLETED_DOCUMENT_TTL_INDEX,
|
|
20
20
|
});
|
|
21
21
|
await collection.createIndex({ kind: 1, status: 1, scheduledAt: 1, priority: -1, claimedAt: 1 }, { name: exports.IndexNames.CLAIM_DOCUMENT_INDEX });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mongo-indexes.js","sourceRoot":"","sources":["../src/mongo-indexes.ts"],"names":[],"mappings":";;;AAeA,sCAsBC;AArCD,iDAAkD;AAGrC,QAAA,
|
|
1
|
+
{"version":3,"file":"mongo-indexes.js","sourceRoot":"","sources":["../src/mongo-indexes.ts"],"names":[],"mappings":";;;AAeA,sCAsBC;AArCD,iDAAkD;AAGrC,QAAA,sBAAsB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,UAAU;AAEtD,QAAA,UAAU,GAAG;IACxB,4BAA4B,EAAE,qCAAqC;IACnE,oBAAoB,EAAE,6BAA6B;IACnD,qBAAqB,EAAE,8BAA8B;CACtD,CAAC;AAMK,KAAK,UAAU,aAAa,CAAC,UAAsB,EAAE,OAA+B;IACzF,MAAM,UAAU,CAAC,WAAW,CAC1B,EAAE,WAAW,EAAE,CAAC,CAAC,EAAE,EACnB;QACE,uBAAuB,EAAE;YACvB,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;YAC9B,MAAM,EAAE,EAAE,GAAG,EAAE,mBAAU,CAAC,SAAS,EAAE;SACtC;QACD,kBAAkB,EAAE,OAAO,CAAC,kBAAkB,IAAI,8BAAsB;QACxE,IAAI,EAAE,kBAAU,CAAC,4BAA4B;KAC9C,CACF,CAAC;IAEF,MAAM,UAAU,CAAC,WAAW,CAC1B,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,EAClE,EAAE,IAAI,EAAE,kBAAU,CAAC,oBAAoB,EAAE,CAC1C,CAAC;IAEF,MAAM,UAAU,CAAC,WAAW,CAC1B,EAAE,cAAc,EAAE,CAAC,EAAE,EACrB,EAAE,IAAI,EAAE,kBAAU,CAAC,qBAAqB,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CACvE,CAAC;AACJ,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@neofinancial/chrono-mongo-datastore",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"description": "MongoDB datastore implementation for Chrono task scheduling system",
|
|
5
5
|
"private": false,
|
|
6
6
|
"publishConfig": {
|
|
@@ -21,13 +21,13 @@
|
|
|
21
21
|
"README.md"
|
|
22
22
|
],
|
|
23
23
|
"devDependencies": {
|
|
24
|
-
"mongodb": "^6
|
|
24
|
+
"mongodb": "^6",
|
|
25
25
|
"mongodb-memory-server": "^10.1.4",
|
|
26
|
-
"@neofinancial/chrono": "0.
|
|
26
|
+
"@neofinancial/chrono": "0.3.0"
|
|
27
27
|
},
|
|
28
28
|
"peerDependencies": {
|
|
29
|
-
"mongodb": "^6
|
|
30
|
-
"@neofinancial/chrono": "0.
|
|
29
|
+
"mongodb": "^6",
|
|
30
|
+
"@neofinancial/chrono": "0.3.0"
|
|
31
31
|
},
|
|
32
32
|
"scripts": {
|
|
33
33
|
"clean": "rimraf ./build",
|