Skip to content

Warn when Geo* entities are logged and the viewer wasn't compiled with the map_view feature #8052

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Tracked by #7877
abey79 opened this issue Nov 8, 2024 · 1 comment · Fixed by #8061 or #8302
Closed
Tracked by #7877
Assignees
Labels
feat-map-view Everything related to the map view ui concerns graphical user interface

Comments

@abey79
Copy link
Member

abey79 commented Nov 8, 2024

The map view is behind a map_view cargo feature on rerun-cli, which is enabled in release build but not in default build (aka when building from source). This leads to a footgun where people don't see a map when they expect one. We should warn the user when that happens, indicating that the map_view feature needs to be enabled.

The proposed mechanism for that is to have a store subscribers that reacts to some specific indicator components, and emit warnings as required.

Level 1: hard code GeoPoints and GeoLineStrings (subject to bitrot, eg when we introduce GeoPolygons

Level 2: use the information already contained in attribute.docs.view_types to populate the reflection structures, and use said structure to generate warnings for all kinds of view that might be missing.
.
.
.

Level ∞: "unsupported data, click here to download the Map view plugin"

@abey79 abey79 added ui concerns graphical user interface feat-map-view Everything related to the map view labels Nov 8, 2024
@emilk emilk self-assigned this Nov 11, 2024
emilk added a commit that referenced this issue Nov 11, 2024
### What
* Closes #8052

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8061?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8061?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!
* [x] If have noted any breaking changes to the log API in
`CHANGELOG.md` and the migration guide

- [PR Build Summary](https://build.rerun.io/pr/8061)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.
@emilk
Copy link
Member

emilk commented Dec 3, 2024

We log a warning, but that's not good enough. We should show the error message in the space view with the problem:

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat-map-view Everything related to the map view ui concerns graphical user interface
Projects
None yet
2 participants