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

feat: cardinal pretty logging, improve goroutine reliability, kill --watch #64

Merged
merged 1 commit into from
May 20, 2024

Conversation

smsunarto
Copy link
Member

@smsunarto smsunarto commented May 16, 2024

TL;DR

What changed?

  • world cardinal dev now use pretty logging on latest Cardinal version. This is done by setting CARDINAL_PRETTY_LOG to true.
  • Refactors to goroutine management in world cardinal start and world cardinal dev to make it more reliable using error group.
  • Disable printing the usage guide when a command returns an error.
  • Various string reformatting using lipgloss to make things look pretty.
  • Prevent exit code 130, 137, 143 from being treated as an error since it's an expected exit code from Docker when it receives termination signal (i.e. Ctrl + C, SIGKILL, SIGTERM, etc)
  • Kill world cardinal dev --watch flag because runner is ugly and buggy af

How to test?

  1. Run world cardinal dev and world cardinal start and try to break it. This includes running it against various edge cases (i.e. Redis already running, kill redis when cardinal is running, etc)

Copy link

graphite-app bot commented May 16, 2024

Your org has enabled the Graphite merge queue for merging into main

Add the label “graphite/merge” to the PR and Graphite will automatically add it to the merge queue when it’s ready to merge.

You must have a Graphite account and log in to Graphite in order to use the merge queue. Sign up using this link.

Copy link

coderabbitai bot commented May 16, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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>.
    • 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.
  • 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.

Copy link
Member Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @smsunarto and the rest of your teammates on Graphite Graphite

@smsunarto smsunarto force-pushed the 05-15-refactor_various branch 7 times, most recently from 3b18139 to c9e9757 Compare May 16, 2024 22:18
Copy link

codecov bot commented May 16, 2024

Codecov Report

Attention: Patch coverage is 47.82609% with 12 lines in your changes are missing coverage. Please review.

Project coverage is 52.63%. Comparing base (03aa9eb) to head (cf5a2a0).

Files Patch % Lines
common/teacmd/docker.go 0.00% 8 Missing ⚠️
cmd/world/root/root.go 73.33% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #64      +/-   ##
==========================================
- Coverage   52.72%   52.63%   -0.09%     
==========================================
  Files           9        9              
  Lines         698      720      +22     
==========================================
+ Hits          368      379      +11     
- Misses        262      273      +11     
  Partials       68       68              

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

@smsunarto smsunarto force-pushed the 05-15-refactor_various branch 2 times, most recently from 5722aab to a287716 Compare May 17, 2024 00:03
@smsunarto smsunarto marked this pull request as ready for review May 17, 2024 00:08
@smsunarto smsunarto requested a review from zulkhair May 17, 2024 00:08
@smsunarto smsunarto changed the title refactor: various feat: cardinal pretty logging and improve goroutine reliability May 17, 2024
@smsunarto smsunarto force-pushed the 05-15-refactor_various branch 3 times, most recently from 43e1acc to 2fb1eab Compare May 17, 2024 00:34
@zulkhair
Copy link
Collaborator

I'm testing to run with world cardinal dev --watch. It got stuck when i'm tryin to send sigint.
Screenshot from 2024-05-17 11-23-27

@smsunarto smsunarto force-pushed the 05-15-refactor_various branch 2 times, most recently from b26e310 to 786a522 Compare May 17, 2024 18:00
@smsunarto smsunarto changed the title feat: cardinal pretty logging and improve goroutine reliability feat: cardinal pretty logging, improve goroutine reliability, kill --watch May 17, 2024
cmd/world/cardinal/dev.go Outdated Show resolved Hide resolved
Copy link
Collaborator

@zulkhair zulkhair left a comment

Choose a reason for hiding this comment

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

Tested all the functionality. LGTM

@smsunarto smsunarto force-pushed the 05-15-refactor_various branch 2 times, most recently from 3ca84b0 to 10c408f Compare May 17, 2024 19:09
Copy link
Collaborator

@zulkhair zulkhair left a comment

Choose a reason for hiding this comment

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

Unit test is failed because cardinal editor run called twice on different test case.

Adding --editor=false flag on line 128 and 184 should resolve this problem.

image.png

@smsunarto smsunarto merged commit ef82596 into main May 20, 2024
10 of 12 checks passed
@smsunarto smsunarto deleted the 05-15-refactor_various branch May 20, 2024 23:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants