@google-cloud/pubsub 2.17.0 → 2.18.3

package/build/src/lease-manager.d.ts

@@ -19,8 +19,10 @@ import { Message, Subscriber } from './subscriber';
 export interface FlowControlOptions {
     allowExcessMessages?: boolean;
     maxBytes?: number;
-    maxExtension?: number;
     maxMessages?: number;
+    maxExtensionMinutes?: number;
+    /** @deprecated Use maxExtensionMinutes. */
+    maxExtension?: number;
 }
 /**
  * @typedef {object} FlowControlOptions
@@ -33,7 +35,7 @@ export interface FlowControlOptions {
  * @property {number} [maxBytes=104857600] The desired amount of memory to
  *     allow message data to consume. (Default: 100MB) It's possible that this
  *     value will be exceeded, since messages are received in batches.
- * @property {number} [maxExtension=60] The maximum duration (in seconds)
+ * @property {number} [maxExtensionMinutes=60] The maximum duration (in minutes)
  *      to extend the message deadline before redelivering.
  * @property {number} [maxMessages=1000] The desired number of messages to allow
  *     in memory before pausing the message stream. Unless allowExcessMessages
@@ -104,6 +106,9 @@ export declare class LeaseManager extends EventEmitter {
      * Sets options for the LeaseManager.
      *
      * @param {FlowControlOptions} [options] The options.
+     *
+     * @throws {RangeError} If both maxExtension and maxExtensionMinutes are set.
+     *
      * @private
      */
     setOptions(options: FlowControlOptions): void;

package/build/src/lease-manager.js

@@ -29,7 +29,7 @@ const default_options_1 = require("./default-options");
  * @property {number} [maxBytes=104857600] The desired amount of memory to
  *     allow message data to consume. (Default: 100MB) It's possible that this
  *     value will be exceeded, since messages are received in batches.
- * @property {number} [maxExtension=60] The maximum duration (in seconds)
+ * @property {number} [maxExtensionMinutes=60] The maximum duration (in minutes)
  *      to extend the message deadline before redelivering.
  * @property {number} [maxMessages=1000] The desired number of messages to allow
  *     in memory before pausing the message stream. Unless allowExcessMessages
@@ -155,13 +155,27 @@ class LeaseManager extends events_1.EventEmitter {
      * Sets options for the LeaseManager.
      *
      * @param {FlowControlOptions} [options] The options.
+     *
+     * @throws {RangeError} If both maxExtension and maxExtensionMinutes are set.
+     *
      * @private
      */
     setOptions(options) {
+        // Convert the old deprecated maxExtension to avoid breaking clients,
+        // but allow only one.
+        if (options.maxExtension !== undefined &&
+            options.maxExtensionMinutes !== undefined) {
+            throw new RangeError('Only one of "maxExtension" or "maxExtensionMinutes" may be set for subscriber lease management options');
+        }
+        if (options.maxExtension !== undefined &&
+            options.maxExtensionMinutes === undefined) {
+            options.maxExtensionMinutes = options.maxExtension / 60;
+            delete options.maxExtension;
+        }
         const defaults = {
             allowExcessMessages: true,
             maxBytes: default_options_1.defaultOptions.subscription.maxOutstandingBytes,
-            maxExtension: default_options_1.defaultOptions.subscription.maxExtensionMinutes,
+            maxExtensionMinutes: default_options_1.defaultOptions.subscription.maxExtensionMinutes,
             maxMessages: default_options_1.defaultOptions.subscription.maxOutstandingMessages,
         };
         this._options = Object.assign(defaults, options);
@@ -202,8 +216,9 @@ class LeaseManager extends events_1.EventEmitter {
     _extendDeadlines() {
         const deadline = this._subscriber.ackDeadline;
         for (const message of this._messages) {
-            const lifespan = (Date.now() - message.received) / 1000;
-            if (lifespan < this._options.maxExtension) {
+            // Lifespan here is in minutes.
+            const lifespan = (Date.now() - message.received) / (60 * 1000);
+            if (lifespan < this._options.maxExtensionMinutes) {
                 message.modAck(deadline);
             }
             else {

package/build/src/lease-manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"lease-manager.js","sourceRoot":"","sources":["../../src/lease-manager.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,mCAAoC;AAEpC,uDAAiD;AASjD;;;;;;;;;;;;;;;;;;GAkBG;AACH;;;;;;;;;GASG;AACH,MAAa,YAAa,SAAQ,qBAAY;IAQ5C,YAAY,GAAe,EAAE,OAAO,GAAG,EAAE;QACvC,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QACf,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAE,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;QAEvB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IACD;;;OAGG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IACD;;;OAGG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;IAC7B,CAAC;IACD;;;;;;OAMG;IACH,GAAG,CAAC,OAAgB;QAClB,MAAM,EAAC,mBAAmB,EAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAE9B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC;QAE7B,IAAI,mBAAoB,IAAI,CAAC,OAAO,EAAE;YACpC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;SACzB;aAAM;YACL,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC7B;QAED,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YACvB,IAAI,CAAC,kBAAkB,EAAE,CAAC;SAC3B;QAED,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE;YAC7B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACnB;IACH,CAAC;IACD;;;OAGG;IACH,KAAK;QACH,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAE9B,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QAEf,IAAI,OAAO,EAAE;YACX,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;SAC3C;QAED,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC1B,CAAC;IACD;;;;;OAKG;IACH,MAAM;QACJ,MAAM,EAAC,QAAQ,EAAE,WAAW,EAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9C,OAAO,IAAI,CAAC,IAAI,IAAI,WAAY,IAAI,IAAI,CAAC,KAAK,IAAI,QAAS,CAAC;IAC9D,CAAC;IACD;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAgB;QACrB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;YAChC,OAAO;SACR;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAE9B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC;QAE7B,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE;YAC7B,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;SAC3C;aAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC7C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;SAChC;aAAM,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,EAAE;YAC3B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAG,CAAC,CAAC;SACxC;QAED,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,UAAU,EAAE;YACtC,IAAI,CAAC,gBAAgB,EAAE,CAAC;SACzB;IACH,CAAC;IACD;;;;;OAKG;IACH,UAAU,CAAC,OAA2B;QACpC,MAAM,QAAQ,GAAuB;YACnC,mBAAmB,EAAE,IAAI;YACzB,QAAQ,EAAE,gCAAc,CAAC,YAAY,CAAC,mBAAmB;YACzD,YAAY,EAAE,gCAAc,CAAC,YAAY,CAAC,mBAAmB;YAC7D,WAAW,EAAE,gCAAc,CAAC,YAAY,CAAC,sBAAsB;SAChE,CAAC;QAEF,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IACD;;;;OAIG;IACK,gBAAgB;QACtB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QAExB,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC;SACpB;IACH,CAAC;IACD;;;;;;;;;OASG;IACK,SAAS,CAAC,OAAgB;QAChC,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;YAC3B,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;SACnE;IACH,CAAC;IACD;;;;;OAKG;IACK,gBAAgB;QACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;QAE9C,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE;YACpC,MAAM,QAAQ,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;YAExD,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAa,EAAE;gBAC1C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;aAC1B;iBAAM;gBACL,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;aACtB;SACF;QAED,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,IAAI,CAAC,kBAAkB,EAAE,CAAC;SAC3B;IACH,CAAC;IACD;;;;;;;OAOG;IACK,0BAA0B;QAChC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC7B,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;QACrD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC;QAE/C,OAAO,CAAC,QAAQ,GAAG,GAAG,GAAG,OAAO,CAAC,GAAG,MAAM,CAAC;IAC7C,CAAC;IACD;;;;OAIG;IACK,kBAAkB;QACxB,MAAM,OAAO,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AApND,oCAoNC"}
+{"version":3,"file":"lease-manager.js","sourceRoot":"","sources":["../../src/lease-manager.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,mCAAoC;AAEpC,uDAAiD;AAYjD;;;;;;;;;;;;;;;;;;GAkBG;AACH;;;;;;;;;GASG;AACH,MAAa,YAAa,SAAQ,qBAAY;IAQ5C,YAAY,GAAe,EAAE,OAAO,GAAG,EAAE;QACvC,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QACf,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAE,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;QAEvB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IACD;;;OAGG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IACD;;;OAGG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;IAC7B,CAAC;IACD;;;;;;OAMG;IACH,GAAG,CAAC,OAAgB;QAClB,MAAM,EAAC,mBAAmB,EAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAE9B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC;QAE7B,IAAI,mBAAoB,IAAI,CAAC,OAAO,EAAE;YACpC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;SACzB;aAAM;YACL,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC7B;QAED,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YACvB,IAAI,CAAC,kBAAkB,EAAE,CAAC;SAC3B;QAED,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE;YAC7B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACnB;IACH,CAAC;IACD;;;OAGG;IACH,KAAK;QACH,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAE9B,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QAEf,IAAI,OAAO,EAAE;YACX,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;SAC3C;QAED,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC1B,CAAC;IACD;;;;;OAKG;IACH,MAAM;QACJ,MAAM,EAAC,QAAQ,EAAE,WAAW,EAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9C,OAAO,IAAI,CAAC,IAAI,IAAI,WAAY,IAAI,IAAI,CAAC,KAAK,IAAI,QAAS,CAAC;IAC9D,CAAC;IACD;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAgB;QACrB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;YAChC,OAAO;SACR;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAE9B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC;QAE7B,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE;YAC7B,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;SAC3C;aAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC7C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;SAChC;aAAM,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,EAAE;YAC3B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAG,CAAC,CAAC;SACxC;QAED,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,UAAU,EAAE;YACtC,IAAI,CAAC,gBAAgB,EAAE,CAAC;SACzB;IACH,CAAC;IACD;;;;;;;;OAQG;IACH,UAAU,CAAC,OAA2B;QACpC,qEAAqE;QACrE,sBAAsB;QACtB,IACE,OAAO,CAAC,YAAY,KAAK,SAAS;YAClC,OAAO,CAAC,mBAAmB,KAAK,SAAS,EACzC;YACA,MAAM,IAAI,UAAU,CAClB,wGAAwG,CACzG,CAAC;SACH;QACD,IACE,OAAO,CAAC,YAAY,KAAK,SAAS;YAClC,OAAO,CAAC,mBAAmB,KAAK,SAAS,EACzC;YACA,OAAO,CAAC,mBAAmB,GAAG,OAAO,CAAC,YAAY,GAAG,EAAE,CAAC;YACxD,OAAO,OAAO,CAAC,YAAY,CAAC;SAC7B;QAED,MAAM,QAAQ,GAAuB;YACnC,mBAAmB,EAAE,IAAI;YACzB,QAAQ,EAAE,gCAAc,CAAC,YAAY,CAAC,mBAAmB;YACzD,mBAAmB,EAAE,gCAAc,CAAC,YAAY,CAAC,mBAAmB;YACpE,WAAW,EAAE,gCAAc,CAAC,YAAY,CAAC,sBAAsB;SAChE,CAAC;QAEF,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IACD;;;;OAIG;IACK,gBAAgB;QACtB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QAExB,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC;SACpB;IACH,CAAC;IACD;;;;;;;;;OASG;IACK,SAAS,CAAC,OAAgB;QAChC,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;YAC3B,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;SACnE;IACH,CAAC;IACD;;;;;OAKG;IACK,gBAAgB;QACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;QAE9C,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE;YACpC,+BAA+B;YAC/B,MAAM,QAAQ,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;YAE/D,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,mBAAoB,EAAE;gBACjD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;aAC1B;iBAAM;gBACL,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;aACtB;SACF;QAED,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,IAAI,CAAC,kBAAkB,EAAE,CAAC;SAC3B;IACH,CAAC;IACD;;;;;;;OAOG;IACK,0BAA0B;QAChC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC7B,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;QACrD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC;QAE/C,OAAO,CAAC,QAAQ,GAAG,GAAG,GAAG,OAAO,CAAC,GAAG,MAAM,CAAC;IAC7C,CAAC;IACD;;;;OAIG;IACK,kBAAkB;QACxB,MAAM,OAAO,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AA1OD,oCA0OC"}

package/build/src/publisher/flow-control.d.ts

@@ -0,0 +1,90 @@
+/*!
+ * Copyright 2021 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.
+ */
+/**
+ * @typedef FlowControlOptions
+ * @property {number} [maxOutstandingMessages] The maximum number of messages to
+ *     buffer before publisher flow control kicks in.
+ * @property {number} [maxOutstandingBytes] The maximum number of bytes to buffer
+ *     before publisher flow control kicks in.
+ */
+export interface FlowControlOptions {
+    maxOutstandingMessages?: number;
+    maxOutstandingBytes?: number;
+}
+/**
+ * Manages flow control handling for max bytes and messages.
+ *
+ * Do not use this class externally, it may change without warning.
+ * @private
+ *
+ */
+export declare class FlowControl {
+    options: FlowControlOptions;
+    private bytes;
+    private messages;
+    private requests;
+    constructor(options: FlowControlOptions);
+    /**
+     * Update our options after the fact.
+     *
+     * Do not use externally, it may change without warning.
+     * @private
+     */
+    setOptions(options: FlowControlOptions): void;
+    /**
+     * @returns {number} The number of bytes that are queued up.
+     */
+    get currentByteCount(): number;
+    /**
+     * @returns {number} The number of messages that are queued up.
+     */
+    get currentMessageCount(): number;
+    /**
+     * Adds the specified number of bytes or messages to our count. We'll
+     * assume that this is end running around our queueing mechanisms.
+     *
+     * @param {number} bytes The number of bytes to add to the count.
+     * @param {number} messages The number of messages to add to the count.
+     */
+    addToCount(bytes: number, messages: number): void;
+    /**
+     * Attempts to queue the specified number of bytes and messages. If
+     * there are too many things in the publisher flow control queue
+     * already, we will defer and come back to it.
+     *
+     * Do not use externally, it may change without warning.
+     * @private
+     */
+    willSend(bytes: number, messages: number): Promise<void>;
+    /**
+     * Removes the specified number of bytes and messages from our queued
+     * counts, after a deferred request was released. If there is enough
+     * space.
+     *
+     * Do not use externally, it may change without warning.
+     * @private
+     */
+    sent(bytes: number, messages: number): void;
+    private exceeded;
+    /**
+     * Returns true if adding the specified number of bytes or messages
+     * would exceed limits imposed by configuration.
+     *
+     * Do not use externally, it may change without warning.
+     * @private
+     */
+    wouldExceed(bytes: number, messages: number): boolean;
+}

package/build/src/publisher/flow-control.js

@@ -0,0 +1,145 @@
+"use strict";
+/*!
+ * Copyright 2021 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.FlowControl = void 0;
+const defer = require("p-defer");
+/**
+ * Manages flow control handling for max bytes and messages.
+ *
+ * Do not use this class externally, it may change without warning.
+ * @private
+ *
+ */
+class FlowControl {
+    constructor(options) {
+        this.options = {};
+        this.setOptions(options);
+        this.bytes = this.messages = 0;
+        this.requests = [];
+    }
+    /**
+     * Update our options after the fact.
+     *
+     * Do not use externally, it may change without warning.
+     * @private
+     */
+    setOptions(options) {
+        this.options = options;
+        if (this.options.maxOutstandingBytes === 0 ||
+            this.options.maxOutstandingMessages === 0) {
+            // Undefined is okay, but if either is zero, no publishes ever happen.
+            throw new Error('When using publisher flow control, maxOutstandingBytes and maxOutstandingMessages must not be zero');
+        }
+    }
+    /**
+     * @returns {number} The number of bytes that are queued up.
+     */
+    get currentByteCount() {
+        return this.bytes;
+    }
+    /**
+     * @returns {number} The number of messages that are queued up.
+     */
+    get currentMessageCount() {
+        return this.messages;
+    }
+    /**
+     * Adds the specified number of bytes or messages to our count. We'll
+     * assume that this is end running around our queueing mechanisms.
+     *
+     * @param {number} bytes The number of bytes to add to the count.
+     * @param {number} messages The number of messages to add to the count.
+     */
+    addToCount(bytes, messages) {
+        this.bytes += bytes;
+        this.messages += messages;
+    }
+    /**
+     * Attempts to queue the specified number of bytes and messages. If
+     * there are too many things in the publisher flow control queue
+     * already, we will defer and come back to it.
+     *
+     * Do not use externally, it may change without warning.
+     * @private
+     */
+    async willSend(bytes, messages) {
+        // Add this to our queue size.
+        this.bytes += bytes;
+        this.messages += messages;
+        // If this request won't fit, we have to put it in the queue.
+        if (this.exceeded()) {
+            const promise = defer();
+            this.requests.push({
+                promise: promise.promise,
+                resolve: promise.resolve,
+                reject: promise.reject,
+                bytes,
+                messageCount: messages,
+            });
+            // This will pass through when someone else's this.sent() completes.
+            await promise.promise;
+        }
+    }
+    /**
+     * Removes the specified number of bytes and messages from our queued
+     * counts, after a deferred request was released. If there is enough
+     * space.
+     *
+     * Do not use externally, it may change without warning.
+     * @private
+     */
+    sent(bytes, messages) {
+        this.bytes -= bytes;
+        this.messages -= messages;
+        // This shouldn't happen, but just be sure.
+        if (this.bytes < 0)
+            this.bytes = 0;
+        if (this.messages < 0)
+            this.messages = 0;
+        // Let things waiting on willSend() have a go, if there's space.
+        if (this.requests.length > 0 && !this.exceeded()) {
+            const next = this.requests.shift();
+            next.resolve();
+        }
+    }
+    // Just uses wouldExceed() to see if we've already exceeded the limits.
+    exceeded() {
+        return this.wouldExceed(0, 0);
+    }
+    /**
+     * Returns true if adding the specified number of bytes or messages
+     * would exceed limits imposed by configuration.
+     *
+     * Do not use externally, it may change without warning.
+     * @private
+     */
+    wouldExceed(bytes, messages) {
+        const totalBytes = this.bytes + bytes;
+        const totalMessages = this.messages + messages;
+        if (this.options.maxOutstandingBytes !== undefined &&
+            totalBytes > this.options.maxOutstandingBytes) {
+            return true;
+        }
+        if (this.options.maxOutstandingMessages !== undefined &&
+            totalMessages > this.options.maxOutstandingMessages) {
+            return true;
+        }
+        return false;
+    }
+}
+exports.FlowControl = FlowControl;
+//# sourceMappingURL=flow-control.js.map

package/build/src/publisher/flow-control.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow-control.js","sourceRoot":"","sources":["../../../src/publisher/flow-control.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,iCAAiC;AAyBjC;;;;;;GAMG;AACH,MAAa,WAAW;IAMtB,YAAY,OAA2B;QALvC,YAAO,GAAuB,EAAE,CAAC;QAM/B,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,OAA2B;QACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IACE,IAAI,CAAC,OAAO,CAAC,mBAAmB,KAAK,CAAC;YACtC,IAAI,CAAC,OAAO,CAAC,sBAAsB,KAAK,CAAC,EACzC;YACA,sEAAsE;YACtE,MAAM,IAAI,KAAK,CACb,oGAAoG,CACrG,CAAC;SACH;IACH,CAAC;IAED;;OAEG;IACH,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,KAAa,EAAE,QAAgB;QACxC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC;QACpB,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC;IAC5B,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,QAAQ,CAAC,KAAa,EAAE,QAAgB;QAC5C,8BAA8B;QAC9B,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC;QACpB,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC;QAE1B,6DAA6D;QAC7D,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE;YACnB,MAAM,OAAO,GAAG,KAAK,EAAQ,CAAC;YAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACjB,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,KAAK;gBACL,YAAY,EAAE,QAAQ;aACvB,CAAC,CAAC;YAEH,oEAAoE;YACpE,MAAM,OAAO,CAAC,OAAO,CAAC;SACvB;IACH,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,KAAa,EAAE,QAAgB;QAClC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC;QACpB,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC;QAE1B,2CAA2C;QAC3C,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC;YAAE,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QACnC,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC;YAAE,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QAEzC,gEAAgE;QAChE,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE;YAChD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAG,CAAC;YACpC,IAAI,CAAC,OAAO,EAAE,CAAC;SAChB;IACH,CAAC;IAED,uEAAuE;IAC/D,QAAQ;QACd,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,KAAa,EAAE,QAAgB;QACzC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACtC,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAE/C,IACE,IAAI,CAAC,OAAO,CAAC,mBAAmB,KAAK,SAAS;YAC9C,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAC7C;YACA,OAAO,IAAI,CAAC;SACb;QAED,IACE,IAAI,CAAC,OAAO,CAAC,sBAAsB,KAAK,SAAS;YACjD,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,EACnD;YACA,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA9ID,kCA8IC"}

package/build/src/publisher/flow-publisher.d.ts

@@ -0,0 +1,95 @@
+/*!
+ * Copyright 2021 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.
+ */
+import { Publisher } from '.';
+import { PubsubMessage } from './pubsub-message';
+/**
+ * Encapsulates a series of message publishes from a rapid loop (or similar
+ * circumstance).
+ *
+ * This class is not meant to be instantiated outside of the `@google-cloud/pubsub`
+ * package. It is returned from {@link Topic#flowControlled}. Messages sent
+ * through an instance of this class will obey publisher flow control
+ * settings set through {@link PublisherOptions} on {@link Topic}, across
+ * all instances returned by {@link Topic#flowControlled} on that {@link Topic}.
+ */
+export declare class FlowControlledPublisher {
+    private publisher;
+    private flowControl;
+    private idPromises;
+    constructor(publisher: Publisher);
+    /**
+     * Returns true if sending the specified Buffer would result in exceeding the
+     * limits of the flow control settings.
+     *
+     * @param {PubsubMessage} message The data buffer with the message's contents.
+     * @returns {boolean} True if the message would exceed flow control limits.
+     */
+    wouldExceed(message: PubsubMessage): boolean;
+    /**
+     * Publishes a message, subject to flow control restrictions.
+     *
+     * If the message can be sent immediately, this will return `null`. Otherwise,
+     * it will return a Promise<void> that resolves after it's okay to resume
+     * calling the method.
+     *
+     * @param {Buffer} [data] The message contents to be sent.
+     * @param {Attributes} [attributes] Optional attributes.
+     * @returns null, or a Promise that resolves when sending may resume.
+     *
+     * @example
+     * ```
+     * const wait = flowControlled.publish({data});
+     * if (wait) {
+     *   await wait;
+     * }
+     *
+     * ```
+     * @example
+     * ```
+     * // It's okay to await unconditionally, it's equivalent to nextTick().
+     * await flowControlled.publish(data);
+     * ```
+     */
+    publish(message: PubsubMessage): Promise<void> | null;
+    /**
+     * Publishes a message unconditionally, updating flow control counters.
+     *
+     * You'll generally only want to use this if you want to deal with timing the
+     * flow control yourself, but you'd like the library to do the bean counting.
+     *
+     * @param {Buffer} [data] The message contents to be sent.
+     * @param {Attributes} [attributes] Optional attributes.
+     *
+     * @example
+     * ```
+     * if (!flowControlled.wouldExceed(data)) {
+     *   flowControlled.publishNow(data);
+     * }
+     * ```
+     */
+    publishNow(message: PubsubMessage): void;
+    private doPublish;
+    /**
+     * Returns a Promise that will resolve to all of the currently sent
+     * message IDs (or reject if there is an error). This also clears
+     * out any currently sent messages, so the next call to `all()` will
+     * be a clean slate.
+     *
+     * @returns {Promise<string[]>} A Promise that resolves when all current
+     *   messages are sent.
+     */
+    all(): Promise<string[]>;
+}

package/build/src/publisher/flow-publisher.js

@@ -0,0 +1,133 @@
+"use strict";
+/*!
+ * Copyright 2021 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.FlowControlledPublisher = void 0;
+const pubsub_message_1 = require("./pubsub-message");
+/**
+ * Encapsulates a series of message publishes from a rapid loop (or similar
+ * circumstance).
+ *
+ * This class is not meant to be instantiated outside of the `@google-cloud/pubsub`
+ * package. It is returned from {@link Topic#flowControlled}. Messages sent
+ * through an instance of this class will obey publisher flow control
+ * settings set through {@link PublisherOptions} on {@link Topic}, across
+ * all instances returned by {@link Topic#flowControlled} on that {@link Topic}.
+ */
+class FlowControlledPublisher {
+    constructor(publisher) {
+        this.publisher = publisher;
+        this.flowControl = this.publisher.flowControl;
+        this.idPromises = [];
+    }
+    /**
+     * Returns true if sending the specified Buffer would result in exceeding the
+     * limits of the flow control settings.
+     *
+     * @param {PubsubMessage} message The data buffer with the message's contents.
+     * @returns {boolean} True if the message would exceed flow control limits.
+     */
+    wouldExceed(message) {
+        return this.flowControl.wouldExceed(pubsub_message_1.calculateMessageSize(message), 1);
+    }
+    /**
+     * Publishes a message, subject to flow control restrictions.
+     *
+     * If the message can be sent immediately, this will return `null`. Otherwise,
+     * it will return a Promise<void> that resolves after it's okay to resume
+     * calling the method.
+     *
+     * @param {Buffer} [data] The message contents to be sent.
+     * @param {Attributes} [attributes] Optional attributes.
+     * @returns null, or a Promise that resolves when sending may resume.
+     *
+     * @example
+     * ```
+     * const wait = flowControlled.publish({data});
+     * if (wait) {
+     *   await wait;
+     * }
+     *
+     * ```
+     * @example
+     * ```
+     * // It's okay to await unconditionally, it's equivalent to nextTick().
+     * await flowControlled.publish(data);
+     * ```
+     */
+    publish(message) {
+        const doPublish = () => {
+            this.doPublish(message);
+        };
+        const size = pubsub_message_1.calculateMessageSize(message);
+        if (this.flowControl.wouldExceed(size, 1)) {
+            const waitPromise = this.flowControl.willSend(size, 1);
+            return waitPromise.then(doPublish);
+        }
+        else {
+            this.flowControl.willSend(size, 1).then(() => { });
+            doPublish();
+            return null;
+        }
+    }
+    /**
+     * Publishes a message unconditionally, updating flow control counters.
+     *
+     * You'll generally only want to use this if you want to deal with timing the
+     * flow control yourself, but you'd like the library to do the bean counting.
+     *
+     * @param {Buffer} [data] The message contents to be sent.
+     * @param {Attributes} [attributes] Optional attributes.
+     *
+     * @example
+     * ```
+     * if (!flowControlled.wouldExceed(data)) {
+     *   flowControlled.publishNow(data);
+     * }
+     * ```
+     */
+    publishNow(message) {
+        this.flowControl.addToCount(pubsub_message_1.calculateMessageSize(message), 1);
+        this.doPublish(message);
+    }
+    doPublish(message) {
+        let idPromise = this.publisher.publishMessage(message);
+        // This will defer but not eat any errors.
+        const publishDone = (id) => {
+            this.flowControl.sent(pubsub_message_1.calculateMessageSize(message), 1);
+            return id;
+        };
+        idPromise.catch(publishDone);
+        idPromise = idPromise.then(publishDone);
+        this.idPromises.push(idPromise);
+    }
+    /**
+     * Returns a Promise that will resolve to all of the currently sent
+     * message IDs (or reject if there is an error). This also clears
+     * out any currently sent messages, so the next call to `all()` will
+     * be a clean slate.
+     *
+     * @returns {Promise<string[]>} A Promise that resolves when all current
+     *   messages are sent.
+     */
+    all() {
+        const allPromise = Promise.all(this.idPromises);
+        this.idPromises = [];
+        return allPromise;
+    }
+}
+exports.FlowControlledPublisher = FlowControlledPublisher;
+//# sourceMappingURL=flow-publisher.js.map

package/build/src/publisher/flow-publisher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow-publisher.js","sourceRoot":"","sources":["../../../src/publisher/flow-publisher.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAIH,qDAAqE;AAErE;;;;;;;;;GASG;AACH,MAAa,uBAAuB;IAKlC,YAAY,SAAoB;QAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;QAC9C,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,OAAsB;QAChC,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,qCAAoB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,OAAO,CAAC,OAAsB;QAC5B,MAAM,SAAS,GAAG,GAAG,EAAE;YACrB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC,CAAC;QAEF,MAAM,IAAI,GAAG,qCAAoB,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE;YACzC,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YACvD,OAAO,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACpC;aAAM;YACL,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YAClD,SAAS,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC;SACb;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,OAAsB;QAC/B,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,qCAAoB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9D,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAEO,SAAS,CAAC,OAAsB;QACtC,IAAI,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAEvD,0CAA0C;QAC1C,MAAM,WAAW,GAAG,CAAC,EAAU,EAAE,EAAE;YACjC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,qCAAoB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;YACxD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACF,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAC7B,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAExC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;OAQG;IACH,GAAG;QACD,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAChD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AAhHD,0DAgHC"}

package/build/src/publisher/index.d.ts

@@ -20,14 +20,13 @@ import { BatchPublishOptions } from './message-batch';
 import { Queue, OrderedQueue } from './message-queues';
 import { Topic } from '../topic';
 import { RequestCallback, EmptyCallback } from '../pubsub';
-import { google } from '../../protos/protos';
-export declare type PubsubMessage = google.pubsub.v1.IPubsubMessage;
-export interface Attributes {
-    [key: string]: string;
-}
+import { FlowControl, FlowControlOptions } from './flow-control';
+import { PubsubMessage, Attributes } from './pubsub-message';
+export { PubsubMessage, Attributes } from './pubsub-message';
 export declare type PublishCallback = RequestCallback<string>;
 export interface PublishOptions {
     batching?: BatchPublishOptions;
+    flowControlOptions?: FlowControlOptions;
     gaxOpts?: CallOptions;
     messageOrdering?: boolean;
     enableOpenTelemetryTracing?: boolean;
@@ -36,6 +35,8 @@ export interface PublishOptions {
  * @typedef PublishOptions
  * @property {BatchPublishOptions} [batching] The maximum number of bytes to
  *     buffer before sending a payload.
+ * @property {FlowControlOptions} [publisherFlowControl] Publisher-side flow
+ *     control settings. If this is undefined, Ignore will be the assumed action.
  * @property {object} [gaxOpts] Request configuration options, outlined
  *     {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html|here.}
  * @property {boolean} [messageOrdering] If true, messages published with the
@@ -44,6 +45,7 @@ export interface PublishOptions {
  * any order.
  */
 export declare const BATCH_LIMITS: BatchPublishOptions;
+export declare const flowControlDefaults: FlowControlOptions;
 /**
  * A Publisher object allows you to publish messages to a specific topic.
  *
@@ -60,9 +62,34 @@ export declare class Publisher {
     settings: PublishOptions;
     queue: Queue;
     orderedQueues: Map<string, OrderedQueue>;
+    flowControl: FlowControl;
     constructor(topic: Topic, options?: PublishOptions);
+    /**
+     * Immediately sends all remaining queued data. This is mostly useful
+     * if you are planning to call close() on the PubSub object that holds
+     * the server connections.
+     *
+     * @private
+     *
+     * @param {EmptyCallback} [callback] Callback function.
+     * @returns {Promise<EmptyResponse>}
+     */
     flush(): Promise<void>;
     flush(callback: EmptyCallback): void;
+    /**
+     * Publish the provided message.
+     *
+     * @deprecated use {@link Publisher#publishMessage} instead.
+     *
+     * @private
+     * @see Publisher#publishMessage
+     *
+     * @param {buffer} data The message data. This must come in the form of a
+     *     Buffer object.
+     * @param {object.<string, string>} [attributes] Attributes for this message.
+     * @param {PublishCallback} [callback] Callback function.
+     * @returns {Promise<PublishResponse>}
+     */
     publish(data: Buffer, attributes?: Attributes): Promise<string>;
     publish(data: Buffer, callback: PublishCallback): void;
     publish(data: Buffer, attributes: Attributes, callback: PublishCallback): void;
@@ -77,6 +104,7 @@ export declare class Publisher {
      * @param {PubsubMessage} [message] Options for this message.
      * @param {PublishCallback} [callback] Callback function.
      */
+    publishMessage(message: PubsubMessage): Promise<string>;
     publishMessage(message: PubsubMessage, callback: PublishCallback): void;
     /**
      * Indicates to the publisher that it is safe to continue publishing for the