add browser-echo example

.github/workflows/ci.yml

@@ -13,7 +13,8 @@ env:
   RUSTFLAGS: -Dwarnings
   RUSTDOCFLAGS: -Dwarnings
   MSRV: "1.81"
-  RS_EXAMPLES_LIST: "dumbpipe-web,extism/host,extism/iroh-extism-host-functions,extism/plugin,iroh-automerge,iroh-gateway,frosty"
+  RS_EXAMPLES_LIST: "dumbpipe-web,extism/host,extism/iroh-extism-host-functions,extism/plugin,iroh-automerge,iroh-gateway,frosty,browser-echo"
+  WASM_EXAMPLES_LIST: "browser-echo"
   IROH_FORCE_STAGING_RELAYS: "1"
 
 jobs:
@@ -47,6 +48,9 @@ jobs:
         toolchain: ${{ matrix.rust }}
         components: clippy,rustfmt
 
+    - name: Add wasm target
+      run: rustup target add wasm32-unknown-unknown
+
     - name: Run sccache-cache
       uses: mozilla-actions/sccache-action@v0.0.4
 
@@ -60,6 +64,16 @@ jobs:
       env:
         RUST_LOG: ${{ runner.debug && 'DEBUG' || 'INFO'}}
 
+    - name: wasm
+      run: |
+        for i in ${WASM_EXAMPLES_LIST//,/ }
+        do
+          echo "Checking wasm $i"
+          cargo build --manifest-path $i/Cargo.toml --target wasm32-unknown-unknown
+        done
+      env:
+        RUST_LOG: ${{ runner.debug && 'DEBUG' || 'INFO'}}
+
     - name: fmt
       run: |
           for i in ${RS_EXAMPLES_LIST//,/ }

.github/workflows/deploy.yml

@@ -0,0 +1,98 @@
+name: Deploy Preview
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "browser-echo/**"
+  pull_request:
+    paths:
+      - "browser-echo/**"
+  workflow_dispatch:
+    inputs:
+      pr_number:
+        required: true
+        type: string
+
+# ensure job runs sequentially so pushing to the preview branch doesn't conflict
+concurrency:
+  group: ci-deploy-preview
+
+jobs:
+  preview_deploy:
+    permissions: write-all
+    timeout-minutes: 30
+    name: Deploy Docs preview
+    if: ${{ github.event_name == 'push' || ((github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch' ) && !github.event.pull_request.head.repo.fork ) }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Set preview path (PR)
+        if: ${{ github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch' }}
+        env:
+          PREVIEW_PATH: pr/${{ github.event.pull_request.number || inputs.pr_number }}
+        run: |
+          echo "PREVIEW_PATH=$PREVIEW_PATH" >> "$GITHUB_ENV"
+
+      - name: Set preview path (push)
+        if: ${{ github.event_name == 'push' }}
+        env:
+          PREVIEW_PATH: main
+        run: |
+          echo "PREVIEW_PATH=$PREVIEW_PATH" >> "$GITHUB_ENV"
+
+      - uses: actions/checkout@v4
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install rust stable toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Add wasm target
+        run: rustup target add wasm32-unknown-unknown
+
+      - name: Install tools
+        uses: taiki-e/install-action@v2
+        with:
+          tool: wasm-bindgen,wasm-opt,wasm-pack,cargo-make
+
+      - name: Build examples
+        run: cargo make deploy
+
+      - name: Deploy Docs to Preview Branch
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./deploy-out
+          destination_dir: ${{ env.PREVIEW_PATH }}
+          publish_branch: generated-deploy-preview
+
+      - name: Find Docs Comment
+        if: ${{ github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch' }}
+        uses: peter-evans/find-comment@v3
+        id: fc
+        with:
+          issue-number: ${{ github.event.pull_request.number || inputs.pr_number }}
+          comment-author: "github-actions[bot]"
+          body-includes: Deployment for this PR has been generated
+
+      - name: Get current timestamp
+        if: ${{ github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch' }}
+        id: get_timestamp
+        run: echo "TIMESTAMP=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> $GITHUB_ENV
+
+      - name: Create or Update Docs Comment
+        if: ${{ github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch' }}
+        uses: peter-evans/create-or-update-comment@v4
+        with:
+          issue-number: ${{ github.event.pull_request.number || inputs.pr_number }}
+          comment-id: ${{ steps.fc.outputs.comment-id }}
+          body: |
+            Deployment for this PR has been generated and is available at: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/${{ env.PREVIEW_PATH }}/browser-echo/
+
+            Last updated: ${{ env.TIMESTAMP }}
+          edit-mode: replace

.gitignore

@@ -1,3 +1,4 @@
 target/
 *iroh-data
 */.sendme*
+/deploy-out

Makefile.toml

@@ -0,0 +1,23 @@
+# Use cargo-make to run tasks here: https://crates.io/crates/cargo-make
+
+# this task is run from the "deploy" workflow in .github/workflows/deploy
+# it builds all browser examples, and assembles them in a deploy-out directory
+# together with a simple index.html with links to the individual examples.
+[tasks.deploy]
+dependencies = [{ name = "deploy", path = "browser-echo" }]
+
+script = '''
+rm -r deploy-out || true
+mkdir deploy-out
+
+cat <<EOF > deploy-out/index.html
+<!DOCTYPE html>
+<html lang="en"><head><title>iroh examples</title></head>
+<body><h1>iroh examples</h1><a href="https://github.com/n0-computer/iroh-examples">source code</a><ul>
+EOF
+
+cp -r browser-echo/public deploy-out/browser-echo
+echo '<li><a href="./browser-echo/index.html">browser-echo</li>' >> deploy-out/index.html
+
+echo '</ul></body></html>' >> deploy-out/index.html
+'''

README.md

@@ -13,7 +13,7 @@ Forward http requests to dumbpipe. Share a local dev server publicly.
 
 # Extism
 
-Use iroh through [extism] 
+Use iroh through [extism]
 
 # Iroh-automerge
 
@@ -31,6 +31,10 @@ Node discovery using the bittorrent [mainline] DHT and [pkarr].
 
 Todo app using iroh documents and [tauri]
 
+# Browser-echo
+
+Use iroh in the browser, compiled to web assembly.
+
 [iroh-experiments]: https://github.com/n0-computer/iroh-experiments
 [extism]: https://extism.org/
 [automerge]: https://automerge.org/

browser-echo/.gitignore

@@ -0,0 +1,2 @@
+/public/wasm
+/package-lock.json