chore: improve development environment (#353)

* chore: add vscode dev template

* chore(vscode): makes auto detecting the rust std sourcemap when debugging

* chore(devcontainer): add `vscode-lldb`

* chore(devcontainer): mapping rust std source map to lldb by default

* chore(devcontainer): support dind

Author: nyannyacha

.devcontainer/devcontainer.json

@@ -8,6 +8,7 @@
     }
   },
   "features": {
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {},
     "ghcr.io/jungaretti/features/make:1": {},
     "ghcr.io/lee-orr/rusty-dev-containers/cargo-make:0": {}
   },
@@ -20,13 +21,17 @@
   "customizations": {
     "vscode": {
       "settings": {
-        "extensions.verifySignature": false
+        "extensions.verifySignature": false,
+        "lldb.launch.preRunCommands": [
+          "script lldb.debugger.HandleCommand('settings set target.source-map /rustc/{} \"{}/lib/rustlib/src/rust\"'.format(os.popen('rustc --version --verbose').read().split('commit-hash: ')[1].split('\\n')[0].strip(), os.popen('rustc --print sysroot').readline().strip()))"
+        ]
       },
       "extensions": [
         "rust-lang.rust-analyzer",
         "eamodio.gitlens",
         "ms-azuretools.vscode-docker",
-        "ms-vscode.hexeditor"
+        "ms-vscode.hexeditor",
+        "vadimcn.vscode-lldb"
       ]
     }
   }

.dockerignore

@@ -1 +1,10 @@
 target/
+k6/
+examples/
+assets/
+.vscodes/
+.github/
+
+scripts/*
+!scripts/install_onnx.sh
+!scripts/download_models.sh

.gitignore

@@ -1,10 +1,13 @@
-# Generated by Cargo
-# will have compiled files and executables
 debug/
 target/
 temp/
 .idea/
 .idea
+
+.vscode/*
+!.vscode/launch.template.jsonc
+!.vscode/settings.template.jsonc
+
 scripts/debug.sh
 
 node_modules/

.vscode/launch.template.jsonc

@@ -0,0 +1,76 @@
+/* 
+
+    Copy this file into '.vscode/launch.json' or merge its contents into your existing
+    configurations.
+
+*/
+
+{
+    "configurations": [ 
+        {
+            "name": "Debug Runtime",
+            "type": "lldb",
+            "request": "launch",
+            "cargo": {
+                "args": [
+                    "build",
+                    "--bin=edge-runtime",
+                    "--features=cli/tracing"
+                ],
+                "filter": {
+                    "kind": "bin"
+                }
+            },
+            "cwd": "${workspaceFolder}",
+            "sourceLanguages": [
+                "rust"
+            ],
+            "args": [
+                "-v",
+                "start",
+                "--main-service",
+                "./examples/main",
+                "--event-worker",
+                "./examples/event-manager"
+
+                // To enable the inspector capability, uncomment the line below.
+                // "--inspect-brk"
+
+                // If you want to listen to the inspect session on a different port, uncomment the
+                // line below instead.
+                // "--inspect-brk=127.0.0.1:<PORT>"
+
+                // If you want to allow an inspector session to be created on the main worker,
+                // uncomment the line below. 
+                //
+                // This flag must be used in combination with the flag above.
+                // "--inspect-main"
+            ],
+            "env": {
+                "RUST_BACKTRACE": "full",
+                "EDGE_RUNTIME_PORT": "9998"
+
+                // If you want to get a detailed log, uncomment below.
+                // Value of environment variable below is described in detail in the links below:
+                // https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives
+                // "RUST_LOG": "trace"
+            }
+        },
+        {
+            "name": "Attach V8 Inspector",
+            "type": "node",
+            "address": "127.0.0.1",
+            "request": "attach",
+            "localRoot": "/",
+            "remoteRoot": "/",
+            "timeout": 1000000,
+
+            // Properties below are optional.
+            "restart": true,
+
+            // Inspector is accepting sessions on 9229 by default. If you changed the listening port
+            // via the inspector flag above, this value must also be changed.
+            "port": 9229
+        }
+    ]
+}

.vscode/settings.template.jsonc

@@ -0,0 +1,21 @@
+/* 
+
+    Copy this file into '.vscode/settings.json' or merge its contents into your existing
+    configurations.
+
+*/
+
+{
+    "lldb.launch.preRunCommands": [
+        "script lldb.debugger.HandleCommand('settings set target.source-map /rustc/{} \"{}/lib/rustlib/src/rust\"'.format(os.popen('rustc --version --verbose').read().split('commit-hash: ')[1].split('\\n')[0].strip(), os.popen('rustc --print sysroot').readline().strip()))"
+    ],
+    "rust-analyzer.cargo.features": [
+        "cli/tracing"
+    ],
+    "rust-analyzer.diagnostics.disabled": [
+        "E0308"
+    ],
+    "editor.rulers": [
+        100
+    ]
+}

Cargo.toml

@@ -83,5 +83,8 @@ faster-hex = "0.9.0"
 #[patch.crates-io]
 #deno_core = { path = "/your/path/to/deno_core/core" }
 
+[profile.dind]
+inherits = "dev"
+
 [profile.release]
 lto = true

Dockerfile

@@ -3,6 +3,9 @@ FROM rust:1.74.1-bookworm as builder
 ARG TARGETPLATFORM
 ARG GIT_V_VERSION
 ARG ONNXRUNTIME_VERSION=1.17.0
+ARG PROFILE=release
+ARG FEATURES
+
 RUN apt-get update && apt-get install -y llvm-dev libclang-dev clang cmake
 WORKDIR /usr/src/edge-runtime
 
@@ -11,9 +14,9 @@ RUN --mount=type=cache,target=/usr/local/cargo/registry,id=${TARGETPLATFORM} \
 COPY . .
 
 RUN --mount=type=cache,target=/usr/local/cargo/registry,id=${TARGETPLATFORM} --mount=type=cache,target=/usr/src/edge-runtime/target,id=${TARGETPLATFORM} \
-    GIT_V_TAG=${GIT_V_VERSION} cargo build --release && \
+    GIT_V_TAG=${GIT_V_VERSION} cargo build --profile ${PROFILE} --features "${FEATURES}" && \
     cargo strip && \
-    mv /usr/src/edge-runtime/target/release/edge-runtime /root
+    mv /usr/src/edge-runtime/target/${PROFILE}/edge-runtime /root
 
 RUN ./scripts/install_onnx.sh $ONNXRUNTIME_VERSION $TARGETPLATFORM /root/libonnxruntime.so
 RUN ./scripts/download_models.sh

scripts/run.sh

@@ -1,6 +1,7 @@
 #!/usr/bin/env bash
 
 # --features cli/tracing
-GIT_V_TAG=0.1.1 cargo build && EDGE_RUNTIME_PORT=9998 RUST_BACKTRACE=full ./target/debug/edge-runtime "$@" start \
+GIT_V_TAG=0.1.1 cargo build --features cli/tracing && \
+EDGE_RUNTIME_PORT=9998 RUST_BACKTRACE=full ./target/debug/edge-runtime "$@" start \
     --main-service ./examples/main \
-    --event-worker ./examples/event-manager
+    --event-worker ./examples/event-manager

scripts/run_dind.sh

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+
+GIT_V_TAG=0.1.1
+EDGE_RUNTIME_PORT=9998
+ONNXRUNTIME_VERSION=1.17.0
+FEATURES=cli/tracing
+RUST_BACKTRACE=full
+
+SCRIPT=$(readlink -f "$0")
+SCRIPTPATH=$(dirname "$SCRIPT")
+
+cd $SCRIPTPATH && \
+    docker build \
+    -t edge_runtime \
+    --build-arg GIT_V_TAG=$GIT_V_TAG \
+    --build-arg ONNXRUNTIME_VERSION=$ONNXRUNTIME_VERSION \
+    --build-arg PROFILE=dind \
+    --build-arg FEATURES=$FEATURES \
+    "$SCRIPTPATH/.."
+
+docker run \
+    --privileged \
+    --rm \
+    -it \
+    -p $EDGE_RUNTIME_PORT:$EDGE_RUNTIME_PORT \
+    -w /home/deno \
+    -v "$SCRIPTPATH/../examples:/home/deno/examples" \
+    -e EDGE_RUNTIME_PORT=$EDGE_RUNTIME_PORT \
+    -e RUST_BACKTRACE=$RUST_BACKTRACE \
+    -e RUST_LOG=$RUST_LOG \
+    edge_runtime:latest \
+    start \
+        -p $EDGE_RUNTIME_PORT \
+        --main-service ./examples/main \
+        --event-worker ./examples/event-manager \
+        --static "./examples/**/*.bin"