Skip to content
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

Static data 1: static-aware datastore, caches and queries #5535

Merged
merged 9 commits into from
Apr 5, 2024

Conversation

teh-cmc
Copy link
Member

@teh-cmc teh-cmc commented Mar 15, 2024

Introduces the concept of static data into the data APIs.

Static data is a on a per-entity per-component basis. If it exists, it unconditionally shadows any temporal data of the same type. It is never garbage collected.
When static data is returned, it is indicated via TimeInt::STATIC.

The terminology has been normalized all over the place: data is either static or temporal, and nothing else.

Static data cannot have more than one cell per-entity per-component. Trying to write more than one cells will trigger last-write-wins semantics, as defined by RowId ordering.

Timeless fallbacks just don't exist anymore, which simplifies out a lot of code in the datastore and query cache.

Note: static data is in many subtle ways incompatible with our legacy InstanceKey-based model, which results in a couple hacks in this PR. Those hacks will be gone as soon as the new data APIs land and instance keys go away.


Part of a PR series that removes the concept of timeless data in favor of the much simpler concept of static data:

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!

Comment on lines -43 to -47
/// If enabled, the store will throw an error if and when it notices that a single component
/// type maps to more than one arrow datatype.
///
/// Enabled by default in debug builds.
pub enable_typecheck: bool,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing in anticipation of promises.

crates/re_data_store/src/store.rs Show resolved Hide resolved
crates/re_data_store/src/store.rs Show resolved Hide resolved
@@ -6,6 +6,8 @@ use crate::{DataStore, LatestAtQuery};

// --- Read ---

// TODO(cmc): these helpers have got to go once the new APIs land.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe add a issue number to this TODO

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there's already a PR open for it!

crates/re_data_store/src/store_read.rs Outdated Show resolved Hide resolved
crates/re_data_store/src/store_read.rs Show resolved Hide resolved
crates/re_query_cache/src/cache.rs Outdated Show resolved Hide resolved
crates/re_entity_db/src/entity_db.rs Outdated Show resolved Hide resolved
crates/re_space_view_text_log/src/visualizer_system.rs Outdated Show resolved Hide resolved
@teh-cmc teh-cmc force-pushed the cmc/static_0_timeint_shenanigans branch from 36f58cd to bd0c3d9 Compare April 5, 2024 14:04
@teh-cmc teh-cmc removed the do-not-merge Do not merge this PR label Apr 5, 2024
Base automatically changed from cmc/static_0_timeint_shenanigans to main April 5, 2024 14:20
teh-cmc added a commit that referenced this pull request Apr 5, 2024
_Commits make no sense, review the final changelog directly._

_All the interesting bits happen in `re_log_types/time_point` & `re_sdk`
-- everything else is just change propagation._


- `TimeInt` now ranges from `i64:MIN + 1` to `i64::MAX`.
- `TimeInt::STATIC`, which takes the place of the now illegal
`TimeInt(i64::MIN)`, is now _the only way_ of identifying static data.
- It is impossible to create `TimeInt::STATIC` inadvertently -- users of
the SDK cannot set the clock to that value.
- Similarly, it is impossible to create a `TimeRange`, a `TimePoint`, a
`LatestAtQuery` or a `RangeQuery` that includes `TimeInt::STATIC`.
If static data exists, that's what will be returned, unconditionally --
there's no such thing as querying for it explicitely.
- `TimePoint::timeless` is gone -- we already have `TimePoint::default`
that we use all over the place, we don't need two ways of doing the same
thing.

There still exists a logical mapping between an empty `TimePoint` and
static data, as that is how one represents static data on the wire --
terminology wise: "a timeless timepoint results in static data".

Similar to the "ensure `RowId`s are unique" refactor from back when,
this seemingly tiny change on the surface will vastly simplify
downstream code that finally has some invariants to rely on.

- Fixes #4832
- Related to #5264


---

Part of a PR series that removes the concept of timeless data in favor
of the much simpler concept of static data:
- #5534
- #5535
- #5536
- #5537
- #5540
@teh-cmc teh-cmc merged commit 08109da into main Apr 5, 2024
10 of 13 checks passed
@teh-cmc teh-cmc deleted the cmc/static_1_store branch April 5, 2024 15:09
teh-cmc added a commit that referenced this pull request Apr 5, 2024
Just exposing all the new static stuff to the Python SDK, and trying to
kill the "timeless" terminology in the process.

---

Part of a PR series that removes the concept of timeless data in favor
of the much simpler concept of static data:
- #5534
- #5535
- #5536
- #5537
- #5540
teh-cmc added a commit that referenced this pull request Apr 5, 2024
Just exposing all the new static stuff to the C & C++ SDKs, and trying
to kill the "timeless" terminology in the process.

---

Part of a PR series that removes the concept of timeless data in favor
of the much simpler concept of static data:
- #5534
- #5535
- #5536
- #5537
- #5540
teh-cmc added a commit that referenced this pull request Apr 5, 2024
Just exposing all the new static stuff to the Rust SDK, and trying to
kill the "timeless" terminology in the process.

---

Part of a PR series that removes the concept of timeless data in favor
of the much simpler concept of static data:
- #5534
- #5535
- #5536
- #5537
- #5540
Comment on lines -436 to -438
// EntityTree should be empty again when we end since everything was GC'd
assert_eq!(db.tree().num_children_and_fields(), 0);
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@teh-cmc why was this test removed -- we were depending on this functionality.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't quite remember -- probably a mistake, a lot of tests became redundant with each other as the model got vastly simplified

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔩 data model include in changelog ⛃ re_datastore affects the datastore itself 🔍 re_query affects re_query itself
Projects
None yet
3 participants