summaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorBartek Iwańczuk <biwanczuk@gmail.com>2024-01-19 00:30:49 +0100
committerGitHub <noreply@github.com>2024-01-18 23:30:49 +0000
commitc62615bfe5a070c2517f3af3208d4308c72eb054 (patch)
treee95abadb1b93e79bdc9aa3449ee88dd3c1c29ce4 /runtime
parent99f9fa5556e60c8149403bbe88411f45b080ca11 (diff)
feat: Start warning on each use of a deprecated API (#21939)
This commit introduces deprecation warnings for "Deno.*" APIs. This is gonna be quite noisy, but should tremendously help with user code updates to ensure smooth migration to Deno 2.0. The warning is printed at each unique call site to help quickly identify where code needs to be adjusted. There's some stack frame filtering going on to remove frames that are not useful to the user and would only cause confusion. The warning can be silenced using "--quiet" flag or "DENO_NO_DEPRECATION_WARNINGS" env var. "Deno.run()" API is now using this warning. Other deprecated APIs will start warning in follow up PRs. Example: ```js import { runEcho as runEcho2 } from "http://localhost:4545/run/warn_on_deprecated_api/mod.ts"; const p = Deno.run({ cmd: [ Deno.execPath(), "eval", "console.log('hello world')", ], }); await p.status(); p.close(); async function runEcho() { const p = Deno.run({ cmd: [ Deno.execPath(), "eval", "console.log('hello world')", ], }); await p.status(); p.close(); } await runEcho(); await runEcho(); for (let i = 0; i < 10; i++) { await runEcho(); } await runEcho2(); ``` ``` $ deno run --allow-read foo.js Warning ├ Use of deprecated "Deno.run()" API. │ ├ This API will be removed in Deno 2.0. Make sure to upgrade to a stable API before then. │ ├ Suggestion: Use "Deno.Command()" API instead. │ └ Stack trace: └─ at file:///Users/ib/dev/deno/foo.js:3:16 hello world Warning ├ Use of deprecated "Deno.run()" API. │ ├ This API will be removed in Deno 2.0. Make sure to upgrade to a stable API before then. │ ├ Suggestion: Use "Deno.Command()" API instead. │ └ Stack trace: ├─ at runEcho (file:///Users/ib/dev/deno/foo.js:8:18) └─ at file:///Users/ib/dev/deno/foo.js:13:7 hello world Warning ├ Use of deprecated "Deno.run()" API. │ ├ This API will be removed in Deno 2.0. Make sure to upgrade to a stable API before then. │ ├ Suggestion: Use "Deno.Command()" API instead. │ └ Stack trace: ├─ at runEcho (file:///Users/ib/dev/deno/foo.js:8:18) └─ at file:///Users/ib/dev/deno/foo.js:14:7 hello world Warning ├ Use of deprecated "Deno.run()" API. │ ├ This API will be removed in Deno 2.0. Make sure to upgrade to a stable API before then. │ ├ Suggestion: Use "Deno.Command()" API instead. │ └ Stack trace: ├─ at runEcho (file:///Users/ib/dev/deno/foo.js:8:18) └─ at file:///Users/ib/dev/deno/foo.js:17:9 hello world hello world hello world hello world hello world hello world hello world hello world hello world hello world Warning ├ Use of deprecated "Deno.run()" API. │ ├ This API will be removed in Deno 2.0. Make sure to upgrade to a stable API before then. │ ├ Suggestion: Use "Deno.Command()" API instead. │ ├ Suggestion: It appears this API is used by a remote dependency. │ Try upgrading to the latest version of that dependency. │ └ Stack trace: ├─ at runEcho (http://localhost:4545/run/warn_on_deprecated_api/mod.ts:2:18) └─ at file:///Users/ib/dev/deno/foo.js:20:7 hello world ``` Closes #21839
Diffstat (limited to 'runtime')
-rw-r--r--runtime/js/40_process.js5
-rw-r--r--runtime/js/99_main.js99
-rw-r--r--runtime/worker_bootstrap.rs5
3 files changed, 108 insertions, 1 deletions
diff --git a/runtime/js/40_process.js b/runtime/js/40_process.js
index c90f38664..e6a62dcf7 100644
--- a/runtime/js/40_process.js
+++ b/runtime/js/40_process.js
@@ -140,6 +140,11 @@ function run({
...new SafeArrayIterator(ArrayPrototypeSlice(cmd, 1)),
];
}
+ internals.warnOnDeprecatedApi(
+ "Deno.run()",
+ (new Error()).stack,
+ `Use "Deno.Command()" API instead.`,
+ );
const res = opRun({
cmd: ArrayPrototypeMap(cmd, String),
cwd,
diff --git a/runtime/js/99_main.js b/runtime/js/99_main.js
index 6c5ca3b59..54a4406b2 100644
--- a/runtime/js/99_main.js
+++ b/runtime/js/99_main.js
@@ -9,6 +9,8 @@ const {
ArrayPrototypeFilter,
ArrayPrototypeIncludes,
ArrayPrototypeMap,
+ ArrayPrototypePop,
+ ArrayPrototypeShift,
DateNow,
Error,
ErrorPrototype,
@@ -23,6 +25,10 @@ const {
ObjectValues,
PromisePrototypeThen,
PromiseResolve,
+ SafeSet,
+ StringPrototypeIncludes,
+ StringPrototypeSplit,
+ StringPrototypeTrim,
Symbol,
SymbolIterator,
TypeError,
@@ -89,6 +95,93 @@ ObjectDefineProperties(Symbol, {
let windowIsClosing = false;
let globalThis_;
+let deprecatedApiWarningDisabled = false;
+const ALREADY_WARNED_DEPRECATED = new SafeSet();
+
+function warnOnDeprecatedApi(apiName, stack, suggestion) {
+ if (deprecatedApiWarningDisabled) {
+ return;
+ }
+
+ if (ALREADY_WARNED_DEPRECATED.has(apiName + stack)) {
+ return;
+ }
+
+ // If we haven't warned yet, let's do some processing of the stack trace
+ // to make it more useful.
+ const stackLines = StringPrototypeSplit(stack, "\n");
+ ArrayPrototypeShift(stackLines);
+ while (true) {
+ // Filter out internal frames at the top of the stack - they are not useful
+ // to the user.
+ if (
+ StringPrototypeIncludes(stackLines[0], "(ext:") ||
+ StringPrototypeIncludes(stackLines[0], "(node:")
+ ) {
+ ArrayPrototypeShift(stackLines);
+ } else {
+ break;
+ }
+ }
+ // Now remove the last frame if it's coming from "ext:core" - this is most likely
+ // event loop tick or promise handler calling a user function - again not
+ // useful to the user.
+ if (
+ StringPrototypeIncludes(stackLines[stackLines.length - 1], "(ext:core/")
+ ) {
+ ArrayPrototypePop(stackLines);
+ }
+
+ let isFromRemoteDependency = false;
+ const firstStackLine = stackLines[0];
+ if (firstStackLine && !StringPrototypeIncludes(firstStackLine, "file:")) {
+ isFromRemoteDependency = true;
+ }
+
+ ALREADY_WARNED_DEPRECATED.add(apiName + stack);
+ console.error(
+ "%cWarning",
+ "color: yellow; font-weight: bold;",
+ );
+ console.error(
+ `%c\u251c Use of deprecated "${apiName}" API.`,
+ "color: yellow;",
+ );
+ console.error("%c\u2502", "color: yellow;");
+ console.error(
+ "%c\u251c This API will be removed in Deno 2.0. Make sure to upgrade to a stable API before then.",
+ "color: yellow;",
+ );
+ console.error("%c\u2502", "color: yellow;");
+ console.error(
+ `%c\u251c Suggestion: ${suggestion}`,
+ "color: yellow;",
+ );
+ if (isFromRemoteDependency) {
+ console.error("%c\u2502", "color: yellow;");
+ console.error(
+ `%c\u251c Suggestion: It appears this API is used by a remote dependency.`,
+ "color: yellow;",
+ );
+ console.error(
+ "%c\u2502 Try upgrading to the latest version of that dependency.",
+ "color: yellow;",
+ );
+ }
+
+ console.error("%c\u2502", "color: yellow;");
+ console.error("%c\u2514 Stack trace:", "color: yellow;");
+ for (let i = 0; i < stackLines.length; i++) {
+ console.error(
+ `%c ${i == stackLines.length - 1 ? "\u2514" : "\u251c"}\u2500 ${
+ StringPrototypeTrim(stackLines[i])
+ }`,
+ "color: yellow;",
+ );
+ }
+ console.error();
+}
+
function windowClose() {
if (!windowIsClosing) {
windowIsClosing = true;
@@ -432,7 +525,7 @@ function exposeUnstableFeaturesForWindowOrWorkerGlobalScope(options) {
// FIXME(bartlomieju): temporarily add whole `Deno.core` to
// `Deno[Deno.internal]` namespace. It should be removed and only necessary
// methods should be left there.
-ObjectAssign(internals, { core });
+ObjectAssign(internals, { core, warnOnDeprecatedApi });
const internalSymbol = Symbol("Deno.internal");
const finalDenoNs = {
internal: internalSymbol,
@@ -467,8 +560,10 @@ function bootstrapMainRuntime(runtimeOptions) {
3: inspectFlag,
5: hasNodeModulesDir,
6: maybeBinaryNpmCommandName,
+ 7: shouldDisableDeprecatedApiWarning,
} = runtimeOptions;
+ deprecatedApiWarningDisabled = shouldDisableDeprecatedApiWarning;
performance.setTimeOrigin(DateNow());
globalThis_ = globalThis;
@@ -593,8 +688,10 @@ function bootstrapWorkerRuntime(
4: enableTestingFeaturesFlag,
5: hasNodeModulesDir,
6: maybeBinaryNpmCommandName,
+ 7: shouldDisableDeprecatedApiWarning,
} = runtimeOptions;
+ deprecatedApiWarningDisabled = shouldDisableDeprecatedApiWarning;
performance.setTimeOrigin(DateNow());
globalThis_ = globalThis;
diff --git a/runtime/worker_bootstrap.rs b/runtime/worker_bootstrap.rs
index aac665b05..e3bfc13b9 100644
--- a/runtime/worker_bootstrap.rs
+++ b/runtime/worker_bootstrap.rs
@@ -60,6 +60,7 @@ pub struct BootstrapOptions {
pub has_node_modules_dir: bool,
pub maybe_binary_npm_command_name: Option<String>,
pub node_ipc_fd: Option<i64>,
+ pub disable_deprecated_api_warning: bool,
}
impl Default for BootstrapOptions {
@@ -88,6 +89,7 @@ impl Default for BootstrapOptions {
has_node_modules_dir: Default::default(),
maybe_binary_npm_command_name: None,
node_ipc_fd: None,
+ disable_deprecated_api_warning: false,
}
}
}
@@ -117,6 +119,8 @@ struct BootstrapV8<'a>(
bool,
// maybe_binary_npm_command_name
Option<&'a str>,
+ // disable_deprecated_api_warning,
+ bool,
);
impl BootstrapOptions {
@@ -136,6 +140,7 @@ impl BootstrapOptions {
self.enable_testing_features,
self.has_node_modules_dir,
self.maybe_binary_npm_command_name.as_deref(),
+ self.disable_deprecated_api_warning,
);
bootstrap.serialize(ser).unwrap()