chore(deps): bump axone-protocol/prolog from v1.0.0 to v2.0.1 #828

ccamel · 2024-11-25T17:56:20Z

Self explanatory.

See:

Summary by CodeRabbit

New Features
- Updated to Prolog library version 2, potentially introducing new features and improvements.
Bug Fixes
- Enhanced error handling in various functions to provide more descriptive error messages.
Documentation
- Import paths updated across multiple files to reflect the transition to version 2 of the Prolog library.
Refactor
- Code structure maintained while updating import paths for consistency and compatibility with the new library version.

coderabbitai · 2024-11-25T17:56:30Z

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 introduces significant updates to the go.mod file and various source files, primarily involving the transition of the Prolog library from version 1 to version 2. Key changes include the removal of certain dependencies and updates to import paths across multiple files. The modifications ensure that the codebase is aligned with the new version of the Prolog library while maintaining existing functionality and logic.

Changes

File Path	Change Summary
go.mod	- Updated `github.com/axone-protocol/prolog` from `v1.0.1-0.20241123121322-d4ffd777d1cd` to `v2.0.0`. - Removed `github.com/goccy/go-yaml`. - Removed `golang.org/x/xerrors`.
x/logic/interpreter/interpreter.go	- Updated import paths from `github.com/axone-protocol/prolog` to `github.com/axone-protocol/prolog/v2` and `github.com/axone-protocol/prolog/engine` to `github.com/axone-protocol/prolog/v2/engine`.
x/logic/interpreter/registry.go	- Updated import paths as above.
x/logic/keeper/interpreter.go	- Updated import paths as above.
x/logic/keeper/metrics.go	- Updated import path for `engine` package.
x/logic/keeper/metrics_test.go	- Updated import path for `engine` package.
x/logic/predicate/address.go	- Updated import path for `engine` package.
x/logic/predicate/atom.go	- Updated import path for `engine` package.
x/logic/predicate/atom_test.go	- Updated import path for `engine` package.
x/logic/predicate/bank.go	- Updated import path for `engine` package.
x/logic/predicate/bank_test.go	- Updated import path for `engine` package.
x/logic/predicate/block.go	- Updated import path for `engine` package.
x/logic/predicate/builtin_test.go	- Updated import path for `engine` package.
x/logic/predicate/chain.go	- Updated import path for `engine` package.
x/logic/predicate/chain_test.go	- Updated import path for `engine` package.
x/logic/predicate/crypto.go	- Updated import path for `engine` package.
x/logic/predicate/crypto_test.go	- Updated import path for `engine` package.
x/logic/predicate/database.go	- Updated import path for `engine` package.
x/logic/predicate/did.go	- Updated import path for `engine` package.
x/logic/predicate/did_test.go	- Updated import path for `engine` package.
x/logic/predicate/encoding.go	- Updated import path for `engine` package.
x/logic/predicate/encoding_test.go	- Updated import paths for `prolog` and `engine` packages.
x/logic/predicate/file.go	- Updated import path for `engine` package.
x/logic/predicate/io.go	- Updated import path for `engine` package.
x/logic/predicate/json.go	- Updated import path for `engine` package.
x/logic/predicate/json_test.go	- Updated import path for `engine` package.
x/logic/predicate/string.go	- Updated import path for `engine` package.
x/logic/predicate/string_test.go	- Updated import path for `engine` package.
x/logic/predicate/term.go	- Updated import path for `engine` package.
x/logic/predicate/uri.go	- Updated import path for `engine` package.
x/logic/predicate/uri_test.go	- Updated import path for `engine` package.
x/logic/predicate/util.go	- Updated import path for `engine` package.
x/logic/prolog/assert.go	- Updated import path for `engine` package.
x/logic/prolog/assert_test.go	- Updated import path for `engine` package.
x/logic/prolog/atom.go	- Updated import path for `engine` package.
x/logic/prolog/byte.go	- Updated import path for `engine` package.
x/logic/prolog/byte_test.go	- Updated import path for `engine` package.
x/logic/prolog/context.go	- Updated import path for `engine` package.
x/logic/prolog/encode.go	- Updated import path for `engine` package.
x/logic/prolog/error.go	- Updated import path for `engine` package.
x/logic/prolog/hex.go	- Updated import path for `engine` package.
x/logic/prolog/hex_test.go	- Updated import path for `engine` package.
x/logic/prolog/json.go	- Updated import path for `engine` package.
x/logic/prolog/json_test.go	- Updated import path for `engine` package.
x/logic/prolog/list.go	- Updated import path for `engine` package.
x/logic/prolog/list_test.go	- Updated import path for `engine` package.
x/logic/prolog/option.go	- Updated import path for `engine` package.
x/logic/prolog/option_test.go	- Updated import path for `engine` package.
x/logic/prolog/text.go	- Updated import path for `engine` package.
x/logic/prolog/tuple.go	- Updated import path for `engine` package.
x/logic/prolog/unify.go	- Updated import path for `engine` package.
x/logic/testutil/logic.go	- Updated import paths for `prolog` and `engine` packages.
x/logic/util/prolog.go	- Updated import paths for `prolog` and `engine` packages.

Possibly related PRs

Refactor and improve json_prolog/2 predicate #782: The changes in the main PR involve updating the github.com/axone-protocol/prolog dependency to version 2.0.0, which is directly related to the modifications made in the json.go file of PR Refactor and improve json_prolog/2 predicate #782, where the handling of JSON-related terms and the JSONProlog function were significantly refactored to improve functionality and error handling.
Feat/telemetry #810: The telemetry features introduced in PR Feat/telemetry #810 enhance the functionality of the interpreter, which may be impacted by the updates to the Prolog library in the main PR, particularly in how predicates are processed and monitored.
Feat/expose database predicates #812: The exposure of database predicates in PR Feat/expose database predicates #812 aligns with the changes made in the main PR regarding the Prolog library update, as it may affect how these predicates interact with the updated engine functionalities.

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

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

coderabbitai

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (9)

x/logic/predicate/block.go (2)
Line range hint 31-49: Consider preserving timestamp precision

The function converts block time to Unix timestamp (seconds), which might lose precision. Consider using nanoseconds or a more precise representation if millisecond/microsecond precision is important for your use case.

Example improvement:
-return engine.Unify(vm, time, engine.Integer(sdkContext.BlockTime().Unix()), cont, env)
+return engine.Unify(vm, time, engine.Integer(sdkContext.BlockTime().UnixNano()), cont, env)
Add migration examples for deprecated block_height/1 predicate

The deprecation notice should include migration examples to help users transition from block_height/1 to block_header/1. Based on the feature tests, here's how to update the documentation:
// Deprecated: Use the `block_header/1` predicate instead.
// Migration example:
//   Old: block_height(Height)
//   New: block_header(Header), Height = Header.height
The migration path is clearly demonstrated in the feature tests and should be documented in the deprecation notice

The new approach provides more functionality as it gives access to the entire block header, not just the height

Similar migration patterns are used for other deprecated block predicates

🔗 Analysis chain

Line range hint 11-29: Consider adding migration guide for deprecated function

While the deprecation notice points users to block_header/1, it would be helpful to provide a code example showing how to migrate from block_height to block_header/1.

Let me gather more information about the block_header implementation to provide accurate migration guidance.
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Look for block_header/1 implementation and documentation

# Search for block_header predicate implementation
ast-grep --pattern 'func $_($_, $_) { $$$ block_header $$$ }'

# Search for block_header documentation
rg -A 5 "block_header/1"
Length of output: 3480

Script:
#!/bin/bash
# Search for BlockHeader implementation
ast-grep --pattern 'func BlockHeader($$$) {
  $$$
}'

# Search for block_header example usage in feature files
rg -A 10 "block_header\\(" x/logic/predicate/features/
Length of output: 3264
x/logic/predicate/chain.go (1)
Line range hint 119-134: Consider implementing a migration strategy for deprecated ChainID function

While the function is properly marked as deprecated with a clear alternative (block_header/1), we should consider:

Adding a timeline for removal

Providing migration examples in the documentation

Consider adding a comment with migration examples:
 // ChainID is a predicate which unifies the given term with the current chain ID. The signature is:
 //
 // The signature is as follows:
 //
 //	chain_id(?ID)
 //
 // where:
 //   - ID represents the current chain ID at the time of the query.
 //
 // Deprecated: Use the `block_header/1` predicate instead.
+// Migration example:
+//   Old: chain_id(ID)
+//   New: block_header(Header), get_dict(chain_id, Header, ID)
x/logic/predicate/encoding_test.go (1)
Line range hint 123-149: Consider minor improvements to the helper function

While the helper function is well-implemented, it could be more maintainable with some refinements.

Consider this improved version:
 func checkSolutions(sols *prolog.Solutions, wantResult []testutil.TermResults, wantSuccess bool, wantError error) {
-    var got []testutil.TermResults
-    for sols.Next() {
-        m := testutil.TermResults{}
-        err := sols.Scan(m)
-        So(err, ShouldBeNil)
-
-        got = append(got, m)
-    }
+    var actualResults []testutil.TermResults
+    for sols.Next() {
+        currentResult := testutil.TermResults{}
+        err := sols.Scan(currentResult)
+        So(err, ShouldBeNil)
+        actualResults = append(actualResults, currentResult)
+    }
+
     if wantError != nil {
         So(sols.Err(), ShouldNotBeNil)
         So(sols.Err().Error(), ShouldEqual, wantError.Error())
-    } else {
-        So(sols.Err(), ShouldBeNil)
-
-        if wantSuccess {
-            So(len(got), ShouldEqual, len(wantResult))
-            for iGot, resultGot := range got {
-                for varGot, termGot := range resultGot {
-                    So(testutil.ReindexUnknownVariables(termGot), ShouldEqual, wantResult[iGot][varGot])
-                }
-            }
-        } else {
-            So(len(got), ShouldEqual, 0)
-        }
+        return
     }
+
+    So(sols.Err(), ShouldBeNil)
+    if !wantSuccess {
+        So(len(actualResults), ShouldEqual, 0)
+        return
+    }
+
+    So(len(actualResults), ShouldEqual, len(wantResult))
+    for i, result := range actualResults {
+        for varName, term := range result {
+            So(testutil.ReindexUnknownVariables(term), ShouldEqual, wantResult[i][varName])
+        }
+    }
 }
x/logic/predicate/string_test.go (1)
Line range hint 24-146: Consider grouping and documenting test case categories

The test cases are comprehensive and well-structured, covering various scenarios including error conditions. Consider adding comments to group test cases by their purpose (e.g., "Success cases", "Error cases", "Edge cases") to improve maintainability.

Example structure:
 func TestReadString(t *testing.T) {
 	Convey("Given a test cases", t, func() {
 		cases := []struct {
+			// Test case categories:
+			// - Basic string reading
+			// - Multi-byte character handling
+			// - Error conditions
+			// - Length constraints
 			input       string
 			program    string
x/logic/predicate/json.go (1)

Line range hint 32-53: Consider leveraging new features from Prolog v2

The current implementation has a robust error handling system. It might be worth investigating if Prolog v2 offers any new features or improvements that could simplify this error handling or enhance the JSON-Prolog conversions.

Consider:

Checking if v2 provides built-in JSON handling utilities

Looking for improved stream handling capabilities

Exploring any new error types or handling mechanisms
x/logic/predicate/json_test.go (2)
Line range hint 422-516: Consider adding property-based tests

While the test cases are comprehensive, consider adding property-based tests for the bidirectional JSON-Prolog conversion to catch edge cases systematically.

Example implementation:
func TestJsonPrologProperties(t *testing.T) {
    Convey("Given a property-based test", t, func() {
        properties := &quick.Config{
            MaxCount: 1000,
        }
        f := func(jsonObj map[string]interface{}) bool {
            // Convert to JSON string
            jsonBytes, err := json.Marshal(jsonObj)
            if err != nil {
                return true // Skip invalid JSON
            }
            
            // Test bidirectional conversion
            // Implementation details...
            
            return true
        }
        So(quick.Check(f, properties), ShouldBeNil)
    })
}
Line range hint 517-589: Consider consolidating stream error tests

The stream error test cases in TestJSONRead and TestJSONWrite have similar patterns. Consider using a test helper function to reduce code duplication.

Example implementation:
func testStreamErrors(t *testing.T, testFn func(stream engine.Term, env *engine.Env) (*engine.VM, error)) {
    cases := []struct {
        name           string
        stream         func() engine.Term
        wantErrorMatch string
    }{
        // Common test cases...
    }
    
    for _, tc := range cases {
        t.Run(tc.name, func(t *testing.T) {
            // Common test logic...
        })
    }
}
x/logic/predicate/bank_test.go (1)
Line range hint 829-829: Consider adding benchmarks and improving readability

Two suggestions for enhancing the test suite:

Consider adding sub-benchmarks to measure performance of different predicate operations

Consider breaking down long lines (currently marked with //nolint:lll) into more readable structures

Example benchmark structure:
func BenchmarkBankPredicates(b *testing.B) {
    b.Run("BankBalances", func(b *testing.B) {
        // benchmark implementation
    })
    b.Run("SpendableBalances", func(b *testing.B) {
        // benchmark implementation
    })
}

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e5a863f and 261c8bd.

⛔ Files ignored due to path filters (1)

go.sum is excluded by !**/*.sum

📒 Files selected for processing (53)

go.mod (1 hunks)
x/logic/interpreter/interpreter.go (1 hunks)
x/logic/interpreter/registry.go (1 hunks)
x/logic/keeper/interpreter.go (1 hunks)
x/logic/keeper/metrics.go (1 hunks)
x/logic/keeper/metrics_test.go (1 hunks)
x/logic/predicate/address.go (1 hunks)
x/logic/predicate/atom.go (1 hunks)
x/logic/predicate/atom_test.go (1 hunks)
x/logic/predicate/bank.go (1 hunks)
x/logic/predicate/bank_test.go (1 hunks)
x/logic/predicate/block.go (1 hunks)
x/logic/predicate/builtin_test.go (1 hunks)
x/logic/predicate/chain.go (1 hunks)
x/logic/predicate/chain_test.go (1 hunks)
x/logic/predicate/crypto.go (1 hunks)
x/logic/predicate/crypto_test.go (1 hunks)
x/logic/predicate/database.go (1 hunks)
x/logic/predicate/did.go (1 hunks)
x/logic/predicate/did_test.go (1 hunks)
x/logic/predicate/encoding.go (1 hunks)
x/logic/predicate/encoding_test.go (1 hunks)
x/logic/predicate/file.go (1 hunks)
x/logic/predicate/io.go (1 hunks)
x/logic/predicate/json.go (1 hunks)
x/logic/predicate/json_test.go (1 hunks)
x/logic/predicate/string.go (1 hunks)
x/logic/predicate/string_test.go (1 hunks)
x/logic/predicate/term.go (1 hunks)
x/logic/predicate/uri.go (1 hunks)
x/logic/predicate/uri_test.go (1 hunks)
x/logic/predicate/util.go (1 hunks)
x/logic/prolog/assert.go (1 hunks)
x/logic/prolog/assert_test.go (1 hunks)
x/logic/prolog/atom.go (1 hunks)
x/logic/prolog/byte.go (1 hunks)
x/logic/prolog/byte_test.go (1 hunks)
x/logic/prolog/context.go (1 hunks)
x/logic/prolog/encode.go (1 hunks)
x/logic/prolog/error.go (1 hunks)
x/logic/prolog/hex.go (1 hunks)
x/logic/prolog/hex_test.go (1 hunks)
x/logic/prolog/json.go (1 hunks)
x/logic/prolog/json_test.go (1 hunks)
x/logic/prolog/list.go (1 hunks)
x/logic/prolog/list_test.go (1 hunks)
x/logic/prolog/option.go (1 hunks)
x/logic/prolog/option_test.go (1 hunks)
x/logic/prolog/text.go (1 hunks)
x/logic/prolog/tuple.go (1 hunks)
x/logic/prolog/unify.go (1 hunks)
x/logic/testutil/logic.go (1 hunks)
x/logic/util/prolog.go (1 hunks)

✅ Files skipped from review due to trivial changes (37)

x/logic/keeper/metrics.go
x/logic/keeper/metrics_test.go
x/logic/predicate/address.go
x/logic/predicate/atom.go
x/logic/predicate/atom_test.go
x/logic/predicate/bank.go
x/logic/predicate/chain_test.go
x/logic/predicate/crypto.go
x/logic/predicate/database.go
x/logic/predicate/did.go
x/logic/predicate/did_test.go
x/logic/predicate/encoding.go
x/logic/predicate/file.go
x/logic/predicate/io.go
x/logic/predicate/string.go
x/logic/predicate/term.go
x/logic/predicate/uri.go
x/logic/predicate/uri_test.go
x/logic/predicate/util.go
x/logic/prolog/assert.go
x/logic/prolog/assert_test.go
x/logic/prolog/atom.go
x/logic/prolog/byte.go
x/logic/prolog/context.go
x/logic/prolog/encode.go
x/logic/prolog/error.go
x/logic/prolog/hex.go
x/logic/prolog/hex_test.go
x/logic/prolog/json.go
x/logic/prolog/json_test.go
x/logic/prolog/list.go
x/logic/prolog/list_test.go
x/logic/prolog/option.go
x/logic/prolog/option_test.go
x/logic/prolog/text.go
x/logic/prolog/tuple.go
x/logic/prolog/unify.go

🧰 Additional context used

📓 Path-based instructions (15)

x/logic/interpreter/interpreter.go (1)