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

Credential: put Parse method public #30

Merged
merged 1 commit into from
Sep 17, 2024
Merged

Credential: put Parse method public #30

merged 1 commit into from
Sep 17, 2024

Conversation

bdeneux
Copy link
Contributor

@bdeneux bdeneux commented Sep 17, 2024

Make the Parse method public allowing us to reuse the parsing of a VC from []byte in external lib.

Copy link
Contributor

coderabbitai bot commented Sep 17, 2024

Walkthrough

The changes involve modifications to method names in the Go codebase, specifically within the credential/generate.go and credential/parser.go files, where the method parse has been renamed to Parse to enhance visibility and adhere to Go naming conventions. Additionally, the SubmitClaims method in the testutil/dataverse_mocks.go file has been updated to return a transaction response alongside an error, providing more detailed feedback on transaction submissions.

Changes

File Change Summary
credential/generate.go Renamed func (p *Parser) parse(data []byte) to func (p *Parser) Parse(data []byte)
credential/parser.go Renamed func (cp *DefaultParser) parse(raw []byte) to func (cp *DefaultParser) Parse(raw []byte)
testutil/dataverse_mocks.go Modified func (m *MockDataverseTxClient) SubmitClaims(ctx context.Context, credential *verifiable.Credential) error to func (m *MockDataverseTxClient) SubmitClaims(ctx context.Context, credential *verifiable.Credential) (*types.TxResponse, error)

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant MockDataverseTxClient
    participant TxResponse

    Client->>MockDataverseTxClient: SubmitClaims(credential)
    MockDataverseTxClient->>TxResponse: Process claim submission
    MockDataverseTxClient-->>Client: Return (TxResponse, error)
Loading

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 generate interesting stats about this repository and render them as a table.
    -- @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.

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 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 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.
Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI o1 for code reviews: OpenAI's new o1 model is being tested for generating code suggestions in code reviews.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

Copy link

codecov bot commented Sep 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines Coverage Δ
credential/generate.go 88.23% <100.00%> (ø)
credential/parser.go 92.00% <100.00%> (ø)

... and 1 file with indirect coverage changes

@bdeneux bdeneux requested review from amimart and ccamel September 17, 2024 13:01
@bdeneux bdeneux self-assigned this Sep 17, 2024
@bdeneux bdeneux marked this pull request as ready for review September 17, 2024 13:10
Copy link
Member

@ccamel ccamel left a comment

Choose a reason for hiding this comment

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

😌

Copy link
Member

@amimart amimart left a comment

Choose a reason for hiding this comment

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

👍

@bdeneux bdeneux merged commit 73ee5a2 into main Sep 17, 2024
14 checks passed
@bdeneux bdeneux deleted the feat/parse-public branch September 17, 2024 13:14
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between be90ef1 and 1593420.

Files selected for processing (3)
  • credential/generate.go (1 hunks)
  • credential/parser.go (1 hunks)
  • testutil/dataverse_mocks.go (2 hunks)
Files skipped from review due to trivial changes (2)
  • credential/generate.go
  • credential/parser.go

@@ -13,6 +13,7 @@ import (
context "context"
reflect "reflect"

types "github.com/cosmos/cosmos-sdk/types"
Copy link
Contributor

Choose a reason for hiding this comment

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

Avoid Modifying Generated Code Directly

The file dataverse_mocks.go is generated code, as indicated by the comments at the top (Code generated by MockGen. DO NOT EDIT.). Direct modifications to generated files are discouraged because they will be overwritten the next time the code is regenerated.

Recommendation: Update the source interface in dataverse/client.go or adjust the mock generation command to reflect the changes in the SubmitClaims method signature. This ensures that the generated mocks stay consistent with the actual interface definitions.

Also applies to: 113-118

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.

3 participants