@google-cloud/pubsub 2.16.6 → 2.18.2

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

package/build/src/publisher/index.js

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Publisher = exports.BATCH_LIMITS = void 0;
+exports.Publisher = exports.flowControlDefaults = exports.BATCH_LIMITS = void 0;
 const promisify_1 = require("@google-cloud/promisify");
 const extend = require("extend");
 const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
@@ -23,10 +23,14 @@ const api_1 = require("@opentelemetry/api");
 const message_queues_1 = require("./message-queues");
 const default_options_1 = require("../default-options");
 const opentelemetry_tracing_1 = require("../opentelemetry-tracing");
+const flow_control_1 = require("./flow-control");
+const util_1 = require("../util");
 /**
  * @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
@@ -38,6 +42,10 @@ exports.BATCH_LIMITS = {
     maxBytes: Math.pow(1024, 2) * 9,
     maxMessages: 1000,
 };
+exports.flowControlDefaults = {
+    maxOutstandingBytes: undefined,
+    maxOutstandingMessages: undefined,
+};
 /**
  * A Publisher object allows you to publish messages to a specific topic.
  *
@@ -51,21 +59,12 @@ exports.BATCH_LIMITS = {
  */
 class Publisher {
     constructor(topic, options) {
+        this.flowControl = new flow_control_1.FlowControl((options === null || options === void 0 ? void 0 : options.flowControlOptions) || exports.flowControlDefaults);
         this.setOptions(options);
         this.topic = topic;
         this.queue = new message_queues_1.Queue(this);
         this.orderedQueues = new Map();
     }
-    /**
-     * 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(callback) {
         const definedCallback = callback ? callback : () => { };
         const publishes = [promisify_1.promisify(this.queue.publish).bind(this.queue)()];
@@ -77,36 +76,11 @@ class Publisher {
         })
             .catch(definedCallback);
     }
-    /**
-     * 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, attrsOrCb, callback) {
         const attributes = typeof attrsOrCb === 'object' ? attrsOrCb : {};
         callback = typeof attrsOrCb === 'function' ? attrsOrCb : callback;
         return this.publishMessage({ data, attributes }, callback);
     }
-    /**
-     * Publish the provided message.
-     *
-     * @private
-     *
-     * @throws {TypeError} If data is not a Buffer object.
-     * @throws {TypeError} If any value in `attributes` object is not a string.
-     *
-     * @param {PubsubMessage} [message] Options for this message.
-     * @param {PublishCallback} [callback] Callback function.
-     */
     publishMessage(message, callback) {
         const { data, attributes = {} } = message;
         // We must have at least one of:
@@ -183,6 +157,7 @@ class Publisher {
                 isBundling: false,
             },
             enableOpenTelemetryTracing: false,
+            flowControlOptions: Object.assign({}, exports.flowControlDefaults),
         };
         return defaults;
     }
@@ -195,7 +170,7 @@ class Publisher {
      */
     setOptions(options = {}) {
         const defaults = this.getOptionDefaults();
-        const { batching, gaxOpts, messageOrdering, enableOpenTelemetryTracing } = extend(true, defaults, options);
+        const { batching, gaxOpts, messageOrdering, enableOpenTelemetryTracing, flowControlOptions, } = extend(true, defaults, options);
         this.settings = {
             batching: {
                 maxBytes: Math.min(batching.maxBytes, exports.BATCH_LIMITS.maxBytes),
@@ -205,6 +180,7 @@ class Publisher {
             gaxOpts,
             messageOrdering,
             enableOpenTelemetryTracing,
+            flowControlOptions,
         };
         // We also need to let all of our queues know that they need to update their options.
         // Note that these might be undefined, because setOptions() is called in the constructor.
@@ -216,6 +192,8 @@ class Publisher {
                 q.updateOptions();
             }
         }
+        // This will always be filled in by our defaults if nothing else.
+        this.flowControl.setOptions(this.settings.flowControlOptions);
     }
     /**
      * Constructs an OpenTelemetry span
@@ -259,8 +237,7 @@ class Publisher {
     }
 }
 exports.Publisher = Publisher;
-promisify_1.promisifyAll(Publisher, {
+util_1.promisifySome(Publisher, Publisher.prototype, ['flush', 'publishMessage'], {
     singular: true,
-    exclude: ['publish', 'setOptions', 'constructSpan', 'getOptionDefaults'],
 });
 //# sourceMappingURL=index.js.map

package/build/src/publisher/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/publisher/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,uDAAgE;AAChE,iCAAiC;AAEjC,8EAAuE;AACvE,4CAAsE;AAGtE,qDAAqD;AAIrD,wDAAkD;AAClD,oEAAoD;AAiBpD;;;;;;;;;;GAUG;AAEU,QAAA,YAAY,GAAwB;IAC/C,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC;IAC/B,WAAW,EAAE,IAAI;CAClB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAa,SAAS;IAKpB,YAAY,KAAY,EAAE,OAAwB;QAChD,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,IAAI,sBAAK,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,EAAE,CAAC;IACjC,CAAC;IAID;;;;;;;;;OASG;IACH,KAAK,CAAC,QAAwB;QAC5B,MAAM,eAAe,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC;QAEvD,MAAM,SAAS,GAAG,CAAC,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACrE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAClD,SAAS,CAAC,IAAI,CAAC,qBAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAC/C,CAAC;QACF,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAE5C,YAAY;aACT,IAAI,CAAC,GAAG,EAAE;YACT,eAAe,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC,CAAC;aACD,KAAK,CAAC,eAAe,CAAC,CAAC;IAC5B,CAAC;IAQD;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,IAAY,EACZ,SAAwC,EACxC,QAA0B;QAE1B,MAAM,UAAU,GAAG,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;QAClE,QAAQ,GAAG,OAAO,SAAS,KAAK,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC;QAClE,OAAO,IAAI,CAAC,cAAc,CAAC,EAAC,IAAI,EAAE,UAAU,EAAC,EAAE,QAAS,CAAC,CAAC;IAC5D,CAAC;IACD;;;;;;;;;;OAUG;IACH,cAAc,CAAC,OAAsB,EAAE,QAAyB;QAC9D,MAAM,EAAC,IAAI,EAAE,UAAU,GAAG,EAAE,EAAC,GAAG,OAAO,CAAC;QAExC,gCAAgC;QAChC,yBAAyB;QACzB,sCAAsC;QACtC,IAAI,IAAI,IAAI,CAAC,CAAC,IAAI,YAAY,MAAM,CAAC,EAAE;YACrC,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;SAC9D;QAED,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,UAAW,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YAC9B,MAAM,IAAI,SAAS,CACjB,+DAA+D,CAChE,CAAC;SACH;QAED,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,MAAM,KAAK,GAAG,UAAW,CAAC,GAAG,CAAC,CAAC;YAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBAC7B,MAAM,IAAI,SAAS,CAAC;2BACD,OAAO,KAAK,mBAAmB,GAAG,IAAI,CAAC,CAAC;aAC5D;SACF;QAED,MAAM,IAAI,GAAqB,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAE3D,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE;YACxB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAClC,IAAI,IAAI,EAAE;gBACR,IAAI,CAAC,GAAG,EAAE,CAAC;aACZ;YACD,OAAO;SACR;QAED,MAAM,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC;QAEhC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAChC,MAAM,KAAK,GAAG,IAAI,6BAAY,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAC1C,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACnC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;SAC3D;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;QAC3C,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAE7B,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,GAAG,EAAE,CAAC;SACZ;IACH,CAAC;IACD;;;;;;;OAOG;IACH,gBAAgB,CAAC,GAAW;QAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAE1C,IAAI,KAAK,EAAE;YACT,KAAK,CAAC,gBAAgB,EAAE,CAAC;SAC1B;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB;QACf,6CAA6C;QAC7C,MAAM,QAAQ,GAAG;YACf,QAAQ,EAAE;gBACR,QAAQ,EAAE,gCAAc,CAAC,OAAO,CAAC,mBAAmB;gBACpD,WAAW,EAAE,gCAAc,CAAC,OAAO,CAAC,sBAAsB;gBAC1D,eAAe,EAAE,gCAAc,CAAC,OAAO,CAAC,cAAc;aACvD;YACD,eAAe,EAAE,KAAK;YACtB,OAAO,EAAE;gBACP,UAAU,EAAE,KAAK;aAClB;YACD,0BAA0B,EAAE,KAAK;SAClC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,UAAU,EAAoB;QACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE1C,MAAM,EAAC,QAAQ,EAAE,OAAO,EAAE,eAAe,EAAE,0BAA0B,EAAC,GACpE,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAElC,IAAI,CAAC,QAAQ,GAAG;YACd,QAAQ,EAAE;gBACR,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAS,CAAC,QAAS,EAAE,oBAAY,CAAC,QAAS,CAAC;gBAC/D,WAAW,EAAE,IAAI,CAAC,GAAG,CACnB,QAAS,CAAC,WAAY,EACtB,oBAAY,CAAC,WAAY,CAC1B;gBACD,eAAe,EAAE,QAAS,CAAC,eAAe;aAC3C;YACD,OAAO;YACP,eAAe;YACf,0BAA0B;SAC3B,CAAC;QAEF,qFAAqF;QACrF,yFAAyF;QACzF,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;SAC5B;QACD,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE;gBAC3C,CAAC,CAAC,aAAa,EAAE,CAAC;aACnB;SACF;IACH,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,OAAsB;;QAClC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,0BAA0B,EAAE;YAC7C,OAAO,SAAS,CAAC;SAClB;QAED,MAAM,cAAc,GAAG;YACrB,0EAA0E;YAC1E,kIAAkI;YAClI,CAAC,yCAAkB,CAAC,0BAA0B,CAAC,EAAE,KAAK;YACtD,CAAC,yCAAkB,CAAC,gBAAgB,CAAC,EAAE,QAAQ;YAC/C,CAAC,yCAAkB,CAAC,mBAAmB,CAAC,EAAE,MAAM;YAChD,CAAC,yCAAkB,CAAC,qBAAqB,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI;YAC3D,CAAC,yCAAkB,CAAC,0BAA0B,CAAC,EAAE,OAAO;YACxD,CAAC,yCAAkB,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC,SAAS;YAC5D,CAAC,yCAAkB,CAAC,kBAAkB,CAAC,EAAE,QAAQ;YACjD,CAAC,yCAAkB,CAAC,oCAAoC,CAAC,QACvD,OAAO,CAAC,IAAI,0CAAE,MAAM;YACtB,+BAA+B,EAAE,OAAO,CAAC,WAAW;SACvC,CAAC;QAEhB,MAAM,IAAI,GAAS,kCAAU,CAC3B,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,OAAO,EACzB,cAAQ,CAAC,QAAQ,EACjB,cAAc,CACf,CAAC;QAEF,mFAAmF;QACnF,IAAI,wBAAkB,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE;YAC1C,IACE,OAAO,CAAC,UAAU;gBAClB,OAAO,CAAC,UAAU,CAAC,qCAAqC,CAAC,EACzD;gBACA,OAAO,CAAC,IAAI,CACV,2FAA2F,CAC5F,CAAC;aACH;YACD,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;gBACvB,OAAO,CAAC,UAAU,GAAG,EAAE,CAAC;aACzB;YAED,OAAO,CAAC,UAAU,CAAC,qCAAqC,CAAC;gBACvD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;SACtC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA1QD,8BA0QC;AAED,wBAAY,CAAC,SAAS,EAAE;IACtB,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,eAAe,EAAE,mBAAmB,CAAC;CACzE,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/publisher/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,uDAAkD;AAClD,iCAAiC;AAEjC,8EAAuE;AACvE,4CAAsE;AAGtE,qDAAqD;AAGrD,wDAAkD;AAClD,oEAAoD;AAEpD,iDAA+D;AAC/D,kCAAsC;AAetC;;;;;;;;;;;;GAYG;AAEU,QAAA,YAAY,GAAwB;IAC/C,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC;IAC/B,WAAW,EAAE,IAAI;CAClB,CAAC;AAEW,QAAA,mBAAmB,GAAuB;IACrD,mBAAmB,EAAE,SAAS;IAC9B,sBAAsB,EAAE,SAAS;CAClC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAa,SAAS;IAOpB,YAAY,KAAY,EAAE,OAAwB;QAChD,IAAI,CAAC,WAAW,GAAG,IAAI,0BAAW,CAChC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,kBAAkB,KAAI,2BAAmB,CACnD,CAAC;QACF,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,IAAI,sBAAK,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,EAAE,CAAC;IACjC,CAAC;IAcD,KAAK,CAAC,QAAwB;QAC5B,MAAM,eAAe,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC;QAEvD,MAAM,SAAS,GAAG,CAAC,qBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACrE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAClD,SAAS,CAAC,IAAI,CAAC,qBAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAC/C,CAAC;QACF,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAE5C,YAAY;aACT,IAAI,CAAC,GAAG,EAAE;YACT,eAAe,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC,CAAC;aACD,KAAK,CAAC,eAAe,CAAC,CAAC;IAC5B,CAAC;IAsBD,OAAO,CACL,IAAY,EACZ,SAAwC,EACxC,QAA0B;QAE1B,MAAM,UAAU,GAAG,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;QAClE,QAAQ,GAAG,OAAO,SAAS,KAAK,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC;QAClE,OAAO,IAAI,CAAC,cAAc,CAAC,EAAC,IAAI,EAAE,UAAU,EAAC,EAAE,QAAS,CAAC,CAAC;IAC5D,CAAC;IAeD,cAAc,CACZ,OAAsB,EACtB,QAA0B;QAE1B,MAAM,EAAC,IAAI,EAAE,UAAU,GAAG,EAAE,EAAC,GAAG,OAAO,CAAC;QAExC,gCAAgC;QAChC,yBAAyB;QACzB,sCAAsC;QACtC,IAAI,IAAI,IAAI,CAAC,CAAC,IAAI,YAAY,MAAM,CAAC,EAAE;YACrC,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;SAC9D;QAED,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,UAAW,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YAC9B,MAAM,IAAI,SAAS,CACjB,+DAA+D,CAChE,CAAC;SACH;QAED,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,MAAM,KAAK,GAAG,UAAW,CAAC,GAAG,CAAC,CAAC;YAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBAC7B,MAAM,IAAI,SAAS,CAAC;2BACD,OAAO,KAAK,mBAAmB,GAAG,IAAI,CAAC,CAAC;aAC5D;SACF;QAED,MAAM,IAAI,GAAqB,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAE3D,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE;YACxB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,QAAS,CAAC,CAAC;YACnC,IAAI,IAAI,EAAE;gBACR,IAAI,CAAC,GAAG,EAAE,CAAC;aACZ;YACD,OAAO;SACR;QAED,MAAM,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC;QAEhC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAChC,MAAM,KAAK,GAAG,IAAI,6BAAY,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAC1C,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACnC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;SAC3D;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;QAC3C,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,QAAS,CAAC,CAAC;QAE9B,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,GAAG,EAAE,CAAC;SACZ;IACH,CAAC;IAED;;;;;;;OAOG;IACH,gBAAgB,CAAC,GAAW;QAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAE1C,IAAI,KAAK,EAAE;YACT,KAAK,CAAC,gBAAgB,EAAE,CAAC;SAC1B;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB;QACf,6CAA6C;QAC7C,MAAM,QAAQ,GAAmB;YAC/B,QAAQ,EAAE;gBACR,QAAQ,EAAE,gCAAc,CAAC,OAAO,CAAC,mBAAmB;gBACpD,WAAW,EAAE,gCAAc,CAAC,OAAO,CAAC,sBAAsB;gBAC1D,eAAe,EAAE,gCAAc,CAAC,OAAO,CAAC,cAAc;aACvD;YACD,eAAe,EAAE,KAAK;YACtB,OAAO,EAAE;gBACP,UAAU,EAAE,KAAK;aAClB;YACD,0BAA0B,EAAE,KAAK;YACjC,kBAAkB,EAAE,MAAM,CAAC,MAAM,CAC/B,EAAE,EACF,2BAAmB,CACE;SACxB,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,UAAU,EAAoB;QACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE1C,MAAM,EACJ,QAAQ,EACR,OAAO,EACP,eAAe,EACf,0BAA0B,EAC1B,kBAAkB,GACnB,GAAG,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAEpC,IAAI,CAAC,QAAQ,GAAG;YACd,QAAQ,EAAE;gBACR,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAS,CAAC,QAAS,EAAE,oBAAY,CAAC,QAAS,CAAC;gBAC/D,WAAW,EAAE,IAAI,CAAC,GAAG,CACnB,QAAS,CAAC,WAAY,EACtB,oBAAY,CAAC,WAAY,CAC1B;gBACD,eAAe,EAAE,QAAS,CAAC,eAAe;aAC3C;YACD,OAAO;YACP,eAAe;YACf,0BAA0B;YAC1B,kBAAkB;SACnB,CAAC;QAEF,qFAAqF;QACrF,yFAAyF;QACzF,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;SAC5B;QACD,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE;gBAC3C,CAAC,CAAC,aAAa,EAAE,CAAC;aACnB;SACF;QAED,iEAAiE;QACjE,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,kBAAmB,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,OAAsB;;QAClC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,0BAA0B,EAAE;YAC7C,OAAO,SAAS,CAAC;SAClB;QAED,MAAM,cAAc,GAAG;YACrB,0EAA0E;YAC1E,kIAAkI;YAClI,CAAC,yCAAkB,CAAC,0BAA0B,CAAC,EAAE,KAAK;YACtD,CAAC,yCAAkB,CAAC,gBAAgB,CAAC,EAAE,QAAQ;YAC/C,CAAC,yCAAkB,CAAC,mBAAmB,CAAC,EAAE,MAAM;YAChD,CAAC,yCAAkB,CAAC,qBAAqB,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI;YAC3D,CAAC,yCAAkB,CAAC,0BAA0B,CAAC,EAAE,OAAO;YACxD,CAAC,yCAAkB,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC,SAAS;YAC5D,CAAC,yCAAkB,CAAC,kBAAkB,CAAC,EAAE,QAAQ;YACjD,CAAC,yCAAkB,CAAC,oCAAoC,CAAC,QACvD,OAAO,CAAC,IAAI,0CAAE,MAAM;YACtB,+BAA+B,EAAE,OAAO,CAAC,WAAW;SACvC,CAAC;QAEhB,MAAM,IAAI,GAAS,kCAAU,CAC3B,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,OAAO,EACzB,cAAQ,CAAC,QAAQ,EACjB,cAAc,CACf,CAAC;QAEF,mFAAmF;QACnF,IAAI,wBAAkB,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE;YAC1C,IACE,OAAO,CAAC,UAAU;gBAClB,OAAO,CAAC,UAAU,CAAC,qCAAqC,CAAC,EACzD;gBACA,OAAO,CAAC,IAAI,CACV,2FAA2F,CAC5F,CAAC;aACH;YACD,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;gBACvB,OAAO,CAAC,UAAU,GAAG,EAAE,CAAC;aACzB;YAED,OAAO,CAAC,UAAU,CAAC,qCAAqC,CAAC;gBACvD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;SACtC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAnSD,8BAmSC;AAED,oBAAa,CAAC,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,gBAAgB,CAAC,EAAE;IACzE,QAAQ,EAAE,IAAI;CACf,CAAC,CAAC"}

package/build/src/publisher/message-batch.d.ts

@@ -61,7 +61,7 @@ export declare class MessageBatch {
      * @param {object} message The message in question.
      * @returns {boolean}
      */
-    canFit({ data }: PubsubMessage): boolean;
+    canFit(message: PubsubMessage): boolean;
     /**
      * Checks to see if this batch is at the maximum allowed payload size.
      * When publishing ordered messages, it is ok to exceed the user configured

package/build/src/publisher/message-batch.js

@@ -17,6 +17,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MessageBatch = void 0;
 const _1 = require("./");
+const pubsub_message_1 = require("./pubsub-message");
 /**
  * @typedef BatchPublishOptions
  * @property {number} [maxBytes=1 * 1024 * 1024] The maximum number of bytes to
@@ -58,7 +59,7 @@ class MessageBatch {
     add(message, callback) {
         this.messages.push(message);
         this.callbacks.push(callback);
-        this.bytes += message.data.length;
+        this.bytes += pubsub_message_1.calculateMessageSize(message);
     }
     /**
      * Indicates if a given message can fit in the batch.
@@ -66,10 +67,10 @@ class MessageBatch {
      * @param {object} message The message in question.
      * @returns {boolean}
      */
-    canFit({ data }) {
+    canFit(message) {
         const { maxMessages, maxBytes } = this.options;
         return (this.messages.length < maxMessages &&
-            this.bytes + data.length <= maxBytes);
+            this.bytes + pubsub_message_1.calculateMessageSize(message) <= maxBytes);
     }
     /**
      * Checks to see if this batch is at the maximum allowed payload size.