@naturalcycles/db-lib 10.52.0 → 10.53.0

package/dist/commondao/common.dao.js

@@ -653,12 +653,17 @@ export class CommonDao {
     async compress(dbm) {
         if (!this.cfg.compress?.keys.length)
             return; // No compression requested
-        const { keys, level = 1 } = this.cfg.compress;
+        const { keys, level = 1, warnSizeBytes, onOversizeWarning } = this.cfg.compress;
         const properties = _pick(dbm, keys);
         const bufferString = JSON.stringify(properties);
         // Unlike `decompress`, we're testing to use async zstd compression.
         // Async Decompression leaks memory severely. But Compression seems fine.
         const __compressed = await zip2.zstdCompress(bufferString, level);
+        if (warnSizeBytes && onOversizeWarning && __compressed.byteLength > warnSizeBytes) {
+            // Shallow-clone: `dbm` is mutated below (omit source keys + assign __compressed),
+            // so we hand the hook a snapshot of the pre-mutation state.
+            onOversizeWarning({ ...dbm }, __compressed.byteLength);
+        }
         _omitWithUndefined(dbm, _objectKeys(properties), { mutate: true });
         Object.assign(dbm, { __compressed });
     }

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

@@ -185,6 +185,22 @@ 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;
+        /**
+         * If set, `onOversizeWarning` is invoked whenever the resulting `__compressed`
+         * Buffer exceeds this size in bytes. Useful for monitoring rows approaching
+         * DB row-size limits (e.g. Datastore's 1MB per entity).
+         *
+         * No-op unless `onOversizeWarning` is also provided.
+         */
+        warnSizeBytes?: number;
+        /**
+         * Invoked when the `__compressed` Buffer exceeds `warnSizeBytes`.
+         *
+         * Called with a shallow clone of the DBM (since the original is mutated
+         * later in the compression step) and the resulting compressed size in bytes.
+         * The consumer decides how to surface the warning (Sentry, logger, metrics, etc.).
+         */
+        onOversizeWarning?: (dbm: DBM, size: number) => void;
     };
 }
 /**

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@naturalcycles/db-lib",
   "type": "module",
-  "version": "10.52.0",
+  "version": "10.53.0",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@naturalcycles/nodejs-lib": "^15"
   },
   "devDependencies": {
     "@typescript/native-preview": "beta",
-    "@naturalcycles/dev-lib": "20.48.0"
+    "@naturalcycles/dev-lib": "18.4.2"
   },
   "files": [
     "dist",

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

@@ -224,6 +224,22 @@ export interface CommonDaoCfg<
      * Undefined will default to level 1 (not the 3, which is the zstd default)
      */
     level?: Integer
+    /**
+     * If set, `onOversizeWarning` is invoked whenever the resulting `__compressed`
+     * Buffer exceeds this size in bytes. Useful for monitoring rows approaching
+     * DB row-size limits (e.g. Datastore's 1MB per entity).
+     *
+     * No-op unless `onOversizeWarning` is also provided.
+     */
+    warnSizeBytes?: number
+    /**
+     * Invoked when the `__compressed` Buffer exceeds `warnSizeBytes`.
+     *
+     * Called with a shallow clone of the DBM (since the original is mutated
+     * later in the compression step) and the resulting compressed size in bytes.
+     * The consumer decides how to surface the warning (Sentry, logger, metrics, etc.).
+     */
+    onOversizeWarning?: (dbm: DBM, size: number) => void
   }
 }
 

package/src/commondao/common.dao.ts

@@ -849,12 +849,17 @@ export class CommonDao<
   private async compress(dbm: DBM): Promise<void> {
     if (!this.cfg.compress?.keys.length) return // No compression requested
 
-    const { keys, level = 1 } = this.cfg.compress
+    const { keys, level = 1, warnSizeBytes, onOversizeWarning } = this.cfg.compress
     const properties = _pick(dbm, keys)
     const bufferString = JSON.stringify(properties)
     // Unlike `decompress`, we're testing to use async zstd compression.
     // Async Decompression leaks memory severely. But Compression seems fine.
     const __compressed = await zip2.zstdCompress(bufferString, level)
+    if (warnSizeBytes && onOversizeWarning && __compressed.byteLength > warnSizeBytes) {
+      // Shallow-clone: `dbm` is mutated below (omit source keys + assign __compressed),
+      // so we hand the hook a snapshot of the pre-mutation state.
+      onOversizeWarning({ ...dbm }, __compressed.byteLength)
+    }
     _omitWithUndefined(dbm as any, _objectKeys(properties), { mutate: true })
     Object.assign(dbm, { __compressed })
   }