TypeScript compilation fails when using Yarn PnP

[testorangemac]

What is your Scenario?

TypeScript compilation fails when using Yarn PnP. See the minimal working example repository or the steps to reproduce.

What is the Current behavior?

The following error is reported:

ERROR Cannot prepare tests due to the following error:

Error: TypeScript compilation failed.
C:/git/testcafe-yarn-berry/getting-started.ts (1, 26): File name 'C:/git/testcafe-yarn-berry/.yarn/cache/testcafe-npm-2.1.0-a6f521662e-8d426e4912.zip/node_modules/testcafe/ts-defs/index.d.ts' differs from already included file name 'c:/git/testcafe-yarn-berry/.yarn/cache/testcafe-npm-2.1.0-a6f521662e-8d426e4912.zip/node_modules/testcafe/ts-defs/index.d.ts' only in casing.
  The file is in the program because:
    Root file specified for compilation
    Imported via "testcafe" from file 'C:/git/testcafe-yarn-berry/getting-started.ts' with packageId 'testcafe/ts-defs/index.d.ts@2.1.0'

What is the Expected behavior?

TypeScript compilation works and the test is successfully run.

What is your public website URL? (or attach your complete example)

https://github.com/testorangemac/yarn-testcafe-berry

What is your TestCafe test code?

import { Selector } from "testcafe";

fixture("Getting Started").page(
  "https://devexpress.github.io/testcafe/example"
);

test("My first test", async (t) => {
  await t
    .typeText("#developer-name", "John Smith")
    .click("#submit-button")
    .expect(Selector("#article-header").innerText)
    .eql("Thank you, John Smith!");
});

Your complete configuration file

n/a

Your complete test report

n/a

Screenshots

n/a

Steps to Reproduce

1. Run yarn init -2 (in a new directory)
2. Run yarn add -D testcafe
3. Add the example test file (as getting-started.ts)
4. Run yarn testcafe chrome getting-started.ts

TestCafe version

2.1.0

Node.js version

v19.2.0

Command-line arguments

chrome getting-started.ts

Browser name(s) and version(s)

Chrome 108

Platform(s) and version(s)

Windows 10 Pro

Other

I have made the following observations:

• The only difference in the reported error is the drive letter C vs c
• This only occurs on Windows (verified on Linux)
• When using JavaScript (renaming the test file to .js) it runs fine
• Using different TypeScript versions doesn't impact the behavior
• Patching the TestCafe code to use lower casing after calling process.cwd() fixes the issue and runs the test fine

[AlexKamaev]

Thank you for your research and sharing the example. I was able to reproduce the issue.
To the team:
While we still need to research the issue in detail, I found a possible solution, which should be checked.

 private _compileFilesToCache (ts: TypeScriptInstance, filenames: string[]): void {
        const opts    = this._tsConfig.getOptions() as Dictionary<CompilerOptionsValue>;
        
        // NOTE: I added the following line
        filenames = filenames.map(name => TypeScriptTestFileCompiler._normalizeFilename(name));
        
        const program = ts.createProgram([TypeScriptTestFileCompiler.tsDefsPath, ...filenames], opts);

[miherlosev]

Duplicate of #7710

[Asuza]

@testorangemac would you be willing to share your patch to resolve this issue? I'm going to see if I can figure it out in the meantime. I'm seeing this when trying to run tests:

Error: TypeScript compilation failed.
C:/dev/myapp/api.mock.ts (1, 29): File name 'C:/dev/myapp/.yarn/cache/testcafe-npm-2.6.2-1e6c5a66b9-65d49c3cdd.zip/node_modules/testcafe/ts-defs/index.d.ts' differs from already included file name 'c:/dev/app028-checkout/.yarn/cache/testcafe-npm-2.6.2-1e6c5a66b9-65d49c3cdd.zip/node_modules/testcafe/ts-defs/index.d.ts' only in casing.
  The file is in the program because:
    Root file specified for compilation
    Imported via 'testcafe' from file 'C:/dev/myapp/api.mock.ts' with packageId 'testcafe/ts-defs/index.d.ts@2.6.2'

I never noticed that the drive letter was the issue until you pointed it out! Thanks.

[Asuza]

Never mind! I applied the change that @AlexKamaev and the tests started just fine. I'm relieved to see the tests running, as this was the last hurdle I had when trying to switch to Yarn PnP. Thank you both.