search

yorkie-team / yorkie

Yorkie is a document store for collaborative applications.
https://yorkie.dev
Apache License 2.0
748 stars 133 forks source link

Remove commit revision in version command #905

Closed hackerwins closed 3 weeks ago

hackerwins commented 3 weeks ago

What this PR does / why we need it:

Remove commit revision in version command

The following error occurs when running $ yorkie version.

$ yorkie version
Yorkie: 0.4.24
panic: runtime error: slice bounds out of range [:7] with length 0

goroutine 1 [running]:
main.init.5.newVersionCmd.func1(0x1400022f800?, {0x102d8a3b0?, 0x4?, 0x102d8a3b4?})
        github.com/yorkie-team/yorkie/cmd/yorkie/version.go:38 +0x15c
github.com/spf13/cobra.(*Command).execute(0x140001c0dc8, {0x1038bc520, 0x0, 0x0})
        github.com/spf13/cobra@v1.5.0/command.go:872 +0x574
github.com/spf13/cobra.(*Command).ExecuteC(0x1038493c0)
        github.com/spf13/cobra@v1.5.0/command.go:990 +0x318
github.com/spf13/cobra.(*Command).Execute(...)
        github.com/spf13/cobra@v1.5.0/command.go:918
main.Run(...)
        github.com/yorkie-team/yorkie/cmd/yorkie/commands.go:39
main.main()
        github.com/yorkie-team/yorkie/cmd/yorkie/main.go:24 +0x24

The cause was not found, but since revision wasn't strictly necessary, this commit removes revision from version command.

Starting with 0.4.18, BrewTestBot started automatically deploying to Homebrew. It is assumed that the error occurs after this point.

Which issue(s) this PR fixes:

Related to #870

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Additional documentation:

Checklist:

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

[!WARNING]

Review failed

The pull request is closed.

Walkthrough

The changes primarily involve simplifying the version information retrieval in the cmd/yorkie/version.go file and updating a log message in server/backend/backend.go. Specifically, the settingByKey function and a relative constant were removed for a more straightforward approach to print the version and build information. Meanwhile, in backend.go, the log message was refined to correctly display the database reference instead of the RPC reference during backend creation.

Changes

File Change Summary
cmd/yorkie/version.go Removed settingByKey function and commitRevisionKey constant for simplified version info retrieval.
server/backend/backend.go Modified the log message in New() function to correctly reference db instead of rpc.

Poem

In code’s forest, changes bloom,
Simplified the version's room.
Yorkie's build now clear and bright,
Backend logs with names just right.
Happy bits and bytes now play,
As Rabbit cheers, in code's ballet.
🌼💻✨

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 3 weeks ago

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 50.74%. Comparing base (47ae9d4) to head (08d4e97).

Files Patch % Lines
server/backend/backend.go 0.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #905 +/- ## ======================================= Coverage 50.74% 50.74% ======================================= Files 70 70 Lines 10473 10473 ======================================= Hits 5315 5315 Misses 4631 4631 Partials 527 527 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.