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

fix: warn about import assertions when using typescript #25135

Merged
Merged
Show file tree
Hide file tree
Changes from 4 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
144 changes: 113 additions & 31 deletions cli/emit.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ use crate::cache::FastInsecureHasher;
use crate::cache::ParsedSourceCache;

use deno_ast::SourceMapOption;
use deno_ast::SourceRange;
use deno_ast::SourceRanged;
use deno_ast::SourceRangedForSpanned;
use deno_ast::TranspileResult;
use deno_core::error::AnyError;
use deno_core::futures::stream::FuturesUnordered;
Expand Down Expand Up @@ -109,26 +112,28 @@ impl Emitter {
let parsed_source_cache = self.parsed_source_cache.clone();
let transpile_and_emit_options =
self.transpile_and_emit_options.clone();
let transpile_result = deno_core::unsync::spawn_blocking({
let specifier = specifier.clone();
let source = source.clone();
move || -> Result<_, AnyError> {
EmitParsedSourceHelper::transpile(
&parsed_source_cache,
&specifier,
source.clone(),
media_type,
&transpile_and_emit_options.0,
&transpile_and_emit_options.1,
)
}
})
.await
.unwrap()?;
let (should_cache, transpile_result) =
deno_core::unsync::spawn_blocking({
let specifier = specifier.clone();
let source = source.clone();
move || -> Result<_, AnyError> {
EmitParsedSourceHelper::transpile(
&parsed_source_cache,
&specifier,
source.clone(),
media_type,
&transpile_and_emit_options.0,
&transpile_and_emit_options.1,
)
}
})
.await
.unwrap()?;
Ok(helper.post_emit_parsed_source(
specifier,
transpile_result,
source_hash,
should_cache,
))
}
}
Expand All @@ -145,18 +150,20 @@ impl Emitter {
match helper.pre_emit_parsed_source(specifier, source) {
PreEmitResult::Cached(emitted_text) => Ok(emitted_text),
PreEmitResult::NotCached { source_hash } => {
let transpile_result = EmitParsedSourceHelper::transpile(
&self.parsed_source_cache,
specifier,
source.clone(),
media_type,
&self.transpile_and_emit_options.0,
&self.transpile_and_emit_options.1,
)?;
let (should_cache, transpile_result) =
EmitParsedSourceHelper::transpile(
&self.parsed_source_cache,
specifier,
source.clone(),
media_type,
&self.transpile_and_emit_options.0,
&self.transpile_and_emit_options.1,
)?;
Ok(helper.post_emit_parsed_source(
specifier,
transpile_result,
source_hash,
should_cache,
))
}
}
Expand Down Expand Up @@ -254,19 +261,25 @@ impl<'a> EmitParsedSourceHelper<'a> {
media_type: MediaType,
transpile_options: &deno_ast::TranspileOptions,
emit_options: &deno_ast::EmitOptions,
) -> Result<TranspileResult, AnyError> {
) -> Result<(bool, TranspileResult), AnyError> {
// nothing else needs the parsed source at this point, so remove from
// the cache in order to not transpile owned
let parsed_source = parsed_source_cache
.remove_or_parse_module(specifier, source, media_type)?;
Ok(parsed_source.transpile(transpile_options, emit_options)?)
let should_cache = !has_import_assertion(&parsed_source);
Ok((
should_cache,
parsed_source.transpile(transpile_options, emit_options)?,
))
}

pub fn post_emit_parsed_source(
&self,
specifier: &ModuleSpecifier,
transpile_result: TranspileResult,
source_hash: u64,
// todo(dsherret): remove after Deno 2.0
should_cache: bool,
) -> ModuleCodeBytes {
let transpiled_source = match transpile_result {
TranspileResult::Owned(source) => source,
Expand All @@ -276,11 +289,80 @@ impl<'a> EmitParsedSourceHelper<'a> {
}
};
debug_assert!(transpiled_source.source_map.is_none());
self.0.emit_cache.set_emit_code(
specifier,
source_hash,
&transpiled_source.source,
);
if should_cache {
self.0.emit_cache.set_emit_code(
specifier,
source_hash,
&transpiled_source.source,
);
}
transpiled_source.source.into_boxed_slice().into()
}
}

fn has_import_assertion(parsed_source: &deno_ast::ParsedSource) -> bool {
fn has_import_assertion(text: &str) -> bool {
// good enough
text.contains(" assert ") && !text.contains(" with ")
}

fn warn_import_attribute(
parsed_source: &deno_ast::ParsedSource,
range: SourceRange,
) {
let text_info = parsed_source.text_info_lazy();
let loc = text_info.line_and_column_display(range.start);
deno_runtime::import_assertion_callback(
deno_core::ImportAssertionsSupportCustomCallbackArgs {
maybe_specifier: Some(parsed_source.specifier().to_string()),
maybe_line_number: Some(loc.line_number),
column_number: loc.column_number,
maybe_source_line: Some(range.text_fast(text_info).to_string()),
},
)
}

let Some(module) = parsed_source.program_ref().as_module() else {
return false;
};

let mut had_import_assertion = false;
for item in &module.body {
match item {
deno_ast::swc::ast::ModuleItem::ModuleDecl(decl) => match decl {
deno_ast::swc::ast::ModuleDecl::Import(n) => {
if n.with.is_some()
Comment on lines +330 to +334
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also handle import("./data.json", { assert: { type: "json" }})?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, that's annoying. I'll update it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need to do it for that because v8 will warn about it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay 👍

&& has_import_assertion(n.text_fast(parsed_source.text_info_lazy()))
{
had_import_assertion = true;
warn_import_attribute(parsed_source, n.range());
}
}
deno_ast::swc::ast::ModuleDecl::ExportAll(n) => {
if n.with.is_some()
&& has_import_assertion(n.text_fast(parsed_source.text_info_lazy()))
{
had_import_assertion = true;
warn_import_attribute(parsed_source, n.range());
}
}
deno_ast::swc::ast::ModuleDecl::ExportNamed(n) => {
if n.with.is_some()
&& has_import_assertion(n.text_fast(parsed_source.text_info_lazy()))
{
had_import_assertion = true;
warn_import_attribute(parsed_source, n.range());
}
}
deno_ast::swc::ast::ModuleDecl::ExportDecl(_)
| deno_ast::swc::ast::ModuleDecl::ExportDefaultDecl(_)
| deno_ast::swc::ast::ModuleDecl::ExportDefaultExpr(_)
| deno_ast::swc::ast::ModuleDecl::TsImportEquals(_)
| deno_ast::swc::ast::ModuleDecl::TsExportAssignment(_)
| deno_ast::swc::ast::ModuleDecl::TsNamespaceExport(_) => {}
},
deno_ast::swc::ast::ModuleItem::Stmt(_) => {}
}
}
had_import_assertion
}
1 change: 1 addition & 0 deletions runtime/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ pub use worker_bootstrap::WorkerExecutionMode;
pub use worker_bootstrap::WorkerLogLevel;

mod shared;
pub use shared::import_assertion_callback;
pub use shared::runtime;

// NOTE(bartlomieju): keep IDs in sync with `runtime/90_deno_ns.js` (search for `unstableFeatures`)
Expand Down
18 changes: 18 additions & 0 deletions tests/specs/run/ts_import_assertions/__test__.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"tests": {
"assertion": {
"steps": [{
"args": "run assertion.ts",
"output": "assertion.out"
}, {
// should output the same because the emit won't be cached
"args": "run assertion.ts",
"output": "assertion.out"
}]
},
"with": {
"args": "run with.ts",
"output": "with.out"
}
}
}
7 changes: 7 additions & 0 deletions tests/specs/run/ts_import_assertions/assertion.out
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
⚠️ Import assertions are deprecated. Use `with` keyword, instead of 'assert' keyword.

import test from "./data.json" assert { type: "json" };

at file:///[WILDLINE]/assertion.ts:1:1

{ prop: "data" }
2 changes: 2 additions & 0 deletions tests/specs/run/ts_import_assertions/assertion.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
import test from "./data.json" assert { type: "json" };
console.log(test);
3 changes: 3 additions & 0 deletions tests/specs/run/ts_import_assertions/data.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"prop": "data"
}
1 change: 1 addition & 0 deletions tests/specs/run/ts_import_assertions/with.out
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{ prop: "data" }
2 changes: 2 additions & 0 deletions tests/specs/run/ts_import_assertions/with.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
import test from "./data.json" with { type: "json" };
console.log(test);
3 changes: 1 addition & 2 deletions tests/testdata/import_attributes/json_with_shebang.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
// deno-lint-ignore no-import-assertions
import json from "./json_with_shebang.json" assert { type: "json" };
import json from "./json_with_shebang.json" with { type: "json" };

console.log(json);
6 changes: 6 additions & 0 deletions tests/testdata/import_attributes/static_export.out
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
⚠️ Import assertions are deprecated. Use `with` keyword, instead of 'assert' keyword.

export { default } from "./data.json" assert { type: "json" };

at file:///[WILDLINE]

{ a: "b", c: { d: 10 } }
6 changes: 6 additions & 0 deletions tests/testdata/import_attributes/static_import.out
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
⚠️ Import assertions are deprecated. Use `with` keyword, instead of 'assert' keyword.

import data2 from "./data.json" assert { type: "json" };

at file:///[WILDLINE]

{ a: "b", c: { d: 10 } }
{ a: "b", c: { d: 10 } }
2 changes: 1 addition & 1 deletion tests/testdata/run/config_json_import.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
import config from "../jsx/deno-jsx.json" assert { type: "json" };
import config from "../jsx/deno-jsx.json" with { type: "json" };
console.log(config);
Loading