@juzi/file-box 1.7.0

package/dist/esm/src/urn-registry/uniform-resource-name-registry.js

@@ -0,0 +1,253 @@
+/**
+ * Huan(202110): Assignment and Resolution of Uniform Resource Names
+ *  https://datatracker.ietf.org/wg/urn/about/
+ */
+/**
+ * RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace
+ *  ------------------------------------------------------------
+ *  This specification defines a Uniform Resource Name namespace for
+ *  UUIDs (Universally Unique IDentifier), also known as GUIDs (Globally
+ *  Unique IDentifier).  A UUID is 128 bits long, and can guarantee
+ *  uniqueness across space and time.  UUIDs were originally used in the
+ *  Apollo Network Computing System and later in the Open Software
+ *  Foundation's (OSF) Distributed Computing Environment (DCE), and then
+ *  in Microsoft Windows platforms.
+ *
+ *  The information here is meant to be a concise guide for those wishing
+ *  to implement services using UUIDs as URNs.  Nothing in this document
+ *  should be construed to override the DCE standards that defined UUIDs.
+ */
+/**
+ * RFC 2141: Uniform Resource Names (URNs) Syntax
+ * ----------------------------------------------
+ *  Uniform Resource Names (URNs) are intended to serve as persistent,
+ *  location-independent, resource identifiers. This document sets
+ *  forward the canonical syntax for URNs.  A discussion of both existing
+ *  legacy and new namespaces and requirements for URN presentation and
+ *  transmission are presented.  Finally, there is a discussion of URN
+ *  equivalence and how to determine it.
+ */
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+import { instanceToClass } from 'clone-class';
+import { log } from 'brolog';
+import { FileBox, } from '../file-box.js';
+import { randomUuid, } from './random-uuid.js';
+/**
+ * A UUID will be only keep for a certain time.
+ */
+const DEFAULT_UUID_EXPIRE_MINUTES = 30;
+const DEFAULT_UUID_PURGE_INTERVAL_MINUTES = 1;
+class UniformResourceNameRegistry {
+    static processExitMap = new WeakMap();
+    /**
+     * The directory that store all UUID files
+     */
+    storeDir;
+    expireMilliseconds;
+    /**
+     * Key: expiretime
+     * Value: the array of UUID that will expires after the `expiretime` (Key)
+     */
+    uuidExpiringTable;
+    purgerTimer;
+    constructor(options = {}) {
+        log.verbose('UniformResourceNameRegistry', 'constructor("%s")', JSON.stringify(options));
+        this.uuidExpiringTable = new Map();
+        this.expireMilliseconds = options.expireMilliseconds ?? (DEFAULT_UUID_EXPIRE_MINUTES * 60 * 1000 * 1000);
+        this.storeDir = options.storeDir || path.join(os.tmpdir(), 'file-box-urn-registry.' + String(process.pid));
+    }
+    /**
+     * Return a FileBox Interface with the current URN Registry for conience
+     */
+    getFileBox() {
+        this.init();
+        class UUIDFileBox extends FileBox {
+        }
+        UUIDFileBox.setUuidLoader(this.load.bind(this));
+        UUIDFileBox.setUuidSaver(this.save.bind(this));
+        return UUIDFileBox;
+    }
+    /**
+     * init the UUID registry
+     *
+     * must be called before use.
+     */
+    init() {
+        log.verbose('UniformResourceNameRegistry', 'init()');
+        try {
+            const stat = fs.statSync(this.storeDir);
+            if (!stat.isDirectory()) {
+                throw new Error(this.storeDir + ' is Not a directory');
+            }
+        }
+        catch (e) {
+            if (e.code === 'ENOENT') {
+                fs.mkdirSync(this.storeDir, { recursive: true });
+            }
+            else {
+                throw e;
+            }
+        }
+        if (!this.purgerTimer) {
+            this.addProcessExitListener();
+            this.purgerTimer = setInterval(() => this.purgeExpiredUuid(), DEFAULT_UUID_PURGE_INTERVAL_MINUTES * 60 * 1000);
+        }
+    }
+    purgeExpiredUuid() {
+        log.verbose('UniformResourceNameRegistry', 'purgeExpiredUuid()');
+        const expireTimeList = [...this.uuidExpiringTable.keys()]
+            .sort((a, b) => Number(a) - Number(b));
+        for (const expireTime of expireTimeList) {
+            if (Date.now() < expireTime) {
+                // The earliest expire time is in the future
+                break;
+            }
+            const uuidList = this.uuidExpiringTable.get(expireTime) || [];
+            this.uuidExpiringTable.delete(expireTime);
+            for (const uuid of uuidList) {
+                this.purge(uuid).catch(console.error);
+            }
+        }
+    }
+    /**
+     * Clean up by calling this.destroy() before process exit
+     */
+    addProcessExitListener() {
+        log.verbose('UniformResourceNameRegistry', 'addProcessExitListener()');
+        const Klass = instanceToClass(this, UniformResourceNameRegistry);
+        /**
+         * If we have already registered the listener, do nothing.
+         */
+        if (Klass.processExitMap.has(this)) {
+            return;
+        }
+        const destroyCallback = () => this.destroy();
+        process.addListener('exit', destroyCallback);
+        Klass.processExitMap.set(this, () => process.removeListener('exit', destroyCallback));
+    }
+    uuidFileName(uuid) {
+        return path.join(this.storeDir, uuid + '.dat');
+    }
+    /**
+     * @deprecated use `load()` instead
+     */
+    async resolve(uuid) {
+        log.warn('UniformResourceNameRegistry', 'resolve() is deprecated: use `load()` instead.\n%s', new Error().stack);
+        return this.load(uuid);
+    }
+    /**
+     * `resolve()` can only be used once.
+     *  after resolve(), the UUID will be not exist any more
+     */
+    async load(uuid) {
+        log.verbose('UniformResourceNameRegistry', 'load(%s)', uuid);
+        const filename = this.uuidFileName(uuid);
+        const stream = fs.createReadStream(filename);
+        await new Promise((resolve, reject) => {
+            stream.on('ready', resolve);
+            stream.on('error', reject);
+        });
+        return stream;
+    }
+    /**
+     * @deprecated use `save()` instead
+     */
+    async register(stream) {
+        log.verbose('UniformResourceNameRegistry', 'register() deprecated: use save() instead.\n%s', new Error().stack);
+        return this.save(stream);
+    }
+    /**
+     * Save the `Readable` stream and return a random UUID
+     *  The UUID will be expired after MAX_KEEP_MINUTES
+     */
+    async save(stream) {
+        log.verbose('UniformResourceNameRegistry', 'save(stream)');
+        const uuid = randomUuid();
+        const fileStream = fs.createWriteStream(this.uuidFileName(uuid));
+        const future = new Promise((resolve, reject) => {
+            stream.on('end', resolve);
+            stream.on('error', reject);
+            fileStream.on('error', reject);
+        });
+        stream.pipe(fileStream);
+        await future;
+        this.addToExpiringTable(uuid);
+        return uuid;
+    }
+    /**
+     * Set a timer to execute delete callback after `expireMilliseconds`
+     */
+    addToExpiringTable(uuid) {
+        log.verbose('UniformResourceNameRegistry', 'addToExpiringTable(%s)', uuid);
+        const expireTime = Date.now() + this.expireMilliseconds;
+        const expireTimeInterval = DEFAULT_UUID_PURGE_INTERVAL_MINUTES * 60 * 1000;
+        // https://stackoverflow.com/a/22687090
+        const expireTimeNearestMinute = Math.ceil(expireTime / expireTimeInterval) * expireTimeInterval;
+        const uuidList = this.uuidExpiringTable.get(expireTime) || [];
+        uuidList.push(uuid);
+        this.uuidExpiringTable.set(expireTimeNearestMinute, uuidList);
+        log.silly('UniformResourceNameRegistry', 'addToExpiringTable() uuidList.length = %s, expireTime = %s', uuidList.length, expireTimeNearestMinute);
+    }
+    async purge(uuid) {
+        log.verbose('UniformResourceNameRegistry', 'purge(%s)', uuid);
+        const file = this.uuidFileName(uuid);
+        try {
+            await fs.promises.unlink(file);
+            log.silly('UniformResourceNameRegistry', 'purge() %s', file);
+        }
+        catch (e) {
+            log.warn('UniformResourceNameRegistry', 'purge() rejection:', e.message);
+        }
+    }
+    /**
+     * destroy the urn registry.
+     *
+     * This function will be called automatically at `process.on(exit)`
+     * however, it till need to be called before the program ends
+     *  because there have some timers in eventloop task list
+     */
+    destroy() {
+        log.verbose('UniformResourceNameRegistry', 'destroy() %s UUIDs left', [...this.uuidExpiringTable.values()].flat().length);
+        if (this.purgerTimer) {
+            log.verbose('UniformResourceNameRegistry', 'destroy() clearing purger timer ...');
+            clearInterval(this.purgerTimer);
+            this.purgerTimer = undefined;
+        }
+        const Klass = instanceToClass(this, UniformResourceNameRegistry);
+        /**
+         * Remove process exit listener
+         */
+        if (Klass.processExitMap.has(this)) {
+            log.verbose('UniformResourceNameRegistry', 'destroy() remove process `exit` listener ...');
+            const fn = Klass.processExitMap.get(this);
+            Klass.processExitMap.delete(this);
+            fn && fn();
+        }
+        /**
+         * Clean up all the files
+         */
+        log.verbose('UniformResourceNameRegistry', 'destroy() fs.rmSync(%s) ...', this.storeDir);
+        try {
+            /**
+             * Huan(202110):
+             *  Check for the `this.uuidDir` exist or not
+             *    when we are running unit tests, we might instanciate multiple UniformResourceNameRegistry
+             *    which will cause the `this.destroy()` to be registered multiple times
+             */
+            fs.statSync(this.storeDir);
+            fs.rmSync(this.storeDir, { recursive: true });
+            log.verbose('UniformResourceNameRegistry', 'destroy() fs.rmSync(%s) done', this.storeDir);
+        }
+        catch (e) {
+            if (e.code === 'ENOENT') {
+                log.verbose('UniformResourceNameRegistry', 'destroy() %s not exist', this.storeDir);
+                return;
+            }
+            log.warn('UniformResourceNameRegistry', 'destroy() fs.rmSync(%s) exception: %s', e.message);
+        }
+    }
+}
+export { UniformResourceNameRegistry };
+//# sourceMappingURL=uniform-resource-name-registry.js.map

package/dist/esm/src/urn-registry/uniform-resource-name-registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uniform-resource-name-registry.js","sourceRoot":"","sources":["../../../../src/urn-registry/uniform-resource-name-registry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;GAcG;AAEH;;;;;;;;;GASG;AACH,OAAO,EAAE,MAAU,IAAI,CAAA;AACvB,OAAO,EAAE,MAAU,IAAI,CAAA;AACvB,OAAO,IAAI,MAAQ,MAAM,CAAA;AAIzB,OAAO,EAAE,eAAe,EAAE,MAAO,aAAa,CAAA;AAC9C,OAAO,EAAE,GAAG,EAAE,MAAmB,QAAQ,CAAA;AAEzC,OAAO,EACL,OAAO,GACR,MAA8B,gBAAgB,CAAA;AAE/C,OAAO,EACL,UAAU,GACX,MAAoB,kBAAkB,CAAA;AAEvC;;GAEG;AACH,MAAM,2BAA2B,GAAW,EAAE,CAAA;AAC9C,MAAM,mCAAmC,GAAG,CAAC,CAAA;AAO7C,MAAM,2BAA2B;IAErB,MAAM,CAAC,cAAc,GAAG,IAAI,OAAO,EAG1C,CAAA;IAEH;;OAEG;IACO,QAAQ,CAAQ;IAEhB,kBAAkB,CAAQ;IAEpC;;;OAGG;IACO,iBAAiB,CAG1B;IAES,WAAW,CAAiC;IAEtD,YACE,UAA8C,EAAE;QAEhD,GAAG,CAAC,OAAO,CAAC,6BAA6B,EAAE,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;QAExF,IAAI,CAAC,iBAAiB,GAAG,IAAI,GAAG,EAAE,CAAA;QAElC,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,IAAI,CAAC,2BAA2B,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAA;QACxG,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAC3C,EAAE,CAAC,MAAM,EAAE,EACX,wBAAwB,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAC/C,CAAA;IACH,CAAC;IAED;;OAEG;IACH,UAAU;QACR,IAAI,CAAC,IAAI,EAAE,CAAA;QAEX,MAAM,WAAY,SAAQ,OAAO;SAAG;QACpC,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QAC/C,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QAC9C,OAAO,WAAW,CAAA;IACpB,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,GAAG,CAAC,OAAO,CAAC,6BAA6B,EAAE,QAAQ,CAAC,CAAA;QAEpD,IAAI;YACF,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YACvC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE;gBACvB,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,GAAG,qBAAqB,CAAC,CAAA;aACvD;SACF;QAAC,OAAO,CAAC,EAAE;YACV,IAAK,CAA2B,CAAC,IAAI,KAAK,QAAQ,EAAE;gBAClD,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;aACjD;iBAAM;gBACL,MAAM,CAAC,CAAA;aACR;SACF;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACrB,IAAI,CAAC,sBAAsB,EAAE,CAAA;YAE7B,IAAI,CAAC,WAAW,GAAG,WAAW,CAC5B,GAAG,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAC7B,mCAAmC,GAAG,EAAE,GAAG,IAAI,CAChD,CAAA;SACF;IAEH,CAAC;IAES,gBAAgB;QACxB,GAAG,CAAC,OAAO,CAAC,6BAA6B,EAAE,oBAAoB,CAAC,CAAA;QAChE,MAAM,cAAc,GAAG,CAAE,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAE;aACxD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QAExC,KAAK,MAAM,UAAU,IAAI,cAAc,EAAE;YACvC,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,EAAE;gBAC3B,4CAA4C;gBAC5C,MAAK;aACN;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,CAAA;YAC7D,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;YAEzC,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE;gBAC3B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;aACtC;SACF;IACH,CAAC;IAED;;OAEG;IACO,sBAAsB;QAC9B,GAAG,CAAC,OAAO,CAAC,6BAA6B,EAAE,0BAA0B,CAAC,CAAA;QAEtE,MAAM,KAAK,GAAG,eAAe,CAAC,IAAI,EAAE,2BAA2B,CAAC,CAAA;QAEhE;;WAEG;QACH,IAAI,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAClC,OAAM;SACP;QAED,MAAM,eAAe,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAA;QAE5C,OAAO,CAAC,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;QAC5C,KAAK,CAAC,cAAc,CAAC,GAAG,CACtB,IAAI,EACJ,GAAG,EAAE,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,eAAe,CAAC,CACtD,CAAA;IACH,CAAC;IAES,YAAY,CAAE,IAAY;QAClC,OAAO,IAAI,CAAC,IAAI,CACd,IAAI,CAAC,QAAQ,EACb,IAAI,GAAG,MAAM,CACd,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAE,IAAY;QACzB,GAAG,CAAC,IAAI,CAAC,6BAA6B,EAAE,oDAAoD,EAAE,IAAI,KAAK,EAAE,CAAC,KAAK,CAAC,CAAA;QAChH,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACxB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI,CAAE,IAAY;QACtB,GAAG,CAAC,OAAO,CAAC,6BAA6B,EAAE,UAAU,EAAE,IAAI,CAAC,CAAA;QAE5D,MAAM,QAAQ,GAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;QACzC,MAAM,MAAM,GAAM,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAA;QAE/C,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1C,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAC3B,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QAC5B,CAAC,CAAC,CAAA;QAEF,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAE,MAAgB;QAC9B,GAAG,CAAC,OAAO,CAAC,6BAA6B,EAAE,gDAAgD,EAAE,IAAI,KAAK,EAAE,CAAC,KAAK,CAAC,CAAA;QAC/G,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC1B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI,CAAE,MAAgB;QAC1B,GAAG,CAAC,OAAO,CAAC,6BAA6B,EAAE,cAAc,CAAC,CAAA;QAE1D,MAAM,IAAI,GAAG,UAAU,EAAE,CAAA;QAEzB,MAAM,UAAU,GAAG,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAA;QAChE,MAAM,MAAM,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnD,MAAM,CAAC,EAAE,CAAC,KAAK,EAAS,OAAO,CAAC,CAAA;YAChC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAO,MAAM,CAAC,CAAA;YAC/B,UAAU,CAAC,EAAE,CAAC,OAAO,EAAG,MAAM,CAAC,CAAA;QACjC,CAAC,CAAC,CAAA;QACF,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QACvB,MAAM,MAAM,CAAA;QAEZ,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAA;QAE7B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACO,kBAAkB,CAAE,IAAY;QACxC,GAAG,CAAC,OAAO,CAAC,6BAA6B,EAAE,wBAAwB,EAAE,IAAI,CAAC,CAAA;QAE1E,MAAM,UAAU,GAAW,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAA;QAC/D,MAAM,kBAAkB,GAAG,mCAAmC,GAAG,EAAE,GAAG,IAAI,CAAA;QAE1E,uCAAuC;QACvC,MAAM,uBAAuB,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,kBAAkB,CAAC,GAAG,kBAAkB,CAAA;QAE/F,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,CAAA;QAC7D,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACnB,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,uBAAuB,EAAE,QAAQ,CAAC,CAAA;QAE7D,GAAG,CAAC,KAAK,CAAC,6BAA6B,EAAE,4DAA4D,EACnG,QAAQ,CAAC,MAAM,EACf,uBAAuB,CACxB,CAAA;IACH,CAAC;IAES,KAAK,CAAC,KAAK,CAAE,IAAY;QACjC,GAAG,CAAC,OAAO,CAAC,6BAA6B,EAAE,WAAW,EAAE,IAAI,CAAC,CAAA;QAE7D,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;QACpC,IAAI;YACF,MAAM,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC9B,GAAG,CAAC,KAAK,CAAC,6BAA6B,EAAE,YAAY,EAAE,IAAI,CAAC,CAAA;SAC7D;QAAC,OAAO,CAAC,EAAE;YACV,GAAG,CAAC,IAAI,CAAC,6BAA6B,EAAE,oBAAoB,EAAG,CAAW,CAAC,OAAO,CAAC,CAAA;SACpF;IACH,CAAC;IAED;;;;;;OAMG;IACH,OAAO;QACL,GAAG,CAAC,OAAO,CAAC,6BAA6B,EAAE,yBAAyB,EAClE,CAAE,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAE,CAAC,IAAI,EAAE,CAAC,MAAM,CACrD,CAAA;QAED,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,GAAG,CAAC,OAAO,CAAC,6BAA6B,EAAE,qCAAqC,CAAC,CAAA;YACjF,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;YAC/B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA;SAC7B;QAED,MAAM,KAAK,GAAG,eAAe,CAAC,IAAI,EAAE,2BAA2B,CAAC,CAAA;QAEhE;;WAEG;QACH,IAAI,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAClC,GAAG,CAAC,OAAO,CAAC,6BAA6B,EAAE,8CAA8C,CAAC,CAAA;YAC1F,MAAM,EAAE,GAAG,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;YACzC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YACjC,EAAE,IAAI,EAAE,EAAE,CAAA;SACX;QAED;;WAEG;QACH,GAAG,CAAC,OAAO,CAAC,6BAA6B,EAAE,6BAA6B,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;QACxF,IAAI;YACF;;;;;eAKG;YACH,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAE1B,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;YAC7C,GAAG,CAAC,OAAO,CAAC,6BAA6B,EAAE,8BAA8B,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;SAE1F;QAAC,OAAO,CAAC,EAAE;YACV,IAAK,CAA2B,CAAC,IAAI,KAAK,QAAQ,EAAE;gBAClD,GAAG,CAAC,OAAO,CAAC,6BAA6B,EAAE,wBAAwB,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;gBACnF,OAAM;aACP;YACD,GAAG,CAAC,IAAI,CAAC,6BAA6B,EAAE,uCAAuC,EAAG,CAAW,CAAC,OAAO,CAAC,CAAA;SACvG;IACH,CAAC;;AAIH,OAAO,EAAE,2BAA2B,EAAE,CAAA"}

package/dist/esm/src/urn-registry/uniform-resource-name-registry.spec.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+export {};
+//# sourceMappingURL=uniform-resource-name-registry.spec.d.ts.map

package/dist/esm/src/urn-registry/uniform-resource-name-registry.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uniform-resource-name-registry.spec.d.ts","sourceRoot":"","sources":["../../../../src/urn-registry/uniform-resource-name-registry.spec.ts"],"names":[],"mappings":""}

package/dist/esm/src/urn-registry/uniform-resource-name-registry.spec.js

@@ -0,0 +1,79 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+import { test, sinon, } from 'tstest';
+import { FileBox } from '../file-box.js';
+import { UniformResourceNameRegistry } from './uniform-resource-name-registry.js';
+test('UniformResourceNameRegistry class', async (t) => {
+    const QRCODE = 'test qrcode';
+    const urnRegistry = new UniformResourceNameRegistry();
+    await urnRegistry.init();
+    const fileBox = FileBox.fromQRCode(QRCODE);
+    const stream = await fileBox.toStream();
+    const uuid = await urnRegistry.save(stream);
+    const stream2 = await urnRegistry.load(uuid);
+    t.ok(stream2, 'should load stream');
+    const fileBox2 = FileBox.fromStream(stream2, 'test');
+    const qrcode = await fileBox2.toQRCode();
+    t.equal(qrcode, QRCODE, 'should get back the qrcode data');
+    await t.resolves(() => urnRegistry.load(uuid), 'should not reject when load a UUID again');
+    await urnRegistry.destroy();
+});
+test('expireMilliseconds: in time', async (t) => {
+    const expireMilliseconds = 3;
+    const urnRegistry = new UniformResourceNameRegistry({
+        expireMilliseconds,
+    });
+    await urnRegistry.init();
+    const uuid = await urnRegistry.save(await FileBox.fromQRCode('qr').toStream());
+    await new Promise(resolve => setTimeout(resolve, 1));
+    await t.resolves(() => urnRegistry.load(uuid), `should not expire after 1ms (with ${expireMilliseconds}ms expire)`);
+    await urnRegistry.destroy();
+});
+test('expireMilliseconds: time out', async (t) => {
+    const sandbox = sinon.createSandbox({
+        useFakeTimers: true,
+    });
+    const expireMilliseconds = 10 * 60 * 1000; // 10 minute
+    const urnRegistry = new UniformResourceNameRegistry({
+        expireMilliseconds,
+    });
+    await urnRegistry.init();
+    /**
+     * Time: 0
+     */
+    const uuid1 = await urnRegistry.save(await FileBox.fromQRCode('qr').toStream());
+    await t.resolves(() => urnRegistry.load(uuid1), 'should load uuid1 successfully');
+    /**
+     * Time: 5
+     */
+    await sandbox.clock.tickAsync(5 * 60 * 1000);
+    const uuid2 = await urnRegistry.save(await FileBox.fromQRCode('qr2').toStream());
+    await t.resolves(() => urnRegistry.load(uuid1), 'should load uuid1 successfully after 5 minutes');
+    await t.resolves(() => urnRegistry.load(uuid2), 'should load uuid2 successfully');
+    /**
+     * Time: 11
+     */
+    await sandbox.clock.tickAsync(6 * 60 * 1000);
+    await t.rejects(() => urnRegistry.load(uuid1), 'should load uuid1 fail because it is expired');
+    await t.resolves(() => urnRegistry.load(uuid2), 'should load uuid2 successfully 6 minutes after it has been saved');
+    /**
+     * Time 20
+     */
+    await sandbox.clock.tickAsync(9 * 60 * 1000);
+    await t.rejects(() => urnRegistry.load(uuid2), 'should load uuid2 fail because it is expired');
+    await urnRegistry.destroy();
+    sandbox.restore();
+});
+test('URN FileBox helper smoke testing', async (t) => {
+    const QRCODE = 'test qrcode';
+    const urnRegistry = new UniformResourceNameRegistry();
+    const UUIDFileBox = urnRegistry.getFileBox();
+    const uuid = await UUIDFileBox
+        .fromQRCode(QRCODE)
+        .toUuid();
+    const qrcode = await UUIDFileBox
+        .fromUuid(uuid)
+        .toQRCode();
+    t.equal(qrcode, QRCODE, 'should get back the qrcode data');
+    urnRegistry.destroy();
+});
+//# sourceMappingURL=uniform-resource-name-registry.spec.js.map

package/dist/esm/src/urn-registry/uniform-resource-name-registry.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uniform-resource-name-registry.spec.js","sourceRoot":"","sources":["../../../../src/urn-registry/uniform-resource-name-registry.spec.ts"],"names":[],"mappings":";AAEA,OAAO,EACL,IAAI,EACJ,KAAK,GACN,MAAgB,QAAQ,CAAA;AAEzB,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAExC,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAA;AAEjF,IAAI,CAAC,mCAAmC,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAClD,MAAM,MAAM,GAAG,aAAa,CAAA;IAE5B,MAAM,WAAW,GAAG,IAAI,2BAA2B,EAAE,CAAA;IACrD,MAAM,WAAW,CAAC,IAAI,EAAE,CAAA;IAExB,MAAM,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;IAC1C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAA;IAEvC,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAE3C,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC5C,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAA;IAEnC,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,OAAQ,EAAE,MAAM,CAAC,CAAA;IACrD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,CAAA;IAExC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,iCAAiC,CAAC,CAAA;IAE1D,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,0CAA0C,CAAC,CAAA;IAE1F,MAAM,WAAW,CAAC,OAAO,EAAE,CAAA;AAC7B,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,6BAA6B,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC5C,MAAM,kBAAkB,GAAG,CAAC,CAAA;IAC5B,MAAM,WAAW,GAAG,IAAI,2BAA2B,CAAC;QAClD,kBAAkB;KACnB,CAAC,CAAA;IACF,MAAM,WAAW,CAAC,IAAI,EAAE,CAAA;IAExB,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC9E,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;IACpD,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,qCAAqC,kBAAkB,YAAY,CAAC,CAAA;IAEnH,MAAM,WAAW,CAAC,OAAO,EAAE,CAAA;AAC7B,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,8BAA8B,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC7C,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAAC;QAClC,aAAa,EAAE,IAAI;KACpB,CAAC,CAAA;IAEF,MAAM,kBAAkB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA,CAAE,YAAY;IACvD,MAAM,WAAW,GAAG,IAAI,2BAA2B,CAAC;QAClD,kBAAkB;KACnB,CAAC,CAAA;IACF,MAAM,WAAW,CAAC,IAAI,EAAE,CAAA;IAExB;;OAEG;IACH,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC/E,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gCAAgC,CAAC,CAAA;IAEjF;;OAEG;IACH,MAAM,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAA;IAC5C,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;IAChF,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gDAAgD,CAAC,CAAA;IACjG,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gCAAgC,CAAC,CAAA;IAEjF;;OAEG;IACH,MAAM,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAA;IAC5C,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,8CAA8C,CAAC,CAAA;IAC9F,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,kEAAkE,CAAC,CAAA;IAEnH;;OAEG;IACH,MAAM,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAA;IAC5C,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,8CAA8C,CAAC,CAAA;IAE9F,MAAM,WAAW,CAAC,OAAO,EAAE,CAAA;IAC3B,OAAO,CAAC,OAAO,EAAE,CAAA;AACnB,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,kCAAkC,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACjD,MAAM,MAAM,GAAG,aAAa,CAAA;IAE5B,MAAM,WAAW,GAAG,IAAI,2BAA2B,EAAE,CAAA;IAErD,MAAM,WAAW,GAAG,WAAW,CAAC,UAAU,EAAE,CAAA;IAE5C,MAAM,IAAI,GAAG,MAAM,WAAW;SAC3B,UAAU,CAAC,MAAM,CAAC;SAClB,MAAM,EAAE,CAAA;IAEX,MAAM,MAAM,GAAG,MAAM,WAAW;SAC7B,QAAQ,CAAC,IAAI,CAAC;SACd,QAAQ,EAAE,CAAA;IAEb,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,iCAAiC,CAAC,CAAA;IAC1D,WAAW,CAAC,OAAO,EAAE,CAAA;AACvB,CAAC,CAAC,CAAA"}

package/dist/esm/src/urn-registry/uuid-to-big-int.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Convert UUID to BigInt
+ * @param uuid
+ * @returns BigInt
+ */
+declare function uuidToBigInt(uuid: string): BigInt;
+export { uuidToBigInt, };
+//# sourceMappingURL=uuid-to-big-int.d.ts.map

package/dist/esm/src/urn-registry/uuid-to-big-int.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uuid-to-big-int.d.ts","sourceRoot":"","sources":["../../../../src/urn-registry/uuid-to-big-int.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,iBAAS,YAAY,CAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAK3C;AAED,OAAO,EACL,YAAY,GACb,CAAA"}

package/dist/esm/src/urn-registry/uuid-to-big-int.js

@@ -0,0 +1,13 @@
+/**
+ * Convert UUID to BigInt
+ * @param uuid
+ * @returns BigInt
+ */
+function uuidToBigInt(uuid) {
+    // credit: https://stackoverflow.com/a/58014300/1123955
+    const hexBytes = `0x${uuid.replace(/-/g, '')}`;
+    const bigInteger = BigInt(hexBytes);
+    return bigInteger;
+}
+export { uuidToBigInt, };
+//# sourceMappingURL=uuid-to-big-int.js.map

package/dist/esm/src/urn-registry/uuid-to-big-int.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uuid-to-big-int.js","sourceRoot":"","sources":["../../../../src/urn-registry/uuid-to-big-int.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,SAAS,YAAY,CAAE,IAAY;IACjC,uDAAuD;IACvD,MAAM,QAAQ,GAAM,KAAK,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAA;IACjD,MAAM,UAAU,GAAI,MAAM,CAAC,QAAQ,CAAC,CAAA;IACpC,OAAO,UAAU,CAAA;AACnB,CAAC;AAED,OAAO,EACL,YAAY,GACb,CAAA"}

package/dist/esm/src/urn-registry/uuid-to-big-int.spec.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+export {};
+//# sourceMappingURL=uuid-to-big-int.spec.d.ts.map

package/dist/esm/src/urn-registry/uuid-to-big-int.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uuid-to-big-int.spec.d.ts","sourceRoot":"","sources":["../../../../src/urn-registry/uuid-to-big-int.spec.ts"],"names":[],"mappings":""}

package/dist/esm/src/urn-registry/uuid-to-big-int.spec.js

@@ -0,0 +1,15 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+import { test } from 'tstest';
+import { uuidToBigInt } from './uuid-to-big-int.js';
+test('uuidToBigInt() Nil UUID', async (t) => {
+    const uuid = '00000000-0000-0000-0000-000000000000';
+    const bigInt = uuidToBigInt(uuid);
+    t.equal(bigInt.toString(), '0', 'should get zero for a Nil UUID');
+});
+test('uuidToBigInt() Nil UUID', async (t) => {
+    const UUID = '00bd7c03-a690-48d3-a1fe-1314574e4fc1';
+    const EXPECTED = BigInt('0x00bd7c03a69048d3a1fe1314574e4fc1');
+    const bigInt = uuidToBigInt(UUID);
+    t.equal(bigInt, EXPECTED, 'should convert UUID right');
+});
+//# sourceMappingURL=uuid-to-big-int.spec.js.map

package/dist/esm/src/urn-registry/uuid-to-big-int.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uuid-to-big-int.spec.js","sourceRoot":"","sources":["../../../../src/urn-registry/uuid-to-big-int.spec.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,IAAI,EAAE,MAAO,QAAQ,CAAA;AAE9B,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAEnD,IAAI,CAAC,yBAAyB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACxC,MAAM,IAAI,GAAG,sCAAsC,CAAA;IACnD,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IACjC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,GAAG,EAAE,gCAAgC,CAAC,CAAA;AACnE,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,yBAAyB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACxC,MAAM,IAAI,GAAG,sCAAsC,CAAA;IACnD,MAAM,QAAQ,GAAG,MAAM,CAAC,oCAAoC,CAAC,CAAA;IAE7D,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IACjC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,2BAA2B,CAAC,CAAA;AACxD,CAAC,CAAC,CAAA"}

package/dist/esm/src/version.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto generated from scripts/generate-version.sh
+ */
+export declare const VERSION: string;
+//# sourceMappingURL=version.d.ts.map

package/dist/esm/src/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../src/version.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,OAAO,EAAE,MAAgB,CAAA"}

package/dist/esm/src/version.js

@@ -0,0 +1,5 @@
+/**
+ * This file was auto generated from scripts/generate-version.sh
+ */
+export const VERSION = '1.7.0';
+//# sourceMappingURL=version.js.map

package/dist/esm/src/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../src/version.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAW,OAAO,CAAA"}

package/dist/esm/src/version.spec.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+export {};
+//# sourceMappingURL=version.spec.d.ts.map

package/dist/esm/src/version.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.spec.d.ts","sourceRoot":"","sources":["../../../src/version.spec.ts"],"names":[],"mappings":""}

package/dist/esm/src/version.spec.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+import { test } from 'tstest';
+import { VERSION } from './version.js';
+test('Make sure the VERSION is fresh in source code', async (t) => {
+    t.equal(VERSION, '0.0.0', 'version should be 0.0.0 in source code, only updated before publish to NPM');
+});
+//# sourceMappingURL=version.spec.js.map

package/dist/esm/src/version.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.spec.js","sourceRoot":"","sources":["../../../src/version.spec.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,IAAI,EAAE,MAAO,QAAQ,CAAA;AAE9B,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAEtC,IAAI,CAAC,+CAA+C,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC9D,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,4EAA4E,CAAC,CAAA;AACzG,CAAC,CAAC,CAAA"}

package/dist/esm/tests/integration.spec.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+export {};
+//# sourceMappingURL=integration.spec.d.ts.map

package/dist/esm/tests/integration.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"integration.spec.d.ts","sourceRoot":"","sources":["../../../tests/integration.spec.ts"],"names":[],"mappings":""}

package/dist/esm/tests/integration.spec.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+import { test } from 'tstest';
+test('integration test', async (t) => {
+    t.pass('tbw');
+});
+//# sourceMappingURL=integration.spec.js.map

package/dist/esm/tests/integration.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"integration.spec.js","sourceRoot":"","sources":["../../../tests/integration.spec.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,IAAI,EAAE,MAAO,QAAQ,CAAA;AAE9B,IAAI,CAAC,kBAAkB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IACjC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AACf,CAAC,CAAC,CAAA"}

package/dist/esm/tests/network-timeout.spec.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+export {};
+//# sourceMappingURL=network-timeout.spec.d.ts.map

package/dist/esm/tests/network-timeout.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-timeout.spec.d.ts","sourceRoot":"","sources":["../../../tests/network-timeout.spec.ts"],"names":[],"mappings":""}

package/dist/esm/tests/network-timeout.spec.js

@@ -0,0 +1,119 @@
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+import { createServer } from 'http';
+import { setTimeout } from 'timers/promises';
+import { sinon, test } from 'tstest';
+import { FileBox } from '../src/mod.js';
+import { HTTP_TIMEOUT } from '../src/config.js';
+test('slow network stall HTTP_TIMEOUT', async (t) => {
+    const sandbox = sinon.createSandbox();
+    sandbox.useFakeTimers({
+        now: Date.now(),
+        shouldAdvanceTime: true,
+        shouldClearNativeTimers: true,
+        toFake: ['setTimeout', 'clearTimeout', 'setInterval', 'clearInterval', 'nextTick'],
+    });
+    t.jobs = 3;
+    const port = Math.floor(Math.random() * (65535 - 49152 + 1)) + 49152;
+    const URL = {
+        NOT_TIMEOUT: '/not_timeout',
+        READY: '/ready',
+        TIMEOUT: '/timeout',
+    };
+    /* eslint @typescript-eslint/no-misused-promises:off */
+    const server = createServer(async (req, res) => {
+        res.write(Buffer.from('This is the first chunk of data.'));
+        if (req.url === URL.NOT_TIMEOUT) {
+            await setTimeout(HTTP_TIMEOUT * 0.5);
+            res.write(Buffer.from('This is the second chunk of data.'));
+            await setTimeout(HTTP_TIMEOUT * 0.9);
+        }
+        else {
+            await setTimeout(HTTP_TIMEOUT + 100);
+        }
+        // console.debug(`${new Date().toLocaleTimeString()} call res.end "${req.url}"`)
+        res.end(Buffer.from('All data end.'));
+    });
+    const host = await new Promise((resolve) => {
+        server.listen(port, '127.0.0.1', () => {
+            const addr = server.address();
+            // console.debug(`Server is listening on port ${JSON.stringify(addr)}`)
+            resolve(`http://127.0.0.1:${addr.port}`);
+        });
+    });
+    t.teardown(() => {
+        // console.debug('teardown')
+        server.close();
+        sandbox.restore();
+    });
+    /** eslint @typescript-eslint/no-floating-promises:off */
+    t.test('should not timeout', async (t) => {
+        const url = `${host}${URL.NOT_TIMEOUT}`;
+        const dataSpy = sandbox.spy();
+        const errorSpy = sandbox.spy();
+        // console.debug(`${new Date().toLocaleTimeString()} Start request "${url}" ...`)
+        const start = Date.now();
+        const stream = await FileBox.fromUrl(url).toStream();
+        stream.once('error', errorSpy).on('data', dataSpy);
+        await sandbox.clock.tickAsync(1);
+        t.ok(dataSpy.calledOnce, `should get chunk 1 (${Date.now() - start} passed)`);
+        t.ok(errorSpy.notCalled, `should not get error (${Date.now() - start} passed)`);
+        // FIXME: tickAsync does not work on socket timeout
+        await new Promise((resolve) => {
+            stream.once('error', resolve).on('close', resolve);
+            // resolve(setTimeout(HTTP_TIMEOUT))
+        });
+        await sandbox.clock.tickAsync(1);
+        // await sandbox.clock.tickAsync(HTTP_TIMEOUT)
+        // t.comment('recv data count:', dataSpy.callCount)
+        // t.comment('recv error count:', errorSpy.callCount)
+        t.ok(dataSpy.calledThrice, `should get chunk 3 after TIMEOUT ${HTTP_TIMEOUT} (${Date.now() - start} passed)`);
+        t.ok(errorSpy.notCalled, `should not get error after TIMEOUT ${HTTP_TIMEOUT} (${Date.now() - start} passed)`);
+        t.end();
+    }).catch(t.threw);
+    /** eslint @typescript-eslint/no-floating-promises:off */
+    t.test('should timeout', async (t) => {
+        const url = `${host}${URL.TIMEOUT}`;
+        const dataSpy = sandbox.spy();
+        const errorSpy = sandbox.spy();
+        // console.debug(`${new Date().toLocaleTimeString()} Start request "${url}" ...`)
+        const start = Date.now();
+        const stream = await FileBox.fromUrl(url).toStream();
+        stream.once('error', errorSpy).once('data', dataSpy);
+        // .on('error', (e) => {
+        //   console.error(`on error for req "${url}":`, e.stack)
+        // })
+        // .on('data', (d: Buffer) => {
+        //   console.error(`on data for req "${url}":`, d.toString())
+        // })
+        await sandbox.clock.tickAsync(1);
+        // t.comment('recv data count:', dataSpy.callCount)
+        // t.comment('recv error count:', errorSpy.callCount)
+        t.ok(dataSpy.calledOnce, `should get chunk 1 (${Date.now() - start} passed)`);
+        t.ok(errorSpy.notCalled, `should not get error (${Date.now() - start} passed)`);
+        // FIXME: tickAsync does not work on socket timeout
+        await new Promise((resolve) => {
+            stream.once('error', resolve).on('close', resolve);
+            // resolve(setTimeout(HTTP_TIMEOUT))
+        });
+        await sandbox.clock.tickAsync(1);
+        // await sandbox.clock.tickAsync(HTTP_TIMEOUT)
+        // t.comment('recv data count:', dataSpy.callCount)
+        // t.comment('recv error count:', errorSpy.callCount)
+        t.ok(errorSpy.calledOnce, `should get error after TIMEOUT ${HTTP_TIMEOUT} (${Date.now() - start} passed)`);
+        t.end();
+    }).catch(t.threw);
+    /** eslint @typescript-eslint/no-floating-promises:off */
+    t.test('ready should timeout', async (t) => {
+        const url = `${host}${URL.READY}`;
+        const errorSpy = sandbox.spy();
+        // console.debug(`${new Date().toLocaleTimeString()} Start request "${url}" ...`)
+        const start = Date.now();
+        const fileBox = FileBox.fromUrl(url);
+        await fileBox.ready().catch(errorSpy);
+        await sandbox.clock.tickAsync(1);
+        // t.comment('recv error count:', errorSpy.callCount)
+        t.ok(errorSpy.calledOnce, `should get error after TIMEOUT ${HTTP_TIMEOUT} (${Date.now() - start} passed)`);
+        t.end();
+    }).catch(t.threw);
+});
+//# sourceMappingURL=network-timeout.spec.js.map

package/dist/esm/tests/network-timeout.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-timeout.spec.js","sourceRoot":"","sources":["../../../tests/network-timeout.spec.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AAEnC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAEpC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAEvC,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAE/C,IAAI,CAAC,iCAAiC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;IAClD,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,EAAE,CAAA;IACrC,OAAO,CAAC,aAAa,CAAC;QACpB,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE;QACf,iBAAiB,EAAE,IAAI;QACvB,uBAAuB,EAAE,IAAI;QAC7B,MAAM,EAAE,CAAE,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,eAAe,EAAE,UAAU,CAAE;KACrF,CAAC,CAAA;IACF,CAAC,CAAC,IAAI,GAAG,CAAC,CAAA;IACV,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAA;IACpE,MAAM,GAAG,GAAG;QACV,WAAW,EAAE,cAAc;QAC3B,KAAK,EAAE,QAAQ;QACf,OAAO,EAAE,UAAU;KACpB,CAAA;IAED,uDAAuD;IACvD,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QAC7C,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC,CAAA;QAE1D,IAAI,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,WAAW,EAAE;YAC/B,MAAM,UAAU,CAAC,YAAY,GAAG,GAAG,CAAC,CAAA;YACpC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC,CAAA;YAC3D,MAAM,UAAU,CAAC,YAAY,GAAG,GAAG,CAAC,CAAA;SACrC;aAAM;YACL,MAAM,UAAU,CAAC,YAAY,GAAG,GAAG,CAAC,CAAA;SACrC;QAED,gFAAgF;QAChF,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAA;IACvC,CAAC,CAAC,CAAA;IAEF,MAAM,IAAI,GAAG,MAAM,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,EAAE;QACjD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE;YACpC,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAiB,CAAA;YAC5C,uEAAuE;YACvE,OAAO,CAAC,oBAAoB,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;QAC1C,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE;QACd,4BAA4B;QAC5B,MAAM,CAAC,KAAK,EAAE,CAAA;QACd,OAAO,CAAC,OAAO,EAAE,CAAA;IACnB,CAAC,CAAC,CAAA;IAEF,yDAAyD;IACzD,CAAC,CAAC,IAAI,CAAC,oBAAoB,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QACvC,MAAM,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,CAAC,WAAW,EAAE,CAAA;QACvC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE,CAAA;QAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,CAAA;QAE9B,iFAAiF;QACjF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACxB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAA;QAEpD,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAElD,MAAM,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QAChC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,uBAAuB,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,UAAU,CAAC,CAAA;QAC7E,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,EAAE,yBAAyB,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,UAAU,CAAC,CAAA;QAE/E,mDAAmD;QACnD,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YAClC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAClD,oCAAoC;QACtC,CAAC,CAAC,CAAA;QACF,MAAM,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QAChC,8CAA8C;QAE9C,mDAAmD;QACnD,qDAAqD;QACrD,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,oCAAoC,YAAY,KAAK,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,UAAU,CAAC,CAAA;QAC7G,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,EAAE,sCAAsC,YAAY,KAAK,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,UAAU,CAAC,CAAA;QAC7G,CAAC,CAAC,GAAG,EAAE,CAAA;IACT,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;IAEjB,yDAAyD;IACzD,CAAC,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QACnC,MAAM,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,CAAC,OAAO,EAAE,CAAA;QACnC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE,CAAA;QAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,CAAA;QAE9B,iFAAiF;QACjF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACxB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAA;QAEpD,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACpD,wBAAwB;QACxB,yDAAyD;QACzD,KAAK;QACL,+BAA+B;QAC/B,6DAA6D;QAC7D,KAAK;QAEL,MAAM,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QAEhC,mDAAmD;QACnD,qDAAqD;QACrD,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,uBAAuB,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,UAAU,CAAC,CAAA;QAC7E,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,EAAE,yBAAyB,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,UAAU,CAAC,CAAA;QAE/E,mDAAmD;QACnD,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YAClC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAClD,oCAAoC;QACtC,CAAC,CAAC,CAAA;QACF,MAAM,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QAChC,8CAA8C;QAE9C,mDAAmD;QACnD,qDAAqD;QACrD,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,kCAAkC,YAAY,KAAK,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,UAAU,CAAC,CAAA;QAC1G,CAAC,CAAC,GAAG,EAAE,CAAA;IACT,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;IAEjB,yDAAyD;IACzD,CAAC,CAAC,IAAI,CAAC,sBAAsB,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QACzC,MAAM,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,CAAC,KAAK,EAAE,CAAA;QACjC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,CAAA;QAE9B,iFAAiF;QACjF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACxB,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QACpC,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;QAErC,MAAM,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QAChC,qDAAqD;QACrD,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,kCAAkC,YAAY,KAAK,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,UAAU,CAAC,CAAA;QAC1G,CAAC,CAAC,GAAG,EAAE,CAAA;IACT,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;AACnB,CAAC,CAAC,CAAA"}