fix: declarative actions on meta pn

[leoslr]

Description of the changes

Follow up on #1405

The default declarative values were missing when we were creating the meta-pn extension. It was not possible to perform declarative actions at the meta-pn level, such as declareReceivedPayment or declareSentPayment

Summary by CodeRabbit

• New Features

  • Enhanced payment network functionality to support declaring sent payments with additional metadata.

• Bug Fixes

  • Improved error handling in payment detection to prevent issues with null or incorrect values.

• Tests

  • Added comprehensive tests to validate declaring sent payments, including scenarios with and without previous state data.
  • Updated mock data in tests to include default values for various payment-related fields.

[coderabbitai]

Walkthrough

The updates across the various modules refine the MetaPaymentNetwork class by enhancing its applyCreation method to merge generic action values, introduce comprehensive tests for the declarative payment actions, and add type checks in the MetaDetector class for robust validation. Additional mock data fields are incorporated to support the new and existing test cases, ensuring thorough validation of payment-related functionalities.

Changes

Files / Modules	Change Summary
.../extensions/payment-network/meta.ts	Introduced genericCreationAction constant and merged its values with applyCreation.
.../extensions/payment-network/meta.test.ts	Added new test cases for applyActionToExtension/declareSentPayment functionality.
.../utils/payment-network/meta-pn-data-generator.ts	Added constants and declarations for payment details, updated states with payment amounts.
.../meta-payment-detector.ts	Added type checking before proceeding with operations on value objects.
.../meta-payment-network.test.ts	Enhanced requestMock with default fields for payment and refund information.

Poem

In the land of code, where payments flow,
Meta networks gleam and grow,
Tests declare, and values merge,
Ensuring processes never diverge.
Each change a step, so clear and bright,
In the digital realm, all’s set right.

---

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
• Mastodon
• Reddit
• LinkedIn

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 Configration 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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 3215d08 and 867e3bf.

Files selected for processing (3)

• packages/advanced-logic/src/extensions/payment-network/meta.ts (2 hunks)
• packages/advanced-logic/test/extensions/payment-network/meta.test.ts (1 hunks)
• packages/advanced-logic/test/utils/payment-network/meta-pn-data-generator.ts (5 hunks)

Additional comments not posted (8)

packages/advanced-logic/src/extensions/payment-network/meta.ts (2)

116-117: Encapsulation of generic creation logic looks good.

The introduction of genericCreationAction encapsulates the generic creation logic, improving code readability and maintainability.

---

Line range hint 119-132:
Merging generic creation logic with specific values is correct.

This ensures that the generic creation logic is combined with specific values, maintaining the correct state of the extension.

packages/advanced-logic/test/utils/payment-network/meta-pn-data-generator.ts (4)

18-20: Declarations of amount, note, and txHash are straightforward.

These declarations are necessary for the actionDeclareSentPayment object.

---

77-86: Introduction of actionDeclareSentPayment is correct.

This object is necessary for testing the declareSentPayment functionality.

---

115-118: Addition of payment and refund amount properties is necessary.

These properties are necessary to track the payment and refund amounts.

---

163-166: Addition of payment and refund amount properties is necessary.

These properties are necessary to track the payment and refund amounts.

packages/advanced-logic/test/extensions/payment-network/meta.test.ts (2)

378-390: New test case for declareSentPayment is correct.

This test case ensures that the declareSentPayment action works correctly.

---

392-402: New test case for declareSentPayment without a previous state is correct.

This test case ensures that the declareSentPayment action is not allowed without a previous state.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 867e3bf and 7ab5735.

Files selected for processing (2)

• packages/payment-detection/src/meta-payment-detector.ts (1 hunks)
• packages/payment-detection/test/meta-payment-network.test.ts (1 hunks)

Additional comments not posted (2)

packages/payment-detection/src/meta-payment-detector.ts (1)

141-145: LGTM! The type check enhances robustness.

The added type check ensures that only valid objects are processed, preventing potential runtime errors.

packages/payment-detection/test/meta-payment-network.test.ts (1)

109-116: LGTM! The added default values ensure comprehensive test coverage.

Including default values for payeeDelegate, payerDelegate, paymentInfo, refundInfo, receivedPaymentAmount, receivedRefundAmount, sentPaymentAmount, and sentRefundAmount ensures comprehensive test coverage and data consistency.