0
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2025-03-09 21:57:40 -04:00
deno/runtime
Bartek Iwańczuk c62615bfe5
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
2024-01-18 23:30:49 +00:00
..
examples chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
js feat: Start warning on each use of a deprecated API (#21939) 2024-01-18 23:30:49 +00:00
ops fix(web): use rustyline for prompt (#21893) 2024-01-11 22:05:55 +01:00
permissions fix(ext/node): add fs.cp, fs.cpSync, promises.cp (#21745) 2024-01-05 18:28:33 +05:30
Cargo.toml chore: forward v1.39.4 release commit to main (#21933) 2024-01-13 20:32:50 -05:00
clippy.toml feat(compile): unstable npm and node specifier support (#19005) 2023-05-10 20:06:59 -04:00
colors.rs perf: don't allocate so much in runtime/colors.rs (#21957) 2024-01-16 14:58:01 +01:00
errors.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
fmt_errors.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
fs_util.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
inspector_server.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
js.rs refactor: remove snapshotting from deno_runtime (#21794) 2024-01-10 16:30:50 +01:00
lib.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
README.md fix (doc): Typo in runtime/README.md (#20020) 2023-12-13 17:24:32 +00:00
shared.rs refactor: remove snapshotting from deno_runtime (#21794) 2024-01-10 16:30:50 +01:00
snapshot.rs fix(ext/node): add fs.cp, fs.cpSync, promises.cp (#21745) 2024-01-05 18:28:33 +05:30
tokio_util.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
web_worker.rs chore: upgrade deno_core to 0.246.0 (#21904) 2024-01-14 18:28:46 -07:00
worker.rs chore: upgrade deno_core to 0.246.0 (#21904) 2024-01-14 18:28:46 -07:00
worker_bootstrap.rs feat: Start warning on each use of a deprecated API (#21939) 2024-01-18 23:30:49 +00:00

deno_runtime crate

crates docs

This is a slim version of the Deno CLI which removes typescript integration and various tooling (like lint and doc). Basically only JavaScript execution with Deno's operating system bindings (ops).

Stability

This crate is built using battle-tested modules that were originally in the deno crate, however the API of this crate is subject to rapid and breaking changes.

MainWorker

The main API of this crate is MainWorker. MainWorker is a structure encapsulating deno_core::JsRuntime with a set of ops used to implement Deno namespace.

When creating a MainWorker implementors must call MainWorker::bootstrap to prepare JS runtime for use.

MainWorker is highly configurable and allows to customize many of the runtime's properties:

  • module loading implementation
  • error formatting
  • support for source maps
  • support for V8 inspector and Chrome Devtools debugger
  • HTTP client user agent, CA certificate
  • random number generator seed

Worker Web API

deno_runtime comes with support for Worker Web API. The Worker API is implemented using WebWorker structure.

When creating a new instance of MainWorker implementors must provide a callback function that is used when creating a new instance of Worker.

All WebWorker instances are descendents of MainWorker which is responsible for setting up communication with child worker. Each WebWorker spawns a new OS thread that is dedicated solely to that worker.