Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(config): relax ClientID validation after 1.0.0 #2706

Merged
merged 1 commit into from
Nov 7, 2023

Conversation

dnwe
Copy link
Collaborator

@dnwe dnwe commented Nov 3, 2023

The original validation regex was based on the one that existed in the Java clients pre-1.0.0 but KIP-190 removed the client-side validation because instead the brokers were updated to be able to cope with any clientID and sanitize it before using it in metrics etc.

We can do similar in Sarama and only do client-side validation when the user has specified a version number older than 1.0.0

Fixes #2697

@dnwe dnwe force-pushed the dnwe/relax-clientid-validation branch 2 times, most recently from 0039ce6 to e150560 Compare November 4, 2023 11:11
Copy link
Collaborator

@hindessm hindessm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

The original validation regex was based on the one that existed in the
Java clients pre-1.0.0 but KIP-190 removed the client-side validation
because instead the brokers were updated to be able to cope with any
clientID and sanitize it before using it in metrics etc.

We can do similar in Sarama and only do client-side validation when the
user has specified a version number older than 1.0.0

Fixes #2697

Signed-off-by: Dominic Evans <dominic.evans@uk.ibm.com>
@dnwe dnwe force-pushed the dnwe/relax-clientid-validation branch from e150560 to c08d93e Compare November 7, 2023 09:41
@dnwe dnwe added the fix label Nov 7, 2023
@dnwe dnwe merged commit 385b3b4 into main Nov 7, 2023
13 checks passed
@dnwe dnwe deleted the dnwe/relax-clientid-validation branch November 7, 2023 11:20
candiduslynx added a commit to cloudquery/cloudquery that referenced this pull request Jun 12, 2024
kodiakhq bot pushed a commit to cloudquery/cloudquery that referenced this pull request Jun 13, 2024
paologallinaharbur pushed a commit to newrelic/nri-kafka that referenced this pull request Aug 26, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [github.com/IBM/sarama](https://togithub.com/IBM/sarama) | `v1.41.3`
-> `v1.43.3` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fIBM%2fsarama/v1.43.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fIBM%2fsarama/v1.43.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fIBM%2fsarama/v1.41.3/v1.43.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fIBM%2fsarama/v1.41.3/v1.43.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>IBM/sarama (github.com/IBM/sarama)</summary>

### [`v1.43.3`](https://togithub.com/IBM/sarama/releases/tag/v1.43.3):
Version 1.43.3 (2024-08-12)

[Compare
Source](https://togithub.com/IBM/sarama/compare/v1.43.2...v1.43.3)

<!-- Release notes generated using configuration in .github/release.yaml
at main -->

#### What's Changed

##### 🐛 Fixes

- fix: declare assignor variable for examples & clean up log format by
[@&#8203;kumakichi](https://togithub.com/kumakichi) in
[IBM/sarama#2909
- fix(consumer): maintain ordering of offset commit requests by
[@&#8203;prestona](https://togithub.com/prestona) in
[IBM/sarama#2947
- fix(producer): treat ErrKafkaStorageError as retriable by
[@&#8203;richardartoul](https://togithub.com/richardartoul) in
[IBM/sarama#2939

##### 📦 Dependency updates

- chore(deps): bump the golang-org-x group across 1 directory with 2
updates by [@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2956
- chore(deps): bump github.com/eapache/go-resiliency from 1.6.0 to 1.7.0
by [@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2944
- chore(deps): bump github.com/klauspost/compress from 1.17.8 to 1.17.9
by [@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2926

##### 🔧 Maintenance

- fix(ci): correct docker-compose install by
[@&#8203;dnwe](https://togithub.com/dnwe) in
[IBM/sarama#2954

##### 📝 Documentation

- fix(doc): correct JVM's config name corresponding to MaxWaitTime by
[@&#8203;abhipranay](https://togithub.com/abhipranay) in
[IBM/sarama#2893

#### New Contributors

- [@&#8203;abhipranay](https://togithub.com/abhipranay) made their first
contribution in
[IBM/sarama#2893
- [@&#8203;kumakichi](https://togithub.com/kumakichi) made their first
contribution in
[IBM/sarama#2909
- [@&#8203;richardartoul](https://togithub.com/richardartoul) made their
first contribution in
[IBM/sarama#2939

**Full Changelog**:
IBM/sarama@v1.43.2...v1.43.3

### [`v1.43.2`](https://togithub.com/IBM/sarama/releases/tag/v1.43.2):
Version 1.43.2 (2024-04-25)

[Compare
Source](https://togithub.com/IBM/sarama/compare/v1.43.1...v1.43.2)

<!-- Release notes generated using configuration in .github/release.yaml
at main -->

#### What's Changed

##### 🐛 Fixes

- chore(ci): add 32-bit alignment check by
[@&#8203;dnwe](https://togithub.com/dnwe) in
[IBM/sarama#2874

##### 📦 Dependency updates

- chore(deps): bump golang.org/x/net from 0.21.0 to 0.23.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2866
- chore(deps): bump the golang-org-x group with 2 updates by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2853
- chore(deps): bump github.com/klauspost/compress from 1.17.7 to 1.17.8
by [@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2857
- chore(deps): bump golang.org/x/net from 0.21.0 to 0.23.0 in
/examples/txn_producer in the go_modules group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2865
- chore(deps): bump golang.org/x/net from 0.21.0 to 0.23.0 in
/examples/consumergroup in the go_modules group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2867
- chore(deps): bump golang.org/x/net from 0.21.0 to 0.23.0 in
/examples/exactly_once in the go_modules group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2868
- chore(deps): bump golang.org/x/net from 0.22.0 to 0.23.0 in
/examples/interceptors in the go_modules group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2869

**Full Changelog**:
IBM/sarama@v1.43.1...v1.43.2

### [`v1.43.1`](https://togithub.com/IBM/sarama/releases/tag/v1.43.1):
Version 1.43.1 (2024-03-27)

[Compare
Source](https://togithub.com/IBM/sarama/compare/v1.43.0...v1.43.1)

<!-- Release notes generated using configuration in .github/release.yaml
at main -->

#### What's Changed

##### 🐛 Fixes

- fix: message.max.bytes should default to
[`1048576`](https://togithub.com/IBM/sarama/commit/1048576) not 1 MB by
[@&#8203;puellanivis](https://togithub.com/puellanivis) in
[IBM/sarama#2804
- fix: add locking around broker throttle timer to prevent race
condition by [@&#8203;chengsha](https://togithub.com/chengsha) in
[IBM/sarama#2826

##### 📦 Dependency updates

- chore(deps): bump go.opentelemetry.io/otel/sdk from 1.23.1 to 1.24.0
in /examples/interceptors by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2816
- chore(deps): bump the golang-org-x group with 1 update by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2825
- chore(deps): bump github.com/stretchr/testify from 1.8.4 to 1.9.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2822
- chore(deps): bump
go.opentelemetry.io/otel/exporters/stdout/stdoutmetric from 1.23.1 to
1.24.0 in /examples/interceptors by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2815

#### New Contributors

- [@&#8203;chengsha](https://togithub.com/chengsha) made their first
contribution in
[IBM/sarama#2826

**Full Changelog**:
IBM/sarama@v1.43.0...v1.43.1

### [`v1.43.0`](https://togithub.com/IBM/sarama/releases/tag/v1.43.0):
Version 1.43.0 (2024-02-22)

[Compare
Source](https://togithub.com/IBM/sarama/compare/v1.42.2...v1.43.0)

<!-- Release notes generated using configuration in .github/release.yaml
at main -->

> \[!NOTE]\
> The go.mod directive has been bumped to 1.19 as the minimum version of
Go required for the module. This was necessary to continue to receive
updates from some of the third party dependencies that Sarama makes use
of for compression.

#### What's Changed

##### 🎉 New Features / Improvements

- feat: update go directive to 1.19 by
[@&#8203;dnwe](https://togithub.com/dnwe) in
[IBM/sarama#2795
- feat: add BuildSpnFunc to GSSAPIConfig for allow custom spn by
[@&#8203;fooofei](https://togithub.com/fooofei) in
[IBM/sarama#2807

##### 🐛 Fixes

- Use %v formatting words and remove unnecessary newline by
[@&#8203;puellanivis](https://togithub.com/puellanivis) in
[IBM/sarama#2802

##### 📦 Dependency updates

- chore(deps): bump github.com/klauspost/compress from 1.16.7 to 1.17.6
by [@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2784
- chore(deps): bump github.com/eapache/go-resiliency from 1.5.0 to 1.6.0
by [@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2810
- chore(deps): bump github.com/klauspost/compress from 1.17.6 to 1.17.7
by [@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2811

##### 🔧 Maintenance

- chore(doc): add v1.42.2 to CHANGELOG.md by
[@&#8203;dnwe](https://togithub.com/dnwe) in
[IBM/sarama#2796

#### New Contributors

- [@&#8203;puellanivis](https://togithub.com/puellanivis) made their
first contribution in
[IBM/sarama#2802
- [@&#8203;fooofei](https://togithub.com/fooofei) made their first
contribution in
[IBM/sarama#2807

**Full Changelog**:
IBM/sarama@v1.42.2...v1.43.0

### [`v1.42.2`](https://togithub.com/IBM/sarama/releases/tag/v1.42.2):
Version 1.42.2 (2024-02-09)

[Compare
Source](https://togithub.com/IBM/sarama/compare/v1.42.1...v1.42.2)

<!-- Release notes generated using configuration in .github/release.yaml
at main -->

#### What's Changed

> \[!NOTE]\
> The go.mod directive has been bumped to 1.18 as the minimum version of
Go required for the module. This was necessary to continue to receive
updates from some of the third party dependencies that Sarama makes use
of for compression.

##### 🎉 New Features / Improvements

- feat: update go directive to 1.18 by
[@&#8203;dnwe](https://togithub.com/dnwe) in
[IBM/sarama#2713
- feat: return KError instead of errors in AlterConfigs and
DescribeConfig by [@&#8203;zhuliquan](https://togithub.com/zhuliquan) in
[IBM/sarama#2472

##### 🐛 Fixes

- fix: don't waste time for backoff on member id required error by
[@&#8203;lzakharov](https://togithub.com/lzakharov) in
[IBM/sarama#2759
- fix: prevent ConsumerGroup.Close infinitely locking by
[@&#8203;maqdev](https://togithub.com/maqdev) in
[IBM/sarama#2717

##### 📦 Dependency updates

- chore(deps): bump golang.org/x/net from 0.17.0 to 0.18.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2716
- chore(deps): bump golang.org/x/sync to v0.5.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2718
- chore(deps): bump github.com/pierrec/lz4/v4 from 4.1.18 to 4.1.19 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2739
- chore(deps): bump golang.org/x/crypto from 0.15.0 to 0.17.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2748
- chore(deps): bump the golang-org-x group with 1 update by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2734
- chore(deps): bump the golang-org-x group with 2 updates by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2764
- chore(deps): bump github.com/pierrec/lz4/v4 from 4.1.19 to 4.1.21 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2763
- chore(deps): bump golang.org/x/crypto from 0.15.0 to 0.17.0 in
/examples/exactly_once by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2749
- chore(deps): bump golang.org/x/crypto from 0.15.0 to 0.17.0 in
/examples/consumergroup by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2750
- chore(deps): bump golang.org/x/crypto from 0.15.0 to 0.17.0 in
/examples/sasl_scram_client by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2751
- chore(deps): bump golang.org/x/crypto from 0.15.0 to 0.17.0 in
/examples/interceptors by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2752
- chore(deps): bump golang.org/x/crypto from 0.15.0 to 0.17.0 in
/examples/http_server by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2753
- chore(deps): bump github.com/eapache/go-resiliency from 1.4.0 to 1.5.0
by [@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2745
- chore(deps): bump golang.org/x/crypto from 0.15.0 to 0.17.0 in
/examples/txn_producer by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2754
- chore(deps): bump go.opentelemetry.io/otel/sdk from 1.19.0 to 1.22.0
in /examples/interceptors by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2767
- chore(deps): bump the golang-org-x group with 1 update by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2793
- chore(deps): bump
go.opentelemetry.io/otel/exporters/stdout/stdoutmetric from 0.42.0 to
1.23.1 in /examples/interceptors by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[IBM/sarama#2792

##### 🔧 Maintenance

- fix(examples): housekeeping of code and deps by
[@&#8203;dnwe](https://togithub.com/dnwe) in
[IBM/sarama#2720

##### ➕ Other Changes

- fix(test): retry MockBroker Listen for EADDRINUSE by
[@&#8203;dnwe](https://togithub.com/dnwe) in
[IBM/sarama#2721

#### New Contributors

- [@&#8203;maqdev](https://togithub.com/maqdev) made their first
contribution in
[IBM/sarama#2717
- [@&#8203;zhuliquan](https://togithub.com/zhuliquan) made their first
contribution in
[IBM/sarama#2472

**Full Changelog**:
IBM/sarama@v1.42.1...v1.42.2

### [`v1.42.1`](https://togithub.com/IBM/sarama/releases/tag/v1.42.1):
Version 1.42.1 (2023-11-07)

[Compare
Source](https://togithub.com/IBM/sarama/compare/v1.42.0...v1.42.1)

#### What's Changed

##### 🐛 Fixes

- fix: make fetchInitialOffset use correct protocol by
[@&#8203;dnwe](https://togithub.com/dnwe) in
[IBM/sarama#2705
- fix(config): relax ClientID validation after 1.0.0 by
[@&#8203;dnwe](https://togithub.com/dnwe) in
[IBM/sarama#2706

**Full Changelog**:
IBM/sarama@v1.42.0...v1.42.1

### [`v1.42.0`](https://togithub.com/IBM/sarama/releases/tag/v1.42.0):
Version 1.42.0 (2023-11-02)

[Compare
Source](https://togithub.com/IBM/sarama/compare/v1.41.3...v1.42.0)

<!-- Release notes generated using configuration in .github/release.yaml
at main -->

#### What's Changed

##### 🐛 Fixes

- Asynchronously close brokers during a RefreshBrokers by
[@&#8203;bmassemin](https://togithub.com/bmassemin) in
[IBM/sarama#2693
- Fix data race on Broker.done channel by
[@&#8203;prestona](https://togithub.com/prestona) in
[IBM/sarama#2698
- fix: data race in Broker.AsyncProduce by
[@&#8203;lzakharov](https://togithub.com/lzakharov) in
[IBM/sarama#2678
- Fix default retention time value in offset commit by
[@&#8203;prestona](https://togithub.com/prestona) in
[IBM/sarama#2700
- fix(txmgr): ErrOffsetsLoadInProgress is retriable by
[@&#8203;dnwe](https://togithub.com/dnwe) in
[IBM/sarama#2701

##### 🔧 Maintenance

- chore(ci): improve ossf scorecard result by
[@&#8203;dnwe](https://togithub.com/dnwe) in
[IBM/sarama#2685
- chore(ci): add kafka 3.6.0 to FVT and versions by
[@&#8203;dnwe](https://togithub.com/dnwe) in
[IBM/sarama#2692

##### ➕ Other Changes

- chore(ci): ossf scorecard.yml by
[@&#8203;dnwe](https://togithub.com/dnwe) in
[IBM/sarama#2683
- fix(ci): always run CodeQL on every commit by
[@&#8203;dnwe](https://togithub.com/dnwe) in
[IBM/sarama#2689
- chore(doc): add OpenSSF Scorecard badge by
[@&#8203;dnwe](https://togithub.com/dnwe) in
[IBM/sarama#2691

#### New Contributors

- [@&#8203;bmassemin](https://togithub.com/bmassemin) made their first
contribution in
[IBM/sarama#2693
- [@&#8203;lzakharov](https://togithub.com/lzakharov) made their first
contribution in
[IBM/sarama#2678

**Full Changelog**:
IBM/sarama@v1.41.3...v1.42.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View the
[repository job
log](https://developer.mend.io/github/newrelic/nri-kafka).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMS41IiwidXBkYXRlZEluVmVyIjoiMzguMjAuMSIsInRhcmdldEJyYW5jaCI6Im1hc3RlciJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ClientID regex is too restrictive.
2 participants