bug: Stencil can resolve incorrect jest-runner dependency when using pnpm

Aperta
  • Qualcosa non va?
#5,196 1 commento 2 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
testing-qa, tooling

Direzione di ricerca

Riproduci il fallimento di packages/stencil con pnpm install seguito da pnpm test.spec, quindi traccia la risoluzione del runner da @stencil/core/testing/index.js utilizzando lo stack trace fornito. Il lavoro è completato quando viene selezionato il runner Jest v29 per il progetto Stencil nonostante un altro pacchetto del workspace utilizzi Jest v26 e i test vengano completati correttamente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Bug: Validated
Prerequisites
Stencil Version

v4.9.0

Current Behavior

In a mono-repo using pnpm where you have mixed dependency versions of Jest, specifically the jest-runner package, Stencil will incorrectly use an older version of the jest-runner package, even though the Stencil project may be configured with a newer version.

For example, in a project that has Jest v29 for the Stencil project, but another package with Jest v26, Stencil will use the test facade for Jest v29, but use the jest-runner@26 instance when executing the test runner.

This results in an exception:

TypeError: Cannot read properties of undefined (reading 'serial')

I've modified the bundle to provide the entire stack trace:

TypeError: Cannot read properties of undefined (reading 'serial')
    at e.runTests (/Users/sean/Documents/ionic/issues/ionic-framework/node_modules/.pnpm/[email protected]/node_modules/jest-runner/build/index.js:108:27)
    at e.runTests (/Users/sean/Documents/ionic/issues/ionic-framework/node_modules/.pnpm/@[email protected]/node_modules/@stencil/core/testing/index.js:926:19)
    at TestScheduler.scheduleTests (/Users/sean/Documents/ionic/issues/ionic-framework/node_modules/.pnpm/@[email protected]/node_modules/@jest/core/build/TestScheduler.js:283:32)
    at async runJest (/Users/sean/Documents/ionic/issues/ionic-framework/node_modules/.pnpm/@[email protected]/node_modules/@jest/core/build/runJest.js:367:19)
    at async _run10000 (/Users/sean/Documents/ionic/issues/ionic-framework/node_modules/.pnpm/@[email protected]/node_modules/@jest/core/build/cli/index.js:343:7)
    at async runCLI (/Users/sean/Documents/ionic/issues/ionic-framework/node_modules/.pnpm/@[email protected]/node_modules/@jest/core/build/cli/index.js:198:3)
    at async runJest (/Users/sean/Documents/ionic/issues/ionic-framework/node_modules/.pnpm/@[email protected]/node_modules/@stencil/core/testing/index.js:900:10)
    at async Object.run (/Users/sean/Documents/ionic/issues/ionic-framework/node_modules/.pnpm/@[email protected]/node_modules/@stencil/core/testing/index.js:12865:10)
    at async taskTest (/Users/sean/Documents/ionic/issues/ionic-framework/node_modules/.pnpm/@[email protected]/node_modules/@stencil/core/cli/index.cjs:2395:24)
    at async runTask (/Users/sean/Documents/ionic/issues/ionic-framework/node_modules/.pnpm/@[email protected]/node_modules/@stencil/core/cli/index.cjs:2514:13)

This behavior is likely driven from pnpm hoisting the dependency, changing the execution location from which Stencil uses to grab the jest-runner instance and invoke it. I suspect we will need to make stricter assumption around where this instance lives, such as from the rootDir of the project, instead of from the executing node_modules.

Expected Behavior

Stencil should resolve its own dependency of the jest-runner, regardless of if the workspace is using another dependency for another project in the mono-repo.

System Info
`npx stencil info` fails with:
> npm ERR! could not determine executable to run
Steps to Reproduce
  1. Clone the repository - it is a mono-repo.
  2. Install pnpm, if not already installed: https://pnpm.io/installation
  3. Install project dependencies: pnpm install
  4. Run unit tests for the Stencil project: cd packages/stencil && pnpm test.spec
  5. Observe: Exception is thrown, tests do not run successfully.
  6. Expected: Tests run successfully.
Code Reproduction URL

https://github.com/sean-perkins/stencil-pnpm-issue

Additional Information

Workarounds:

  1. Downgrade to the lowest version of Jest that is compatible with Stencil, for example with the reproduction downgrading the Stencil project to Jest v26.
  2. Upgrade all packages in the mono-repo to the same version of Jest as the Stencil project.
  3. Use npm or a package manager that does not hoist dependencies.
Lingua principale
TypeScript
Stelle
13.2k
Fork
865
Merge medio
2g 16h
PR unite (30g)
29

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di stenciljs/core

Tutte le issue di stenciljs/core

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.