feat: add sync cargo feature (#72)

denoland · Jan 22, 2025 · 5ed9314 · 5ed9314
1 parent ae318d8
commit 5ed9314
Show file tree

Hide file tree

Showing 34 changed files with 182 additions and 113 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -33,6 +33,9 @@ jobs:
         if: contains(matrix.os, 'ubuntu')
         run: cargo clippy
 
+      - name: Build (sync)
+        run: cargo build --features sync
+
       - name: Test
         run: cargo test
 

diff --git a/LICENCE b/LICENCE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2024 the Deno authors
+Copyright (c) 2018-2025 the Deno authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/auth_tokens.ts b/auth_tokens.ts
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 interface BearerAuthToken {
   type: "bearer";

diff --git a/auth_tokens_test.ts b/auth_tokens_test.ts
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 import { AuthTokens } from "./auth_tokens.ts";
 import { assertEquals } from "@std/assert";

diff --git a/cache.ts b/cache.ts
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 import type { LoadResponse } from "@deno/graph";
 import type { CacheSetting, FileFetcher } from "./file_fetcher.ts";

diff --git a/cache_test.ts b/cache_test.ts
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 import { FetchCacher } from "./cache.ts";
 import { DenoDir } from "./deno_dir.ts";

diff --git a/deno_dir.ts b/deno_dir.ts
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 import { isAbsolute, join, resolve } from "@std/path";
 import { DiskCache } from "./disk_cache.ts";

diff --git a/deno_dir_test.ts b/deno_dir_test.ts
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 import { assertEquals, assertThrows } from "@std/assert";
 import { DenoDir } from "./deno_dir.ts";

diff --git a/deps_test.ts b/deps_test.ts
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 export { assertEquals, assertRejects } from "@std/assert";
 export { createGraph } from "@deno/graph";

diff --git a/disk_cache.ts b/disk_cache.ts
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 import { ensureDir } from "@std/fs/ensure-dir";
 import { dirname, isAbsolute, join } from "@std/path";

diff --git a/disk_cache_test.ts b/disk_cache_test.ts
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 import { assertEquals, assertRejects } from "@std/assert";
 import { DiskCache } from "./disk_cache.ts";

diff --git a/file_fetcher.ts b/file_fetcher.ts
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 import { AuthTokens } from "./auth_tokens.ts";
 import { fromFileUrl } from "@std/path";

diff --git a/file_fetcher_test.ts b/file_fetcher_test.ts
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 import { DenoDir } from "./deno_dir.ts";
 import { assertRejects, createGraph } from "./deps_test.ts";

diff --git a/http_cache.ts b/http_cache.ts
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 import { isAbsolute } from "@std/path";
 import { assert } from "./util.ts";

diff --git a/mod.ts b/mod.ts
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 /**
  * A module which provides a TypeScript implementation of the Deno CLI's cache

diff --git a/rs_lib/Cargo.toml b/rs_lib/Cargo.toml
@@ -13,6 +13,7 @@ crate-type = ["cdylib", "lib"]
 default = ["file_fetcher"]
 file_fetcher = ["async-trait", "base64", "cache_control", "chrono", "data-url", "http"]
 wasm = ["console_error_panic_hook", "js-sys", "serde-wasm-bindgen", "wasm-bindgen", "sys_traits/wasm"]
+sync = []
 
 [dependencies]
 async-trait = { version = "0.1.73", optional = true }

diff --git a/rs_lib/clippy.toml b/rs_lib/clippy.toml
@@ -44,3 +44,6 @@ disallowed-methods = [
   { path = "std::path::Path::exists", reason = "File system operations should be done using DenoCacheEnv trait" },
   { path = "std::time::SystemTime::now", reason = "Getting the time should be done using DenoCacheEnv trait" },
 ]
+disallowed-types = [
+  { path = "std::sync::Arc", reason = "use crate::sync::MaybeArc instead" },
+]
diff --git a/rs_lib/src/cache.rs b/rs_lib/src/cache.rs
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 use deno_error::JsError;
 use serde::Deserialize;
@@ -13,6 +13,8 @@ use url::Url;
 use crate::common::base_url_to_filename_parts;
 use crate::common::checksum;
 use crate::common::HeadersMap;
+use crate::sync::MaybeSend;
+use crate::sync::MaybeSync;
 
 #[derive(Debug, Copy, Clone, Eq, PartialEq)]
 pub enum GlobalToLocalCopy {
@@ -153,7 +155,10 @@ pub struct HttpCacheItemKey<'a> {
   pub(super) file_path: Option<PathBuf>,
 }
 
-pub trait HttpCache: Send + Sync + std::fmt::Debug {
+#[allow(clippy::disallowed_types)]
+pub type HttpCacheRc = crate::sync::MaybeArc<dyn HttpCache>;
+
+pub trait HttpCache: MaybeSend + MaybeSync + std::fmt::Debug {
   /// A pre-computed key for looking up items in the cache.
   fn cache_item_key<'a>(
     &self,

diff --git a/rs_lib/src/common.rs b/rs_lib/src/common.rs
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 use std::borrow::Cow;
 use std::collections::HashMap;

diff --git a/rs_lib/src/deno_dir.rs b/rs_lib/src/deno_dir.rs
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 use std::path::PathBuf;
 

diff --git a/rs_lib/src/file_fetcher/auth_tokens.rs b/rs_lib/src/file_fetcher/auth_tokens.rs
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 use std::borrow::Cow;
 use std::fmt;

diff --git a/rs_lib/src/file_fetcher/http_util.rs b/rs_lib/src/file_fetcher/http_util.rs
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 use std::time::Duration;
 use std::time::SystemTime;

diff --git a/rs_lib/src/file_fetcher/mod.rs b/rs_lib/src/file_fetcher/mod.rs
@@ -1,9 +1,8 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 use std::borrow::Cow;
 use std::collections::HashMap;
 use std::path::PathBuf;
-use std::sync::Arc;
 
 use boxed_error::Boxed;
 use data_url::DataUrl;
@@ -23,12 +22,14 @@ use thiserror::Error;
 use url::Url;
 
 use self::http_util::CacheSemantics;
+use crate::cache::HttpCacheRc;
 use crate::common::HeadersMap;
+use crate::sync::MaybeSend;
+use crate::sync::MaybeSync;
 use crate::CacheEntry;
 use crate::CacheReadFileError;
 use crate::Checksum;
 use crate::ChecksumIntegrityError;
-use crate::HttpCache;
 
 mod auth_tokens;
 mod http_util;
@@ -86,12 +87,16 @@ impl FileOrRedirect {
       Ok(FileOrRedirect::File(File {
         url: url.clone(),
         maybe_headers: Some(cache_entry.metadata.headers),
-        source: Arc::from(cache_entry.content),
+        #[allow(clippy::disallowed_types)] // ok for source
+        source: std::sync::Arc::from(cache_entry.content),
       }))
     }
   }
 }
 
+#[allow(clippy::disallowed_types)] // ok for source
+type FileSource = std::sync::Arc<[u8]>;
+
 /// A structure representing a source file.
 #[derive(Debug, Clone, Eq, PartialEq)]
 pub struct File {
@@ -100,7 +105,7 @@ pub struct File {
   pub url: Url,
   pub maybe_headers: Option<HashMap<String, String>>,
   /// The source of the file.
-  pub source: Arc<[u8]>,
+  pub source: FileSource,
 }
 
 impl File {
@@ -116,7 +121,10 @@ impl File {
   }
 }
 
-pub trait MemoryFiles: std::fmt::Debug + Send + Sync {
+#[allow(clippy::disallowed_types)]
+pub type MemoryFilesRc = crate::sync::MaybeArc<dyn MemoryFiles>;
+
+pub trait MemoryFiles: std::fmt::Debug + MaybeSend + MaybeSync {
   fn get(&self, url: &Url) -> Option<File>;
 }
 
@@ -383,7 +391,7 @@ impl From<FetchCachedNoFollowError> for FetchNoFollowError {
 }
 
 #[async_trait::async_trait(?Send)]
-pub trait HttpClient: std::fmt::Debug + Send + Sync {
+pub trait HttpClient: std::fmt::Debug + MaybeSend + MaybeSync {
   /// Send a request getting the response.
   ///
   /// The implementation MUST not follow redirects. Return `SendResponse::Redirect`
@@ -414,7 +422,7 @@ impl BlobStore for NullBlobStore {
 }
 
 #[async_trait::async_trait(?Send)]
-pub trait BlobStore: std::fmt::Debug + Send + Sync {
+pub trait BlobStore: std::fmt::Debug + MaybeSend + MaybeSync {
   async fn get(&self, url: &Url) -> std::io::Result<Option<BlobData>>;
 }
 
@@ -442,9 +450,9 @@ pub struct FileFetcher<
 > {
   blob_store: TBlobStore,
   sys: TSys,
-  http_cache: Arc<dyn HttpCache>,
+  http_cache: HttpCacheRc,
   http_client: THttpClient,
-  memory_files: Arc<dyn MemoryFiles>,
+  memory_files: MemoryFilesRc,
   allow_remote: bool,
   cache_setting: CacheSetting,
   auth_tokens: AuthTokens,
@@ -459,9 +467,9 @@ impl<
   pub fn new(
     blob_store: TBlobStore,
     sys: TSys,
-    http_cache: Arc<dyn HttpCache>,
+    http_cache: HttpCacheRc,
     http_client: THttpClient,
-    memory_files: Arc<dyn MemoryFiles>,
+    memory_files: MemoryFilesRc,
     options: FileFetcherOptions,
   ) -> Self {
     Self {
@@ -625,7 +633,8 @@ impl<
     Ok(File {
       url: url.clone(),
       maybe_headers: Some(headers),
-      source: Arc::from(bytes),
+      #[allow(clippy::disallowed_types)] // ok for source
+      source: std::sync::Arc::from(bytes),
     })
   }
 
@@ -651,7 +660,8 @@ impl<
     Ok(File {
       url: url.clone(),
       maybe_headers: Some(headers),
-      source: Arc::from(blob.bytes),
+  #[allow(clippy::disallowed_types)] // ok for source
+      source: std::sync::Arc::from(blob.bytes),
     })
   }
 
@@ -735,7 +745,8 @@ impl<
         Ok(FileOrRedirect::File(File {
           url: url.clone(),
           maybe_headers: Some(headers),
-          source: Arc::from(bytes),
+  #[allow(clippy::disallowed_types)] // ok for source
+          source: std::sync::Arc::from(bytes),
         }))
       }
     }

diff --git a/rs_lib/src/global/cache_file.rs b/rs_lib/src/global/cache_file.rs
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 use std::borrow::Cow;
 use std::io::ErrorKind;

diff --git a/rs_lib/src/global/mod.rs b/rs_lib/src/global/mod.rs
@@ -1,4 +1,4 @@
-// Copyright 2018-2024 the Deno authors. MIT license.
+// Copyright 2018-2025 the Deno authors. MIT license.
 
 use std::path::PathBuf;
 use std::time::Duration;
@@ -26,9 +26,14 @@ use crate::cache::CacheReadFileError;
 use crate::cache::Checksum;
 use crate::cache::SerializedCachedUrlMetadata;
 use crate::common::HeadersMap;
+use crate::sync::MaybeSend;
+use crate::sync::MaybeSync;
 
 mod cache_file;
 
+#[allow(clippy::disallowed_types)]
+pub type GlobalHttpCacheRc<TSys> = crate::sync::MaybeArc<GlobalHttpCache<TSys>>;
+
 #[derive(Debug)]
 pub struct GlobalHttpCache<
   Sys: FsCreateDirAll
@@ -61,18 +66,11 @@ impl<
     Self { path, sys }
   }
 
-  pub fn get_global_cache_location(&self) -> &PathBuf {
+  pub fn dir_path(&self) -> &PathBuf {
     &self.path
   }
 
-  pub fn get_global_cache_filepath(
-    &self,
-    url: &Url,
-  ) -> std::io::Result<PathBuf> {
-    Ok(self.path.join(url_to_filename(url)?))
-  }
-
-  fn get_cache_filepath(&self, url: &Url) -> std::io::Result<PathBuf> {
+  pub fn local_path_for_url(&self, url: &Url) -> std::io::Result<PathBuf> {
     Ok(self.path.join(url_to_filename(url)?))
   }
 
@@ -96,8 +94,8 @@ impl<
       + SystemRandom
       + SystemTimeNow
       + std::fmt::Debug
-      + Send
-      + Sync
+      + MaybeSend
+      + MaybeSync
       + Clone,
   > HttpCache for GlobalHttpCache<TSys>
 {
@@ -109,12 +107,12 @@ impl<
       #[cfg(debug_assertions)]
       is_local_key: false,
       url,
-      file_path: Some(self.get_cache_filepath(url)?),
+      file_path: Some(self.local_path_for_url(url)?),
     })
   }
 
   fn contains(&self, url: &Url) -> bool {
-    let Ok(cache_filepath) = self.get_cache_filepath(url) else {
+    let Ok(cache_filepath) = self.local_path_for_url(url) else {
       return false;
     };
     self.sys.fs_is_file(&cache_filepath).unwrap_or(false)
@@ -143,7 +141,7 @@ impl<
     headers: HeadersMap,
     content: &[u8],
   ) -> std::io::Result<()> {
-    let cache_filepath = self.get_cache_filepath(url)?;
+    let cache_filepath = self.local_path_for_url(url)?;
     cache_file::write(
       &self.sys,
       &cache_filepath,