Skip to content

Add In Progress status#96

Merged
grunch merged 1 commit into
developfrom
feature-nip69-status
Mar 27, 2025
Merged

Add In Progress status#96
grunch merged 1 commit into
developfrom
feature-nip69-status

Conversation

@arkanoider

@arkanoider arkanoider commented Mar 25, 2025

Copy link
Copy Markdown
Collaborator

@grunch @Catrya

added in progress status for align behaviour to nip69.

Summary by CodeRabbit

  • New Features
    • Introduced an "in-progress" order status to give users a clearer view of order processing states.
    • Orders now display and are recognized with the "in-progress" label, ensuring more accurate status tracking.

@coderabbitai

coderabbitai Bot commented Mar 25, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

This change updates the order status functionality by adding an InProgress variant to the Status enum in the src/order.rs file. The update involves modifying the enum declaration, the Display trait's formatting, and the FromStr trait for parsing strings. The new changes allow the system to handle an "in-progress" state for orders.

Changes

File(s) Change Summary
src/order.rs - Added InProgress variant to the Status enum.
- Updated the Display implementation to return "in-progress" for the new variant.
- Modified the FromStr implementation to recognize "in-progress" as InProgress.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant OrderStatus

    Client->>OrderStatus: Call fmt() with Status::InProgress
    OrderStatus-->>Client: Return "in-progress"
Loading
sequenceDiagram
    participant Client
    participant OrderStatus

    Client->>OrderStatus: Call from_str("in-progress")
    OrderStatus-->>Client: Return Status::InProgress
Loading

Poem

In the code burrow deep and swift,
I’ve hopped to add a brand new shift.
Now orders whisper "in-progress" clear,
A change so fresh, a bunny cheer!
Off I hop with a joyful twitch!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/order.rs (1)

48-64: Consider documenting the new status

While the implementation is correct, the purpose and context of when the "InProgress" status should be used isn't documented. Consider adding a brief comment describing when an order should be marked as "in-progress" vs. other similar statuses.

pub enum Status {
    Active,
    Canceled,
    CanceledByAdmin,
    SettledByAdmin,
    CompletedByAdmin,
    Dispute,
    Expired,
    FiatSent,
    SettledHoldInvoice,
    Pending,
    Success,
    WaitingBuyerInvoice,
    WaitingPayment,
    CooperativelyCanceled,
+    /// Order is currently being processed according to nip69 specification
    InProgress,
}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 042cb2f and 7c7934a.

📒 Files selected for processing (1)
  • src/order.rs (3 hunks)
🔇 Additional comments (4)
src/order.rs (4)

63-63: LGTM: Adding InProgress status to the Status enum

This change adds a new enum variant to represent an "in-progress" state for orders, aligning with nip69 as mentioned in the PR description.


83-83: LGTM: Display implementation for InProgress

The Display trait implementation is properly updated to format the new Status::InProgress variant as "in-progress", consistent with the kebab-case format used for other statuses.


107-107: LGTM: FromStr implementation for InProgress

The FromStr trait implementation correctly handles parsing "in-progress" strings into the Status::InProgress variant, maintaining the bidirectional conversion between string representations and enum variants.


48-64:

Details

✅ Verification successful

Verify completeness of status transition validations

The code appears to have validation logic for status transitions in methods like check_status(). Ensure that any code paths that rely on status checks are updated to handle the new InProgress status appropriately.


🏁 Script executed:

#!/bin/bash
# Look for any status-checking logic or status transitions in the codebase
rg -A 5 "check_status|Status::" --type rust | grep -v "FromStr\|Display"

Length of output: 5049


Status transition update verified:
We confirmed that the new InProgress status is now fully integrated across the codebase. In particular:

  • In src/order.rs:

    • The InProgress variant is defined in the Status enum with the correct string representation ("in-progress").
    • Methods such as check_status() and status conversions properly handle all enum variants including InProgress.
  • In src/dispute.rs:

    • The InProgress status is also managed correctly within status formatting logic.

All status-related validations and transitions have been updated to include InProgress consistently. No additional changes are required from what was initially flagged.

@Catrya Catrya left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hi @arkanoider great job!
The only thing that doesn't work well yet is that when an order is taken, it goes to in-progress (that's fine), but when the taker puts the invoice if they're a buyer, or pays the hold invoice if they're a seller, order event it's published again with the status in-progress.
It should only be published when the taker takes it, not also when it moves to the next status in the DB.

Everything else I told you yesterday already works perfectly.

@arkanoider

Copy link
Copy Markdown
Collaborator Author

Hi @arkanoider great job!
The only thing that doesn't work well yet is that when an order is taken, it goes to in-progress (that's fine), but when the taker puts the invoice if they're a buyer, or pays the hold invoice if they're a seller, order event it's published again with the status in-progress.
It should only be published when the taker takes it, not also when it moves to the next status in the DB.

Everything else I told you yesterday already works perfectly.

uh yes probably i have to refine that edge case!
Will look asap to that case!

@Catrya

Catrya commented Mar 26, 2025

Copy link
Copy Markdown
Member

Hi @arkanoider great job!
The only thing that doesn't work well yet is that when an order is taken, it goes to in-progress (that's fine), but when the taker puts the invoice if they're a buyer, or pays the hold invoice if they're a seller, order event it's published again with the status in-progress.
It should only be published when the taker takes it, not also when it moves to the next status in the DB.
Everything else I told you yesterday already works perfectly.

uh yes probably i have to refine that edge case! Will look asap to that case!

Sorry, I just realized I put the review here in mostro-core instead of mostrod 😅

@arkanoider

Copy link
Copy Markdown
Collaborator Author

Hi @arkanoider great job!
The only thing that doesn't work well yet is that when an order is taken, it goes to in-progress (that's fine), but when the taker puts the invoice if they're a buyer, or pays the hold invoice if they're a seller, order event it's published again with the status in-progress.
It should only be published when the taker takes it, not also when it moves to the next status in the DB.
Everything else I told you yesterday already works perfectly.

uh yes probably i have to refine that edge case! Will look asap to that case!

Sorry, I just realized I put the review here in mostro-core instead of mostrod 😅

Don't worry it's clear...

@grunch grunch left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@grunch grunch merged commit ec71afe into develop Mar 27, 2025
@grunch grunch deleted the feature-nip69-status branch March 27, 2025 19:12
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