@webda/fs 4.0.0-beta.3

package/lib/filequeue.service.js

@@ -0,0 +1,138 @@
+import * as fs from "fs";
+import { join } from "path";
+import { randomUUID } from "crypto";
+import { Queue, QueueParameters } from "@webda/core";
+import { JSONUtils } from "@webda/utils";
+/** Configuration parameters for the filesystem-backed FIFO queue. */
+export class FileQueueParameters extends QueueParameters {
+    /**
+     * Number of seconds before dropping message
+     *
+     * @default 30
+     */
+    expire;
+    /**
+     * Where to store the queue
+     */
+    folder;
+    /** Set default expiration to 30 seconds and convert to milliseconds. */
+    default() {
+        this.expire = this.expire ?? 30;
+        this.expire *= 1000;
+    }
+}
+/**
+ * FIFO Queue on filesystem
+ * @category CoreServices
+ * @WebdaModda
+ */
+export class FileQueue extends Queue {
+    /**
+     * @override
+     */
+    loadParameters(params) {
+        return new FileQueueParameters().load(params);
+    }
+    /**
+     * Create the storage folder if does not exist
+     */
+    computeParameters() {
+        super.computeParameters();
+        this.parameters.default?.();
+        if (!fs.existsSync(this.parameters.folder)) {
+            fs.mkdirSync(this.parameters.folder);
+        }
+    }
+    /**
+     * @override
+     */
+    async size() {
+        return fs.readdirSync(this.parameters.folder).filter(f => f.endsWith(".json")).length;
+    }
+    /**
+     * Return file
+     *
+     * @param uid - the message unique identifier
+     * @returns the file path
+     */
+    getFile(uid) {
+        return join(this.parameters.folder, `${uid}.json`);
+    }
+    /**
+     * @override
+     */
+    async sendMessage(params) {
+        let uid = randomUUID();
+        let file = this.getFile(uid);
+        while (fs.existsSync(file)) {
+            uid = randomUUID();
+            file = this.getFile(uid);
+        }
+        JSONUtils.saveFile(params, file);
+    }
+    /**
+     * @override
+     */
+    async receiveMessage(proto) {
+        const files = fs
+            .readdirSync(this.parameters.folder)
+            .filter(f => f.endsWith(".json"))
+            .map(f => {
+            const lockFile = join(this.parameters.folder, f + ".lock");
+            const res = {
+                ...fs.lstatSync(join(this.parameters.folder, f)),
+                path: join(this.parameters.folder, f),
+                hasLock: fs.existsSync(lockFile),
+                uid: f.substring(0, f.length - 5)
+            };
+            if (res.hasLock) {
+                const lock = fs.lstatSync(lockFile);
+                if (lock.birthtimeMs < Date.now() - this.parameters.expire) {
+                    res.hasLock = false;
+                    fs.unlinkSync(lockFile);
+                }
+            }
+            return res;
+        })
+            .filter(f => !f.hasLock)
+            .sort((a, b) => {
+            if (a.birthtimeMs > b.birthtimeMs) {
+                return 1;
+            }
+            return -1;
+        });
+        if (files.length) {
+            const el = files.shift();
+            fs.writeFileSync(el.path + ".lock", "");
+            return [
+                {
+                    ReceiptHandle: el.uid,
+                    Message: this.unserialize(fs.readFileSync(el.path).toString(), proto)
+                }
+            ];
+        }
+        else {
+            await new Promise(resolve => setTimeout(resolve, 10000));
+        }
+        return [];
+    }
+    /**
+     * @override
+     */
+    async deleteMessage(receipt) {
+        const file = this.getFile(receipt);
+        if (fs.existsSync(file)) {
+            fs.unlinkSync(file);
+            if (fs.existsSync(file + ".lock")) {
+                fs.unlinkSync(file + ".lock");
+            }
+        }
+    }
+    /**
+     * @inheritdoc
+     */
+    async __clean() {
+        (await import("fs-extra")).emptyDirSync(this.parameters.folder);
+    }
+}
+//# sourceMappingURL=filequeue.service.js.map

package/lib/filequeue.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filequeue.service.js","sourceRoot":"","sources":["../src/filequeue.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAGzC,qEAAqE;AACrE,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IACtD;;;;OAIG;IACH,MAAM,CAAU;IAChB;;OAEG;IACH,MAAM,CAAS;IAEf,wEAAwE;IACxE,OAAO;QACL,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;QAChC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC;IACtB,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,SAAwE,SAAQ,KAAW;IACtG;;OAEG;IACH,cAAc,CAAC,MAAW;QACxB,OAAU,IAAI,mBAAmB,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,KAAK,CAAC,iBAAiB,EAAE,CAAC;QAC1B,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;QAC5B,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3C,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,OAAO,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;IACxF,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,GAAW;QACjB,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAC,MAAM;QACtB,IAAI,GAAG,GAAG,UAAU,EAAE,CAAC;QACvB,IAAI,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC7B,OAAO,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,GAAG,GAAG,UAAU,EAAE,CAAC;YACnB,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;QACD,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAI,KAAqB;QAC3C,MAAM,KAAK,GAAG,EAAE;aACb,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;aACnC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;aAChC,GAAG,CAAC,CAAC,CAAC,EAAE;YACP,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC;YAC3D,MAAM,GAAG,GAAG;gBACV,GAAG,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;gBAChD,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;gBACrC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;gBAChC,GAAG,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;aAClC,CAAC;YACF,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;gBAChB,MAAM,IAAI,GAAG,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBACpC,IAAI,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;oBAC3D,GAAG,CAAC,OAAO,GAAG,KAAK,CAAC;oBACpB,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;gBAC1B,CAAC;YACH,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC,CAAC;aACD,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;aACvB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YACb,IAAI,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;gBAClC,OAAO,CAAC,CAAC;YACX,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;QACZ,CAAC,CAAC,CAAC;QACL,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;YACzB,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC,IAAI,GAAG,OAAO,EAAE,EAAE,CAAC,CAAC;YACxC,OAAO;gBACL;oBACE,aAAa,EAAE,EAAE,CAAC,GAAG;oBACrB,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC;iBACtE;aACF,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QAC3D,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CAAC,OAAO;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACnC,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACpB,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,GAAG,OAAO,CAAC,EAAE,CAAC;gBAClC,EAAE,CAAC,UAAU,CAAC,IAAI,GAAG,OAAO,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,CAAC,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAClE,CAAC;CACF"}

package/lib/filestore.service.d.ts

@@ -0,0 +1,133 @@
+import { Store, StoreFindResult, StoreParameters, ModelClass, Repository } from "@webda/core";
+import * as WebdaQL from "@webda/ql";
+/** Configuration parameters for the JSON-file-backed store. */
+export declare class FileStoreParameters extends StoreParameters {
+    /**
+     * Local path where to store all `json` files
+     */
+    folder: string;
+    /**
+     * Parameter sent to JSON.stringify when storing the json
+     */
+    beautify?: string | number;
+}
+/**
+ * Simple file storage of object
+ *
+ * Storage structure
+ *   /folder/{uuid}
+ *
+ * Parameters:
+ *  folder: to store to
+ *
+ * @category CoreServices
+ * @WebdaModda
+ */
+export declare class FileStore<K extends FileStoreParameters = FileStoreParameters> extends Store<K> {
+    static EXTENSION: string;
+    /**
+     * Load the parameters for a service
+     *
+     * @param params - raw parameter values
+     * @returns the loaded parameters
+     */
+    loadParameters(params: any): K;
+    /**
+     * Create the storage folder if does not exist
+     */
+    computeParameters(): void;
+    /**
+     * Get the file path of an object
+     *
+     * @param uid - the object unique identifier
+     * @returns the file path
+     */
+    file(uid: any): string;
+    /**
+     * @override
+     */
+    _exists(uid: any): Promise<boolean>;
+    /**
+     * @override
+     */
+    find(query: WebdaQL.Query): Promise<StoreFindResult<any>>;
+    /**
+     * @override
+     */
+    _create(uuid: string, object: any): Promise<any>;
+    /**
+     * Store in file the object
+     *
+     * @param uuid - the object unique identifier
+     * @param object - the object to persist
+     * @returns the persisted object
+     */
+    protected persist(uuid: string, object: any): Promise<any>;
+    /**
+     * Verify optimistic locking update condition
+     *
+     * @param uuid - the object unique identifier
+     * @param stored - the currently stored object
+     * @param writeConditionField - field to check for condition
+     * @param writeCondition - expected value of the field
+     */
+    protected checkUpdateCondition(uuid: string, stored: any, writeConditionField?: string, writeCondition?: any): void;
+    /**
+     * Verify collection item update condition
+     *
+     * @param stored - the currently stored object
+     * @param prop - the collection property name
+     * @param itemWriteConditionField - field to check on the item
+     * @param itemWriteCondition - expected value of the field
+     * @param index - index of the item in the collection
+     */
+    protected checkCollectionUpdateCondition(stored: any, prop: string, itemWriteConditionField: string, itemWriteCondition: any, index: number): void;
+    /**
+     * @override
+     */
+    _upsertItemToCollection(uid: string, prop: string, item: any, index: number, itemWriteCondition: any, itemWriteConditionField: string, updateDate: Date): Promise<any>;
+    /**
+     * @override
+     */
+    _removeAttribute(uuid: string, attribute: string, writeCondition?: any, writeConditionField?: string): Promise<void>;
+    /**
+     * @override
+     */
+    _deleteItemFromCollection(uid: string, prop: string, index: number, itemWriteCondition: any, itemWriteConditionField: string, updateDate: Date): Promise<any>;
+    /**
+     * @override
+     */
+    _delete(uid: string): Promise<void>;
+    /**
+     * @override
+     */
+    _patch(object: any, uid: string, writeCondition?: any, writeConditionField?: string): Promise<any>;
+    /**
+     * @override
+     */
+    _update(object: any, uid: string, writeCondition?: any, writeConditionField?: string): Promise<any>;
+    /**
+     * @override
+     */
+    getAll(uids?: string[]): Promise<any>;
+    /**
+     * @override
+     */
+    _get(uid: string, raiseIfNotFound?: boolean): Promise<any>;
+    /**
+     * @override
+     */
+    _incrementAttributes(uid: string, params: {
+        property: string;
+        value: number;
+    }[], updateDate: Date): Promise<any>;
+    /**
+     * @override
+     */
+    getRepository<T extends ModelClass>(model: T): Repository<T>;
+    /**
+     * @override
+     */
+    __clean(): Promise<void>;
+}
+//# sourceMappingURL=filestore.service.d.ts.map

package/lib/filestore.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filestore.service.d.ts","sourceRoot":"","sources":["../src/filestore.service.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,EACL,eAAe,EAEf,eAAe,EAIf,UAAU,EACV,UAAU,EAGX,MAAM,aAAa,CAAC;AAErB,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAErC,+DAA+D;AAC/D,qBAAa,mBAAoB,SAAQ,eAAe;IACtD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC5B;AAgHD;;;;;;;;;;;GAWG;AACH,qBAAa,SAAS,CAAC,CAAC,SAAS,mBAAmB,GAAG,mBAAmB,CAAE,SAAQ,KAAK,CAAC,CAAC,CAAC;IAC1F,MAAM,CAAC,SAAS,SAAW;IAE3B;;;;;OAKG;IACH,cAAc,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAE7B;IAED;;OAEG;IACH,iBAAiB,SAKhB;IAED;;;;;OAKG;IACH,IAAI,CAAC,GAAG,KAAA,UAEP;IAED;;OAEG;IACG,OAAO,CAAC,GAAG,KAAA,oBAEhB;IAED;;OAEG;IACG,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAY9D;IAED;;OAEG;IACG,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,gBAKtC;IAED;;;;;;OAMG;IACH,UAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,gBAGhD;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,mBAAmB,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,GAAG,QAI3G;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,8BAA8B,CACtC,MAAM,EAAE,GAAG,EACX,IAAI,EAAE,MAAM,EACZ,uBAAuB,EAAE,MAAM,EAC/B,kBAAkB,EAAE,GAAG,EACvB,KAAK,EAAE,MAAM,QAcd;IAED;;OAEG;IACG,uBAAuB,CAC3B,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,GAAG,EACT,KAAK,EAAE,MAAM,EACb,kBAAkB,EAAE,GAAG,EACvB,uBAAuB,EAAE,MAAM,EAC/B,UAAU,EAAE,IAAI,gBAoBjB;IAED;;OAEG;IACG,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,GAAG,EAAE,mBAAmB,CAAC,EAAE,MAAM,iBAKzG;IAED;;OAEG;IACG,yBAAyB,CAC7B,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,kBAAkB,EAAE,GAAG,EACvB,uBAAuB,EAAE,MAAM,EAC/B,UAAU,EAAE,IAAI,gBAOjB;IAED;;OAEG;IACG,OAAO,CAAC,GAAG,EAAE,MAAM,iBAKxB;IAED;;OAEG;IACG,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,GAAG,EAAE,mBAAmB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAOvG;IAED;;OAEG;IACG,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,GAAG,EAAE,mBAAmB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAIxG;IAED;;OAEG;IACG,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAc1C;IAED;;OAEG;IACG,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,eAAe,GAAE,OAAe,GAAG,OAAO,CAAC,GAAG,CAAC,CAWtE;IAED;;OAEG;IACG,oBAAoB,CACxB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,EAC7C,UAAU,EAAE,IAAI,GACf,OAAO,CAAC,GAAG,CAAC,CAWd;IAED;;OAEG;IAEH,aAAa,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAQ3D;IAED;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAE7B;CACF"}