Add more examples to app.rerun.io

.github/workflows/README.md

@@ -42,13 +42,23 @@ uploaded anywhere.
   - `RELEASE_VERSION` - If producing a release, the version number. This must match the version in `Cargo.toml`.
 - [reusable_upload_web.yml](reusable_upload_web.yml) - This job uploads the web assets to google cloud. By default this
   only uploads to: `app.rerun.io/commit/<commit>/`
-  - `MARK_PRERELEASE_FOR_MAINLINE` - If true, then the web assets will go to `app.rerun.io/preleease/
+  - `MARK_PRERELEASE_FOR_MAINLINE` - If true, then the web assets will go to `app.rerun.io/prelease/
   - `MARK_TAGGED_VERSION` - If true, then the web assets will go to `app.rerun.io/version/<RELEASE_VERSION>`
   - `RELEASE_VERSION` - If producing a release, the version number.
   - `RRD_ARTIFACT_NAME` - Intermediate name of the GitHub rrd artifact. This should match the name passed to
     `reusable_build_and_test_wheels.yml`
   - `UPLOAD_COMMIT_OVERRIDE` - If set, will replace the value of `<commit>`. This is necessary because we want pull
   request builds associated with their originating commit, even if the web-build happens on an ephemeral merge-commit.
+- [reusable_build_web_demo.yml](reusable_build_web.yml) - This job builds the assets uploaded to `demo.rerun.io`.
+  - `SOURCE_LINK_COMMIT_OVERRIDE` - If set, will replace the value of `<commit>` in the built app. This ensures that the
+  source source code link in the built app always points to the pull request's `HEAD`.
+- [reusable_upload_web_demo.yml](reusable_upload_web_demo.yml) - This job uploads the `demo.rerun.io` assets to google cloud. By default this
+  only uploads to: `demo.rerun.io/commit/<commit>/`
+  - `MARK_PRERELEASE_FOR_MAINLINE` - If true, then the web assets will go to `demo.rerun.io/prelease/
+  - `MARK_TAGGED_VERSION` - If true, then the web assets will go to `demo.rerun.io/version/<RELEASE_VERSION>`
+  - `RELEASE_VERSION` - If producing a release, the version number.
+  - `UPLOAD_COMMIT_OVERRIDE` - If set, will replace the value of `<commit>`. This is necessary because we want pull
+  request builds associated with their originating commit, even if the web-build happens on an ephemeral merge-commit.
 - [reusable_pr_summary.yml](reusable_pr_summary.yml) - This job updates the PR summary with the results of the CI run.
   - This summary can be found at:
   `https://build.rerun.io/pr/<PR_NUMBER>/`

.github/workflows/manual_adhoc_web.yml

@@ -23,7 +23,7 @@ jobs:
       CONCURRENCY: adhoc-web-${{ github.event.inputs.ADHOC_NAME }}
       PLATFORM: linux
       MATURIN_FEATURE_FLAGS: '--no-default-features --features extension-module'
-      WHEEL_ARTIFACT_NAME: ''
+      WHEEL_ARTIFACT_NAME: linux-wheel
       RRD_ARTIFACT_NAME: linux-rrd-fast
     secrets: inherit
 
@@ -46,3 +46,23 @@ jobs:
       ADHOC_NAME: ${{ github.event.inputs.ADHOC_NAME }}
       RRD_ARTIFACT_NAME: linux-rrd-fast
     secrets: inherit
+
+  build-web-demo-adhoc:
+    name: 'Build Web Demo'
+    needs: [min-test-wheel, build-web-adhoc]
+    uses: ./.github/workflows/reusable_build_web_demo.yml
+    with:
+      CONCURRENCY: adhoc-web-${{ github.event.inputs.ADHOC_NAME }}
+      WHEEL_ARTIFACT_NAME: linux-wheel
+    secrets: inherit
+
+  upload-web-demo:
+    name: 'Upload Web Demo'
+    needs: [build-web-demo-adhoc]
+    uses: ./.github/workflows/reusable_upload_web_demo.yml
+    with:
+      CONCURRENCY: adhoc-web-${{ github.event.inputs.ADHOC_NAME }}
+      MARK_PRERELEASE_FOR_MAINLINE: false
+      MARK_TAGGED_VERSION: false
+      ADHOC_NAME: ${{ github.event.inputs.ADHOC_NAME }}
+    secrets: inherit

.github/workflows/manual_dispatch.yml

@@ -41,6 +41,12 @@ on:
         required: false
         default: true
 
+      BUILD_WEB_DEMO:
+        description: 'Run reusable_build_web'
+        type: boolean
+        required: false
+        default: true
+
       RELEASE_VERSION:
         description: 'Release Version Number (Must match Cargo.toml)'
         type: string
@@ -231,6 +237,27 @@ jobs:
       RRD_ARTIFACT_NAME: linux-rrd-fast
     secrets: inherit
 
+  build-web-demo:
+    name: 'Build Web Demo'
+    needs: [min-test-wheel, build-web]
+    if: ${{ github.event.inputs.BUILD_WEB_DEMO == 'true'}}
+    uses: ./.github/workflows/reusable_build_web_demo.yml
+    with:
+      CONCURRENCY: manual-dispatch-${{ github.run_id}}
+      WHEEL_ARTIFACT_NAME: linux-wheel
+    secrets: inherit
+
+  upload-web-demo:
+    name: 'Upload Web Demo'
+    needs: [build-web-demo]
+    if: ${{ (github.event.inputs.BUILD_WEB_DEMO == 'true') && (github.event.inputs.UPLOAD_GCLOUD == 'true') }}
+    uses: ./.github/workflows/reusable_upload_web_demo.yml
+    with:
+      CONCURRENCY: manual-dispatch-${{ github.run_id}}
+      MARK_PRERELEASE_FOR_MAINLINE: false
+      MARK_TAGGED_VERSION: false
+    secrets: inherit
+
   check-for-pr:
     runs-on: ubuntu-latest
     if: ${{ github.event.inputs.UPDATE_PR_SUMMARY == 'true' }}

.github/workflows/on_pull_request.yml

@@ -44,6 +44,25 @@ jobs:
       UPLOAD_COMMIT_OVERRIDE: ${{ github.event.pull_request.head.sha }}
     secrets: inherit
 
+  build-web-demo:
+    name: 'Build Web Demo'
+    needs: [min-test-wheel, build-web]
+    uses: ./.github/workflows/reusable_build_web_demo.yml
+    with:
+      CONCURRENCY: pr-${{ github.event.pull_request.number }}
+      WHEEL_ARTIFACT_NAME: linux-wheel-fast
+      SOURCE_LINK_COMMIT_OVERRIDE: ${{ github.event.pull_request.head.sha }}
+    secrets: inherit
+
+  upload-web-demo:
+    name: 'Upload Web Demo'
+    needs: [build-web-demo]
+    uses: ./.github/workflows/reusable_upload_web_demo.yml
+    with:
+      CONCURRENCY: pr-${{ github.event.pull_request.number }}
+      UPLOAD_COMMIT_OVERRIDE: ${{ github.event.pull_request.head.sha }}
+    secrets: inherit
+
   run-notebook:
     name: 'Run Notebook'
     needs: [min-test-wheel]

.github/workflows/on_push_main.yml

@@ -50,6 +50,24 @@ jobs:
       MARK_PRERELEASE_FOR_MAINLINE: true
     secrets: inherit
 
+  build-web-demo:
+    name: 'Build Web Demo'
+    needs: [build-linux, build-web]
+    uses: ./.github/workflows/reusable_build_web_demo.yml
+    with:
+      CONCURRENCY: push-${{ github.ref_name }}
+      WHEEL_ARTIFACT_NAME: linux-wheel
+    secrets: inherit
+
+  upload-web-demo:
+    name: 'Upload Web'
+    needs: [build-web-demo]
+    uses: ./.github/workflows/reusable_upload_web_demo.yml
+    with:
+      CONCURRENCY: push-${{ github.ref_name }}
+      MARK_PRERELEASE_FOR_MAINLINE: true
+    secrets: inherit
+
   build-linux:
     needs: [checks]
     name: 'Linux: Build/Test Wheels'

.github/workflows/reusable_build_web_demo.yml

@@ -0,0 +1,99 @@
+name: Reusable Build Web Demo
+
+on:
+  workflow_call:
+    inputs:
+      CONCURRENCY:
+        required: true
+        type: string
+      WHEEL_ARTIFACT_NAME:
+        required: true
+        type: string
+      # Each example in the built app contains a link to its source code.
+      # This determines the target commit to link to, and by default
+      # it is the current commit (github.sha)
+      SOURCE_LINK_COMMIT_OVERRIDE:
+        required: false
+        type: string
+
+concurrency:
+  group: ${{ inputs.CONCURRENCY }}-build-web-demo
+  cancel-in-progress: true
+
+env:
+  PYTHON_VERSION: "3.8"
+  # web_sys_unstable_apis is required to enable the web_sys clipboard API which egui_web uses
+  # https://rustwasm.github.io/wasm-bindgen/api/web_sys/struct.Clipboard.html
+  # https://rustwasm.github.io/docs/wasm-bindgen/web-sys/unstable-apis.html
+  RUSTFLAGS: --cfg=web_sys_unstable_apis --deny warnings
+
+  # See https://github.com/ericseppanen/cargo-cranky/issues/8
+  RUSTDOCFLAGS: --deny warnings --deny rustdoc::missing_crate_level_docs
+
+jobs:
+  rs-build-web-demo:
+    name: Build Web Demo
+    permissions:
+      contents: "read"
+      id-token: "write"
+
+    runs-on: ubuntu-latest-16-cores
+
+    container:
+      image: rerunio/ci_docker:0.6
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Download Web Viewer
+        uses: actions/download-artifact@v3
+        with:
+          name: web_viewer
+          path: web_viewer
+
+      - name: Download Wheel
+        uses: actions/download-artifact@v3
+        with:
+          name: ${{ inputs.WHEEL_ARTIFACT_NAME }}
+          path: wheel
+
+      - name: Install dependencies for examples/python
+        run: |
+          pip install -r scripts/requirements-web-demo.txt
+          pip install Jinja2
+
+      - name: Install built wheel
+        shell: bash
+        run: |
+          pip uninstall rerun-sdk -y
+          pip install deprecated numpy>=1.23 pyarrow==10.0.1 pytest==7.1.2
+          pip install rerun-sdk --no-index --find-links wheel
+
+      - name: Verify built wheel version
+        shell: bash
+        run: |
+          python3 -m rerun --version
+          which rerun
+          rerun --version
+
+      - name: Resolve source link commit hash
+        run: |
+          if [ -z "${{ inputs.SOURCE_LINK_COMMIT_OVERRIDE }}" ]; then
+            USED_SHA=${{ github.sha }}
+          else
+            USED_SHA=${{ inputs.SOURCE_LINK_COMMIT_OVERRIDE }}
+          fi
+          echo "SHORT_SHA=$(echo $USED_SHA | cut -c1-7)" >> $GITHUB_ENV
+
+      - name: Build web demo
+        env:
+          COMMIT_HASH: ${{ env.SHORT_SHA }}
+        run: |
+          python3 scripts/build_demo_app.py --skip-wasm-build
+
+      - name: Upload web demo assets
+        uses: actions/upload-artifact@v3
+        with:
+          name: web_demo
+          path: web_demo
+

.github/workflows/reusable_upload_web_demo.yml

@@ -0,0 +1,108 @@
+name: Reusable Upload Web Demo
+
+on:
+  workflow_call:
+    inputs:
+      CONCURRENCY:
+        required: true
+        type: string
+      ADHOC_NAME:
+        type: string
+        required: false
+        default: ''
+      MARK_PRERELEASE_FOR_MAINLINE:
+        required: false
+        type: boolean
+        default: false
+      MARK_TAGGED_VERSION:
+        required: false
+        type: boolean
+        default: false
+      RELEASE_VERSION:
+        required: false
+        type: string
+        default: 'prerelease'
+      # We need this because PRs use a merged commit but we really want
+      # to track uploads based on the source commit.
+      UPLOAD_COMMIT_OVERRIDE:
+        required: false
+        type: string
+        default: ''
+
+concurrency:
+  group: ${{ inputs.CONCURRENCY }}-upload-web-demo
+  cancel-in-progress: true
+
+jobs:
+
+  upload-web:
+    name: Upload Web Wemo to Google Cloud
+    permissions:
+      contents: "read"
+      id-token: "write"
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Download web demo assets
+        uses: actions/download-artifact@v3
+        with:
+          name: web_demo
+          path: web_demo
+
+      # Upload the wasm, html etc to a Google cloud bucket:
+      - id: "auth"
+        uses: google-github-actions/auth@v1
+        with:
+          workload_identity_provider: ${{ secrets.GOOGLE_WORKLOAD_IDENTITY_PROVIDER }}
+          service_account: ${{ secrets.GOOGLE_SERVICE_ACCOUNT }}
+
+      - name: Add SHORT_SHA env property with commit short sha
+        run: |
+          if [ -z "${{ inputs.UPLOAD_COMMIT_OVERRIDE }}" ]; then
+            USED_SHA=${{ github.sha }}
+          else
+            USED_SHA=${{ inputs.UPLOAD_COMMIT_OVERRIDE }}
+          fi
+          echo "SHORT_SHA=$(echo $USED_SHA | cut -c1-7)" >> $GITHUB_ENV
+
+      - name: "Upload web demo (commit)"
+        uses: google-github-actions/upload-cloud-storage@v1
+        with:
+          path: "web_demo"
+          destination: "rerun-demo/commit/${{env.SHORT_SHA}}"
+          parent: false
+
+      - name: "Upload web demo (prerelease)"
+        if: inputs.MARK_PRERELEASE_FOR_MAINLINE
+        uses: google-github-actions/upload-cloud-storage@v1
+        with:
+          path: "web_demo"
+          destination: "rerun-demo/prerelease"
+          parent: false
+
+      - name: "Upload web demo (tagged)"
+        if: inputs.MARK_TAGGED_VERSION
+        uses: google-github-actions/upload-cloud-storage@v1
+        with:
+          path: "web_demo"
+          destination: "rerun-demo/version/${{inputs.RELEASE_VERSION}}"
+          parent: false
+
+      - name: "Upload web demo (latest)"
+        if: inputs.MARK_TAGGED_VERSION
+        uses: google-github-actions/upload-cloud-storage@v1
+        with:
+          path: "web_demo"
+          destination: "rerun-demo/version/latest"
+          parent: false
+
+      - name: "Upload web demo (adhoc)"
+        if: ${{ inputs.ADHOC_NAME != '' }}
+        uses: google-github-actions/upload-cloud-storage@v1
+        with:
+          path: "web_demo"
+          destination: "rerun-demo/adhoc/${{inputs.ADHOC_NAME}}"
+          parent: false

.gitignore

@@ -20,3 +20,6 @@ perf.data*
 
 # Screenshots from samples etc.
 screenshot*.png
+
+# Web demo app build
+web_demo