@naturalcycles/db-lib 8.24.0 → 8.24.4

package/dist/adapter/cachedb/cache.db.model.d.ts

@@ -33,9 +33,7 @@ export interface CacheDBCfg {
      */
     logDownstream?: boolean;
     /**
-     * Pass noopLogger (or undefined) to skip logging completely.
-     *
-     * @default console
+     * Defaults to `console`.
      */
     logger?: CommonLogger;
 }

package/dist/adapter/file/file.db.model.d.ts

@@ -19,7 +19,7 @@ export interface FileDBCfg {
      */
     sortObjects?: boolean;
     /**
-     * @default console
+     * Defaults to `console`.
      */
     logger?: CommonLogger;
     /**

package/dist/adapter/inmemory/inMemory.db.d.ts

@@ -31,7 +31,7 @@ export interface InMemoryDBCfg {
      */
     persistZip: boolean;
     /**
-     * @default console
+     * Defaults to `console`.
      */
     logger?: CommonLogger;
 }

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

@@ -1,4 +1,4 @@
-import { AsyncMapper, JsonSchemaObject, JsonSchemaRootObject, Saved, ObjectWithId } from '@naturalcycles/js-lib';
+import { AsyncMapper, JsonSchemaObject, JsonSchemaRootObject, ObjectWithId, Saved } from '@naturalcycles/js-lib';
 import { AjvSchema, ObjectSchemaTyped, ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { DBModelType, RunQueryResult } from '../db.model';
 import { DBQuery, RunnableDBQuery } from '../query/dbQuery';
@@ -137,7 +137,7 @@ export declare class CommonDao<BM extends Partial<ObjectWithId>, DBM extends Obj
      *
      * Does NOT mutate the object.
      */
-    validateAndConvert<IN, OUT = IN>(obj: IN, schema?: ObjectSchemaTyped<IN> | AjvSchema<IN>, modelType?: DBModelType, opt?: CommonDaoOptions): OUT;
+    validateAndConvert<IN, OUT = IN>(obj: Partial<IN>, schema: ObjectSchemaTyped<IN> | AjvSchema<IN> | undefined, modelType: DBModelType, opt?: CommonDaoOptions): OUT;
     getTableSchema(): Promise<JsonSchemaRootObject<DBM>>;
     createTable(schema: JsonSchemaObject<DBM>, opt?: CommonDaoCreateOptions): Promise<void>;
     /**

package/dist/commondao/common.dao.js

@@ -8,6 +8,8 @@ const db_model_1 = require("../db.model");
 const dbQuery_1 = require("../query/dbQuery");
 const common_dao_model_1 = require("./common.dao.model");
 /* eslint-disable no-dupe-class-members */
+const isGAE = !!process.env['GAE_INSTANCE'];
+const isCI = !!process.env['CI'];
 /**
  * Lowest common denominator API between supported Databases.
  *
@@ -19,7 +21,10 @@ class CommonDao {
     constructor(cfg) {
         this.cfg = cfg;
         this.cfg = {
-            logLevel: common_dao_model_1.CommonDaoLogLevel.OPERATIONS,
+            // Default is to NOT log in AppEngine and in CI,
+            // otherwise to log Operations
+            // e.g in Dev (local machine), Test - it will log operations (useful for debugging)
+            logLevel: isGAE || isCI ? common_dao_model_1.CommonDaoLogLevel.NONE : common_dao_model_1.CommonDaoLogLevel.OPERATIONS,
             createdUpdated: true,
             logger: console,
             ...cfg,
@@ -732,8 +737,6 @@ class CommonDao {
     async ping() {
         await this.cfg.db.ping();
     }
-    // todo: logging
-    // todo: bmToDBM, etc. How?
     // transaction(): DBTransaction {
     //   return this.cfg.db.transaction()
     // }
@@ -745,7 +748,7 @@ class CommonDao {
         if (Array.isArray(res)) {
             logRes = `${res.length} row(s)`;
             if (res.length && this.cfg.logLevel >= common_dao_model_1.CommonDaoLogLevel.DATA_FULL) {
-                args.push('\n', res.slice(0, 10)); // max 10 items
+                args.push('\n', ...res.slice(0, 10)); // max 10 items
             }
         }
         else if (res) {
@@ -757,7 +760,7 @@ class CommonDao {
         else {
             logRes = `undefined`;
         }
-        this.cfg.logger?.log(...[`<< ${table}.${op}: ${logRes} in ${(0, js_lib_1._since)(started)}`].concat(args));
+        this.cfg.logger?.log(`<< ${table}.${op}: ${logRes} in ${(0, js_lib_1._since)(started)}`, ...args);
     }
     logSaveResult(started, op, table) {
         if (!this.cfg.logLevel)

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

@@ -1,4 +1,4 @@
-import { CommonLogger, ErrorMode, ObjectWithId } from '@naturalcycles/js-lib';
+import { CommonLogger, ErrorMode, ObjectWithId, Saved } from '@naturalcycles/js-lib';
 import { AjvSchema, AjvValidationError, JoiValidationError, ObjectSchemaTyped, TransformLogProgressOptions, TransformMapOptions } from '@naturalcycles/nodejs-lib';
 import { CommonDB } from '../common.db';
 import { CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions } from '../db.model';
@@ -34,11 +34,20 @@ export declare enum CommonDaoLogLevel {
      * Same as undefined
      */
     NONE = 0,
+    /**
+     * Log operations (e.g "getById returned 1 row"), but not data
+     */
     OPERATIONS = 10,
+    /**
+     * Log operations and data for single operations (e.g getById), but not batch operations.
+     */
     DATA_SINGLE = 20,
+    /**
+     * Log EVERYTHING - all data passing in and out (max 10 rows). Very verbose!
+     */
     DATA_FULL = 30
 }
-export interface CommonDaoCfg<BM extends Partial<ObjectWithId>, DBM extends ObjectWithId, TM> {
+export interface CommonDaoCfg<BM extends Partial<ObjectWithId>, DBM extends ObjectWithId = Saved<BM>, TM = BM> {
     db: CommonDB;
     table: string;
     /**
@@ -54,9 +63,7 @@ export interface CommonDaoCfg<BM extends Partial<ObjectWithId>, DBM extends Obje
      */
     readOnly?: boolean;
     /**
-     * Pass undefined (or noopLogger) to disable logging completely.
-     *
-     * @default console
+     * Defaults to `console`
      */
     logger?: CommonLogger;
     /**

package/dist/commondao/common.dao.model.js

@@ -7,7 +7,16 @@ var CommonDaoLogLevel;
      * Same as undefined
      */
     CommonDaoLogLevel[CommonDaoLogLevel["NONE"] = 0] = "NONE";
+    /**
+     * Log operations (e.g "getById returned 1 row"), but not data
+     */
     CommonDaoLogLevel[CommonDaoLogLevel["OPERATIONS"] = 10] = "OPERATIONS";
+    /**
+     * Log operations and data for single operations (e.g getById), but not batch operations.
+     */
     CommonDaoLogLevel[CommonDaoLogLevel["DATA_SINGLE"] = 20] = "DATA_SINGLE";
+    /**
+     * Log EVERYTHING - all data passing in and out (max 10 rows). Very verbose!
+     */
     CommonDaoLogLevel[CommonDaoLogLevel["DATA_FULL"] = 30] = "DATA_FULL";
 })(CommonDaoLogLevel = exports.CommonDaoLogLevel || (exports.CommonDaoLogLevel = {}));

package/dist/pipeline/dbPipelineRestore.js

@@ -78,7 +78,7 @@ async function dbPipelineRestore(opt) {
                 ...opt,
                 metric: table,
             }),
-            (0, nodejs_lib_1.transformLimit)(limit),
+            (0, nodejs_lib_1.transformLimit)({ limit }),
             ...(sinceUpdated
                 ? [(0, nodejs_lib_1.transformFilterSync)(r => r.updated >= sinceUpdated)]
                 : []),

package/package.json

@@ -42,7 +42,7 @@
   "engines": {
     "node": ">=14.15"
   },
-  "version": "8.24.0",
+  "version": "8.24.4",
   "description": "Lowest Common Denominator API to supported Databases",
   "keywords": [
     "db",

package/src/adapter/cachedb/cache.db.model.ts

@@ -40,9 +40,7 @@ export interface CacheDBCfg {
   logDownstream?: boolean
 
   /**
-   * Pass noopLogger (or undefined) to skip logging completely.
-   *
-   * @default console
+   * Defaults to `console`.
    */
   logger?: CommonLogger
 }

package/src/adapter/file/file.db.model.ts

@@ -24,7 +24,7 @@ export interface FileDBCfg {
   sortObjects?: boolean
 
   /**
-   * @default console
+   * Defaults to `console`.
    */
   logger?: CommonLogger
 

package/src/adapter/inmemory/inMemory.db.ts

@@ -65,7 +65,7 @@ export interface InMemoryDBCfg {
   persistZip: boolean
 
   /**
-   * @default console
+   * Defaults to `console`.
    */
   logger?: CommonLogger
 }

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

@@ -1,4 +1,4 @@
-import { CommonLogger, ErrorMode, ObjectWithId } from '@naturalcycles/js-lib'
+import { CommonLogger, ErrorMode, ObjectWithId, Saved } from '@naturalcycles/js-lib'
 import {
   AjvSchema,
   AjvValidationError,
@@ -46,12 +46,25 @@ export enum CommonDaoLogLevel {
    * Same as undefined
    */
   NONE = 0,
+  /**
+   * Log operations (e.g "getById returned 1 row"), but not data
+   */
   OPERATIONS = 10,
+  /**
+   * Log operations and data for single operations (e.g getById), but not batch operations.
+   */
   DATA_SINGLE = 20,
+  /**
+   * Log EVERYTHING - all data passing in and out (max 10 rows). Very verbose!
+   */
   DATA_FULL = 30,
 }
 
-export interface CommonDaoCfg<BM extends Partial<ObjectWithId>, DBM extends ObjectWithId, TM> {
+export interface CommonDaoCfg<
+  BM extends Partial<ObjectWithId>,
+  DBM extends ObjectWithId = Saved<BM>,
+  TM = BM,
+> {
   db: CommonDB
   table: string
 
@@ -71,9 +84,7 @@ export interface CommonDaoCfg<BM extends Partial<ObjectWithId>, DBM extends Obje
   readOnly?: boolean
 
   /**
-   * Pass undefined (or noopLogger) to disable logging completely.
-   *
-   * @default console
+   * Defaults to `console`
    */
   logger?: CommonLogger
 

package/src/commondao/common.dao.ts

@@ -1,20 +1,21 @@
 import {
+  _filterNullishValues,
+  _filterUndefinedValues,
+  _passthroughPredicate,
+  _since,
+  _truncate,
+  _uniqBy,
   AppError,
   AsyncMapper,
   ErrorMode,
   JsonSchemaObject,
-  _passthroughPredicate,
-  _since,
-  _truncate,
-  pMap,
   JsonSchemaRootObject,
-  Saved,
-  _uniqBy,
   ObjectWithId,
-  _filterUndefinedValues,
-  _filterNullishValues,
+  pMap,
+  Saved,
 } from '@naturalcycles/js-lib'
 import {
+  _pipeline,
   AjvSchema,
   AjvValidationError,
   getValidationResult,
@@ -22,14 +23,13 @@ import {
   ObjectSchemaTyped,
   ReadableTyped,
   stringId,
+  transformBuffer,
   transformLogProgress,
   transformMap,
   transformMapSimple,
   transformMapSync,
   transformTap,
   writableVoid,
-  _pipeline,
-  transformBuffer,
 } from '@naturalcycles/nodejs-lib'
 import { DBLibError } from '../cnst'
 import { DBModelType, RunQueryResult } from '../db.model'
@@ -46,6 +46,9 @@ import {
 
 /* eslint-disable no-dupe-class-members */
 
+const isGAE = !!process.env['GAE_INSTANCE']
+const isCI = !!process.env['CI']
+
 /**
  * Lowest common denominator API between supported Databases.
  *
@@ -60,7 +63,10 @@ export class CommonDao<
 > {
   constructor(public cfg: CommonDaoCfg<BM, DBM, TM>) {
     this.cfg = {
-      logLevel: CommonDaoLogLevel.OPERATIONS,
+      // Default is to NOT log in AppEngine and in CI,
+      // otherwise to log Operations
+      // e.g in Dev (local machine), Test - it will log operations (useful for debugging)
+      logLevel: isGAE || isCI ? CommonDaoLogLevel.NONE : CommonDaoLogLevel.OPERATIONS,
       createdUpdated: true,
       logger: console,
       ...cfg,
@@ -897,9 +903,9 @@ export class CommonDao<
    * Does NOT mutate the object.
    */
   validateAndConvert<IN, OUT = IN>(
-    obj: IN,
-    schema?: ObjectSchemaTyped<IN> | AjvSchema<IN>,
-    modelType?: DBModelType,
+    obj: Partial<IN>,
+    schema: ObjectSchemaTyped<IN> | AjvSchema<IN> | undefined,
+    modelType: DBModelType,
     opt: CommonDaoOptions = {},
   ): OUT {
     // `raw` option completely bypasses any processing
@@ -922,12 +928,12 @@ export class CommonDao<
 
     // Pre-validation hooks
     if (modelType === DBModelType.DBM) {
-      obj = this.cfg.hooks!.beforeDBMValidate!(obj as any) as any
+      obj = this.cfg.hooks!.beforeDBMValidate!(obj as any) as IN
     }
 
     // Return as is if no schema is passed or if `skipConversion` is set
     if (!schema || opt.skipConversion) {
-      return obj as any
+      return obj as OUT
     }
 
     // This will Convert and Validate
@@ -941,12 +947,12 @@ export class CommonDao<
       // Ajv schema
       convertedValue = obj // because Ajv mutates original object
 
-      error = schema.getValidationError(obj, {
+      error = schema.getValidationError(obj as IN, {
         objectName,
       })
     } else {
       // Joi
-      const vr = getValidationResult<IN, OUT>(obj, schema, objectName)
+      const vr = getValidationResult<IN, OUT>(obj as IN, schema, objectName)
       error = vr.error
       convertedValue = vr.value
     }
@@ -977,8 +983,6 @@ export class CommonDao<
     await this.cfg.db.ping()
   }
 
-  // todo: logging
-  // todo: bmToDBM, etc. How?
   // transaction(): DBTransaction {
   //   return this.cfg.db.transaction()
   // }
@@ -992,7 +996,7 @@ export class CommonDao<
     if (Array.isArray(res)) {
       logRes = `${res.length} row(s)`
       if (res.length && this.cfg.logLevel >= CommonDaoLogLevel.DATA_FULL) {
-        args.push('\n', res.slice(0, 10)) // max 10 items
+        args.push('\n', ...res.slice(0, 10)) // max 10 items
       }
     } else if (res) {
       logRes = `1 row`
@@ -1003,7 +1007,7 @@ export class CommonDao<
       logRes = `undefined`
     }
 
-    this.cfg.logger?.log(...[`<< ${table}.${op}: ${logRes} in ${_since(started)}`].concat(args))
+    this.cfg.logger?.log(`<< ${table}.${op}: ${logRes} in ${_since(started)}`, ...args)
   }
 
   protected logSaveResult(started: number, op: string, table: string): void {

package/src/pipeline/dbPipelineRestore.ts

@@ -209,7 +209,7 @@ export async function dbPipelineRestore(opt: DBPipelineRestoreOptions): Promise<
           ...opt,
           metric: table,
         }),
-        transformLimit(limit),
+        transformLimit({ limit }),
         ...(sinceUpdated
           ? [transformFilterSync<SavedDBEntity>(r => r.updated >= sinceUpdated)]
           : []),