fix: bust fast check cache on deno_graph version change (#491)

Author: dsherret

src/fast_check/cache.rs

@@ -17,12 +17,14 @@ pub struct FastCheckCacheKey(u64);
 impl FastCheckCacheKey {
   #[cfg(feature = "fast_check")]
   pub fn build(
+    hash_seed: &'static str,
     package_nv: &PackageNv,
     entrypoints: &BTreeSet<ModuleSpecifier>,
   ) -> Self {
     use std::hash::Hash;
     use std::hash::Hasher;
     let mut hasher = twox_hash::XxHash64::default();
+    hash_seed.hash(&mut hasher);
     package_nv.hash(&mut hasher);
     for value in entrypoints {
       value.hash(&mut hasher);
@@ -83,9 +85,15 @@ pub struct FastCheckCacheModuleItemDiagnostic {
 }
 
 /// Cache for storing the results of fast checks based on a package.
-///
-/// Note: Implementors should bust their cache when their version changes.
 pub trait FastCheckCache {
+  /// Seed that is provided to the hash in order to cache bust
+  /// it on version changes.
+  ///
+  /// This defaults to the current deno_graph version.
+  fn hash_seed(&self) -> &'static str {
+    env!("CARGO_PKG_VERSION")
+  }
+
   fn get(&self, key: FastCheckCacheKey) -> Option<FastCheckCacheItem>;
   fn set(&self, key: FastCheckCacheKey, value: FastCheckCacheItem);
 }

src/fast_check/mod.rs

@@ -570,7 +570,11 @@ pub fn build_fast_check_type_graph<'a>(
             ),
           ));
         }
-        let cache_key = FastCheckCacheKey::build(&nv, &package.entrypoints);
+        let cache_key = FastCheckCacheKey::build(
+          fast_check_cache.hash_seed(),
+          &nv,
+          &package.entrypoints,
+        );
         fast_check_cache.set(
           cache_key,
           FastCheckCacheItem {

src/fast_check/range_finder.rs

@@ -466,7 +466,8 @@ impl<'a> PublicRangeFinder<'a> {
     let Some(fast_check_cache) = &self.fast_check_cache else {
       return None;
     };
-    let cache_key = FastCheckCacheKey::build(nv, entrypoints);
+    let cache_key =
+      FastCheckCacheKey::build(fast_check_cache.hash_seed(), nv, entrypoints);
     let Some(cache_item) = fast_check_cache.get(cache_key) else {
       return None;
     };

tests/helpers/mod.rs

@@ -142,6 +142,10 @@ pub struct TestFastCheckCache {
 }
 
 impl FastCheckCache for TestFastCheckCache {
+  fn hash_seed(&self) -> &'static str {
+    "stable-for-tests"
+  }
+
   fn get(
     &self,
     key: deno_graph::FastCheckCacheKey,

tests/specs/graph/fast_check/cache__basic.txt

@@ -286,6 +286,6 @@ Fast check https://jsr.io/@scope/a/1.0.0/mod.ts:
   }
 
 == fast check cache ==
-FastCheckCacheKey(4741815020074927300):
+FastCheckCacheKey(13212997092325944472):
     Deps - []
     Modules: [["https://jsr.io/@scope/a/1.0.0/mod.ts","info"],["https://jsr.io/@scope/a/1.0.0/a.ts","info"],["https://jsr.io/@scope/a/1.0.0/a4.ts","info"],["https://jsr.io/@scope/a/1.0.0/a6.ts","info"]]

tests/specs/graph/fast_check/cache__diagnostic.txt

@@ -152,6 +152,6 @@ Fast check https://jsr.io/@scope/a/1.0.0/mod.ts:
 
 
 == fast check cache ==
-FastCheckCacheKey(4741815020074927300):
+FastCheckCacheKey(13212997092325944472):
     Deps - []
     Modules: [["https://jsr.io/@scope/a/1.0.0/mod.ts","diagnostic"],["https://jsr.io/@scope/a/1.0.0/c.ts","diagnostic"]]

tests/specs/graph/fast_check/cache__diagnostic_deep.txt

@@ -153,6 +153,6 @@ Fast check https://jsr.io/@scope/a/1.0.0/mod.ts:
 
 
 == fast check cache ==
-FastCheckCacheKey(4741815020074927300):
+FastCheckCacheKey(13212997092325944472):
     Deps - []
     Modules: [["https://jsr.io/@scope/a/1.0.0/mod.ts","diagnostic"],["https://jsr.io/@scope/a/1.0.0/a.ts","diagnostic"],["https://jsr.io/@scope/a/1.0.0/b.ts","diagnostic"],["https://jsr.io/@scope/a/1.0.0/c.ts","diagnostic"]]

tests/specs/graph/fast_check/cache__diagnostic_multiple_exports.txt

@@ -186,6 +186,6 @@ Fast check https://jsr.io/@scope/a/1.0.0/mod.ts:
 
 
 == fast check cache ==
-FastCheckCacheKey(2640350593211828171):
+FastCheckCacheKey(17039939699199502831):
     Deps - []
     Modules: [["https://jsr.io/@scope/a/1.0.0/mod.ts","diagnostic"],["https://jsr.io/@scope/a/1.0.0/b.ts","diagnostic"],["https://jsr.io/@scope/a/1.0.0/a.ts","diagnostic"]]

tests/specs/graph/fast_check/cache__diagnostic_then_nested_dep.txt

@@ -192,9 +192,9 @@ Fast check https://jsr.io/@scope/b/1.0.0/mod.ts:
   }
 
 == fast check cache ==
-FastCheckCacheKey(4741815020074927300):
-    Deps - ["@scope/[email protected]"]
-    Modules: [["https://jsr.io/@scope/a/1.0.0/mod.ts","diagnostic"]]
-FastCheckCacheKey(15065614787034843742):
+FastCheckCacheKey(3278580195394936988):
     Deps - []
     Modules: [["https://jsr.io/@scope/b/1.0.0/mod.ts","info"]]
+FastCheckCacheKey(13212997092325944472):
+    Deps - ["@scope/[email protected]"]
+    Modules: [["https://jsr.io/@scope/a/1.0.0/mod.ts","diagnostic"]]