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

ockam_node improvements #1948

Open
SanjoDeundiak opened this issue Oct 7, 2021 · 5 comments
Open

ockam_node improvements #1948

SanjoDeundiak opened this issue Oct 7, 2021 · 5 comments

Comments

@SanjoDeundiak
Copy link
Member

SanjoDeundiak commented Oct 7, 2021

  1. Make crate-public if possible:

    • NullWorker
    • Mailbox
    • NodeReplyResult
    • NodeError
    • NodeMessage
    • NodeReply
  2. Make Executor functions crate-public

  3. Refactor Cancel API to shorten calls like this

    let m = child_ctx.receive::<String>().await?.take().body();

    to this

    let m = child_ctx.receive::<String>().await?.body();

    Possible solution: merge cancel capability into Routed struct

  4. Improve crate description

  5. Mention route! macro in send and send_from_address functions description

  6. Update forward function description

  7. Update receive* functions description

  8. Improve start_node description

  9. Not counting tests: 7 TODOs, 2 FIXMEs, 11 unwraps, 2 panics, 1 expect

  10. Fix cargo clippy warnings (there are 16)

  11. Add usage examples for Context functions: address, aliases, new_context, start_worker, start_processor, stop_worker, stop_processor, stop, send, send_from_address, forward, receive*

@mrinalwadhwa
Copy link
Member

Awesome! Thank you @SanjoDeundiak let's break this down into smaller sub issues.

@abhishekc-sharma
Copy link
Contributor

Has this been broken down into smaller issues ? I can take on some of tasks if required.

@SanjoDeundiak
Copy link
Member Author

Hey @abhishekc-sharma ! That would be great. Which tasks do you want to take?

@mrinalwadhwa
Copy link
Member

Maybe this is a good place to start:

Fix cargo clippy warnings (there are 16)

Also note this PR from @spacekookie is making improvements to ockam_node
#2007

@abhishekc-sharma
Copy link
Contributor

That seems like a good place to start @mrinalwadhwa . Will fix the cargo clippy warnings to start with.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants