axone-protocol / axoned

⛓️ Axone blockchain πŸ’«
https://axone.xyz
Apache License 2.0
162 stars 121 forks source link

🧠 Use our own `axone/prolog` fork in logic module #703

Closed bdeneux closed 1 month ago

bdeneux commented 1 month ago

πŸ“ Description

This PR replace ichiban/prolog module with our own fork axone-protocol/prolog. By doing this, since it's contains breaking changes, we need to align current implementation with this new module.

πŸ‘¨πŸ»β€πŸ”§ Fixes

This fork contains fixes for those issues :

πŸ‘©β€πŸ’» Related development

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent changes enhance the functionality and configurability of a Go project, particularly within the Prolog interpreter and its associated components. Key updates include the introduction of a maximum variable limit, improvements in error handling, and the adoption of ordered maps for better predicate management. These enhancements streamline resource management and improve testing capabilities, thereby refining overall performance and robustness.

Changes

Files Change Summary
go.mod Added new dependencies and replaced a Prolog interpreter library.
proto/.../params.proto Introduced max_variables field in Limits message to set a limit on variable creation.
x/logic/interpreter/interpreter.go Added WithMaxVariables function and modified interpreter initialization for better configurability.
x/logic/interpreter/registry.go Switched from a standard map to an ordered map for preserving predicate order.
x/logic/keeper/features/*.feature Updated gas_used values in multiple feature tests to reflect adjusted performance metrics.
x/logic/keeper/grpc_query_ask_test.go Added maxVariables to tests and updated expected error messages for resource limits.
x/logic/keeper/grpc_query_params_test.go Invoked WithMaxVariables in test case for parameter validation.
x/logic/keeper/interpreter.go Updated newInterpreter to accept max variable limit for improved resource management.
x/logic/prolog/tuple.go Changed tuple representation from engine.Atom(0) to engine.Atom("").
x/logic/types/params.go Introduced DefaultMaxVariables and a new function WithMaxVariables for limit management.
x/logic/types/params_test.go Added WithMaxVariables in TestValidateParams to enforce stricter validation.
x/logic/util/prolog.go Enhanced error handling in QueryInterpreter for more precise error reporting.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Interpreter
    participant ErrorHandler

    User->>Interpreter: Execute query with variables
    Interpreter->>ErrorHandler: Check for variable limits
    ErrorHandler-->>Interpreter: Return error if limit exceeded
    Interpreter-->>User: Return results or error

🐰 "In the garden where ideas bloom,
New variables dance, dispelling gloom.
With ordered maps and limits set,
Our Prolog tales are not done yet!
Let’s hop along, with joy we cheer,
For every change brings us near!" ✨


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 Configuration 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.
bdeneux commented 1 month ago

@amimart This PR is now ready until we release axone-protocol/prolog πŸ˜‡

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 54.54545% with 5 lines in your changes missing coverage. Please review.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #703      +/-   ##
==========================================
+ Coverage   54.37%   54.42%   +0.05%     
==========================================
  Files          73       73              
  Lines        2893     2901       +8     
==========================================
+ Hits         1573     1579       +6     
- Misses       1226     1228       +2     
  Partials       94       94              
Files Coverage Ξ”
x/logic/keeper/interpreter.go 94.80% <100.00%> (+0.06%) :arrow_up:
x/logic/types/params.go 94.73% <100.00%> (+0.37%) :arrow_up:
x/logic/prolog/tuple.go 0.00% <0.00%> (ΓΈ)
x/logic/util/prolog.go 0.00% <0.00%> (ΓΈ)