1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-12-22 23:34:47 -05:00
denoland-deno/ext/node/polyfills
Marvin Hagemeister 692738232b
fix(node/fs): promises not exporting fs constants (#21997)
<!--
Before submitting a PR, please read https://deno.com/manual/contributing

1. Give the PR a descriptive title.

  Examples of good title:
    - fix(std/http): Fix race condition in server
    - docs(console): Update docstrings
    - feat(doc): Handle nested reexports

  Examples of bad title:
    - fix #7123
    - update docs
    - fix bugs

2. Ensure there is a related issue and it is referenced in the PR text.
3. Ensure there are tests that cover the changes.
4. Ensure `cargo test` passes.
5. Ensure `./tools/format.js` passes without changing files.
6. Ensure `./tools/lint.js` passes.
7. Open as a draft PR if your work is still in progress. The CI won't
run
   all steps, but you can add '[ci]' to a commit message to force it to.
8. If you would like to run the benchmarks on the CI, add the 'ci-bench'
label.
-->

We were missing the `constants` export in the promise `fs` API which is
available in node.

```ts
import { constants, promises } from "node:fs";
import { constants as fsPromiseConstants } from "node:fs/promises";
console.log(constants === promises.constants); // logs: true
console.log(constants === fsPromiseConstants); // logs: true
```

Fixes https://github.com/denoland/deno/issues/21994
2024-01-21 21:48:48 +01:00
..
_fs refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
_process refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
_util fix(node): remove use of non existing FunctionPrototypeApply primordial (#21986) 2024-01-19 12:01:46 -05:00
assert chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
dns chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
fs fix(node/fs): promises not exporting fs constants (#21997) 2024-01-21 21:48:48 +01:00
internal refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
internal_binding refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
path chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
readline chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
stream chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
timers chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
util chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
00_globals.js chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
01_require.js refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
02_init.js refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
_brotli.js refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
_events.d.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_events.mjs fix(ext/node): don't call undefined nextTick fn (#20724) 2023-10-02 14:13:57 +02:00
_global.d.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_http_agent.mjs refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
_http_common.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_http_outgoing.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_next_tick.ts refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
_readline.d.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_readline.mjs refactor: rename built-in node modules from ext:deno_node/ to node: (#19680) 2023-07-02 20:19:30 +02:00
_readline_shared_types.d.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_stream.d.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_stream.mjs fix(ext/node): use node:process in _streams.mjs (#21755) 2024-01-02 19:08:05 +01:00
_tls_common.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_tls_wrap.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_utils.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
_zlib.mjs fix(node/zlib): accept dataview and buffer in zlib bindings (#21756) 2024-01-03 19:03:51 +05:30
_zlib_binding.mjs refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
assert.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
assertion_error.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
async_hooks.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
buffer.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
child_process.ts refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
cluster.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
console.ts refactor: split runtime/98_global_scope.js (#21785) 2024-01-06 14:40:26 +01:00
constants.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
crypto.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
dgram.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
diagnostics_channel.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
dns.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
domain.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
events.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
fs.ts fix(node/fs): promises not exporting fs constants (#21997) 2024-01-21 21:48:48 +01:00
http.ts fix(node/http): remoteAddress and remotePort not being set (#21998) 2024-01-19 13:09:37 +01:00
http2.ts refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
https.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
inspector.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
net.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
os.ts refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
path.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
perf_hooks.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
process.ts feat: "rejectionhandled" Web event and "rejectionHandled" Node event (#21875) 2024-01-12 22:10:42 +00:00
punycode.ts refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
querystring.js fix(ext/node): querystring stringify without encode callback (#21740) 2024-01-02 04:54:11 +00:00
readline.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
README.md chore: update commonjs loading docs (#19904) 2023-07-22 05:48:06 +02:00
repl.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
stream.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
string_decoder.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
sys.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
testing.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
timers.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
tls.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
tty.js refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
url.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
util.ts refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
v8.ts refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
vm.ts refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
wasi.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
worker_threads.ts refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
zlib.ts chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00

Deno Node.js compatibility

This module is meant to have a compatibility layer for the Node.js standard library.

Warning: Any function of this module should not be referred anywhere in the Deno standard library as it's a compatibility module.

Supported modules

  • assert
  • assert/strict partly
  • async_hooks partly
  • buffer
  • child_process partly
  • cluster partly
  • console partly
  • constants partly
  • crypto partly
  • dgram partly
  • diagnostics_channel partly
  • dns partly
  • events
  • fs partly
  • fs/promises partly
  • http partly
  • http2
  • https partly
  • inspector partly
  • module
  • net
  • os partly
  • path
  • path/posix
  • path/win32
  • perf_hooks
  • process partly
  • punycode
  • querystring
  • readline
  • repl partly
  • stream
  • stream/promises
  • stream/web partly
  • string_decoder
  • sys
  • timers
  • timers/promises
  • tls
  • trace_events
  • tty partly
  • url
  • util partly
  • util/types partly
  • v8
  • vm partly
  • wasi
  • webcrypto
  • worker_threads
  • zlib
  • node globals partly

Deprecated

These modules are deprecated in Node.js and will probably not be polyfilled:

  • domain
  • freelist

Experimental

These modules are experimental in Node.js and will not be polyfilled until they are stable:

  • diagnostics_channel
  • async_hooks
  • policies
  • trace_events
  • wasi
  • webcrypto

CommonJS modules loading

createRequire(...) is provided to create a require function for loading CJS modules. It also sets supported globals.

import { createRequire } from "node:module";

const require = createRequire(import.meta.url);
// Loads native module polyfill.
const path = require("path");
// Loads extensionless module.
const cjsModule = require("./my_mod");
// Visits node_modules.
const leftPad = require("left-pad");

Contributing

Setting up the test runner and running tests

See tools/node_compat/README.md.

Best practices

When converting from promise-based to callback-based APIs, the most obvious way is like this:

promise.then((value) => callback(null, value)).catch(callback);

This has a subtle bug - if the callback throws an error, the catch statement will also catch that error, and the callback will be called twice. The correct way to do it is like this:

promise.then((value) => callback(null, value), callback);

The second parameter of then can also be used to catch errors, but only errors from the existing promise, not the new one created by the callback.

If the Deno equivalent is actually synchronous, there's a similar problem with try/catch statements:

try {
  const value = process();
  callback(null, value);
} catch (err) {
  callback(err);
}

Since the callback is called within the try block, any errors from it will be caught and call the callback again.

The correct way to do it is like this:

let err, value;
try {
  value = process();
} catch (e) {
  err = e;
}
if (err) {
  callback(err); // Make sure arguments.length === 1
} else {
  callback(null, value);
}

It's not as clean, but prevents the callback being called twice.

Remaining Tests

Node compatibility can be measured by how many native Node tests pass. If you'd like to know what you can work on, check out the list of Node tests remaining here.