@powersync/common 1.51.0 → 1.52.0

package/lib/utils/DataStream.js

@@ -1,169 +0,0 @@
-import Logger from 'js-logger';
-import { BaseObserver } from './BaseObserver.js';
-export const DEFAULT_PRESSURE_LIMITS = {
-    highWater: 10,
-    lowWater: 0
-};
-/**
- * A very basic implementation of a data stream with backpressure support which does not use
- * native JS streams or async iterators.
- * This is handy for environments such as React Native which need polyfills for the above.
- */
-export class DataStream extends BaseObserver {
-    options;
-    dataQueue;
-    isClosed;
-    processingPromise;
-    notifyDataAdded;
-    logger;
-    mapLine;
-    constructor(options) {
-        super();
-        this.options = options;
-        this.processingPromise = null;
-        this.isClosed = false;
-        this.dataQueue = [];
-        this.mapLine = options?.mapLine ?? ((line) => line);
-        this.logger = options?.logger ?? Logger.get('DataStream');
-        if (options?.closeOnError) {
-            const l = this.registerListener({
-                error: (ex) => {
-                    l?.();
-                    this.close();
-                }
-            });
-        }
-    }
-    get highWatermark() {
-        return this.options?.pressure?.highWaterMark ?? DEFAULT_PRESSURE_LIMITS.highWater;
-    }
-    get lowWatermark() {
-        return this.options?.pressure?.lowWaterMark ?? DEFAULT_PRESSURE_LIMITS.lowWater;
-    }
-    get closed() {
-        return this.isClosed;
-    }
-    async close() {
-        this.isClosed = true;
-        await this.processingPromise;
-        this.iterateListeners((l) => l.closed?.());
-        // Discard any data in the queue
-        this.dataQueue = [];
-        this.listeners.clear();
-    }
-    /**
-     * Enqueues data for the consumers to read
-     */
-    enqueueData(data) {
-        if (this.isClosed) {
-            throw new Error('Cannot enqueue data into closed stream.');
-        }
-        this.dataQueue.push(data);
-        this.notifyDataAdded?.();
-        this.processQueue();
-    }
-    /**
-     * Reads data once from the data stream
-     * @returns a Data payload or Null if the stream closed.
-     */
-    async read() {
-        if (this.closed) {
-            return null;
-        }
-        // Wait for any pending processing to complete first.
-        // This ensures we register our listener before calling processQueue(),
-        // avoiding a race where processQueue() sees no reader and returns early.
-        if (this.processingPromise) {
-            await this.processingPromise;
-        }
-        // Re-check after await - stream may have closed while we were waiting
-        if (this.closed) {
-            return null;
-        }
-        return new Promise((resolve, reject) => {
-            const l = this.registerListener({
-                data: async (data) => {
-                    resolve(data);
-                    // Remove the listener
-                    l?.();
-                },
-                closed: () => {
-                    resolve(null);
-                    l?.();
-                },
-                error: (ex) => {
-                    reject(ex);
-                    l?.();
-                }
-            });
-            this.processQueue();
-        });
-    }
-    /**
-     * Executes a callback for each data item in the stream
-     */
-    forEach(callback) {
-        if (this.dataQueue.length <= this.lowWatermark) {
-            this.iterateAsyncErrored(async (l) => l.lowWater?.());
-        }
-        return this.registerListener({
-            data: callback
-        });
-    }
-    processQueue() {
-        if (this.processingPromise) {
-            return;
-        }
-        const promise = (this.processingPromise = this._processQueue());
-        promise.finally(() => {
-            this.processingPromise = null;
-        });
-        return promise;
-    }
-    hasDataReader() {
-        return Array.from(this.listeners.values()).some((l) => !!l.data);
-    }
-    async _processQueue() {
-        /**
-         * Allow listeners to mutate the queue before processing.
-         * This allows for operations such as dropping or compressing data
-         * on high water or requesting more data on low water.
-         */
-        if (this.dataQueue.length >= this.highWatermark) {
-            await this.iterateAsyncErrored(async (l) => l.highWater?.());
-        }
-        if (this.isClosed || !this.hasDataReader()) {
-            return;
-        }
-        if (this.dataQueue.length) {
-            const data = this.dataQueue.shift();
-            const mapped = this.mapLine(data);
-            await this.iterateAsyncErrored(async (l) => l.data?.(mapped));
-        }
-        if (this.dataQueue.length <= this.lowWatermark) {
-            const dataAdded = new Promise((resolve) => {
-                this.notifyDataAdded = resolve;
-            });
-            await Promise.race([this.iterateAsyncErrored(async (l) => l.lowWater?.()), dataAdded]);
-            this.notifyDataAdded = null;
-        }
-        if (this.dataQueue.length > 0) {
-            setTimeout(() => this.processQueue());
-        }
-    }
-    async iterateAsyncErrored(cb) {
-        // Important: We need to copy the listeners, as calling a listener could result in adding another
-        // listener, resulting in infinite loops.
-        const listeners = Array.from(this.listeners.values());
-        for (let i of listeners) {
-            try {
-                await cb(i);
-            }
-            catch (ex) {
-                this.logger.error(ex);
-                this.iterateListeners((l) => l.error?.(ex));
-            }
-        }
-    }
-}
-//# sourceMappingURL=DataStream.js.map

package/lib/utils/DataStream.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"DataStream.js","sourceRoot":"","sources":["../../src/utils/DataStream.ts"],"names":[],"mappings":"AAAA,OAAO,MAAmB,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAgB,YAAY,EAAE,MAAM,mBAAmB,CAAC;AA0B/D,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,SAAS,EAAE,EAAE;IACb,QAAQ,EAAE,CAAC;CACZ,CAAC;AAEF;;;;GAIG;AACH,MAAM,OAAO,UAAyC,SAAQ,YAA4C;IAYlF;IAXtB,SAAS,CAAe;IAEd,QAAQ,CAAU;IAElB,iBAAiB,CAAuB;IACxC,eAAe,CAAsB;IAErC,MAAM,CAAU;IAEhB,OAAO,CAAmC;IAEpD,YAAsB,OAAmD;QACvE,KAAK,EAAE,CAAC;QADY,YAAO,GAAP,OAAO,CAA4C;QAEvE,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,OAAO,GAAG,OAAO,EAAE,OAAO,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAW,CAAC,CAAC;QAE3D,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAE1D,IAAI,OAAO,EAAE,YAAY,EAAE,CAAC;YAC1B,MAAM,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;gBAC9B,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE;oBACZ,CAAC,EAAE,EAAE,CAAC;oBACN,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,CAAC;aACF,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,aAAa,IAAI,uBAAuB,CAAC,SAAS,CAAC;IACpF,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,IAAI,uBAAuB,CAAC,QAAQ,CAAC;IAClF,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,MAAM,IAAI,CAAC,iBAAiB,CAAC;QAC7B,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAC3C,gCAAgC;QAChC,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,IAAgB;QAC1B,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC7D,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1B,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;QAEzB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,qDAAqD;QACrD,uEAAuE;QACvE,yEAAyE;QACzE,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3B,MAAM,IAAI,CAAC,iBAAiB,CAAC;QAC/B,CAAC;QAED,sEAAsE;QACtE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;gBAC9B,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;oBACnB,OAAO,CAAC,IAAI,CAAC,CAAC;oBACd,sBAAsB;oBACtB,CAAC,EAAE,EAAE,CAAC;gBACR,CAAC;gBACD,MAAM,EAAE,GAAG,EAAE;oBACX,OAAO,CAAC,IAAI,CAAC,CAAC;oBACd,CAAC,EAAE,EAAE,CAAC;gBACR,CAAC;gBACD,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE;oBACZ,MAAM,CAAC,EAAE,CAAC,CAAC;oBACX,CAAC,EAAE,EAAE,CAAC;gBACR,CAAC;aACF,CAAC,CAAC;YAEH,IAAI,CAAC,YAAY,EAAE,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,QAAwC;QAC9C,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YAC/C,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACxD,CAAC;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAC;YAC3B,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;IACL,CAAC;IAES,YAAY;QACpB,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3B,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QAChE,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE;YACnB,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;IAES,aAAa;QACrB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACnE,CAAC;IAES,KAAK,CAAC,aAAa;QAC3B;;;;WAIG;QACH,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAChD,MAAM,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAC/D,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YAC3C,OAAO;QACT,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAG,CAAC;YACrC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAClC,MAAM,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QAChE,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YAC/C,MAAM,SAAS,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBAC9C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;YACvF,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC9B,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAES,KAAK,CAAC,mBAAmB,CAAC,EAAiE;QACnG,iGAAiG;QACjG,yCAAyC;QACzC,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;QACtD,KAAK,IAAI,CAAC,IAAI,SAAS,EAAE,CAAC;YACxB,IAAI,CAAC;gBACH,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;YACd,CAAC;YAAC,OAAO,EAAE,EAAE,CAAC;gBACZ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACtB,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

package/src/utils/DataStream.ts

@@ -1,222 +0,0 @@
-import Logger, { ILogger } from 'js-logger';
-import { BaseListener, BaseObserver } from './BaseObserver.js';
-
-export type DataStreamOptions<ParsedData, SourceData> = {
-  mapLine?: (line: SourceData) => ParsedData;
-
-  /**
-   * Close the stream if any consumer throws an error
-   */
-  closeOnError?: boolean;
-  pressure?: {
-    highWaterMark?: number;
-    lowWaterMark?: number;
-  };
-  logger?: ILogger;
-};
-
-export type DataStreamCallback<Data extends any = any> = (data: Data) => Promise<void>;
-
-export interface DataStreamListener<Data extends any = any> extends BaseListener {
-  data: (data: Data) => Promise<void>;
-  closed: () => void;
-  error: (error: Error) => void;
-  highWater: () => Promise<void>;
-  lowWater: () => Promise<void>;
-}
-
-export const DEFAULT_PRESSURE_LIMITS = {
-  highWater: 10,
-  lowWater: 0
-};
-
-/**
- * A very basic implementation of a data stream with backpressure support which does not use
- * native JS streams or async iterators.
- * This is handy for environments such as React Native which need polyfills for the above.
- */
-export class DataStream<ParsedData, SourceData = any> extends BaseObserver<DataStreamListener<ParsedData>> {
-  dataQueue: SourceData[];
-
-  protected isClosed: boolean;
-
-  protected processingPromise: Promise<void> | null;
-  protected notifyDataAdded: (() => void) | null;
-
-  protected logger: ILogger;
-
-  protected mapLine: (line: SourceData) => ParsedData;
-
-  constructor(protected options?: DataStreamOptions<ParsedData, SourceData>) {
-    super();
-    this.processingPromise = null;
-    this.isClosed = false;
-    this.dataQueue = [];
-    this.mapLine = options?.mapLine ?? ((line) => line as any);
-
-    this.logger = options?.logger ?? Logger.get('DataStream');
-
-    if (options?.closeOnError) {
-      const l = this.registerListener({
-        error: (ex) => {
-          l?.();
-          this.close();
-        }
-      });
-    }
-  }
-
-  get highWatermark() {
-    return this.options?.pressure?.highWaterMark ?? DEFAULT_PRESSURE_LIMITS.highWater;
-  }
-
-  get lowWatermark() {
-    return this.options?.pressure?.lowWaterMark ?? DEFAULT_PRESSURE_LIMITS.lowWater;
-  }
-
-  get closed() {
-    return this.isClosed;
-  }
-
-  async close() {
-    this.isClosed = true;
-    await this.processingPromise;
-    this.iterateListeners((l) => l.closed?.());
-    // Discard any data in the queue
-    this.dataQueue = [];
-    this.listeners.clear();
-  }
-
-  /**
-   * Enqueues data for the consumers to read
-   */
-  enqueueData(data: SourceData) {
-    if (this.isClosed) {
-      throw new Error('Cannot enqueue data into closed stream.');
-    }
-
-    this.dataQueue.push(data);
-    this.notifyDataAdded?.();
-
-    this.processQueue();
-  }
-
-  /**
-   * Reads data once from the data stream
-   * @returns a Data payload or Null if the stream closed.
-   */
-  async read(): Promise<ParsedData | null> {
-    if (this.closed) {
-      return null;
-    }
-
-    // Wait for any pending processing to complete first.
-    // This ensures we register our listener before calling processQueue(),
-    // avoiding a race where processQueue() sees no reader and returns early.
-    if (this.processingPromise) {
-      await this.processingPromise;
-    }
-
-    // Re-check after await - stream may have closed while we were waiting
-    if (this.closed) {
-      return null;
-    }
-
-    return new Promise((resolve, reject) => {
-      const l = this.registerListener({
-        data: async (data) => {
-          resolve(data);
-          // Remove the listener
-          l?.();
-        },
-        closed: () => {
-          resolve(null);
-          l?.();
-        },
-        error: (ex) => {
-          reject(ex);
-          l?.();
-        }
-      });
-
-      this.processQueue();
-    });
-  }
-
-  /**
-   * Executes a callback for each data item in the stream
-   */
-  forEach(callback: DataStreamCallback<ParsedData>) {
-    if (this.dataQueue.length <= this.lowWatermark) {
-      this.iterateAsyncErrored(async (l) => l.lowWater?.());
-    }
-
-    return this.registerListener({
-      data: callback
-    });
-  }
-
-  protected processQueue() {
-    if (this.processingPromise) {
-      return;
-    }
-
-    const promise = (this.processingPromise = this._processQueue());
-    promise.finally(() => {
-      this.processingPromise = null;
-    });
-    return promise;
-  }
-
-  protected hasDataReader() {
-    return Array.from(this.listeners.values()).some((l) => !!l.data);
-  }
-
-  protected async _processQueue() {
-    /**
-     * Allow listeners to mutate the queue before processing.
-     * This allows for operations such as dropping or compressing data
-     * on high water or requesting more data on low water.
-     */
-    if (this.dataQueue.length >= this.highWatermark) {
-      await this.iterateAsyncErrored(async (l) => l.highWater?.());
-    }
-
-    if (this.isClosed || !this.hasDataReader()) {
-      return;
-    }
-
-    if (this.dataQueue.length) {
-      const data = this.dataQueue.shift()!;
-      const mapped = this.mapLine(data);
-      await this.iterateAsyncErrored(async (l) => l.data?.(mapped));
-    }
-
-    if (this.dataQueue.length <= this.lowWatermark) {
-      const dataAdded = new Promise<void>((resolve) => {
-        this.notifyDataAdded = resolve;
-      });
-
-      await Promise.race([this.iterateAsyncErrored(async (l) => l.lowWater?.()), dataAdded]);
-      this.notifyDataAdded = null;
-    }
-
-    if (this.dataQueue.length > 0) {
-      setTimeout(() => this.processQueue());
-    }
-  }
-
-  protected async iterateAsyncErrored(cb: (l: Partial<DataStreamListener<ParsedData>>) => Promise<void>) {
-    // Important: We need to copy the listeners, as calling a listener could result in adding another
-    // listener, resulting in infinite loops.
-    const listeners = Array.from(this.listeners.values());
-    for (let i of listeners) {
-      try {
-        await cb(i);
-      } catch (ex) {
-        this.logger.error(ex);
-        this.iterateListeners((l) => l.error?.(ex));
-      }
-    }
-  }
-}