@google-cloud/pubsub 3.1.0 → 3.2.0

package/build/protos/protos.json

@@ -2064,6 +2064,10 @@
                 "syntax": {
                   "type": "string",
                   "id": 12
+                },
+                "edition": {
+                  "type": "string",
+                  "id": 13
                 }
               }
             },
@@ -2891,6 +2895,19 @@
                     "end": {
                       "type": "int32",
                       "id": 4
+                    },
+                    "semantic": {
+                      "type": "Semantic",
+                      "id": 5
+                    }
+                  },
+                  "nested": {
+                    "Semantic": {
+                      "values": {
+                        "NONE": 0,
+                        "SET": 1,
+                        "ALIAS": 2
+                      }
                     }
                   }
                 }

package/build/src/ack-metadata.d.ts

@@ -0,0 +1,29 @@
+import { GoogleError, Status } from 'google-gax';
+import { AckResponse } from './subscriber';
+/**
+ * Contains information about ack responses that may be used to build
+ * responses to user ack calls.
+ *
+ * @private
+ */
+export interface AckErrorInfo {
+    transient: boolean;
+    response?: AckResponse;
+    rawErrorCode?: string;
+    grpcErrorCode?: Status;
+}
+export declare type AckErrorCodes = Map<string, AckErrorInfo>;
+/**
+ * Processes the raw RPC information when sending a batch of acks
+ * to the Pub/Sub service.
+ *
+ * @private
+ */
+export declare function processAckErrorInfo(rpcError: GoogleError): AckErrorCodes;
+/**
+ * For a completely failed RPC call, this will find the appropriate
+ * error information to return to an ack() caller.
+ *
+ * @private
+ */
+export declare function processAckRpcError(grpcCode: Status): AckErrorInfo;

package/build/src/ack-metadata.js

@@ -0,0 +1,93 @@
+"use strict";
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processAckRpcError = exports.processAckErrorInfo = void 0;
+const google_gax_1 = require("google-gax");
+const subscriber_1 = require("./subscriber");
+const permanentFailureInvalidAckId = 'PERMANENT_FAILURE_INVALID_ACK_ID';
+const transientFailurePrefix = 'TRANSIENT_';
+// If we get these as RPC errors, they will trigger a retry.
+const exactlyOnceDeliveryTemporaryRetryErrors = [
+    google_gax_1.Status.DEADLINE_EXCEEDED,
+    google_gax_1.Status.RESOURCE_EXHAUSTED,
+    google_gax_1.Status.ABORTED,
+    google_gax_1.Status.INTERNAL,
+    google_gax_1.Status.UNAVAILABLE,
+];
+/**
+ * Processes the raw RPC information when sending a batch of acks
+ * to the Pub/Sub service.
+ *
+ * @private
+ */
+function processAckErrorInfo(rpcError) {
+    const ret = new Map();
+    if (!rpcError.errorInfoMetadata) {
+        return ret;
+    }
+    // The typing for errorInfoMetadata is currently incorrect.
+    const metadata = rpcError.errorInfoMetadata;
+    for (const ackId of Object.getOwnPropertyNames(metadata)) {
+        const code = metadata[ackId];
+        if (code === permanentFailureInvalidAckId) {
+            ret.set(ackId, {
+                transient: false,
+                response: subscriber_1.AckResponses.Invalid,
+                rawErrorCode: code,
+            });
+        }
+        else if (code.startsWith(transientFailurePrefix)) {
+            ret.set(ackId, {
+                transient: true,
+                rawErrorCode: code,
+            });
+        }
+        else {
+            ret.set(ackId, {
+                transient: false,
+                response: subscriber_1.AckResponses.Other,
+                rawErrorCode: code,
+            });
+        }
+    }
+    return ret;
+}
+exports.processAckErrorInfo = processAckErrorInfo;
+/**
+ * For a completely failed RPC call, this will find the appropriate
+ * error information to return to an ack() caller.
+ *
+ * @private
+ */
+function processAckRpcError(grpcCode) {
+    const ackError = {
+        transient: exactlyOnceDeliveryTemporaryRetryErrors.includes(grpcCode),
+        grpcErrorCode: grpcCode,
+    };
+    switch (grpcCode) {
+        case google_gax_1.Status.PERMISSION_DENIED:
+            ackError.response = subscriber_1.AckResponses.PermissionDenied;
+            break;
+        case google_gax_1.Status.FAILED_PRECONDITION:
+            ackError.response = subscriber_1.AckResponses.FailedPrecondition;
+            break;
+        default:
+            ackError.response = subscriber_1.AckResponses.Other;
+            break;
+    }
+    return ackError;
+}
+exports.processAckRpcError = processAckRpcError;
+//# sourceMappingURL=ack-metadata.js.map

package/build/src/ack-metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ack-metadata.js","sourceRoot":"","sources":["../../src/ack-metadata.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;AAEjC,2CAA+C;AAC/C,6CAAuD;AAEvD,MAAM,4BAA4B,GAAG,kCAAkC,CAAC;AACxE,MAAM,sBAAsB,GAAG,YAAY,CAAC;AAE5C,4DAA4D;AAC5D,MAAM,uCAAuC,GAAG;IAC9C,mBAAM,CAAC,iBAAiB;IACxB,mBAAM,CAAC,kBAAkB;IACzB,mBAAM,CAAC,OAAO;IACd,mBAAM,CAAC,QAAQ;IACf,mBAAM,CAAC,WAAW;CACnB,CAAC;AAwBF;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,QAAqB;IACvD,MAAM,GAAG,GAAG,IAAI,GAAG,EAAwB,CAAC;IAE5C,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE;QAC/B,OAAO,GAAG,CAAC;KACZ;IAED,2DAA2D;IAC3D,MAAM,QAAQ,GAAG,QAAQ,CAAC,iBAAmC,CAAC;IAE9D,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,EAAE;QACxD,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;QAE7B,IAAI,IAAI,KAAK,4BAA4B,EAAE;YACzC,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE;gBACb,SAAS,EAAE,KAAK;gBAChB,QAAQ,EAAE,yBAAY,CAAC,OAAO;gBAC9B,YAAY,EAAE,IAAI;aACnB,CAAC,CAAC;SACJ;aAAM,IAAI,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE;YAClD,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE;gBACb,SAAS,EAAE,IAAI;gBACf,YAAY,EAAE,IAAI;aACnB,CAAC,CAAC;SACJ;aAAM;YACL,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE;gBACb,SAAS,EAAE,KAAK;gBAChB,QAAQ,EAAE,yBAAY,CAAC,KAAK;gBAC5B,YAAY,EAAE,IAAI;aACnB,CAAC,CAAC;SACJ;KACF;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAlCD,kDAkCC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,QAAgB;IACjD,MAAM,QAAQ,GAAiB;QAC7B,SAAS,EAAE,uCAAuC,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACrE,aAAa,EAAE,QAAQ;KACxB,CAAC;IACF,QAAQ,QAAQ,EAAE;QAChB,KAAK,mBAAM,CAAC,iBAAiB;YAC3B,QAAQ,CAAC,QAAQ,GAAG,yBAAY,CAAC,gBAAgB,CAAC;YAClD,MAAM;QACR,KAAK,mBAAM,CAAC,mBAAmB;YAC7B,QAAQ,CAAC,QAAQ,GAAG,yBAAY,CAAC,kBAAkB,CAAC;YACpD,MAAM;QACR;YACE,QAAQ,CAAC,QAAQ,GAAG,yBAAY,CAAC,KAAK,CAAC;YACvC,MAAM;KACT;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAlBD,gDAkBC"}

package/build/src/exponential-retry.d.ts

@@ -0,0 +1,66 @@
+import { Duration } from './temporal';
+/**
+ * This interface specifies what we'll add to retried items in order
+ * to track them through the exponential backoff.
+ *
+ * @private
+ */
+export interface RetriedItem<T> {
+    retryInfo?: RetryInfo<T>;
+}
+/**
+ * These items will go inside the added retry metadata.
+ *
+ * @private
+ */
+export interface RetryInfo<T> {
+    firstRetry: number;
+    nextRetry: number;
+    multiplier: number;
+    callback: RetryCallback<T>;
+}
+/**
+ * Users of this class will pass in a callback in this form when
+ * an item is ready to be retried. The item must be placed
+ * back on the queue if it needs to be retried again.
+ *
+ * @private
+ */
+export interface RetryCallback<T> {
+    (item: T, totalTime: Duration): void;
+}
+/**
+ * Provides a helper that will manage your retries using the "truncated
+ * exponential backoff" strategy.
+ *
+ * Most of the pieces of this library are doing retries via gax, but for
+ * exactly-once delivery, we have some things where gRPC failures won't
+ * take care of it.
+ *
+ * @private
+ */
+export declare class ExponentialRetry<T> {
+    private _items;
+    private _backoffMs;
+    private _maxBackoffMs;
+    private _timer?;
+    constructor(backoff: Duration, maxBackoff: Duration);
+    /**
+     * Shut down all operations/timers/etc and return a list of
+     * items that were still pending retry.
+     *
+     * @private
+     */
+    close(): T[];
+    /**
+     * Place an item on the retry queue. It's important that it's the
+     * same exact item that was already on the queue, if it's being retried
+     * more than once.
+     *
+     * @private
+     */
+    retryLater(item: T, callback: RetryCallback<T>): void;
+    private randomizeDelta;
+    private doRetries;
+    private scheduleRetry;
+}

package/build/src/exponential-retry.js

@@ -0,0 +1,138 @@
+"use strict";
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExponentialRetry = void 0;
+const heap_js_1 = require("heap-js");
+const temporal_1 = require("./temporal");
+// Compare function for Heap so we can use it as a priority queue.
+function comparator(a, b) {
+    return a.retryInfo.nextRetry - b.retryInfo.nextRetry;
+}
+/**
+ * Provides a helper that will manage your retries using the "truncated
+ * exponential backoff" strategy.
+ *
+ * Most of the pieces of this library are doing retries via gax, but for
+ * exactly-once delivery, we have some things where gRPC failures won't
+ * take care of it.
+ *
+ * @private
+ */
+class ExponentialRetry {
+    constructor(backoff, maxBackoff) {
+        this._items = new heap_js_1.default((comparator));
+        this._backoffMs = backoff.totalOf('millisecond');
+        this._maxBackoffMs = maxBackoff.totalOf('millisecond');
+    }
+    /**
+     * Shut down all operations/timers/etc and return a list of
+     * items that were still pending retry.
+     *
+     * @private
+     */
+    close() {
+        if (this._timer) {
+            clearTimeout(this._timer);
+        }
+        const leftovers = this._items.toArray();
+        this._items.clear();
+        return leftovers;
+    }
+    /**
+     * Place an item on the retry queue. It's important that it's the
+     * same exact item that was already on the queue, if it's being retried
+     * more than once.
+     *
+     * @private
+     */
+    retryLater(item, callback) {
+        const retried = item;
+        const retryInfo = retried.retryInfo;
+        if (!retryInfo) {
+            // This item's first time through.
+            retried.retryInfo = {
+                firstRetry: Date.now(),
+                nextRetry: Date.now() + this.randomizeDelta(this._backoffMs),
+                multiplier: 1,
+                callback,
+            };
+        }
+        else {
+            // Not the first time - handle backoff.
+            const nextMultiplier = retryInfo.multiplier * 2;
+            let delta = this.randomizeDelta(nextMultiplier * this._backoffMs);
+            if (delta > this._maxBackoffMs) {
+                delta = this.randomizeDelta(this._maxBackoffMs);
+            }
+            else {
+                retryInfo.multiplier = nextMultiplier;
+            }
+            retryInfo.nextRetry = Date.now() + delta;
+        }
+        // Re-sort it into the heap with the correct position.
+        // It's my assumption here that any item that is being retried is
+        // very likely near or at the top.
+        this._items.remove(retried);
+        this._items.push(retried);
+        // Schedule the next retry.
+        this.scheduleRetry();
+    }
+    // Takes a time delta and adds fuzz.
+    randomizeDelta(durationMs) {
+        // The fuzz distance should never exceed one second, but in the
+        // case of smaller things, don't end up with a negative delta.
+        const magnitude = durationMs < 1000 ? durationMs : 1000;
+        const offset = Math.random() * magnitude - magnitude / 2.0;
+        return durationMs + offset;
+    }
+    // Looks through the queue to see if there's anything to handle.
+    doRetries() {
+        const now = Date.now();
+        while (!this._items.isEmpty()) {
+            const next = this._items.peek();
+            // Within 10msec is close enough.
+            if (next.retryInfo.nextRetry - now < 10) {
+                this._items.pop();
+                next.retryInfo.callback(next, temporal_1.Duration.from({ millis: now - next.retryInfo.firstRetry }));
+            }
+            else {
+                break;
+            }
+        }
+        // Is there stuff to retry still?
+        if (!this._items.isEmpty()) {
+            this.scheduleRetry();
+        }
+    }
+    // If there are items to retry, schedule the next timer event.
+    scheduleRetry() {
+        // What's next?
+        const next = this._items.peek();
+        if (next) {
+            let delta = next.retryInfo.nextRetry - Date.now();
+            if (delta < 0) {
+                delta = 0;
+            }
+            if (this._timer) {
+                clearTimeout(this._timer);
+            }
+            this._timer = setTimeout(() => {
+                this.doRetries();
+            }, delta);
+        }
+    }
+}
+exports.ExponentialRetry = ExponentialRetry;
+//# sourceMappingURL=exponential-retry.js.map

package/build/src/exponential-retry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exponential-retry.js","sourceRoot":"","sources":["../../src/exponential-retry.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;AAEjC,qCAA2B;AAC3B,yCAAoC;AA+BpC,kEAAkE;AAClE,SAAS,UAAU,CAAI,CAAiB,EAAE,CAAiB;IACzD,OAAO,CAAC,CAAC,SAAU,CAAC,SAAS,GAAG,CAAC,CAAC,SAAU,CAAC,SAAS,CAAC;AACzD,CAAC;AAaD;;;;;;;;;GASG;AACH,MAAa,gBAAgB;IAM3B,YAAY,OAAiB,EAAE,UAAoB;QAL3C,WAAM,GAAG,IAAI,iBAAI,CAAiB,CAAA,UAAa,CAAA,CAAC,CAAC;QAMvD,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACjD,IAAI,CAAC,aAAa,GAAG,UAAU,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IACzD,CAAC;IAED;;;;;OAKG;IACH,KAAK;QACH,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAC3B;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACxC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QACpB,OAAO,SAAgB,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,IAAO,EAAE,QAA0B;QAC5C,MAAM,OAAO,GAAG,IAAsB,CAAC;QACvC,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QAEpC,IAAI,CAAC,SAAS,EAAE;YACd,kCAAkC;YAClC,OAAO,CAAC,SAAS,GAAG;gBAClB,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE;gBACtB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC;gBAC5D,UAAU,EAAE,CAAC;gBACb,QAAQ;aACT,CAAC;SACH;aAAM;YACL,uCAAuC;YACvC,MAAM,cAAc,GAAG,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC;YAChD,IAAI,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;YAClE,IAAI,KAAK,GAAG,IAAI,CAAC,aAAa,EAAE;gBAC9B,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;aACjD;iBAAM;gBACL,SAAS,CAAC,UAAU,GAAG,cAAc,CAAC;aACvC;YACD,SAAS,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;SAC1C;QAED,sDAAsD;QACtD,iEAAiE;QACjE,kCAAkC;QAClC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE1B,2BAA2B;QAC3B,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAED,oCAAoC;IAC5B,cAAc,CAAC,UAAkB;QACvC,+DAA+D;QAC/D,8DAA8D;QAC9D,MAAM,SAAS,GAAG,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC;QACxD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,SAAS,GAAG,SAAS,GAAG,GAAG,CAAC;QAC3D,OAAO,UAAU,GAAG,MAAM,CAAC;IAC7B,CAAC;IAED,gEAAgE;IACxD,SAAS;QACf,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE;YAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAG,CAAC;YAEjC,iCAAiC;YACjC,IAAI,IAAI,CAAC,SAAU,CAAC,SAAS,GAAG,GAAG,GAAG,EAAE,EAAE;gBACxC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;gBAElB,IAAI,CAAC,SAAU,CAAC,QAAQ,CACtB,IAAoB,EACpB,mBAAQ,CAAC,IAAI,CAAC,EAAC,MAAM,EAAE,GAAG,GAAG,IAAI,CAAC,SAAU,CAAC,UAAU,EAAC,CAAC,CAC1D,CAAC;aACH;iBAAM;gBACL,MAAM;aACP;SACF;QAED,iCAAiC;QACjC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE;YAC1B,IAAI,CAAC,aAAa,EAAE,CAAC;SACtB;IACH,CAAC;IAED,8DAA8D;IACtD,aAAa;QACnB,eAAe;QACf,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAChC,IAAI,IAAI,EAAE;YACR,IAAI,KAAK,GAAG,IAAI,CAAC,SAAU,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACnD,IAAI,KAAK,GAAG,CAAC,EAAE;gBACb,KAAK,GAAG,CAAC,CAAC;aACX;YAED,IAAI,IAAI,CAAC,MAAM,EAAE;gBACf,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aAC3B;YACD,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC5B,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,CAAC,EAAE,KAAK,CAAC,CAAC;SACX;IACH,CAAC;CACF;AAxHD,4CAwHC"}

package/build/src/index.d.ts

@@ -92,7 +92,7 @@ export { PageOptions, GetSnapshotsCallback, GetSnapshotsResponse, GetSubscriptio
 export { CreateSnapshotCallback, CreateSnapshotResponse, SeekCallback, SeekResponse, Snapshot, } from './snapshot';
 export { Message, SubscriberOptions } from './subscriber';
 export { Schema, CreateSchemaResponse, ISchema, SchemaType, SchemaTypes, ICreateSchemaRequest, SchemaEncoding, SchemaView, SchemaViews, Encodings, SchemaMessageMetadata, } from './schema';
-export { PushConfig, SubscriptionMetadata, SubscriptionOptions, SubscriptionCloseCallback, CreateSubscriptionOptions, CreateSubscriptionCallback, CreateSubscriptionResponse, GetSubscriptionOptions, GetSubscriptionCallback, GetSubscriptionResponse, GetSubscriptionMetadataCallback, GetSubscriptionMetadataResponse, SetSubscriptionMetadataCallback, SetSubscriptionMetadataResponse, Subscription, } from './subscription';
+export { PushConfig, SubscriptionMetadata, SubscriptionOptions, SubscriptionCloseCallback, CreateSubscriptionOptions, CreateSubscriptionCallback, CreateSubscriptionResponse, GetSubscriptionOptions, GetSubscriptionCallback, GetSubscriptionResponse, GetSubscriptionMetadataCallback, GetSubscriptionMetadataResponse, SetSubscriptionMetadataCallback, SetSubscriptionMetadataResponse, Subscription, AckError, AckResponse, AckResponses, } from './subscription';
 export { CreateTopicCallback, CreateTopicResponse, GetTopicCallback, GetTopicResponse, GetTopicOptions, GetTopicMetadataCallback, GetTopicMetadataResponse, GetTopicSubscriptionsCallback, GetTopicSubscriptionsResponse, SetTopicMetadataCallback, SetTopicMetadataResponse, Topic, TopicMetadata, } from './topic';
 export { Duration, TotalOfUnit, DurationLike } from './temporal';
 import * as protos from '../protos/protos';

package/build/src/index.js

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.protos = exports.Duration = exports.Topic = exports.Subscription = exports.Encodings = exports.SchemaViews = exports.SchemaTypes = exports.Schema = exports.Message = exports.Snapshot = exports.PubSub = exports.PublishError = exports.IAM = exports.v1 = void 0;
+exports.protos = exports.Duration = exports.Topic = exports.AckResponses = exports.AckError = exports.Subscription = exports.Encodings = exports.SchemaViews = exports.SchemaTypes = exports.Schema = exports.Message = exports.Snapshot = exports.PubSub = exports.PublishError = exports.IAM = exports.v1 = void 0;
 /**
  * @namespace google.pubsub.v1
  */
@@ -102,6 +102,8 @@ Object.defineProperty(exports, "SchemaViews", { enumerable: true, get: function
 Object.defineProperty(exports, "Encodings", { enumerable: true, get: function () { return schema_1.Encodings; } });
 var subscription_1 = require("./subscription");
 Object.defineProperty(exports, "Subscription", { enumerable: true, get: function () { return subscription_1.Subscription; } });
+Object.defineProperty(exports, "AckError", { enumerable: true, get: function () { return subscription_1.AckError; } });
+Object.defineProperty(exports, "AckResponses", { enumerable: true, get: function () { return subscription_1.AckResponses; } });
 var topic_1 = require("./topic");
 Object.defineProperty(exports, "Topic", { enumerable: true, get: function () { return topic_1.Topic; } });
 var temporal_1 = require("./temporal");

package/build/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;GAEG;AACH;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;;;;;;;GAWG;AACH,2BAA2B;AACnB,gBAAE;AAEV,6BAUe;AADb,0FAAA,GAAG,OAAA;AAIL,2DAAuD;AAA/C,6GAAA,YAAY,OAAA;AAEpB,mCAckB;AAFhB,gGAAA,MAAM,OAAA;AAGR,uCAMoB;AADlB,oGAAA,QAAQ,OAAA;AAEV,2CAAwD;AAAhD,qGAAA,OAAO,OAAA;AACf,mCAYkB;AAXhB,gGAAA,MAAM,OAAA;AAIN,qGAAA,WAAW,OAAA;AAIX,qGAAA,WAAW,OAAA;AACX,mGAAA,SAAS,OAAA;AAGX,+CAgBwB;AADtB,4GAAA,YAAY,OAAA;AAEd,iCAciB;AAFf,8FAAA,KAAK,OAAA;AAGP,uCAA+D;AAAvD,oGAAA,QAAQ,OAAA;AAEhB,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE;IAC1B,OAAO,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC;IACxC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACxB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;CAC/C;AACD,2CAA2C;AACnC,wBAAM"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;GAEG;AACH;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;;;;;;;GAWG;AACH,2BAA2B;AACnB,gBAAE;AAEV,6BAUe;AADb,0FAAA,GAAG,OAAA;AAIL,2DAAuD;AAA/C,6GAAA,YAAY,OAAA;AAEpB,mCAckB;AAFhB,gGAAA,MAAM,OAAA;AAGR,uCAMoB;AADlB,oGAAA,QAAQ,OAAA;AAEV,2CAAwD;AAAhD,qGAAA,OAAO,OAAA;AACf,mCAYkB;AAXhB,gGAAA,MAAM,OAAA;AAIN,qGAAA,WAAW,OAAA;AAIX,qGAAA,WAAW,OAAA;AACX,mGAAA,SAAS,OAAA;AAGX,+CAmBwB;AAJtB,4GAAA,YAAY,OAAA;AACZ,wGAAA,QAAQ,OAAA;AAER,4GAAA,YAAY,OAAA;AAEd,iCAciB;AAFf,8FAAA,KAAK,OAAA;AAGP,uCAA+D;AAAvD,oGAAA,QAAQ,OAAA;AAEhB,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE;IAC1B,OAAO,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC;IACxC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACxB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;CAC/C;AACD,2CAA2C;AACnC,wBAAM"}

package/build/src/message-queues.d.ts

@@ -14,10 +14,23 @@
  * limitations under the License.
  */
 /// <reference types="node" />
-import { CallOptions, grpc } from 'google-gax';
+import { CallOptions, GoogleError, grpc } from 'google-gax';
 import defer = require('p-defer');
-import { Message, Subscriber } from './subscriber';
-declare type QueuedMessages = Array<[string, number?]>;
+import { ExponentialRetry } from './exponential-retry';
+import { AckResponse, Message, Subscriber } from './subscriber';
+/**
+ * @private
+ */
+export interface QueuedMessage {
+    ackId: string;
+    deadline?: number;
+    responsePromise?: defer.DeferredPromise<void>;
+    retryCount: number;
+}
+/**
+ * @private
+ */
+export declare type QueuedMessages = Array<QueuedMessage>;
 export interface BatchOptions {
     callOptions?: CallOptions;
     maxMessages?: number;
@@ -26,17 +39,19 @@ export interface BatchOptions {
 /**
  * Error class used to signal a batch failure.
  *
+ * Now that we have exactly-once delivery subscriptions, we'll only
+ * throw one of these if there was an unknown error.
+ *
  * @class
  *
  * @param {string} message The error message.
- * @param {ServiceError} err The grpc service error.
+ * @param {GoogleError} err The grpc error.
  */
-export declare class BatchError extends Error implements grpc.ServiceError {
+export declare class BatchError extends Error {
     ackIds: string[];
     code: grpc.status;
     details: string;
-    metadata: grpc.Metadata;
-    constructor(err: grpc.ServiceError, ackIds: string[], rpc: string);
+    constructor(err: GoogleError, ackIds: string[], rpc: string);
 }
 /**
  * @typedef {object} BatchOptions
@@ -60,14 +75,28 @@ export declare class BatchError extends Error implements grpc.ServiceError {
 export declare abstract class MessageQueue {
     numPendingRequests: number;
     numInFlightRequests: number;
+    numInRetryRequests: number;
     protected _onFlush?: defer.DeferredPromise<void>;
     protected _onDrain?: defer.DeferredPromise<void>;
     protected _options: BatchOptions;
     protected _requests: QueuedMessages;
     protected _subscriber: Subscriber;
     protected _timer?: NodeJS.Timer;
-    protected abstract _sendBatch(batch: QueuedMessages): Promise<void>;
+    protected _retrier: ExponentialRetry<QueuedMessage>;
+    protected _closed: boolean;
+    protected abstract _sendBatch(batch: QueuedMessages): Promise<QueuedMessages>;
     constructor(sub: Subscriber, options?: BatchOptions);
+    /**
+     * Shuts down this message queue gracefully. Any acks/modAcks pending in
+     * the queue or waiting for retry will be removed. If exactly-once delivery
+     * is enabled on the subscription, we'll send permanent failures to
+     * anyone waiting on completions; otherwise we'll send successes.
+     *
+     * If a flush is desired first, do it before calling close().
+     *
+     * @private
+     */
+    close(): void;
     /**
      * Gets the default buffer time in ms.
      *
@@ -82,7 +111,20 @@ export declare abstract class MessageQueue {
      * @param {number} [deadline] The deadline.
      * @private
      */
-    add({ ackId }: Message, deadline?: number): void;
+    add({ ackId }: Message, deadline?: number): Promise<void>;
+    /**
+     * Retry handler for acks/modacks that have transient failures. Unless
+     * it's passed the final deadline, we will just re-queue it for sending.
+     *
+     * @private
+     */
+    private handleRetry;
+    /**
+     * This hook lets a subclass tell the retry handler to go ahead and fail early.
+     *
+     * @private
+     */
+    protected shouldFailEarly(message: QueuedMessage): boolean;
     /**
      * Sends a batch of messages.
      * @private
@@ -106,6 +148,37 @@ export declare abstract class MessageQueue {
      * @private
      */
     setOptions(options: BatchOptions): void;
+    /**
+     * Succeed a whole batch of Acks/Modacks for an OK RPC response.
+     *
+     * @private
+     */
+    handleAckSuccesses(batch: QueuedMessages): void;
+    /**
+     * If we get an RPC failure of any kind, this will take care of deciding
+     * what to do for each related ack/modAck. Successful ones will have their
+     * Promises resolved, permanent errors will have their Promises rejected,
+     * and transients will be returned for retry.
+     *
+     * Note that this is only used for subscriptions with exactly-once
+     * delivery enabled, so _sendBatch() in the classes below take care of
+     * resolving errors to success; they don't make it here.
+     *
+     * @private
+     */
+    handleAckFailures(operation: string, batch: QueuedMessages, rpcError: GoogleError): {
+        toError: Map<AckResponse, QueuedMessages>;
+        toRetry: QueuedMessages;
+    };
+    /**
+     * Since we handle our own retries for ack/modAck calls when exactly-once
+     * delivery is enabled on a subscription, we conditionally need to disable
+     * the gax retries. This returns an appropriate CallOptions for the
+     * subclasses to pass down.
+     *
+     * @private
+     */
+    protected getCallOptions(): CallOptions | undefined;
 }
 /**
  * Queues up Acknowledge (ack) requests.
@@ -122,7 +195,7 @@ export declare class AckQueue extends MessageQueue {
      * @param {Array.<Array.<string|number>>} batch Array of ackIds and deadlines.
      * @return {Promise}
      */
-    protected _sendBatch(batch: QueuedMessages): Promise<void>;
+    protected _sendBatch(batch: QueuedMessages): Promise<QueuedMessages>;
 }
 /**
  * Queues up ModifyAckDeadline requests and sends them out in batches.
@@ -140,6 +213,6 @@ export declare class ModAckQueue extends MessageQueue {
      * @param {Array.<Array.<string|number>>} batch Array of ackIds and deadlines.
      * @return {Promise}
      */
-    protected _sendBatch(batch: QueuedMessages): Promise<void>;
+    protected _sendBatch(batch: QueuedMessages): Promise<QueuedMessages>;
+    protected shouldFailEarly(message: QueuedMessage): boolean;
 }
-export {};