fix: Fix issues with Cypress.require() and TypeScript #25931

chrisbreiding · 2023-02-23T16:45:34Z

Closes Unable to use Cypress.require within cy.origin #25885

Additional details

The root of the fix is two-fold:

Moving the cy.origin() callback preprocessing into the child process, so it's the same as preprocessing the spec file itself.
Using the user-installed version of the typescript package instead of our own, which actually doesn't exist in the production build of Cypress. This is also the same way it works when preprocessing the spec file itself.

Steps to test

Set up a test project with a TypeScript spec file and use Cypress.require() within cy.origin():

describe('Some test', (): void => {
  it('should work', (): void => {
     cy.origin('https://example.com', (): void => {
        const test = Cypress.require('./test.js');
        cy.log('test', test);
     });
  });
});

How has the user experience changed?

PR Tasks

Have tests been added/updated?
[N/A] Has a PR for user-facing changes been opened in cypress-documentation?
[N/A] Have API changes been updated in the type definitions?

…s-require-typescript

…ypress-io/cypress into issue-25885-cypress-require-typescript

…s-require-typescript

… path

…s-require-typescript

cypress · 2023-02-28T14:00:57Z

27 flaky tests on run #44611 ↗︎

0	26874	1281	0	27

Details:

fix test
Project: cypress	Commit: `af35e9019e`
Status: Passed	Duration: 19:19 💡
Started: Mar 8, 2023 8:35 PM	Ended: Mar 8, 2023 8:54 PM

cypress/cypress.cy.js • 3 flaky tests • 5x-driver-electron

View Output Video

Test		Artifacts
... > correctly returns currentRetry		`Output` `Video`
... > correctly returns currentRetry		`Output` `Video`
... > correctly returns currentRetry		`Output` `Video`

commands/net_stubbing.cy.ts • 1 flaky test • 5x-driver-firefox

View Output Video

Test		Artifacts
network stubbing > intercepting request > can delay and throttle a StaticResponse		`Output`

e2e/origin/navigation.cy.ts • 1 flaky test • 5x-driver-firefox

View Output Video

Test		Artifacts
... > establishes foobar spec bridge		`Output`

cypress/cypress.cy.js • 3 flaky tests • 5x-driver-firefox

View Output Video

Test		Artifacts
... > correctly returns currentRetry		`Output`
... > correctly returns currentRetry		`Output`
... > correctly returns currentRetry		`Output`

create-from-component.cy.ts • 1 flaky test • app-e2e

View Output Video

Test		Artifacts
... > runs generated spec		`Output` `Screenshots` `Video`

The first 5 flaky specs are shown, see all 17 specs in Cypress Cloud.

_{This comment has been generated by cypress-bot as a result of this
project's GitHub integration settings.}

chrisbreiding · 2023-03-01T14:56:48Z

packages/server/lib/plugins/child/cross_origin.js

@@ -0,0 +1,67 @@
+const md5 = require('md5')


Moved this file into the child process. The main reason for the content changes are converting it from typescript to vanilla JS, since we currently don't have the processing set up for TS within the child process.

…s-require-typescript

chrisbreiding · 2023-03-03T14:30:24Z

packages/server/lib/plugins/child/run_plugins.js

@@ -14,6 +14,7 @@ const resolve = require('../../util/resolve')
 const browserLaunch = require('./browser_launch')


Most of the changes in here was just moving a couple methods around so that the order made a little more sense (to me at least) when I was updating the tests for this. The only thing I added were the lines referencing _process:cross:origin:callback.

chrisbreiding · 2023-03-03T14:33:04Z

packages/server/test/unit/plugins/child/run_plugins_spec.js

@@ -1,433 +1,278 @@
 require('../../../spec_helper')


All these tests had been skipped for over a year, so I unskipped them, fixed the existing ones, and added new ones for my changes to run_plugins.js. It doesn't have 100% test coverage of run_plugins.js (I didn't add tests for any functionality I didn't add or change), but it's a step in the right direction.

chrisbreiding · 2023-03-03T15:46:00Z

system-tests/projects/origin-dependencies/.gitignore

@@ -1 +0,0 @@
-!node_modules


This origin-dependencies project is no longer used by any system tests.

…s-require-typescript

chrisbreiding · 2023-03-03T15:56:24Z

packages/server/lib/plugins/child/cross_origin.js

+  const typescriptPath = resolve.typescript(projectRoot)
+  const webpackOptions = getFullWebpackOptions(file, typescriptPath)


This is the root of the fix. Instead of resolving typescript with our own, we get the path to it the same way we do for regular file preprocessing by finding the user's installed typescript.

mschile · 2023-03-03T16:26:27Z

cli/CHANGELOG.md

@@ -7,6 +7,10 @@ _Released 03/14/2023 (PENDING)_

 - It is now possible to control the number of connection attempts to the browser using the CYPRESS_CONNECT_RETRY_THRESHOLD Environment Variable. Learn more [here](https://docs.cypress.io/guides/references/advanced-installation#Environment-variables). Addressed in [#25848](https://github.com/cypress-io/cypress/pull/25848).

+**Bugfixes:**
+
+- Fixed an issue where using `Cypress.require()` would throw the error `Cannot find module 'typescript'`. Fixes [#25885](https://github.com/cypress-io/cypress/issues/25885).


Is this fixing a regression or did it never work?

It worked with regular require, but hasn't worked with Cypress.require() since it was re-released.

mjhenkes · 2023-03-03T18:49:45Z

npm/webpack-batteries-included-preprocessor/index.js


  options.webpackOptions = getDefaultWebpackOptions()

-  addTypeScriptConfig({ filePath }, options)
+  if (options.typescript) {


so the variable we want to check is typescript.options.typescript? Is there a better name for the top variable? Or could we get options directly passed in?

It wasn't quite typescript.options.typescript, but taking another look at this, I realized it had grown a little convoluted so I refactored it a bit in fa10505

…ypress-io/cypress into issue-25885-cypress-require-typescript

…s-require-typescript

chrisbreiding and others added 11 commits February 23, 2023 09:59

fix: make typescript a dependency instead of a devDependency [run ci]

5a39d85

Merge remote-tracking branch 'origin/develop' into issue-25885-cypres…

6f7ddaa

…s-require-typescript

chore: updating v8 snapshot cache

bda413b

chore: updating v8 snapshot cache

ab5e6ea

chore: updating v8 snapshot cache

10a58d5

Merge branch 'issue-25885-cypress-require-typescript' of github.com:c…

974ff30

…ypress-io/cypress into issue-25885-cypress-require-typescript

Merge remote-tracking branch 'origin/develop' into issue-25885-cypres…

a61a752

…s-require-typescript

revert dep change

7d77b28

fix: process origin callback in child process with correct typescript…

43ba9db

… path

Merge remote-tracking branch 'origin/develop' into issue-25885-cypres…

638aee9

…s-require-typescript

run ci

f931fb9

chrisbreiding added 6 commits February 28, 2023 09:05

add branch back to workflows [run ci]

ceb0805

return undefined instead of null [run ci]

4eb3c4b

fix [run ci]

08df049

uhhh send the project root [run ci]

452de15

add branch to artifact persistence [run ci]

4dee523

delete moved file

b162c6c

chrisbreiding commented Mar 1, 2023

View reviewed changes

chrisbreiding added 6 commits March 2, 2023 09:22

unskip and fix run_plugins spec

e15bf7c

add binary system test [run ci]

6495ecf

Merge remote-tracking branch 'origin/develop' into issue-25885-cypres…

11ceab7

…s-require-typescript

add changelog entry

cf608a6

add yarn.lock [run ci]

62f0d19

add date [run ci]

f3a1771

digitalgopnik mentioned this pull request Mar 3, 2023

Unable to use Cypress.require within cy.origin #25885

Closed

chrisbreiding commented Mar 3, 2023

View reviewed changes

chrisbreiding added 2 commits March 3, 2023 09:34

remove failed attempt at a system test

9d825d7

add unit tests to batteries included preprocessor [run ci]

ee4e142

chrisbreiding commented Mar 3, 2023

View reviewed changes

chrisbreiding added 2 commits March 3, 2023 10:48

Merge remote-tracking branch 'origin/develop' into issue-25885-cypres…

2bd68c9

…s-require-typescript

Update workflows.yml

bf4ef2f

chrisbreiding commented Mar 3, 2023

View reviewed changes

chrisbreiding marked this pull request as ready for review March 3, 2023 15:56

mschile reviewed Mar 3, 2023

View reviewed changes

mschile changed the title ~~fix: WIP - Fix issues with Cypress.require() and TypeScript~~ fix: Fix issues with Cypress.require() and TypeScript Mar 3, 2023

chore: updating v8 snapshot cache

749c388

mjhenkes reviewed Mar 3, 2023

View reviewed changes

mschile approved these changes Mar 3, 2023

View reviewed changes

cypress-bot[bot] and others added 5 commits March 3, 2023 19:13

chore: updating v8 snapshot cache

442aa3c

chore: updating v8 snapshot cache

21c9ca3

refactor getFullWebpackOptions

fa10505

Merge branch 'issue-25885-cypress-require-typescript' of github.com:c…

826b2a3

…ypress-io/cypress into issue-25885-cypress-require-typescript

Merge remote-tracking branch 'origin/develop' into issue-25885-cypres…

1fc6816

…s-require-typescript

mjhenkes approved these changes Mar 3, 2023

View reviewed changes

chrisbreiding and others added 6 commits March 7, 2023 09:47

Merge branch 'develop' into issue-25885-cypress-require-typescript

51c897c

revert snapshot meta changes

8d33891

no fancy syntax :P

b8ac30d

one more

5399345

see if this fixes integration spec timeout

1618d98

fix test

af35e90

chrisbreiding merged commit ed69f0b into develop Mar 8, 2023

chrisbreiding deleted the issue-25885-cypress-require-typescript branch March 8, 2023 21:25

mjhenkes mentioned this pull request Mar 9, 2023

In OIDC login, call back page doesn't load completely #26020

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Fix issues with Cypress.require() and TypeScript #25931

fix: Fix issues with Cypress.require() and TypeScript #25931

chrisbreiding commented Feb 23, 2023 •

edited

Loading

cypress bot commented Feb 28, 2023 •

edited

Loading

chrisbreiding Mar 1, 2023 •

edited

Loading

chrisbreiding Mar 3, 2023

chrisbreiding Mar 3, 2023 •

edited

Loading

chrisbreiding Mar 3, 2023

chrisbreiding Mar 3, 2023

mschile Mar 3, 2023

chrisbreiding Mar 3, 2023

mjhenkes Mar 3, 2023

chrisbreiding Mar 3, 2023

		@@ -14,6 +14,7 @@ const resolve = require('../../util/resolve')
		const browserLaunch = require('./browser_launch')

		const typescriptPath = resolve.typescript(projectRoot)
		const webpackOptions = getFullWebpackOptions(file, typescriptPath)

		@@ -1 +0,0 @@
		!node_modules

fix: Fix issues with Cypress.require() and TypeScript #25931

fix: Fix issues with Cypress.require() and TypeScript #25931

Conversation

chrisbreiding commented Feb 23, 2023 • edited Loading

Additional details

Steps to test

How has the user experience changed?

PR Tasks

cypress bot commented Feb 28, 2023 • edited Loading

27 flaky tests on run #44611 ↗︎

chrisbreiding Mar 1, 2023 • edited Loading

Choose a reason for hiding this comment

chrisbreiding Mar 3, 2023

Choose a reason for hiding this comment

chrisbreiding Mar 3, 2023 • edited Loading

Choose a reason for hiding this comment

chrisbreiding Mar 3, 2023

Choose a reason for hiding this comment

chrisbreiding Mar 3, 2023

Choose a reason for hiding this comment

mschile Mar 3, 2023

Choose a reason for hiding this comment

chrisbreiding Mar 3, 2023

Choose a reason for hiding this comment

mjhenkes Mar 3, 2023

Choose a reason for hiding this comment

chrisbreiding Mar 3, 2023

Choose a reason for hiding this comment

chrisbreiding commented Feb 23, 2023 •

edited

Loading

cypress bot commented Feb 28, 2023 •

edited

Loading

chrisbreiding Mar 1, 2023 •

edited

Loading

chrisbreiding Mar 3, 2023 •

edited

Loading