search

build-trust / ockam

Orchestrate end-to-end encryption, cryptographic identities, mutual authentication, and authorization policies between distributed applications – at massive scale.
https://ockam.io
Apache License 2.0
4.47k stars 562 forks source link

ockam_node improvements #1948

Open SanjoDeundiak opened 3 years ago

SanjoDeundiak commented 3 years ago

  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 commented 3 years ago

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

abhishekc-sharma commented 3 years ago

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

SanjoDeundiak commented 3 years ago

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

mrinalwadhwa commented 3 years ago

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 https://github.com/ockam-network/ockam/pull/2007

abhishekc-sharma commented 3 years ago

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