Feat/block header 1 - Githubissues

ccamel commented 6 days ago

Takes advantage of the support for Dicts introduced in https://github.com/axone-protocol/prolog/pull/17 to expose the current block header in this format through the new block_header/1 predicate.

This includes updating the examples and deprecating the block_time/1, block_height/1, and chain_id/1 predicates which have been retained for compatibility.

NB: The block_header/1 predicate is slightly more costly due to the systematic transformation of the header structure into a Prolog Dict and its unification, regardless of how it is subsequently used. This contrasts with predicates like block_height/1, which specifically targeted a single field of the header.

Summary by CodeRabbit

Release Notes

New Features
- Introduced the block_header/1 predicate for retrieving current block header properties.
- Added scenarios for testing block header retrieval, block height, and block time in Prolog.
Deprecations
- Marked BlockHeight and BlockTime predicates as deprecated; users are encouraged to use block_header/1.
- Deprecated predicates block_height/1, block_time/1, and chain_id/1 for compatibility.
Bug Fixes
- Updated expected output formats in feature tests for asserta/1 and assertz/1 to align with Prolog syntax.
Chores
- Updated dependency versions for improved stability and performance.

coderabbitai[bot] commented 6 days ago

[!IMPORTANT]

Review skipped

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

Walkthrough

The pull request includes updates to the go.mod file, modifying dependency versions and adding new dependencies. It also introduces changes to the interpreter package's predicate registry, marking some predicates as deprecated while adding a new one. Additionally, several feature files have been updated for consistency in expected output formats, while a new feature file for testing block_header/1 has been introduced. Two feature files have been deleted, and modifications in the test file streamline YAML handling. Finally, new and deprecated predicates have been added or marked in the predicate package.

Changes

File Path	Change Summary
go.mod	Updated dependency versions, added `github.com/goccy/go-yaml v1.9.7` and `gopkg.in/yaml.v3 v3.0.1` (indirect).
x/logic/interpreter/registry.go	Deprecated predicates `block_height/1`, `block_time/1`, `chain_id/1`, added new predicate `./3` mapped to `engine.Op3`.
x/logic/keeper/features/asserta_1.feature	Updated expected output formats for variable expressions in scenarios.
x/logic/keeper/features/assertz_1.feature	Adjusted expected output formats for variable expressions in scenarios.
x/logic/keeper/features/block_header_1.feature	Added new feature for testing `block_header/1` with multiple scenarios.
x/logic/keeper/features/block_height_1.feature	Deleted file containing tests for `block_height/2`.
x/logic/keeper/features/block_time_1.feature	Deleted file containing tests for `block_time/2`.
x/logic/keeper/features_test.go	Changed YAML import from `gopkg.in/yaml.v3` to `sigs.k8s.io/yaml`, simplified test case structure with new parsing function.
x/logic/predicate/block.go	Deprecated `BlockHeight` and `BlockTime` predicates, retaining core functionality.
x/logic/predicate/chain.go	Added new `BlockHeader` predicate, deprecated `ChainID` predicate.

Possibly related PRs

776: Involves updates to the go.mod file, including dependency version updates, which may relate to overall dependency management.

Suggested reviewers

bdeneux
amimart

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 , 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 6 days ago

Codecov Report

Attention: Patch coverage is 76.19048% with 15 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
x/logic/predicate/chain.go	76.19%	10 Missing and 5 partials :warning:

@@            Coverage Diff             @@
##             main     #824      +/-   ##
==========================================
+ Coverage   42.98%   45.08%   +2.09%     
==========================================
  Files         113      113              
  Lines        6325     6388      +63     
==========================================
+ Hits         2719     2880     +161     
+ Misses       3480     3373     -107     
- Partials      126      135       +9

Files with missing lines	Coverage Δ
x/logic/interpreter/registry.go	`81.81% <ø> (ø)`
x/logic/predicate/block.go	`0.00% <ø> (ø)`
x/logic/predicate/chain.go	`74.28% <76.19%> (+17.14%)`	:arrow_up:

... and 5 files with indirect coverage changes

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests

ccamel commented 6 days ago

@coderabbitai resolve

coderabbitai[bot] commented 6 days ago

:white_check_mark: Actions performed

Comments resolved and changes approved.

axone-protocol / axoned

Feat/block header 1 #824

Summary by CodeRabbit

Release Notes

Review skipped

Walkthrough

Changes

Possibly related PRs

776: Involves updates to the `go.mod` file, including dependency version updates, which may relate to overall dependency management.

Suggested reviewers

Codecov Report

axone-protocol / axoned

Feat/block header 1 #824

Summary by CodeRabbit

Release Notes

Review skipped

Walkthrough

Changes

Possibly related PRs

776: Involves updates to the go.mod file, including dependency version updates, which may relate to overall dependency management.

Suggested reviewers

Codecov Report

776: Involves updates to the `go.mod` file, including dependency version updates, which may relate to overall dependency management.