Skip to content

chore: add test - create and declare received payment in a single transaction #1443

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

Merged
merged 3 commits into from
Aug 27, 2024

Conversation

MantisClone
Copy link
Member

@MantisClone MantisClone commented Aug 15, 2024

Description of the changes

  • Add a test that creates and declares the received payment in a single transaction

Summary by CodeRabbit

  • New Features

    • Enhanced the declarative payments functionality by allowing users to create a payment request and declare a received payment in a single transaction.
  • Tests

    • Introduced a new test case to validate the simultaneous creation of a request and declaration of a received payment.

Copy link
Contributor

coderabbitai bot commented Aug 15, 2024

Walkthrough

The recent update introduces a test case in the request-client.js module that allows for the simultaneous creation of a payment request and the declaration of a received payment within the same transaction. This enhancement improves the declarative payment functionality by enabling users to seamlessly manage both actions, verifying that the balance is updated correctly after the transaction is confirmed.

Changes

File Path Change Summary
packages/request-client.js/test/... Added a new test case in the declarative payments suite to create a request and declare a payment in the same transaction. The test utilizes mock storage and a fake signature provider.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant RequestNetwork
    participant Storage

    User->>RequestNetwork: createRequest(requestInfo)
    RequestNetwork->>Storage: save request with payment declaration
    Storage-->>RequestNetwork: return confirmation
    RequestNetwork->>User: return request confirmation
    User->>RequestNetwork: check balance
    RequestNetwork->>Storage: retrieve updated balance
    Storage-->>RequestNetwork: return updated balance
    RequestNetwork->>User: display updated balance
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>.
    • 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 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.

@MantisClone MantisClone self-assigned this Aug 15, 2024
@MantisClone MantisClone marked this pull request as ready for review August 15, 2024 21:22
@MantisClone MantisClone requested a review from yomarion August 15, 2024 21:23
@github-actions github-actions bot requested a review from leoslr August 15, 2024 21:23
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: ASSERTIVE

Commits

Files that changed from the base of the PR and between 2505a75 and a038cc5.

Files selected for processing (1)
  • packages/request-client.js/test/declarative-payments.test.ts (1 hunks)
Additional context used
Biome
packages/request-client.js/test/declarative-payments.test.ts

[error] 217-217: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

},
});
const requestData = await request.waitForConfirmation();
expect(requestData.balance!.balance).toEqual('10');
Copy link
Contributor

Choose a reason for hiding this comment

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

Avoid using non-null assertions.

The non-null assertion operator (!) is used on requestData.balance!.balance. It's safer to use optional chaining (?.) to avoid potential runtime errors.

- expect(requestData.balance!.balance).toEqual('10');
+ expect(requestData.balance?.balance).toEqual('10');
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
expect(requestData.balance!.balance).toEqual('10');
expect(requestData.balance?.balance).toEqual('10');
Tools
Biome

[error] 217-217: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

@MantisClone MantisClone merged commit 8d41f35 into master Aug 27, 2024
24 checks passed
@MantisClone MantisClone deleted the create-and-declare-received-at-same-time branch August 27, 2024 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants