@milaboratories/pl-client 2.11.8 → 2.11.10

package/dist/core/ll_client.js

@@ -0,0 +1,264 @@
+import { PlatformClient } from '../proto/github.com/milaboratory/pl/plapi/plapiproto/api.client.js';
+import { compressionAlgorithms, ChannelCredentials, InterceptingCall, status } from '@grpc/grpc-js';
+import { plAddressToConfig } from './config.js';
+import { GrpcTransport } from '@protobuf-ts/grpc-transport';
+import { LLPlTransaction } from './ll_transaction.js';
+import { parsePlJwt } from '../util/pl.js';
+import { inferAuthRefreshTime } from './auth.js';
+import { defaultHttpDispatcher } from '@milaboratories/pl-http';
+
+class GrpcClientProviderImpl {
+    grpcTransport;
+    clientConstructor;
+    client = undefined;
+    constructor(grpcTransport, clientConstructor) {
+        this.grpcTransport = grpcTransport;
+        this.clientConstructor = clientConstructor;
+    }
+    reset() {
+        this.client = undefined;
+    }
+    get() {
+        if (this.client === undefined)
+            this.client = this.clientConstructor(this.grpcTransport());
+        return this.client;
+    }
+}
+/** Abstract out low level networking and authorization details */
+class LLPlClient {
+    ops;
+    conf;
+    /** Initial authorization information */
+    authInformation;
+    /** Will be executed by the client when it is required */
+    onAuthUpdate;
+    /** Will be executed if auth-related error happens during normal client operation */
+    onAuthError;
+    /** Will be executed by the client when it is required */
+    onAuthRefreshProblem;
+    /** Threshold after which auth info refresh is required */
+    refreshTimestamp;
+    _status = 'OK';
+    statusListener;
+    grpcInterceptors;
+    _grpcTransport;
+    providers = [];
+    grpcPl;
+    httpDispatcher;
+    constructor(configOrAddress, ops = {}) {
+        this.ops = ops;
+        this.conf
+            = typeof configOrAddress === 'string' ? plAddressToConfig(configOrAddress) : configOrAddress;
+        this.grpcInterceptors = [];
+        const { auth, statusListener, shouldUseGzip } = ops;
+        if (auth !== undefined) {
+            this.refreshTimestamp = inferAuthRefreshTime(auth.authInformation, this.conf.authMaxRefreshSeconds);
+            this.grpcInterceptors.push(this.createAuthInterceptor());
+            this.authInformation = auth.authInformation;
+            this.onAuthUpdate = auth.onUpdate;
+            this.onAuthRefreshProblem = auth.onUpdateError;
+            this.onAuthError = auth.onAuthError;
+        }
+        this.grpcInterceptors.push(this.createErrorInterceptor());
+        // initialize _grpcTransport and _grpcPl
+        this.initGrpc(shouldUseGzip ?? false);
+        this.httpDispatcher = defaultHttpDispatcher(this.conf.httpProxy);
+        if (statusListener !== undefined) {
+            this.statusListener = statusListener;
+            statusListener(this._status);
+        }
+        this.grpcPl = this.createGrpcClientProvider((transport) => new PlatformClient(transport));
+    }
+    /**
+     * Initializes (or reinitializes) _grpcTransport and _grpcPl
+     * @param gzip - whether to enable gzip compression
+     */
+    initGrpc(gzip) {
+        const clientOptions = {
+            'grpc.keepalive_time_ms': 30_000, // 30 seconds
+            'interceptors': this.grpcInterceptors,
+        };
+        if (gzip)
+            clientOptions['grpc.default_compression_algorithm'] = compressionAlgorithms.gzip;
+        //
+        // Leaving it here for now
+        // https://github.com/grpc/grpc-node/issues/2788
+        //
+        // We should implement message pooling algorithm to overcome hardcoded NO_DELAY behaviour
+        // of HTTP/2 and allow our small messages to batch together.
+        //
+        const grpcOptions = {
+            host: this.conf.hostAndPort,
+            timeout: this.conf.defaultRequestTimeout,
+            channelCredentials: this.conf.ssl
+                ? ChannelCredentials.createSsl()
+                : ChannelCredentials.createInsecure(),
+            clientOptions,
+        };
+        if (this.conf.grpcProxy)
+            process.env.grpc_proxy = this.conf.grpcProxy;
+        else
+            delete process.env.grpc_proxy;
+        const oldTransport = this._grpcTransport;
+        this._grpcTransport = new GrpcTransport(grpcOptions);
+        // Reset all providers to let them reinitialize their clients
+        for (let i = 0; i < this.providers.length; i++) {
+            const provider = this.providers[i].deref();
+            if (provider === undefined) {
+                // at the same time we need to remove providers that are no longer valid
+                this.providers.splice(i, 1);
+                i--;
+            }
+            else {
+                provider.reset();
+            }
+        }
+        if (oldTransport !== undefined)
+            oldTransport.close();
+    }
+    providerCleanupCounter = 0;
+    /**
+     * Creates a provider for a grpc client. Returned provider will create fresh client whenever the underlying transport is reset.
+     *
+     * @param clientConstructor - a factory function that creates a grpc client
+     */
+    createGrpcClientProvider(clientConstructor) {
+        // We need to cleanup providers periodically to avoid memory leaks.
+        // This is a simple heuristic to avoid memory leaks.
+        // We could use a more sophisticated algorithm, but this is good enough for now.
+        this.providerCleanupCounter++;
+        if (this.providerCleanupCounter >= 16) {
+            for (let i = 0; i < this.providers.length; i++) {
+                const provider = this.providers[i].deref();
+                if (provider === undefined) {
+                    this.providers.splice(i, 1);
+                    i--;
+                }
+            }
+            this.providerCleanupCounter = 0;
+        }
+        const provider = new GrpcClientProviderImpl(() => this._grpcTransport, clientConstructor);
+        this.providers.push(new WeakRef(provider));
+        return provider;
+    }
+    get grpcTransport() {
+        return this._grpcTransport;
+    }
+    /** Returns true if client is authenticated. Even with anonymous auth information
+     * connection is considered authenticated. Unauthenticated clients are used for
+     * login and similar tasks, see {@link UnauthenticatedPlClient}. */
+    get authenticated() {
+        return this.authInformation !== undefined;
+    }
+    /** null means anonymous connection */
+    get authUser() {
+        if (!this.authenticated)
+            throw new Error('Client is not authenticated');
+        if (this.authInformation?.jwtToken)
+            return parsePlJwt(this.authInformation?.jwtToken).user.login;
+        else
+            return null;
+    }
+    updateStatus(newStatus) {
+        process.nextTick(() => {
+            if (this._status !== newStatus) {
+                this._status = newStatus;
+                if (this.statusListener !== undefined)
+                    this.statusListener(this._status);
+                if (this.onAuthError !== undefined)
+                    this.onAuthError();
+            }
+        });
+    }
+    get status() {
+        return this._status;
+    }
+    authRefreshInProgress = false;
+    refreshAuthInformationIfNeeded() {
+        if (this.refreshTimestamp === undefined
+            || Date.now() < this.refreshTimestamp
+            || this.authRefreshInProgress
+            || this._status === 'Unauthenticated')
+            return;
+        // Running refresh in background`
+        this.authRefreshInProgress = true;
+        void (async () => {
+            try {
+                const response = await this.grpcPl.get().getJWTToken({
+                    expiration: {
+                        seconds: BigInt(this.conf.authTTLSeconds),
+                        nanos: 0,
+                    },
+                }).response;
+                this.authInformation = { jwtToken: response.token };
+                this.refreshTimestamp = inferAuthRefreshTime(this.authInformation, this.conf.authMaxRefreshSeconds);
+                if (this.onAuthUpdate)
+                    this.onAuthUpdate(this.authInformation);
+            }
+            catch (e) {
+                if (this.onAuthRefreshProblem)
+                    this.onAuthRefreshProblem(e);
+            }
+            finally {
+                this.authRefreshInProgress = false;
+            }
+        })();
+    }
+    /** Detects certain errors and update client status accordingly */
+    createErrorInterceptor() {
+        return (options, nextCall) => {
+            return new InterceptingCall(nextCall(options), {
+                start: (metadata, listener, next) => {
+                    next(metadata, {
+                        onReceiveStatus: (status$1, next) => {
+                            if (status$1.code == status.UNAUTHENTICATED)
+                                // (!!!) don't change to "==="
+                                this.updateStatus('Unauthenticated');
+                            if (status$1.code == status.UNAVAILABLE)
+                                // (!!!) don't change to "==="
+                                this.updateStatus('Disconnected');
+                            next(status$1);
+                        },
+                    });
+                },
+            });
+        };
+    }
+    /** Injects authentication information if needed */
+    createAuthInterceptor() {
+        return (options, nextCall) => {
+            return new InterceptingCall(nextCall(options), {
+                start: (metadata, listener, next) => {
+                    if (this.authInformation?.jwtToken !== undefined) {
+                        metadata.set('authorization', 'Bearer ' + this.authInformation.jwtToken);
+                        this.refreshAuthInformationIfNeeded();
+                        next(metadata, listener);
+                    }
+                    else {
+                        next(metadata, listener);
+                    }
+                },
+            });
+        };
+    }
+    createTx(rw, ops = {}) {
+        return new LLPlTransaction((abortSignal) => {
+            let totalAbortSignal = abortSignal;
+            if (ops.abortSignal)
+                totalAbortSignal = AbortSignal.any([totalAbortSignal, ops.abortSignal]);
+            return this.grpcPl.get().tx({
+                abort: totalAbortSignal,
+                timeout: ops.timeout
+                    ?? (rw ? this.conf.defaultRWTransactionTimeout : this.conf.defaultROTransactionTimeout),
+            });
+        });
+    }
+    /** Closes underlying transport */
+    async close() {
+        this.grpcTransport.close();
+        await this.httpDispatcher.destroy();
+    }
+}
+
+export { LLPlClient };
+//# sourceMappingURL=ll_client.js.map

package/dist/core/ll_client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ll_client.js","sources":["../../src/core/ll_client.ts"],"sourcesContent":["import { PlatformClient } from '../proto/github.com/milaboratory/pl/plapi/plapiproto/api.client';\nimport type { ClientOptions, Interceptor } from '@grpc/grpc-js';\nimport {\n  ChannelCredentials,\n  InterceptingCall,\n  status as GrpcStatus,\n  compressionAlgorithms,\n} from '@grpc/grpc-js';\nimport type {\n  AuthInformation,\n  AuthOps,\n  PlClientConfig,\n  PlConnectionStatus,\n  PlConnectionStatusListener,\n} from './config';\nimport { plAddressToConfig } from './config';\nimport type { GrpcOptions } from '@protobuf-ts/grpc-transport';\nimport { GrpcTransport } from '@protobuf-ts/grpc-transport';\nimport { LLPlTransaction } from './ll_transaction';\nimport { parsePlJwt } from '../util/pl';\nimport type { Dispatcher } from 'undici';\nimport { inferAuthRefreshTime } from './auth';\nimport { defaultHttpDispatcher } from '@milaboratories/pl-http';\nimport type { GrpcClientProvider, GrpcClientProviderFactory } from './grpc';\n\nexport interface PlCallOps {\n  timeout?: number;\n  abortSignal?: AbortSignal;\n}\n\nclass GrpcClientProviderImpl<Client> implements GrpcClientProvider<Client> {\n  private client: Client | undefined = undefined;\n\n  constructor(private readonly grpcTransport: () => GrpcTransport, private readonly clientConstructor: (transport: GrpcTransport) => Client) {}\n\n  public reset(): void {\n    this.client = undefined;\n  }\n\n  public get(): Client {\n    if (this.client === undefined)\n      this.client = this.clientConstructor(this.grpcTransport());\n    return this.client;\n  }\n}\n\n/** Abstract out low level networking and authorization details */\nexport class LLPlClient implements GrpcClientProviderFactory {\n  public readonly conf: PlClientConfig;\n\n  /** Initial authorization information */\n  private authInformation?: AuthInformation;\n  /** Will be executed by the client when it is required */\n  private readonly onAuthUpdate?: (newInfo: AuthInformation) => void;\n  /** Will be executed if auth-related error happens during normal client operation */\n  private readonly onAuthError?: () => void;\n  /** Will be executed by the client when it is required */\n  private readonly onAuthRefreshProblem?: (error: unknown) => void;\n  /** Threshold after which auth info refresh is required */\n  private refreshTimestamp?: number;\n\n  private _status: PlConnectionStatus = 'OK';\n  private readonly statusListener?: PlConnectionStatusListener;\n\n  private readonly grpcInterceptors: Interceptor[];\n  private _grpcTransport!: GrpcTransport;\n  private readonly providers: WeakRef<GrpcClientProviderImpl<any>>[] = [];\n\n  public readonly grpcPl: GrpcClientProvider<PlatformClient>;\n\n  public readonly httpDispatcher: Dispatcher;\n\n  constructor(\n    configOrAddress: PlClientConfig | string,\n    private readonly ops: {\n      auth?: AuthOps;\n      statusListener?: PlConnectionStatusListener;\n      shouldUseGzip?: boolean;\n    } = {},\n  ) {\n    this.conf\n      = typeof configOrAddress === 'string' ? plAddressToConfig(configOrAddress) : configOrAddress;\n\n    this.grpcInterceptors = [];\n\n    const { auth, statusListener, shouldUseGzip } = ops;\n\n    if (auth !== undefined) {\n      this.refreshTimestamp = inferAuthRefreshTime(\n        auth.authInformation,\n        this.conf.authMaxRefreshSeconds,\n      );\n      this.grpcInterceptors.push(this.createAuthInterceptor());\n      this.authInformation = auth.authInformation;\n      this.onAuthUpdate = auth.onUpdate;\n      this.onAuthRefreshProblem = auth.onUpdateError;\n      this.onAuthError = auth.onAuthError;\n    }\n\n    this.grpcInterceptors.push(this.createErrorInterceptor());\n\n    // initialize _grpcTransport and _grpcPl\n    this.initGrpc(shouldUseGzip ?? false);\n\n    this.httpDispatcher = defaultHttpDispatcher(this.conf.httpProxy);\n\n    if (statusListener !== undefined) {\n      this.statusListener = statusListener;\n      statusListener(this._status);\n    }\n\n    this.grpcPl = this.createGrpcClientProvider((transport) => new PlatformClient(transport));\n  }\n\n  /**\n   * Initializes (or reinitializes) _grpcTransport and _grpcPl\n   * @param gzip - whether to enable gzip compression\n   */\n  private initGrpc(gzip: boolean) {\n    const clientOptions: ClientOptions = {\n      'grpc.keepalive_time_ms': 30_000, // 30 seconds\n      'interceptors': this.grpcInterceptors,\n    };\n\n    if (gzip) clientOptions['grpc.default_compression_algorithm'] = compressionAlgorithms.gzip;\n\n    //\n    // Leaving it here for now\n    // https://github.com/grpc/grpc-node/issues/2788\n    //\n    // We should implement message pooling algorithm to overcome hardcoded NO_DELAY behaviour\n    // of HTTP/2 and allow our small messages to batch together.\n    //\n    const grpcOptions: GrpcOptions = {\n      host: this.conf.hostAndPort,\n      timeout: this.conf.defaultRequestTimeout,\n      channelCredentials: this.conf.ssl\n        ? ChannelCredentials.createSsl()\n        : ChannelCredentials.createInsecure(),\n      clientOptions,\n    };\n\n    if (this.conf.grpcProxy) process.env.grpc_proxy = this.conf.grpcProxy;\n    else delete process.env.grpc_proxy;\n\n    const oldTransport = this._grpcTransport;\n\n    this._grpcTransport = new GrpcTransport(grpcOptions);\n\n    // Reset all providers to let them reinitialize their clients\n    for (let i = 0; i < this.providers.length; i++) {\n      const provider = this.providers[i].deref();\n      if (provider === undefined) {\n        // at the same time we need to remove providers that are no longer valid\n        this.providers.splice(i, 1);\n        i--;\n      } else {\n        provider.reset();\n      }\n    }\n\n    if (oldTransport !== undefined) oldTransport.close();\n  }\n\n  private providerCleanupCounter = 0;\n\n  /**\n   * Creates a provider for a grpc client. Returned provider will create fresh client whenever the underlying transport is reset.\n   *\n   * @param clientConstructor - a factory function that creates a grpc client\n   */\n  public createGrpcClientProvider<Client>(clientConstructor: (transport: GrpcTransport) => Client): GrpcClientProvider<Client> {\n    // We need to cleanup providers periodically to avoid memory leaks.\n    // This is a simple heuristic to avoid memory leaks.\n    // We could use a more sophisticated algorithm, but this is good enough for now.\n    this.providerCleanupCounter++;\n    if (this.providerCleanupCounter >= 16) {\n      for (let i = 0; i < this.providers.length; i++) {\n        const provider = this.providers[i].deref();\n        if (provider === undefined) {\n          this.providers.splice(i, 1);\n          i--;\n        }\n      }\n      this.providerCleanupCounter = 0;\n    }\n\n    const provider = new GrpcClientProviderImpl<Client>(() => this._grpcTransport, clientConstructor);\n    this.providers.push(new WeakRef(provider));\n    return provider;\n  }\n\n  public get grpcTransport(): GrpcTransport {\n    return this._grpcTransport;\n  }\n\n  /** Returns true if client is authenticated. Even with anonymous auth information\n   * connection is considered authenticated. Unauthenticated clients are used for\n   * login and similar tasks, see {@link UnauthenticatedPlClient}. */\n  public get authenticated(): boolean {\n    return this.authInformation !== undefined;\n  }\n\n  /** null means anonymous connection */\n  public get authUser(): string | null {\n    if (!this.authenticated) throw new Error('Client is not authenticated');\n    if (this.authInformation?.jwtToken)\n      return parsePlJwt(this.authInformation?.jwtToken).user.login;\n    else return null;\n  }\n\n  private updateStatus(newStatus: PlConnectionStatus) {\n    process.nextTick(() => {\n      if (this._status !== newStatus) {\n        this._status = newStatus;\n        if (this.statusListener !== undefined) this.statusListener(this._status);\n        if (this.onAuthError !== undefined) this.onAuthError();\n      }\n    });\n  }\n\n  public get status(): PlConnectionStatus {\n    return this._status;\n  }\n\n  private authRefreshInProgress: boolean = false;\n\n  private refreshAuthInformationIfNeeded(): void {\n    if (\n      this.refreshTimestamp === undefined\n      || Date.now() < this.refreshTimestamp\n      || this.authRefreshInProgress\n      || this._status === 'Unauthenticated'\n    )\n      return;\n\n    // Running refresh in background`\n    this.authRefreshInProgress = true;\n    void (async () => {\n      try {\n        const response = await this.grpcPl.get().getJWTToken({\n          expiration: {\n            seconds: BigInt(this.conf.authTTLSeconds),\n            nanos: 0,\n          },\n        }).response;\n        this.authInformation = { jwtToken: response.token };\n        this.refreshTimestamp = inferAuthRefreshTime(\n          this.authInformation,\n          this.conf.authMaxRefreshSeconds,\n        );\n        if (this.onAuthUpdate) this.onAuthUpdate(this.authInformation);\n      } catch (e: unknown) {\n        if (this.onAuthRefreshProblem) this.onAuthRefreshProblem(e);\n      } finally {\n        this.authRefreshInProgress = false;\n      }\n    })();\n  }\n\n  /** Detects certain errors and update client status accordingly */\n  private createErrorInterceptor(): Interceptor {\n    return (options, nextCall) => {\n      return new InterceptingCall(nextCall(options), {\n        start: (metadata, listener, next) => {\n          next(metadata, {\n            onReceiveStatus: (status, next) => {\n              if (status.code == GrpcStatus.UNAUTHENTICATED)\n                // (!!!) don't change to \"===\"\n                this.updateStatus('Unauthenticated');\n              if (status.code == GrpcStatus.UNAVAILABLE)\n                // (!!!) don't change to \"===\"\n                this.updateStatus('Disconnected');\n              next(status);\n            },\n          });\n        },\n      });\n    };\n  }\n\n  /** Injects authentication information if needed */\n  private createAuthInterceptor(): Interceptor {\n    return (options, nextCall) => {\n      return new InterceptingCall(nextCall(options), {\n        start: (metadata, listener, next) => {\n          if (this.authInformation?.jwtToken !== undefined) {\n            metadata.set('authorization', 'Bearer ' + this.authInformation.jwtToken);\n            this.refreshAuthInformationIfNeeded();\n            next(metadata, listener);\n          } else {\n            next(metadata, listener);\n          }\n        },\n      });\n    };\n  }\n\n  createTx(rw: boolean, ops: PlCallOps = {}): LLPlTransaction {\n    return new LLPlTransaction((abortSignal) => {\n      let totalAbortSignal = abortSignal;\n      if (ops.abortSignal) totalAbortSignal = AbortSignal.any([totalAbortSignal, ops.abortSignal]);\n      return this.grpcPl.get().tx({\n        abort: totalAbortSignal,\n        timeout:\n          ops.timeout\n          ?? (rw ? this.conf.defaultRWTransactionTimeout : this.conf.defaultROTransactionTimeout),\n      });\n    });\n  }\n\n  /** Closes underlying transport */\n  public async close() {\n    this.grpcTransport.close();\n    await this.httpDispatcher.destroy();\n  }\n}\n"],"names":["status","GrpcStatus"],"mappings":";;;;;;;;;AA8BA,MAAM,sBAAsB,CAAA;AAGG,IAAA,aAAA;AAAqD,IAAA,iBAAA;IAF1E,MAAM,GAAuB,SAAS;IAE9C,WAAA,CAA6B,aAAkC,EAAmB,iBAAuD,EAAA;QAA5G,IAAA,CAAA,aAAa,GAAb,aAAa;QAAwC,IAAA,CAAA,iBAAiB,GAAjB,iBAAiB;IAAyC;IAErI,KAAK,GAAA;AACV,QAAA,IAAI,CAAC,MAAM,GAAG,SAAS;IACzB;IAEO,GAAG,GAAA;AACR,QAAA,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;AAC3B,YAAA,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,MAAM;IACpB;AACD;AAED;MACa,UAAU,CAAA;AA2BF,IAAA,GAAA;AA1BH,IAAA,IAAI;;AAGZ,IAAA,eAAe;;AAEN,IAAA,YAAY;;AAEZ,IAAA,WAAW;;AAEX,IAAA,oBAAoB;;AAE7B,IAAA,gBAAgB;IAEhB,OAAO,GAAuB,IAAI;AACzB,IAAA,cAAc;AAEd,IAAA,gBAAgB;AACzB,IAAA,cAAc;IACL,SAAS,GAA2C,EAAE;AAEvD,IAAA,MAAM;AAEN,IAAA,cAAc;IAE9B,WAAA,CACE,eAAwC,EACvB,GAAA,GAIb,EAAE,EAAA;QAJW,IAAA,CAAA,GAAG,GAAH,GAAG;AAMpB,QAAA,IAAI,CAAC;AACD,cAAA,OAAO,eAAe,KAAK,QAAQ,GAAG,iBAAiB,CAAC,eAAe,CAAC,GAAG,eAAe;AAE9F,QAAA,IAAI,CAAC,gBAAgB,GAAG,EAAE;QAE1B,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,aAAa,EAAE,GAAG,GAAG;AAEnD,QAAA,IAAI,IAAI,KAAK,SAAS,EAAE;AACtB,YAAA,IAAI,CAAC,gBAAgB,GAAG,oBAAoB,CAC1C,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAChC;YACD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;AACxD,YAAA,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe;AAC3C,YAAA,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,QAAQ;AACjC,YAAA,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,aAAa;AAC9C,YAAA,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW;QACrC;QAEA,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE,CAAC;;AAGzD,QAAA,IAAI,CAAC,QAAQ,CAAC,aAAa,IAAI,KAAK,CAAC;QAErC,IAAI,CAAC,cAAc,GAAG,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;AAEhE,QAAA,IAAI,cAAc,KAAK,SAAS,EAAE;AAChC,YAAA,IAAI,CAAC,cAAc,GAAG,cAAc;AACpC,YAAA,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC;QAC9B;AAEA,QAAA,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,wBAAwB,CAAC,CAAC,SAAS,KAAK,IAAI,cAAc,CAAC,SAAS,CAAC,CAAC;IAC3F;AAEA;;;AAGG;AACK,IAAA,QAAQ,CAAC,IAAa,EAAA;AAC5B,QAAA,MAAM,aAAa,GAAkB;YACnC,wBAAwB,EAAE,MAAM;YAChC,cAAc,EAAE,IAAI,CAAC,gBAAgB;SACtC;AAED,QAAA,IAAI,IAAI;AAAE,YAAA,aAAa,CAAC,oCAAoC,CAAC,GAAG,qBAAqB,CAAC,IAAI;;;;;;;;AAS1F,QAAA,MAAM,WAAW,GAAgB;AAC/B,YAAA,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW;AAC3B,YAAA,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,qBAAqB;AACxC,YAAA,kBAAkB,EAAE,IAAI,CAAC,IAAI,CAAC;AAC5B,kBAAE,kBAAkB,CAAC,SAAS;AAC9B,kBAAE,kBAAkB,CAAC,cAAc,EAAE;YACvC,aAAa;SACd;AAED,QAAA,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAO,CAAC,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS;;AAChE,YAAA,OAAO,OAAO,CAAC,GAAG,CAAC,UAAU;AAElC,QAAA,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc;QAExC,IAAI,CAAC,cAAc,GAAG,IAAI,aAAa,CAAC,WAAW,CAAC;;AAGpD,QAAA,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE;AAC1C,YAAA,IAAI,QAAQ,KAAK,SAAS,EAAE;;gBAE1B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC;AAC3B,gBAAA,CAAC,EAAE;YACL;iBAAO;gBACL,QAAQ,CAAC,KAAK,EAAE;YAClB;QACF;QAEA,IAAI,YAAY,KAAK,SAAS;YAAE,YAAY,CAAC,KAAK,EAAE;IACtD;IAEQ,sBAAsB,GAAG,CAAC;AAElC;;;;AAIG;AACI,IAAA,wBAAwB,CAAS,iBAAuD,EAAA;;;;QAI7F,IAAI,CAAC,sBAAsB,EAAE;AAC7B,QAAA,IAAI,IAAI,CAAC,sBAAsB,IAAI,EAAE,EAAE;AACrC,YAAA,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE;AAC1C,gBAAA,IAAI,QAAQ,KAAK,SAAS,EAAE;oBAC1B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC;AAC3B,oBAAA,CAAC,EAAE;gBACL;YACF;AACA,YAAA,IAAI,CAAC,sBAAsB,GAAG,CAAC;QACjC;AAEA,QAAA,MAAM,QAAQ,GAAG,IAAI,sBAAsB,CAAS,MAAM,IAAI,CAAC,cAAc,EAAE,iBAAiB,CAAC;QACjG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC1C,QAAA,OAAO,QAAQ;IACjB;AAEA,IAAA,IAAW,aAAa,GAAA;QACtB,OAAO,IAAI,CAAC,cAAc;IAC5B;AAEA;;AAEmE;AACnE,IAAA,IAAW,aAAa,GAAA;AACtB,QAAA,OAAO,IAAI,CAAC,eAAe,KAAK,SAAS;IAC3C;;AAGA,IAAA,IAAW,QAAQ,GAAA;QACjB,IAAI,CAAC,IAAI,CAAC,aAAa;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC;AACvE,QAAA,IAAI,IAAI,CAAC,eAAe,EAAE,QAAQ;AAChC,YAAA,OAAO,UAAU,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,KAAK;;AACzD,YAAA,OAAO,IAAI;IAClB;AAEQ,IAAA,YAAY,CAAC,SAA6B,EAAA;AAChD,QAAA,OAAO,CAAC,QAAQ,CAAC,MAAK;AACpB,YAAA,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE;AAC9B,gBAAA,IAAI,CAAC,OAAO,GAAG,SAAS;AACxB,gBAAA,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS;AAAE,oBAAA,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC;AACxE,gBAAA,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS;oBAAE,IAAI,CAAC,WAAW,EAAE;YACxD;AACF,QAAA,CAAC,CAAC;IACJ;AAEA,IAAA,IAAW,MAAM,GAAA;QACf,OAAO,IAAI,CAAC,OAAO;IACrB;IAEQ,qBAAqB,GAAY,KAAK;IAEtC,8BAA8B,GAAA;AACpC,QAAA,IACE,IAAI,CAAC,gBAAgB,KAAK;AACvB,eAAA,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AAClB,eAAA,IAAI,CAAC;eACL,IAAI,CAAC,OAAO,KAAK,iBAAiB;YAErC;;AAGF,QAAA,IAAI,CAAC,qBAAqB,GAAG,IAAI;QACjC,KAAK,CAAC,YAAW;AACf,YAAA,IAAI;gBACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC;AACnD,oBAAA,UAAU,EAAE;wBACV,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC;AACzC,wBAAA,KAAK,EAAE,CAAC;AACT,qBAAA;iBACF,CAAC,CAAC,QAAQ;gBACX,IAAI,CAAC,eAAe,GAAG,EAAE,QAAQ,EAAE,QAAQ,CAAC,KAAK,EAAE;AACnD,gBAAA,IAAI,CAAC,gBAAgB,GAAG,oBAAoB,CAC1C,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAChC;gBACD,IAAI,IAAI,CAAC,YAAY;AAAE,oBAAA,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC;YAChE;YAAE,OAAO,CAAU,EAAE;gBACnB,IAAI,IAAI,CAAC,oBAAoB;AAAE,oBAAA,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC;YAC7D;oBAAU;AACR,gBAAA,IAAI,CAAC,qBAAqB,GAAG,KAAK;YACpC;QACF,CAAC,GAAG;IACN;;IAGQ,sBAAsB,GAAA;AAC5B,QAAA,OAAO,CAAC,OAAO,EAAE,QAAQ,KAAI;AAC3B,YAAA,OAAO,IAAI,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;gBAC7C,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,KAAI;oBAClC,IAAI,CAAC,QAAQ,EAAE;AACb,wBAAA,eAAe,EAAE,CAACA,QAAM,EAAE,IAAI,KAAI;AAChC,4BAAA,IAAIA,QAAM,CAAC,IAAI,IAAIC,MAAU,CAAC,eAAe;;AAE3C,gCAAA,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC;AACtC,4BAAA,IAAID,QAAM,CAAC,IAAI,IAAIC,MAAU,CAAC,WAAW;;AAEvC,gCAAA,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC;4BACnC,IAAI,CAACD,QAAM,CAAC;wBACd,CAAC;AACF,qBAAA,CAAC;gBACJ,CAAC;AACF,aAAA,CAAC;AACJ,QAAA,CAAC;IACH;;IAGQ,qBAAqB,GAAA;AAC3B,QAAA,OAAO,CAAC,OAAO,EAAE,QAAQ,KAAI;AAC3B,YAAA,OAAO,IAAI,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;gBAC7C,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,KAAI;oBAClC,IAAI,IAAI,CAAC,eAAe,EAAE,QAAQ,KAAK,SAAS,EAAE;AAChD,wBAAA,QAAQ,CAAC,GAAG,CAAC,eAAe,EAAE,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC;wBACxE,IAAI,CAAC,8BAA8B,EAAE;AACrC,wBAAA,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;oBAC1B;yBAAO;AACL,wBAAA,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC;oBAC1B;gBACF,CAAC;AACF,aAAA,CAAC;AACJ,QAAA,CAAC;IACH;AAEA,IAAA,QAAQ,CAAC,EAAW,EAAE,GAAA,GAAiB,EAAE,EAAA;AACvC,QAAA,OAAO,IAAI,eAAe,CAAC,CAAC,WAAW,KAAI;YACzC,IAAI,gBAAgB,GAAG,WAAW;YAClC,IAAI,GAAG,CAAC,WAAW;AAAE,gBAAA,gBAAgB,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;YAC5F,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;AAC1B,gBAAA,KAAK,EAAE,gBAAgB;gBACvB,OAAO,EACL,GAAG,CAAC;AACD,wBAAC,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,2BAA2B,GAAG,IAAI,CAAC,IAAI,CAAC,2BAA2B,CAAC;AAC1F,aAAA,CAAC;AACJ,QAAA,CAAC,CAAC;IACJ;;AAGO,IAAA,MAAM,KAAK,GAAA;AAChB,QAAA,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE;AAC1B,QAAA,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE;IACrC;AACD;;;;"}

package/dist/core/ll_transaction.cjs

@@ -0,0 +1,236 @@
+'use strict';
+
+var Denque = require('denque');
+var errors = require('./errors.cjs');
+
+function createResponseHandler(kind, expectMultiResponse, resolve, reject) {
+    return { kind, expectMultiResponse, resolve, reject };
+}
+function isRecoverable(status) {
+    return status.code === errors.PlErrorCodeNotFound;
+}
+class RethrowError extends Error {
+    rethrowLambda;
+    name = 'RethrowError';
+    constructor(rethrowLambda) {
+        super('Rethrow error, you should never see this one.');
+        this.rethrowLambda = rethrowLambda;
+    }
+}
+class LLPlTransaction {
+    /** Bidirectional channel through which transaction communicates with the server */
+    stream;
+    /** Used to abort ongoing transaction stream */
+    abortController = new AbortController();
+    /** Counter of sent requests, used to calculate which future response will correspond to this request.
+     * Incremented on each sent request. */
+    requestIdxCounter = 0;
+    /** Queue from which incoming message processor takes handlers to which pass incoming messages */
+    responseHandlerQueue = new Denque();
+    /** Each new resource, created by the transaction, is assigned with virtual (local) resource id, to make it possible
+     * to populate its fields without awaiting actual resource id. This counter tracks those ids on client side, the
+     * same way it is tracked on the server, so client can synchronously return such ids to the user. */
+    localResourceIdCounter = 0n;
+    /** Switches to true, when this transaction closes due to normal or exceptional conditions. Prevents any new messages
+     * to be sent to the stream. */
+    closed = false;
+    /** Whether the outgoing stream was already closed. */
+    completed = false;
+    /** If this transaction was terminated due to error, this is a generator to create new errors if corresponding response is required. */
+    errorFactory;
+    /** Timestamp when transaction was opened */
+    openTimestamp = Date.now();
+    incomingProcessorResult;
+    constructor(streamFactory) {
+        this.stream = streamFactory(this.abortController.signal);
+        // Starting incoming event processor
+        this.incomingProcessorResult = this.incomingEventProcessor();
+    }
+    assignErrorFactoryIfNotSet(errorFactory, reject) {
+        if (reject !== undefined)
+            reject(new RethrowError(errorFactory));
+        if (this.errorFactory)
+            return errorFactory;
+        this.errorFactory = errorFactory;
+        return errorFactory;
+    }
+    async incomingEventProcessor() {
+        /** Counter of received responses, used to check consistency of responses.
+         * Increments on each received message. */
+        let expectedId = -1;
+        // defined externally to make possible to communicate any processing errors
+        // to the specific request on which it happened
+        let currentHandler = undefined;
+        let responseAggregator = undefined;
+        try {
+            for await (const message of this.stream.responses) {
+                if (currentHandler === undefined) {
+                    currentHandler = this.responseHandlerQueue.shift();
+                    if (currentHandler === undefined) {
+                        this.assignErrorFactoryIfNotSet(() => {
+                            throw new Error(`orphan incoming message`);
+                        });
+                        break;
+                    }
+                    // allocating response aggregator array
+                    if (currentHandler.expectMultiResponse)
+                        responseAggregator = [];
+                    expectedId++;
+                }
+                if (message.requestId !== expectedId) {
+                    const errorMessage = `out of order messages, ${message.requestId} !== ${expectedId}`;
+                    this.assignErrorFactoryIfNotSet(() => {
+                        throw new Error(errorMessage);
+                    });
+                    break;
+                }
+                if (message.error !== undefined) {
+                    const status = message.error;
+                    if (isRecoverable(status)) {
+                        currentHandler.reject(new RethrowError(() => {
+                            throw new errors.RecoverablePlError(status);
+                        }));
+                        currentHandler = undefined;
+                        if (message.multiMessage !== undefined && !message.multiMessage.isLast) {
+                            this.assignErrorFactoryIfNotSet(() => {
+                                throw new Error('Unexpected message sequence.');
+                            });
+                            break;
+                        }
+                        // We can continue to work after recoverable errors
+                        continue;
+                    }
+                    else {
+                        this.assignErrorFactoryIfNotSet(() => {
+                            throw new errors.UnrecoverablePlError(status);
+                        }, currentHandler.reject);
+                        currentHandler = undefined;
+                        // In case of unrecoverable errors we close the transaction
+                        break;
+                    }
+                }
+                if (currentHandler.kind !== message.response.oneofKind
+                    && message?.multiMessage?.isEmpty !== true) {
+                    const errorMessage = `inconsistent request response types: ${currentHandler.kind} !== ${message.response.oneofKind}`;
+                    this.assignErrorFactoryIfNotSet(() => {
+                        throw new Error(errorMessage);
+                    }, currentHandler.reject);
+                    currentHandler = undefined;
+                    break;
+                }
+                if (currentHandler.expectMultiResponse !== (message.multiMessage !== undefined)) {
+                    const errorMessage = `inconsistent multi state: ${currentHandler.expectMultiResponse} !== ${message.multiMessage !== undefined}`;
+                    this.assignErrorFactoryIfNotSet(() => {
+                        throw new Error(errorMessage);
+                    }, currentHandler.reject);
+                    currentHandler = undefined;
+                    break;
+                }
+                // <- at this point we validated everything we can at this level
+                if (message.multiMessage !== undefined) {
+                    if (!message.multiMessage.isEmpty) {
+                        if (message.multiMessage.id !== responseAggregator.length + 1) {
+                            const errorMessage = `inconsistent multi id: ${message.multiMessage.id} !== ${responseAggregator.length + 1}`;
+                            this.assignErrorFactoryIfNotSet(() => {
+                                throw new Error(errorMessage);
+                            }, currentHandler.reject);
+                            currentHandler = undefined;
+                            break;
+                        }
+                        responseAggregator.push(message.response);
+                    }
+                    if (message.multiMessage.isLast) {
+                        currentHandler.resolve(responseAggregator);
+                        responseAggregator = undefined;
+                        currentHandler = undefined;
+                    }
+                }
+                else {
+                    currentHandler.resolve(message.response);
+                    currentHandler = undefined;
+                }
+            }
+        }
+        catch (e) {
+            return this.assignErrorFactoryIfNotSet(() => {
+                errors.rethrowMeaningfulError(e, true);
+            }, currentHandler?.reject);
+        }
+        finally {
+            await this.close();
+        }
+        return null;
+    }
+    /** Executed after termination of incoming message processor */
+    async close() {
+        if (this.closed)
+            return;
+        this.closed = true;
+        // Rejecting all messages
+        while (true) {
+            const handler = this.responseHandlerQueue.shift();
+            if (!handler)
+                break;
+            if (this.errorFactory)
+                handler.reject(new RethrowError(this.errorFactory));
+            else
+                handler.reject(new Error('no reply'));
+        }
+        // closing outgoing stream
+        await this.stream.requests.complete();
+    }
+    /** Forcefully close the transaction, terminate all connections and reject all pending requests */
+    abort(cause) {
+        this.assignErrorFactoryIfNotSet(() => {
+            throw new Error(`transaction aborted`, { cause });
+        });
+        this.abortController.abort(cause);
+    }
+    /** Await incoming message loop termination and throw any leftover errors if it was unsuccessful */
+    async await() {
+        // for those who want to understand "why?":
+        // this way there is no hanging promise that will complete with rejection
+        // until await is implicitly requested, the this.incomingProcessorResult
+        // always resolves with success
+        const processingResult = await this.incomingProcessorResult;
+        if (processingResult !== null)
+            processingResult();
+    }
+    /** Generate proper client message and send it to the server, and returns a promise of future response. */
+    async send(r, expectMultiResponse) {
+        if (this.errorFactory)
+            return Promise.reject(new RethrowError(this.errorFactory));
+        if (this.closed)
+            return Promise.reject(new Error('Transaction already closed'));
+        // Note: Promise synchronously executes a callback passed to a constructor
+        const result = new Promise((resolve, reject) => {
+            this.responseHandlerQueue.push(createResponseHandler(r.oneofKind, expectMultiResponse, resolve, reject));
+        });
+        // Awaiting message dispatch to catch any associated errors.
+        // There is no hurry, we are not going to receive a response until message is sent.
+        await this.stream.requests.send({
+            requestId: this.requestIdxCounter++,
+            request: r,
+        });
+        try {
+            return await result;
+        }
+        catch (e) {
+            if (e instanceof RethrowError)
+                e.rethrowLambda();
+            throw new Error('Error while waiting for response', { cause: e });
+        }
+    }
+    _completed = false;
+    /** Safe to call multiple times */
+    async complete() {
+        if (this._completed)
+            return;
+        this._completed = true;
+        await this.stream.requests.complete();
+    }
+}
+
+exports.LLPlTransaction = LLPlTransaction;
+exports.RethrowError = RethrowError;
+//# sourceMappingURL=ll_transaction.cjs.map

package/dist/core/ll_transaction.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ll_transaction.cjs","sources":["../../src/core/ll_transaction.ts"],"sourcesContent":["import type {\n  TxAPI_ClientMessage,\n  TxAPI_ServerMessage,\n} from '../proto/github.com/milaboratory/pl/plapi/plapiproto/api';\nimport type { DuplexStreamingCall } from '@protobuf-ts/runtime-rpc';\nimport Denque from 'denque';\nimport type { Status } from '../proto/github.com/googleapis/googleapis/google/rpc/status';\nimport {\n  PlErrorCodeNotFound,\n  RecoverablePlError,\n  rethrowMeaningfulError,\n  UnrecoverablePlError,\n} from './errors';\n\nexport type ClientMessageRequest = TxAPI_ClientMessage['request'];\n\nexport type ServerMessageResponse = TxAPI_ServerMessage['response'];\n\ntype TxStream = DuplexStreamingCall<TxAPI_ClientMessage, TxAPI_ServerMessage>;\n\nexport type OneOfKind<T extends { oneofKind: unknown }, Kind extends T['oneofKind']> = Extract<\n  T,\n  { oneofKind: Kind }\n>;\n\ninterface SingleResponseHandler<Kind extends ServerMessageResponse['oneofKind']> {\n  kind: Kind;\n  expectMultiResponse: false;\n  resolve: (v: OneOfKind<ServerMessageResponse, Kind>) => void;\n  reject: (e: Error) => void;\n}\n\ninterface MultiResponseHandler<Kind extends ServerMessageResponse['oneofKind']> {\n  kind: Kind;\n  expectMultiResponse: true;\n  resolve: (v: OneOfKind<ServerMessageResponse, Kind>[]) => void;\n  reject: (e: Error) => void;\n}\n\ntype AnySingleResponseHandler = SingleResponseHandler<ServerMessageResponse['oneofKind']>;\n\ntype AnyMultiResponseHandler = MultiResponseHandler<ServerMessageResponse['oneofKind']>;\n\ntype AnyResponseHandler =\n  | SingleResponseHandler<ServerMessageResponse['oneofKind']>\n  | MultiResponseHandler<ServerMessageResponse['oneofKind']>;\n\nfunction createResponseHandler<Kind extends ServerMessageResponse['oneofKind']>(\n  kind: Kind,\n  expectMultiResponse: boolean,\n  resolve:\n    | ((v: OneOfKind<ServerMessageResponse, Kind>) => void)\n    | ((v: OneOfKind<ServerMessageResponse, Kind>[]) => void),\n  reject: (e: Error) => void,\n): AnyResponseHandler {\n  return { kind, expectMultiResponse, resolve, reject } as AnyResponseHandler;\n}\n\nfunction isRecoverable(status: Status): boolean {\n  return status.code === PlErrorCodeNotFound;\n}\n\nexport class RethrowError extends Error {\n  name = 'RethrowError';\n  constructor(public readonly rethrowLambda: () => never) {\n    super('Rethrow error, you should never see this one.');\n  }\n}\n\nexport class LLPlTransaction {\n  /** Bidirectional channel through which transaction communicates with the server */\n  private readonly stream: TxStream;\n\n  /** Used to abort ongoing transaction stream */\n  private readonly abortController = new AbortController();\n\n  /** Counter of sent requests, used to calculate which future response will correspond to this request.\n   * Incremented on each sent request. */\n  private requestIdxCounter = 0;\n\n  /** Queue from which incoming message processor takes handlers to which pass incoming messages */\n  private readonly responseHandlerQueue = new Denque<AnyResponseHandler>();\n\n  /** Each new resource, created by the transaction, is assigned with virtual (local) resource id, to make it possible\n   * to populate its fields without awaiting actual resource id. This counter tracks those ids on client side, the\n   * same way it is tracked on the server, so client can synchronously return such ids to the user. */\n  private localResourceIdCounter = 0n;\n\n  /** Switches to true, when this transaction closes due to normal or exceptional conditions. Prevents any new messages\n   * to be sent to the stream. */\n  private closed = false;\n  /** Whether the outgoing stream was already closed. */\n  private completed = false;\n\n  /** If this transaction was terminated due to error, this is a generator to create new errors if corresponding response is required. */\n  private errorFactory?: () => never;\n\n  /** Timestamp when transaction was opened */\n  private readonly openTimestamp = Date.now();\n\n  private readonly incomingProcessorResult: Promise<(() => never) | null>;\n\n  constructor(streamFactory: (abortSignal: AbortSignal) => TxStream) {\n    this.stream = streamFactory(this.abortController.signal);\n\n    // Starting incoming event processor\n    this.incomingProcessorResult = this.incomingEventProcessor();\n  }\n\n  private assignErrorFactoryIfNotSet(\n    errorFactory: () => never,\n    reject?: (e: Error) => void,\n  ): () => never {\n    if (reject !== undefined) reject(new RethrowError(errorFactory));\n    if (this.errorFactory) return errorFactory;\n    this.errorFactory = errorFactory;\n    return errorFactory;\n  }\n\n  private async incomingEventProcessor(): Promise<(() => never) | null> {\n    /** Counter of received responses, used to check consistency of responses.\n     * Increments on each received message. */\n    let expectedId = -1;\n\n    // defined externally to make possible to communicate any processing errors\n    // to the specific request on which it happened\n    let currentHandler: AnyResponseHandler | undefined = undefined;\n    let responseAggregator: ServerMessageResponse[] | undefined = undefined;\n    try {\n      for await (const message of this.stream.responses) {\n        if (currentHandler === undefined) {\n          currentHandler = this.responseHandlerQueue.shift();\n\n          if (currentHandler === undefined) {\n            this.assignErrorFactoryIfNotSet(() => {\n              throw new Error(`orphan incoming message`);\n            });\n            break;\n          }\n\n          // allocating response aggregator array\n          if (currentHandler.expectMultiResponse) responseAggregator = [];\n\n          expectedId++;\n        }\n\n        if (message.requestId !== expectedId) {\n          const errorMessage = `out of order messages, ${message.requestId} !== ${expectedId}`;\n          this.assignErrorFactoryIfNotSet(() => {\n            throw new Error(errorMessage);\n          });\n          break;\n        }\n\n        if (message.error !== undefined) {\n          const status = message.error;\n\n          if (isRecoverable(status)) {\n            currentHandler.reject(\n              new RethrowError(() => {\n                throw new RecoverablePlError(status);\n              }),\n            );\n            currentHandler = undefined;\n\n            if (message.multiMessage !== undefined && !message.multiMessage.isLast) {\n              this.assignErrorFactoryIfNotSet(() => {\n                throw new Error('Unexpected message sequence.');\n              });\n              break;\n            }\n\n            // We can continue to work after recoverable errors\n            continue;\n          } else {\n            this.assignErrorFactoryIfNotSet(() => {\n              throw new UnrecoverablePlError(status);\n            }, currentHandler.reject);\n            currentHandler = undefined;\n\n            // In case of unrecoverable errors we close the transaction\n            break;\n          }\n        }\n\n        if (\n          currentHandler.kind !== message.response.oneofKind\n          && message?.multiMessage?.isEmpty !== true\n        ) {\n          const errorMessage = `inconsistent request response types: ${currentHandler.kind} !== ${message.response.oneofKind}`;\n\n          this.assignErrorFactoryIfNotSet(() => {\n            throw new Error(errorMessage);\n          }, currentHandler.reject);\n          currentHandler = undefined;\n\n          break;\n        }\n\n        if (currentHandler.expectMultiResponse !== (message.multiMessage !== undefined)) {\n          const errorMessage = `inconsistent multi state: ${currentHandler.expectMultiResponse} !== ${message.multiMessage !== undefined}`;\n\n          this.assignErrorFactoryIfNotSet(() => {\n            throw new Error(errorMessage);\n          }, currentHandler.reject);\n          currentHandler = undefined;\n\n          break;\n        }\n\n        // <- at this point we validated everything we can at this level\n\n        if (message.multiMessage !== undefined) {\n          if (!message.multiMessage.isEmpty) {\n            if (message.multiMessage.id !== responseAggregator!.length + 1) {\n              const errorMessage = `inconsistent multi id: ${message.multiMessage.id} !== ${responseAggregator!.length + 1}`;\n\n              this.assignErrorFactoryIfNotSet(() => {\n                throw new Error(errorMessage);\n              }, currentHandler.reject);\n              currentHandler = undefined;\n\n              break;\n            }\n\n            responseAggregator!.push(message.response);\n          }\n\n          if (message.multiMessage.isLast) {\n            (currentHandler as AnyMultiResponseHandler).resolve(responseAggregator!);\n            responseAggregator = undefined;\n            currentHandler = undefined;\n          }\n        } else {\n          (currentHandler as AnySingleResponseHandler).resolve(message.response);\n          currentHandler = undefined;\n        }\n      }\n    } catch (e: any) {\n      return this.assignErrorFactoryIfNotSet(() => {\n        rethrowMeaningfulError(e, true);\n      }, currentHandler?.reject);\n    } finally {\n      await this.close();\n    }\n    return null;\n  }\n\n  /** Executed after termination of incoming message processor */\n  private async close(): Promise<void> {\n    if (this.closed) return;\n\n    this.closed = true;\n\n    // Rejecting all messages\n\n    while (true) {\n      const handler = this.responseHandlerQueue.shift();\n      if (!handler) break;\n      if (this.errorFactory) handler.reject(new RethrowError(this.errorFactory));\n      else handler.reject(new Error('no reply'));\n    }\n\n    // closing outgoing stream\n    await this.stream.requests.complete();\n  }\n\n  /** Forcefully close the transaction, terminate all connections and reject all pending requests */\n  public abort(cause?: Error) {\n    this.assignErrorFactoryIfNotSet(() => {\n      throw new Error(`transaction aborted`, { cause });\n    });\n    this.abortController.abort(cause);\n  }\n\n  /** Await incoming message loop termination and throw any leftover errors if it was unsuccessful */\n  public async await(): Promise<void> {\n    // for those who want to understand \"why?\":\n    // this way there is no hanging promise that will complete with rejection\n    // until await is implicitly requested, the this.incomingProcessorResult\n    // always resolves with success\n\n    const processingResult = await this.incomingProcessorResult;\n    if (processingResult !== null) processingResult();\n  }\n\n  public async send<Kind extends ClientMessageRequest['oneofKind']>(\n    r: OneOfKind<ClientMessageRequest, Kind>,\n    expectMultiResponse: false\n  ): Promise<OneOfKind<ServerMessageResponse, Kind>>;\n  public async send<Kind extends ClientMessageRequest['oneofKind']>(\n    r: OneOfKind<ClientMessageRequest, Kind>,\n    expectMultiResponse: true\n  ): Promise<OneOfKind<ServerMessageResponse, Kind>[]>;\n  /** Generate proper client message and send it to the server, and returns a promise of future response. */\n  public async send<Kind extends ClientMessageRequest['oneofKind']>(\n    r: OneOfKind<ClientMessageRequest, Kind>,\n    expectMultiResponse: boolean,\n  ): Promise<OneOfKind<ServerMessageResponse, Kind> | OneOfKind<ServerMessageResponse, Kind>[]> {\n    if (this.errorFactory) return Promise.reject(new RethrowError(this.errorFactory));\n\n    if (this.closed) return Promise.reject(new Error('Transaction already closed'));\n\n    // Note: Promise synchronously executes a callback passed to a constructor\n    const result = new Promise<OneOfKind<ServerMessageResponse, Kind>>((resolve, reject) => {\n      this.responseHandlerQueue.push(\n        createResponseHandler(r.oneofKind, expectMultiResponse, resolve, reject),\n      );\n    });\n\n    // Awaiting message dispatch to catch any associated errors.\n    // There is no hurry, we are not going to receive a response until message is sent.\n    await this.stream.requests.send({\n      requestId: this.requestIdxCounter++,\n      request: r,\n    });\n\n    try {\n      return await result;\n    } catch (e: any) {\n      if (e instanceof RethrowError) e.rethrowLambda();\n      throw new Error('Error while waiting for response', { cause: e });\n    }\n  }\n\n  private _completed = false;\n\n  /** Safe to call multiple times */\n  public async complete() {\n    if (this._completed) return;\n    this._completed = true;\n    await this.stream.requests.complete();\n  }\n}\n"],"names":["PlErrorCodeNotFound","RecoverablePlError","UnrecoverablePlError","rethrowMeaningfulError"],"mappings":";;;;;AA+CA,SAAS,qBAAqB,CAC5B,IAAU,EACV,mBAA4B,EAC5B,OAE2D,EAC3D,MAA0B,EAAA;IAE1B,OAAO,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,EAAwB;AAC7E;AAEA,SAAS,aAAa,CAAC,MAAc,EAAA;AACnC,IAAA,OAAO,MAAM,CAAC,IAAI,KAAKA,0BAAmB;AAC5C;AAEM,MAAO,YAAa,SAAQ,KAAK,CAAA;AAET,IAAA,aAAA;IAD5B,IAAI,GAAG,cAAc;AACrB,IAAA,WAAA,CAA4B,aAA0B,EAAA;QACpD,KAAK,CAAC,+CAA+C,CAAC;QAD5B,IAAA,CAAA,aAAa,GAAb,aAAa;IAEzC;AACD;MAEY,eAAe,CAAA;;AAET,IAAA,MAAM;;AAGN,IAAA,eAAe,GAAG,IAAI,eAAe,EAAE;AAExD;AACuC;IAC/B,iBAAiB,GAAG,CAAC;;AAGZ,IAAA,oBAAoB,GAAG,IAAI,MAAM,EAAsB;AAExE;;AAEoG;IAC5F,sBAAsB,GAAG,EAAE;AAEnC;AAC+B;IACvB,MAAM,GAAG,KAAK;;IAEd,SAAS,GAAG,KAAK;;AAGjB,IAAA,YAAY;;AAGH,IAAA,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE;AAE1B,IAAA,uBAAuB;AAExC,IAAA,WAAA,CAAY,aAAqD,EAAA;QAC/D,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;;AAGxD,QAAA,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,sBAAsB,EAAE;IAC9D;IAEQ,0BAA0B,CAChC,YAAyB,EACzB,MAA2B,EAAA;QAE3B,IAAI,MAAM,KAAK,SAAS;AAAE,YAAA,MAAM,CAAC,IAAI,YAAY,CAAC,YAAY,CAAC,CAAC;QAChE,IAAI,IAAI,CAAC,YAAY;AAAE,YAAA,OAAO,YAAY;AAC1C,QAAA,IAAI,CAAC,YAAY,GAAG,YAAY;AAChC,QAAA,OAAO,YAAY;IACrB;AAEQ,IAAA,MAAM,sBAAsB,GAAA;AAClC;AAC0C;AAC1C,QAAA,IAAI,UAAU,GAAG,EAAE;;;QAInB,IAAI,cAAc,GAAmC,SAAS;QAC9D,IAAI,kBAAkB,GAAwC,SAAS;AACvE,QAAA,IAAI;YACF,WAAW,MAAM,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;AACjD,gBAAA,IAAI,cAAc,KAAK,SAAS,EAAE;AAChC,oBAAA,cAAc,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE;AAElD,oBAAA,IAAI,cAAc,KAAK,SAAS,EAAE;AAChC,wBAAA,IAAI,CAAC,0BAA0B,CAAC,MAAK;AACnC,4BAAA,MAAM,IAAI,KAAK,CAAC,CAAA,uBAAA,CAAyB,CAAC;AAC5C,wBAAA,CAAC,CAAC;wBACF;oBACF;;oBAGA,IAAI,cAAc,CAAC,mBAAmB;wBAAE,kBAAkB,GAAG,EAAE;AAE/D,oBAAA,UAAU,EAAE;gBACd;AAEA,gBAAA,IAAI,OAAO,CAAC,SAAS,KAAK,UAAU,EAAE;oBACpC,MAAM,YAAY,GAAG,CAAA,uBAAA,EAA0B,OAAO,CAAC,SAAS,CAAA,KAAA,EAAQ,UAAU,CAAA,CAAE;AACpF,oBAAA,IAAI,CAAC,0BAA0B,CAAC,MAAK;AACnC,wBAAA,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC;AAC/B,oBAAA,CAAC,CAAC;oBACF;gBACF;AAEA,gBAAA,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE;AAC/B,oBAAA,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK;AAE5B,oBAAA,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE;AACzB,wBAAA,cAAc,CAAC,MAAM,CACnB,IAAI,YAAY,CAAC,MAAK;AACpB,4BAAA,MAAM,IAAIC,yBAAkB,CAAC,MAAM,CAAC;wBACtC,CAAC,CAAC,CACH;wBACD,cAAc,GAAG,SAAS;AAE1B,wBAAA,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,EAAE;AACtE,4BAAA,IAAI,CAAC,0BAA0B,CAAC,MAAK;AACnC,gCAAA,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC;AACjD,4BAAA,CAAC,CAAC;4BACF;wBACF;;wBAGA;oBACF;yBAAO;AACL,wBAAA,IAAI,CAAC,0BAA0B,CAAC,MAAK;AACnC,4BAAA,MAAM,IAAIC,2BAAoB,CAAC,MAAM,CAAC;AACxC,wBAAA,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC;wBACzB,cAAc,GAAG,SAAS;;wBAG1B;oBACF;gBACF;gBAEA,IACE,cAAc,CAAC,IAAI,KAAK,OAAO,CAAC,QAAQ,CAAC;AACtC,uBAAA,OAAO,EAAE,YAAY,EAAE,OAAO,KAAK,IAAI,EAC1C;AACA,oBAAA,MAAM,YAAY,GAAG,CAAA,qCAAA,EAAwC,cAAc,CAAC,IAAI,CAAA,KAAA,EAAQ,OAAO,CAAC,QAAQ,CAAC,SAAS,EAAE;AAEpH,oBAAA,IAAI,CAAC,0BAA0B,CAAC,MAAK;AACnC,wBAAA,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC;AAC/B,oBAAA,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC;oBACzB,cAAc,GAAG,SAAS;oBAE1B;gBACF;AAEA,gBAAA,IAAI,cAAc,CAAC,mBAAmB,MAAM,OAAO,CAAC,YAAY,KAAK,SAAS,CAAC,EAAE;AAC/E,oBAAA,MAAM,YAAY,GAAG,CAAA,0BAAA,EAA6B,cAAc,CAAC,mBAAmB,CAAA,KAAA,EAAQ,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE;AAEhI,oBAAA,IAAI,CAAC,0BAA0B,CAAC,MAAK;AACnC,wBAAA,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC;AAC/B,oBAAA,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC;oBACzB,cAAc,GAAG,SAAS;oBAE1B;gBACF;;AAIA,gBAAA,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE;AACtC,oBAAA,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,EAAE;AACjC,wBAAA,IAAI,OAAO,CAAC,YAAY,CAAC,EAAE,KAAK,kBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE;AAC9D,4BAAA,MAAM,YAAY,GAAG,CAAA,uBAAA,EAA0B,OAAO,CAAC,YAAY,CAAC,EAAE,CAAA,KAAA,EAAQ,kBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE;AAE9G,4BAAA,IAAI,CAAC,0BAA0B,CAAC,MAAK;AACnC,gCAAA,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC;AAC/B,4BAAA,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC;4BACzB,cAAc,GAAG,SAAS;4BAE1B;wBACF;AAEA,wBAAA,kBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;oBAC5C;AAEA,oBAAA,IAAI,OAAO,CAAC,YAAY,CAAC,MAAM,EAAE;AAC9B,wBAAA,cAA0C,CAAC,OAAO,CAAC,kBAAmB,CAAC;wBACxE,kBAAkB,GAAG,SAAS;wBAC9B,cAAc,GAAG,SAAS;oBAC5B;gBACF;qBAAO;AACJ,oBAAA,cAA2C,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;oBACtE,cAAc,GAAG,SAAS;gBAC5B;YACF;QACF;QAAE,OAAO,CAAM,EAAE;AACf,YAAA,OAAO,IAAI,CAAC,0BAA0B,CAAC,MAAK;AAC1C,gBAAAC,6BAAsB,CAAC,CAAC,EAAE,IAAI,CAAC;AACjC,YAAA,CAAC,EAAE,cAAc,EAAE,MAAM,CAAC;QAC5B;gBAAU;AACR,YAAA,MAAM,IAAI,CAAC,KAAK,EAAE;QACpB;AACA,QAAA,OAAO,IAAI;IACb;;AAGQ,IAAA,MAAM,KAAK,GAAA;QACjB,IAAI,IAAI,CAAC,MAAM;YAAE;AAEjB,QAAA,IAAI,CAAC,MAAM,GAAG,IAAI;;QAIlB,OAAO,IAAI,EAAE;YACX,MAAM,OAAO,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE;AACjD,YAAA,IAAI,CAAC,OAAO;gBAAE;YACd,IAAI,IAAI,CAAC,YAAY;gBAAE,OAAO,CAAC,MAAM,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;;gBACrE,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC;QAC5C;;QAGA,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE;IACvC;;AAGO,IAAA,KAAK,CAAC,KAAa,EAAA;AACxB,QAAA,IAAI,CAAC,0BAA0B,CAAC,MAAK;YACnC,MAAM,IAAI,KAAK,CAAC,CAAA,mBAAA,CAAqB,EAAE,EAAE,KAAK,EAAE,CAAC;AACnD,QAAA,CAAC,CAAC;AACF,QAAA,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC;IACnC;;AAGO,IAAA,MAAM,KAAK,GAAA;;;;;AAMhB,QAAA,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,uBAAuB;QAC3D,IAAI,gBAAgB,KAAK,IAAI;AAAE,YAAA,gBAAgB,EAAE;IACnD;;AAWO,IAAA,MAAM,IAAI,CACf,CAAwC,EACxC,mBAA4B,EAAA;QAE5B,IAAI,IAAI,CAAC,YAAY;AAAE,YAAA,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEjF,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;;QAG/E,MAAM,MAAM,GAAG,IAAI,OAAO,CAAyC,CAAC,OAAO,EAAE,MAAM,KAAI;AACrF,YAAA,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAC5B,qBAAqB,CAAC,CAAC,CAAC,SAAS,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,CAAC,CACzE;AACH,QAAA,CAAC,CAAC;;;AAIF,QAAA,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;AAC9B,YAAA,SAAS,EAAE,IAAI,CAAC,iBAAiB,EAAE;AACnC,YAAA,OAAO,EAAE,CAAC;AACX,SAAA,CAAC;AAEF,QAAA,IAAI;YACF,OAAO,MAAM,MAAM;QACrB;QAAE,OAAO,CAAM,EAAE;YACf,IAAI,CAAC,YAAY,YAAY;gBAAE,CAAC,CAAC,aAAa,EAAE;YAChD,MAAM,IAAI,KAAK,CAAC,kCAAkC,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;QACnE;IACF;IAEQ,UAAU,GAAG,KAAK;;AAGnB,IAAA,MAAM,QAAQ,GAAA;QACnB,IAAI,IAAI,CAAC,UAAU;YAAE;AACrB,QAAA,IAAI,CAAC,UAAU,GAAG,IAAI;QACtB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE;IACvC;AACD;;;;;"}

package/dist/core/ll_transaction.d.ts

@@ -1,5 +1,5 @@
-import { TxAPI_ClientMessage, TxAPI_ServerMessage } from '../proto/github.com/milaboratory/pl/plapi/plapiproto/api';
-import { DuplexStreamingCall } from '@protobuf-ts/runtime-rpc';
+import type { TxAPI_ClientMessage, TxAPI_ServerMessage } from '../proto/github.com/milaboratory/pl/plapi/plapiproto/api';
+import type { DuplexStreamingCall } from '@protobuf-ts/runtime-rpc';
 export type ClientMessageRequest = TxAPI_ClientMessage['request'];
 export type ServerMessageResponse = TxAPI_ServerMessage['response'];
 type TxStream = DuplexStreamingCall<TxAPI_ClientMessage, TxAPI_ServerMessage>;