Enable support for Cypress tests that rely on workspace packages

Aperta
  • Qualcosa non va?
#1,407 1 commento 0 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
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
cypress, github-actions, javascript
Ambito
ci-cd, testing

Direzione di ricerca

Inizia con .github/workflows/web-e2e-deployed-environments.yml e packages/e2e/cypress.config.ts, quindi riproduci il fallimento usando il workflow pnpm workspace mostrato. Traccia il modo in cui la GitHub Action invoca Cypress e il modo in cui il webpack preprocessor risolve @repo/mock/rules. Il lavoro è completato quando gli import dei pacchetti del workspace vengono risolti nell'action, oppure quando una configurazione documentata li abilita in modo affidabile.

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

Descrizione

type: feature

The GitHub Action fails to run Cypress tests in a pnpm monorepo workspace with the following error:

Error: Webpack Compilation Error
Module not found: Error: Can't resolve '@repo/mock/rules' in /home/runner/work/monorepo/monorepo/packages/e2e/cypress/constants'

Environment

  • cypress-io/github-action: v6
  • Cypress: v14.2.0
  • Package manager: pnpm
  • Project structure: Monorepo with workspace packages
  • OS: Ubuntu 22.04 (GitHub Action runner)

Project Structure

/monorepo
├── .github
│ └── workflows
│ └── web-e2e-deployed-environments.yml # GitHub Actions workflow file
├── packages
│ ├── mock # Mock package with KYC rules and scenarios
│ │ ├── package.json # Contains exports configuration
│ │ ├── src
│ │ │ └── handlers
│ │ │ └── kyc
│ │ │ ├── rules.ts # Exports RULES and SSNS used in tests
│ │ │ └── scenarios.ts # KYC mock scenarios
│ │ └── dist # Built JavaScript files
│ │
│ └── e2e # E2E test package using Cypress
│ │ ├── package.json
│ │ ├── cypress.config.ts
│ │ ├── cypress
│ │ ├── constants
│ │ │ └── kyc-mock-constants.ts # Imports from @repo/mock/rules
│ └── ...

The import causing the issue

From packages/e2e/cypress/constants/kyc-mock-constants.ts:

// Import using the exports field from package.json
import { RULES, SSNS } from '@repo/mock/rules';

From packages/mock/package.json:

"exports": {
  "./rules": {
    "types": "./src/handlers/kyc/rules.ts",
    "default": "./dist/handlers/kyc/rules.js"
  }
}

Steps to reproduce

  1. Have a pnpm monorepo with workspace packages (using "workspace:*" in package.json)
  2. Create a Cypress test that imports from a workspace package (e.g., import { RULES } from '@repo/mock/rules')
  3. Run the Cypress tests using the GitHub Action

Current workflow

# Install Cypress dependencies. Since we're in a monorepo, tell Cypress to look at the root package.json/lockfile
# Don't run the tests yet, we'll do that later in the proper directory
- name: Install Cypress dependencies
  uses: cypress-io/github-action@v6
  with:
    runTests: false

- name: Build mock package
  run: pnpm build --filter @repo/mock

- name: Run Cypress tests
  uses: cypress-io/github-action@v6
  env:
    # Environment variables here
  with:
    install: false
    working-directory: packages/e2e
    browser: chrome
    record: true
    parallel: true
    tag: "Staging"

Expected behavior

The Cypress tests should be able to resolve and import the workspace package modules.

Actual behavior

Cypress webpack preprocessor fails to resolve the imports, resulting in the above error.

Additional information

  • The issue seems to be related to how the GitHub Action configures Cypress with pnpm workspaces
  • The mock package is built successfully before running the tests
  • The same tests run fine locally with pnpm cy:run

Expected behavior

The Cypress tests should be able to resolve and import the workspace package modules.

Actual behavior

Cypress webpack preprocessor fails to resolve the imports, resulting in the above error.

Possible solutions

  1. Add native support for pnpm workspaces in the github-action
  2. Provide built-in webpack configuration options for monorepos in the action
  3. Document a recommended approach for handling pnpm workspaces with Cypress

Any guidance on how to fix this issue would be greatly appreciated!

Lingua principale
JavaScript
Stelle
1.5k
Fork
356
Merge medio
1g 9h
PR unite (30g)
28

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 cypress-io/github-action

Tutte le issue di cypress-io/github-action

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.