refactor!: remove default protocols and iroh-cli #2928

dignifiedquire · 2024-11-14T11:51:32Z

Description

As previously announced and planned, this removes all protocol implementations from the iroh crate, as well as removes the iroh-cli crate.

The core functionality of those protocols, including RPC & CLI now is in the individual crates.

Remove from `iroh`

iroh-docs
iroh-blobs
iroh-gossip

Examples

Move examples to the appropriate repos: examples: import examples from main repo iroh-blobs#15

Tests

Move the remaining tests to the appropriate repos

CLI

Remove

Breaking Changes

iroh-cli removed
- the crate itself
- the ability to run iroh itself in a docker container, as there is no binary anymore
removed
- iroh::blobs use iroh_blobs
- iroh::docs use iroh_docs
- iroh::gossip use iroh_gossip
- iroh::client::blobs use iroh_blobs::rpc::client. a memory client is available on Blobs
- iroh::client::tags use iroh_blobs::rpc::client. a memory client is available on Blobs
- iroh::client::gossip use iroh_gossip::rpc::client. a memory client is available on Gossip
- iroh::client::docs use iroh_docs::rpc::client. a memory client is available on Docs
- iroh::client::authors use iroh_docs::rpc::client. a memory client is available on Docs
- iroh::node::MemNode, use Node directly
- iroh::node::FsNode, use Node directly
- iroh::node::Node::local_pool_handle
- iroh::node::builder::DocsStorage
- iroh::node::builder::Builder::enable_gc_policy
- iroh::node::builder::Builder::enable_docs
- iroh::node::builder::Builder::register_cb_done
- iroh::node::builder::ProtocolBuilder::local_pool_handle
- iroh::node::builder::GcPolicy
- iroh::util::progress
- iroh::util::path::IrohPaths::BaoStoreDir
- iroh::util::path::IrohPaths::DocsDatabase
- iroh::util::path::IrohPaths::Console
- iroh::util::path::IrohPaths::DefaultAuthor
iroh::node::Builder has no more generic parameters anymore
iroh::node::Node has no more generic parameters anymore

Notes & open questions

Change checklist

Self-review.
Documentation updates following the style guide, if relevant.
Tests if relevant.
All breaking changes documented.

Arqu · 2024-11-19T12:41:18Z

So what's the plan now. Ideally we will set up an iroh-net based example which just tests the connectivity & pipes and we plug that back into netsim and sort out the blobs story on its own.

Also the docker files should not be removed as we still build images for iroh-relay and iroh-dns-server which are arguably much more important anyways. I just need to adapt the images & CI.

github-actions · 2024-11-21T11:39:49Z

Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/2928/docs/iroh/

Last updated: 2024-11-25T20:39:00Z

## Description Moves our netsim tests to run from an example and only test the lib part of the code, not the full CLI & blobs. Things left to do: - [x] rename the example from `new` to anything that makes more sense `netsim` runs it under `iroh-transfer` - [x] clean up the example code - [x] add the option to provide either a relay config or pass in at least the relay url as an argument - [x] continue the CI adjustment and move all invocations of the netsim runner to run from `iroh_v2` and `integration_v2` sims (we want a less abrupt netsim switchover) - [x] convert the remaining sims in `chuck/netsim/sims` to the new format - [ ] after some time flip back the CI invocations to be regular `iroh` and `integration` sims which includes doing the same on `netsim` and removing the old ones ## Breaking Changes  ## Notes & open questions  ## Change checklist - [ ] Self-review. - [ ] Documentation updates following the [style guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text), if relevant. - [ ] Tests if relevant. - [ ] All breaking changes documented.

rklaehn · 2024-11-25T16:23:52Z

iroh/examples/rpc.rs

-where
-    S: Store,
-{
+async fn run(builder: iroh::node::Builder) -> anyhow::Result<()> {
    let node = builder
        .enable_rpc()


I was a bit confused at first what node does now. I thought the idea was that iroh is a pure reexport crate and whenever you build a node like thing you DIY it using the router API. E.g. this enable_rpc enables rpc, but only for the node api, which is almost never what people want if they want rpc.

Is the plan to change this at some point?

yes, that Node will go away, as a follow up to this PR

rklaehn · 2024-11-25T16:24:44Z

iroh/examples/transfer.rs

@@ -0,0 +1,324 @@
+use std::{


This is not really an example but a bench, right?

The intent is for it to be example that we also happen to use for netsim. It benches nothing on it's own though.

rklaehn · 2024-11-25T16:28:17Z

iroh/src/node/builder.rs

    dns_resolver: Option<DnsResolver>,
    node_discovery: DiscoveryConfig,
-    docs_storage: DocsStorage,
    #[cfg(any(test, feature = "test-utils"))]
    insecure_skip_relay_cert_verify: bool,


This mirrors all the options of the endpoint API. I found that somewhat tedious. Have you considered starting this builder with an endpoint builder?

let ep_builder = Endpoint::builder().insecure_skip_relay_cert_verify(true); // do not not call build yet Node::builder(ep_builder).node_specific_stuff().build().await?;

that's a good idea, but this builder will be deleted in a follow up anyway

github-actions · 2024-11-25T16:42:24Z

Netsim report & logs for this PR have been generated and is available at: LOGS
This report will remain available for 3 days.

Last updated for commit: b77d50c

rklaehn

All my reservations are about code that is going to be removed anyway. Also, there seems to be a lot of reformatting of yaml files.

So let's get this over with...

dignifiedquire · 2024-11-25T18:04:35Z

Also, there seems to be a lot of reformatting of yaml files.

yeah sorry, fighting my temporary editor..

Arqu · 2024-11-25T20:42:30Z

Also dropped the required Docker test as it's no longer with us ☠️

dignifiedquire added this to the v0.29.0 milestone Nov 18, 2024

dignifiedquire force-pushed the refactor-drop-external-protocols branch from 430e19a to dda20df Compare November 19, 2024 09:23

dignifiedquire changed the title ~~refactor(iroh): remove external protocols from iroh~~ refactor(iroh)!: remove external protocols from iroh Nov 19, 2024

dignifiedquire changed the title ~~refactor(iroh)!: remove external protocols from iroh~~ refactor!: remove default protocols and iroh-cli Nov 19, 2024

dignifiedquire force-pushed the refactor-drop-external-protocols branch from 5fb1ef0 to 9feb3a4 Compare November 21, 2024 11:25

dignifiedquire self-assigned this Nov 25, 2024

dignifiedquire and others added 13 commits November 25, 2024 16:40

refactor(iroh): remove iroh-docs

3e16412

refactor(iroh): remove iroh-gossip

da0ea80

refactor(iroh): remove iroh-blobs

123fc4d

start updating examples

0172035

fixup examples

1e92e4a

refactor! remove iroh-cli

ba29c70

remove examples depending on iroh-blobs

228722e

cleanup: remove docker

c29c5b1

cleanup some docs

c89c227

fixup docs

ffdfd1d

docker is back

1badc50

skip deprecation

9b3f007

dignifiedquire marked this pull request as ready for review November 25, 2024 15:47

fixups

bc9d420

dignifiedquire force-pushed the refactor-drop-external-protocols branch from f4adb94 to bc9d420 Compare November 25, 2024 15:48

rklaehn reviewed Nov 25, 2024

View reviewed changes

fixup yaml

10cce5f

rklaehn approved these changes Nov 25, 2024

View reviewed changes

slight refactor of the transfer example

dba3d18

Arqu approved these changes Nov 25, 2024

View reviewed changes

eeeh

19345f5

dignifiedquire added this pull request to the merge queue Nov 25, 2024

Merged via the queue into main with commit a956319 Nov 25, 2024
25 of 26 checks passed

dignifiedquire deleted the refactor-drop-external-protocols branch November 28, 2024 10:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor!: remove default protocols and iroh-cli #2928

refactor!: remove default protocols and iroh-cli #2928

dignifiedquire commented Nov 14, 2024 •

edited

Loading

Arqu commented Nov 19, 2024

github-actions bot commented Nov 21, 2024 •

edited

Loading

rklaehn Nov 25, 2024

dignifiedquire Nov 25, 2024

rklaehn Nov 25, 2024

Arqu Nov 25, 2024

rklaehn Nov 25, 2024

dignifiedquire Nov 25, 2024

github-actions bot commented Nov 25, 2024 •

edited

Loading

rklaehn left a comment

dignifiedquire commented Nov 25, 2024

Arqu commented Nov 25, 2024

refactor!: remove default protocols and iroh-cli #2928

refactor!: remove default protocols and iroh-cli #2928

Conversation

dignifiedquire commented Nov 14, 2024 • edited Loading

Description

Remove from iroh

Examples

Tests

Breaking Changes

Notes & open questions

Change checklist

Arqu commented Nov 19, 2024

github-actions bot commented Nov 21, 2024 • edited Loading

rklaehn Nov 25, 2024

Choose a reason for hiding this comment

dignifiedquire Nov 25, 2024

Choose a reason for hiding this comment

rklaehn Nov 25, 2024

Choose a reason for hiding this comment

Arqu Nov 25, 2024

Choose a reason for hiding this comment

rklaehn Nov 25, 2024

Choose a reason for hiding this comment

dignifiedquire Nov 25, 2024

Choose a reason for hiding this comment

github-actions bot commented Nov 25, 2024 • edited Loading

rklaehn left a comment

Choose a reason for hiding this comment

dignifiedquire commented Nov 25, 2024

Arqu commented Nov 25, 2024

dignifiedquire commented Nov 14, 2024 •

edited

Loading

Remove from `iroh`

github-actions bot commented Nov 21, 2024 •

edited

Loading

github-actions bot commented Nov 25, 2024 •

edited

Loading