feat: Make INTERNAL a retryable error for Pull

.gitignore

@@ -1,11 +1,11 @@
 **/*.log
 **/node_modules
-.coverage
-coverage
-.nyc_output
-docs/
-out/
-build/
+/.coverage
+/coverage
+/.nyc_output
+/docs/
+/out/
+/build/
 system-test/secrets.js
 system-test/*key.json
 *.lock

protos/google/pubsub/v1/pubsub.proto

@@ -60,6 +60,7 @@ service Publisher {
       patch: "/v1/{topic.name=projects/*/topics/*}"
       body: "*"
     };
+    option (google.api.method_signature) = "topic,update_mask";
   }
 
   // Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic
@@ -214,7 +215,7 @@ message Topic {
   // timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time)
   // that is up to `message_retention_duration` in the past. If this field is
   // not set, message retention is controlled by settings on individual
-  // subscriptions. Cannot be more than 7 days or less than 10 minutes.
+  // subscriptions. Cannot be more than 31 days or less than 10 minutes.
   google.protobuf.Duration message_retention_duration = 8;
 }
 
@@ -461,6 +462,7 @@ service Subscriber {
       patch: "/v1/{subscription.name=projects/*/subscriptions/*}"
       body: "*"
     };
+    option (google.api.method_signature) = "subscription,update_mask";
   }
 
   // Lists matching subscriptions.
@@ -515,9 +517,7 @@ service Subscriber {
     option (google.api.method_signature) = "subscription,ack_ids";
   }
 
-  // Pulls messages from the server. The server may return `UNAVAILABLE` if
-  // there are too many concurrent pull requests pending for the given
-  // subscription.
+  // Pulls messages from the server.
   rpc Pull(PullRequest) returns (PullResponse) {
     option (google.api.http) = {
       post: "/v1/{subscription=projects/*/subscriptions/*}:pull"
@@ -554,10 +554,10 @@ service Subscriber {
   }
 
   // Gets the configuration details of a 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.
+  // [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 GetSnapshot(GetSnapshotRequest) returns (Snapshot) {
     option (google.api.http) = {
       get: "/v1/{snapshot=projects/*/snapshots/*}"
@@ -602,16 +602,16 @@ service Subscriber {
   }
 
   // Updates 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.
+  // [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 UpdateSnapshot(UpdateSnapshotRequest) returns (Snapshot) {
     option (google.api.http) = {
       patch: "/v1/{snapshot.name=projects/*/snapshots/*}"
       body: "*"
     };
+    option (google.api.method_signature) = "snapshot,update_mask";
   }
 
   // Removes an existing snapshot. Snapshots are used in [Seek]
@@ -645,7 +645,9 @@ service Subscriber {
   }
 }
 
-// A subscription resource.
+// A subscription resource. If none of `push_config` or `bigquery_config` is
+// set, then the subscriber will pull and ack messages using API methods. At
+// most one of these fields may be set.
 message Subscription {
   option (google.api.resource) = {
     type: "pubsub.googleapis.com/Subscription"
@@ -683,21 +685,17 @@ message Subscription {
   ];
 
   // If push delivery is used with this subscription, this field is
-  // used to configure it. Either `pushConfig` or `bigQueryConfig` can be set,
-  // but not both. If both are empty, then the subscriber will pull and ack
-  // messages using API methods.
+  // used to configure it.
   PushConfig push_config = 4;
 
   // If delivery to BigQuery is used with this subscription, this field is
-  // used to configure it. Either `pushConfig` or `bigQueryConfig` can be set,
-  // but not both. If both are empty, then the subscriber will pull and ack
-  // messages using API methods.
+  // used to configure it.
   BigQueryConfig bigquery_config = 18;
 
   // The approximate amount of time (on a best-effort basis) Pub/Sub waits for
   // the subscriber to acknowledge receipt before resending the message. In the
   // interval after the message is delivered and before it is acknowledged, it
-  // is considered to be <i>outstanding</i>. During that time period, the
+  // is considered to be _outstanding_. During that time period, the
   // message will not be redelivered (on a best-effort basis).
   //
   // For pull subscriptions, this value is used as the initial value for the ack
@@ -732,8 +730,8 @@ message Subscription {
   // minutes.
   google.protobuf.Duration message_retention_duration = 8;
 
-  // 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 = 9;
 
   // If true, messages published with the same `ordering_key` in `PubsubMessage`
@@ -922,7 +920,7 @@ message PushConfig {
   // * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
   //
   // For example:
-  // <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
+  // `attributes { "x-goog-version": "v1" }`
   map<string, string> attributes = 2;
 
   // An authentication method used by push endpoints to verify the source of
@@ -948,6 +946,11 @@ message BigQueryConfig {
     ACTIVE = 1;
 
     // Cannot write to the BigQuery table because of permission denied errors.
+    // This can happen if
+    // - Pub/Sub SA has not been granted the [appropriate BigQuery IAM
+    // permissions](https://cloud.google.com/pubsub/docs/create-subscription#assign_bigquery_service_account)
+    // - bigquery.googleapis.com API is not enabled for the project
+    // ([instructions](https://cloud.google.com/service-usage/docs/enable-disable))
     PERMISSION_DENIED = 2;
 
     // Cannot write to the BigQuery table because it does not exist.
@@ -958,7 +961,7 @@ message BigQueryConfig {
   }
 
   // The name of the table to which to write data, of the form
-  // {projectId}:{datasetId}.{tableId}
+  // {projectId}.{datasetId}.{tableId}
   string table = 1;
 
   // When true, use the topic's schema as the columns to write to in BigQuery,
@@ -1127,7 +1130,8 @@ message PullRequest {
 // Response for the `Pull` method.
 message PullResponse {
   // Received Pub/Sub messages. The list will be empty if there are no more
-  // messages available in the backlog. For JSON, the response can be entirely
+  // messages available in the backlog, or if no messages could be returned
+  // before the request timeout. For JSON, the response can be entirely
   // empty. The Pub/Sub system may return fewer than the `maxMessages` requested
   // even if there are more messages available in the backlog.
   repeated ReceivedMessage received_messages = 1;
@@ -1270,6 +1274,9 @@ message StreamingPullResponse {
 
     // List of acknowledgement IDs that were out of order.
     repeated string unordered_ack_ids = 3;
+
+    // List of acknowledgement IDs that failed processing with temporary issues.
+    repeated string temporary_failed_ack_ids = 4;
   }
 
   // Acknowledgement IDs sent in one or more previous requests to modify the
@@ -1281,21 +1288,23 @@ message StreamingPullResponse {
     // List of acknowledgement IDs that were malformed or whose acknowledgement
     // deadline has expired.
     repeated string invalid_ack_ids = 2;
+
+    // List of acknowledgement IDs that failed processing with temporary issues.
+    repeated string temporary_failed_ack_ids = 3;
   }
 
   // Subscription properties sent as part of the response.
   message SubscriptionProperties {
     // True iff exactly once delivery is enabled for this subscription.
     bool exactly_once_delivery_enabled = 1;
+
     // True iff message ordering is enabled for this subscription.
     bool message_ordering_enabled = 2;
   }
 
   // Received Pub/Sub messages. This will not be empty.
   repeated ReceivedMessage received_messages = 1;
 
-  reserved 2;
-
   // This field will only be set if `enable_exactly_once_delivery` is set to
   // `true`.
   AcknowledgeConfirmation acknowledge_confirmation = 5;
@@ -1313,9 +1322,9 @@ message CreateSnapshotRequest {
   // Required. User-provided name for this snapshot. 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. Note that for REST API requests, you
-  // must specify a name.  See the <a
-  // href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource
-  // name rules</a>. Format is `projects/{project}/snapshots/{snap}`.
+  // must specify a name.  See the [resource name
+  // rules](https://cloud.google.com/pubsub/docs/admin#resource_names). Format
+  // is `projects/{project}/snapshots/{snap}`.
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = { type: "pubsub.googleapis.com/Snapshot" }
@@ -1337,8 +1346,8 @@ message CreateSnapshotRequest {
     }
   ];
 
-  // 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 = 3;
 }
 

protos/google/pubsub/v1/schema.proto

@@ -320,17 +320,17 @@ message DeleteSchemaRevisionRequest {
   // Required. The name of the schema revision to be deleted, with a revision ID
   // explicitly included.
   //
-  // Example: projects/123/schemas/my-schema@c7cfa2a8
+  // Example: `projects/123/schemas/my-schema@c7cfa2a8`
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = { type: "pubsub.googleapis.com/Schema" }
   ];
 
-  // Required. The revision ID to roll back to.
-  // It must be a revision of the same schema.
-  //
-  //   Example: c7cfa2a8
-  string revision_id = 2 [(google.api.field_behavior) = REQUIRED];
+  // Optional. This field is deprecated and should not be used for specifying
+  // the revision ID. The revision ID should be specified via the `name`
+  // parameter.
+  string revision_id = 2
+      [deprecated = true, (google.api.field_behavior) = OPTIONAL];
 }
 
 // Request for the `DeleteSchema` method.