/
example_test.go
399 lines (364 loc) · 12.8 KB
/
example_test.go
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
// 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
//
// https://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
package pscompat_test
import (
"context"
"fmt"
"sync"
"time"
"cloud.google.com/go/pubsub"
"cloud.google.com/go/pubsublite/pscompat"
"golang.org/x/sync/errgroup"
"golang.org/x/xerrors"
)
func ExamplePublisherClient_Publish() {
ctx := context.Background()
const topic = "projects/my-project/locations/zone/topics/my-topic"
publisher, err := pscompat.NewPublisherClient(ctx, topic)
if err != nil {
// TODO: Handle error.
}
defer publisher.Stop()
var results []*pubsub.PublishResult
r := publisher.Publish(ctx, &pubsub.Message{
Data: []byte("hello world"),
})
results = append(results, r)
// Publish more messages ...
var publishFailed bool
for _, r := range results {
id, err := r.Get(ctx)
if err != nil {
// TODO: Handle error.
publishFailed = true
continue
}
fmt.Printf("Published a message with a message ID: %s\n", id)
}
// NOTE: A failed PublishResult indicates that the publisher client
// encountered a fatal error and has permanently terminated. After the fatal
// error has been resolved, a new publisher client instance must be created to
// republish failed messages.
if publishFailed {
fmt.Printf("Publisher client terminated due to error: %v\n", publisher.Error())
}
}
// This example illustrates how to set batching settings for publishing. Note
// that batching settings apply per partition. If BufferedByteLimit is being
// used to bound memory usage, keep in mind the number of partitions in the
// topic.
func ExamplePublisherClient_Publish_batchingSettings() {
ctx := context.Background()
const topic = "projects/my-project/locations/zone/topics/my-topic"
settings := pscompat.PublishSettings{
DelayThreshold: 50 * time.Millisecond,
CountThreshold: 200,
BufferedByteLimit: 5e8,
}
publisher, err := pscompat.NewPublisherClientWithSettings(ctx, topic, settings)
if err != nil {
// TODO: Handle error.
}
defer publisher.Stop()
var results []*pubsub.PublishResult
r := publisher.Publish(ctx, &pubsub.Message{
Data: []byte("hello world"),
})
results = append(results, r)
// Publish more messages ...
var publishFailed bool
for _, r := range results {
id, err := r.Get(ctx)
if err != nil {
// TODO: Handle error.
publishFailed = true
continue
}
fmt.Printf("Published a message with a message ID: %s\n", id)
}
// NOTE: A failed PublishResult indicates that the publisher client
// encountered a fatal error and has permanently terminated. After the fatal
// error has been resolved, a new publisher client instance must be created to
// republish failed messages.
if publishFailed {
fmt.Printf("Publisher client terminated due to error: %v\n", publisher.Error())
}
}
// This example illustrates how to handle various publishing errors. Some errors
// can be automatically handled (e.g. backend unavailable and buffer overflow),
// while others are fatal errors that should be inspected.
// If the application has a low tolerance to backend unavailability, set a lower
// PublishSettings.Timeout value to detect and alert.
func ExamplePublisherClient_Publish_errorHandling() {
ctx := context.Background()
const topic = "projects/my-project/locations/zone/topics/my-topic"
settings := pscompat.PublishSettings{
// The PublisherClient will terminate when it cannot connect to backends for
// more than 10 minutes.
Timeout: 10 * time.Minute,
// Sets a conservative publish buffer byte limit, per partition.
BufferedByteLimit: 1e8,
}
publisher, err := pscompat.NewPublisherClientWithSettings(ctx, topic, settings)
if err != nil {
// TODO: Handle error.
}
defer publisher.Stop()
var toRepublish []*pubsub.Message
var mu sync.Mutex
g := new(errgroup.Group)
for i := 0; i < 10; i++ {
msg := &pubsub.Message{
Data: []byte(fmt.Sprintf("message-%d", i)),
}
result := publisher.Publish(ctx, msg)
g.Go(func() error {
id, err := result.Get(ctx)
if err != nil {
// NOTE: A failed PublishResult indicates that the publisher client has
// permanently terminated. A new publisher client instance must be
// created to republish failed messages.
fmt.Printf("Publish error: %v\n", err)
// Oversized messages cannot be published.
if !xerrors.Is(err, pscompat.ErrOversizedMessage) {
mu.Lock()
toRepublish = append(toRepublish, msg)
mu.Unlock()
}
return err
}
fmt.Printf("Published a message with a message ID: %s\n", id)
return nil
})
}
if err := g.Wait(); err != nil {
fmt.Printf("Publisher client terminated due to error: %v\n", publisher.Error())
switch {
case xerrors.Is(publisher.Error(), pscompat.ErrBackendUnavailable):
// TODO: Create a new publisher client to republish failed messages.
case xerrors.Is(publisher.Error(), pscompat.ErrOverflow):
// TODO: Create a new publisher client to republish failed messages.
// Throttle publishing. Note that backend unavailability can also cause
// buffer overflow before the ErrBackendUnavailable error.
default:
// TODO: Inspect and handle fatal error.
}
}
}
func ExampleSubscriberClient_Receive() {
ctx := context.Background()
const subscription = "projects/my-project/locations/zone/subscriptions/my-subscription"
subscriber, err := pscompat.NewSubscriberClient(ctx, subscription)
if err != nil {
// TODO: Handle error.
}
cctx, cancel := context.WithCancel(ctx)
err = subscriber.Receive(cctx, func(ctx context.Context, m *pubsub.Message) {
// TODO: Handle message.
// NOTE: May be called concurrently; synchronize access to shared memory.
m.Ack()
})
if err != nil {
// TODO: Handle error.
}
// Call cancel from the receiver callback or another goroutine to stop
// receiving.
cancel()
}
// If the application has a low tolerance to backend unavailability, set a lower
// ReceiveSettings.Timeout value to detect and alert.
func ExampleSubscriberClient_Receive_errorHandling() {
ctx := context.Background()
const subscription = "projects/my-project/locations/zone/subscriptions/my-subscription"
settings := pscompat.ReceiveSettings{
// The SubscriberClient will terminate when it cannot connect to backends
// for more than 5 minutes.
Timeout: 5 * time.Minute,
}
subscriber, err := pscompat.NewSubscriberClientWithSettings(ctx, subscription, settings)
if err != nil {
// TODO: Handle error.
}
for {
cctx, cancel := context.WithCancel(ctx)
err = subscriber.Receive(cctx, func(ctx context.Context, m *pubsub.Message) {
// TODO: Handle message.
// NOTE: May be called concurrently; synchronize access to shared memory.
m.Ack()
})
if err != nil {
fmt.Printf("Subscriber client stopped receiving due to error: %v\n", err)
if xerrors.Is(err, pscompat.ErrBackendUnavailable) {
// TODO: Alert if necessary. Receive can be retried.
} else {
// TODO: Handle fatal error.
break
}
}
// Call cancel from the receiver callback or another goroutine to stop
// receiving.
cancel()
}
}
// This example shows how to throttle SubscriberClient.Receive, which aims for
// high throughput by default. By limiting the number of messages and/or bytes
// being processed at once, you can bound your program's resource consumption.
// Note that ReceiveSettings apply per partition, so keep in mind the number of
// partitions in the associated topic.
func ExampleSubscriberClient_Receive_maxOutstanding() {
ctx := context.Background()
const subscription = "projects/my-project/locations/zone/subscriptions/my-subscription"
settings := pscompat.ReceiveSettings{
MaxOutstandingMessages: 5,
MaxOutstandingBytes: 10e6,
}
subscriber, err := pscompat.NewSubscriberClientWithSettings(ctx, subscription, settings)
if err != nil {
// TODO: Handle error.
}
cctx, cancel := context.WithCancel(ctx)
err = subscriber.Receive(cctx, func(ctx context.Context, m *pubsub.Message) {
// TODO: Handle message.
// NOTE: May be called concurrently; synchronize access to shared memory.
m.Ack()
})
if err != nil {
// TODO: Handle error.
}
// Call cancel from the receiver callback or another goroutine to stop
// receiving.
cancel()
}
// This example shows how to manually assign which topic partitions a
// SubscriberClient should connect to. If not specified, the SubscriberClient
// will use Pub/Sub Lite's partition assignment service to automatically
// determine which partitions it should connect to.
func ExampleSubscriberClient_Receive_manualPartitionAssignment() {
ctx := context.Background()
const subscription = "projects/my-project/locations/zone/subscriptions/my-subscription"
settings := pscompat.ReceiveSettings{
// NOTE: The corresponding topic must have 2 or more partitions.
Partitions: []int{0, 1},
}
subscriber, err := pscompat.NewSubscriberClientWithSettings(ctx, subscription, settings)
if err != nil {
// TODO: Handle error.
}
cctx, cancel := context.WithCancel(ctx)
err = subscriber.Receive(cctx, func(ctx context.Context, m *pubsub.Message) {
// TODO: Handle message.
// NOTE: May be called concurrently; synchronize access to shared memory.
m.Ack()
})
if err != nil {
// TODO: Handle error.
}
// Call cancel from the receiver callback or another goroutine to stop
// receiving.
cancel()
}
// This example illustrates how to declare a common interface for publisher
// clients from Cloud Pub/Sub (cloud.google.com/go/pubsub) and Pub/Sub Lite
// (cloud.google.com/go/pubsublite/pscompat).
func ExampleNewPublisherClient_interface() {
// publisherInterface is implemented by both pscompat.PublisherClient and
// pubsub.Topic.
type publisherInterface interface {
Publish(context.Context, *pubsub.Message) *pubsub.PublishResult
Stop()
}
publish := func(publisher publisherInterface) {
defer publisher.Stop()
// TODO: Publish messages.
}
// Create a Pub/Sub Lite publisher client.
ctx := context.Background()
publisher, err := pscompat.NewPublisherClient(ctx, "projects/my-project/locations/zone/topics/my-topic")
if err != nil {
// TODO: Handle error.
}
publish(publisher)
// Create a Cloud Pub/Sub topic to publish.
client, err := pubsub.NewClient(ctx, "my-project")
if err != nil {
// TODO: Handle error.
}
topic := client.Topic("my-topic")
publish(topic)
}
// This example illustrates how to declare a common interface for subscriber
// clients from Cloud Pub/Sub (cloud.google.com/go/pubsub) and Pub/Sub Lite
// (cloud.google.com/go/pubsublite/pscompat).
func ExampleNewSubscriberClient_interface() {
// subscriberInterface is implemented by both pscompat.SubscriberClient and
// pubsub.Subscription.
type subscriberInterface interface {
Receive(context.Context, func(context.Context, *pubsub.Message)) error
}
receive := func(subscriber subscriberInterface) {
// TODO: Receive messages.
}
// Create a Pub/Sub Lite subscriber client.
ctx := context.Background()
subscriber, err := pscompat.NewSubscriberClient(ctx, "projects/my-project/locations/zone/subscriptions/my-subscription")
if err != nil {
// TODO: Handle error.
}
receive(subscriber)
// Create a Cloud Pub/Sub subscription to receive.
client, err := pubsub.NewClient(ctx, "my-project")
if err != nil {
// TODO: Handle error.
}
subscription := client.Subscription("my-subscription")
receive(subscription)
}
func ExampleParseMessageMetadata_publisher() {
ctx := context.Background()
const topic = "projects/my-project/locations/zone/topics/my-topic"
publisher, err := pscompat.NewPublisherClient(ctx, topic)
if err != nil {
// TODO: Handle error.
}
defer publisher.Stop()
result := publisher.Publish(ctx, &pubsub.Message{Data: []byte("payload")})
id, err := result.Get(ctx)
if err != nil {
// TODO: Handle error.
}
metadata, err := pscompat.ParseMessageMetadata(id)
if err != nil {
// TODO: Handle error.
}
fmt.Printf("Published message to partition %d with offset %d\n", metadata.Partition, metadata.Offset)
}
func ExampleParseMessageMetadata_subscriber() {
ctx := context.Background()
const subscription = "projects/my-project/locations/zone/subscriptions/my-subscription"
subscriber, err := pscompat.NewSubscriberClient(ctx, subscription)
if err != nil {
// TODO: Handle error.
}
err = subscriber.Receive(ctx, func(ctx context.Context, m *pubsub.Message) {
// TODO: Handle message.
m.Ack()
metadata, err := pscompat.ParseMessageMetadata(m.ID)
if err != nil {
// TODO: Handle error.
}
fmt.Printf("Received message from partition %d with offset %d\n", metadata.Partition, metadata.Offset)
})
if err != nil {
// TODO: Handle error.
}
}