1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
use ahash::{HashMap, HashMapExt, HashSet};
use anyhow::Context as _;
use itertools::Itertools as _;
use re_chunk_store::{ChunkStoreConfig, ChunkStoreGeneration, ChunkStoreStats};
use re_entity_db::{EntityDb, StoreBundle};
use re_log_types::{ApplicationId, StoreId, StoreKind};
use re_query::CachesStats;
use crate::{Caches, StoreContext};
/// Interface for accessing all blueprints and recordings
///
/// The [`StoreHub`] provides access to the [`EntityDb`] instances that are used
/// to store both blueprints and recordings.
///
/// Internally, the [`StoreHub`] tracks which [`ApplicationId`] and `recording
/// id` ([`StoreId`]) are currently active in the viewer. These can be configured
/// using [`StoreHub::set_active_recording_id`] and [`StoreHub::set_active_app`] respectively.
///
/// ## Blueprints
/// For each [`ApplicationId`], the [`StoreHub`] also keeps track of two blueprints:
/// * The active blueprint
/// * The default blueprint
///
/// Either on of these can be `None`.
///
/// The active blueprint is what the user would see and edit, if they were to select that app id.
/// If there is no active blueprint, the default will be cloned and made active.
///
/// The default blueprint is usually the blueprint set by the SDK.
/// This lets users reset the active blueprint to the one sent by the SDK.
#[derive(Default)]
pub struct StoreHub {
/// How we load and save blueprints.
persistence: BlueprintPersistence,
active_rec_id: Option<StoreId>,
active_application_id: Option<ApplicationId>,
default_blueprint_by_app_id: HashMap<ApplicationId, StoreId>,
active_blueprint_by_app_id: HashMap<ApplicationId, StoreId>,
store_bundle: StoreBundle,
/// Things that need caching.
caches_per_recording: HashMap<StoreId, Caches>,
/// The [`ChunkStoreGeneration`] from when the [`EntityDb`] was last saved
blueprint_last_save: HashMap<StoreId, ChunkStoreGeneration>,
/// The [`ChunkStoreGeneration`] from when the [`EntityDb`] was last garbage collected
blueprint_last_gc: HashMap<StoreId, ChunkStoreGeneration>,
}
/// Load a blueprint from persisted storage, e.g. disk.
/// Returns `Ok(None)` if no blueprint is found.
pub type BlueprintLoader =
dyn Fn(&ApplicationId) -> anyhow::Result<Option<StoreBundle>> + Send + Sync;
/// Save a blueprint to persisted storage, e.g. disk.
pub type BlueprintSaver = dyn Fn(&ApplicationId, &EntityDb) -> anyhow::Result<()> + Send + Sync;
/// Validate a blueprint against the current blueprint schema requirements.
pub type BlueprintValidator = dyn Fn(&EntityDb) -> bool + Send + Sync;
/// How to save and load blueprints
#[derive(Default)]
pub struct BlueprintPersistence {
pub loader: Option<Box<BlueprintLoader>>,
pub saver: Option<Box<BlueprintSaver>>,
pub validator: Option<Box<BlueprintValidator>>,
}
/// Convenient information used for `MemoryPanel`
#[derive(Default)]
pub struct StoreHubStats {
pub blueprint_stats: ChunkStoreStats,
pub blueprint_cached_stats: CachesStats,
pub blueprint_config: ChunkStoreConfig,
pub recording_stats2: ChunkStoreStats,
pub recording_cached_stats: CachesStats,
pub recording_config2: ChunkStoreConfig,
}
impl StoreHub {
/// App ID used as a marker to display the welcome screen.
pub fn welcome_screen_app_id() -> ApplicationId {
"Welcome screen".into()
}
/// Blueprint ID used for the default welcome screen blueprint
fn welcome_screen_blueprint_id() -> StoreId {
StoreId::from_string(
StoreKind::Blueprint,
Self::welcome_screen_app_id().to_string(),
)
}
/// Used only for tests
pub fn test_hub() -> Self {
Self::new(
BlueprintPersistence {
loader: None,
saver: None,
validator: None,
},
&|_| {},
)
}
/// Create a new [`StoreHub`].
///
/// The [`StoreHub`] will contain a single empty blueprint associated with the app ID returned
/// by `[StoreHub::welcome_screen_app_id]`. It should be used as a marker to display the welcome
/// screen.
pub fn new(
persistence: BlueprintPersistence,
setup_welcome_screen_blueprint: &dyn Fn(&mut EntityDb),
) -> Self {
re_tracing::profile_function!();
let mut default_blueprint_by_app_id = HashMap::new();
let mut store_bundle = StoreBundle::default();
default_blueprint_by_app_id.insert(
Self::welcome_screen_app_id(),
Self::welcome_screen_blueprint_id(),
);
let welcome_screen_blueprint =
store_bundle.blueprint_entry(&Self::welcome_screen_blueprint_id());
(setup_welcome_screen_blueprint)(welcome_screen_blueprint);
Self {
persistence,
active_rec_id: None,
active_application_id: None,
default_blueprint_by_app_id,
active_blueprint_by_app_id: Default::default(),
store_bundle,
caches_per_recording: Default::default(),
blueprint_last_save: Default::default(),
blueprint_last_gc: Default::default(),
}
}
// ---------------------
// Accessors
/// All the loaded recordings and blueprints.
#[inline]
pub fn store_bundle(&self) -> &StoreBundle {
&self.store_bundle
}
/// Get a read-only [`StoreContext`] from the [`StoreHub`] if one is available.
///
/// All of the returned references to blueprints and recordings will have a
/// matching [`ApplicationId`].
pub fn read_context(&mut self) -> Option<StoreContext<'_>> {
static EMPTY_ENTITY_DB: once_cell::sync::Lazy<EntityDb> =
once_cell::sync::Lazy::new(|| EntityDb::new(re_log_types::StoreId::empty_recording()));
static EMPTY_CACHES: once_cell::sync::Lazy<Caches> =
once_cell::sync::Lazy::new(Default::default);
// If we have an app-id, then use it to look up the blueprint.
let app_id = self.active_application_id.clone()?;
// Defensive coding: Check that default and active blueprints exists,
// in case some of our book-keeping is broken.
if let Some(blueprint_id) = self.default_blueprint_by_app_id.get(&app_id) {
if !self.store_bundle.contains(blueprint_id) {
self.default_blueprint_by_app_id.remove(&app_id);
}
}
if let Some(blueprint_id) = self.active_blueprint_by_app_id.get(&app_id) {
if !self.store_bundle.contains(blueprint_id) {
self.active_blueprint_by_app_id.remove(&app_id);
}
}
// If there's no active blueprint for this app, try to make the current default one active.
if !self.active_blueprint_by_app_id.contains_key(&app_id) {
if let Some(blueprint_id) = self.default_blueprint_by_app_id.get(&app_id).cloned() {
self.set_cloned_blueprint_active_for_app(&app_id, &blueprint_id)
.unwrap_or_else(|err| {
re_log::warn!("Failed to make blueprint active: {err}");
});
}
}
let active_blueprint = {
// Get the id is of whatever blueprint is now active, falling back on the "app blueprint" if needed.
let active_blueprint_id = self
.active_blueprint_by_app_id
.entry(app_id.clone())
.or_insert_with(|| StoreId::from_string(StoreKind::Blueprint, app_id.clone().0));
// Get or create the blueprint:
self.store_bundle.blueprint_entry(active_blueprint_id);
self.store_bundle.get(active_blueprint_id)?
};
let default_blueprint = self
.default_blueprint_by_app_id
.get(&app_id)
.and_then(|id| self.store_bundle.get(id));
let recording = self
.active_rec_id
.as_ref()
.and_then(|id| self.store_bundle.get(id));
if recording.is_none() {
self.active_rec_id = None;
}
let caches = self.active_caches();
Some(StoreContext {
app_id,
blueprint: active_blueprint,
default_blueprint,
recording: recording.unwrap_or(&EMPTY_ENTITY_DB),
bundle: &self.store_bundle,
caches: caches.unwrap_or(&EMPTY_CACHES),
hub: self,
})
}
/// Mutable access to a [`EntityDb`] by id
pub fn entity_db_mut(&mut self, store_id: &StoreId) -> &mut EntityDb {
self.store_bundle.entry(store_id)
}
// ---------------------
// Add and remove stores
/// Insert a new recording or blueprint into the [`StoreHub`].
///
/// Note that the recording is not automatically made active. Use [`StoreHub::set_active_recording_id`]
/// if needed.
pub fn insert_entity_db(&mut self, entity_db: EntityDb) {
self.store_bundle.insert(entity_db);
}
pub fn remove(&mut self, store_id: &StoreId) {
_ = self.caches_per_recording.remove(store_id);
let removed_store = self.store_bundle.remove(store_id);
let Some(removed_store) = removed_store else {
return;
};
match removed_store.store_kind() {
StoreKind::Recording => {
if let Some(app_id) = removed_store.app_id().cloned() {
let any_other_recordings_for_this_app = self
.store_bundle
.recordings()
.any(|rec| rec.app_id() == Some(&app_id));
if !any_other_recordings_for_this_app {
re_log::trace!("Removed last recording of {app_id}. Closing app.");
self.close_app(&app_id);
}
}
}
StoreKind::Blueprint => {
self.active_blueprint_by_app_id
.retain(|_, id| id != store_id);
self.default_blueprint_by_app_id
.retain(|_, id| id != store_id);
}
}
if self.active_rec_id.as_ref() == Some(store_id) {
if let Some(new_selection) = self.store_bundle.find_closest_recording(store_id) {
self.set_active_recording_id(new_selection.clone());
} else {
self.active_application_id = None;
self.active_rec_id = None;
}
}
}
pub fn retain(&mut self, mut should_retain: impl FnMut(&EntityDb) -> bool) {
let stores_to_remove: Vec<StoreId> = self
.store_bundle
.entity_dbs()
.filter_map(|store| {
if should_retain(store) {
None
} else {
Some(store.store_id().clone())
}
})
.collect();
for store in stores_to_remove {
self.remove(&store);
}
}
/// Remove all open recordings and applications, and go to the welcome page.
pub fn clear_recordings(&mut self) {
// Keep only the welcome screen:
let mut store_ids_retained = HashSet::default();
self.store_bundle.retain(|db| {
if db.app_id() == Some(&Self::welcome_screen_app_id()) {
store_ids_retained.insert(db.store_id().clone());
true
} else {
false
}
});
self.caches_per_recording
.retain(|store_id, _| store_ids_retained.contains(store_id));
self.active_rec_id = None;
self.active_application_id = Some(Self::welcome_screen_app_id());
}
// ---------------------
// Active app
/// Change the active [`ApplicationId`]
#[allow(clippy::needless_pass_by_value)]
pub fn set_active_app(&mut self, app_id: ApplicationId) {
// If we don't know of a blueprint for this `ApplicationId` yet,
// try to load one from the persisted store
if !self.active_blueprint_by_app_id.contains_key(&app_id) {
if let Err(err) = self.try_to_load_persisted_blueprint(&app_id) {
re_log::warn!("Failed to load persisted blueprint: {err}");
}
}
if self.active_application_id.as_ref() == Some(&app_id) {
return;
}
self.active_application_id = Some(app_id.clone());
self.active_rec_id = None;
// Find any matching recording and activate it
for rec in self
.store_bundle
.recordings()
.sorted_by_key(|entity_db| entity_db.store_info().map(|info| info.started))
{
if rec.app_id() == Some(&app_id) {
self.active_rec_id = Some(rec.store_id().clone());
return;
}
}
}
/// Close this application and all its recordings.
pub fn close_app(&mut self, app_id: &ApplicationId) {
if let Err(err) = self.save_app_blueprints() {
re_log::warn!("Failed to save blueprints: {err}");
}
let mut store_ids_removed = HashSet::default();
self.store_bundle.retain(|db| {
if db.app_id() == Some(app_id) {
store_ids_removed.insert(db.store_id().clone());
false
} else {
true
}
});
self.caches_per_recording
.retain(|store_id, _| !store_ids_removed.contains(store_id));
if self.active_application_id.as_ref() == Some(app_id) {
self.active_application_id = None;
self.active_rec_id = None;
}
self.default_blueprint_by_app_id.remove(app_id);
self.active_blueprint_by_app_id.remove(app_id);
}
#[inline]
pub fn active_app(&self) -> Option<&ApplicationId> {
self.active_application_id.as_ref()
}
// ---------------------
// Active recording
/// Directly access the [`EntityDb`] for the active recording.
#[inline]
pub fn active_recording_id(&self) -> Option<&StoreId> {
self.active_rec_id.as_ref()
}
/// Directly access the [`EntityDb`] for the active recording.
#[inline]
pub fn active_recording(&self) -> Option<&EntityDb> {
self.active_rec_id
.as_ref()
.and_then(|id| self.store_bundle.get(id))
}
/// Directly access the [`Caches`] for the active recording.
///
/// This returns `None` only if there is no active recording: the cache itself is always
/// present if there's an active recording.
#[inline]
pub fn active_caches(&self) -> Option<&Caches> {
self.active_rec_id.as_ref().and_then(|store_id| {
let caches = self.caches_per_recording.get(store_id);
debug_assert!(
caches.is_some(),
"active recordings should always have associated caches",
);
caches
})
}
/// Change the active/visible recording id.
///
/// This will also change the application-id to match the newly active recording.
pub fn set_active_recording_id(&mut self, recording_id: StoreId) {
debug_assert_eq!(recording_id.kind, StoreKind::Recording);
// If this recording corresponds to an app that we know about, then update the app-id.
if let Some(app_id) = self
.store_bundle
.get(&recording_id)
.as_ref()
.and_then(|recording| recording.app_id())
.cloned()
{
self.set_active_app(app_id);
}
self.active_rec_id = Some(recording_id.clone());
// Make sure the active recording has associated caches, always.
_ = self.caches_per_recording.entry(recording_id).or_default();
}
/// Activate a recording by its [`StoreId`].
pub fn set_activate_recording(&mut self, store_id: StoreId) {
match store_id.kind {
StoreKind::Recording => self.set_active_recording_id(store_id),
StoreKind::Blueprint => {
re_log::debug!("Tried to activate the blueprint {store_id} as a recording.");
}
}
}
// ---------------------
// Default blueprint
pub fn default_blueprint_id_for_app(&self, app_id: &ApplicationId) -> Option<&StoreId> {
self.default_blueprint_by_app_id.get(app_id)
}
pub fn default_blueprint_for_app(&self, app_id: &ApplicationId) -> Option<&EntityDb> {
self.default_blueprint_id_for_app(app_id)
.and_then(|id| self.store_bundle.get(id))
}
/// Change which blueprint is the default for a given [`ApplicationId`]
#[inline]
pub fn set_default_blueprint_for_app(
&mut self,
app_id: &ApplicationId,
blueprint_id: &StoreId,
) -> anyhow::Result<()> {
let blueprint = self
.store_bundle
.get(blueprint_id)
.context("missing blueprint")?;
// TODO(#6282): Improve this error message.
if let Some(validator) = &self.persistence.validator {
if !(validator)(blueprint) {
anyhow::bail!("Blueprint failed validation");
}
}
re_log::trace!("Switching default blueprint for '{app_id}' to '{blueprint_id}'");
self.default_blueprint_by_app_id
.insert(app_id.clone(), blueprint_id.clone());
Ok(())
}
/// Clear the current default blueprint
pub fn clear_default_blueprint(&mut self) {
if let Some(app_id) = &self.active_application_id {
if let Some(blueprint_id) = self.default_blueprint_by_app_id.remove(app_id) {
self.remove(&blueprint_id);
}
}
}
// ---------------------
// Active blueprint
/// What is the active blueprint for the active application?
pub fn active_blueprint_id(&self) -> Option<&StoreId> {
self.active_app()
.and_then(|app_id| self.active_blueprint_id_for_app(app_id))
}
pub fn active_blueprint_id_for_app(&self, app_id: &ApplicationId) -> Option<&StoreId> {
self.active_blueprint_by_app_id.get(app_id)
}
pub fn active_blueprint_for_app(&self, app_id: &ApplicationId) -> Option<&EntityDb> {
self.active_blueprint_id_for_app(app_id)
.and_then(|id| self.store_bundle.get(id))
}
/// Make blueprint active for a given [`ApplicationId`]
///
/// We never activate a blueprint directly. Instead, we clone it and activate the clone.
//TODO(jleibs): In the future this can probably be handled with snapshots instead.
pub fn set_cloned_blueprint_active_for_app(
&mut self,
app_id: &ApplicationId,
blueprint_id: &StoreId,
) -> anyhow::Result<()> {
let new_id = StoreId::random(StoreKind::Blueprint);
re_log::trace!(
"Cloning '{blueprint_id}' as '{new_id}' the active blueprint for '{app_id}' to '{blueprint_id}'"
);
let blueprint = self
.store_bundle
.get(blueprint_id)
.context("missing blueprint")?;
// TODO(#6282): Improve this error message.
if let Some(validator) = &self.persistence.validator {
if !(validator)(blueprint) {
anyhow::bail!("Blueprint failed validation");
}
}
let new_blueprint = blueprint.clone_with_new_id(new_id.clone())?;
self.store_bundle.insert(new_blueprint);
self.active_blueprint_by_app_id
.insert(app_id.clone(), new_id);
Ok(())
}
/// Is the given blueprint id the active blueprint for any app id?
pub fn is_active_blueprint(&self, blueprint_id: &StoreId) -> bool {
self.active_blueprint_by_app_id
.values()
.any(|id| id == blueprint_id)
}
/// Clear the currently active blueprint
pub fn clear_active_blueprint(&mut self) {
if let Some(app_id) = &self.active_application_id {
if let Some(blueprint_id) = self.active_blueprint_by_app_id.remove(app_id) {
re_log::debug!("Clearing blueprint for {app_id}: {blueprint_id}");
self.remove(&blueprint_id);
}
}
}
// ---------------------
// Misc operations
/// Cloned blueprints are the ones the user has edited,
/// i.e. NOT sent from the SDK.
pub fn clear_all_cloned_blueprints(&mut self) {
self.retain(|db| match db.store_kind() {
StoreKind::Recording => true,
StoreKind::Blueprint => db.cloned_from().is_none(),
});
}
/// Remove any empty [`EntityDb`]s from the hub
pub fn purge_empty(&mut self) {
self.retain(|entity_db| !entity_db.is_empty());
}
/// Call [`EntityDb::purge_fraction_of_ram`] on every recording
//
// NOTE: If you touch any of this, make sure to play around with our GC stress test scripts
// available under `$WORKSPACE_ROOT/tests/python/gc_stress`.
pub fn purge_fraction_of_ram(&mut self, fraction_to_purge: f32) {
re_tracing::profile_function!();
let Some(store_id) = self.store_bundle.find_oldest_modified_recording() else {
return;
};
if let Some(caches) = self.caches_per_recording.get_mut(&store_id) {
caches.purge_memory();
}
let store_bundle = &mut self.store_bundle;
let Some(entity_db) = store_bundle.get_mut(&store_id) else {
if cfg!(debug_assertions) {
unreachable!();
}
return; // unreachable
};
let store_size_before = entity_db
.storage_engine()
.store()
.stats()
.total()
.total_size_bytes;
let store_events = entity_db.purge_fraction_of_ram(fraction_to_purge);
let store_size_after = entity_db
.storage_engine()
.store()
.stats()
.total()
.total_size_bytes;
if let Some(caches) = self.caches_per_recording.get_mut(&store_id) {
caches.on_store_events(&store_events);
}
// No point keeping an empty recording around.
if entity_db.is_empty() {
self.remove(&store_id);
return;
}
// Running the GC didn't do anything.
//
// That's because all that's left in that store is protected rows: it's time to remove it
// entirely, unless it's the last recording still standing, in which case we're better off
// keeping some data around to show the user rather than a blank screen.
//
// If the user needs the memory for something else, they will get it back as soon as they
// log new things anyhow.
let num_recordings = store_bundle.recordings().count();
if store_size_before == store_size_after && num_recordings > 1 {
self.remove(&store_id);
}
// Either we've reached our target goal or we couldn't fetch memory stats, in which case
// we still consider that we're done anyhow.
// NOTE: It'd be tempting to loop through recordings here, as long as we haven't reached
// our actual target goal.
// We cannot do that though: there are other subsystems that need to release memory before
// we can get an accurate reading of the current memory used and decide if we should go on.
}
/// Remove any recordings with a network source pointing at this `uri`.
pub fn remove_recording_by_uri(&mut self, uri: &str) {
self.retain(|db| {
let Some(data_source) = &db.data_source else {
// no data source, keep
return true;
};
// retain only sources which:
// - aren't network sources
// - don't point at the given `uri`
match data_source {
re_smart_channel::SmartChannelSource::RrdHttpStream { url, .. } => url != uri,
re_smart_channel::SmartChannelSource::WsClient { ws_server_url } => {
ws_server_url != uri
}
_ => true,
}
});
}
pub fn gc_blueprints(&mut self) {
re_tracing::profile_function!();
for blueprint_id in self
.active_blueprint_by_app_id
.values()
.chain(self.default_blueprint_by_app_id.values())
{
if let Some(blueprint) = self.store_bundle.get_mut(blueprint_id) {
if self.blueprint_last_gc.get(blueprint_id) == Some(&blueprint.generation()) {
continue; // no change since last gc
}
// TODO(jleibs): Decide a better tuning for this. Would like to save a
// reasonable amount of history, or incremental snapshots.
let store_events =
blueprint.gc_everything_but_the_latest_row_on_non_default_timelines();
if let Some(caches) = self.caches_per_recording.get_mut(blueprint_id) {
caches.on_store_events(&store_events);
}
self.blueprint_last_gc
.insert(blueprint_id.clone(), blueprint.generation());
}
}
}
/// See `re_viewer_context::Cache::begin_frame`.
pub fn begin_frame(&mut self, renderer_active_frame_idx: u64) {
if let Some(store_id) = self.active_recording_id().cloned() {
if let Some(caches) = self.caches_per_recording.get_mut(&store_id) {
caches.begin_frame(renderer_active_frame_idx);
}
}
}
/// Persist any in-use blueprints to durable storage.
pub fn save_app_blueprints(&mut self) -> anyhow::Result<()> {
let Some(saver) = &self.persistence.saver else {
return Ok(());
};
re_tracing::profile_function!();
// Because we save blueprints based on their `ApplicationId`, we only
// save the blueprints referenced by `blueprint_by_app_id`, even though
// there may be other Blueprints in the Hub.
for (app_id, blueprint_id) in &self.active_blueprint_by_app_id {
if app_id == &Self::welcome_screen_app_id() {
continue; // Don't save changes to the welcome screen
}
let Some(blueprint) = self.store_bundle.get_mut(blueprint_id) else {
re_log::debug!("Failed to find blueprint {blueprint_id}.");
continue;
};
if self.blueprint_last_save.get(blueprint_id) == Some(&blueprint.generation()) {
continue; // no change since last save
}
(saver)(app_id, blueprint)?;
self.blueprint_last_save
.insert(blueprint_id.clone(), blueprint.generation());
}
Ok(())
}
/// Try to load the persisted blueprint for the given `ApplicationId`.
/// Note: If no blueprint exists at the expected path, the result is still considered `Ok`.
/// It is only an `Error` if a blueprint exists but fails to load.
fn try_to_load_persisted_blueprint(&mut self, app_id: &ApplicationId) -> anyhow::Result<()> {
re_tracing::profile_function!();
let Some(loader) = &self.persistence.loader else {
return Ok(());
};
if let Some(mut bundle) = (loader)(app_id)? {
for store in bundle.drain_entity_dbs() {
match store.store_kind() {
StoreKind::Recording => {
anyhow::bail!(
"Found a recording in a blueprint file: {:?}",
store.store_id()
);
}
StoreKind::Blueprint => {}
}
if store.app_id() != Some(app_id) {
if let Some(store_app_id) = store.app_id() {
anyhow::bail!("Found app_id {store_app_id}; expected {app_id}");
} else {
anyhow::bail!("Found store without an app_id");
}
}
// We found the blueprint we were looking for; make it active.
// borrow-checker won't let us just call `self.set_blueprint_for_app_id`
re_log::debug!(
"Activating new blueprint {} for {app_id}; loaded from disk",
store.store_id(),
);
self.active_blueprint_by_app_id
.insert(app_id.clone(), store.store_id().clone());
self.blueprint_last_save
.insert(store.store_id().clone(), store.generation());
self.store_bundle.insert(store);
}
}
Ok(())
}
/// Populate a [`StoreHubStats`] based on the active app.
//
// TODO(jleibs): We probably want stats for all recordings, not just the active recording.
pub fn stats(&self) -> StoreHubStats {
re_tracing::profile_function!();
// If we have an app-id, then use it to look up the blueprint.
let blueprint = self
.active_application_id
.as_ref()
.and_then(|app_id| self.active_blueprint_by_app_id.get(app_id))
.and_then(|blueprint_id| self.store_bundle.get(blueprint_id))
.map(|entity_db| entity_db.storage_engine());
let blueprint = blueprint.as_ref();
let blueprint_stats = blueprint
.map(|engine| engine.store().stats())
.unwrap_or_default();
let blueprint_cached_stats = blueprint
.map(|engine| engine.cache().stats())
.unwrap_or_default();
let blueprint_config = blueprint
.map(|engine| engine.store().config().clone())
.unwrap_or_default();
let recording = self
.active_rec_id
.as_ref()
.and_then(|rec_id| self.store_bundle.get(rec_id))
.map(|entity_db| entity_db.storage_engine());
let recording = recording.as_ref();
let recording_stats2 = recording
.map(|engine| engine.store().stats())
.unwrap_or_default();
let recording_cached_stats = recording
.map(|engine| engine.cache().stats())
.unwrap_or_default();
let recording_config2 = recording
.map(|engine| engine.store().config().clone())
.unwrap_or_default();
StoreHubStats {
blueprint_stats,
blueprint_cached_stats,
blueprint_config,
recording_stats2,
recording_cached_stats,
recording_config2,
}
}
}