@naturalcycles/db-lib 10.47.0 → 10.48.0

package/dist/commondao/common.dao.d.ts

@@ -164,6 +164,10 @@ export declare class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity
     storageRowsToDBMs(rows: ObjectWithId[]): Promise<DBM[]>;
     private compress;
     private decompress;
+    /**
+     * Mutates `dbm`.
+     */
+    private decompressSync;
     anyToDBM(dbm: undefined, opt?: CommonDaoOptions): null;
     anyToDBM(dbm?: any, opt?: CommonDaoOptions): DBM;
     anyToDBMs(rows: DBM[], opt?: CommonDaoOptions): DBM[];

package/dist/commondao/common.dao.js

@@ -7,7 +7,7 @@ import { _filterUndefinedValues, _objectAssignExact, _omitWithUndefined, _pick,
 import { pMap } from '@naturalcycles/js-lib/promise/pMap.js';
 import { _objectKeys, _passthroughPredicate, _stringMapEntries, _stringMapValues, _typeCast, } from '@naturalcycles/js-lib/types';
 import { stringId } from '@naturalcycles/nodejs-lib';
-import { decompressZstdOrInflateToString, zstdCompress } from '@naturalcycles/nodejs-lib/zip';
+import { decompressZstdOrInflateToString, decompressZstdOrInflateToStringSync, zstdCompress, } from '@naturalcycles/nodejs-lib/zip';
 import { DBLibError } from '../cnst.js';
 import { RunnableDBQuery } from '../query/dbQuery.js';
 import { CommonDaoTransaction } from './commonDaoTransaction.js';
@@ -178,7 +178,10 @@ export class CommonDao {
         q.table = opt.table || q.table;
         let pipeline = this.cfg.db.streamQuery(q, opt);
         if (this.cfg.compress?.keys.length) {
-            pipeline = pipeline.map(async row => await this.storageRowToDBM(row));
+            pipeline = pipeline.map(async row => await this.storageRowToDBM(row), {
+                // lowered, to reduce the total buffer size a bit for uncompressed objects
+                highWaterMark: 16,
+            });
         }
         const isPartialQuery = !!q._selectedFieldNames;
         if (isPartialQuery)
@@ -192,7 +195,10 @@ export class CommonDao {
         q.table = opt.table || q.table;
         let pipeline = this.cfg.db.streamQuery(q, opt);
         if (this.cfg.compress?.keys.length) {
-            pipeline = pipeline.map(async row => await this.storageRowToDBM(row));
+            pipeline = pipeline.map(async row => await this.storageRowToDBM(row), {
+                // lowered, to reduce the total buffer size a bit for uncompressed objects
+                highWaterMark: 16,
+            });
         }
         const isPartialQuery = !!q._selectedFieldNames;
         if (isPartialQuery)
@@ -628,7 +634,12 @@ export class CommonDao {
         if (!this.cfg.compress?.keys.length)
             return row;
         const dbm = { ...row };
-        await this.decompress(dbm);
+        if (this.cfg.compress.syncMode) {
+            this.decompressSync(dbm);
+        }
+        else {
+            await this.decompress(dbm);
+        }
         return dbm;
     }
     /**
@@ -637,6 +648,13 @@ export class CommonDao {
     async storageRowsToDBMs(rows) {
         if (!this.cfg.compress?.keys.length)
             return rows;
+        if (this.cfg.compress.syncMode) {
+            return rows.map(row => {
+                const dbm = { ...row };
+                this.decompressSync(dbm);
+                return dbm;
+            });
+        }
         return await pMap(rows, async row => await this.storageRowToDBM(row));
     }
     /**
@@ -665,6 +683,18 @@ export class CommonDao {
         dbm.__compressed = undefined;
         Object.assign(dbm, properties);
     }
+    /**
+     * Mutates `dbm`.
+     */
+    decompressSync(dbm) {
+        _typeCast(dbm);
+        if (!Buffer.isBuffer(dbm.__compressed))
+            return; // No compressed data
+        const bufferString = decompressZstdOrInflateToStringSync(dbm.__compressed);
+        const properties = JSON.parse(bufferString);
+        dbm.__compressed = undefined;
+        Object.assign(dbm, properties);
+    }
     anyToDBM(dbm, _opt = {}) {
         if (!dbm)
             return null;

package/dist/commondao/common.dao.model.d.ts

@@ -185,6 +185,12 @@ export interface CommonDaoCfg<BM extends BaseDBEntity, DBM extends BaseDBEntity
          * Undefined will default to level 1 (not the 3, which is the zstd default)
          */
         level?: Integer;
+        /**
+         * When enabled, zstd decompression will be performed synchronously.
+         *
+         * @experimental
+         */
+        syncMode?: boolean;
     };
 }
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/db-lib",
   "type": "module",
-  "version": "10.47.0",
+  "version": "10.48.0",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@naturalcycles/nodejs-lib": "^15"

package/src/commondao/common.dao.model.ts

@@ -224,6 +224,12 @@ export interface CommonDaoCfg<
      * Undefined will default to level 1 (not the 3, which is the zstd default)
      */
     level?: Integer
+    /**
+     * When enabled, zstd decompression will be performed synchronously.
+     *
+     * @experimental
+     */
+    syncMode?: boolean
   }
 }
 

package/src/commondao/common.dao.ts

@@ -27,7 +27,11 @@ import type {
 import { stringId } from '@naturalcycles/nodejs-lib'
 import type { JsonSchema } from '@naturalcycles/nodejs-lib/ajv'
 import type { Pipeline } from '@naturalcycles/nodejs-lib/stream'
-import { decompressZstdOrInflateToString, zstdCompress } from '@naturalcycles/nodejs-lib/zip'
+import {
+  decompressZstdOrInflateToString,
+  decompressZstdOrInflateToStringSync,
+  zstdCompress,
+} from '@naturalcycles/nodejs-lib/zip'
 import { DBLibError } from '../cnst.js'
 import type {
   CommonDBSaveOptions,
@@ -254,7 +258,10 @@ export class CommonDao<
     let pipeline = this.cfg.db.streamQuery<DBM>(q, opt)
 
     if (this.cfg.compress?.keys.length) {
-      pipeline = pipeline.map(async row => await this.storageRowToDBM(row))
+      pipeline = pipeline.map(async row => await this.storageRowToDBM(row), {
+        // lowered, to reduce the total buffer size a bit for uncompressed objects
+        highWaterMark: 16,
+      })
     }
 
     const isPartialQuery = !!q._selectedFieldNames
@@ -272,7 +279,10 @@ export class CommonDao<
     let pipeline = this.cfg.db.streamQuery<DBM>(q, opt)
 
     if (this.cfg.compress?.keys.length) {
-      pipeline = pipeline.map(async row => await this.storageRowToDBM(row))
+      pipeline = pipeline.map(async row => await this.storageRowToDBM(row), {
+        // lowered, to reduce the total buffer size a bit for uncompressed objects
+        highWaterMark: 16,
+      })
     }
 
     const isPartialQuery = !!q._selectedFieldNames
@@ -823,7 +833,11 @@ export class CommonDao<
   async storageRowToDBM(row: ObjectWithId): Promise<DBM> {
     if (!this.cfg.compress?.keys.length) return row as DBM
     const dbm = { ...(row as DBM) }
-    await this.decompress(dbm)
+    if (this.cfg.compress.syncMode) {
+      this.decompressSync(dbm)
+    } else {
+      await this.decompress(dbm)
+    }
     return dbm
   }
 
@@ -832,6 +846,13 @@ export class CommonDao<
    */
   async storageRowsToDBMs(rows: ObjectWithId[]): Promise<DBM[]> {
     if (!this.cfg.compress?.keys.length) return rows as DBM[]
+    if (this.cfg.compress.syncMode) {
+      return rows.map(row => {
+        const dbm = { ...(row as DBM) }
+        this.decompressSync(dbm)
+        return dbm
+      })
+    }
     return await pMap(rows, async row => await this.storageRowToDBM(row))
   }
 
@@ -863,6 +884,19 @@ export class CommonDao<
     Object.assign(dbm, properties)
   }
 
+  /**
+   * Mutates `dbm`.
+   */
+  private decompressSync(dbm: DBM): void {
+    _typeCast<Compressed<DBM>>(dbm)
+    if (!Buffer.isBuffer(dbm.__compressed)) return // No compressed data
+
+    const bufferString = decompressZstdOrInflateToStringSync(dbm.__compressed)
+    const properties = JSON.parse(bufferString)
+    dbm.__compressed = undefined
+    Object.assign(dbm, properties)
+  }
+
   anyToDBM(dbm: undefined, opt?: CommonDaoOptions): null
   anyToDBM(dbm?: any, opt?: CommonDaoOptions): DBM
   anyToDBM(dbm?: DBM, _opt: CommonDaoOptions = {}): DBM | null {