RSDK-4040 RSDK-3446 Make dialdbg a feature instead of a crate (viamro…

…botics#68)

.github/workflows/release.yml

@@ -49,7 +49,10 @@ jobs:
         if: inputs.version != 'nobump'
         run: |
           cargo install cargo-release
-          cargo release version ${{ inputs.version }} --execute --no-confirm
+          # Include dialdbg feature to publish dialdbg. Users can later use 
+          # `cargo add viam-rust-utils --features dialdbg` if they want access
+          # to dialdbg for some reason.
+          cargo release version ${{ inputs.version }} --features dialdbg --execute --no-confirm
 
       - name: Which Version
         id: which_version

Cargo.toml

@@ -13,11 +13,21 @@ crate-type = ["cdylib","lib"]
 doctest = false
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
+[features]
+dialdbg = []
+
+[[bin]]
+name = "viam-dialdbg"
+path = "src/dialdbg/main.rs"
+required-features = ["dialdbg"]
+
 [dependencies]
 anyhow = { version = "1.0", features = ["backtrace"]}
 base64 = "0.13.0"
 byteorder = "1.4.3"
 bytes = "1.1.0"
+chrono = "0.4.26"
+clap = { version = "4.3.19", features = ["derive"] }
 dashmap = "5.4.0"
 derivative = "2.2.0"
 ffi_helpers = "0.3.0"
@@ -32,6 +42,7 @@ interceptor = "0.8.0"
 interfaces = "0.0.8"
 libc = {version = "0.2"}
 log = "0.4.17"
+log4rs = "1.2.0"
 nalgebra = "0.31.4"
 prost = "0.11"
 prost-types = "0.11"
@@ -56,11 +67,3 @@ env_logger = "0.9.0"
 
 [build-dependencies]
 tonic-build = {version = "0.9.2",features = ["prost"]}
-
-[workspace]
-
-# dialdbg exists as a member of the workspace so it gets its own crate.
-members = [
-    "dialdbg",
-]
-exclude = [ "examples" ]

Makefile

@@ -7,7 +7,8 @@ build:
 build-example:
 	cd examples/ && cargo build
 build-dialdbg:
-	cd dialdbg/ && cargo build
+	# this target is used by homebrew; if altering, update homebrew formula.
+	cargo build --release --features dialdbg
 buf-clean:
 	find src/gen -type f \( -iname "*.rs" ! -iname "mod.rs" \) -delete
 buf-install:

README.md

@@ -12,6 +12,7 @@ Next run the following command `curl --proto '=https' --tlsv1.2 -sSf https://sh.
 ## Repository Layout
 - `src/gen` All the google and viam api proto files
 - `src/dial` The implementation of gRPC over webRTC used for p2p connection to robots
+- `src/dialdbg` A CLI debugging tool for dial logic. See `src/dialdbg/README.md`.
 - `src/ffi` FFI wrapper for dial logic
 - `src/proxy` Logic for creating a unix socket to serve as connectiong proxy
 - `examples` A list of examples

etc/test.sh

@@ -13,7 +13,7 @@ while ! lsof -i ":$SERVER_PORT" | grep -q LISTEN; do
   sleep 0.1
 done
 
-SERVER_PORT=$SERVER_PORT cargo test --workspace
+SERVER_PORT=$SERVER_PORT cargo test --workspace --features dialdbg
 result=$?
 
 kill "$(lsof -t -i:$SERVER_PORT)"