node-tap mocking alongside ts-node

[drazisil]

This might work better as a different issue type, if so let me know.

Expected Behavior

I am able to mock require

Actual Behavior

I receive this relatively unhelpful (to me) error stack

    Object.<anonymous> (test/dosStub.ts:8:3)

    Module.m._compile (node_modules/ts-node/src/index.ts:1225:23)

    Object.require.extensions.<computed> [as .ts] (node_modules/ts-node/src/index.ts:1228:12)

Steps to reproduce the problem

This is probably partly related to the node-tap's way of mocking, which is documented here. https://node-tap.org/docs/api/mocks/#api

Minimal reproduction

Since my code is already quite short, pasting it here in it's entirety

import t from "tap";
const { DosStub} = t.mock("../lib/dosStub.ts", {
  console: {
    error: () => {}
  }
});

t.test("DosStub", (t) => {
  t.throws(function() {new DosStub()}, 'foo')
  t.done
});

The contents of the dosStub.ts file are a single exported class. Since this is a require error, I don't think the content of that file are relevant, but I will share if desired.

TypeStrong/ts-node-repros#15

Specifications

• ts-node version: v10.1.0
• node version: v14.16.1
• TypeScript version: v4.3.5
• tsconfig.json, if you're using one:

{ }
  

• Operating system and version:
• If Windows, are you using WSL or WSL2?:

Description: Manjaro Linux
Release: 21.1.0

[drazisil]

So as not to clutter the template, I'll add a couple notes here. Since the error says it occurs here https://github.com/TypeStrong/ts-node/blob/v10.1.0/src/index.ts#L1228 I speculate that https://github.com/TypeStrong/ts-node/blob/v10.1.0/src/index.ts#L1212 is at fault, based on the wording, and s-node is unable to register .ts as a extension that node can handle.

Per the docs, https://nodejs.org/dist/latest-v14.x/docs/api/modules.html#modules_require_extensions this API has been depreciated for some time, but I understand there is no other way to do this. nodejs/node#32483

Based on https://github.com/nodejs/node/blob/v14.16.1/test/parallel/test-module-multi-extensions.js#L20-L30, it appears that Node still tests that this works, so it does not appear to be broken. I have no idea where to hunt from here.

[drazisil]

https://nodejs.org/dist/latest-v14.x/docs/api/esm.html#esm_no_require_extensions

Is it because I'm usingimport and tap is rewriting require, which import doesn't use, per the above?

No, tap should support this, per https://node-tap.org/docs/using-with/#using-tap-with-esm 🤔

[cspotcode]

A couple quick observations:

Based on your reproduction, ts-node is throwing an internal error that it cannot find @types/node. I believe this is a separate bug which I've tracked here: #1419
However, it may be masking the tap-related bug which you are trying to demonstrate. I believe you can work around the @types/node bug by adding @types/node as a dependency in package.json. This should make your reproduction more illustrative.

Second, there's a syntax error in f.ts: https://github.com/TypeStrong/ts-node-repros/blob/1fd4007a3ffa335fd786e823b1a9011aabe454a6/test/f.ts
What happens when the syntax error is corrected? Does the error you receive change at all?

[drazisil]

Both fixed, thanks. Maybe we'll get the correct error now.

[cspotcode]

I think f.ts still has a typo.

…

On Thu, Aug 5, 2021, 12:10 AM Drazi Crendraven ***@***.***> wrote: Both fixed, thanks. Maybe we'll get the correct error now. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#1417 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAC35OCUGKVE4DFCW6KM6VLT3IFKJANCNFSM5BSOC66Q> .

[drazisil]

There are two commits since I'm editing on web on mobile. I think the typo was fixed with the second one? Otherwise I'm not seeing it and will have to review tomorrow

[cspotcode]

Yes, please test this locally, and when you're sure it is correct, I'll rerun the reproduction.

…

On Thu, Aug 5, 2021, 12:13 AM Drazi Crendraven ***@***.***> wrote: There are two commits since I'm editing on web on mobile. I think the typo was fixed with the second one? Otherwise I'm not seeing it and will have to review tomorrow — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#1417 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAC35OA74K6LVGV7RBB4Z6TT3IFYDANCNFSM5BSOC66Q> .

[drazisil]

It's ready to run now and is giving the "correct" error locally.

[cspotcode]

still has a typo EDIT maybe spoke too soon

[cspotcode]

Ok yeah, still has a typo in t.ts

[drazisil]

Ok yeah, still has a typo in t.ts

Where? It runs the tests and gives the error I expect. I'd be happy if the error was due to a typo. 👀

NM. Sorry to waste your time. :-/ I see the issue. I need to stop switching between tap and jest, it's just close enough syntax.