GoogleCloudPlatform / GoogleCloudPlatform/spring-cloud-gcp

Kotlin Pub/Sub sample doesn't mention the need to "debounce"

Open
#1,060 1 comment 0 reactions 0 assignees View on GitHub
documentation priority: p3 type: enhancement
Dominant language
Java
Stars
551
Forks
349
Avg merge
1d 13h
Merged PRs (30d)
14

Description

https://github.com/GoogleCloudPlatform/spring-cloud-gcp/blob/main/spring-cloud-gcp-samples/spring-cloud-gcp-kotlin-samples/spring-cloud-gcp-kotlin-app-sample/src/main/kotlin/com/example/app/PubSubConfiguration.kt

**Describe the bug**
Our Pub/Sub service is really good at making sure that a message is delivered at least once to a subscriber, but messages can be delivered many times, this is non-intuitive and not mentioning it will confuse developers.

There are two possible fixes:
1. Mention it in the comments that you may get the same message many times.
2. Better would be to have some mechanism to debounce (recognize & ignore duplicate messages) so that developers see a way around this.

Contributor guide

Open the contributing guide

Research direction

Start with spring-cloud-gcp-samples/spring-cloud-gcp-kotlin-samples/spring-cloud-gcp-kotlin-app-sample/src/main/kotlin/com/example/app/PubSubConfiguration.kt. Read the Pub/Sub configuration and determine whether the sample should only document at-least-once delivery or also demonstrate duplicate-message handling; done means the chosen behavior is clear to developers and duplicate delivery is addressed without ambiguity.

Written by the indexing model from the issue text.

Assessment

Tech stack
google-cloud, kotlin, spring
Domain
backend, distributed-systems, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.