-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
1 parent
99f9fa5
commit c62615b
Showing
14 changed files
with
291 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
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(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
Download http://localhost:4545/run/warn_on_deprecated_api/mod.ts | ||
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 [WILDCARD]warn_on_deprecated_api/main.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 ([WILDCARD]warn_on_deprecated_api/main.js:14:18) | ||
└─ at [WILDCARD]warn_on_deprecated_api/main.js:25: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 ([WILDCARD]warn_on_deprecated_api/main.js:14:18) | ||
└─ at [WILDCARD]warn_on_deprecated_api/main.js:26: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 ([WILDCARD]warn_on_deprecated_api/main.js:14:18) | ||
└─ at [WILDCARD]warn_on_deprecated_api/main.js:29: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 [WILDCARD]warn_on_deprecated_api/main.js:32:7 | ||
|
||
hello world |
15 changes: 15 additions & 0 deletions
15
cli/tests/testdata/run/warn_on_deprecated_api/main_disabled_env.out
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
Download http://localhost:4545/run/warn_on_deprecated_api/mod.ts | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world |
14 changes: 14 additions & 0 deletions
14
cli/tests/testdata/run/warn_on_deprecated_api/main_disabled_flag.out
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world | ||
hello world |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
export async function runEcho() { | ||
const p = Deno.run({ | ||
cmd: [ | ||
Deno.execPath(), | ||
"eval", | ||
"console.log('hello world')", | ||
], | ||
}); | ||
await p.status(); | ||
p.close(); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.