Refactoring

[arkanoider]

Hi @grunch ,

ok starting with a draft to let you review what i am doing and see if we can really get something better in the end.

I will try to describe the big parts i am trying to do:

• Better/Cleaner error management
• Using more helper functions to improve code readability.
• Diminish at least all CantDo messages call via centralization in main loop.
• Some cosmetics, small functions unions and so on...

I DON'T want to touch any part of the logic, there are many changes but only as "cosmetics" modifications.

I will try to describe a bit more the three main points starting from errors:

errors.rs is now inside mostro-core and now mostro error is an enum with two variants as below:

#[derive(Debug, PartialEq, Eq)]
pub enum MostroError {
    MostroInternalErr(ServiceError),
    MostroCantDo(CantDoReason),
}

• Internal error are for just log on mostro
• CantDo error are the error sent to users via cantDo messages

Now cantDo message are enqued in main loop, here the part in app.rs where the error messages are queued:

 if inner_message.verify() {
                        if let Some(action) = message.inner_action() {
                            if let Err(e) = handle_message_action(
                                &action,
                                message.clone(),
                                &event,
                                &my_keys,
                                &pool,
                                ln_client,
                            )
                            .await
                            {
                                match e.downcast::<MostroError>() {
                                    Ok(err) => {
                                        match err {
                                            MostroError::MostroCantDo(cause) => {
                                                enqueue_cant_do_msg(
                                                    inner_message.request_id,
                                                    inner_message.id,
                                                    cause,
                                                    event.rumor.pubkey,
                                                )
                                                .await
                                            }
                                            MostroError::MostroInternalErr(e) => {
                                                warning_msg(&action, e)
                                            }
                                        };
                                    }
                                    Err(_) => {
                                        todo!()
                                        // warning_msg(&action, e);
                                    }
                                }
                            }
                        }
                    }

There is dequeue in scheduler.rs that checks every second and in case dequeues messages. This has a nice effect on many part of the code like here in take_sell.rs

 if let Err(cause) = order.is_sell_order() {
        return Err(MostroCantDo(cause));
    };
    // Check if the order status is pending
    if let Err(cause) = order.check_status(Status::Pending) {
        return Err(MostroCantDo(cause));
    }

    // Validate that the order was sent from the correct maker
    if let Err(cause) = order.sent_from_maker(event.rumor.pubkey.to_hex()) {
        return Err(MostroCantDo(cause));
    }

Just returning the error should automatically enqueue the message in main loop, and basically after max 1s scheduler will clean queue....

TBC..

[coderabbitai]

Important

Review skipped

Draft detected.

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.

---

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>, 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. (Beta)
• @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.

[grunch]

Hi @arkanoider cACK, I like it, let's go further with this implementation 🚀