Skip to content

feat: make the cache manifest more deterministic #53

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

Merged
dsherret merged 1 commit into from
Jul 19, 2024
Merged

feat: make the cache manifest more deterministic #53

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
30 changes: 15 additions & 15 deletions rs_lib/src/local.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.

use std::collections::BTreeMap;
use std::collections::HashMap;
use std::collections::HashSet;
use std::io::ErrorKind;
Expand All @@ -9,7 +10,6 @@ use std::sync::Arc;
use std::time::SystemTime;

use deno_media_type::MediaType;
use indexmap::IndexMap;
use once_cell::sync::Lazy;
use parking_lot::RwLock;
use url::Url;
Expand Down Expand Up @@ -616,7 +616,7 @@ impl<Env: DenoCacheEnv> LocalCacheManifest<Env> {
!= MediaType::from_specifier_and_headers(url, Some(headers))
}

let mut headers_subset = IndexMap::new();
let mut headers_subset = BTreeMap::new();

const HEADER_KEYS_TO_KEEP: [&str; 4] = [
// keep alphabetical for cleanliness in the output
Expand Down Expand Up @@ -707,11 +707,10 @@ impl<Env: DenoCacheEnv> LocalCacheManifest<Env> {
// This is in a separate module in order to enforce keeping
// the internal implementation private.
mod manifest {
use std::collections::HashMap;
use std::collections::BTreeMap;
use std::path::Path;
use std::path::PathBuf;

use indexmap::IndexMap;
use serde::Deserialize;
use serde::Serialize;
use url::Url;
Expand All @@ -722,10 +721,10 @@ mod manifest {
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct SerializedLocalCacheManifestDataModule {
#[serde(
default = "IndexMap::new",
skip_serializing_if = "IndexMap::is_empty"
default = "BTreeMap::new",
skip_serializing_if = "BTreeMap::is_empty"
)]
pub headers: IndexMap<String, String>,
pub headers: BTreeMap<String, String>,
}

impl SerializedLocalCacheManifestDataModule {
Expand All @@ -734,25 +733,26 @@ mod manifest {
}
}

// Using BTreeMap to make sure that the data is always sorted
#[derive(Debug, Default, Clone, Serialize, Deserialize)]
struct SerializedLocalCacheManifestData {
#[serde(
default = "IndexMap::new",
skip_serializing_if = "IndexMap::is_empty"
default = "BTreeMap::new",
skip_serializing_if = "BTreeMap::is_empty"
)]
pub folders: IndexMap<Url, String>,
pub folders: BTreeMap<Url, String>,
#[serde(
default = "IndexMap::new",
skip_serializing_if = "IndexMap::is_empty"
default = "BTreeMap::new",
skip_serializing_if = "BTreeMap::is_empty"
)]
pub modules: IndexMap<Url, SerializedLocalCacheManifestDataModule>,
pub modules: BTreeMap<Url, SerializedLocalCacheManifestDataModule>,
}

#[derive(Debug, Default, Clone)]
pub(super) struct LocalCacheManifestData {
serialized: SerializedLocalCacheManifestData,
// reverse mapping used in the lsp
reverse_mapping: Option<HashMap<PathBuf, Url>>,
reverse_mapping: Option<BTreeMap<PathBuf, Url>>,
}

impl LocalCacheManifestData {
Expand Down Expand Up @@ -794,7 +794,7 @@ mod manifest {
};
(path, url.clone())
}))
.collect::<HashMap<_, _>>(),
.collect::<BTreeMap<_, _>>(),
)
} else {
None
Expand Down