@milaboratories/pl-client 2.11.7 → 2.11.9

package/dist/core/client.js

@@ -0,0 +1,267 @@
+import { LLPlClient } from './ll_client.js';
+import { toGlobalResourceId, PlTransaction, TxCommitConflict } from './transaction.js';
+import { createHash } from 'node:crypto';
+import { NullResourceId, isNullResourceId, ensureResourceIdNotNull } from './types.js';
+import { ClientRoot } from '../helpers/pl.js';
+import { assertNever, createRetryState, nextRetryStateOrError } from '@milaboratories/ts-helpers';
+import { MaintenanceAPI_Ping_Response_Compression } from '../proto/github.com/milaboratory/pl/plapi/plapiproto/api.js';
+import * as tp from 'node:timers/promises';
+import { LRUCache } from 'lru-cache';
+import { DefaultFinalResourceDataPredicate } from './final.js';
+import { initialTxStat, addStat } from './stat.js';
+
+const defaultTxOps = {
+    sync: false,
+};
+const AnonymousClientRoot = 'AnonymousRoot';
+function alternativeRootFieldName(alternativeRoot) {
+    return `alternative_root_${alternativeRoot}`;
+}
+/** Client to access core PL API. */
+class PlClient {
+    drivers = new Map();
+    /** Artificial delay introduced after write transactions completion, to
+     * somewhat throttle the load on pl. Delay introduced after sync, if requested. */
+    txDelay;
+    /** Last resort measure to solve complicated race conditions in pl. */
+    forceSync;
+    /** Last resort measure to solve complicated race conditions in pl. */
+    defaultRetryOptions;
+    buildLLPlClient;
+    _ll;
+    /** Stores client root (this abstraction is intended for future implementation of the security model) */
+    _clientRoot = NullResourceId;
+    _serverInfo = undefined;
+    _txCommittedStat = initialTxStat();
+    _txConflictStat = initialTxStat();
+    _txErrorStat = initialTxStat();
+    //
+    // Caching
+    //
+    /** This function determines whether resource data can be cached */
+    finalPredicate;
+    /** Resource data cache, to minimize redundant data rereading from remote db */
+    resourceDataCache;
+    constructor(configOrAddress, auth, ops = {}) {
+        // Will reinitialize client after getting available feature from server.
+        this.buildLLPlClient = (shouldUseGzip) => {
+            return new LLPlClient(configOrAddress, { auth, ...ops, shouldUseGzip });
+        };
+        this._ll = this.buildLLPlClient(false);
+        const conf = this._ll.conf;
+        this.txDelay = conf.txDelay;
+        this.forceSync = conf.forceSync;
+        this.finalPredicate = ops.finalPredicate ?? DefaultFinalResourceDataPredicate;
+        this.resourceDataCache = new LRUCache({
+            maxSize: conf.maxCacheBytes,
+            sizeCalculation: (v) => (v.basicData.data?.length ?? 0) + 64,
+        });
+        switch (conf.retryBackoffAlgorithm) {
+            case 'exponential':
+                this.defaultRetryOptions = {
+                    type: 'exponentialBackoff',
+                    initialDelay: conf.retryInitialDelay,
+                    maxAttempts: conf.retryMaxAttempts,
+                    backoffMultiplier: conf.retryExponentialBackoffMultiplier,
+                    jitter: conf.retryJitter,
+                };
+                break;
+            case 'linear':
+                this.defaultRetryOptions = {
+                    type: 'linearBackoff',
+                    initialDelay: conf.retryInitialDelay,
+                    maxAttempts: conf.retryMaxAttempts,
+                    backoffStep: conf.retryLinearBackoffStep,
+                    jitter: conf.retryJitter,
+                };
+                break;
+            default:
+                assertNever(conf.retryBackoffAlgorithm);
+        }
+    }
+    get txCommittedStat() {
+        return { ...this._txCommittedStat };
+    }
+    get txConflictStat() {
+        return { ...this._txConflictStat };
+    }
+    get txErrorStat() {
+        return { ...this._txErrorStat };
+    }
+    get txTotalStat() {
+        return addStat(addStat(this._txCommittedStat, this._txConflictStat), this._txErrorStat);
+    }
+    get allTxStat() {
+        return {
+            committed: this.txCommittedStat,
+            conflict: this.txConflictStat,
+            error: this.txErrorStat,
+        };
+    }
+    async ping() {
+        return (await this._ll.grpcPl.get().ping({})).response;
+    }
+    get conf() {
+        return this._ll.conf;
+    }
+    get httpDispatcher() {
+        return this._ll.httpDispatcher;
+    }
+    get grpcTransport() {
+        return this._ll.grpcTransport;
+    }
+    get initialized() {
+        return !isNullResourceId(this._clientRoot);
+    }
+    checkInitialized() {
+        if (!this.initialized)
+            throw new Error('Client not initialized');
+    }
+    get clientRoot() {
+        this.checkInitialized();
+        return ensureResourceIdNotNull(this._clientRoot);
+    }
+    get serverInfo() {
+        this.checkInitialized();
+        return this._serverInfo;
+    }
+    /** Currently implements custom logic to emulate future behaviour with single root. */
+    async init() {
+        if (this.initialized)
+            throw new Error('Already initialized');
+        // calculating reproducible root name from the username
+        const user = this._ll.authUser;
+        const mainRootName = user === null ? AnonymousClientRoot : createHash('sha256').update(user).digest('hex');
+        this._serverInfo = await this.ping();
+        if (this._serverInfo.compression === MaintenanceAPI_Ping_Response_Compression.GZIP) {
+            await this._ll.close();
+            this._ll = this.buildLLPlClient(true);
+        }
+        this._clientRoot = await this._withTx('initialization', true, NullResourceId, async (tx) => {
+            let mainRoot;
+            if (await tx.checkResourceNameExists(mainRootName))
+                mainRoot = await tx.getResourceByName(mainRootName);
+            else {
+                mainRoot = tx.createRoot(ClientRoot);
+                tx.setResourceName(mainRootName, mainRoot);
+            }
+            if (this.conf.alternativeRoot === undefined) {
+                await tx.commit();
+                return await toGlobalResourceId(mainRoot);
+            }
+            else {
+                const aFId = {
+                    resourceId: mainRoot,
+                    fieldName: alternativeRootFieldName(this.conf.alternativeRoot),
+                };
+                const altRoot = tx.createEphemeral(ClientRoot);
+                tx.lock(altRoot);
+                tx.createField(aFId, 'Dynamic');
+                tx.setField(aFId, altRoot);
+                await tx.commit();
+                return await altRoot.globalId;
+            }
+        });
+    }
+    /** Returns true if field existed */
+    async deleteAlternativeRoot(alternativeRootName) {
+        this.checkInitialized();
+        if (this._ll.conf.alternativeRoot !== undefined)
+            throw new Error('Initialized with alternative root.');
+        return await this.withWriteTx('delete-alternative-root', async (tx) => {
+            const fId = {
+                resourceId: tx.clientRoot,
+                fieldName: alternativeRootFieldName(alternativeRootName),
+            };
+            const exists = tx.fieldExists(fId);
+            tx.removeField(fId);
+            await tx.commit();
+            return await exists;
+        });
+    }
+    async _withTx(name, writable, clientRoot, body, ops) {
+        // for exponential / linear backoff
+        let retryState = createRetryState(ops?.retryOptions ?? this.defaultRetryOptions);
+        while (true) {
+            // opening low-level tx
+            const llTx = this._ll.createTx(writable, ops);
+            // wrapping it into high-level tx (this also asynchronously sends initialization message)
+            const tx = new PlTransaction(llTx, name, writable, clientRoot, this.finalPredicate, this.resourceDataCache);
+            let ok = false;
+            let result = undefined;
+            let txId;
+            try {
+                // executing transaction body
+                result = await body(tx);
+                // collecting stat
+                this._txCommittedStat = addStat(this._txCommittedStat, tx.stat);
+                ok = true;
+            }
+            catch (e) {
+                // the only recoverable
+                if (e instanceof TxCommitConflict) {
+                    // ignoring
+                    // collecting stat
+                    this._txConflictStat = addStat(this._txConflictStat, tx.stat);
+                }
+                else {
+                    // collecting stat
+                    this._txErrorStat = addStat(this._txErrorStat, tx.stat);
+                    throw e;
+                }
+            }
+            finally {
+                // close underlying grpc stream, if not yet done
+                // even though we can skip two lines below for read-only transactions,
+                // we don't do it to simplify reasoning about what is going on in
+                // concurrent code, especially in significant latency situations
+                await tx.complete();
+                await tx.await();
+                txId = await tx.getGlobalTxId();
+            }
+            if (ok) {
+                // syncing on transaction if requested
+                if (ops?.sync === undefined ? this.forceSync : ops?.sync)
+                    await this._ll.grpcPl.get().txSync({ txId });
+                // introducing artificial delay, if requested
+                if (writable && this.txDelay > 0)
+                    await tp.setTimeout(this.txDelay, undefined, { signal: ops?.abortSignal });
+                return result;
+            }
+            // we only get here after TxCommitConflict error,
+            // all other errors terminate this loop instantly
+            await tp.setTimeout(retryState.nextDelay, undefined, { signal: ops?.abortSignal });
+            retryState = nextRetryStateOrError(retryState);
+        }
+    }
+    async withTx(name, writable, body, ops = {}) {
+        this.checkInitialized();
+        return await this._withTx(name, writable, this.clientRoot, body, { ...ops, ...defaultTxOps });
+    }
+    async withWriteTx(name, body, ops = {}) {
+        return await this.withTx(name, true, body, { ...ops, ...defaultTxOps });
+    }
+    async withReadTx(name, body, ops = {}) {
+        return await this.withTx(name, false, body, { ...ops, ...defaultTxOps });
+    }
+    getDriver(definition) {
+        const attached = this.drivers.get(definition.name);
+        if (attached !== undefined)
+            return attached;
+        const driver = definition.init(this, this._ll, this.httpDispatcher);
+        this.drivers.set(definition.name, driver);
+        return driver;
+    }
+    /** Closes underlying transport */
+    async close() {
+        await this._ll.close();
+    }
+    static async init(configOrAddress, auth, ops = {}) {
+        const pl = new PlClient(configOrAddress, auth, ops);
+        await pl.init();
+        return pl;
+    }
+}
+
+export { PlClient };
+//# sourceMappingURL=client.js.map

package/dist/core/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sources":["../../src/core/client.ts"],"sourcesContent":["import type { AuthOps, PlClientConfig, PlConnectionStatusListener } from './config';\nimport type { PlCallOps } from './ll_client';\nimport { LLPlClient } from './ll_client';\nimport type { AnyResourceRef } from './transaction';\nimport { PlTransaction, toGlobalResourceId, TxCommitConflict } from './transaction';\nimport { createHash } from 'node:crypto';\nimport type { OptionalResourceId, ResourceId } from './types';\nimport { ensureResourceIdNotNull, isNullResourceId, NullResourceId } from './types';\nimport { ClientRoot } from '../helpers/pl';\nimport type { RetryOptions } from '@milaboratories/ts-helpers';\nimport { assertNever, createRetryState, nextRetryStateOrError } from '@milaboratories/ts-helpers';\nimport type { PlDriver, PlDriverDefinition } from './driver';\nimport type { MaintenanceAPI_Ping_Response } from '../proto/github.com/milaboratory/pl/plapi/plapiproto/api';\nimport { MaintenanceAPI_Ping_Response_Compression } from '../proto/github.com/milaboratory/pl/plapi/plapiproto/api';\nimport * as tp from 'node:timers/promises';\nimport type { Dispatcher } from 'undici';\nimport { LRUCache } from 'lru-cache';\nimport type { ResourceDataCacheRecord } from './cache';\nimport type { FinalResourceDataPredicate } from './final';\nimport { DefaultFinalResourceDataPredicate } from './final';\nimport type { AllTxStat, TxStat } from './stat';\nimport { addStat, initialTxStat } from './stat';\nimport type { GrpcTransport } from '@protobuf-ts/grpc-transport';\n\nexport type TxOps = PlCallOps & {\n  sync?: boolean;\n  retryOptions?: RetryOptions;\n};\n\nconst defaultTxOps = {\n  sync: false,\n};\n\nconst AnonymousClientRoot = 'AnonymousRoot';\n\nfunction alternativeRootFieldName(alternativeRoot: string): string {\n  return `alternative_root_${alternativeRoot}`;\n}\n\n/** Client to access core PL API. */\nexport class PlClient {\n  private readonly drivers = new Map<string, PlDriver>();\n\n  /** Artificial delay introduced after write transactions completion, to\n   * somewhat throttle the load on pl. Delay introduced after sync, if requested. */\n  private readonly txDelay: number;\n\n  /** Last resort measure to solve complicated race conditions in pl. */\n  private readonly forceSync: boolean;\n\n  /** Last resort measure to solve complicated race conditions in pl. */\n  private readonly defaultRetryOptions: RetryOptions;\n\n  private readonly buildLLPlClient: (shouldUseGzip: boolean) => LLPlClient;\n  private _ll: LLPlClient;\n  /** Stores client root (this abstraction is intended for future implementation of the security model) */\n  private _clientRoot: OptionalResourceId = NullResourceId;\n\n  private _serverInfo: MaintenanceAPI_Ping_Response | undefined = undefined;\n\n  private _txCommittedStat: TxStat = initialTxStat();\n  private _txConflictStat: TxStat = initialTxStat();\n  private _txErrorStat: TxStat = initialTxStat();\n\n  //\n  // Caching\n  //\n\n  /** This function determines whether resource data can be cached */\n  public readonly finalPredicate: FinalResourceDataPredicate;\n\n  /** Resource data cache, to minimize redundant data rereading from remote db */\n  private readonly resourceDataCache: LRUCache<ResourceId, ResourceDataCacheRecord>;\n\n  private constructor(\n    configOrAddress: PlClientConfig | string,\n    auth: AuthOps,\n    ops: {\n      statusListener?: PlConnectionStatusListener;\n      finalPredicate?: FinalResourceDataPredicate;\n    } = {},\n  ) {\n    // Will reinitialize client after getting available feature from server.\n    this.buildLLPlClient = (shouldUseGzip: boolean) => {\n      return new LLPlClient(configOrAddress, { auth, ...ops, shouldUseGzip });\n    };\n    this._ll = this.buildLLPlClient(false);\n    const conf = this._ll.conf;\n    this.txDelay = conf.txDelay;\n    this.forceSync = conf.forceSync;\n    this.finalPredicate = ops.finalPredicate ?? DefaultFinalResourceDataPredicate;\n    this.resourceDataCache = new LRUCache({\n      maxSize: conf.maxCacheBytes,\n      sizeCalculation: (v) => (v.basicData.data?.length ?? 0) + 64,\n    });\n    switch (conf.retryBackoffAlgorithm) {\n      case 'exponential':\n        this.defaultRetryOptions = {\n          type: 'exponentialBackoff',\n          initialDelay: conf.retryInitialDelay,\n          maxAttempts: conf.retryMaxAttempts,\n          backoffMultiplier: conf.retryExponentialBackoffMultiplier,\n          jitter: conf.retryJitter,\n        };\n        break;\n      case 'linear':\n        this.defaultRetryOptions = {\n          type: 'linearBackoff',\n          initialDelay: conf.retryInitialDelay,\n          maxAttempts: conf.retryMaxAttempts,\n          backoffStep: conf.retryLinearBackoffStep,\n          jitter: conf.retryJitter,\n        };\n        break;\n      default:\n        assertNever(conf.retryBackoffAlgorithm);\n    }\n  }\n\n  public get txCommittedStat(): TxStat {\n    return { ...this._txCommittedStat };\n  }\n\n  public get txConflictStat(): TxStat {\n    return { ...this._txConflictStat };\n  }\n\n  public get txErrorStat(): TxStat {\n    return { ...this._txErrorStat };\n  }\n\n  public get txTotalStat(): TxStat {\n    return addStat(addStat(this._txCommittedStat, this._txConflictStat), this._txErrorStat);\n  }\n\n  public get allTxStat(): AllTxStat {\n    return {\n      committed: this.txCommittedStat,\n      conflict: this.txConflictStat,\n      error: this.txErrorStat,\n    };\n  }\n\n  public async ping(): Promise<MaintenanceAPI_Ping_Response> {\n    return (await this._ll.grpcPl.get().ping({})).response;\n  }\n\n  public get conf(): PlClientConfig {\n    return this._ll.conf;\n  }\n\n  public get httpDispatcher(): Dispatcher {\n    return this._ll.httpDispatcher;\n  }\n\n  public get grpcTransport(): GrpcTransport {\n    return this._ll.grpcTransport;\n  }\n\n  private get initialized() {\n    return !isNullResourceId(this._clientRoot);\n  }\n\n  private checkInitialized() {\n    if (!this.initialized) throw new Error('Client not initialized');\n  }\n\n  public get clientRoot(): ResourceId {\n    this.checkInitialized();\n    return ensureResourceIdNotNull(this._clientRoot);\n  }\n\n  public get serverInfo(): MaintenanceAPI_Ping_Response {\n    this.checkInitialized();\n    return this._serverInfo!;\n  }\n\n  /** Currently implements custom logic to emulate future behaviour with single root. */\n  public async init() {\n    if (this.initialized) throw new Error('Already initialized');\n\n    // calculating reproducible root name from the username\n    const user = this._ll.authUser;\n    const mainRootName\n      = user === null ? AnonymousClientRoot : createHash('sha256').update(user).digest('hex');\n\n    this._serverInfo = await this.ping();\n    if (this._serverInfo.compression === MaintenanceAPI_Ping_Response_Compression.GZIP) {\n      await this._ll.close();\n      this._ll = this.buildLLPlClient(true);\n    }\n\n    this._clientRoot = await this._withTx('initialization', true, NullResourceId, async (tx) => {\n      let mainRoot: AnyResourceRef;\n\n      if (await tx.checkResourceNameExists(mainRootName))\n        mainRoot = await tx.getResourceByName(mainRootName);\n      else {\n        mainRoot = tx.createRoot(ClientRoot);\n        tx.setResourceName(mainRootName, mainRoot);\n      }\n\n      if (this.conf.alternativeRoot === undefined) {\n        await tx.commit();\n        return await toGlobalResourceId(mainRoot);\n      } else {\n        const aFId = {\n          resourceId: mainRoot,\n          fieldName: alternativeRootFieldName(this.conf.alternativeRoot),\n        };\n\n        const altRoot = tx.createEphemeral(ClientRoot);\n        tx.lock(altRoot);\n        tx.createField(aFId, 'Dynamic');\n        tx.setField(aFId, altRoot);\n        await tx.commit();\n\n        return await altRoot.globalId;\n      }\n    });\n  }\n\n  /** Returns true if field existed */\n  public async deleteAlternativeRoot(alternativeRootName: string): Promise<boolean> {\n    this.checkInitialized();\n    if (this._ll.conf.alternativeRoot !== undefined)\n      throw new Error('Initialized with alternative root.');\n    return await this.withWriteTx('delete-alternative-root', async (tx) => {\n      const fId = {\n        resourceId: tx.clientRoot,\n        fieldName: alternativeRootFieldName(alternativeRootName),\n      };\n      const exists = tx.fieldExists(fId);\n      tx.removeField(fId);\n      await tx.commit();\n      return await exists;\n    });\n  }\n\n  private async _withTx<T>(\n    name: string,\n    writable: boolean,\n    clientRoot: OptionalResourceId,\n    body: (tx: PlTransaction) => Promise<T>,\n    ops?: TxOps,\n  ): Promise<T> {\n    // for exponential / linear backoff\n    let retryState = createRetryState(ops?.retryOptions ?? this.defaultRetryOptions);\n\n    while (true) {\n      // opening low-level tx\n      const llTx = this._ll.createTx(writable, ops);\n      // wrapping it into high-level tx (this also asynchronously sends initialization message)\n      const tx = new PlTransaction(\n        llTx,\n        name,\n        writable,\n        clientRoot,\n        this.finalPredicate,\n        this.resourceDataCache,\n      );\n\n      let ok = false;\n      let result: T | undefined = undefined;\n      let txId;\n\n      try {\n        // executing transaction body\n        result = await body(tx);\n        // collecting stat\n        this._txCommittedStat = addStat(this._txCommittedStat, tx.stat);\n        ok = true;\n      } catch (e: unknown) {\n        // the only recoverable\n        if (e instanceof TxCommitConflict) {\n          // ignoring\n          // collecting stat\n          this._txConflictStat = addStat(this._txConflictStat, tx.stat);\n        } else {\n          // collecting stat\n          this._txErrorStat = addStat(this._txErrorStat, tx.stat);\n          throw e;\n        }\n      } finally {\n        // close underlying grpc stream, if not yet done\n\n        // even though we can skip two lines below for read-only transactions,\n        // we don't do it to simplify reasoning about what is going on in\n        // concurrent code, especially in significant latency situations\n        await tx.complete();\n        await tx.await();\n\n        txId = await tx.getGlobalTxId();\n      }\n\n      if (ok) {\n        // syncing on transaction if requested\n        if (ops?.sync === undefined ? this.forceSync : ops?.sync)\n          await this._ll.grpcPl.get().txSync({ txId });\n\n        // introducing artificial delay, if requested\n        if (writable && this.txDelay > 0)\n          await tp.setTimeout(this.txDelay, undefined, { signal: ops?.abortSignal });\n\n        return result!;\n      }\n\n      // we only get here after TxCommitConflict error,\n      // all other errors terminate this loop instantly\n\n      await tp.setTimeout(retryState.nextDelay, undefined, { signal: ops?.abortSignal });\n      retryState = nextRetryStateOrError(retryState);\n    }\n  }\n\n  private async withTx<T>(\n    name: string,\n    writable: boolean,\n    body: (tx: PlTransaction) => Promise<T>,\n    ops: Partial<TxOps> = {},\n  ): Promise<T> {\n    this.checkInitialized();\n    return await this._withTx(name, writable, this.clientRoot, body, { ...ops, ...defaultTxOps });\n  }\n\n  public async withWriteTx<T>(\n    name: string,\n    body: (tx: PlTransaction) => Promise<T>,\n    ops: Partial<TxOps> = {},\n  ): Promise<T> {\n    return await this.withTx(name, true, body, { ...ops, ...defaultTxOps });\n  }\n\n  public async withReadTx<T>(\n    name: string,\n    body: (tx: PlTransaction) => Promise<T>,\n    ops: Partial<TxOps> = {},\n  ): Promise<T> {\n    return await this.withTx(name, false, body, { ...ops, ...defaultTxOps });\n  }\n\n  public getDriver<Drv extends PlDriver>(definition: PlDriverDefinition<Drv>): Drv {\n    const attached = this.drivers.get(definition.name);\n    if (attached !== undefined) return attached as Drv;\n    const driver = definition.init(this, this._ll, this.httpDispatcher);\n    this.drivers.set(definition.name, driver);\n    return driver;\n  }\n\n  /** Closes underlying transport */\n  public async close() {\n    await this._ll.close();\n  }\n\n  public static async init(\n    configOrAddress: PlClientConfig | string,\n    auth: AuthOps,\n    ops: {\n      statusListener?: PlConnectionStatusListener;\n    } = {},\n  ) {\n    const pl = new PlClient(configOrAddress, auth, ops);\n    await pl.init();\n    return pl;\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;;;;AA6BA,MAAM,YAAY,GAAG;AACnB,IAAA,IAAI,EAAE,KAAK;CACZ;AAED,MAAM,mBAAmB,GAAG,eAAe;AAE3C,SAAS,wBAAwB,CAAC,eAAuB,EAAA;IACvD,OAAO,CAAA,iBAAA,EAAoB,eAAe,CAAA,CAAE;AAC9C;AAEA;MACa,QAAQ,CAAA;AACF,IAAA,OAAO,GAAG,IAAI,GAAG,EAAoB;AAEtD;AACkF;AACjE,IAAA,OAAO;;AAGP,IAAA,SAAS;;AAGT,IAAA,mBAAmB;AAEnB,IAAA,eAAe;AACxB,IAAA,GAAG;;IAEH,WAAW,GAAuB,cAAc;IAEhD,WAAW,GAA6C,SAAS;IAEjE,gBAAgB,GAAW,aAAa,EAAE;IAC1C,eAAe,GAAW,aAAa,EAAE;IACzC,YAAY,GAAW,aAAa,EAAE;;;;;AAO9B,IAAA,cAAc;;AAGb,IAAA,iBAAiB;AAElC,IAAA,WAAA,CACE,eAAwC,EACxC,IAAa,EACb,MAGI,EAAE,EAAA;;AAGN,QAAA,IAAI,CAAC,eAAe,GAAG,CAAC,aAAsB,KAAI;AAChD,YAAA,OAAO,IAAI,UAAU,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,GAAG,EAAE,aAAa,EAAE,CAAC;AACzE,QAAA,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC;AACtC,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI;AAC1B,QAAA,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO;AAC3B,QAAA,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS;QAC/B,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,cAAc,IAAI,iCAAiC;AAC7E,QAAA,IAAI,CAAC,iBAAiB,GAAG,IAAI,QAAQ,CAAC;YACpC,OAAO,EAAE,IAAI,CAAC,aAAa;AAC3B,YAAA,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,IAAI,EAAE;AAC7D,SAAA,CAAC;AACF,QAAA,QAAQ,IAAI,CAAC,qBAAqB;AAChC,YAAA,KAAK,aAAa;gBAChB,IAAI,CAAC,mBAAmB,GAAG;AACzB,oBAAA,IAAI,EAAE,oBAAoB;oBAC1B,YAAY,EAAE,IAAI,CAAC,iBAAiB;oBACpC,WAAW,EAAE,IAAI,CAAC,gBAAgB;oBAClC,iBAAiB,EAAE,IAAI,CAAC,iCAAiC;oBACzD,MAAM,EAAE,IAAI,CAAC,WAAW;iBACzB;gBACD;AACF,YAAA,KAAK,QAAQ;gBACX,IAAI,CAAC,mBAAmB,GAAG;AACzB,oBAAA,IAAI,EAAE,eAAe;oBACrB,YAAY,EAAE,IAAI,CAAC,iBAAiB;oBACpC,WAAW,EAAE,IAAI,CAAC,gBAAgB;oBAClC,WAAW,EAAE,IAAI,CAAC,sBAAsB;oBACxC,MAAM,EAAE,IAAI,CAAC,WAAW;iBACzB;gBACD;AACF,YAAA;AACE,gBAAA,WAAW,CAAC,IAAI,CAAC,qBAAqB,CAAC;;IAE7C;AAEA,IAAA,IAAW,eAAe,GAAA;AACxB,QAAA,OAAO,EAAE,GAAG,IAAI,CAAC,gBAAgB,EAAE;IACrC;AAEA,IAAA,IAAW,cAAc,GAAA;AACvB,QAAA,OAAO,EAAE,GAAG,IAAI,CAAC,eAAe,EAAE;IACpC;AAEA,IAAA,IAAW,WAAW,GAAA;AACpB,QAAA,OAAO,EAAE,GAAG,IAAI,CAAC,YAAY,EAAE;IACjC;AAEA,IAAA,IAAW,WAAW,GAAA;AACpB,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;IACzF;AAEA,IAAA,IAAW,SAAS,GAAA;QAClB,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,eAAe;YAC/B,QAAQ,EAAE,IAAI,CAAC,cAAc;YAC7B,KAAK,EAAE,IAAI,CAAC,WAAW;SACxB;IACH;AAEO,IAAA,MAAM,IAAI,GAAA;AACf,QAAA,OAAO,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,QAAQ;IACxD;AAEA,IAAA,IAAW,IAAI,GAAA;AACb,QAAA,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI;IACtB;AAEA,IAAA,IAAW,cAAc,GAAA;AACvB,QAAA,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc;IAChC;AAEA,IAAA,IAAW,aAAa,GAAA;AACtB,QAAA,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa;IAC/B;AAEA,IAAA,IAAY,WAAW,GAAA;AACrB,QAAA,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC;IAC5C;IAEQ,gBAAgB,GAAA;QACtB,IAAI,CAAC,IAAI,CAAC,WAAW;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC;IAClE;AAEA,IAAA,IAAW,UAAU,GAAA;QACnB,IAAI,CAAC,gBAAgB,EAAE;AACvB,QAAA,OAAO,uBAAuB,CAAC,IAAI,CAAC,WAAW,CAAC;IAClD;AAEA,IAAA,IAAW,UAAU,GAAA;QACnB,IAAI,CAAC,gBAAgB,EAAE;QACvB,OAAO,IAAI,CAAC,WAAY;IAC1B;;AAGO,IAAA,MAAM,IAAI,GAAA;QACf,IAAI,IAAI,CAAC,WAAW;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC;;AAG5D,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ;QAC9B,MAAM,YAAY,GACd,IAAI,KAAK,IAAI,GAAG,mBAAmB,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;QAEzF,IAAI,CAAC,WAAW,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE;QACpC,IAAI,IAAI,CAAC,WAAW,CAAC,WAAW,KAAK,wCAAwC,CAAC,IAAI,EAAE;AAClF,YAAA,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE;YACtB,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;QACvC;AAEA,QAAA,IAAI,CAAC,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,KAAI;AACzF,YAAA,IAAI,QAAwB;AAE5B,YAAA,IAAI,MAAM,EAAE,CAAC,uBAAuB,CAAC,YAAY,CAAC;gBAChD,QAAQ,GAAG,MAAM,EAAE,CAAC,iBAAiB,CAAC,YAAY,CAAC;iBAChD;AACH,gBAAA,QAAQ,GAAG,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC;AACpC,gBAAA,EAAE,CAAC,eAAe,CAAC,YAAY,EAAE,QAAQ,CAAC;YAC5C;YAEA,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE;AAC3C,gBAAA,MAAM,EAAE,CAAC,MAAM,EAAE;AACjB,gBAAA,OAAO,MAAM,kBAAkB,CAAC,QAAQ,CAAC;YAC3C;iBAAO;AACL,gBAAA,MAAM,IAAI,GAAG;AACX,oBAAA,UAAU,EAAE,QAAQ;oBACpB,SAAS,EAAE,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC;iBAC/D;gBAED,MAAM,OAAO,GAAG,EAAE,CAAC,eAAe,CAAC,UAAU,CAAC;AAC9C,gBAAA,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;AAChB,gBAAA,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,SAAS,CAAC;AAC/B,gBAAA,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;AAC1B,gBAAA,MAAM,EAAE,CAAC,MAAM,EAAE;AAEjB,gBAAA,OAAO,MAAM,OAAO,CAAC,QAAQ;YAC/B;AACF,QAAA,CAAC,CAAC;IACJ;;IAGO,MAAM,qBAAqB,CAAC,mBAA2B,EAAA;QAC5D,IAAI,CAAC,gBAAgB,EAAE;QACvB,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,KAAK,SAAS;AAC7C,YAAA,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC;QACvD,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,OAAO,EAAE,KAAI;AACpE,YAAA,MAAM,GAAG,GAAG;gBACV,UAAU,EAAE,EAAE,CAAC,UAAU;AACzB,gBAAA,SAAS,EAAE,wBAAwB,CAAC,mBAAmB,CAAC;aACzD;YACD,MAAM,MAAM,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC;AAClC,YAAA,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC;AACnB,YAAA,MAAM,EAAE,CAAC,MAAM,EAAE;YACjB,OAAO,MAAM,MAAM;AACrB,QAAA,CAAC,CAAC;IACJ;IAEQ,MAAM,OAAO,CACnB,IAAY,EACZ,QAAiB,EACjB,UAA8B,EAC9B,IAAuC,EACvC,GAAW,EAAA;;AAGX,QAAA,IAAI,UAAU,GAAG,gBAAgB,CAAC,GAAG,EAAE,YAAY,IAAI,IAAI,CAAC,mBAAmB,CAAC;QAEhF,OAAO,IAAI,EAAE;;AAEX,YAAA,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC;;YAE7C,MAAM,EAAE,GAAG,IAAI,aAAa,CAC1B,IAAI,EACJ,IAAI,EACJ,QAAQ,EACR,UAAU,EACV,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,iBAAiB,CACvB;YAED,IAAI,EAAE,GAAG,KAAK;YACd,IAAI,MAAM,GAAkB,SAAS;AACrC,YAAA,IAAI,IAAI;AAER,YAAA,IAAI;;AAEF,gBAAA,MAAM,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC;;AAEvB,gBAAA,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC,IAAI,CAAC;gBAC/D,EAAE,GAAG,IAAI;YACX;YAAE,OAAO,CAAU,EAAE;;AAEnB,gBAAA,IAAI,CAAC,YAAY,gBAAgB,EAAE;;;AAGjC,oBAAA,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC,IAAI,CAAC;gBAC/D;qBAAO;;AAEL,oBAAA,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC;AACvD,oBAAA,MAAM,CAAC;gBACT;YACF;oBAAU;;;;;AAMR,gBAAA,MAAM,EAAE,CAAC,QAAQ,EAAE;AACnB,gBAAA,MAAM,EAAE,CAAC,KAAK,EAAE;AAEhB,gBAAA,IAAI,GAAG,MAAM,EAAE,CAAC,aAAa,EAAE;YACjC;YAEA,IAAI,EAAE,EAAE;;AAEN,gBAAA,IAAI,GAAG,EAAE,IAAI,KAAK,SAAS,GAAG,IAAI,CAAC,SAAS,GAAG,GAAG,EAAE,IAAI;AACtD,oBAAA,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC;;AAG9C,gBAAA,IAAI,QAAQ,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC;AAC9B,oBAAA,MAAM,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC;AAE5E,gBAAA,OAAO,MAAO;YAChB;;;AAKA,YAAA,MAAM,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC;AAClF,YAAA,UAAU,GAAG,qBAAqB,CAAC,UAAU,CAAC;QAChD;IACF;IAEQ,MAAM,MAAM,CAClB,IAAY,EACZ,QAAiB,EACjB,IAAuC,EACvC,GAAA,GAAsB,EAAE,EAAA;QAExB,IAAI,CAAC,gBAAgB,EAAE;QACvB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,EAAE,GAAG,GAAG,EAAE,GAAG,YAAY,EAAE,CAAC;IAC/F;IAEO,MAAM,WAAW,CACtB,IAAY,EACZ,IAAuC,EACvC,MAAsB,EAAE,EAAA;AAExB,QAAA,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,GAAG,GAAG,EAAE,GAAG,YAAY,EAAE,CAAC;IACzE;IAEO,MAAM,UAAU,CACrB,IAAY,EACZ,IAAuC,EACvC,MAAsB,EAAE,EAAA;AAExB,QAAA,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,GAAG,GAAG,EAAE,GAAG,YAAY,EAAE,CAAC;IAC1E;AAEO,IAAA,SAAS,CAAuB,UAAmC,EAAA;AACxE,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC;QAClD,IAAI,QAAQ,KAAK,SAAS;AAAE,YAAA,OAAO,QAAe;AAClD,QAAA,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,cAAc,CAAC;QACnE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC;AACzC,QAAA,OAAO,MAAM;IACf;;AAGO,IAAA,MAAM,KAAK,GAAA;AAChB,QAAA,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE;IACxB;IAEO,aAAa,IAAI,CACtB,eAAwC,EACxC,IAAa,EACb,GAAA,GAEI,EAAE,EAAA;QAEN,MAAM,EAAE,GAAG,IAAI,QAAQ,CAAC,eAAe,EAAE,IAAI,EAAE,GAAG,CAAC;AACnD,QAAA,MAAM,EAAE,CAAC,IAAI,EAAE;AACf,QAAA,OAAO,EAAE;IACX;AACD;;;;"}

package/dist/core/config.cjs

@@ -0,0 +1,111 @@
+'use strict';
+
+const DEFAULT_REQUEST_TIMEOUT = 5_000;
+const DEFAULT_RO_TX_TIMEOUT = 300_000;
+const DEFAULT_RW_TX_TIMEOUT = 60_000;
+const DEFAULT_TOKEN_TTL_SECONDS = 31 * 24 * 60 * 60;
+const DEFAULT_AUTH_MAX_REFRESH = 12 * 24 * 60 * 60;
+const DEFAULT_MAX_CACHE_BYTES = 128_000_000; // 128 Mb
+const DEFAULT_RETRY_BACKOFF_ALGORITHM = 'exponential';
+const DEFAULT_RETRY_MAX_ATTEMPTS = 16; // 1st attempt + 15 retries
+const DEFAULT_RETRY_INITIAL_DELAY = 14; // 14 ms * <jitter> of sleep after first failure
+const DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER = 1.5; // + 50% on each round
+const DEFAULT_RETRY_LINEAR_BACKOFF_STEP = 50; // + 50 ms
+const DEFAULT_RETRY_JITTER = 0.3; // 30%
+const DefaultRetryOptions = {
+    type: 'exponentialBackoff',
+    maxAttempts: DEFAULT_RETRY_MAX_ATTEMPTS,
+    initialDelay: DEFAULT_RETRY_INITIAL_DELAY,
+    backoffMultiplier: DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER,
+    jitter: DEFAULT_RETRY_JITTER,
+};
+function parseInt(s) {
+    if (!s)
+        return undefined;
+    const num = Number(s);
+    if (Number.isNaN(num))
+        throw new Error(`Can't parse number: ${s}`);
+    return num;
+}
+/** Parses pl url and creates a config object that can be passed to
+ * {@link PlClient} of {@link UnauthenticatedPlClient}. */
+function plAddressToConfig(address, overrides = {}) {
+    if (address.indexOf('://') === -1)
+        // non-url address
+        return {
+            hostAndPort: address,
+            ssl: false,
+            defaultRequestTimeout: DEFAULT_REQUEST_TIMEOUT,
+            defaultROTransactionTimeout: DEFAULT_RO_TX_TIMEOUT,
+            defaultRWTransactionTimeout: DEFAULT_RW_TX_TIMEOUT,
+            authTTLSeconds: DEFAULT_TOKEN_TTL_SECONDS,
+            authMaxRefreshSeconds: DEFAULT_AUTH_MAX_REFRESH,
+            txDelay: 0,
+            forceSync: false,
+            maxCacheBytes: DEFAULT_MAX_CACHE_BYTES,
+            retryBackoffAlgorithm: DEFAULT_RETRY_BACKOFF_ALGORITHM,
+            retryMaxAttempts: DEFAULT_RETRY_MAX_ATTEMPTS,
+            retryInitialDelay: DEFAULT_RETRY_INITIAL_DELAY,
+            retryExponentialBackoffMultiplier: DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER,
+            retryLinearBackoffStep: DEFAULT_RETRY_LINEAR_BACKOFF_STEP,
+            retryJitter: DEFAULT_RETRY_JITTER,
+            ...overrides,
+        };
+    const url = new URL(address);
+    if (url.protocol !== 'https:'
+        && url.protocol !== 'http:'
+        && url.protocol !== 'grpc:'
+        && url.protocol !== 'tls:')
+        throw new Error(`Unexpected URL schema: ${url.protocol}`);
+    if (url.pathname !== '/' && url.pathname !== '')
+        throw new Error(`Unexpected URL path: ${url.pathname}`);
+    return {
+        hostAndPort: url.host, // this also includes port
+        alternativeRoot: url.searchParams.get('alternative-root') ?? undefined,
+        ssl: url.protocol === 'https:' || url.protocol === 'tls:',
+        defaultRequestTimeout: parseInt(url.searchParams.get('request-timeout')) ?? DEFAULT_REQUEST_TIMEOUT,
+        defaultROTransactionTimeout: parseInt(url.searchParams.get('ro-tx-timeout'))
+            ?? parseInt(url.searchParams.get('tx-timeout'))
+            ?? DEFAULT_RO_TX_TIMEOUT,
+        defaultRWTransactionTimeout: parseInt(url.searchParams.get('rw-tx-timeout'))
+            ?? parseInt(url.searchParams.get('tx-timeout'))
+            ?? DEFAULT_RW_TX_TIMEOUT,
+        authTTLSeconds: DEFAULT_TOKEN_TTL_SECONDS,
+        authMaxRefreshSeconds: DEFAULT_AUTH_MAX_REFRESH,
+        grpcProxy: url.searchParams.get('grpc-proxy') ?? undefined,
+        httpProxy: url.searchParams.get('http-proxy') ?? undefined,
+        user: url.username === '' ? undefined : url.username,
+        password: url.password === '' ? undefined : url.password,
+        txDelay: parseInt(url.searchParams.get('tx-delay')) ?? 0,
+        forceSync: Boolean(url.searchParams.get('force-sync')),
+        maxCacheBytes: parseInt(url.searchParams.get('max-cache-bytes')) ?? DEFAULT_MAX_CACHE_BYTES,
+        retryBackoffAlgorithm: (url.searchParams.get('retry-backoff-algorithm')
+            ?? DEFAULT_RETRY_BACKOFF_ALGORITHM),
+        retryMaxAttempts: parseInt(url.searchParams.get('retry-max-attempts')) ?? DEFAULT_RETRY_MAX_ATTEMPTS,
+        retryInitialDelay: parseInt(url.searchParams.get('retry-initial-delay')) ?? DEFAULT_RETRY_INITIAL_DELAY,
+        retryExponentialBackoffMultiplier: parseInt(url.searchParams.get('retry-exp-backoff-multiplier'))
+            ?? DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER,
+        retryLinearBackoffStep: parseInt(url.searchParams.get('retry-linear-backoff-step'))
+            ?? DEFAULT_RETRY_LINEAR_BACKOFF_STEP,
+        retryJitter: parseInt(url.searchParams.get('retry-backoff-jitter')) ?? DEFAULT_RETRY_JITTER,
+        ...overrides,
+    };
+}
+const AnonymousAuthInformation = {};
+
+exports.AnonymousAuthInformation = AnonymousAuthInformation;
+exports.DEFAULT_AUTH_MAX_REFRESH = DEFAULT_AUTH_MAX_REFRESH;
+exports.DEFAULT_MAX_CACHE_BYTES = DEFAULT_MAX_CACHE_BYTES;
+exports.DEFAULT_REQUEST_TIMEOUT = DEFAULT_REQUEST_TIMEOUT;
+exports.DEFAULT_RETRY_BACKOFF_ALGORITHM = DEFAULT_RETRY_BACKOFF_ALGORITHM;
+exports.DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER = DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER;
+exports.DEFAULT_RETRY_INITIAL_DELAY = DEFAULT_RETRY_INITIAL_DELAY;
+exports.DEFAULT_RETRY_JITTER = DEFAULT_RETRY_JITTER;
+exports.DEFAULT_RETRY_LINEAR_BACKOFF_STEP = DEFAULT_RETRY_LINEAR_BACKOFF_STEP;
+exports.DEFAULT_RETRY_MAX_ATTEMPTS = DEFAULT_RETRY_MAX_ATTEMPTS;
+exports.DEFAULT_RO_TX_TIMEOUT = DEFAULT_RO_TX_TIMEOUT;
+exports.DEFAULT_RW_TX_TIMEOUT = DEFAULT_RW_TX_TIMEOUT;
+exports.DEFAULT_TOKEN_TTL_SECONDS = DEFAULT_TOKEN_TTL_SECONDS;
+exports.DefaultRetryOptions = DefaultRetryOptions;
+exports.plAddressToConfig = plAddressToConfig;
+//# sourceMappingURL=config.cjs.map

package/dist/core/config.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.cjs","sources":["../../src/core/config.ts"],"sourcesContent":["import type { ExponentialBackoffRetryOptions } from '@milaboratories/ts-helpers';\n\n/** Base configuration structure for PL client */\nexport interface PlClientConfig {\n  /** Port and host of remote pl server */\n  hostAndPort: string;\n\n  /** If set, client will expose a nested object under a field with name `alternative_root_${alternativeRoot}` as a\n   * client root. */\n  alternativeRoot?: string;\n\n  /** If true, client will establish tls connection to the server, using default\n   * CA of node instance. */\n  // Not implementing custom ssl validation logic for now.\n  // Implementing it in a correct way is really nontrivial thing,\n  // real use-cases should be considered.\n  ssl: boolean;\n\n  /** Default timeout in milliseconds for unary calls, like ping and login. */\n  defaultRequestTimeout: number;\n\n  /** Default timeout in milliseconds for read-write transaction, should be\n   * adjusted for long round-trip  or low bandwidth connections. */\n  defaultRWTransactionTimeout: number;\n  /** Default timeout in milliseconds for read-only transaction, should be\n   * adjusted for long round-trip or low bandwidth connections. */\n  defaultROTransactionTimeout: number;\n\n  /** Controls what TTL will be requested from the server, when new JWT token\n   * is requested. */\n  authTTLSeconds: number;\n  /** If token is older than this time, it will be refreshed regardless of its\n   * expiration time. */\n  authMaxRefreshSeconds: number;\n\n  /** Proxy server URL to use for pl connection. */\n  grpcProxy?: string;\n  /** Proxy server URL to use for http connections of pl drivers, like file\n   * downloading. */\n  httpProxy?: string;\n\n  /** Username extracted from pl URL. Ignored by {@link PlClient}, picked up by {@link defaultPlClient}. */\n  user?: string;\n  /** Password extracted from pl URL. Ignored by {@link PlClient}, picked up by {@link defaultPlClient}. */\n  password?: string;\n\n  /** Artificial delay introduced after write transactions completion, to\n   * somewhat throttle the load on pl. Delay introduced after sync, if requested. */\n  txDelay: number;\n\n  /** Last resort measure to solve complicated race conditions in pl. */\n  forceSync: boolean;\n\n  /** Maximal number of bytes of resource state to cache */\n  maxCacheBytes: number;\n\n  //\n  // Retry\n  //\n\n  /**\n   * What type of backoff strategy to use in transaction retries\n   * (pl uses optimistic transaction model with regular retries in write transactions)\n   * */\n  retryBackoffAlgorithm: 'exponential' | 'linear';\n\n  /** Maximal number of attempts in */\n  retryMaxAttempts: number;\n\n  /** Delay after first failed attempt, in ms. */\n  retryInitialDelay: number;\n\n  /** Each time delay will be multiplied by this number (1.5 means plus on 50% each attempt) */\n  retryExponentialBackoffMultiplier: number;\n\n  /** [used only for ] This value will be added to the delay from the previous step, in ms */\n  retryLinearBackoffStep: number;\n\n  /** Value from 0 to 1, determine level of randomness to introduce to the backoff delays sequence. (0 meaning no randomness) */\n  retryJitter: number;\n}\n\nexport const DEFAULT_REQUEST_TIMEOUT = 5_000;\nexport const DEFAULT_RO_TX_TIMEOUT = 300_000;\nexport const DEFAULT_RW_TX_TIMEOUT = 60_000;\nexport const DEFAULT_TOKEN_TTL_SECONDS = 31 * 24 * 60 * 60;\nexport const DEFAULT_AUTH_MAX_REFRESH = 12 * 24 * 60 * 60;\n\nexport const DEFAULT_MAX_CACHE_BYTES = 128_000_000; // 128 Mb\n\nexport const DEFAULT_RETRY_BACKOFF_ALGORITHM = 'exponential';\nexport const DEFAULT_RETRY_MAX_ATTEMPTS = 16; // 1st attempt + 15 retries\nexport const DEFAULT_RETRY_INITIAL_DELAY = 14; // 14 ms * <jitter> of sleep after first failure\nexport const DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER = 1.5; // + 50% on each round\nexport const DEFAULT_RETRY_LINEAR_BACKOFF_STEP = 50; // + 50 ms\nexport const DEFAULT_RETRY_JITTER = 0.3; // 30%\n\nexport const DefaultRetryOptions: ExponentialBackoffRetryOptions = {\n  type: 'exponentialBackoff',\n  maxAttempts: DEFAULT_RETRY_MAX_ATTEMPTS,\n  initialDelay: DEFAULT_RETRY_INITIAL_DELAY,\n  backoffMultiplier: DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER,\n  jitter: DEFAULT_RETRY_JITTER,\n};\n\ntype PlConfigOverrides = Partial<\n  Pick<\n    PlClientConfig,\n    | 'ssl'\n    | 'defaultRequestTimeout'\n    | 'defaultROTransactionTimeout'\n    | 'defaultRWTransactionTimeout'\n    | 'httpProxy'\n    | 'grpcProxy'\n  >\n>;\n\nfunction parseInt(s: string | null | undefined): number | undefined {\n  if (!s) return undefined;\n  const num = Number(s);\n  if (Number.isNaN(num)) throw new Error(`Can't parse number: ${s}`);\n  return num;\n}\n\n/** Parses pl url and creates a config object that can be passed to\n * {@link PlClient} of {@link UnauthenticatedPlClient}. */\nexport function plAddressToConfig(\n  address: string,\n  overrides: PlConfigOverrides = {},\n): PlClientConfig {\n  if (address.indexOf('://') === -1)\n    // non-url address\n    return {\n      hostAndPort: address,\n      ssl: false,\n      defaultRequestTimeout: DEFAULT_REQUEST_TIMEOUT,\n      defaultROTransactionTimeout: DEFAULT_RO_TX_TIMEOUT,\n      defaultRWTransactionTimeout: DEFAULT_RW_TX_TIMEOUT,\n      authTTLSeconds: DEFAULT_TOKEN_TTL_SECONDS,\n      authMaxRefreshSeconds: DEFAULT_AUTH_MAX_REFRESH,\n      txDelay: 0,\n      forceSync: false,\n\n      maxCacheBytes: DEFAULT_MAX_CACHE_BYTES,\n\n      retryBackoffAlgorithm: DEFAULT_RETRY_BACKOFF_ALGORITHM,\n      retryMaxAttempts: DEFAULT_RETRY_MAX_ATTEMPTS,\n      retryInitialDelay: DEFAULT_RETRY_INITIAL_DELAY,\n      retryExponentialBackoffMultiplier: DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER,\n      retryLinearBackoffStep: DEFAULT_RETRY_LINEAR_BACKOFF_STEP,\n      retryJitter: DEFAULT_RETRY_JITTER,\n\n      ...overrides,\n    };\n\n  const url = new URL(address);\n\n  if (\n    url.protocol !== 'https:'\n    && url.protocol !== 'http:'\n    && url.protocol !== 'grpc:'\n    && url.protocol !== 'tls:'\n  )\n    throw new Error(`Unexpected URL schema: ${url.protocol}`);\n\n  if (url.pathname !== '/' && url.pathname !== '')\n    throw new Error(`Unexpected URL path: ${url.pathname}`);\n\n  return {\n    hostAndPort: url.host, // this also includes port\n    alternativeRoot: url.searchParams.get('alternative-root') ?? undefined,\n    ssl: url.protocol === 'https:' || url.protocol === 'tls:',\n    defaultRequestTimeout:\n      parseInt(url.searchParams.get('request-timeout')) ?? DEFAULT_REQUEST_TIMEOUT,\n    defaultROTransactionTimeout:\n      parseInt(url.searchParams.get('ro-tx-timeout'))\n      ?? parseInt(url.searchParams.get('tx-timeout'))\n      ?? DEFAULT_RO_TX_TIMEOUT,\n    defaultRWTransactionTimeout:\n      parseInt(url.searchParams.get('rw-tx-timeout'))\n      ?? parseInt(url.searchParams.get('tx-timeout'))\n      ?? DEFAULT_RW_TX_TIMEOUT,\n    authTTLSeconds: DEFAULT_TOKEN_TTL_SECONDS,\n    authMaxRefreshSeconds: DEFAULT_AUTH_MAX_REFRESH,\n    grpcProxy: url.searchParams.get('grpc-proxy') ?? undefined,\n    httpProxy: url.searchParams.get('http-proxy') ?? undefined,\n    user: url.username === '' ? undefined : url.username,\n    password: url.password === '' ? undefined : url.password,\n    txDelay: parseInt(url.searchParams.get('tx-delay')) ?? 0,\n    forceSync: Boolean(url.searchParams.get('force-sync')),\n\n    maxCacheBytes: parseInt(url.searchParams.get('max-cache-bytes')) ?? DEFAULT_MAX_CACHE_BYTES,\n\n    retryBackoffAlgorithm: (url.searchParams.get('retry-backoff-algorithm')\n      ?? DEFAULT_RETRY_BACKOFF_ALGORITHM) as any,\n    retryMaxAttempts:\n      parseInt(url.searchParams.get('retry-max-attempts')) ?? DEFAULT_RETRY_MAX_ATTEMPTS,\n    retryInitialDelay:\n      parseInt(url.searchParams.get('retry-initial-delay')) ?? DEFAULT_RETRY_INITIAL_DELAY,\n    retryExponentialBackoffMultiplier:\n      parseInt(url.searchParams.get('retry-exp-backoff-multiplier'))\n      ?? DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER,\n    retryLinearBackoffStep:\n      parseInt(url.searchParams.get('retry-linear-backoff-step'))\n      ?? DEFAULT_RETRY_LINEAR_BACKOFF_STEP,\n    retryJitter: parseInt(url.searchParams.get('retry-backoff-jitter')) ?? DEFAULT_RETRY_JITTER,\n\n    ...overrides,\n  };\n}\n\n/**\n * Authorization data / JWT Token.\n * Absent JWT Token tells the client to connect as anonymous user.\n * */\nexport interface AuthInformation {\n  /** Absent token means anonymous access */\n  jwtToken?: string;\n}\n\nexport const AnonymousAuthInformation: AuthInformation = {};\n\n/** Authorization related settings to pass to {@link PlClient}. */\nexport interface AuthOps {\n  /** Initial authorization information */\n  authInformation: AuthInformation;\n  /** Will be executed after successful authorization information refresh */\n  readonly onUpdate?: (newInfo: AuthInformation) => void;\n  /** Will be executed if auth-related error happens during normal client operation */\n  readonly onAuthError?: () => void;\n  /** Will be executed if error encountered during token update */\n  readonly onUpdateError?: (error: unknown) => void;\n}\n\n/** Connection status. */\nexport type PlConnectionStatus = 'OK' | 'Disconnected' | 'Unauthenticated';\n\n/** Listener that will be called each time connection status changes. */\nexport type PlConnectionStatusListener = (status: PlConnectionStatus) => void;\n"],"names":[],"mappings":";;AAkFO,MAAM,uBAAuB,GAAG;AAChC,MAAM,qBAAqB,GAAG;AAC9B,MAAM,qBAAqB,GAAG;AAC9B,MAAM,yBAAyB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;AACjD,MAAM,wBAAwB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;AAEhD,MAAM,uBAAuB,GAAG,YAAY;AAE5C,MAAM,+BAA+B,GAAG;AACxC,MAAM,0BAA0B,GAAG,GAAG;AACtC,MAAM,2BAA2B,GAAG,GAAG;AACvC,MAAM,4CAA4C,GAAG,IAAI;AACzD,MAAM,iCAAiC,GAAG,GAAG;AAC7C,MAAM,oBAAoB,GAAG,IAAI;AAEjC,MAAM,mBAAmB,GAAmC;AACjE,IAAA,IAAI,EAAE,oBAAoB;AAC1B,IAAA,WAAW,EAAE,0BAA0B;AACvC,IAAA,YAAY,EAAE,2BAA2B;AACzC,IAAA,iBAAiB,EAAE,4CAA4C;AAC/D,IAAA,MAAM,EAAE,oBAAoB;;AAe9B,SAAS,QAAQ,CAAC,CAA4B,EAAA;AAC5C,IAAA,IAAI,CAAC,CAAC;AAAE,QAAA,OAAO,SAAS;AACxB,IAAA,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC;AACrB,IAAA,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;AAAE,QAAA,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA,CAAE,CAAC;AAClE,IAAA,OAAO,GAAG;AACZ;AAEA;AAC0D;SAC1C,iBAAiB,CAC/B,OAAe,EACf,YAA+B,EAAE,EAAA;IAEjC,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE;;QAE/B,OAAO;AACL,YAAA,WAAW,EAAE,OAAO;AACpB,YAAA,GAAG,EAAE,KAAK;AACV,YAAA,qBAAqB,EAAE,uBAAuB;AAC9C,YAAA,2BAA2B,EAAE,qBAAqB;AAClD,YAAA,2BAA2B,EAAE,qBAAqB;AAClD,YAAA,cAAc,EAAE,yBAAyB;AACzC,YAAA,qBAAqB,EAAE,wBAAwB;AAC/C,YAAA,OAAO,EAAE,CAAC;AACV,YAAA,SAAS,EAAE,KAAK;AAEhB,YAAA,aAAa,EAAE,uBAAuB;AAEtC,YAAA,qBAAqB,EAAE,+BAA+B;AACtD,YAAA,gBAAgB,EAAE,0BAA0B;AAC5C,YAAA,iBAAiB,EAAE,2BAA2B;AAC9C,YAAA,iCAAiC,EAAE,4CAA4C;AAC/E,YAAA,sBAAsB,EAAE,iCAAiC;AACzD,YAAA,WAAW,EAAE,oBAAoB;AAEjC,YAAA,GAAG,SAAS;SACb;AAEH,IAAA,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC;AAE5B,IAAA,IACE,GAAG,CAAC,QAAQ,KAAK;WACd,GAAG,CAAC,QAAQ,KAAK;WACjB,GAAG,CAAC,QAAQ,KAAK;WACjB,GAAG,CAAC,QAAQ,KAAK,MAAM;QAE1B,MAAM,IAAI,KAAK,CAAC,CAAA,uBAAA,EAA0B,GAAG,CAAC,QAAQ,CAAA,CAAE,CAAC;IAE3D,IAAI,GAAG,CAAC,QAAQ,KAAK,GAAG,IAAI,GAAG,CAAC,QAAQ,KAAK,EAAE;QAC7C,MAAM,IAAI,KAAK,CAAC,CAAA,qBAAA,EAAwB,GAAG,CAAC,QAAQ,CAAA,CAAE,CAAC;IAEzD,OAAO;AACL,QAAA,WAAW,EAAE,GAAG,CAAC,IAAI;QACrB,eAAe,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,SAAS;QACtE,GAAG,EAAE,GAAG,CAAC,QAAQ,KAAK,QAAQ,IAAI,GAAG,CAAC,QAAQ,KAAK,MAAM;AACzD,QAAA,qBAAqB,EACnB,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,IAAI,uBAAuB;QAC9E,2BAA2B,EACzB,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC;eAC3C,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC;eAC3C,qBAAqB;QAC1B,2BAA2B,EACzB,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC;eAC3C,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC;eAC3C,qBAAqB;AAC1B,QAAA,cAAc,EAAE,yBAAyB;AACzC,QAAA,qBAAqB,EAAE,wBAAwB;QAC/C,SAAS,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,SAAS;QAC1D,SAAS,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,SAAS;AAC1D,QAAA,IAAI,EAAE,GAAG,CAAC,QAAQ,KAAK,EAAE,GAAG,SAAS,GAAG,GAAG,CAAC,QAAQ;AACpD,QAAA,QAAQ,EAAE,GAAG,CAAC,QAAQ,KAAK,EAAE,GAAG,SAAS,GAAG,GAAG,CAAC,QAAQ;AACxD,QAAA,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC;QACxD,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AAEtD,QAAA,aAAa,EAAE,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,IAAI,uBAAuB;QAE3F,qBAAqB,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,yBAAyB;AACjE,eAAA,+BAA+B,CAAQ;AAC5C,QAAA,gBAAgB,EACd,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,IAAI,0BAA0B;AACpF,QAAA,iBAAiB,EACf,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,IAAI,2BAA2B;QACtF,iCAAiC,EAC/B,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,8BAA8B,CAAC;eAC1D,4CAA4C;QACjD,sBAAsB,EACpB,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,2BAA2B,CAAC;eACvD,iCAAiC;AACtC,QAAA,WAAW,EAAE,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC,IAAI,oBAAoB;AAE3F,QAAA,GAAG,SAAS;KACb;AACH;AAWO,MAAM,wBAAwB,GAAoB;;;;;;;;;;;;;;;;;;"}

package/dist/core/config.d.ts

@@ -1,3 +1,4 @@
+import { ExponentialBackoffRetryOptions } from '@milaboratories/ts-helpers';
 /** Base configuration structure for PL client */
 export interface PlClientConfig {
     /** Port and host of remote pl server */
@@ -66,6 +67,7 @@ export declare const DEFAULT_RETRY_INITIAL_DELAY = 14;
 export declare const DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER = 1.5;
 export declare const DEFAULT_RETRY_LINEAR_BACKOFF_STEP = 50;
 export declare const DEFAULT_RETRY_JITTER = 0.3;
+export declare const DefaultRetryOptions: ExponentialBackoffRetryOptions;
 type PlConfigOverrides = Partial<Pick<PlClientConfig, 'ssl' | 'defaultRequestTimeout' | 'defaultROTransactionTimeout' | 'defaultRWTransactionTimeout' | 'httpProxy' | 'grpcProxy'>>;
 /** Parses pl url and creates a config object that can be passed to
  * {@link PlClient} of {@link UnauthenticatedPlClient}. */
@@ -95,4 +97,3 @@ export type PlConnectionStatus = 'OK' | 'Disconnected' | 'Unauthenticated';
 /** Listener that will be called each time connection status changes. */
 export type PlConnectionStatusListener = (status: PlConnectionStatus) => void;
 export {};
-//# sourceMappingURL=config.d.ts.map

package/dist/core/config.js

@@ -0,0 +1,95 @@
+const DEFAULT_REQUEST_TIMEOUT = 5_000;
+const DEFAULT_RO_TX_TIMEOUT = 300_000;
+const DEFAULT_RW_TX_TIMEOUT = 60_000;
+const DEFAULT_TOKEN_TTL_SECONDS = 31 * 24 * 60 * 60;
+const DEFAULT_AUTH_MAX_REFRESH = 12 * 24 * 60 * 60;
+const DEFAULT_MAX_CACHE_BYTES = 128_000_000; // 128 Mb
+const DEFAULT_RETRY_BACKOFF_ALGORITHM = 'exponential';
+const DEFAULT_RETRY_MAX_ATTEMPTS = 16; // 1st attempt + 15 retries
+const DEFAULT_RETRY_INITIAL_DELAY = 14; // 14 ms * <jitter> of sleep after first failure
+const DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER = 1.5; // + 50% on each round
+const DEFAULT_RETRY_LINEAR_BACKOFF_STEP = 50; // + 50 ms
+const DEFAULT_RETRY_JITTER = 0.3; // 30%
+const DefaultRetryOptions = {
+    type: 'exponentialBackoff',
+    maxAttempts: DEFAULT_RETRY_MAX_ATTEMPTS,
+    initialDelay: DEFAULT_RETRY_INITIAL_DELAY,
+    backoffMultiplier: DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER,
+    jitter: DEFAULT_RETRY_JITTER,
+};
+function parseInt(s) {
+    if (!s)
+        return undefined;
+    const num = Number(s);
+    if (Number.isNaN(num))
+        throw new Error(`Can't parse number: ${s}`);
+    return num;
+}
+/** Parses pl url and creates a config object that can be passed to
+ * {@link PlClient} of {@link UnauthenticatedPlClient}. */
+function plAddressToConfig(address, overrides = {}) {
+    if (address.indexOf('://') === -1)
+        // non-url address
+        return {
+            hostAndPort: address,
+            ssl: false,
+            defaultRequestTimeout: DEFAULT_REQUEST_TIMEOUT,
+            defaultROTransactionTimeout: DEFAULT_RO_TX_TIMEOUT,
+            defaultRWTransactionTimeout: DEFAULT_RW_TX_TIMEOUT,
+            authTTLSeconds: DEFAULT_TOKEN_TTL_SECONDS,
+            authMaxRefreshSeconds: DEFAULT_AUTH_MAX_REFRESH,
+            txDelay: 0,
+            forceSync: false,
+            maxCacheBytes: DEFAULT_MAX_CACHE_BYTES,
+            retryBackoffAlgorithm: DEFAULT_RETRY_BACKOFF_ALGORITHM,
+            retryMaxAttempts: DEFAULT_RETRY_MAX_ATTEMPTS,
+            retryInitialDelay: DEFAULT_RETRY_INITIAL_DELAY,
+            retryExponentialBackoffMultiplier: DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER,
+            retryLinearBackoffStep: DEFAULT_RETRY_LINEAR_BACKOFF_STEP,
+            retryJitter: DEFAULT_RETRY_JITTER,
+            ...overrides,
+        };
+    const url = new URL(address);
+    if (url.protocol !== 'https:'
+        && url.protocol !== 'http:'
+        && url.protocol !== 'grpc:'
+        && url.protocol !== 'tls:')
+        throw new Error(`Unexpected URL schema: ${url.protocol}`);
+    if (url.pathname !== '/' && url.pathname !== '')
+        throw new Error(`Unexpected URL path: ${url.pathname}`);
+    return {
+        hostAndPort: url.host, // this also includes port
+        alternativeRoot: url.searchParams.get('alternative-root') ?? undefined,
+        ssl: url.protocol === 'https:' || url.protocol === 'tls:',
+        defaultRequestTimeout: parseInt(url.searchParams.get('request-timeout')) ?? DEFAULT_REQUEST_TIMEOUT,
+        defaultROTransactionTimeout: parseInt(url.searchParams.get('ro-tx-timeout'))
+            ?? parseInt(url.searchParams.get('tx-timeout'))
+            ?? DEFAULT_RO_TX_TIMEOUT,
+        defaultRWTransactionTimeout: parseInt(url.searchParams.get('rw-tx-timeout'))
+            ?? parseInt(url.searchParams.get('tx-timeout'))
+            ?? DEFAULT_RW_TX_TIMEOUT,
+        authTTLSeconds: DEFAULT_TOKEN_TTL_SECONDS,
+        authMaxRefreshSeconds: DEFAULT_AUTH_MAX_REFRESH,
+        grpcProxy: url.searchParams.get('grpc-proxy') ?? undefined,
+        httpProxy: url.searchParams.get('http-proxy') ?? undefined,
+        user: url.username === '' ? undefined : url.username,
+        password: url.password === '' ? undefined : url.password,
+        txDelay: parseInt(url.searchParams.get('tx-delay')) ?? 0,
+        forceSync: Boolean(url.searchParams.get('force-sync')),
+        maxCacheBytes: parseInt(url.searchParams.get('max-cache-bytes')) ?? DEFAULT_MAX_CACHE_BYTES,
+        retryBackoffAlgorithm: (url.searchParams.get('retry-backoff-algorithm')
+            ?? DEFAULT_RETRY_BACKOFF_ALGORITHM),
+        retryMaxAttempts: parseInt(url.searchParams.get('retry-max-attempts')) ?? DEFAULT_RETRY_MAX_ATTEMPTS,
+        retryInitialDelay: parseInt(url.searchParams.get('retry-initial-delay')) ?? DEFAULT_RETRY_INITIAL_DELAY,
+        retryExponentialBackoffMultiplier: parseInt(url.searchParams.get('retry-exp-backoff-multiplier'))
+            ?? DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER,
+        retryLinearBackoffStep: parseInt(url.searchParams.get('retry-linear-backoff-step'))
+            ?? DEFAULT_RETRY_LINEAR_BACKOFF_STEP,
+        retryJitter: parseInt(url.searchParams.get('retry-backoff-jitter')) ?? DEFAULT_RETRY_JITTER,
+        ...overrides,
+    };
+}
+const AnonymousAuthInformation = {};
+
+export { AnonymousAuthInformation, DEFAULT_AUTH_MAX_REFRESH, DEFAULT_MAX_CACHE_BYTES, DEFAULT_REQUEST_TIMEOUT, DEFAULT_RETRY_BACKOFF_ALGORITHM, DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER, DEFAULT_RETRY_INITIAL_DELAY, DEFAULT_RETRY_JITTER, DEFAULT_RETRY_LINEAR_BACKOFF_STEP, DEFAULT_RETRY_MAX_ATTEMPTS, DEFAULT_RO_TX_TIMEOUT, DEFAULT_RW_TX_TIMEOUT, DEFAULT_TOKEN_TTL_SECONDS, DefaultRetryOptions, plAddressToConfig };
+//# sourceMappingURL=config.js.map

package/dist/core/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sources":["../../src/core/config.ts"],"sourcesContent":["import type { ExponentialBackoffRetryOptions } from '@milaboratories/ts-helpers';\n\n/** Base configuration structure for PL client */\nexport interface PlClientConfig {\n  /** Port and host of remote pl server */\n  hostAndPort: string;\n\n  /** If set, client will expose a nested object under a field with name `alternative_root_${alternativeRoot}` as a\n   * client root. */\n  alternativeRoot?: string;\n\n  /** If true, client will establish tls connection to the server, using default\n   * CA of node instance. */\n  // Not implementing custom ssl validation logic for now.\n  // Implementing it in a correct way is really nontrivial thing,\n  // real use-cases should be considered.\n  ssl: boolean;\n\n  /** Default timeout in milliseconds for unary calls, like ping and login. */\n  defaultRequestTimeout: number;\n\n  /** Default timeout in milliseconds for read-write transaction, should be\n   * adjusted for long round-trip  or low bandwidth connections. */\n  defaultRWTransactionTimeout: number;\n  /** Default timeout in milliseconds for read-only transaction, should be\n   * adjusted for long round-trip or low bandwidth connections. */\n  defaultROTransactionTimeout: number;\n\n  /** Controls what TTL will be requested from the server, when new JWT token\n   * is requested. */\n  authTTLSeconds: number;\n  /** If token is older than this time, it will be refreshed regardless of its\n   * expiration time. */\n  authMaxRefreshSeconds: number;\n\n  /** Proxy server URL to use for pl connection. */\n  grpcProxy?: string;\n  /** Proxy server URL to use for http connections of pl drivers, like file\n   * downloading. */\n  httpProxy?: string;\n\n  /** Username extracted from pl URL. Ignored by {@link PlClient}, picked up by {@link defaultPlClient}. */\n  user?: string;\n  /** Password extracted from pl URL. Ignored by {@link PlClient}, picked up by {@link defaultPlClient}. */\n  password?: string;\n\n  /** Artificial delay introduced after write transactions completion, to\n   * somewhat throttle the load on pl. Delay introduced after sync, if requested. */\n  txDelay: number;\n\n  /** Last resort measure to solve complicated race conditions in pl. */\n  forceSync: boolean;\n\n  /** Maximal number of bytes of resource state to cache */\n  maxCacheBytes: number;\n\n  //\n  // Retry\n  //\n\n  /**\n   * What type of backoff strategy to use in transaction retries\n   * (pl uses optimistic transaction model with regular retries in write transactions)\n   * */\n  retryBackoffAlgorithm: 'exponential' | 'linear';\n\n  /** Maximal number of attempts in */\n  retryMaxAttempts: number;\n\n  /** Delay after first failed attempt, in ms. */\n  retryInitialDelay: number;\n\n  /** Each time delay will be multiplied by this number (1.5 means plus on 50% each attempt) */\n  retryExponentialBackoffMultiplier: number;\n\n  /** [used only for ] This value will be added to the delay from the previous step, in ms */\n  retryLinearBackoffStep: number;\n\n  /** Value from 0 to 1, determine level of randomness to introduce to the backoff delays sequence. (0 meaning no randomness) */\n  retryJitter: number;\n}\n\nexport const DEFAULT_REQUEST_TIMEOUT = 5_000;\nexport const DEFAULT_RO_TX_TIMEOUT = 300_000;\nexport const DEFAULT_RW_TX_TIMEOUT = 60_000;\nexport const DEFAULT_TOKEN_TTL_SECONDS = 31 * 24 * 60 * 60;\nexport const DEFAULT_AUTH_MAX_REFRESH = 12 * 24 * 60 * 60;\n\nexport const DEFAULT_MAX_CACHE_BYTES = 128_000_000; // 128 Mb\n\nexport const DEFAULT_RETRY_BACKOFF_ALGORITHM = 'exponential';\nexport const DEFAULT_RETRY_MAX_ATTEMPTS = 16; // 1st attempt + 15 retries\nexport const DEFAULT_RETRY_INITIAL_DELAY = 14; // 14 ms * <jitter> of sleep after first failure\nexport const DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER = 1.5; // + 50% on each round\nexport const DEFAULT_RETRY_LINEAR_BACKOFF_STEP = 50; // + 50 ms\nexport const DEFAULT_RETRY_JITTER = 0.3; // 30%\n\nexport const DefaultRetryOptions: ExponentialBackoffRetryOptions = {\n  type: 'exponentialBackoff',\n  maxAttempts: DEFAULT_RETRY_MAX_ATTEMPTS,\n  initialDelay: DEFAULT_RETRY_INITIAL_DELAY,\n  backoffMultiplier: DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER,\n  jitter: DEFAULT_RETRY_JITTER,\n};\n\ntype PlConfigOverrides = Partial<\n  Pick<\n    PlClientConfig,\n    | 'ssl'\n    | 'defaultRequestTimeout'\n    | 'defaultROTransactionTimeout'\n    | 'defaultRWTransactionTimeout'\n    | 'httpProxy'\n    | 'grpcProxy'\n  >\n>;\n\nfunction parseInt(s: string | null | undefined): number | undefined {\n  if (!s) return undefined;\n  const num = Number(s);\n  if (Number.isNaN(num)) throw new Error(`Can't parse number: ${s}`);\n  return num;\n}\n\n/** Parses pl url and creates a config object that can be passed to\n * {@link PlClient} of {@link UnauthenticatedPlClient}. */\nexport function plAddressToConfig(\n  address: string,\n  overrides: PlConfigOverrides = {},\n): PlClientConfig {\n  if (address.indexOf('://') === -1)\n    // non-url address\n    return {\n      hostAndPort: address,\n      ssl: false,\n      defaultRequestTimeout: DEFAULT_REQUEST_TIMEOUT,\n      defaultROTransactionTimeout: DEFAULT_RO_TX_TIMEOUT,\n      defaultRWTransactionTimeout: DEFAULT_RW_TX_TIMEOUT,\n      authTTLSeconds: DEFAULT_TOKEN_TTL_SECONDS,\n      authMaxRefreshSeconds: DEFAULT_AUTH_MAX_REFRESH,\n      txDelay: 0,\n      forceSync: false,\n\n      maxCacheBytes: DEFAULT_MAX_CACHE_BYTES,\n\n      retryBackoffAlgorithm: DEFAULT_RETRY_BACKOFF_ALGORITHM,\n      retryMaxAttempts: DEFAULT_RETRY_MAX_ATTEMPTS,\n      retryInitialDelay: DEFAULT_RETRY_INITIAL_DELAY,\n      retryExponentialBackoffMultiplier: DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER,\n      retryLinearBackoffStep: DEFAULT_RETRY_LINEAR_BACKOFF_STEP,\n      retryJitter: DEFAULT_RETRY_JITTER,\n\n      ...overrides,\n    };\n\n  const url = new URL(address);\n\n  if (\n    url.protocol !== 'https:'\n    && url.protocol !== 'http:'\n    && url.protocol !== 'grpc:'\n    && url.protocol !== 'tls:'\n  )\n    throw new Error(`Unexpected URL schema: ${url.protocol}`);\n\n  if (url.pathname !== '/' && url.pathname !== '')\n    throw new Error(`Unexpected URL path: ${url.pathname}`);\n\n  return {\n    hostAndPort: url.host, // this also includes port\n    alternativeRoot: url.searchParams.get('alternative-root') ?? undefined,\n    ssl: url.protocol === 'https:' || url.protocol === 'tls:',\n    defaultRequestTimeout:\n      parseInt(url.searchParams.get('request-timeout')) ?? DEFAULT_REQUEST_TIMEOUT,\n    defaultROTransactionTimeout:\n      parseInt(url.searchParams.get('ro-tx-timeout'))\n      ?? parseInt(url.searchParams.get('tx-timeout'))\n      ?? DEFAULT_RO_TX_TIMEOUT,\n    defaultRWTransactionTimeout:\n      parseInt(url.searchParams.get('rw-tx-timeout'))\n      ?? parseInt(url.searchParams.get('tx-timeout'))\n      ?? DEFAULT_RW_TX_TIMEOUT,\n    authTTLSeconds: DEFAULT_TOKEN_TTL_SECONDS,\n    authMaxRefreshSeconds: DEFAULT_AUTH_MAX_REFRESH,\n    grpcProxy: url.searchParams.get('grpc-proxy') ?? undefined,\n    httpProxy: url.searchParams.get('http-proxy') ?? undefined,\n    user: url.username === '' ? undefined : url.username,\n    password: url.password === '' ? undefined : url.password,\n    txDelay: parseInt(url.searchParams.get('tx-delay')) ?? 0,\n    forceSync: Boolean(url.searchParams.get('force-sync')),\n\n    maxCacheBytes: parseInt(url.searchParams.get('max-cache-bytes')) ?? DEFAULT_MAX_CACHE_BYTES,\n\n    retryBackoffAlgorithm: (url.searchParams.get('retry-backoff-algorithm')\n      ?? DEFAULT_RETRY_BACKOFF_ALGORITHM) as any,\n    retryMaxAttempts:\n      parseInt(url.searchParams.get('retry-max-attempts')) ?? DEFAULT_RETRY_MAX_ATTEMPTS,\n    retryInitialDelay:\n      parseInt(url.searchParams.get('retry-initial-delay')) ?? DEFAULT_RETRY_INITIAL_DELAY,\n    retryExponentialBackoffMultiplier:\n      parseInt(url.searchParams.get('retry-exp-backoff-multiplier'))\n      ?? DEFAULT_RETRY_EXPONENTIAL_BACKOFF_MULTIPLIER,\n    retryLinearBackoffStep:\n      parseInt(url.searchParams.get('retry-linear-backoff-step'))\n      ?? DEFAULT_RETRY_LINEAR_BACKOFF_STEP,\n    retryJitter: parseInt(url.searchParams.get('retry-backoff-jitter')) ?? DEFAULT_RETRY_JITTER,\n\n    ...overrides,\n  };\n}\n\n/**\n * Authorization data / JWT Token.\n * Absent JWT Token tells the client to connect as anonymous user.\n * */\nexport interface AuthInformation {\n  /** Absent token means anonymous access */\n  jwtToken?: string;\n}\n\nexport const AnonymousAuthInformation: AuthInformation = {};\n\n/** Authorization related settings to pass to {@link PlClient}. */\nexport interface AuthOps {\n  /** Initial authorization information */\n  authInformation: AuthInformation;\n  /** Will be executed after successful authorization information refresh */\n  readonly onUpdate?: (newInfo: AuthInformation) => void;\n  /** Will be executed if auth-related error happens during normal client operation */\n  readonly onAuthError?: () => void;\n  /** Will be executed if error encountered during token update */\n  readonly onUpdateError?: (error: unknown) => void;\n}\n\n/** Connection status. */\nexport type PlConnectionStatus = 'OK' | 'Disconnected' | 'Unauthenticated';\n\n/** Listener that will be called each time connection status changes. */\nexport type PlConnectionStatusListener = (status: PlConnectionStatus) => void;\n"],"names":[],"mappings":"AAkFO,MAAM,uBAAuB,GAAG;AAChC,MAAM,qBAAqB,GAAG;AAC9B,MAAM,qBAAqB,GAAG;AAC9B,MAAM,yBAAyB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;AACjD,MAAM,wBAAwB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;AAEhD,MAAM,uBAAuB,GAAG,YAAY;AAE5C,MAAM,+BAA+B,GAAG;AACxC,MAAM,0BAA0B,GAAG,GAAG;AACtC,MAAM,2BAA2B,GAAG,GAAG;AACvC,MAAM,4CAA4C,GAAG,IAAI;AACzD,MAAM,iCAAiC,GAAG,GAAG;AAC7C,MAAM,oBAAoB,GAAG,IAAI;AAEjC,MAAM,mBAAmB,GAAmC;AACjE,IAAA,IAAI,EAAE,oBAAoB;AAC1B,IAAA,WAAW,EAAE,0BAA0B;AACvC,IAAA,YAAY,EAAE,2BAA2B;AACzC,IAAA,iBAAiB,EAAE,4CAA4C;AAC/D,IAAA,MAAM,EAAE,oBAAoB;;AAe9B,SAAS,QAAQ,CAAC,CAA4B,EAAA;AAC5C,IAAA,IAAI,CAAC,CAAC;AAAE,QAAA,OAAO,SAAS;AACxB,IAAA,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC;AACrB,IAAA,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;AAAE,QAAA,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA,CAAE,CAAC;AAClE,IAAA,OAAO,GAAG;AACZ;AAEA;AAC0D;SAC1C,iBAAiB,CAC/B,OAAe,EACf,YAA+B,EAAE,EAAA;IAEjC,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE;;QAE/B,OAAO;AACL,YAAA,WAAW,EAAE,OAAO;AACpB,YAAA,GAAG,EAAE,KAAK;AACV,YAAA,qBAAqB,EAAE,uBAAuB;AAC9C,YAAA,2BAA2B,EAAE,qBAAqB;AAClD,YAAA,2BAA2B,EAAE,qBAAqB;AAClD,YAAA,cAAc,EAAE,yBAAyB;AACzC,YAAA,qBAAqB,EAAE,wBAAwB;AAC/C,YAAA,OAAO,EAAE,CAAC;AACV,YAAA,SAAS,EAAE,KAAK;AAEhB,YAAA,aAAa,EAAE,uBAAuB;AAEtC,YAAA,qBAAqB,EAAE,+BAA+B;AACtD,YAAA,gBAAgB,EAAE,0BAA0B;AAC5C,YAAA,iBAAiB,EAAE,2BAA2B;AAC9C,YAAA,iCAAiC,EAAE,4CAA4C;AAC/E,YAAA,sBAAsB,EAAE,iCAAiC;AACzD,YAAA,WAAW,EAAE,oBAAoB;AAEjC,YAAA,GAAG,SAAS;SACb;AAEH,IAAA,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC;AAE5B,IAAA,IACE,GAAG,CAAC,QAAQ,KAAK;WACd,GAAG,CAAC,QAAQ,KAAK;WACjB,GAAG,CAAC,QAAQ,KAAK;WACjB,GAAG,CAAC,QAAQ,KAAK,MAAM;QAE1B,MAAM,IAAI,KAAK,CAAC,CAAA,uBAAA,EAA0B,GAAG,CAAC,QAAQ,CAAA,CAAE,CAAC;IAE3D,IAAI,GAAG,CAAC,QAAQ,KAAK,GAAG,IAAI,GAAG,CAAC,QAAQ,KAAK,EAAE;QAC7C,MAAM,IAAI,KAAK,CAAC,CAAA,qBAAA,EAAwB,GAAG,CAAC,QAAQ,CAAA,CAAE,CAAC;IAEzD,OAAO;AACL,QAAA,WAAW,EAAE,GAAG,CAAC,IAAI;QACrB,eAAe,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,SAAS;QACtE,GAAG,EAAE,GAAG,CAAC,QAAQ,KAAK,QAAQ,IAAI,GAAG,CAAC,QAAQ,KAAK,MAAM;AACzD,QAAA,qBAAqB,EACnB,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,IAAI,uBAAuB;QAC9E,2BAA2B,EACzB,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC;eAC3C,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC;eAC3C,qBAAqB;QAC1B,2BAA2B,EACzB,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC;eAC3C,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC;eAC3C,qBAAqB;AAC1B,QAAA,cAAc,EAAE,yBAAyB;AACzC,QAAA,qBAAqB,EAAE,wBAAwB;QAC/C,SAAS,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,SAAS;QAC1D,SAAS,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,SAAS;AAC1D,QAAA,IAAI,EAAE,GAAG,CAAC,QAAQ,KAAK,EAAE,GAAG,SAAS,GAAG,GAAG,CAAC,QAAQ;AACpD,QAAA,QAAQ,EAAE,GAAG,CAAC,QAAQ,KAAK,EAAE,GAAG,SAAS,GAAG,GAAG,CAAC,QAAQ;AACxD,QAAA,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC;QACxD,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AAEtD,QAAA,aAAa,EAAE,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,IAAI,uBAAuB;QAE3F,qBAAqB,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,yBAAyB;AACjE,eAAA,+BAA+B,CAAQ;AAC5C,QAAA,gBAAgB,EACd,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,IAAI,0BAA0B;AACpF,QAAA,iBAAiB,EACf,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,IAAI,2BAA2B;QACtF,iCAAiC,EAC/B,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,8BAA8B,CAAC;eAC1D,4CAA4C;QACjD,sBAAsB,EACpB,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,2BAA2B,CAAC;eACvD,iCAAiC;AACtC,QAAA,WAAW,EAAE,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC,IAAI,oBAAoB;AAE3F,QAAA,GAAG,SAAS;KACb;AACH;AAWO,MAAM,wBAAwB,GAAoB;;;;"}