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.

Sign up for GitHub

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

docs: Document FileInBundleCache #1355

Merged
merged 1 commit into from
Jan 31, 2024
Merged

docs: Document FileInBundleCache #1355

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions crates/symbolicator-js/src/lookup.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -559,6 +559,7 @@ struct IndividualArtifact {

type FileInBundleCacheInner = moka::sync::Cache<(RemoteFileUri, FileKey), CachedFileEntry>;

/// A cache that memoizes looking up files in artifact bundles.
#[derive(Clone)]
pub struct FileInBundleCache {
cache: FileInBundleCacheInner,
Expand All @@ -571,6 +572,8 @@ impl std::fmt::Debug for FileInBundleCache {
}

impl FileInBundleCache {
/// Creates a new `FileInBundleCache` with a maximum size of 2GiB and
/// idle time of 1h.
pub fn new() -> Self {
const GIGS: u64 = 1 << 30;
let cache = FileInBundleCacheInner::builder()
Expand All @@ -591,6 +594,11 @@ impl FileInBundleCache {
Self { cache }
}

/// Tries to retrieve a file from the cache.
///
/// We look for the file under `(bundle_uri, key)` for `bundle_uri` in `bundle_uris`.
/// Retrieval is limited to a specific list of bundles so that e.g. files with the same
/// `abs_path` belonging to different events are disambiguated.
fn try_get(
&self,
bundle_uris: impl Iterator<Item = RemoteFileUri>,
Expand All @@ -607,6 +615,10 @@ impl FileInBundleCache {
None
}

/// Inserts `file_entry` into the cache under `(bundle_uri, key)`.
///
/// Files are inserted under a specific bundle so that e.g. files with the same
/// `abs_path` belonging to different events are disambiguated.
fn insert(&self, bundle_uri: &RemoteFileUri, key: &FileKey, file_entry: &CachedFileEntry) {
let key = (bundle_uri.clone(), key.clone());
self.cache.insert(key, file_entry.clone())
Expand All @@ -617,6 +629,9 @@ struct ArtifactFetcher {
metrics: JsMetrics,

// other services:
/// Cache for looking up files in artifact bundles.
///
/// This cache is shared between all JS symbolication requests.
files_in_bundles: FileInBundleCache,
objects: ObjectsActor,
sourcefiles_cache: Arc<SourceFilesCache>,
Expand Down Expand Up @@ -1032,6 +1047,7 @@ impl ArtifactFetcher {
return None;
}

// First see if we have already cached this file for any of this event's bundles.
if let Some(file_entry) = self
.files_in_bundles
.try_get(self.artifact_bundles.keys().rev().cloned(), key.clone())
Expand Down
Loading