Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cypress 12.13.0 with Typescript 5.1 fails to compile #26930

Closed
holgergp opened this issue Jun 5, 2023 · 4 comments
Closed

Cypress 12.13.0 with Typescript 5.1 fails to compile #26930

holgergp opened this issue Jun 5, 2023 · 4 comments
Assignees
Labels
CT Issue related to component testing topic: typescript Triaged Issue has been routed to backlog. This is not a commitment to have it prioritized by the team.

Comments

@holgergp
Copy link

holgergp commented Jun 5, 2023

Current behavior

When I use Cypress in version 12.13.0 with TypeScript 5.1.3 compiling with TypeScript fails:

error TS2688: Cannot find type definition file for 'cypress'.
  The file is in the program because:
    Entry point of type library 'cypress' specified in compilerOptions

I set up the repo using the guide https://docs.cypress.io/guides/tooling/typescript-support

Please see the minimal repo: https://github.com/holgergp/typescript51AndCypress and the test run: https://github.com/holgergp/typescript51AndCypress/actions/runs/5175463023/jobs/9323074464

Desired behavior

Please provide docs to circumvent this issue. (or maybe fix this)

Test code to reproduce

Please see the minimal repo: https://github.com/holgergp/typescript51AndCypress and the test run: https://github.com/holgergp/typescript51AndCypress/actions/runs/5175463023/jobs/9323074464

Cypress Version

12.13.0

Node version

18.16.0

Operating System

Github Actions: ubuntu-latest

Debug Logs

https://github.com/holgergp/typescript51AndCypress/actions/runs/5175463023/jobs/9323074464

Other

No response

@MoSattler
Copy link

Same problem here - anyone found a workaround?

@warrensplayer
Copy link
Contributor

This seems to be a problem with a breaking change with Typescript 5.1.3. See: https://devblogs.microsoft.com/typescript/announcing-typescript-5-1/#explicit-typeroots-disables-upward-walks-for-node_modules-types

@holgergp I have replicated your problem in the latest version of Cypress and will forward this ticket to the appropriate team. They will soon evaluate the priority of this ticket and consider their capacity to pick it up. Please note that this does not guarantee that this issue will be resolved. The ticket will indicate status changes during evaluation, so we ask that you please refrain from asking for updates. Thanks!

@warrensplayer warrensplayer added topic: typescript CT Issue related to component testing Triaged Issue has been routed to backlog. This is not a commitment to have it prioritized by the team. labels Jun 20, 2023
@warrensplayer warrensplayer removed their assignment Jun 20, 2023
@lmiller1990
Copy link
Contributor

Let's pick this up asap, and update our ecosystem pipeline so we can catch these earlier.

@jordanpowell88
Copy link
Contributor

jordanpowell88 commented Jun 22, 2023

The solution for this is to specify path to the type files in typeRoots. For example cypress types from the root directory would look like the following:

I recommend viewing our documentation around Configuring typescript. However, if you need to specify typeRoots in your project you will need to implement the solution below. It is important to note that this is not an issue with Cypress itself but a breaking change in Typescript 5.1. This change in Typescript does not exclusively affect Cypress types but any library that ships types as part of the library.

"typeRoots": ["./node_modules", "./node_modules/@types"],

The TDLR: Don't use typeRoots or add a path to node_modules where cypress is installed.

@jordanpowell88 jordanpowell88 self-assigned this Jun 22, 2023
MoSattler added a commit to MoSattler/blues-stack that referenced this issue Jun 24, 2023
Harriethw added a commit to ministryofjustice/hmpps-community-accommodation-tier-2-ui that referenced this issue Jun 30, 2023
We can now update Typescript - it was previously broken with Cypress for
those using `typeRoots` but the fix is to specify the node_modules
folder so it can find Cypress.[1]

[1] cypress-io/cypress#26930
Harriethw added a commit to ministryofjustice/hmpps-community-accommodation-tier-2-ui that referenced this issue Jun 30, 2023
We can now update Typescript - it was previously broken with Cypress for
those using `typeRoots` but the fix is to specify the node_modules
folder so it can find Cypress.[1]

[1] cypress-io/cypress#26930
Harriethw added a commit to ministryofjustice/hmpps-community-accommodation-tier-2-ui that referenced this issue Jun 30, 2023
We can now update Typescript - it was previously broken with Cypress for
those using `typeRoots` but the fix is to specify the node_modules
folder so it can find Cypress.[1]

[1] cypress-io/cypress#26930
cmnord added a commit to cmnord/jep that referenced this issue Aug 21, 2023
cmnord added a commit to cmnord/jep that referenced this issue Aug 21, 2023
nac62116 added a commit to mint-vernetzt/community-platform that referenced this issue Dec 19, 2023
phollome added a commit to mint-vernetzt/community-platform that referenced this issue Feb 19, 2024
* run npx upgrade-remix latest
* Breaking change: LoaderArgs and ActionArgs are now LoaderFunctionArgs and ActionFunctionArgs
* fix typescript compilation errors except thos in api workspace and in node_modules
* Breaking Change: DataFunctionArgs is now LoaderFunctionArgs or ActionFunctionArgs
* Exclude api from root tsconfig because it has its own tsconfig allowing decorators and stuff...
* fetcher.state on <fetcher.Form method="get"> now returns "loading" instead of "submitting" (As its calling the loader not an action)
* Fix typescript errors concerning remix-utlis package caused by upgrading remix
- Only tsc issue inside remix-utils that is missing is the JSX type on React (React.JSX). But this is also an tsc issue inside the @remix-run/react package

* fix type issue on move-to-participants

* Updated all packages and fixed almost all typescript compilation errors
Two compilation errors could not yet be fixed:
- @remix-run/web-fetch still throws a compilation error concerning the Headers type (Known issue to remix developers: remix-run/remix#7067)
- @testing-library/cypress/types throws a compilation error. Did not yet look into it but may be caused by conflicting globals of cypress and jest.

Apart of the compilation errors the app throws an error on build time concerning the use of commonJS syntax (SyntaxError: Cannot use import statement outside a module). Thats a tricky one and ive not found a solution yet.
Resources:
- remix-run/remix#4234
- remix-run/remix#4309
- https://community.fly.io/t/cannot-use-import-statement-outside-a-module/13533
- https://stackoverflow.com/questions/58384179/syntaxerror-cannot-use-import-statement-outside-a-module (Maybe unrelated)
- https://remix.run/docs/en/main/guides/gotchas (Maybe unrelated)

Last but not least, the tests are not running, too. Did not yet look into it deeply but it seems it also has something to do with the globals of cypress and jest that overlap. The error Messages point to jest-setup.ts installGlobals() call.

* fix: jest setup

The tests are now running (34 Failed, 21 Passed). It seems all tests that failed, did that because of importing remix-utils or date-fns-tz package.

* fix: tsc error inside testing-library package

Had to add "cypress" to types field of tsconfig to solve this issue.
See:
- remix-run/indie-stack#239
- https://docs.cypress.io/guides/tooling/typescript-support#Configure-tsconfigjson
- cypress-io/cypress#26930 (comment)

* fix: tsc error in common/api
* Update .nvmrc to version 20
* Use v1 route convention via package @remix-run/v1-route-convention

* Downgrade date-fns v3 to v2 as its still incompatible with date-fns-tz v2

see: marnusw/date-fns-tz#260

* fix: build error for import statements of package remix-utils
* Clean up remix.config.js
* Remove cypress
* fix: cjs errors in config files
* Transform .eslintrc.js from cjs to esm
* fix: failed to load eslint config

* Change node engine in package.json to >=16 as its needed for esm support
see https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

* Remove deprecated package remix-domains and use domain-functions
* Removed unused packages "remix-auth" and "remix-auth-supabase"
* fix: Error "imgproxy is not a constructor" fixed via serverDependencyBundling in remix.config.js
* Add entry.server functionality from remix docs and fix npm start script
* Write test specification
* fix: zod.enum() field does not set the value on remix-forms, use z.string() instead
* fix: session must be set before update password on set-password.tsx
* write test specifications for reset/confirm-password.tsx

* fix: set-password action could not set new session and update password in the same action

used the adminAuthClient in combination with refreshSession to make this possible

* update set-password test specification to fit new behaviour
* Update test specification for register/verify.tsx
* Replace deprecated npm package "piwik-tracker" with the new one "matomo-tracker"

* breaking change: createServerClient() moved from "@supabase/remix-auth-helpers" to "@subase/ssr"

In this commit i updated the createAuthClient() method. Sadly i had to change every route where the authClient is used...

The auth flow has also changed and will be implemented in the next commits.

As i already touched so much files i also made eslint a little happier by resolving eslint errors (mostly const instead of let)

* breaking change: rework login and logout due to new createServerClient from "@supbase/ssr"
* Use root response headers to refresh the session instead of every single route
* Use tsx to execute scripts instead of ts-node which supports esm only
* replace deprecated functions from faker inside seed script
* set up local supabase for new pkce flow
* Add login_redirect param to supabase templates
* fix: login redirect not working with the new template structure
* implement new reset password flow
* add new confirm route
* breaking change: use useBlocker() instead of usePrompt() to alert on discarding changes on settings
* fix: drop down behind main content

* feat: replace imgproxy
- use own implementation
- remove imgproxy-node

* fix: count up throws error
* fix: imgproxy returns forbidden
* feat: i18n (next) (#1254)
* fix: __dirname is not defined in ES module scope
* feat: update tailwindcss
* fix: Add missing error message on failed login (#1252)
* feat: extend event data on api next (#1257)

* fix: Unable to compile TypeScript
Try `npm i --save-dev @types/matomo-tracker` if it exists or add a new declaration (.d.ts) file containing `declare module 'matomo-tracker';

* extend events with responsible orgs and counts
* feat: add direct url to prisma (#1259)
* fix: optimize queries on explore, search and detail pages (#1260)
* feat: integrate sentry (next) (#1262)
* feat: Improve bootstrap doc (next) (#1250)
* fix: some placeholder text in readme
* fix: entry.client.tsx process is not defined (#1264)
* fix: Text content did not match (Hydration Error) (#1267)
* feat: welcome email after registration (#1268)
* feat: prevent scroll reset on several menus and tab bars (#1270)
* fix: missing label for organizationType select on organization settings (#1273)
* fix: typo on project settings web-social (#1275)
* fix: unable to deploy api (#1277)
* fix: API throws Invalid URL (#1282)
* fix: wrong click radius on nav bar menu logout button (#1280)

* Allow minor and patch updates for remix packages via "^<version>" inside package.json deps
* Rebuild package-lock.json
* fix: wrong click radius on nav bar menu logout button
* fix: missing line clamp on event cards on profile detail (#1283)
* fix: cannot read properties of undefined reading id on root (#1286)
* fix: i18n no cache seed breaks deployment (#1288)

---------

Co-authored-by: nac62116 <56918308+nac62116@users.noreply.github.com>
Co-authored-by: Achim Gosse <achim.gosse@digitalnoise.de>
Co-authored-by: Peter Holló <hello@songsforthe.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CT Issue related to component testing topic: typescript Triaged Issue has been routed to backlog. This is not a commitment to have it prioritized by the team.
Projects
None yet
Development

No branches or pull requests

5 participants