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

chore(walnut): put under walnut feature flag #2407

Merged
merged 2 commits into from
Sep 10, 2024
Merged

chore(walnut): put under walnut feature flag #2407

merged 2 commits into from
Sep 10, 2024

Conversation

kariy
Copy link
Member

@kariy kariy commented Sep 10, 2024

put all walnut code in Sozo under the walnut feature flag which will be enabled by default.

Summary by CodeRabbit

  • New Features

    • Introduced a new optional feature, "walnut," allowing users to enhance functionality with the sozo-walnut dependency.
    • Added conditional debugging capabilities through the WalnutDebugger, enabling modular debugging options based on feature activation.
  • Bug Fixes

    • Improved flexibility in function signatures by conditionally including parameters related to the WalnutDebugger.
  • Documentation

    • Enhanced clarity in code structure and readability for functions affected by the new feature.
  • Tests

    • Updated tests to accommodate the new "walnut" feature, ensuring compatibility and functionality under conditional compilation.

Copy link

coderabbitai bot commented Sep 10, 2024

Walkthrough

Ohayo, sensei! This pull request updates the Cargo.toml files for the sozo project by adding the sozo-walnut dependency as an optional feature. It also modifies several source files to implement conditional compilation for the WalnutDebugger, ensuring its instantiation and usage occur only when the "walnut" feature is enabled. These changes enhance the modularity of the codebase, allowing developers to flexibly include or exclude debugging capabilities based on project requirements.

Changes

Files Change Summary
bin/sozo/Cargo.toml, crates/sozo/ops/Cargo.toml Updated sozo-walnut dependency to be optional and added a new walnut feature in both files.
bin/sozo/src/commands/auth.rs, bin/sozo/src/commands/execute.rs, bin/sozo/src/commands/register.rs Introduced conditional compilation for WalnutDebugger in various async functions to enhance modularity.
crates/sozo/ops/src/migration/auto_auth.rs, crates/sozo/ops/src/migration/mod.rs, crates/sozo/ops/src/utils.rs Added conditional compilation for walnut_debugger parameters in function signatures and logic.
crates/sozo/ops/src/tests/auth.rs, crates/sozo/ops/src/tests/model.rs, crates/sozo/ops/src/tests/migration.rs Implemented conditional compilation attributes in several test functions to accommodate optional arguments based on the "walnut" feature.

Possibly related PRs

Tip

Announcements
  • The review status is no longer posted as a separate comment when there are no actionable or nitpick comments. In such cases, the review status is included in the walkthrough comment.
  • We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.
  • Possibly related PRs: Walkthrough comment now includes a list of potentially related PRs to help you recall past context. Please share any feedback in the discussion post on our Discord.
  • Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs in the walkthrough comment. You can also provide custom labeling instructions in the UI or configuration file.
  • Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 75e6f93 and 9538c27.

Files selected for processing (1)
  • bin/sozo/Cargo.toml (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • bin/sozo/Cargo.toml

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

Copy link

codecov bot commented Sep 10, 2024

Codecov Report

Attention: Patch coverage is 81.81818% with 8 lines in your changes missing coverage. Please review.

Project coverage is 68.14%. Comparing base (6112180) to head (9538c27).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
bin/sozo/src/commands/auth.rs 0.00% 4 Missing ⚠️
bin/sozo/src/commands/execute.rs 0.00% 1 Missing ⚠️
crates/sozo/ops/src/migration/auto_auth.rs 95.23% 1 Missing ⚠️
crates/sozo/ops/src/register.rs 50.00% 1 Missing ⚠️
crates/sozo/ops/src/test_utils/setup.rs 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2407   +/-   ##
=======================================
  Coverage   68.13%   68.14%           
=======================================
  Files         364      364           
  Lines       47712    47746   +34     
=======================================
+ Hits        32509    32535   +26     
- Misses      15203    15211    +8     

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

Copy link
Collaborator

@glihm glihm left a comment

Choose a reason for hiding this comment

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

Thanks for gating that under a feature.

@@ -198,7 +201,7 @@ pub async fn revoke_writer<A>(
new_writers: &[ResourceWriter],
txn_config: &TxnConfig,
default_namespace: &str,
walnut_debugger: &Option<WalnutDebugger>,
#[cfg(feature = "walnut")] walnut_debugger: &Option<WalnutDebugger>,
Copy link
Collaborator

Choose a reason for hiding this comment

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

weird why fmt is using only one line in this case.

Copy link
Member Author

Choose a reason for hiding this comment

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

yeah im not sure, i dont like the look of it as well but oh well

@kariy kariy merged commit b5403ec into main Sep 10, 2024
15 checks passed
@kariy kariy deleted the walnut-feature branch September 10, 2024 17:17
@kariy kariy mentioned this pull request Sep 19, 2024
@coderabbitai coderabbitai bot mentioned this pull request Oct 1, 2024
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