Fix web viewer feature flags #8295

jprochazk · 2024-12-03T13:10:44Z

What

build-web-viewer now propagates --no-default-features, and doesn't include it by default
Made map_view a default feature in re_viewer

github-actions · 2024-12-03T13:12:24Z

Web viewer built successfully. If applicable, you should also test it:

I have tested the web viewer

Result	Commit	Link
✅	`b7e8d58`	https://rerun.io/viewer/pr/8295

^{Note: This comment is updated whenever you push a commit.}

github-actions · 2024-12-03T13:14:45Z

Latest documentation preview deployed successfully.

Result	Commit	Link
✅	`b7e8d58`	https://landing-iiobifqen-rerun.vercel.app/docs

^{Note: This comment is updated whenever you push a commit.}

emilk · 2024-12-03T13:18:25Z

rerun_js/web-viewer/build-wasm.mjs

@@ -31,7 +31,8 @@ function buildWebViewer(mode) {
      "cargo run -p re_dev_tools -- build-web-viewer",
      modeFlags,
      "--target no-modules-base",
-      "--features grpc",
+      "--no-default-features",
+      "--features grpc,map_view",


I suggest we have a release = ["grpc", "map_view"] feature in re_viewer instead. It feels like a more discoverable location for controlling what goes into the release.

Suggested change

"--features grpc,map_view",

"--features release",

At this point I just made map_view a default feature. I don't agree with the release feature for web viewer specifically, it makes sense for rerun-cli because there it makes it possible for it to be compiled without nasm, and with -F release in case you do want nasm.

The big problem here imho was build_web_viewer silently passing --no-default-features to the re_viewer build

Makes sense 👍

jprochazk · 2024-12-03T13:36:20Z

Seems to work: https://rerun.io/viewer/pr/8295?url=https%3A%2F%2Fapp.rerun.io%2Fversion%2F0.20.2%2Fexamples%2Fnuscenes_dataset.rrd

emilk

Nice!

Btw, I wonder if we shouldn't make a re_web_viewer crate that just wraps re_viewer. re_viewer is weird in that it is both a library, and web app. Food for thought

emilk · 2024-12-03T13:50:01Z

rerun_js/web-viewer/build-wasm.mjs

@@ -31,7 +31,8 @@ function buildWebViewer(mode) {
      "cargo run -p re_dev_tools -- build-web-viewer",
      modeFlags,
      "--target no-modules-base",
-      "--features grpc",
+      "--no-default-features",
+      "--features grpc,map_view", // no `analytics`


this is for the NPM package, we don't want users' applications which embed the web viewer this way to send analytics to us. they will only do that if they embed the web viewer as an iframe

emilk · 2024-12-03T13:51:25Z

pixi.toml

+rerun-build-web = "rustup target add wasm32-unknown-unknown && cargo run -p re_dev_tools -- build-web-viewer --no-default-features --features analytics,grpc,map_view --debug"

 # Compile the web-viewer wasm and the cli.
 #
 # This installs the `wasm32-unknown-unknown` rust target if it's not already installed.
 # (this looks heavy but takes typically below 0.1s!)
-rerun-build-web-cli = "rustup target add wasm32-unknown-unknown && cargo run -p re_dev_tools -- build-web-viewer --features analytics,grpc --debug && cargo build --package rerun-cli --no-default-features --features web_viewer"
+rerun-build-web-cli = "rustup target add wasm32-unknown-unknown && cargo run -p re_dev_tools -- build-web-viewer --no-default-features --features analytics,grpc,map_view --debug && cargo build --package rerun-cli --no-default-features --features web_viewer"

 # Compile and run the web-viewer in release mode via rerun-cli.
 #
 # You can also give an argument for what to view (e.g. an .rrd file).
 #
 # This installs the `wasm32-unknown-unknown` rust target if it's not already installed.
 # (this looks heavy but takes typically below 0.1s!)
-rerun-web-release = { cmd = "cargo run --package rerun-cli --no-default-features --features web_viewer --release -- --web-viewer", depends_on = [
+rerun-web-release = { cmd = "cargo run --package rerun-cli --no-default-features --features web_viewer,map_view,grpc --release -- --web-viewer", depends_on = [
  "rerun-build-web-release",
 ] }

 # Compile the web-viewer wasm in release mode.
 #
 # This installs the `wasm32-unknown-unknown` rust target if it's not already installed.
 # (this looks heavy but takes typically below 0.1s!)
-rerun-build-web-release = "rustup target add wasm32-unknown-unknown && cargo run -p re_dev_tools -- build-web-viewer --features analytics,grpc --release -g"
+rerun-build-web-release = "rustup target add wasm32-unknown-unknown && cargo run -p re_dev_tools -- build-web-viewer --no-default-features --features analytics,grpc,map_view --release -g"


Isn't easier to keep the default features and just add on grpc?

I wanted to be more explicit here, because you're not going to type the long command

emilk

Nice!

Btw, I wonder if we shouldn't make a re_web_viewer crate that just wraps re_viewer. re_viewer is weird in that it is both a library, and web app. Food for thought

jprochazk · 2024-12-03T14:02:12Z

Btw, I wonder if we shouldn't make a re_web_viewer crate that just wraps re_viewer. re_viewer is weird in that it is both a library, and web app. Food for thought

Reorganize re_viewer into re_viewer and re_web_viewer #8297

pass through --no-default-features

02b8516

jprochazk added 🕸️ web regarding running the viewer in a browser 📺 re_viewer affects re_viewer itself include in changelog labels Dec 3, 2024

jprochazk added 2 commits December 3, 2024 14:12

re-enable map_view feature for web viewer builds

805465b

add map_view back to js package

be4c4b9

oops

315790d

emilk reviewed Dec 3, 2024

View reviewed changes

jprochazk added 5 commits December 3, 2024 14:20

fix arg passing

a6d9637

make map_view a default feature for re_viewer

37cd2dd

fix no-default-features arg

d4de72d

add some missing features

6d1b44b

no analytics in npm package

b7e8d58

emilk approved these changes Dec 3, 2024

View reviewed changes

jprochazk merged commit 312f91c into main Dec 3, 2024
37 checks passed

jprochazk deleted the jan/fix-web-viewer-features branch December 3, 2024 14:02

jprochazk added a commit that referenced this pull request Dec 3, 2024

Fix web viewer feature flags (#8295)

36fba32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix web viewer feature flags #8295

Fix web viewer feature flags #8295

jprochazk commented Dec 3, 2024 •

edited

Loading

github-actions bot commented Dec 3, 2024 •

edited

Loading

github-actions bot commented Dec 3, 2024 •

edited

Loading

emilk Dec 3, 2024

jprochazk Dec 3, 2024 •

edited

Loading

jprochazk Dec 3, 2024 •

edited

Loading

emilk Dec 3, 2024

jprochazk commented Dec 3, 2024

emilk left a comment

emilk Dec 3, 2024

jprochazk Dec 3, 2024

emilk Dec 3, 2024

jprochazk Dec 3, 2024

emilk left a comment

jprochazk commented Dec 3, 2024 •

edited

Loading

Fix web viewer feature flags #8295

Fix web viewer feature flags #8295

Conversation

jprochazk commented Dec 3, 2024 • edited Loading

Related

What

github-actions bot commented Dec 3, 2024 • edited Loading

github-actions bot commented Dec 3, 2024 • edited Loading

emilk Dec 3, 2024

Choose a reason for hiding this comment

jprochazk Dec 3, 2024 • edited Loading

Choose a reason for hiding this comment

jprochazk Dec 3, 2024 • edited Loading

Choose a reason for hiding this comment

emilk Dec 3, 2024

Choose a reason for hiding this comment

jprochazk commented Dec 3, 2024

emilk left a comment

Choose a reason for hiding this comment

emilk Dec 3, 2024

Choose a reason for hiding this comment

jprochazk Dec 3, 2024

Choose a reason for hiding this comment

emilk Dec 3, 2024

Choose a reason for hiding this comment

jprochazk Dec 3, 2024

Choose a reason for hiding this comment

emilk left a comment

Choose a reason for hiding this comment

jprochazk commented Dec 3, 2024 • edited Loading

jprochazk commented Dec 3, 2024 •

edited

Loading

github-actions bot commented Dec 3, 2024 •

edited

Loading

github-actions bot commented Dec 3, 2024 •

edited

Loading

jprochazk Dec 3, 2024 •

edited

Loading

jprochazk Dec 3, 2024 •

edited

Loading

jprochazk commented Dec 3, 2024 •

edited

Loading