chore: comments, logs, & cleanup

ipvm-wg · Nov 29, 2023 · d2fc3f0 · d2fc3f0
1 parent 1c823b8
commit d2fc3f0
Show file tree

Hide file tree

Showing 71 changed files with 3,678 additions and 2,999 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -76,6 +76,7 @@ lto = true
 debug-assertions = false
 
 [profile.release.package.homestar-runtime]
+# Will slow-down compile, but improve perf on generated code.
 codegen-units = 1
 debug-assertions = false
 
@@ -87,6 +88,7 @@ debug-assertions = false
 # Example: `cargo build -p homestar-functions-test --target wasm32-unknown-unknown --profile release-wasm-fn`
 [profile.release-wasm-fn]
 inherits = "release"
+# Will slow-down compile, but improve perf on generated code.
 codegen-units = 1
 # Tell `rustc` to optimize for small code size.
 opt-level = "z" # 'z' to optimize "aggressively" for size

diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -2,6 +2,7 @@
 
 ## Outline
 
+- [Building and Running the Project](#building-and-running-the-project)
 - [Testing the Project](#testing-the-project)
 - [Running the Runtime on Docker](#running-the-runtime-on-docker)
 - [Nix](#nix)
@@ -10,18 +11,51 @@
 - [Recommended Development Flow](#recommended-development-flow)
 - [Conventional Commits](#conventional-commits)
 
+## Building and Running the Project
+
+- Building `homestar`:
+
+  For the fastest compile-times and prettiest logs while developing `homestar`,
+  build with:
+
+  ``` console
+  cargo build --no-default-features --features dev
+  ```
+
+  This removes underlying `wasmtime` `zstd` compression while also turning on
+  ANSI color-coded logs. If you bulid with default features, `zstd` compression
+  and other `wasmtime` defaults will be included in the build.
+
+- Running the `homestar` server/runtime:
+
+  ``` console
+  cargo run --no-default-features --features dev -- start
+  ```
+
+- Running alongside [`tokio-console`][tokio-console] for diagnosis and debugging:
+
+  ``` console
+  cargo run --no-default-features --features dev,console -- start
+  ```
+
+  Then, in another window:
+
+  ```console
+  tokio-console --retain-for 60sec
+  ```
+
 ## Testing the Project
 
 - Running the tests:
 
-We recommend using [cargo nextest][cargo-nextest], which is installed by default
-in our [Nix flake](#nix) or can be [installed separately][cargo-nextest-install].
+  We recommend using [cargo nextest][cargo-nextest], which is installed by default
+  in our [Nix flake](#nix) or can be [installed separately][cargo-nextest-install].
 
   ```console
   cargo nextest run --all-features --no-capture
   ```
 
-The above command translates to this using the default `cargo test`:
+  The above command translates to this using the default `cargo test`:
 
   ```console
   cargo test --all-features -- --nocapture
@@ -139,4 +173,5 @@ a type of `fix`, `feat`, `docs`, `ci`, `refactor`, etc..., structured like so:
 [nix]:https://nixos.org/download.html
 [nix-flake]: https://nixos.wiki/wiki/Flakes
 [pre-commit]: https://pre-commit.com/
+[tokio-console]: https://github.com/tokio-rs/console
 [wit-bindgen]: https://github.com/bytecodealliance/wit-bindgen
diff --git a/README.md b/README.md
@@ -102,7 +102,7 @@ Our current list includes:
 
 - [websocket relay](./examples/websocket-relay/README.md) - An example
   (browser-based) application that connects to the `homestar-runtime` over a
-  websocket connection in order to run a couple static Wasm-based, image
+  WebSocket connection in order to run a couple static Wasm-based, image
   processing workflows that chain inputs and outputs.
 
 ## Workspace
@@ -176,7 +176,6 @@ We would be happy to try to answer your question or try opening a new issue on G
 - [IPVM - IPFS and WASM][ipfs-thing-ipvm] by Brooklyn Zelenka
 - [Breaking Down the Interplanetary Virtual Machine][blog-1]
 - [Ucan Invocation Spec][ucan-invocation]
-- [Wasm/Wit Demo - Februrary 2023][demo-1] by Zeeshan Lakhani
 
 ## License
 

diff --git a/examples/README.md b/examples/README.md
@@ -5,7 +5,7 @@ and the `homestar runtime`. Each example is set up as its own crate,
 demonstrating the necessary dependencies and setup(s).
 
 * [websocket relay](./websocket-relay) - An example (browser-based) application
-  that connects to the `homestar-runtime` over a websocket connection in order
+  that connects to the `homestar-runtime` over a WebSocket connection in order
   to run a couple static Wasm-based, image processing workflows that chain
   inputs and outputs using [inlined promises][pipelines].
 

diff --git a/examples/websocket-relay/example_test.wasm b/examples/websocket-relay/example_test.wasm
diff --git a/examples/websocket-relay/relay-app/src/lib/workflow.ts b/examples/websocket-relay/relay-app/src/lib/workflow.ts
@@ -256,7 +256,7 @@ export const workflowOnePromised = WorkflowBuilder.workflow({
       WorkflowBuilder.crop({
         name: "crop",
         resource:
-          "ipfs://bafybeiczefaiu7464ehupezpzulnti5jvcwnvdalqrdliugnnwcdz6ljia",
+          "ipfs://bafybeig6u35v6t3f4j3zgz2jvj4erd45fbkeolioaddu3lmu6uxm3ilb7a",
         args: {
           data: "{{ cid:bafybeiejevluvtoevgk66plh5t6xiy3ikyuuxg3vgofuvpeckb6eadresm }}",
           x: 150,
@@ -268,15 +268,15 @@ export const workflowOnePromised = WorkflowBuilder.workflow({
       WorkflowBuilder.rotate90({
         name: "rotate90",
         resource:
-          "ipfs://bafybeiczefaiu7464ehupezpzulnti5jvcwnvdalqrdliugnnwcdz6ljia",
+          "ipfs://bafybeig6u35v6t3f4j3zgz2jvj4erd45fbkeolioaddu3lmu6uxm3ilb7a",
         args: {
           data: "{{needs.crop.output}}",
         },
       }),
       WorkflowBuilder.blur({
         name: "blur",
         resource:
-          "ipfs://bafybeiczefaiu7464ehupezpzulnti5jvcwnvdalqrdliugnnwcdz6ljia",
+          "ipfs://bafybeig6u35v6t3f4j3zgz2jvj4erd45fbkeolioaddu3lmu6uxm3ilb7a",
         args: {
           data: "{{needs.rotate90.output}}",
           sigma: 20.2,
@@ -293,7 +293,7 @@ export const workflowTwoPromised = WorkflowBuilder.workflow({
       WorkflowBuilder.crop({
         name: "crop",
         resource:
-          "ipfs://bafybeiczefaiu7464ehupezpzulnti5jvcwnvdalqrdliugnnwcdz6ljia",
+          "ipfs://bafybeig6u35v6t3f4j3zgz2jvj4erd45fbkeolioaddu3lmu6uxm3ilb7a",
         args: {
           data: "{{ cid:bafybeiejevluvtoevgk66plh5t6xiy3ikyuuxg3vgofuvpeckb6eadresm }}",
           x: 150,
@@ -305,15 +305,15 @@ export const workflowTwoPromised = WorkflowBuilder.workflow({
       WorkflowBuilder.rotate90({
         name: "rotate90",
         resource:
-          "ipfs://bafybeiczefaiu7464ehupezpzulnti5jvcwnvdalqrdliugnnwcdz6ljia",
+          "ipfs://bafybeig6u35v6t3f4j3zgz2jvj4erd45fbkeolioaddu3lmu6uxm3ilb7a",
         args: {
           data: "{{needs.crop.output}}",
         },
       }),
       WorkflowBuilder.grayscale({
         name: "grayscale",
         resource:
-          "ipfs://bafybeiczefaiu7464ehupezpzulnti5jvcwnvdalqrdliugnnwcdz6ljia",
+          "ipfs://bafybeig6u35v6t3f4j3zgz2jvj4erd45fbkeolioaddu3lmu6uxm3ilb7a",
         args: {
           data: "{{needs.rotate90.output}}",
         },

diff --git a/examples/websocket-relay/src/main.rs b/examples/websocket-relay/src/main.rs
@@ -16,18 +16,11 @@ fn main() -> Result<()> {
     // daemon. Typically, these would be started separately.
     let ipfs_daemon = ipfs_setup();
 
-    info!(
-        subject = "settings",
-        category = "homestar_init",
-        "starting with settings: {:?}",
-        settings,
-    );
+    info!("starting with settings: {:?}", settings,);
 
     let db = Db::setup_connection_pool(settings.node(), None).expect("to setup database pool");
 
     info!(
-        subject = "database",
-        category = "homestar_init",
         "starting with database: {}",
         Db::url().expect("database url to be provided"),
     );

diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
@@ -57,7 +57,6 @@
           cargo-expand
           cargo-nextest
           cargo-sort
-          cargo-spellcheck
           cargo-unused-features
           cargo-udeps
           cargo-watch
@@ -101,7 +100,7 @@
 
         devRunServer = pkgs.writeScriptBin "cargo-run-dev" ''
           #!${pkgs.stdenv.shell}
-          cargo run --no-default-features --features dev -- start -c homestar-runtime/config/settings.toml
+          cargo run --no-default-features --features dev -- start
         '';
 
         doc = pkgs.writeScriptBin "doc" ''

diff --git a/homestar-core/src/test_utils/workflow.rs b/homestar-core/src/test_utils/workflow.rs
@@ -19,7 +19,7 @@ use std::collections::BTreeMap;
 use url::Url;
 
 const RAW: u64 = 0x55;
-const WASM_CID: &str = "bafybeiczefaiu7464ehupezpzulnti5jvcwnvdalqrdliugnnwcdz6ljia";
+const WASM_CID: &str = "bafybeig6u35v6t3f4j3zgz2jvj4erd45fbkeolioaddu3lmu6uxm3ilb7a";
 
 type NonceBytes = Vec<u8>;
 

diff --git a/homestar-core/src/workflow/instruction.rs b/homestar-core/src/workflow/instruction.rs
@@ -336,7 +336,7 @@ mod test {
                 (
                     RESOURCE_KEY.into(),
                     Ipld::String(
-                        "ipfs://bafybeiczefaiu7464ehupezpzulnti5jvcwnvdalqrdliugnnwcdz6ljia".into()
+                        "ipfs://bafybeig6u35v6t3f4j3zgz2jvj4erd45fbkeolioaddu3lmu6uxm3ilb7a".into()
                     )
                 ),
                 (OP_KEY.into(), Ipld::String("ipld/fun".to_string())),
@@ -357,7 +357,7 @@ mod test {
                             "func": "join-strings"
                         },
                         "nnc": "", "op": "wasm/run",
-                        "rsc": "ipfs://bafybeiczefaiu7464ehupezpzulnti5jvcwnvdalqrdliugnnwcdz6ljia"});
+                        "rsc": "ipfs://bafybeig6u35v6t3f4j3zgz2jvj4erd45fbkeolioaddu3lmu6uxm3ilb7a"});
 
         let instruction = Instruction::<Unit>::try_from(ipld.clone()).unwrap();
         let instr_cid = instruction.to_cid().unwrap();

diff --git a/homestar-core/src/workflow/task.rs b/homestar-core/src/workflow/task.rs
@@ -190,7 +190,7 @@ mod test {
             (
                 "rsc".into(),
                 Ipld::String(
-                    "ipfs://bafybeiczefaiu7464ehupezpzulnti5jvcwnvdalqrdliugnnwcdz6ljia".into(),
+                    "ipfs://bafybeig6u35v6t3f4j3zgz2jvj4erd45fbkeolioaddu3lmu6uxm3ilb7a".into(),
                 ),
             ),
             ("op".into(), Ipld::String("ipld/fun".to_string())),

diff --git a/homestar-functions/test/src/lib.rs b/homestar-functions/test/src/lib.rs
@@ -6,7 +6,11 @@ wit_bindgen::generate!({
 });
 
 use base64::{engine::general_purpose, Engine};
-use std::io::Cursor;
+use std::{
+    collections::hash_map::DefaultHasher,
+    hash::{Hash, Hasher},
+    io::Cursor,
+};
 
 pub struct Component;
 
@@ -115,6 +119,12 @@ impl Guest for Component {
             .unwrap();
         Self::rotate90(decoded)
     }
+
+    fn hash(s: String) -> Vec<u8> {
+        let mut hash = DefaultHasher::new();
+        s.hash(&mut hash);
+        hash.finish().to_be_bytes().to_vec()
+    }
 }
 
 #[cfg(test)]

diff --git a/homestar-functions/test/wit/host.wit b/homestar-functions/test/wit/host.wit
@@ -13,4 +13,5 @@ world test {
   export grayscale-base64: func(data: string) -> list<u8>
   export rotate90: func(data: list<u8>) -> list<u8>
   export rotate90-base64: func(data: string) -> list<u8>
+  export hash: func(data: string) -> list<u8>
 }
diff --git a/homestar-runtime/Cargo.toml b/homestar-runtime/Cargo.toml
@@ -54,6 +54,7 @@ config = { version = "0.13", default-features = false, features = ["toml"] }
 console-subscriber = { version = "0.2", default-features = false, features = [
   "parking_lot",
 ], optional = true }
+const_format = "0.2"
 crossbeam = "0.8"
 dagga = "0.2"
 dashmap = "5.5"
@@ -218,7 +219,7 @@ wait-timeout = "0.2"
 
 [features]
 default = ["wasmtime-default", "ipfs", "monitoring", "websocket-notify"]
-dev = ["ansi-logs", "console", "ipfs", "monitoring", "websocket-notify"]
+dev = ["ansi-logs", "ipfs", "monitoring", "websocket-notify"]
 ansi-logs = ["tracing-logfmt/ansi_logs"]
 console = ["dep:console-subscriber"]
 ipfs = ["dep:ipfs-api", "dep:ipfs-api-backend-hyper"]

diff --git a/...star-runtime/src/event_handler/channel.rs → homestar-runtime/src/channel.rs b/...star-runtime/src/event_handler/channel.rs → homestar-runtime/src/channel.rs
@@ -1,5 +1,5 @@
-//! Wrapper around [crossbeam::channel] and [flume::bounded] to provide common
-//! interfaces for sync/async bounded and non-tokio "oneshot" channels.
+//! Wrapper around [crossbeam::channel] and [flume] to provide common
+//! interfaces for sync/async (un)bounded and non-tokio "oneshot" channels.
 
 use crossbeam::channel;
 

diff --git a/homestar-runtime/src/cli/show.rs b/homestar-runtime/src/cli/show.rs
@@ -1,3 +1,5 @@
+//! Styled, output response for console table.
+
 use std::{
     fmt,
     io::{self, Write},