Using testdouble esm loader with ts-node/esm loader on mocha leads to errors (Node 18.6.0)

[AlexZ-343]

Description

I am trying to do esm mocking using testdouble with a mixed Typescript and Javascript project, mostly following this post

Node 18.6.0 now allows for chaining of loads, and I previously needed ts-node/esm in order to recognize my Typescript files and imports.

I realize that this new feature is less than a week old, but I would appreciate support with reconciling other loaders that I would need for my es6 project (or to find a way that only requires one loader). Due to project requirements, using commonjs on runtime is not an option.

Issue

When running the following mocha command:

NODE_OPTIONS='--experimental-specifier-resolution=node --loader=ts-node/esm --loader=testdouble' mocha test/.js test/.spec.ts

and any permutation thereof (removing experimental-specifier-resolution, changing the order of the --loader params)

I get the following exception

Exception in PromiseRejectCallback:
node:internal/modules/esm/loader:178
return output;
RangeError: Maximum call stack size exceeded
Exception in PromiseRejectCallback:
/Users/repos/moRepo/node_modules/ts-node/dist/esm.js:120
const { source: rawSource } = await defaultLoad(url, {
^
RangeError: Maximum call stack size exceeded
at validateArgs (node:internal/modules/esm/loader:578:26)

These 4 lines repeat indefinitely:

at addShortCircuitFlag (/Users/repos/myRepo/node_modules/ts-node/src/esm.ts:409:21)
at load (/Users/repos/myRepo/node_modules/ts-node/src/esm.ts:239:12)
at nextLoad (node:internal/modules/esm/loader:173:28)
at /Users/repos/myRepo/node_modules/ts-node/src/esm.ts:255:45

Environment

node v18.6.0
npm v.8.13.2
testdouble v.3.16.6

Example Repo

I don't have a repo handy, but I can try to create one and add it in the future.

Code-fenced Examples

service_one.ts

export function getAllInvalidObjects(connection: Connection) {
  
 const response: string[] = service_two.getData(someString);
 ... // some transformations of response
 return response;
}

service_two.ts

// this is the function I'd like to mock when testing service_one.ts
export function getData(someString) {
  axios.get('https://endpoint.com/path?string=' + someString).then((response: any) {
   resolve(response.json);
  }
}

test.ts :

import * as td from 'testdouble';

let mock_validation_rest: any;

beforeEach(async () => {
    mock_rest = await td.replaceEsm('../src/services/service_two.js');
});

afterEach(function () {
    sandbox.restore();
    td.reset();
});

it('successfully validates with mocking, async () => {
    td.when(mock_rest.prototype.getData(td.matchers.anything())).thenResolve(mockData);

    // as long as the mock above works then this test will pass
    return service_one.getAllInvalidObjects(connection).then((response: string[]) => {
      assert.equal(3, response.length);
    });
});

package.json:

    {
      "type": "module",
      "scripts": {
         "test": NODE_OPTIONS='--experimental-specifier-resolution=node --loader=ts-node/esm --loader=testdouble' mocha test/*.js test/*.spec.ts -r dotenv/config
      }
    }

tsconfig.json:

    {
      "compilerOptions": {
         "target": "es2016",
         "module": "es6,
         "moduleResolution": "node16"
         "allowJs": true,
         "esModuleInterop": true
      },
      "ts-node": {
         "esm": true
      }
      "include": [
         "./src/**/*",
         "test/**/*/.ts",
         "test/**/*.js"
      }
    }

[searls]

Could you please also make sure quibble is up-to-date and share its version? Tagging @giltayar if he knows about any of this

[giltayar]

@AlexZ-343 would love to get a reproduction repository so that I can debug it this week! It would make my life much easier.

[AlexZ-343]

quibble is 0.6.13, which is the latest release. Working on the reproduction repository and I will link it when ready.

[AlexZ-343]

I have the repo set is private. I have added @searls and @giltayar to it.

https://github.com/AlexZ-343/testdouble-issue

[giltayar]

Reproduced! Working on it...

[giltayar]

Found the bug! Fixing...

[AlexZ-343]

Hi @giltayar, what's the status on the resolution? I see a fix has been fixed, but there hasn't been a release yet?

[AlexZ-343]

Checking in again @giltayar @searls

[alichry]

Hi @AlexZ-343, I'm facing this issue as well. There's a fix by the node team in nodejs/node#44109. I am going to test it using node v19.0.0-nightly20220806760ecc9c75/ that includes it. if I find anything, I'll let you know.

[alichry]

I've created a playground here: testdouble-ts-node-esm-playground. Mocking fs succeeded, however, mocking internal modules written in typescript did not. The outcome is identical when using node v18.7.0 or node v19.0.0-nightly20220806760ecc9c75

[giltayar]

@searls did you create a release?

[searls]

@giltayar no, I'd actually invited you to after adding you as a maintainer on the npm package, along with an updated RELEASE.md doc!

Would you like to try your hand at releasing a patch bump for this?

[AlexZ-343]

I've created a playground here: testdouble-ts-node-esm-playground. Mocking fs succeeded, however, mocking internal modules written in typescript did not. The outcome is identical when using node v18.7.0 or node v19.0.0-nightly20220806760ecc9c75

hey @alichry, thanks for taking a look at this!

Could you clarify what you mean by this statement?

mocking internal modules written in typescript did not

I'll try playing around with it a bit on my end as well.