create a new hc command to run a holochain webrtc signal server #2265

neonphog · 2023-04-21T23:16:23Z

Summary

Adds a new hc signal-srv command to run a local holochain webrtc signal server that can be passed into a command like hc sandbox generate network webrtc ws://127.0.0.1:xxx.

TODO:

CHANGELOG(s) updated with appropriate info
Just before pressing the merge button, ensure new entries to CHANGELOG(s) are still under the UNRELEASED heading

ThetaSinner · 2023-04-24T20:08:50Z

crates/holochain_sqlite/Cargo.toml

@@ -38,7 +38,7 @@ page_size = "0.4.2"
 parking_lot = "0.10"
 rand = "0.8.5"
 r2d2 = "0.8"
-r2d2_sqlite = "0.21"
+r2d2_sqlite = { version = "0.1", package = "r2d2_sqlite_neonphog" }


What's changing here going from the original package to this one?

@ThetaSinner Alas, r2d2 is now unmaintained... i needed to update a dependency, so I published a fork of it. We can evaluate if we want to switch to a different dependency / or just roll our own connection pool at a later date.

jost-s

Looks all groovy. For Tryorama it'll be the default to not configure the signal server and have the default address be passed to any generated sandboxes.

crates/hc_signal_srv/Cargo.toml

crates/hc_signal_srv/src/lib.rs

Co-authored-by: Jost Schulte <jost.schulte@protonmail.com>

neonphog · 2023-04-24T22:16:21Z

@jost-s

Looks all groovy. For Tryorama it'll be the default to not configure the signal server and have the default address be passed to any generated sandboxes.

Not sure I follow the "not configure the signal server" part. If you don't specify any configuration, you'll get an ephemerally assigned port, which is good, because it'll always work, but then you will need to pass that into the sandboxes, otherwise they won't know what signal port to connect to.

jost-s · 2023-04-24T22:20:17Z

Not sure I follow the "not configure the signal server" part. If you don't specify any configuration, you'll get an ephemerally assigned port, which is good, because it'll always work, but then you will need to pass that into the sandboxes, otherwise they won't know what signal port to connect to.

Sorry, yes, the port has to be set or parsed from the output. Parsing should be fine.

neonphog · 2023-04-24T22:22:39Z

@jost-s

Parsing should be fine

I also added a --address-list-file-path parameter that will write the list of interface addresses bound to a file thinking that might be easier to read than stdout.

jost-s · 2023-04-24T22:24:35Z

@jost-s

Parsing should be fine

I also added a --address-list-file-path parameter that will write the list of interface addresses bound to a file thinking that might be easier to read than stdout.

Yes, I tested it all =D True, that'll be more convenient 👍

maackle

Looks good aside from the naming possibilities which I'm not holding too strongly for

maackle · 2023-04-25T17:25:50Z

crates/hc/src/lib.rs

@@ -165,6 +166,8 @@ pub enum Opt {
    WebApp(hc_bundle::HcWebAppBundle),
    /// Work with sandboxed environments for testing and development
    Sandbox(hc_sandbox::HcSandbox),
+    /// Run a signal server


Suggested change

/// Run a signal server

/// Run a WebRTC signaling server

Or maybe

Suggested change

/// Run a signal server

/// Run a WebRTC signaling server

maackle · 2023-04-25T17:32:14Z

crates/hc/src/lib.rs

@@ -165,6 +166,8 @@ pub enum Opt {
    WebApp(hc_bundle::HcWebAppBundle),
    /// Work with sandboxed environments for testing and development
    Sandbox(hc_sandbox::HcSandbox),
+    /// Run a signal server
+    SignalSrv(hc_signal_srv::HcSignalSrv),


hc signal-srv is not a great look IMO. I only know what a signal server is because I've followed your WebRTC work somewhat, but if I didn't, I don't know if I'd know how to interpret "signal-srv". I prefer hc signal-server but I wouldn't block this on the naming.

Structopt allows users to type the shortest unambiguous prefix, so for those who love brevity they can still just type hc sig either way.

Btw, searching for "signal server", the main hits are about the Signal messenger protocol, so it's probably good to qualify this as "WebRTC signal server" whenever possible in high visibility places where new users might engage with it.

[edit] searching for "webrtc signal server" shows that it's actually officially called a "signaling server". So 🤷

I would've preferred something else than signal-srv too! =D Sounds like "signal surf"!

@jost-s @maackle - feel free to change it. Rust embraces short-cut names (fn, etc), I feel like we should have shortened it further to just hc sig lol : ), but I have zero attachment to the actual name.

How about hc ss? :D

I'm not fond of the abbreviated names in Rust and was surprised to find them to be common. Long identifiers are cheap with code completion and compilation to byte code. For me it's more a general thing with that than specific to this case. If you know about webrtc you'll intuit signal-srv, and if you don't you probably won't. But signal-server doesn't explain you what it does either. So it should be hc wss for webrtc signal server ; )

'course wss means Web-Sockets-Secure : )

Yeah, it was purely meant as a joke.

maackle · 2023-04-25T17:33:22Z

crates/hc_signal_srv/src/lib.rs

+use tx5_signal_srv::Result;
+
+#[derive(Debug, StructOpt)]
+/// Helper for running a holochain webrtc signal server.


Suggested change

/// Helper for running a holochain webrtc signal server.

/// Helper for running a Holochain WebRTC signaling server.

maackle · 2023-04-25T17:34:59Z

crates/hc_signal_srv/src/lib.rs

+        let (driver, addr_list, err_list) = tx5_signal_srv::exec_tx5_signal_srv(config)?;
+
+        for err in err_list {
+            println!("# HC SIGNAL SRV - ERROR: {err:?}");


If you agree to the other change

Suggested change

println!("# HC SIGNAL SRV - ERROR: {err:?}");

println!("# HC SIGNAL SERVER - ERROR: {err:?}");

neonphog added 3 commits April 21, 2023 17:15

create a new hc command to run a holochain webrtc signal server

adfca57

bump deps

e7ddcfe

Merge branch 'develop' into hc-signal-srv

573c992

neonphog marked this pull request as ready for review April 24, 2023 19:45

changelog

a2f5e6a

neonphog requested review from steveej, ThetaSinner, maackle and jost-s and removed request for steveej and ThetaSinner April 24, 2023 19:51

changelog fix

a70bb23

ThetaSinner reviewed Apr 24, 2023

View reviewed changes

jost-s approved these changes Apr 24, 2023

View reviewed changes

neonphog and others added 2 commits April 24, 2023 16:12

Update crates/hc_signal_srv/src/lib.rs

40854db

Co-authored-by: Jost Schulte <jost.schulte@protonmail.com>

Update crates/hc_signal_srv/src/lib.rs

79d50af

Co-authored-by: Jost Schulte <jost.schulte@protonmail.com>

neonphog added 2 commits April 24, 2023 16:27

Merge branch 'develop' into hc-signal-srv

1484de8

address code review comment

11870c2

ThetaSinner approved these changes Apr 25, 2023

View reviewed changes

neonphog added 2 commits April 25, 2023 08:59

Merge branch 'develop' into hc-signal-srv

5054966

pin tx5 version

77a92d7

maackle approved these changes Apr 25, 2023

View reviewed changes

maackle mentioned this pull request Apr 25, 2023

2023 03 17 switch to clap #2125

Merged

2 tasks

neonphog merged commit ae84064 into develop Apr 25, 2023
8 of 12 checks passed

neonphog deleted the hc-signal-srv branch April 25, 2023 22:02

pdaoust mentioned this pull request Apr 27, 2023

hc CLI documentation fixes and updates #2100

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

create a new hc command to run a holochain webrtc signal server #2265

create a new hc command to run a holochain webrtc signal server #2265

neonphog commented Apr 21, 2023 •

edited

ThetaSinner Apr 24, 2023

neonphog Apr 24, 2023

jost-s left a comment

neonphog commented Apr 24, 2023

jost-s commented Apr 24, 2023

neonphog commented Apr 24, 2023

jost-s commented Apr 24, 2023

maackle left a comment

maackle Apr 25, 2023 •

edited

maackle Apr 25, 2023

maackle Apr 25, 2023

jost-s Apr 26, 2023

neonphog Apr 26, 2023

jost-s Apr 26, 2023

neonphog Apr 26, 2023

jost-s Apr 26, 2023

maackle Apr 25, 2023 •

edited

maackle Apr 25, 2023

	/// Helper for running a holochain webrtc signal server.
	/// Helper for running a Holochain WebRTC signaling server.

	println!("# HC SIGNAL SRV - ERROR: {err:?}");
	println!("# HC SIGNAL SERVER - ERROR: {err:?}");

create a new hc command to run a holochain webrtc signal server #2265

create a new hc command to run a holochain webrtc signal server #2265

Conversation

neonphog commented Apr 21, 2023 • edited

Summary

TODO:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jost-s left a comment

Choose a reason for hiding this comment

neonphog commented Apr 24, 2023

jost-s commented Apr 24, 2023

neonphog commented Apr 24, 2023

jost-s commented Apr 24, 2023

maackle left a comment

Choose a reason for hiding this comment

maackle Apr 25, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maackle Apr 25, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neonphog commented Apr 21, 2023 •

edited

maackle Apr 25, 2023 •

edited

maackle Apr 25, 2023 •

edited