[Bug]: Symbol.dispose and Symbol.asyncDispose are undefined

[notaphplover]

Version

29.7.0

Steps to reproduce

1. Clone the minimal reproduction repository
2. Follow the steps in the README.md file.

Expected behavior

As described in the readme, I expect Symbol.dispose and Symbol.asyncDispose to be exposed when targeting a node env.

Actual behavior

Symbol.dispose and Symbol.asyncDispose are not defined in the jest node env.

Additional context

Since typescript 5.2, Explicit Resource Management is being supported in Typescript. Latest stable NodeJS versions include Symbol.dispose and Symbol.asyncDispose, essential to pollyfill this feature. Exposing them in the jest node env would allow to properly test modules using this feature.

Environment

System:
    OS: Linux 6.5 Ubuntu 22.04.3 LTS 22.04.3 LTS (Jammy Jellyfish)
    CPU: (8) x64 Intel(R) Core(TM) i7-6700K CPU @ 4.00GHz
  Binaries:
    Node: 20.9.0 - ~/.nvm/versions/node/v20.9.0/bin/node
    Yarn: 1.22.19 - ~/.nvm/versions/node/v20.9.0/bin/yarn
    npm: 10.3.0 - ~/.nvm/versions/node/v20.9.0/bin/npm
    pnpm: 8.15.1 - ~/.nvm/versions/node/v20.9.0/bin/pnpm
  npmPackages:
    jest: 29.7.0 => 29.7.0

[ertl]

I receive TypeError: Symbol.asyncDispose is not defined.

Is there a workaround until it's fixed?

[SimenB]

We should probably copy this over if it's defined in the "real" environment. Happy to take a PR 🙂

[notaphplover]

I receive TypeError: Symbol.asyncDispose is not defined.

Is there a workaround until it's fixed?

Yeah, but the one I came up is ugly, simply add this code to the tests which are using those symbols:

/*
 * Ugly workaround until https://github.com/jestjs/jest/issues/14874 is fixed
 */

const disposeSymbol: unique symbol = Symbol('Symbol.dispose');
const asyncDisposeSymbol: unique symbol = Symbol('Symbol.asyncDispose');

(Symbol as Writable<SymbolConstructor>).asyncDispose ??=
  asyncDisposeSymbol as unknown as SymbolConstructor['asyncDispose'];
(Symbol as Writable<SymbolConstructor>).dispose ??=
  disposeSymbol as unknown as SymbolConstructor['dispose'];

where Writable is:

export type Writable<T> = {
  -readonly [TKey in keyof T]: T[TKey];
};

I know, ugly, feel free to adapt it to the style which suits you better 😃

[notaphplover]

We should probably copy this over if it's defined in the "real" environment. Happy to take a PR 🙂

Hey @SimenB! So nice to see you here. That would be amazing man, I haven't contributed to the project yet, but I'll try to figure out where to make the change. I wish I could be helpful to this project, so I think it's a great chance, thanks

[notaphplover]

I submitted #14888 😃