@naturalcycles/nodejs-lib 12.56.1 → 12.57.0

package/dist/stream/transform/transformLimit.d.ts

@@ -1,5 +1,9 @@
+import { CommonLogger } from '@naturalcycles/js-lib';
 import { TransformOptions, TransformTyped } from '../stream.model';
+export interface TransformLimitOptions extends TransformOptions {
+    logger?: CommonLogger;
+}
 /**
  * 0 or falsy value means "no limit"
  */
-export declare function transformLimit<IN>(limit?: number, opt?: TransformOptions): TransformTyped<IN, IN>;
+export declare function transformLimit<IN>(limit?: number, opt?: TransformLimitOptions): TransformTyped<IN, IN>;

package/dist/stream/transform/transformLimit.js

@@ -6,6 +6,7 @@ const stream_1 = require("stream");
  * 0 or falsy value means "no limit"
  */
 function transformLimit(limit, opt = {}) {
+    const { logger = console } = opt;
     let index = 0;
     let ended = false;
     return new stream_1.Transform({
@@ -21,7 +22,7 @@ function transformLimit(limit, opt = {}) {
             }
             if (limit && index === limit) {
                 ended = true;
-                console.log(`transformLimit: limit of ${limit} reached`);
+                logger.log(`transformLimit: limit of ${limit} reached`);
                 // this.emit('end') // this makes it "halt" on Node 14 lts
             }
         },

package/dist/stream/transform/transformLogProgress.d.ts

@@ -1,4 +1,4 @@
-import { AnyObject } from '@naturalcycles/js-lib';
+import { AnyObject, CommonLogger } from '@naturalcycles/js-lib';
 import { TransformOptions, TransformTyped } from '../stream.model';
 export interface TransformLogProgressOptions<IN = any> extends TransformOptions {
     /**
@@ -69,6 +69,7 @@ export interface TransformLogProgressOptions<IN = any> extends TransformOptions
      * @default 1000
      */
     logEvery?: number;
+    logger?: CommonLogger;
     /**
      * Function to return extra properties to the "progress object".
      *

package/dist/stream/transform/transformLogProgress.js

@@ -15,7 +15,7 @@ const inspectOpt = {
  * Pass-through transform that optionally logs progress.
  */
 function transformLogProgress(opt = {}) {
-    const { metric = 'progress', heapTotal: logHeapTotal = false, heapUsed: logHeapUsed = false, rss: logRss = true, peakRSS: logPeakRSS = true, logRPS = true, logEvery = 1000, batchSize = 1, extra, } = opt;
+    const { metric = 'progress', heapTotal: logHeapTotal = false, heapUsed: logHeapUsed = false, rss: logRss = true, peakRSS: logPeakRSS = true, logRPS = true, logEvery = 1000, batchSize = 1, extra, logger = console, } = opt;
     const logProgress = opt.logProgress !== false && logEvery !== 0; // true by default
     const logEvery10 = logEvery * 10;
     const started = Date.now();
@@ -54,7 +54,7 @@ function transformLogProgress(opt = {}) {
         const rps10 = Math.round(sma.push(lastRPS));
         if (mem.rss > peakRSS)
             peakRSS = mem.rss;
-        console.log((0, util_1.inspect)({
+        logger.log((0, util_1.inspect)({
             [final ? `${metric}_final` : metric]: batchedProgress,
             ...(extra ? extra(chunk, progress) : {}),
             ...(logHeapUsed ? { heapUsed: (0, js_lib_1._mb)(mem.heapUsed) } : {}),
@@ -76,10 +76,10 @@ function transformLogProgress(opt = {}) {
             if (perHour > 900) {
                 perHour = Math.round(perHour / 1000) + 'K';
             }
-            console.log(`${(0, colors_1.dimGrey)((0, time_lib_1.dayjs)().toPretty())} ${(0, colors_1.white)(metric)} took ${(0, colors_1.yellow)((0, js_lib_1._since)(started))} so far to process ${(0, colors_1.yellow)(batchedProgress)} rows, ~${(0, colors_1.yellow)(perHour)}/hour`);
+            logger.log(`${(0, colors_1.dimGrey)((0, time_lib_1.dayjs)().toPretty())} ${(0, colors_1.white)(metric)} took ${(0, colors_1.yellow)((0, js_lib_1._since)(started))} so far to process ${(0, colors_1.yellow)(batchedProgress)} rows, ~${(0, colors_1.yellow)(perHour)}/hour`);
         }
         else if (final) {
-            console.log(`${(0, colors_1.boldWhite)(metric)} took ${(0, colors_1.yellow)((0, js_lib_1._since)(started))} to process ${(0, colors_1.yellow)(batchedProgress)} rows with total RPS of ${(0, colors_1.yellow)(rpsTotal)}`);
+            logger.log(`${(0, colors_1.boldWhite)(metric)} took ${(0, colors_1.yellow)((0, js_lib_1._since)(started))} to process ${(0, colors_1.yellow)(batchedProgress)} rows with total RPS of ${(0, colors_1.yellow)(rpsTotal)}`);
         }
     }
 }

package/dist/stream/transform/transformMapSimple.d.ts

@@ -1,4 +1,4 @@
-import { ErrorMode, Mapper } from '@naturalcycles/js-lib';
+import { CommonLogger, ErrorMode, Mapper } from '@naturalcycles/js-lib';
 import { TransformTyped } from '../stream.model';
 export interface TransformMapSimpleOptions {
     /**
@@ -7,6 +7,7 @@ export interface TransformMapSimpleOptions {
      * @default ErrorMode.THROW_IMMEDIATELY
      */
     errorMode?: ErrorMode.THROW_IMMEDIATELY | ErrorMode.SUPPRESS;
+    logger?: CommonLogger;
 }
 /**
  * Simplest version of `transformMap`.

package/dist/stream/transform/transformMapSimple.js

@@ -14,7 +14,7 @@ const js_lib_1 = require("@naturalcycles/js-lib");
  */
 function transformMapSimple(mapper, opt = {}) {
     let index = -1;
-    const { errorMode = js_lib_1.ErrorMode.THROW_IMMEDIATELY } = opt;
+    const { errorMode = js_lib_1.ErrorMode.THROW_IMMEDIATELY, logger = console } = opt;
     return new stream_1.Transform({
         objectMode: true,
         transform(chunk, _encoding, cb) {
@@ -22,7 +22,7 @@ function transformMapSimple(mapper, opt = {}) {
                 cb(null, mapper(chunk, ++index));
             }
             catch (err) {
-                console.error(err);
+                logger.error(err);
                 if (errorMode === js_lib_1.ErrorMode.SUPPRESS) {
                     cb(); // suppress the error
                 }

package/dist/stream/transform/transformMapSync.d.ts

@@ -1,4 +1,4 @@
-import { ErrorMode, Mapper, Predicate } from '@naturalcycles/js-lib';
+import { CommonLogger, ErrorMode, Mapper, Predicate } from '@naturalcycles/js-lib';
 import { TransformTyped } from '../stream.model';
 export interface TransformMapSyncOptions<IN = any, OUT = IN> {
     /**
@@ -34,6 +34,7 @@ export interface TransformMapSyncOptions<IN = any, OUT = IN> {
      * @default `stream`
      */
     metric?: string;
+    logger?: CommonLogger;
 }
 /**
  * Sync (not async) version of transformMap.

package/dist/stream/transform/transformMapSync.js

@@ -11,7 +11,7 @@ const transformMap_1 = require("./transformMap");
  */
 function transformMapSync(mapper, opt = {}) {
     let index = -1;
-    const { predicate = transformMap_1.notNullishPredicate, errorMode = js_lib_1.ErrorMode.THROW_IMMEDIATELY, flattenArrayOutput = false, onError, metric = 'stream', objectMode = true, } = opt;
+    const { predicate = transformMap_1.notNullishPredicate, errorMode = js_lib_1.ErrorMode.THROW_IMMEDIATELY, flattenArrayOutput = false, onError, metric = 'stream', objectMode = true, logger = console, } = opt;
     let isRejected = false;
     let errors = 0;
     const collectedErrors = []; // only used if errorMode == THROW_AGGREGATED
@@ -39,7 +39,7 @@ function transformMapSync(mapper, opt = {}) {
                 }
             }
             catch (err) {
-                console.error(err);
+                logger.error(err);
                 errors++;
                 logErrorStats();
                 if (onError) {
@@ -75,7 +75,7 @@ function transformMapSync(mapper, opt = {}) {
     function logErrorStats(final = false) {
         if (!errors)
             return;
-        console.log(`${metric} ${final ? 'final ' : ''}errors: ${(0, colors_1.yellow)(errors)}`);
+        logger.log(`${metric} ${final ? 'final ' : ''}errors: ${(0, colors_1.yellow)(errors)}`);
     }
 }
 exports.transformMapSync = transformMapSync;

package/dist/stream/transform/transformTap.d.ts

@@ -1,9 +1,12 @@
-import { AsyncMapper } from '@naturalcycles/js-lib';
+import { AsyncMapper, CommonLogger } from '@naturalcycles/js-lib';
 import { TransformOptions, TransformTyped } from '../stream.model';
+export interface TransformTapOptions extends TransformOptions {
+    logger?: CommonLogger;
+}
 /**
  * Similar to RxJS `tap` - allows to run a function for each stream item, without affecting the result.
  * Item is passed through to the output.
  *
  * Can also act as a counter, since `index` is passed to `fn`
  */
-export declare function transformTap<IN>(fn: AsyncMapper<IN, any>, opt?: TransformOptions): TransformTyped<IN, IN>;
+export declare function transformTap<IN>(fn: AsyncMapper<IN, any>, opt?: TransformTapOptions): TransformTyped<IN, IN>;

package/dist/stream/transform/transformTap.js

@@ -9,6 +9,7 @@ const stream_1 = require("stream");
  * Can also act as a counter, since `index` is passed to `fn`
  */
 function transformTap(fn, opt = {}) {
+    const { logger = console } = opt;
     let index = 0;
     return new stream_1.Transform({
         objectMode: true,
@@ -19,7 +20,7 @@ function transformTap(fn, opt = {}) {
                 await fn(chunk, index++);
             }
             catch (err) {
-                console.error(err);
+                logger.error(err);
                 // suppressed error
             }
             cb(null, chunk); // pass through the item

package/dist/stream/writable/writableFork.d.ts

@@ -5,5 +5,7 @@ import { TransformOptions, WritableTyped } from '../stream.model';
  * Currently does NOT (!) maintain backpressure.
  * Error in the forked pipeline will propagate up to the main pipeline (and log error, to be sure).
  * Will wait until all forked pipelines are completed before completing the stream.
+ *
+ * @experimental
  */
 export declare function writableFork<T>(chains: NodeJS.WritableStream[][], opt?: TransformOptions): WritableTyped<T>;

package/dist/stream/writable/writableFork.js

@@ -8,6 +8,8 @@ const __1 = require("../..");
  * Currently does NOT (!) maintain backpressure.
  * Error in the forked pipeline will propagate up to the main pipeline (and log error, to be sure).
  * Will wait until all forked pipelines are completed before completing the stream.
+ *
+ * @experimental
  */
 function writableFork(chains, opt) {
     const readables = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/nodejs-lib",
-  "version": "12.56.1",
+  "version": "12.57.0",
   "scripts": {
     "prepare": "husky install",
     "docs-serve": "vuepress dev docs",

package/src/stream/transform/transformLimit.ts

@@ -1,13 +1,19 @@
 import { Transform } from 'stream'
+import { CommonLogger } from '@naturalcycles/js-lib'
 import { TransformOptions, TransformTyped } from '../stream.model'
 
+export interface TransformLimitOptions extends TransformOptions {
+  logger?: CommonLogger
+}
+
 /**
  * 0 or falsy value means "no limit"
  */
 export function transformLimit<IN>(
   limit?: number,
-  opt: TransformOptions = {},
+  opt: TransformLimitOptions = {},
 ): TransformTyped<IN, IN> {
+  const { logger = console } = opt
   let index = 0
   let ended = false
 
@@ -25,7 +31,7 @@ export function transformLimit<IN>(
 
       if (limit && index === limit) {
         ended = true
-        console.log(`transformLimit: limit of ${limit} reached`)
+        logger.log(`transformLimit: limit of ${limit} reached`)
         // this.emit('end') // this makes it "halt" on Node 14 lts
       }
     },

package/src/stream/transform/transformLogProgress.ts

@@ -1,6 +1,6 @@
 import { Transform } from 'stream'
 import { inspect, InspectOptions } from 'util'
-import { SimpleMovingAverage, _mb, _since, AnyObject } from '@naturalcycles/js-lib'
+import { SimpleMovingAverage, _mb, _since, AnyObject, CommonLogger } from '@naturalcycles/js-lib'
 import { dayjs } from '@naturalcycles/time-lib'
 import { boldWhite, dimGrey, white, yellow } from '../../colors'
 import { hasColors } from '../../colors/colors'
@@ -86,6 +86,8 @@ export interface TransformLogProgressOptions<IN = any> extends TransformOptions
    */
   logEvery?: number
 
+  logger?: CommonLogger
+
   /**
    * Function to return extra properties to the "progress object".
    *
@@ -124,6 +126,7 @@ export function transformLogProgress<IN = any>(
     logEvery = 1000,
     batchSize = 1,
     extra,
+    logger = console,
   } = opt
   const logProgress = opt.logProgress !== false && logEvery !== 0 // true by default
   const logEvery10 = logEvery * 10
@@ -172,7 +175,7 @@ export function transformLogProgress<IN = any>(
     const rps10 = Math.round(sma.push(lastRPS))
     if (mem.rss > peakRSS) peakRSS = mem.rss
 
-    console.log(
+    logger.log(
       inspect(
         {
           [final ? `${metric}_final` : metric]: batchedProgress,
@@ -202,13 +205,13 @@ export function transformLogProgress<IN = any>(
         perHour = Math.round(perHour / 1000) + 'K'
       }
 
-      console.log(
+      logger.log(
         `${dimGrey(dayjs().toPretty())} ${white(metric)} took ${yellow(
           _since(started),
         )} so far to process ${yellow(batchedProgress)} rows, ~${yellow(perHour)}/hour`,
       )
     } else if (final) {
-      console.log(
+      logger.log(
         `${boldWhite(metric)} took ${yellow(_since(started))} to process ${yellow(
           batchedProgress,
         )} rows with total RPS of ${yellow(rpsTotal)}`,

package/src/stream/transform/transformMapSimple.ts

@@ -1,5 +1,5 @@
 import { Transform } from 'stream'
-import { ErrorMode, Mapper } from '@naturalcycles/js-lib'
+import { CommonLogger, ErrorMode, Mapper } from '@naturalcycles/js-lib'
 import { TransformTyped } from '../stream.model'
 
 export interface TransformMapSimpleOptions {
@@ -9,6 +9,8 @@ export interface TransformMapSimpleOptions {
    * @default ErrorMode.THROW_IMMEDIATELY
    */
   errorMode?: ErrorMode.THROW_IMMEDIATELY | ErrorMode.SUPPRESS
+
+  logger?: CommonLogger
 }
 
 /**
@@ -25,7 +27,7 @@ export function transformMapSimple<IN = any, OUT = IN>(
   opt: TransformMapSimpleOptions = {},
 ): TransformTyped<IN, OUT> {
   let index = -1
-  const { errorMode = ErrorMode.THROW_IMMEDIATELY } = opt
+  const { errorMode = ErrorMode.THROW_IMMEDIATELY, logger = console } = opt
 
   return new Transform({
     objectMode: true,
@@ -33,7 +35,7 @@ export function transformMapSimple<IN = any, OUT = IN>(
       try {
         cb(null, mapper(chunk, ++index))
       } catch (err) {
-        console.error(err)
+        logger.error(err)
 
         if (errorMode === ErrorMode.SUPPRESS) {
           cb() // suppress the error

package/src/stream/transform/transformMapSync.ts

@@ -1,5 +1,5 @@
 import { Transform } from 'stream'
-import { AggregatedError, ErrorMode, Mapper, Predicate } from '@naturalcycles/js-lib'
+import { AggregatedError, CommonLogger, ErrorMode, Mapper, Predicate } from '@naturalcycles/js-lib'
 import { yellow } from '../../colors'
 import { TransformTyped } from '../stream.model'
 import { notNullishPredicate } from './transformMap'
@@ -43,6 +43,8 @@ export interface TransformMapSyncOptions<IN = any, OUT = IN> {
    * @default `stream`
    */
   metric?: string
+
+  logger?: CommonLogger
 }
 
 /**
@@ -62,6 +64,7 @@ export function transformMapSync<IN = any, OUT = IN>(
     onError,
     metric = 'stream',
     objectMode = true,
+    logger = console,
   } = opt
   let isRejected = false
   let errors = 0
@@ -92,7 +95,7 @@ export function transformMapSync<IN = any, OUT = IN>(
           cb(null, v)
         }
       } catch (err) {
-        console.error(err)
+        logger.error(err)
         errors++
 
         logErrorStats()
@@ -134,6 +137,6 @@ export function transformMapSync<IN = any, OUT = IN>(
   function logErrorStats(final = false): void {
     if (!errors) return
 
-    console.log(`${metric} ${final ? 'final ' : ''}errors: ${yellow(errors)}`)
+    logger.log(`${metric} ${final ? 'final ' : ''}errors: ${yellow(errors)}`)
   }
 }

package/src/stream/transform/transformTap.ts

@@ -1,7 +1,11 @@
 import { Transform } from 'stream'
-import { AsyncMapper } from '@naturalcycles/js-lib'
+import { AsyncMapper, CommonLogger } from '@naturalcycles/js-lib'
 import { TransformOptions, TransformTyped } from '../stream.model'
 
+export interface TransformTapOptions extends TransformOptions {
+  logger?: CommonLogger
+}
+
 /**
  * Similar to RxJS `tap` - allows to run a function for each stream item, without affecting the result.
  * Item is passed through to the output.
@@ -10,8 +14,9 @@ import { TransformOptions, TransformTyped } from '../stream.model'
  */
 export function transformTap<IN>(
   fn: AsyncMapper<IN, any>,
-  opt: TransformOptions = {},
+  opt: TransformTapOptions = {},
 ): TransformTyped<IN, IN> {
+  const { logger = console } = opt
   let index = 0
 
   return new Transform({
@@ -23,7 +28,7 @@ export function transformTap<IN>(
       try {
         await fn(chunk, index++)
       } catch (err) {
-        console.error(err)
+        logger.error(err)
         // suppressed error
       }
 

package/src/stream/writable/writableFork.ts

@@ -7,6 +7,8 @@ import { TransformOptions, WritableTyped } from '../stream.model'
  * Currently does NOT (!) maintain backpressure.
  * Error in the forked pipeline will propagate up to the main pipeline (and log error, to be sure).
  * Will wait until all forked pipelines are completed before completing the stream.
+ *
+ * @experimental
  */
 export function writableFork<T>(
   chains: NodeJS.WritableStream[][],