Fix lib.ErrorLogWithError

[jonfung-dydx]

i thought i fixed this but we weren't passing through the k:v tags values properly

[coderabbitai]

Walkthrough

The modification made to the logging system is aimed at enhancing error tracking capabilities. By adjusting the ErrorLogWithError function, the update ensures that error objects are correctly appended to logs. This is achieved through the proper formatting and passing of keyvals to the logger, facilitating easier identification and resolution of issues.

Changes

File(s)	Summary
protocol/lib/log/utils.go	Modified ErrorLogWithError to improve error object logging by correctly formatting keyvals.

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Actionable comments posted: 1

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 363d9f4 and 7cec7fc.

Files selected for processing (1)

• protocol/lib/log/utils.go (1 hunks)

Additional Context Used

Path-based Instructions (1)

protocol/lib/log/utils.go (1)

**/**:
Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.

[coderabbitai]

The change made to append the error object to keyvals using append(keyvals, Error, err)... is intended to ensure that error objects are correctly logged. However, there's a potential issue with this approach:

1. The Error variable is not defined within the provided context. Assuming it's meant to be a string key for the error object, it should be explicitly defined as such, e.g., "error".
2. Using append directly on the keyvals argument can lead to unexpected behavior if keyvals is reused elsewhere, as append can modify the underlying array of a slice in place if there's enough capacity.

To address these concerns, consider the following adjustments:

- ctx.Logger().Error(msg, append(keyvals, Error, err)...)
+ const errorKey = "error" // Define a constant for the error key
+ // Ensure a new slice is created to avoid modifying `keyvals` outside this function
+ keyvalsWithError := append([]interface{}{errorKey, err}, keyvals...)
+ ctx.Logger().Error(msg, keyvalsWithError...)

This ensures that the error object is correctly appended with a clear key, and avoids potential side effects from modifying the keyvals slice.

---

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	ctx.Logger().Error(msg, append(keyvals, Error, err)...)
	const errorKey = "error" // Define a constant for the error key
	// Ensure a new slice is created to avoid modifying `keyvals` outside this function
	keyvalsWithError := append([]interface{}{errorKey, err}, keyvals...)
	ctx.Logger().Error(msg, keyvalsWithError...)

[jonfung-dydx]

@Mergifyio backport release/protocol/v4.x

[jonfung-dydx]

@Mergifyio backport release/protocol/v5.x

[mergify]

backport release/protocol/v4.x

✅ Backports have been created

• #1310 Fix lib.ErrorLogWithError (backport #1306) has been created for branch release/protocol/v4.x

[mergify]

backport release/protocol/v5.x

✅ Backports have been created

• #1309 Fix lib.ErrorLogWithError (backport #1306) has been created for branch release/protocol/v5.x