@google-cloud/pubsub 2.4.0 → 2.5.0

package/CHANGELOG.md

@@ -4,6 +4,21 @@
 
 [1]: https://www.npmjs.com/package/@google-cloud/pubsub?activeTab=versions
 
+## [2.5.0](https://www.github.com/googleapis/nodejs-pubsub/compare/v2.4.0...v2.5.0) (2020-08-17)
+
+
+### Features
+
+* Opentelemetry integration ([#1078](https://www.github.com/googleapis/nodejs-pubsub/issues/1078)) ([76db007](https://www.github.com/googleapis/nodejs-pubsub/commit/76db007f270a646e8570768fa827ea2a97b62cbc)), closes [#1066](https://www.github.com/googleapis/nodejs-pubsub/issues/1066) [#1070](https://www.github.com/googleapis/nodejs-pubsub/issues/1070)
+
+
+### Bug Fixes
+
+* make request batching work again ([#1087](https://www.github.com/googleapis/nodejs-pubsub/issues/1087)) ([80e0ee3](https://www.github.com/googleapis/nodejs-pubsub/commit/80e0ee3a4ef0da325e61ce2b869f4c0f9829b136))
+* properly handle non-emulator alternate endpoints for pub/sub ([#1060](https://www.github.com/googleapis/nodejs-pubsub/issues/1060)) ([195ebf6](https://www.github.com/googleapis/nodejs-pubsub/commit/195ebf648e00ba35f567cef06a06c31f3f9c57d9))
+* **deps:** update opentelemetry monorepo to ^0.10.0 ([#1090](https://www.github.com/googleapis/nodejs-pubsub/issues/1090)) ([78a45ff](https://www.github.com/googleapis/nodejs-pubsub/commit/78a45ff1cb8fb921e5ca05e435554d684a777185))
+* update minimum gax version to 2.7.0 to fix recent protobuf errors ([#1085](https://www.github.com/googleapis/nodejs-pubsub/issues/1085)) ([904348c](https://www.github.com/googleapis/nodejs-pubsub/commit/904348cd6471f267a54635fcd65fe4191896308e))
+
 ## [2.4.0](https://www.github.com/googleapis/nodejs-pubsub/compare/v2.3.0...v2.4.0) (2020-08-08)
 
 

package/README.md

@@ -22,6 +22,9 @@ For additional help developing Pub/Sub applications, in Node.js and other langua
 guides.
 
 
+A comprehensive list of changes in each version may be found in
+[the CHANGELOG](https://github.com/googleapis/nodejs-pubsub/blob/master/CHANGELOG.md).
+
 * [Google Cloud Pub/Sub Node.js Client API Reference][client-docs]
 * [Google Cloud Pub/Sub Documentation][product-docs]
 * [github.com/googleapis/nodejs-pubsub](https://github.com/googleapis/nodejs-pubsub)

package/build/protos/google/pubsub/v1/pubsub.proto

@@ -42,9 +42,8 @@ service Publisher {
       "https://www.googleapis.com/auth/cloud-platform,"
       "https://www.googleapis.com/auth/pubsub";
 
-  // Creates the given topic with the given name. See the
-  // <a href="https://cloud.google.com/pubsub/docs/admin#resource_names">
-  // resource name rules</a>.
+  // Creates the given topic with the given name. See the [resource name rules](
+  // https://cloud.google.com/pubsub/docs/admin#resource_names).
   rpc CreateTopic(Topic) returns (Topic) {
     option (google.api.http) = {
       put: "/v1/{name=projects/*/topics/*}"
@@ -98,11 +97,10 @@ service Publisher {
   }
 
   // Lists the names of the snapshots on this topic. Snapshots are used in
-  // <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
-  // operations, which allow
-  // you to manage message acknowledgments in bulk. That is, you can set the
-  // acknowledgment state of messages in an existing subscription to the state
-  // captured by a snapshot.
+  // [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
+  // which allow you to manage message acknowledgments in bulk. That is, you can
+  // set the acknowledgment state of messages in an existing subscription to the
+  // state captured by a snapshot.
   rpc ListTopicSnapshots(ListTopicSnapshotsRequest)
       returns (ListTopicSnapshotsResponse) {
     option (google.api.http) = {
@@ -161,8 +159,8 @@ message Topic {
   // must not start with `"goog"`.
   string name = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
-  // managing labels</a>.
+  // See [Creating and managing labels]
+  // (https://cloud.google.com/pubsub/docs/labels).
   map<string, string> labels = 2;
 
   // Policy constraining the set of Google Cloud Platform regions where messages
@@ -180,11 +178,11 @@ message Topic {
 // A message that is published by publishers and consumed by subscribers. The
 // message must contain either a non-empty data field or at least one attribute.
 // Note that client libraries represent this object differently
-// depending on the language. See the corresponding
-// <a href="https://cloud.google.com/pubsub/docs/reference/libraries">client
-// library documentation</a> for more information. See
-// <a href="https://cloud.google.com/pubsub/quotas">Quotas and limits</a>
-// for more information about message limits.
+// depending on the language. See the corresponding [client library
+// documentation](https://cloud.google.com/pubsub/docs/reference/libraries) for
+// more information. See [quotas and limits]
+// (https://cloud.google.com/pubsub/quotas) for more information about message
+// limits.
 message PubsubMessage {
   // The message data field. If this field is empty, the message must contain
   // at least one attribute.
@@ -212,9 +210,6 @@ message PubsubMessage {
   // delivered to subscribers in the order in which they are received by the
   // Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest`
   // must specify the same `ordering_key` value.
-  // <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
-  // API might be changed in backward-incompatible ways and is not recommended
-  // for production use. It is not subject to any SLA or deprecation policy.
   string ordering_key = 5;
 }
 
@@ -388,19 +383,17 @@ service Subscriber {
       "https://www.googleapis.com/auth/cloud-platform,"
       "https://www.googleapis.com/auth/pubsub";
 
-  // Creates a subscription to a given topic. See the
-  // <a href="https://cloud.google.com/pubsub/docs/admin#resource_names">
-  // resource name rules</a>.
+  // Creates a subscription to a given topic. See the [resource name rules]
+  // (https://cloud.google.com/pubsub/docs/admin#resource_names).
   // If the subscription already exists, returns `ALREADY_EXISTS`.
   // If the corresponding topic doesn't exist, returns `NOT_FOUND`.
   //
   // If the name is not provided in the request, the server will assign a random
   // name for this subscription on the same project as the topic, conforming
-  // to the
-  // [resource name
-  // format](https://cloud.google.com/pubsub/docs/admin#resource_names). The
-  // generated name is populated in the returned Subscription object. Note that
-  // for REST API requests, you must specify a name in the request.
+  // to the [resource name format]
+  // (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated
+  // name is populated in the returned Subscription object. Note that for REST
+  // API requests, you must specify a name in the request.
   rpc CreateSubscription(Subscription) returns (Subscription) {
     option (google.api.http) = {
       put: "/v1/{name=projects/*/subscriptions/*}"
@@ -528,12 +521,11 @@ service Subscriber {
     option (google.api.method_signature) = "snapshot";
   }
 
-  // Lists the existing snapshots. Snapshots are used in
-  // <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
-  // operations, which allow
-  // you to manage message acknowledgments in bulk. That is, you can set the
-  // acknowledgment state of messages in an existing subscription to the state
-  // captured by a snapshot.
+  // Lists the existing snapshots. Snapshots are used in [Seek](
+  // https://cloud.google.com/pubsub/docs/replay-overview) operations, which
+  // allow you to manage message acknowledgments in bulk. That is, you can set
+  // the acknowledgment state of messages in an existing subscription to the
+  // state captured by a snapshot.
   rpc ListSnapshots(ListSnapshotsRequest) returns (ListSnapshotsResponse) {
     option (google.api.http) = {
       get: "/v1/{project=projects/*}/snapshots"
@@ -542,21 +534,19 @@ service Subscriber {
   }
 
   // Creates a snapshot from the requested subscription. Snapshots are used in
-  // <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
-  // operations, which allow
-  // you to manage message acknowledgments in bulk. That is, you can set the
-  // acknowledgment state of messages in an existing subscription to the state
-  // captured by a snapshot.
-  // <br><br>If the snapshot already exists, returns `ALREADY_EXISTS`.
+  // [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
+  // which allow you to manage message acknowledgments in bulk. That is, you can
+  // set the acknowledgment state of messages in an existing subscription to the
+  // state captured by a snapshot.
+  // If the snapshot already exists, returns `ALREADY_EXISTS`.
   // If the requested subscription doesn't exist, returns `NOT_FOUND`.
   // If the backlog in the subscription is too old -- and the resulting snapshot
   // would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned.
   // See also the `Snapshot.expire_time` field. If the name is not provided in
   // the request, the server will assign a random
   // name for this snapshot on the same project as the subscription, conforming
-  // to the
-  // [resource name
-  // format](https://cloud.google.com/pubsub/docs/admin#resource_names). The
+  // to the [resource name format]
+  // (https://cloud.google.com/pubsub/docs/admin#resource_names). The
   // generated name is populated in the returned Snapshot object. Note that for
   // REST API requests, you must specify a name in the request.
   rpc CreateSnapshot(CreateSnapshotRequest) returns (Snapshot) {
@@ -580,12 +570,11 @@ service Subscriber {
     };
   }
 
-  // Removes an existing snapshot. Snapshots are used in
-  // <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
-  // operations, which allow
-  // you to manage message acknowledgments in bulk. That is, you can set the
-  // acknowledgment state of messages in an existing subscription to the state
-  // captured by a snapshot.<br><br>
+  // Removes an existing snapshot. Snapshots are used in [Seek]
+  // (https://cloud.google.com/pubsub/docs/replay-overview) operations, which
+  // allow you to manage message acknowledgments in bulk. That is, you can set
+  // the acknowledgment state of messages in an existing subscription to the
+  // state captured by a snapshot.
   // When the snapshot is deleted, all messages retained in the snapshot
   // are immediately dropped. After a snapshot is deleted, a new one may be
   // created with the same name, but the new one has no association with the old
@@ -598,13 +587,12 @@ service Subscriber {
   }
 
   // Seeks an existing subscription to a point in time or to a given snapshot,
-  // whichever is provided in the request. Snapshots are used in
-  // <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
-  // operations, which allow
-  // you to manage message acknowledgments in bulk. That is, you can set the
-  // acknowledgment state of messages in an existing subscription to the state
-  // captured by a snapshot. Note that both the subscription and the snapshot
-  // must be on the same topic.
+  // whichever is provided in the request. Snapshots are used in [Seek](
+  // https://cloud.google.com/pubsub/docs/replay-overview) operations, which
+  // allow you to manage message acknowledgments in bulk. That is, you can set
+  // the acknowledgment state of messages in an existing subscription to the
+  // state captured by a snapshot. Note that both the subscription and the
+  // snapshot must be on the same topic.
   rpc Seek(SeekRequest) returns (SeekResponse) {
     option (google.api.http) = {
       post: "/v1/{subscription=projects/*/subscriptions/*}:seek"
@@ -666,10 +654,8 @@ message Subscription {
   // Indicates whether to retain acknowledged messages. If true, then
   // messages are not expunged from the subscription's backlog, even if they are
   // acknowledged, until they fall out of the `message_retention_duration`
-  // window. This must be true if you would like to
-  // <a
-  // href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time">
-  // Seek to a timestamp</a>.
+  // window. This must be true if you would like to [Seek to a timestamp]
+  // (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time).
   bool retain_acked_messages = 7;
 
   // How long to retain unacknowledged messages in the subscription's backlog,
@@ -688,9 +674,6 @@ message Subscription {
   // will be delivered to the subscribers in the order in which they
   // are received by the Pub/Sub system. Otherwise, they may be delivered in
   // any order.
-  // <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
-  // API might be changed in backward-incompatible ways and is not recommended
-  // for production use. It is not subject to any SLA or deprecation policy.
   bool enable_message_ordering = 10;
 
   // A policy that specifies the conditions for this subscription's expiration.
@@ -1186,11 +1169,10 @@ message UpdateSnapshotRequest {
 }
 
 // A snapshot resource. Snapshots are used in
-// <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a>
-// operations, which allow
-// you to manage message acknowledgments in bulk. That is, you can set the
-// acknowledgment state of messages in an existing subscription to the state
-// captured by a snapshot.
+// [Seek](https://cloud.google.com/pubsub/docs/replay-overview)
+// operations, which allow you to manage message acknowledgments in bulk. That
+// is, you can set the acknowledgment state of messages in an existing
+// subscription to the state captured by a snapshot.
 message Snapshot {
   option (google.api.resource) = {
     type: "pubsub.googleapis.com/Snapshot"
@@ -1217,8 +1199,8 @@ message Snapshot {
   // snapshot that would expire in less than 1 hour after creation.
   google.protobuf.Timestamp expire_time = 3;
 
-  // See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
-  // managing labels</a>.
+  // See [Creating and managing labels]
+  // (https://cloud.google.com/pubsub/docs/labels).
   map<string, string> labels = 4;
 }
 

package/build/src/opentelemetry-tracing.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * Copyright 2020 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 { Attributes, SpanContext, Span } from '@opentelemetry/api';
+/**
+ * Wrapper for creating OpenTelemetry Spans
+ *
+ * @class
+ */
+export declare class OpenTelemetryTracer {
+    /**
+     * Creates a new span with the given properties
+     *
+     * @param {string} spanName the name for the span
+     * @param {Attributes?} attributes an object containing the attributes to be set for the span
+     * @param {SpanContext?} parent the context of the parent span to link to the span
+     */
+    createSpan(spanName: string, attributes?: Attributes, parent?: SpanContext): Span;
+}

package/build/src/opentelemetry-tracing.js

@@ -0,0 +1,41 @@
+"use strict";
+/*!
+ * Copyright 2020 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.OpenTelemetryTracer = void 0;
+const api_1 = require("@opentelemetry/api");
+/**
+ * Wrapper for creating OpenTelemetry Spans
+ *
+ * @class
+ */
+class OpenTelemetryTracer {
+    /**
+     * Creates a new span with the given properties
+     *
+     * @param {string} spanName the name for the span
+     * @param {Attributes?} attributes an object containing the attributes to be set for the span
+     * @param {SpanContext?} parent the context of the parent span to link to the span
+     */
+    createSpan(spanName, attributes, parent) {
+        const tracerProvider = api_1.trace.getTracer('default');
+        return tracerProvider.startSpan(spanName, {
+            parent: parent,
+            attributes: attributes,
+        });
+    }
+}
+exports.OpenTelemetryTracer = OpenTelemetryTracer;
+//# sourceMappingURL=opentelemetry-tracing.js.map

package/build/src/opentelemetry-tracing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"opentelemetry-tracing.js","sourceRoot":"","sources":["../../src/opentelemetry-tracing.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG;;;AAEH,4CAAwE;AAGxE;;;;GAIG;AACH,MAAa,mBAAmB;IAC9B;;;;;;OAMG;IACH,UAAU,CACR,QAAgB,EAChB,UAAuB,EACvB,MAAoB;QAEpB,MAAM,cAAc,GAAW,WAAK,CAAC,SAAS,CAAC,SAAS,CAAW,CAAC;QACpE,OAAO,cAAc,CAAC,SAAS,CAAC,QAAQ,EAAE;YACxC,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,UAAU;SACvB,CAAC,CAAC;IACL,CAAC;CACF;AAnBD,kDAmBC"}

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

@@ -15,11 +15,13 @@
  */
 /// <reference types="node" />
 import { CallOptions } from 'google-gax';
+import { Span } from '@opentelemetry/api';
 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';
+import { OpenTelemetryTracer } from '../opentelemetry-tracing';
 export declare type PubsubMessage = google.pubsub.v1.IPubsubMessage;
 export interface Attributes {
     [key: string]: string;
@@ -29,7 +31,19 @@ export interface PublishOptions {
     batching?: BatchPublishOptions;
     gaxOpts?: CallOptions;
     messageOrdering?: boolean;
+    enableOpenTelemetryTracing?: boolean;
 }
+/**
+ * @typedef PublishOptions
+ * @property {BatchPublishOptions} [batching] The maximum number of bytes to
+ *     buffer before sending a payload.
+ * @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
+ * same order key in Message will be delivered to the subscribers in the order in which they
+ *  are received by the Pub/Sub system. Otherwise, they may be delivered in
+ * any order.
+ */
 export declare const BATCH_LIMITS: BatchPublishOptions;
 /**
  * A Publisher object allows you to publish messages to a specific topic.
@@ -47,6 +61,7 @@ export declare class Publisher {
     settings: PublishOptions;
     queue: Queue;
     orderedQueues: Map<string, OrderedQueue>;
+    tracing: OpenTelemetryTracer | undefined;
     constructor(topic: Topic, options?: PublishOptions);
     flush(): Promise<void>;
     flush(callback: EmptyCallback): void;
@@ -82,4 +97,12 @@ export declare class Publisher {
      * @param {PublishOptions} options The publisher options.
      */
     setOptions(options?: PublishOptions): void;
+    /**
+     * Constructs an OpenTelemetry span
+     *
+     * @private
+     *
+     * @param {PubsubMessage} message The message to create a span for
+     */
+    constructSpan(message: PubsubMessage): Span | undefined;
 }

package/build/src/publisher/index.js

@@ -20,6 +20,18 @@ const promisify_1 = require("@google-cloud/promisify");
 const extend = require("extend");
 const message_queues_1 = require("./message-queues");
 const default_options_1 = require("../default-options");
+const opentelemetry_tracing_1 = require("../opentelemetry-tracing");
+/**
+ * @typedef PublishOptions
+ * @property {BatchPublishOptions} [batching] The maximum number of bytes to
+ *     buffer before sending a payload.
+ * @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
+ * same order key in Message will be delivered to the subscribers in the order in which they
+ *  are received by the Pub/Sub system. Otherwise, they may be delivered in
+ * any order.
+ */
 exports.BATCH_LIMITS = {
     maxBytes: Math.pow(1024, 2) * 9,
     maxMessages: 1000,
@@ -41,6 +53,10 @@ class Publisher {
         this.topic = topic;
         this.queue = new message_queues_1.Queue(this);
         this.orderedQueues = new Map();
+        this.tracing =
+            this.settings && this.settings.enableOpenTelemetryTracing
+                ? new opentelemetry_tracing_1.OpenTelemetryTracer()
+                : undefined;
     }
     /**
      * Immediately sends all remaining queued data. This is mostly useful
@@ -105,8 +121,12 @@ class Publisher {
 \nInvalid value of type "${typeof value}" provided for "${key}".`);
             }
         }
+        const span = this.constructSpan(message);
         if (!message.orderingKey) {
             this.queue.add(message, callback);
+            if (span) {
+                span.end();
+            }
             return;
         }
         const key = message.orderingKey;
@@ -117,6 +137,9 @@ class Publisher {
         }
         const queue = this.orderedQueues.get(key);
         queue.add(message, callback);
+        if (span) {
+            span.end();
+        }
     }
     /**
      * Indicates to the publisher that it is safe to continue publishing for the
@@ -150,8 +173,12 @@ class Publisher {
             gaxOpts: {
                 isBundling: false,
             },
+            enableOpenTelemetryTracing: false,
         };
-        const { batching, gaxOpts, messageOrdering } = extend(true, defaults, options);
+        const { batching, gaxOpts, messageOrdering, enableOpenTelemetryTracing, } = extend(true, defaults, options);
+        this.tracing = enableOpenTelemetryTracing
+            ? new opentelemetry_tracing_1.OpenTelemetryTracer()
+            : undefined;
         this.settings = {
             batching: {
                 maxBytes: Math.min(batching.maxBytes, exports.BATCH_LIMITS.maxBytes),
@@ -160,12 +187,39 @@ class Publisher {
             },
             gaxOpts,
             messageOrdering,
+            enableOpenTelemetryTracing,
+        };
+    }
+    /**
+     * Constructs an OpenTelemetry span
+     *
+     * @private
+     *
+     * @param {PubsubMessage} message The message to create a span for
+     */
+    constructSpan(message) {
+        const spanAttributes = {
+            data: message.data,
         };
+        const span = this.tracing
+            ? this.tracing.createSpan(`${this.topic.name} publisher`, spanAttributes)
+            : undefined;
+        if (span) {
+            if (message.attributes &&
+                message.attributes['googclient_OpenTelemetrySpanContext']) {
+                console.warn('googclient_OpenTelemetrySpanContext key set as message attribute, but will be overridden.');
+            }
+            if (!message.attributes) {
+                message.attributes = {};
+            }
+            message.attributes['googclient_OpenTelemetrySpanContext'] = JSON.stringify(span.context());
+        }
+        return span;
     }
 }
 exports.Publisher = Publisher;
 promisify_1.promisifyAll(Publisher, {
     singular: true,
-    exclude: ['publish', 'setOptions'],
+    exclude: ['publish', 'setOptions', 'constructSpan'],
 });
 //# 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;AAIjC,qDAAqD;AAIrD,wDAAkD;AAgBrC,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,EAAE,CAAC,CAAC;QACpD,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,EAAE,CAAC,CACvC,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,IAAI,CAAC,CAAC,IAAI,YAAY,MAAM,CAAC,EAAE;YAC7B,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;SAC9D;QAED,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAW,CAAC,EAAE;YAC1C,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,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE;YACxB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAClC,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;IAC/B,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;IACD;;;;;;OAMG;IACH,UAAU,CAAC,UAAU,EAAoB;QACvC,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;SACF,CAAC;QAEF,MAAM,EAAC,QAAQ,EAAE,OAAO,EAAE,eAAe,EAAC,GAAG,MAAM,CACjD,IAAI,EACJ,QAAQ,EACR,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,QAAQ,GAAG;YACd,QAAQ,EAAE;gBACR,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,EAAE,oBAAY,CAAC,QAAS,CAAC;gBAC7D,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,oBAAY,CAAC,WAAY,CAAC;gBACtE,eAAe,EAAE,QAAQ,CAAC,eAAe;aAC1C;YACD,OAAO;YACP,eAAe;SAChB,CAAC;IACJ,CAAC;CACF;AAlKD,8BAkKC;AAED,wBAAY,CAAC,SAAS,EAAE;IACtB,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE,CAAC,SAAS,EAAE,YAAY,CAAC;CACnC,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/publisher/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,uDAAgE;AAChE,iCAAiC;AAKjC,qDAAqD;AAIrD,wDAAkD;AAClD,oEAA6D;AAiB7D;;;;;;;;;;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;IAMpB,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;QAC/B,IAAI,CAAC,OAAO;YACV,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,0BAA0B;gBACvD,CAAC,CAAC,IAAI,2CAAmB,EAAE;gBAC3B,CAAC,CAAC,SAAS,CAAC;IAClB,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,EAAE,CAAC,CAAC;QACpD,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,EAAE,CAAC,CACvC,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,IAAI,CAAC,CAAC,IAAI,YAAY,MAAM,CAAC,EAAE;YAC7B,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;SAC9D;QAED,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAW,CAAC,EAAE;YAC1C,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;IACD;;;;;;OAMG;IACH,UAAU,CAAC,UAAU,EAAoB;QACvC,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,MAAM,EACJ,QAAQ,EACR,OAAO,EACP,eAAe,EACf,0BAA0B,GAC3B,GAAG,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAEpC,IAAI,CAAC,OAAO,GAAG,0BAA0B;YACvC,CAAC,CAAC,IAAI,2CAAmB,EAAE;YAC3B,CAAC,CAAC,SAAS,CAAC;QAEd,IAAI,CAAC,QAAQ,GAAG;YACd,QAAQ,EAAE;gBACR,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,EAAE,oBAAY,CAAC,QAAS,CAAC;gBAC7D,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,oBAAY,CAAC,WAAY,CAAC;gBACtE,eAAe,EAAE,QAAQ,CAAC,eAAe;aAC1C;YACD,OAAO;YACP,eAAe;YACf,0BAA0B;SAC3B,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,OAAsB;QAClC,MAAM,cAAc,GAAG;YACrB,IAAI,EAAE,OAAO,CAAC,IAAI;SACnB,CAAC;QACF,MAAM,IAAI,GAAqB,IAAI,CAAC,OAAO;YACzC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,YAAY,EAAE,cAAc,CAAC;YACzE,CAAC,CAAC,SAAS,CAAC;QACd,IAAI,IAAI,EAAE;YACR,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;YACD,OAAO,CAAC,UAAU,CAChB,qCAAqC,CACtC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAxND,8BAwNC;AAED,wBAAY,CAAC,SAAS,EAAE;IACtB,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,eAAe,CAAC;CACpD,CAAC,CAAC"}

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

@@ -21,11 +21,11 @@ export interface BatchPublishOptions {
 }
 /**
  * @typedef BatchPublishOptions
- * @property {number} [maxBytes=1024^2 * 5] The maximum number of bytes to
+ * @property {number} [maxBytes=1 * 1024 * 1024] The maximum number of bytes to
  *     buffer before sending a payload.
- * @property {number} [maxMessages=1000] The maximum number of messages to
+ * @property {number} [maxMessages=100] The maximum number of messages to
  *     buffer before sending a payload.
- * @property {number} [maxMilliseconds=100] The maximum duration to wait before
+ * @property {number} [maxMilliseconds=10] The maximum duration to wait before
  *     sending a payload.
  */
 /**

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

@@ -19,11 +19,11 @@ exports.MessageBatch = void 0;
 const _1 = require("./");
 /**
  * @typedef BatchPublishOptions
- * @property {number} [maxBytes=1024^2 * 5] The maximum number of bytes to
+ * @property {number} [maxBytes=1 * 1024 * 1024] The maximum number of bytes to
  *     buffer before sending a payload.
- * @property {number} [maxMessages=1000] The maximum number of messages to
+ * @property {number} [maxMessages=100] The maximum number of messages to
  *     buffer before sending a payload.
- * @property {number} [maxMilliseconds=100] The maximum duration to wait before
+ * @property {number} [maxMilliseconds=10] The maximum duration to wait before
  *     sending a payload.
  */
 /**

package/build/src/pubsub.d.ts

@@ -97,9 +97,11 @@ interface GetClientCallback {
  *     JSON file, the `projectId` option above is not necessary. NOTE: .pem and
  *     .p12 require you to specify the `email` option as well.
  * @property {string} [apiEndpoint] The `apiEndpoint` from options will set the
- *     host. If not set, the `PUBSUB_EMULATOR_HOST` environment variable from
- *     the gcloud SDK is honored, otherwise the actual API endpoint will be
- *     used.
+ *     host. If not set, the `PUBSUB_EMULATOR_HOST` environment variable from the
+ *     gcloud SDK is honored. We also check the `CLOUD_API_ENDPOINT_OVERRIDES_PUBSUB`
+ *     environment variable used by `gcloud alpha pubsub`. Otherwise the actual API
+ *     endpoint will be used. Note that if the URL doesn't end in '.googleapis.com',
+ *     we will assume that it's an emulator and disable strict SSL checks.
  * @property {string} [email] Account email address. Required when using a .pem
  *     or .p12 keyFilename.
  * @property {object} [credentials] Credentials object.
@@ -167,9 +169,14 @@ export declare class PubSub {
     detachSubscription(name: string, gaxOpts: CallOptions, callback: DetachSubscriptionCallback): void;
     /**
      * Determine the appropriate endpoint to use for API requests, first trying
-     * the local `apiEndpoint` parameter. If the `apiEndpoint` parameter is null
-     * we try Pub/Sub emulator environment variable (PUBSUB_EMULATOR_HOST),
-     * otherwise the default JSON API.
+     * the `apiEndpoint` parameter. If that isn't set, we try the Pub/Sub emulator
+     * environment variable (PUBSUB_EMULATOR_HOST). If that is also null, we try
+     * the standard `gcloud alpha pubsub` environment variable
+     * (CLOUDSDK_API_ENDPOINT_OVERRIDES_PUBSUB). Otherwise the default production
+     * API is used.
+     *
+     * Note that if the URL doesn't end in '.googleapis.com', we will assume that
+     * it's an emulator and disable strict SSL checks.
      *
      * @private
      */
@@ -286,6 +293,7 @@ export declare class PubSub {
      * @throws {Error} If a name is not provided.
      *
      * @param {string} name The name of the topic.
+     * @param {PublishOptions} [options] Publisher configuration object.
      * @returns {Topic} A {@link Topic} instance.
      *
      * @example