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: Prevent unexpected warning from Resty when calling Client.SetDebug(false) #508

Merged
merged 1 commit into from
May 21, 2024

Conversation

lgarber-akamai
Copy link
Contributor

@lgarber-akamai lgarber-akamai commented May 21, 2024

📝 Description

This pull request fixes a small issue that would cause the following Resty warning (raised here) to be printed when Client.SetDebug(...) is called multiple times:

WARN RESTY Overwriting an existing on-request-log callback from=github.com/linode/linodego.(*Client).SetDebug.(*Client).sanitizeAuthorizationHeader.func1 to=github.com/linode/linodego.(*Client).SetDebug.(*Client).sanitizeAuthorizationHeader.func1

This works by initializing the log hook during client creation rather than when calling SetDebug(...).

✔️ How to Test

The following test steps assume you have pulled down this PR locally.

Manual Testing

  1. In a linodego sandbox environment (e.g. dx-devenv), run the following:
package main

import (
	"github.com/linode/linodego"
)

func main() {
	client := linodego.NewClient(nil)
	client.SetDebug(true)
	client.SetDebug(true)
	client.SetDebug(false)
}
  1. Ensure no warnings are raised from Resty.

@lgarber-akamai lgarber-akamai added the bugfix for any bug fixes in the changelog. label May 21, 2024
@lgarber-akamai lgarber-akamai requested a review from a team as a code owner May 21, 2024 15:34
@lgarber-akamai lgarber-akamai requested review from ykim-1 and yec-akamai and removed request for a team May 21, 2024 15:34
Copy link
Contributor

@yec-akamai yec-akamai left a comment

Choose a reason for hiding this comment

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

No warnings from Resty anymore, nice work!

Copy link
Contributor

@jriddle-linode jriddle-linode left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@ykim-1 ykim-1 left a comment

Choose a reason for hiding this comment

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

LGTM, nice work!

@lgarber-akamai lgarber-akamai merged commit 3bcb4a6 into linode:main May 21, 2024
4 checks passed
renovate bot added a commit to anza-labs/lke-operator that referenced this pull request May 23, 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/linode/linodego](https://github.com/linode/linodego) |
`v1.33.1` -> `v1.34.0` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2flinode%2flinodego/v1.34.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2flinode%2flinodego/v1.34.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2flinode%2flinodego/v1.33.1/v1.34.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2flinode%2flinodego/v1.33.1/v1.34.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>linode/linodego (github.com/linode/linodego)</summary>

###
[`v1.34.0`](https://github.com/linode/linodego/releases/tag/v1.34.0)

[Compare
Source](https://github.com/linode/linodego/compare/v1.33.1...v1.34.0)

#### What's Changed

##### ⚠️  Breaking Change

- \[BREAKING] Add support for LKE Control Plane ACL by
[@&#8203;lgarber-akamai](https://github.com/lgarber-akamai) in
[linode/linodego#495

##### 🐛 Bug Fixes

- Prevent unexpected warning from Resty when calling
`Client.SetDebug(false)` by
[@&#8203;lgarber-akamai](https://github.com/lgarber-akamai) in
[linode/linodego#508

##### 💡 Improvements

- Mask the value of the Authorization header if debug is enabled by
[@&#8203;rosskirkpat](https://github.com/rosskirkpat) in
[linode/linodego#501
- Expose region capabilities enum by
[@&#8203;yec-akamai](https://github.com/yec-akamai) in
[linode/linodego#507

##### ⚙️  Repo/CI Improvements

- replace test execution handler with conditional by
[@&#8203;ykim-1](https://github.com/ykim-1) in
[linode/linodego#502

##### 📦 Dependency Updates

- bump golang.org/x/net from 0.24.0 to 0.25.0 by
[@&#8203;dependabot](https://github.com/dependabot) in
[linode/linodego#500
- bump github.com/go-resty/resty/v2 from 2.12.0 to 2.13.1 by
[@&#8203;dependabot](https://github.com/dependabot) in
[linode/linodego#505
- bump golangci/golangci-lint-action from 5 to 6 by
[@&#8203;dependabot](https://github.com/dependabot) in
[linode/linodego#506

#### New Contributors

- [@&#8203;rosskirkpat](https://github.com/rosskirkpat) made their
first contribution in
[linode/linodego#501

**Full Changelog**:
linode/linodego@v1.33.1...v1.34.0

</details>

---

### Configuration

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

🚦 **Automerge**: Enabled.

♻ **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 has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/anza-labs/lke-operator).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNjguMTAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4zNjguMTAiLCJ0YXJnZXRCcmFuY2giOiJtYWluIiwibGFiZWxzIjpbImFyZWEvZGVwZW5kZW5jeSJdfQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix for any bug fixes in the changelog.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants