Bugfix that caused an error when argument has 3 or more nil arguments

[hlts2]

Description

I fixed a problem that the result of Join does not return nil when three or more nil arguments are given.

Related Issue

Versions

• Go Version: 1.22.3
• Rust Version: 1.77.2
• Docker Version: 20.10.8
• Kubernetes Version: v1.30.0
• NGT Version: 2.2.1

Checklist

• I have read the CONTRIBUTING document and completed our CLA agreement.
• I have checked open Pull Requests for the similar feature or fixes?

Special notes for your reviewer

Summary by CodeRabbit

• Bug Fixes

  • Improved error handling to return nil for empty or nil error lists.

• Tests

  • Added tests for enhanced error handling scenarios to ensure reliability.

[coderabbitai]

Walkthrough

The Join function in the internal/errors package has been updated to manage composite error scenarios more effectively. This involves handling *joinError types and any errors implementing the Unwrap method. Additionally, the function now returns nil when all input errors are nil, ensuring more accurate error combination and simplifying error handling logic. A new test, TestJoin, has been added to validate these improvements.

Changes

File	Change Summary
internal/errors/errors.go	Modified Join function to handle *joinError and errors with Unwrap, and return nil if no errors exist.
internal/errors/errors_test.go	Added TestJoin function to test various scenarios for the Join function, including returning nil for nil errors.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[vdaas-ci]

[CHATOPS:HELP] ChatOps commands.

• 🙆‍♀️ /approve - approve
• 🍱 /format - format codes and add licenses
• ✅ /gen-test - generate test codes
• 🏷️ /label - add labels
• 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

[codecov]

Codecov Report

Attention: Patch coverage is 42.85714% with 4 lines in your changes missing coverage. Please review.

Project coverage is 18.95%. Comparing base (84094b3) to head (4733c80).

Files	Patch %	Lines
internal/errors/errors.go	42.85%	4 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2517      +/-   ##
==========================================
+ Coverage   18.91%   18.95%   +0.04%     
==========================================
  Files         565      565              
  Lines       65221    65225       +4     
==========================================
+ Hits        12334    12362      +28     
+ Misses      52089    52063      -26     
- Partials      798      800       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Actionable comments posted: 1

Outside diff range and nitpick comments (1)

internal/errors/errors.go (1)

Line range hint 266-295: Refactor the Join function to simplify the error handling logic and reduce redundancy.

func Join(errs ...error) error {
    var nonNilErrors []error
    for _, err := range errs {
        if err != nil {
            nonNilErrors = append(nonNilErrors, err)
        }
    }
    switch len(nonNilErrors) {
    case 0:
        return nil
    case 1:
        return nonNilErrors[0]
    default:
        return &joinError{errs: nonNilErrors}
    }
}

This refactor simplifies the error handling by collecting non-nil errors first and then deciding the return based on the number of non-nil errors. This approach avoids unnecessary type assertions and simplifies the logic.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3edc428 and 729ec39.

Files selected for processing (2)

• internal/errors/errors.go (2 hunks)
• internal/errors/errors_test.go (3 hunks)

Additional comments not posted (2)

internal/errors/errors_test.go (2)

1654-1707: The structure of the TestJoin function and its test cases are well-defined and adhere to best practices for concurrency and memory leak prevention.

---

1654-1707: Implementation details such as the use of goleak.VerifyNone for goroutine leak checks and deferred cleanup are correctly applied, enhancing the robustness of the tests.

[cloudflare-workers-and-pages]

Deploying vald with    Cloudflare Pages

Latest commit:	4733c80
Status:	✅  Deploy successful!
Preview URL:	https://42215b08.vald.pages.dev
Branch Preview URL:	https://bugfix-internal-errors-join.vald.pages.dev

View logs

[kpango]

Since you are instantiating a new joinError in all cases, why not simply check if e is nil after the Switch and create a new one only if it is nil?

[hlts2]

Thank you for your feedback. I fixed it!
8009a29

[kpango]

LGTM

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 729ec39 and 8009a29.

Files selected for processing (2)

• internal/errors/errors.go (2 hunks)
• internal/errors/errors_test.go (3 hunks)

Files skipped from review as they are similar to previous changes (1)

• internal/errors/errors_test.go

Additional context used

GitHub Check: codecov/patch

internal/errors/errors.go

[warning] 266-267: internal/errors/errors.go#L266-L267
Added lines #L266 - L267 were not covered by tests

---

[warning] 271-272: internal/errors/errors.go#L271-L272
Added lines #L271 - L272 were not covered by tests

Additional comments not posted (1)

internal/errors/errors.go (1)

Line range hint 266-288: Ensure newly added logic in Join function is covered by tests.

The changes in the Join function to handle multiple nil errors and the initialization of e based on conditions look good. However, these changes are not covered by tests according to the static analysis report. It's crucial to ensure that the new logic works as expected under different scenarios.

Verification successful

---

The extracted content of the TestJoin function shows that it includes test cases for various scenarios, including when all errors are nil, when all errors are non-nil and different, and when errors are mixed nil and non-nil. These test cases sufficiently cover the new logic added to the Join function.

• return nil when all errors are nil
• returns an aggregated error when all errors are non-nil and different
• returns an error when errors are mixed nil and non-nil

These scenarios ensure that the changes in the Join function are thoroughly tested.

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Check if the test file `errors_test.go` contains tests for the new logic in `Join` function.

# Test: Search for the test cases related to the new logic in `Join` function.
rg --type go $'TestJoin' internal/errors/errors_test.go

Length of output: 84

---

---

Script:

#!/bin/bash
# Description: Extract the content of the TestJoin function to verify if it covers the new logic in the Join function.
# Extract the TestJoin function from the test file.
ast-grep --lang go --pattern $'func TestJoin($_) {
  $$$
}' internal/errors/errors_test.go

Length of output: 4626

Tools

GitHub Check: codecov/patch

[warning] 266-267: internal/errors/errors.go#L266-L267
Added lines #L266 - L267 were not covered by tests

---

[warning] 271-272: internal/errors/errors.go#L271-L272
Added lines #L271 - L272 were not covered by tests