@naturalcycles/nodejs-lib 12.59.0 → 12.62.1

package/src/stream/transform/transformMap.ts

@@ -26,9 +26,8 @@ export interface TransformMapOptions<IN = any, OUT = IN> {
    * Predicate to filter outgoing results (after mapper).
    * Allows to not emit all results.
    *
-   * Set to `r => r` (passthrough predicate) to pass ANY value (including undefined/null)
-   *
-   * @default to filter out undefined/null values, but pass anything else
+   * Defaults to "pass everything" (including null, undefined, etc).
+   * Simpler way to exclude certain cases is to return SKIP symbol from the mapper.
    */
   predicate?: AsyncPredicate<OUT>
 
@@ -60,10 +59,6 @@ export interface TransformMapOptions<IN = any, OUT = IN> {
   logger?: CommonLogger
 }
 
-export function notNullishPredicate(item: any): boolean {
-  return item !== undefined && item !== null
-}
-
 // doesn't work, cause here we don't construct our Transform instance ourselves
 // export class TransformMap extends AbortableTransform {}
 
@@ -85,7 +80,7 @@ export function transformMap<IN = any, OUT = IN>(
 ): TransformTyped<IN, OUT> {
   const {
     concurrency = 16,
-    predicate = notNullishPredicate,
+    predicate, // we now default to "no predicate" (meaning pass-everything)
     errorMode = ErrorMode.THROW_IMMEDIATELY,
     flattenArrayOutput,
     onError,
@@ -116,14 +111,12 @@ export function transformMap<IN = any, OUT = IN>(
       },
     },
     async function transformMapFn(this: AbortableTransform, chunk: IN, _, cb) {
-      index++
-      // console.log({chunk, _encoding})
-
       // Stop processing if isSettled (either THROW_IMMEDIATELY was fired or END received)
       if (isSettled) return cb()
 
+      const currentIndex = ++index
+
       try {
-        const currentIndex = index // because we need to pass it to 2 functions - mapper and predicate. Refers to INPUT index (since it may return multiple outputs)
         const res = await mapper(chunk, currentIndex)
         const passedResults = await pFilter(
           flattenArrayOutput && Array.isArray(res) ? res : [res],
@@ -132,14 +125,14 @@ export function transformMap<IN = any, OUT = IN>(
               isSettled = true // will be checked later
               return false
             }
-            return r !== SKIP && (await predicate(r, currentIndex))
+            return r !== SKIP && (!predicate || (await predicate(r, currentIndex)))
           },
         )
 
         passedResults.forEach(r => this.push(r))
 
         if (isSettled) {
-          logger.log(`transformMap END received at index ${index}`)
+          logger.log(`transformMap END received at index ${currentIndex}`)
           pipelineClose('transformMap', this, this.sourceReadable, this.streamDone, logger)
         }
 

package/src/stream/transform/transformMapSimple.ts

@@ -31,7 +31,7 @@ export function transformMapSimple<IN = any, OUT = IN>(
 
   return new Transform({
     objectMode: true,
-    transform(chunk: IN, _encoding, cb) {
+    transform(chunk: IN, _, cb) {
       try {
         cb(null, mapper(chunk, ++index))
       } catch (err) {

package/src/stream/transform/transformMapSync.ts

@@ -1,8 +1,16 @@
-import { Transform } from 'stream'
-import { AggregatedError, CommonLogger, ErrorMode, Mapper, Predicate } from '@naturalcycles/js-lib'
+import {
+  AggregatedError,
+  CommonLogger,
+  END,
+  ErrorMode,
+  Mapper,
+  Predicate,
+  SKIP,
+} from '@naturalcycles/js-lib'
 import { yellow } from '../../colors'
+import { AbortableTransform } from '../pipeline/pipeline'
 import { TransformTyped } from '../stream.model'
-import { notNullishPredicate } from './transformMap'
+import { pipelineClose } from '../stream.util'
 
 export interface TransformMapSyncOptions<IN = any, OUT = IN> {
   /**
@@ -20,9 +28,8 @@ export interface TransformMapSyncOptions<IN = any, OUT = IN> {
    * Predicate to filter outgoing results (after mapper).
    * Allows to not emit all results.
    *
-   * @default to filter out undefined/null values, but pass anything else
-   *
-   * Set to `r => r` (passthrough predicate) to pass ANY value (including undefined/null)
+   * Defaults to "pass everything".
+   * Simpler way to skip individual entries is to return SKIP symbol.
    */
   predicate?: Predicate<OUT>
 
@@ -47,6 +54,8 @@ export interface TransformMapSyncOptions<IN = any, OUT = IN> {
   logger?: CommonLogger
 }
 
+export class TransformMapSync extends AbortableTransform {}
+
 /**
  * Sync (not async) version of transformMap.
  * Supposedly faster, for cases when async is not needed.
@@ -58,7 +67,7 @@ export function transformMapSync<IN = any, OUT = IN>(
   let index = -1
 
   const {
-    predicate = notNullishPredicate,
+    predicate, // defaults to "no predicate" (pass everything)
     errorMode = ErrorMode.THROW_IMMEDIATELY,
     flattenArrayOutput = false,
     onError,
@@ -66,34 +75,39 @@ export function transformMapSync<IN = any, OUT = IN>(
     objectMode = true,
     logger = console,
   } = opt
-  let isRejected = false
+  let isSettled = false
   let errors = 0
   const collectedErrors: Error[] = [] // only used if errorMode == THROW_AGGREGATED
 
-  return new Transform({
+  return new TransformMapSync({
     objectMode,
     ...opt,
-    transform(this: Transform, chunk: IN, _encoding, cb) {
-      // Stop processing if THROW_IMMEDIATELY mode is used
-      if (isRejected && errorMode === ErrorMode.THROW_IMMEDIATELY) {
-        return cb()
-      }
+    transform(this: AbortableTransform, chunk: IN, _, cb) {
+      // Stop processing if isSettled
+      if (isSettled) return cb()
 
-      try {
-        if (!predicate(chunk, ++index)) {
-          cb() // signal that we've finished processing, but emit no output here
-          return
-        }
+      const currentIndex = ++index
 
+      try {
         // map and pass through
-        const v = mapper(chunk, index)
+        const v = mapper(chunk, currentIndex)
+
+        const passedResults = (flattenArrayOutput && Array.isArray(v) ? v : [v]).filter(r => {
+          if (r === END) {
+            isSettled = true // will be checked later
+            return false
+          }
+          return r !== SKIP && (!predicate || predicate(r, currentIndex))
+        })
 
-        if (flattenArrayOutput && Array.isArray(v)) {
-          // Pass each item individually
-          v.forEach(item => this.push(item))
-        } else {
-          cb(null, v)
+        passedResults.forEach(r => this.push(r))
+
+        if (isSettled) {
+          logger.log(`transformMapSync END received at index ${currentIndex}`)
+          pipelineClose('transformMapSync', this, this.sourceReadable, this.streamDone, logger)
         }
+
+        cb() // done processing
       } catch (err) {
         logger.error(err)
         errors++
@@ -107,7 +121,7 @@ export function transformMapSync<IN = any, OUT = IN>(
         }
 
         if (errorMode === ErrorMode.THROW_IMMEDIATELY) {
-          isRejected = true
+          isSettled = true
           // Emit error immediately
           return cb(err as Error)
         }

package/src/stream/transform/transformNoOp.ts

@@ -9,7 +9,7 @@ import { TransformTyped } from '../stream.model'
 export function transformNoOp<T = any>(): TransformTyped<T, T> {
   return new Transform({
     objectMode: true,
-    transform(chunk: T, _encoding, cb) {
+    transform(chunk: T, _, cb) {
       cb(null, chunk)
     },
   })

package/src/stream/transform/transformTap.ts

@@ -17,16 +17,16 @@ export function transformTap<IN>(
   opt: TransformTapOptions = {},
 ): TransformTyped<IN, IN> {
   const { logger = console } = opt
-  let index = 0
+  let index = -1
 
   return new Transform({
     objectMode: true,
     ...opt,
-    async transform(chunk: IN, _encoding, cb) {
+    async transform(chunk: IN, _, cb) {
       // console.log('tap', chunk)
 
       try {
-        await fn(chunk, index++)
+        await fn(chunk, ++index)
       } catch (err) {
         logger.error(err)
         // suppressed error

package/src/stream/transform/transformToArray.ts

@@ -10,7 +10,7 @@ export function transformToArray<IN>(opt: TransformOptions = {}): TransformTyped
   return new Transform({
     objectMode: true,
     ...opt,
-    transform(chunk: IN, _encoding, cb) {
+    transform(chunk: IN, _, cb) {
       res.push(chunk)
       // callback to signal that we processed input, but not emitting any output
       cb()

package/src/stream/transform/transformToString.ts

@@ -14,8 +14,8 @@ export function transformToString(): TransformTyped<Buffer, string> {
   return new Transform({
     objectMode: false,
     readableObjectMode: true,
-    transform(chunk: Buffer, _encoding, cb) {
-      // console.log(`enc: ${_encoding}`, chunk.toString())
+    transform(chunk: Buffer, _, cb) {
+      // console.log(`enc: ${_}`, chunk.toString())
       cb(null, chunk.toString())
     },
   })

package/src/stream/transform/worker/transformMultiThreaded.ts

@@ -115,7 +115,7 @@ export function transformMultiThreaded<IN, OUT>(
         }
       },
     },
-    async function transformMapFn(chunk: IN, _encoding, cb) {
+    async function transformMapFn(chunk: IN, _, cb) {
       // Freezing the index, because it may change due to concurrency
       const currentIndex = ++index
 

package/src/stream/writable/writableFork.ts

@@ -31,7 +31,7 @@ export function writableFork<T>(
   return new Writable({
     objectMode: true,
     ...opt,
-    write(chunk: T, _encoding, cb) {
+    write(chunk: T, _, cb) {
       // Push/fork to all sub-streams
       // No backpressure is ensured here, it'll push regardless of the
       readables.forEach(readable => readable.push(chunk))

package/src/stream/writable/writablePushToArray.ts

@@ -8,7 +8,7 @@ export function writablePushToArray<IN>(arr: IN[], opt: TransformOptions = {}):
   return new Writable({
     objectMode: true,
     ...opt,
-    write(chunk: IN, _encoding, cb) {
+    write(chunk: IN, _, cb) {
       arr.push(chunk)
       // callback to signal that we processed input, but not emitting any output
       cb()

package/src/stream/writable/writableVoid.ts

@@ -18,7 +18,7 @@ export function writableVoid(opt: WritableVoidOptions = {}): Writable {
   return new Writable({
     objectMode: true,
     ...opt,
-    write(chunk, _encoding, cb) {
+    write(chunk, _, cb) {
       cb()
     },
     final(cb) {

package/src/util/zip.util.ts

@@ -7,46 +7,52 @@ const inflate = promisify(zlib.inflate.bind(zlib))
 const gzip = promisify(zlib.gzip.bind(zlib))
 const gunzip = promisify(zlib.gunzip.bind(zlib))
 
-// string > zip
+// string > compressed buffer
+
 /**
- * zipBuffer uses `deflate`.
- * It's 9 bytes shorter than gzip.
+ * deflateBuffer uses `deflate`.
+ * It's 9 bytes shorter than `gzip`.
  */
-export async function zipBuffer(buf: Buffer, options: ZlibOptions = {}): Promise<Buffer> {
+export async function deflateBuffer(buf: Buffer, options: ZlibOptions = {}): Promise<Buffer> {
   return await deflate(buf, options)
 }
 
+export async function inflateBuffer(buf: Buffer, options: ZlibOptions = {}): Promise<Buffer> {
+  return await inflate(buf, options)
+}
+
+/**
+ * deflateString uses `deflate`.
+ * It's 9 bytes shorter than `gzip`.
+ */
+export async function deflateString(s: string, options?: ZlibOptions): Promise<Buffer> {
+  return await deflateBuffer(Buffer.from(s), options)
+}
+
+export async function inflateToString(buf: Buffer, options?: ZlibOptions): Promise<string> {
+  return (await inflateBuffer(buf, options)).toString()
+}
+
 /**
  * gzipBuffer uses `gzip`
- * It's 9 bytes longer than deflate.
+ * It's 9 bytes longer than `deflate`.
  */
 export async function gzipBuffer(buf: Buffer, options: ZlibOptions = {}): Promise<Buffer> {
   return await gzip(buf, options)
 }
 
-// zip > buffer
-export async function unzipBuffer(buf: Buffer, options: ZlibOptions = {}): Promise<Buffer> {
-  return await inflate(buf, options)
-}
-
 export async function gunzipBuffer(buf: Buffer, options: ZlibOptions = {}): Promise<Buffer> {
   return await gunzip(buf, options)
 }
 
-// convenience
-export async function zipString(s: string, options?: ZlibOptions): Promise<Buffer> {
-  return await zipBuffer(Buffer.from(s), options)
-}
-
+/**
+ * gzipString uses `gzip`.
+ * It's 9 bytes longer than `deflate`.
+ */
 export async function gzipString(s: string, options?: ZlibOptions): Promise<Buffer> {
   return await gzipBuffer(Buffer.from(s), options)
 }
 
-// convenience
-export async function unzipToString(buf: Buffer, options?: ZlibOptions): Promise<string> {
-  return (await unzipBuffer(buf, options)).toString()
-}
-
 export async function gunzipToString(buf: Buffer, options?: ZlibOptions): Promise<string> {
   return (await gunzipBuffer(buf, options)).toString()
 }