Add more examples to app.rerun.io #2062

jprochazk · 2023-05-09T10:59:52Z

Closes #2017

To run it locally:

$ ./scripts/build_demo_app.py --serve

And open localhost:8080

What

Added the build_demo_app.py script, which runs a cherry-picked list of examples, producing .rrd files. The result is then wrapped up into a shell app which adds a dropdown to switch between the individual examples, a description for each example, and a link to its source code on GitHub.

The app is built on every commit, just like the existing web-viewer app (app.rerun.io), and deployed to a GCS bucket, which is available at demo.rerun.io. The examples app supports the same prefixes as the original web viewer (adhoc/<name>, version/<tag>, commit/<short hash>)

Checklist

I have read and agree to Contributor Guide and the Code of Conduct
I've included a screenshot or gif (if applicable)

PR Build Summary: https://build.rerun.io/pr/2062

scripts/build_demo_app.py

jprochazk · 2023-05-12T07:49:38Z

The deployments work now, but I'm getting some weirdness in the app itself:

jprochazk · 2023-05-12T12:06:12Z

The weirdness is not caused by the stuff in this PR

teh-cmc

Absolutely fantastic 🤌

A few things I'd like to see fixed before this gets merged, but otherwise it's 🟢:

Make sure to bind to all network interfaces (0.0.0.0)
Highlight on the Github button is behaving a bit weird:

scripts/build_demo_app.py

.github/workflows/reusable_build_web_demo.yml

teh-cmc · 2023-05-15T09:17:12Z

.github/workflows/reusable_build_web_demo.yml

+
+      - name: Build web demo
+        env:
+          COMMIT_HASH: ${{ github.env.GITHUB_SHA }}


Don't you need to do the whole commit override dance here? Asking just in case, I'm not too familiar with the matter...

I'm not sure, either. Maybe @jleibs can comment on this?

I believe so. Without the commit-override-dance then when running this job *on pull request, GITHUB_SHA is going to sometimes point to an ephemeral merge-commit, which I think means your code-link from the examples will be broken.

Not necessarily the end of the world for this use-case since the adhoc / on-push-main versions which are the only ones I expect someone in the public to see will still do the right thing, but probably worth adding in the support.

Added this in the form of a SOURCE_LINK_COMMIT_OVERRIDE input to the build_web_demo workflow.

jprochazk · 2023-05-15T10:31:42Z

Seems like the icon just needed a static width and height. Tested it on chrome/firefox/safari, looks to be fine now.

https://demo.rerun.io/commit/6879bc7/examples/colmap/

the script: - cleans the `web_demo` dir - copies static assets (favicon, index.html, js, css, etc.) - uses `re_build_web_viewer` to build the WASM and copies the binaries to `web_demo` - runs the examples with `--save` - renders the example template for each example

- include example titles and descriptions - add `--serve` flag for locally serving the resulting dir

- changed `<select>` to a custom dropdown - added `?` icon with description

- use it to resize colmap to 800x600

examples aren't built into that directory anymore

teh-cmc

Looking good 👌

(Please avoid force-pushing once someone has started reviewing your PR 🙏)

jprochazk · 2023-05-16T08:24:57Z

Please avoid force-pushing once someone has started reviewing your PR

I did this out of habit, I'll merge instead from now on, sorry!

jprochazk changed the title ~~Jan/more web examples~~ Add more examples to app.rerun.io May 9, 2023

jprochazk added 📖 documentation Improvements or additions to documentation 🕸️ web regarding running the viewer in a browser examples Issues relating to the Rerun examples labels May 9, 2023

jprochazk force-pushed the jan/more-web-examples branch from 03d3269 to 71cd0dd Compare May 11, 2023 09:48

jprochazk commented May 11, 2023

View reviewed changes

scripts/build_demo_app.py Show resolved Hide resolved

jprochazk force-pushed the jan/more-web-examples branch 2 times, most recently from ac2cb62 to 2a681de Compare May 11, 2023 18:04

jprochazk marked this pull request as ready for review May 11, 2023 18:04

jprochazk force-pushed the jan/more-web-examples branch from 2281379 to ed6c9ef Compare May 12, 2023 07:30

jprochazk force-pushed the jan/more-web-examples branch from 6619a92 to 87dc036 Compare May 12, 2023 12:08

teh-cmc self-requested a review May 15, 2023 08:45

teh-cmc approved these changes May 15, 2023

View reviewed changes

jprochazk force-pushed the jan/more-web-examples branch from 87dc036 to 6879bc7 Compare May 15, 2023 10:28

jprochazk added 13 commits May 16, 2023 09:44

separate web_viewer html, css, and js for reuse

4c3d2f6

ignore web_viewer/examples

a90fe19

add web examples build script

8453ba6

revert web_viewer

bb7878e

move demo html/js/css into scripts/templates/demo

6d5ca47

rename build_examples_rrd to build_demo_app

bc3fc96

move demo app assets to a separate directory

38b27ca

update build_demo_app.py script

c2e20d7

- include example titles and descriptions - add `--serve` flag for locally serving the resulting dir

remove unnecessary markup

cb49028

update examples header

b061ea0

- changed `<select>` to a custom dropdown - added `?` icon with description

change port to static

0d10dc2

fix icon user-select

c6b5d8b

jprochazk added 21 commits May 16, 2023 09:44

fix /examples links

14b6b54

add build/upload workflows for web demo

4723e5a

add web_demo workflows to ci

72e9d2b

install jinja2

aa9af79

update web-demo builds to require wheel build

5bbc1a9

download wasm from build-web instead of building

2e485ba

WASM -> Wasm

5b46ca3

only copy release wasm

cc27236

disable deep_sdf example

0910637

fix asset paths + upload tagged version as /latest

c0f3b9f

add extra build args

20af755

- use it to resize colmap to 800x600

uninstall rerun-sdk before installing

ce1e2ee

add -y when uninstalling rerun-sdk

f14ea5f

display output when building app

ec11ecf

cache js and css

f3588c1

remove examples from gitignore in web_viewer

26e008c

examples aren't built into that directory anymore

use latest commit hash in CI

8ccb574

bind --serve on 0.0.0.0

1d2e46b

fix typo in workflow

a710ab8

fix gh icon highlight

8ac58e7

add source link commit override

6dd3953

jprochazk force-pushed the jan/more-web-examples branch from 6879bc7 to 6dd3953 Compare May 16, 2023 07:44

jprochazk requested a review from teh-cmc May 16, 2023 08:01

teh-cmc approved these changes May 16, 2023

View reviewed changes

jprochazk merged commit c21fba8 into main May 16, 2023

jprochazk deleted the jan/more-web-examples branch May 16, 2023 08:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add more examples to app.rerun.io #2062

Add more examples to app.rerun.io #2062

jprochazk commented May 9, 2023 •

edited

Loading

jprochazk commented May 12, 2023

jprochazk commented May 12, 2023

teh-cmc left a comment

teh-cmc May 15, 2023

jprochazk May 15, 2023

jleibs May 15, 2023

jprochazk May 16, 2023

jprochazk commented May 15, 2023 •

edited

Loading

teh-cmc left a comment

jprochazk commented May 16, 2023

Add more examples to app.rerun.io #2062

Add more examples to app.rerun.io #2062

Conversation

jprochazk commented May 9, 2023 • edited Loading

What

Checklist

jprochazk commented May 12, 2023

jprochazk commented May 12, 2023

teh-cmc left a comment

Choose a reason for hiding this comment

teh-cmc May 15, 2023

Choose a reason for hiding this comment

jprochazk May 15, 2023

Choose a reason for hiding this comment

jleibs May 15, 2023

Choose a reason for hiding this comment

jprochazk May 16, 2023

Choose a reason for hiding this comment

jprochazk commented May 15, 2023 • edited Loading

teh-cmc left a comment

Choose a reason for hiding this comment

jprochazk commented May 16, 2023

jprochazk commented May 9, 2023 •

edited

Loading

jprochazk commented May 15, 2023 •

edited

Loading