Skip to content
New issue

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

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

Already on GitHub? # to your account

refactor(log): disable coloring in testing logger #22466

Merged
merged 3 commits into from
Nov 7, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Nov 7, 2024

Description

Got annoyed that the testing logger was unreadable within needing to tweak my terminal (or github ci terminal, which i'm not even sure is possible)

Disabling the color of the testing logger just makes more sense

(before)
image


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features

    • Updated Go version to 1.21, enhancing compatibility and performance.
    • Improved testing logger configuration with new options for better output control.
  • Bug Fixes

    • Disabled coloring in the testing logger for clearer log output.
  • Documentation

    • Changelog updated to reflect the release of version 1.5.0, including new features and improvements.

@julienrbrt julienrbrt requested review from sontrinh16 and a team as code owners November 7, 2024 11:18
Copy link
Contributor

coderabbitai bot commented Nov 7, 2024

📝 Walkthrough

Walkthrough

The pull request introduces updates primarily to the Go version used in the testing workflow and related files. The GitHub Actions workflow configuration in .github/workflows/test.yml now specifies Go version 1.21. Correspondingly, the go.mod file reflects this version change. Additionally, the changelog has been updated to document the release of version 1.5.0, including various modifications and improvements. The log/testing.go file also sees enhancements in the console logger configuration used for testing.

Changes

File Change Summary
.github/workflows/test.yml Updated Go version from 1.20 to 1.21 in test-log job.
log/CHANGELOG.md Updated to reflect version 1.5.0 release; added entry for disabling color in testing logger; specified Go version update for cosmossdk.io/log.
log/go.mod Updated Go version from 1.20 to 1.21.
log/testing.go Modified newTestLogger function; updated console writer instantiation and properties for logging.

Possibly related PRs

  • feat(log): add slog-backed Logger type #22347: The changes in the main PR regarding the Go version update in the workflow are related to this PR, which introduces a new logger type that requires Go version 1.21, aligning with the updated Go version in the main PR.

Suggested reviewers

  • julienrbrt
  • sontrinh16

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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@github-actions github-actions bot added the C:log label Nov 7, 2024
@julienrbrt julienrbrt changed the title Julien/disable coloring refactor(log): disable coloring in testing logger Nov 7, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
.github/workflows/test.yml (1)

Based on the output, I can now generate the final response since I have verified the Go version requirements across all modules.

Go version inconsistencies should be standardized to Go 1.23.x

The codebase predominantly uses Go 1.23.x (specifically 1.23, 1.23.0, 1.23.1, or 1.23.2) across most modules. However, there are a few outliers:

  • schema/testing: Go 1.12
  • log: Go 1.21
  • depinject: Go 1.20

These older versions should be updated to Go 1.23.x to maintain consistency and prevent potential compatibility issues across the codebase.

🔗 Analysis chain

Line range hint 1-1200: Consider standardizing Go versions across jobs.

There are inconsistent Go versions being used across different jobs:

  • Most jobs use Go 1.23
  • Some jobs (depinject, errors, math) use Go 1.20
  • The schema job uses Go 1.12
  • The log job uses Go 1.21

This inconsistency could lead to compatibility issues. Consider standardizing the Go version across all jobs unless there's a specific requirement for different versions.

Let's verify the Go version requirements for each module:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check Go version requirements across all modules

# Test: Search for go version in go.mod files
echo "Checking go version in go.mod files..."
fd -e mod -x cat {} \; | rg -A 1 "^go "

# Test: Search for any version constraints in dependencies
echo "Checking version constraints in dependencies..."
fd -e mod -x cat {} \; | rg -A 5 "require"

Length of output: 28917

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f6c7ab6 and fcbd153.

📒 Files selected for processing (4)
  • .github/workflows/test.yml (1 hunks)
  • log/CHANGELOG.md (1 hunks)
  • log/go.mod (1 hunks)
  • log/testing.go (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • log/go.mod
🧰 Additional context used
📓 Path-based instructions (2)
log/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

log/testing.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

🔇 Additional comments (5)
log/testing.go (2)

3-7: LGTM: Import changes are appropriate.

The addition of the time package import is necessary for the time.Kitchen constant, and the import block follows Go standards with proper grouping.


46-57: LGTM: Excellent improvements to logger configuration.

The changes effectively address the PR's objective by:

  1. Disabling colors through NoColor: true
  2. Using a more readable time format with time.Kitchen
  3. Maintaining the correct frame depth for accurate source locations

The implementation is clean and well-documented.

log/CHANGELOG.md (2)

25-25: LGTM: Version header follows the changelog format.

The version header correctly follows the link format and includes the release date.


27-29: LGTM: Changelog entries are well-formatted and informative.

The entries:

  • Follow the required format: [#<issue-number>] Changelog message
  • Are ordered from newest to oldest
  • Provide clear, concise descriptions of changes
  • Include the Go version requirement note for slog support
.github/workflows/test.yml (1)

858-858: LGTM: Go version update for the log job.

The update to Go 1.21 for the log job aligns with the changes in the log/go.mod file.

@julienrbrt julienrbrt added this pull request to the merge queue Nov 7, 2024
Merged via the queue into main with commit ffa74d1 Nov 7, 2024
78 of 79 checks passed
@julienrbrt julienrbrt deleted the julien/disable-coloring branch November 7, 2024 13:19
alpe added a commit that referenced this pull request Nov 13, 2024
* main: (31 commits)
  docs: update links for https security protocol (#22514)
  build(deps): Bump github.com/bytedance/sonic from 1.12.3 to 1.12.4 in /log (#22513)
  feat(x/protocolpool)!: allow any coins in continuous funds (#21916)
  docs: Update protobuf  tx signing message format outer link (#22510)
  test(accounts): fix integration tests (#22418)
  chore(x): fix some typos in comment (#22508)
  build(deps): Bump cosmossdk.io/log from 1.4.1 to 1.5.0 (#22487)
  build(deps): Bump cosmossdk.io/core from 1.0.0-alpha.5 to 1.0.0-alpha.6 (#22502)
  build(deps): Bump golang.org/x/crypto from 0.28.0 to 0.29.0 (#22480)
  docs(adr75): server v2 (#21069)
  fix(server/v2): improve server stop (#22455)
  chore: prepare core changelog (#22495)
  refactor(store/v2): simplify genesis flow (#22435)
  build(deps): Bump google.golang.org/grpc from 1.67.1 to 1.68.0 (#22486)
  build(deps): Bump golang.org/x/sync from 0.8.0 to 0.9.0 (#22482)
  feat(x/circuit): Allow msg Reset with empty msgURL (#22459)
  build(deps): Bump actions/xxx-artifact from v3 to v4 (#22468)
  feat(stf/branch): simplify merged iterator (#22131)
  refactor(log): disable coloring in testing logger (#22466)
  chore(x/tx): update changelog to alpha.2 (#22465)
  ...
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants