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.

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

feat: blob URL support #10045

Merged
merged 3 commits into from
Apr 7, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/disk_cache.rs
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ impl DiskCache {
out.push(path_seg);
}
}
"http" | "https" | "data" => out = url_to_filename(url)?,
"http" | "https" | "data" | "blob" => out = url_to_filename(url)?,
"file" => {
let path = match url.to_file_path() {
Ok(path) => path,
Expand Down
132 changes: 127 additions & 5 deletions cli/file_fetcher.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ use deno_core::futures;
use deno_core::futures::future::FutureExt;
use deno_core::ModuleSpecifier;
use deno_runtime::deno_fetch::reqwest;
use deno_runtime::deno_file::BlobUrlStore;
use deno_runtime::permissions::Permissions;
use log::debug;
use log::info;
use std::borrow::Borrow;
use std::collections::HashMap;
use std::env;
use std::fs;
Expand All @@ -32,7 +34,8 @@ use std::sync::Arc;
use std::sync::Mutex;

static DENO_AUTH_TOKENS: &str = "DENO_AUTH_TOKENS";
pub const SUPPORTED_SCHEMES: [&str; 4] = ["data", "file", "http", "https"];
pub const SUPPORTED_SCHEMES: [&str; 5] =
["data", "blob", "file", "http", "https"];

/// A structure representing a source file.
#[derive(Debug, Clone, Eq, PartialEq)]
Expand Down Expand Up @@ -317,6 +320,7 @@ pub struct FileFetcher {
cache_setting: CacheSetting,
http_cache: HttpCache,
http_client: reqwest::Client,
blob_url_store: BlobUrlStore,
}

impl FileFetcher {
Expand All @@ -325,6 +329,7 @@ impl FileFetcher {
cache_setting: CacheSetting,
allow_remote: bool,
ca_data: Option<Vec<u8>>,
blob_url_store: BlobUrlStore,
) -> Result<Self, AnyError> {
Ok(Self {
auth_tokens: AuthTokens::new(env::var(DENO_AUTH_TOKENS).ok()),
Expand All @@ -333,6 +338,7 @@ impl FileFetcher {
cache_setting,
http_cache,
http_client: create_http_client(get_user_agent(), ca_data)?,
blob_url_store,
})
}

Expand Down Expand Up @@ -446,6 +452,62 @@ impl FileFetcher {
})
}

/// Get a blob URL.
fn fetch_blob_url(
&self,
specifier: &ModuleSpecifier,
) -> Result<File, AnyError> {
debug!("FileFetcher::fetch_blob_url() - specifier: {}", specifier);
match self.fetch_cached(specifier, 0) {
Ok(Some(file)) => return Ok(file),
Ok(None) => {}
Err(err) => return Err(err),
}

if self.cache_setting == CacheSetting::Only {
return Err(custom_error(
"NotFound",
format!(
"Specifier not found in cache: \"{}\", --cached-only is specified.",
specifier
),
));
}

let blob_url_storage = self.blob_url_store.borrow();
let blob = blob_url_storage.get(specifier)?.ok_or_else(|| {
custom_error(
"NotFound",
format!("Blob URL not found: \"{}\".", specifier),
)
})?;

let content_type = blob.media_type;

let (media_type, maybe_charset) =
map_content_type(specifier, Some(content_type.clone()));
let source =
strip_shebang(get_source_from_bytes(blob.data, maybe_charset)?);

let local =
self
.http_cache
.get_cache_filename(specifier)
.ok_or_else(|| {
generic_error("Cannot convert specifier to cached filename.")
})?;
let mut headers = HashMap::new();
headers.insert("content-type".to_string(), content_type);
self.http_cache.set(specifier, headers, source.as_bytes())?;

Ok(File {
local,
maybe_types: None,
media_type,
source,
specifier: specifier.clone(),
})
}
/// Asynchronously fetch remote source file specified by the URL following
/// redirects.
///
Expand Down Expand Up @@ -555,6 +617,12 @@ impl FileFetcher {
self.cache.insert(specifier.clone(), file.clone());
}
result
} else if scheme == "blob" {
let result = self.fetch_blob_url(specifier);
if let Ok(file) = &result {
self.cache.insert(specifier.clone(), file.clone());
}
result
} else if !self.allow_remote {
Err(custom_error(
"NoRemote",
Expand Down Expand Up @@ -604,21 +672,37 @@ mod tests {
use deno_core::error::get_custom_error_class;
use deno_core::resolve_url;
use deno_core::resolve_url_or_path;
use deno_runtime::deno_file::Blob;
use std::rc::Rc;
use tempfile::TempDir;

fn setup(
cache_setting: CacheSetting,
maybe_temp_dir: Option<Rc<TempDir>>,
) -> (FileFetcher, Rc<TempDir>) {
let (file_fetcher, temp_dir, _) =
setup_with_blob_url_store(cache_setting, maybe_temp_dir);
(file_fetcher, temp_dir)
}

fn setup_with_blob_url_store(
cache_setting: CacheSetting,
maybe_temp_dir: Option<Rc<TempDir>>,
) -> (FileFetcher, Rc<TempDir>, BlobUrlStore) {
let temp_dir = maybe_temp_dir.unwrap_or_else(|| {
Rc::new(TempDir::new().expect("failed to create temp directory"))
});
let location = temp_dir.path().join("deps");
let file_fetcher =
FileFetcher::new(HttpCache::new(&location), cache_setting, true, None)
.expect("setup failed");
(file_fetcher, temp_dir)
let blob_url_store = BlobUrlStore::default();
let file_fetcher = FileFetcher::new(
HttpCache::new(&location),
cache_setting,
true,
None,
blob_url_store.clone(),
)
.expect("setup failed");
(file_fetcher, temp_dir, blob_url_store)
}

macro_rules! file_url {
Expand Down Expand Up @@ -988,6 +1072,36 @@ mod tests {
assert_eq!(file.specifier, specifier);
}

#[tokio::test]
async fn test_fetch_blob_url() {
let (file_fetcher, _, blob_url_store) =
setup_with_blob_url_store(CacheSetting::Use, None);

let specifier = blob_url_store.insert(
Blob {
data:
"export const a = \"a\";\n\nexport enum A {\n A,\n B,\n C,\n}\n"
.as_bytes()
.to_vec(),
media_type: "application/typescript".to_string(),
},
None,
);

let result = file_fetcher
.fetch(&specifier, &Permissions::allow_all())
.await;
assert!(result.is_ok());
let file = result.unwrap();
assert_eq!(
file.source,
"export const a = \"a\";\n\nexport enum A {\n A,\n B,\n C,\n}\n"
);
assert_eq!(file.media_type, MediaType::TypeScript);
assert_eq!(file.maybe_types, None);
assert_eq!(file.specifier, specifier);
}

#[tokio::test]
async fn test_fetch_complex() {
let _http_server_guard = test_util::http_server();
Expand Down Expand Up @@ -1061,6 +1175,7 @@ mod tests {
CacheSetting::ReloadAll,
true,
None,
BlobUrlStore::default(),
)
.expect("setup failed");
let result = file_fetcher
Expand All @@ -1087,6 +1202,7 @@ mod tests {
CacheSetting::Use,
true,
None,
BlobUrlStore::default(),
)
.expect("could not create file fetcher");
let specifier =
Expand Down Expand Up @@ -1114,6 +1230,7 @@ mod tests {
CacheSetting::Use,
true,
None,
BlobUrlStore::default(),
)
.expect("could not create file fetcher");
let result = file_fetcher_02
Expand Down Expand Up @@ -1274,6 +1391,7 @@ mod tests {
CacheSetting::Use,
true,
None,
BlobUrlStore::default(),
)
.expect("could not create file fetcher");
let specifier =
Expand Down Expand Up @@ -1304,6 +1422,7 @@ mod tests {
CacheSetting::Use,
true,
None,
BlobUrlStore::default(),
)
.expect("could not create file fetcher");
let result = file_fetcher_02
Expand Down Expand Up @@ -1413,6 +1532,7 @@ mod tests {
CacheSetting::Use,
false,
None,
BlobUrlStore::default(),
)
.expect("could not create file fetcher");
let specifier =
Expand All @@ -1439,13 +1559,15 @@ mod tests {
CacheSetting::Only,
true,
None,
BlobUrlStore::default(),
)
.expect("could not create file fetcher");
let file_fetcher_02 = FileFetcher::new(
HttpCache::new(&location),
CacheSetting::Use,
true,
None,
BlobUrlStore::default(),
)
.expect("could not create file fetcher");
let specifier =
Expand Down
2 changes: 1 addition & 1 deletion cli/http_cache.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ fn base_url_to_filename(url: &Url) -> Option<PathBuf> {
};
out.push(host_port);
}
"data" => (),
"data" | "blob" => (),
scheme => {
error!("Don't know how to create cache name for scheme: {}", scheme);
return None;
Expand Down
2 changes: 2 additions & 0 deletions cli/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ fn create_web_worker_callback(
ts_version: version::TYPESCRIPT.to_string(),
no_color: !colors::use_color(),
get_error_class_fn: Some(&crate::errors::get_error_class_name),
blob_url_store: program_state.blob_url_store.clone(),
};

let mut worker = WebWorker::from_options(
Expand Down Expand Up @@ -199,6 +200,7 @@ pub fn create_main_worker(
no_color: !colors::use_color(),
get_error_class_fn: Some(&crate::errors::get_error_class_name),
location: program_state.flags.location.clone(),
blob_url_store: program_state.blob_url_store.clone(),
};

let mut worker = MainWorker::from_options(main_module, permissions, &options);
Expand Down
8 changes: 7 additions & 1 deletion cli/program_state.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ use crate::module_graph::TypeLib;
use crate::source_maps::SourceMapGetter;
use crate::specifier_handler::FetchHandler;
use crate::version;
use deno_runtime::deno_file::BlobUrlStore;
use deno_runtime::inspector::InspectorServer;
use deno_runtime::permissions::Permissions;

Expand Down Expand Up @@ -56,6 +57,7 @@ pub struct ProgramState {
pub maybe_import_map: Option<ImportMap>,
pub maybe_inspector_server: Option<Arc<InspectorServer>>,
pub ca_data: Option<Vec<u8>>,
pub blob_url_store: BlobUrlStore,
}

impl ProgramState {
Expand All @@ -80,11 +82,14 @@ impl ProgramState {
CacheSetting::Use
};

let blob_url_store = BlobUrlStore::default();

let file_fetcher = FileFetcher::new(
http_cache,
cache_usage,
!flags.no_remote,
ca_data.clone(),
blob_url_store.clone(),
)?;

let lockfile = if let Some(filename) = &flags.lock {
Expand Down Expand Up @@ -131,6 +136,7 @@ impl ProgramState {
maybe_import_map,
maybe_inspector_server,
ca_data,
blob_url_store,
};
Ok(Arc::new(program_state))
}
Expand Down Expand Up @@ -257,7 +263,7 @@ impl ProgramState {
match url.scheme() {
// we should only be looking for emits for schemes that denote external
// modules, which the disk_cache supports
"wasm" | "file" | "http" | "https" | "data" => (),
"wasm" | "file" | "http" | "https" | "data" | "blob" => (),
_ => {
return None;
}
Expand Down
1 change: 1 addition & 0 deletions cli/source_maps.rs
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ pub fn get_orig_position<G: SourceMapGetter>(
// around it. Use the `file_name` we get from V8 if
// `source_file_name` does not parse as a URL.
let file_name = match deno_core::resolve_url(source_file_name) {
Ok(m) if m.scheme() == "blob" => file_name,
Ok(m) => m.to_string(),
Err(_) => file_name,
};
Expand Down
6 changes: 5 additions & 1 deletion cli/specifier_handler.rs
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,9 @@ impl SpecifierHandler for FetchHandler {
}
})?;
let url = &source_file.specifier;
let is_remote = !(url.scheme() == "file" || url.scheme() == "data");
let is_remote = !(url.scheme() == "file"
|| url.scheme() == "data"
|| url.scheme() == "blob");
let filename = disk_cache.get_cache_filename_with_extension(url, "meta");
let maybe_version = if let Some(filename) = filename {
if let Ok(bytes) = disk_cache.get(&filename) {
Expand Down Expand Up @@ -569,6 +571,7 @@ pub mod tests {
use crate::file_fetcher::CacheSetting;
use crate::http_cache::HttpCache;
use deno_core::resolve_url_or_path;
use deno_runtime::deno_file::BlobUrlStore;
use tempfile::TempDir;

macro_rules! map (
Expand All @@ -593,6 +596,7 @@ pub mod tests {
CacheSetting::Use,
true,
None,
BlobUrlStore::default(),
)
.expect("could not setup");
let disk_cache = deno_dir.gen_cache;
Expand Down
Loading