1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
use std::sync::Arc;
use google_cloud_gax::conn::Channel;
use google_cloud_gax::create_request;
use google_cloud_gax::grpc::Status;
use google_cloud_gax::grpc::{IntoStreamingRequest, Response, Streaming};
use google_cloud_gax::retry::{invoke, RetrySetting};
use google_cloud_googleapis::pubsub::v1::subscriber_client::SubscriberClient as InternalSubscriberClient;
use google_cloud_googleapis::pubsub::v1::{
AcknowledgeRequest, CreateSnapshotRequest, DeleteSnapshotRequest, DeleteSubscriptionRequest, GetSnapshotRequest,
GetSubscriptionRequest, ListSnapshotsRequest, ListSnapshotsResponse, ListSubscriptionsRequest,
ListSubscriptionsResponse, ModifyAckDeadlineRequest, ModifyPushConfigRequest, PullRequest, PullResponse,
SeekRequest, SeekResponse, Snapshot, StreamingPullRequest, StreamingPullResponse, Subscription,
UpdateSnapshotRequest, UpdateSubscriptionRequest,
};
use crate::apiv1::conn_pool::ConnectionManager;
use crate::apiv1::PUBSUB_MESSAGE_LIMIT;
pub(crate) fn create_empty_streaming_pull_request() -> StreamingPullRequest {
StreamingPullRequest {
subscription: "".to_string(),
ack_ids: vec![],
modify_deadline_seconds: vec![],
modify_deadline_ack_ids: vec![],
stream_ack_deadline_seconds: 0,
client_id: "".to_string(),
max_outstanding_messages: 0,
max_outstanding_bytes: 0,
}
}
#[derive(Clone, Debug)]
pub struct SubscriberClient {
cm: Arc<ConnectionManager>,
}
#[allow(dead_code)]
impl SubscriberClient {
/// create new Subscriber client
pub fn new(cm: ConnectionManager) -> SubscriberClient {
SubscriberClient { cm: Arc::new(cm) }
}
#[inline]
fn client(&self) -> InternalSubscriberClient<Channel> {
InternalSubscriberClient::new(self.cm.conn())
.max_decoding_message_size(PUBSUB_MESSAGE_LIMIT)
.max_encoding_message_size(PUBSUB_MESSAGE_LIMIT)
}
pub(crate) fn pool_size(&self) -> usize {
self.cm.num()
}
/// create_subscription creates a subscription to a given topic. See the [resource name rules]
/// (https://cloud.google.com/pubsub/docs/admin#resource_names (at 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 (at 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.
#[cfg_attr(feature = "trace", tracing::instrument(skip_all))]
pub async fn create_subscription(
&self,
req: Subscription,
retry: Option<RetrySetting>,
) -> Result<Response<Subscription>, Status> {
let name = &req.name;
let action = || async {
let mut client = self.client();
let request = create_request(format!("name={name}"), req.clone());
client.create_subscription(request).await
};
invoke(retry, action).await
}
/// updateSubscription updates an existing subscription. Note that certain properties of a
/// subscription, such as its topic, are not modifiable.
#[cfg_attr(feature = "trace", tracing::instrument(skip_all))]
pub async fn update_subscription(
&self,
req: UpdateSubscriptionRequest,
retry: Option<RetrySetting>,
) -> Result<Response<Subscription>, Status> {
let name = match &req.subscription {
Some(s) => s.name.as_str(),
None => "",
};
let action = || async {
let mut client = self.client();
let request = create_request(format!("subscription.name={name}"), req.clone());
client.update_subscription(request).await
};
invoke(retry, action).await
}
/// get_subscription gets the configuration details of a subscription.
#[cfg_attr(feature = "trace", tracing::instrument(skip_all))]
pub async fn get_subscription(
&self,
req: GetSubscriptionRequest,
retry: Option<RetrySetting>,
) -> Result<Response<Subscription>, Status> {
let subscription = &req.subscription;
let action = || async {
let mut client = self.client();
let request = create_request(format!("subscription={subscription}"), req.clone());
client.get_subscription(request).await
};
invoke(retry, action).await
}
/// list_subscriptions lists matching subscriptions.
#[cfg_attr(feature = "trace", tracing::instrument(skip_all))]
pub async fn list_subscriptions(
&self,
mut req: ListSubscriptionsRequest,
retry: Option<RetrySetting>,
) -> Result<Vec<Subscription>, Status> {
let project = &req.project;
let mut all = vec![];
//eager loading
loop {
let action = || async {
let mut client = self.client();
let request = create_request(format!("project={project}"), req.clone());
client.list_subscriptions(request).await.map(|d| d.into_inner())
};
let response: ListSubscriptionsResponse = invoke(retry.clone(), action).await?;
all.extend(response.subscriptions.into_iter());
if response.next_page_token.is_empty() {
return Ok(all);
}
req.page_token = response.next_page_token;
}
}
/// delete_subscription deletes an existing subscription. All messages retained in the subscription
/// are immediately dropped. Calls to Pull after deletion will return
/// NOT_FOUND. After a subscription is deleted, a new one may be created with
/// the same name, but the new one has no association with the old
/// subscription or its topic unless the same topic is specified.
#[cfg_attr(feature = "trace", tracing::instrument(skip_all))]
pub async fn delete_subscription(
&self,
req: DeleteSubscriptionRequest,
retry: Option<RetrySetting>,
) -> Result<Response<()>, Status> {
let subscription = &req.subscription;
let action = || async {
let mut client = self.client();
let request = create_request(format!("subscription={subscription}"), req.clone());
client.delete_subscription(request).await
};
invoke(retry, action).await
}
/// ModifyAckDeadline modifies the ack deadline for a specific message. This method is useful
/// to indicate that more time is needed to process a message by the
/// subscriber, or to make the message available for redelivery if the
/// processing was interrupted. Note that this does not modify the
/// subscription-level ackDeadlineSeconds used for subsequent messages.
#[cfg_attr(feature = "trace", tracing::instrument(skip_all))]
pub async fn modify_ack_deadline(
&self,
req: ModifyAckDeadlineRequest,
retry: Option<RetrySetting>,
) -> Result<Response<()>, Status> {
let subscription = &req.subscription;
let action = || async {
let mut client = self.client();
let request = create_request(format!("subscription={subscription}"), req.clone());
client.modify_ack_deadline(request).await
};
invoke(retry, action).await
}
/// acknowledge acknowledges the messages associated with the ack_ids in the
/// AcknowledgeRequest. The Pub/Sub system can remove the relevant messages
/// from the subscription.
///
/// Acknowledging a message whose ack deadline has expired may succeed,
/// but such a message may be redelivered later. Acknowledging a message more
/// than once will not result in an error.
#[cfg_attr(feature = "trace", tracing::instrument(skip_all))]
pub async fn acknowledge(
&self,
req: AcknowledgeRequest,
retry: Option<RetrySetting>,
) -> Result<Response<()>, Status> {
let subscription = &req.subscription;
let action = || async {
let mut client = self.client();
let request = create_request(format!("subscription={subscription}"), req.clone());
client.acknowledge(request).await
};
invoke(retry, action).await
}
/// pull pulls messages from the server. The server may return UNAVAILABLE if
/// there are too many concurrent pull requests pending for the given
/// subscription.
#[cfg_attr(feature = "trace", tracing::instrument(skip_all))]
pub async fn pull(&self, req: PullRequest, retry: Option<RetrySetting>) -> Result<Response<PullResponse>, Status> {
let subscription = &req.subscription;
let action = || async {
let mut client = self.client();
let request = create_request(format!("subscription={subscription}"), req.clone());
client.pull(request).await
};
invoke(retry, action).await
}
/// streaming_pull establishes a stream with the server, which sends messages down to the
/// client. The client streams acknowledgements and ack deadline modifications
/// back to the server. The server will close the stream and return the status
/// on any error. The server may close the stream with status UNAVAILABLE to
/// reassign server-side resources, in which case, the client should
/// re-establish the stream. Flow control can be achieved by configuring the
/// underlying RPC channel.
#[cfg_attr(feature = "trace", tracing::instrument(skip_all))]
pub async fn streaming_pull(
&self,
req: StreamingPullRequest,
ping_receiver: async_channel::Receiver<bool>,
retry: Option<RetrySetting>,
) -> Result<Response<Streaming<StreamingPullResponse>>, Status> {
let action = || async {
let mut client = self.client();
let base_req = req.clone();
let rx = ping_receiver.clone();
let request = Box::pin(async_stream::stream! {
yield base_req.clone();
// ping message.
// must be empty request
while let Ok(_r) = rx.recv().await {
yield create_empty_streaming_pull_request();
}
});
let mut v = request.into_streaming_request();
let target = v.metadata_mut();
target.append(
"x-goog-request-params",
format!("subscription={}", req.subscription).parse().unwrap(),
);
client.streaming_pull(v).await
};
invoke(retry, action).await
}
/// modify_push_config modifies the PushConfig for a specified subscription.
///
/// This may be used to change a push subscription to a pull one (signified by
/// an empty PushConfig) or vice versa, or change the endpoint URL and other
/// attributes of a push subscription. Messages will accumulate for delivery
/// continuously through the call regardless of changes to the PushConfig.
#[cfg_attr(feature = "trace", tracing::instrument(skip_all))]
pub async fn modify_push_config(
&self,
req: ModifyPushConfigRequest,
retry: Option<RetrySetting>,
) -> Result<Response<()>, Status> {
let subscription = &req.subscription;
let action = || async {
let mut client = self.client();
let request = create_request(format!("subscription={subscription}"), req.clone());
client.modify_push_config(request).await
};
invoke(retry, action).await
}
/// get_snapshot gets the configuration details of a snapshot. Snapshots are used in
/// Seek (at 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
#[cfg_attr(feature = "trace", tracing::instrument(skip_all))]
pub async fn get_snapshot(
&self,
req: GetSnapshotRequest,
retry: Option<RetrySetting>,
) -> Result<Response<Snapshot>, Status> {
let snapshot = &req.snapshot;
let action = || async {
let mut client = self.client();
let request = create_request(format!("snapshot={snapshot}"), req.clone());
client.get_snapshot(request).await
};
invoke(retry, action).await
}
/// list_snapshots lists the existing snapshots. Snapshots are used in Seek (at 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.
#[cfg_attr(feature = "trace", tracing::instrument(skip_all))]
pub async fn list_snapshots(
&self,
mut req: ListSnapshotsRequest,
retry: Option<RetrySetting>,
) -> Result<Vec<Snapshot>, Status> {
let project = &req.project;
let mut all = vec![];
//eager loading
loop {
let action = || async {
let mut client = self.client();
let request = create_request(format!("project={project}"), req.clone());
client.list_snapshots(request).await.map(|d| d.into_inner())
};
let response: ListSnapshotsResponse = invoke(retry.clone(), action).await?;
all.extend(response.snapshots.into_iter());
if response.next_page_token.is_empty() {
return Ok(all);
}
req.page_token = response.next_page_token;
}
}
/// create_snapshot creates a snapshot from the requested subscription. Snapshots are used in
/// Seek (at 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 (at 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.
#[cfg_attr(feature = "trace", tracing::instrument(skip_all))]
pub async fn create_snapshot(
&self,
req: CreateSnapshotRequest,
retry: Option<RetrySetting>,
) -> Result<Response<Snapshot>, Status> {
let name = &req.name;
let action = || async {
let mut client = self.client();
let request = create_request(format!("name={name}"), req.clone());
client.create_snapshot(request).await
};
invoke(retry, action).await
}
/// update_snapshot updates an existing snapshot. Snapshots are used in
/// Seek (at 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.
#[cfg_attr(feature = "trace", tracing::instrument(skip_all))]
pub async fn update_snapshot(
&self,
req: UpdateSnapshotRequest,
retry: Option<RetrySetting>,
) -> Result<Response<Snapshot>, Status> {
let name = match &req.snapshot {
Some(v) => v.name.as_str(),
None => "",
};
let action = || async {
let mut client = self.client();
let request = create_request(format!("snapshot.name={name}"), req.clone());
client.update_snapshot(request).await
};
invoke(retry, action).await
}
/// delete_snapshot removes an existing snapshot. Snapshots are used in [Seek]
/// (https://cloud.google.com/pubsub/docs/replay-overview (at 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
/// snapshot or its subscription, unless the same subscription is specified.
#[cfg_attr(feature = "trace", tracing::instrument(skip_all))]
pub async fn delete_snapshot(
&self,
req: DeleteSnapshotRequest,
retry: Option<RetrySetting>,
) -> Result<Response<()>, Status> {
let name = &req.snapshot;
let action = || async {
let mut client = self.client();
let request = create_request(format!("snapshot={name}"), req.clone());
client.delete_snapshot(request).await
};
invoke(retry, action).await
}
// seek [seeks](https://cloud.google.com/pubsub/docs/replay-overview) a subscription to
// a point back in time (with a TimeStamp) or to a saved snapshot.
pub async fn seek(&self, req: SeekRequest, retry: Option<RetrySetting>) -> Result<Response<SeekResponse>, Status> {
let action = || async {
let mut client = self.client();
let subscription = req.subscription.clone();
let request = create_request(format!("subscription={subscription}"), req.clone());
client.seek(request).await
};
invoke(retry, action).await
}
}