fix: skip NATS connection when URL is empty - #143
Open
joldmarfilho wants to merge 2 commits into
Open
Conversation
Reviewer's GuideEnsure the NATS producer constructor safely no-ops when given an empty URL, and add a regression test to verify it does not establish a NATS connection or enable global publishing in that case. Sequence diagram for NewNatsProducer behavior with empty URLsequenceDiagram
participant Caller
participant NewNatsProducer
participant NATS as nats
Caller->>NewNatsProducer: NewNatsProducer(url, natsGlobalEnabled, natsGlobalEvents, loggerWrapper)
alt [strings.TrimSpace(url) == ""]
NewNatsProducer-->>Caller: &natsProducer{conn:nil, natsGlobalEnabled:false, natsGlobalEvents:nil}
else [strings.TrimSpace(url) != ""]
NewNatsProducer->>NATS: Connect(url)
NATS-->>NewNatsProducer: *nats.Conn
NewNatsProducer-->>Caller: &natsProducer{conn:*nats.Conn, natsGlobalEnabled:natsGlobalEnabled}
end
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 2 issues, and left some high level feedback:
- In the empty-URL branch, consider retaining the provided natsGlobalEvents slice instead of forcing it to nil to avoid surprising callers that may rely on the configured event list even when the producer is disabled.
- It may be helpful to log a clear warning when the NATS URL is empty so that operators can distinguish between an intentional configuration (disabled producer) and a misconfiguration.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In the empty-URL branch, consider retaining the provided natsGlobalEvents slice instead of forcing it to nil to avoid surprising callers that may rely on the configured event list even when the producer is disabled.
- It may be helpful to log a clear warning when the NATS URL is empty so that operators can distinguish between an intentional configuration (disabled producer) and a misconfiguration.
## Individual Comments
### Comment 1
<location path="pkg/events/nats/nats_producer_test.go" line_range="5" />
<code_context>
+
+import "testing"
+
+func TestNewNatsProducerDoesNotConnectWithoutURL(t *testing.T) {
+ producer, ok := NewNatsProducer(" ", false, nil, nil).(*natsProducer)
+ if !ok {
</code_context>
<issue_to_address>
**suggestion (testing):** Cover both empty and whitespace-only URLs, ideally via table-driven subtests
This test only covers the whitespace-only case (" "). Since the behavior should be the same for both empty and whitespace-only URLs, please either add a separate test for "" or convert this into a table-driven test with subtests for "" and " " (and any other relevant variants) to ensure we’re protected against regressions for all "empty" URL forms.
</issue_to_address>
### Comment 2
<location path="pkg/events/nats/nats_producer_test.go" line_range="10-13" />
<code_context>
+ if !ok {
+ t.Fatal("constructor returned an unexpected producer type")
+ }
+ if producer.conn != nil {
+ t.Fatal("NATS connection must stay nil when NATS_URL is empty")
+ }
+ if producer.natsGlobalEnabled {
+ t.Fatal("NATS global publishing must stay disabled without a URL")
+ }
</code_context>
<issue_to_address>
**suggestion (testing):** Also assert on `natsGlobalEvents` to fully document the constructor behavior when URL is empty
Since the constructor also sets `natsGlobalEvents` to nil when no URL is provided, add an assertion like `if producer.natsGlobalEvents != nil { t.Fatal("natsGlobalEvents must be nil when NATS_URL is empty") }` so the test fully captures the producer’s expected state in this scenario.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
|
||
| import "testing" | ||
|
|
||
| func TestNewNatsProducerDoesNotConnectWithoutURL(t *testing.T) { |
There was a problem hiding this comment.
suggestion (testing): Cover both empty and whitespace-only URLs, ideally via table-driven subtests
This test only covers the whitespace-only case (" "). Since the behavior should be the same for both empty and whitespace-only URLs, please either add a separate test for "" or convert this into a table-driven test with subtests for "" and " " (and any other relevant variants) to ensure we’re protected against regressions for all "empty" URL forms.
Comment on lines
+10
to
+13
| if producer.conn != nil { | ||
| t.Fatal("NATS connection must stay nil when NATS_URL is empty") | ||
| } | ||
| if producer.natsGlobalEnabled { |
There was a problem hiding this comment.
suggestion (testing): Also assert on natsGlobalEvents to fully document the constructor behavior when URL is empty
Since the constructor also sets natsGlobalEvents to nil when no URL is provided, add an assertion like if producer.natsGlobalEvents != nil { t.Fatal("natsGlobalEvents must be nil when NATS_URL is empty") } so the test fully captures the producer’s expected state in this scenario.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Related Issue
Closes #(issue_number)
Type of Change
Testing
Screenshots (if applicable)
Checklist
Additional Notes
Summary by Sourcery
Skip establishing a NATS connection when no URL is provided and ensure producer is disabled in that case.
Bug Fixes:
Tests: