fix: discover CT community definitions in monorepos with hoisted dependencies #26066

astone123 · 2023-03-09T14:14:37Z

Closes Cypress does not resolve CT Framework Definition in monorepo with hoisted node_modules #25993

Additional details

Right now when we detect CT community framework modules during the Launchpad setup, we only check the projectRoot node_modules/ and then return. This doesn't work if you have a monorepo that hoists dependencies to the repository root.

This PR adds logic to search from the project root to the repository root for community framework modules and return all of the ones that are found.

We use a variety of methods to determine whether or not we've found the repository root:

Looking for platform-specific configuration files (eg lerna.json, nx.json, etc)
Looking for a .git/ directory (meaning that Git has been configured at this level, indicating a repository root)
package.json having a workspace entry in it

This isn't a fool-proof way of determining the repository root but it should work for most projects. I basically copied what Vite does https://github.com/vitejs/vite/blob/0f6de4dcff783ec21fada47651d564cd5e2631b2/packages/vite/src/node/server/searchRoot.ts#L59

Steps to test

Use a monorepo, eg https://github.com/lmiller1990/ct-monorepo-bug

yarn install
notice @lmiller1990/cypress-ct-solid-js is in the root node_modules
cd packages/foo
open yarn in global mode yarn cypress:open
open ct-monorepo-bug/packages/foo in Cypress
select CT
verify that Solid shows up in the list as a community framework

How has the user experience changed?

PR Tasks

Have tests been added/updated? - I'm still working on this, will add another test for automatically testing monorepo support
[na] Has a PR for user-facing changes been opened in cypress-documentation?
[na] Have API changes been updated in the type definitions?

…-io/cypress into launchpad-dep-resolution-exports

…pendencies

…-party-monorepo-resolution

astone123 · 2023-03-09T14:18:45Z

I still need to add a test to automatically verify that we will find third party dependencies for monorepos, but I'm looking for some feedback in the mean time

cypress · 2023-03-09T14:54:51Z

6 flaky tests on run #44729 ↗︎

0	4301	889	0	6

Details:

fix paths for windows
Project: cypress	Commit: `b172a098ed`
Status: Passed	Duration: 15:33 💡
Started: Mar 14, 2023 11:57 AM	Ended: Mar 14, 2023 12:12 PM

commands/net_stubbing.cy.ts • 3 flaky tests • 5x-driver-webkit

View Output Video

Test		Artifacts
network stubbing > intercepting request > can delay and throttle a StaticResponse		`Output` `Video`
... > with `times` > only uses each handler N times		`Output` `Video`
... > stops waiting when an xhr request is canceled		`Output` `Video`

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

View Output Video

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

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

lmiller1990 · 2023-03-09T22:52:09Z

packages/scaffold-config/src/ct-detect-third-party.ts

@@ -25,6 +26,46 @@ const thirdPartyDefinitionPrefixes = {
  globalPrefix: 'cypress-ct-',
 }

+const ROOT_PATHS = [


Nit... should this be ROOT_FILES?

I used the term paths because some of them are directories and some are files, for example .git is a directory.

packages/scaffold-config/test/unit/ct-detect-third-party.spec.ts

lmiller1990 · 2023-03-09T22:55:56Z

packages/scaffold-config/src/ct-detect-third-party.ts

+
+      packageJsonPaths = [...packageJsonPaths, ...newPackagePaths]
+
+      const isCurrentRepositoryRoot = await isRepositoryRoot(directory)


I can give this PR a test later, but definitely will be good to see some tests around this full functionality (whether it's Cy-in-Cy, or just an elaborate unit/integration test in this package).

I added a unit test in this package, let me know what you think

lmiller1990

Tested it out, seems to be working as expected for the minimal reproduction.

Also, might be a good chance to make a little OSS module like find-project-root or something -- what do you think? Seems like something that'd be pretty useful.

marktnoonan

Testing this went fine @astone123, I see you have a few open comments from @lmiller1990 so feel free to tag me for re-review

…-party-monorepo-resolution

astone123 · 2023-03-13T23:51:57Z

packages/frontend-shared/cypress/e2e/e2ePluginSetup.ts

@@ -404,7 +404,15 @@ async function makeE2ETasks () {
      }
    },
    async __internal_openProject ({ argv, projectName }: InternalOpenProjectArgs): Promise<ResetOptionsResult> {
-      if (!scaffoldedProjects.has(projectName)) {
+      let projectMatched = false


Had to re-work this in order to call cy.openProject with a directory inside of a project like <projectName>/packages/foo to test monorepos

Shame we lose the auto completion :(

Let's do it for now, but I wonder if we can find a way to keep the completion 🤔

astone123 · 2023-03-13T23:52:23Z

packages/frontend-shared/cypress/support/e2e.ts

@@ -235,8 +235,10 @@ function openGlobalMode (options: OpenGlobalModeOptions = {}) {
  })
 }

-function openProject (projectName: ProjectFixtureDir, argv: string[] = []) {
-  if (!fixtureDirs.includes(projectName)) {
+type WithPrefix<T extends string> = `${T}${string}`;


Same here, this allows us to open Cypress from within a project to support monorepo testing

lmiller1990

Looks good, quick commit since I think this will break windows CI without path.join b172a09

lmiller1990 · 2023-03-14T10:42:06Z

packages/frontend-shared/cypress/e2e/e2ePluginSetup.ts

@@ -404,7 +404,15 @@ async function makeE2ETasks () {
      }
    },
    async __internal_openProject ({ argv, projectName }: InternalOpenProjectArgs): Promise<ResetOptionsResult> {
-      if (!scaffoldedProjects.has(projectName)) {
+      let projectMatched = false


Shame we lose the auto completion :(

Let's do it for now, but I wonder if we can find a way to keep the completion 🤔

lmiller1990 · 2023-03-14T10:43:02Z

packages/launchpad/cypress/e2e/scaffold-component-testing.cy.ts

+
+    it('Scaffolds component testing for monorepos with hoisted dependencies', () => {
+      cy.scaffoldProject('ct-monorepo-unconfigured')
+      cy.openProject('ct-monorepo-unconfigured/packages/foo')


Random idea to keep the autocompletion on the project name:

cy.openProject('ct-monorepo-unconfigured', { package: 'packages/foo' })

astone123 added 22 commits March 6, 2023 14:40

WIP find a way to resolve dependencies that does not rely on exports

00fa9f4

use resolvePackagePath package

6b4ff05

revert schema changes

1b7f578

something is going on with Percy

4c60b60

remove loc

5bffe16

Merge branch 'develop' into launchpad-dep-resolution-exports

8dcef02

feedback

c2dbdce

Merge branch 'launchpad-dep-resolution-exports' of github.com:cypress…

21c8f71

…-io/cypress into launchpad-dep-resolution-exports

upgrade vite react plugin

d95d3e5

update yarn lock

ac054d1

Merge branch 'develop' into launchpad-dep-resolution-exports

da65e43

fix unit test

98a10d6

Merge branch 'launchpad-dep-resolution-exports' of github.com:cypress…

59f89ca

…-io/cypress into launchpad-dep-resolution-exports

chore: discover CT community definitions in monorepos with hoisted de…

a9ca93c

…pendencies

[run ci]

7403bd2

use find-up v5 because cjs

5897943

delete solid yarn lock [run ci]

2fcde94

improve repo root detection [run ci]

ac1373e

Merge branch 'develop' of github.com:cypress-io/cypress into ct-third…

c43348e

…-party-monorepo-resolution

[run ci]

bd15692

add some unit tests

9449b10

update comments

eba120d

astone123 requested review from warrensplayer, jordanpowell88, marktnoonan, mike-plummer and lmiller1990 March 9, 2023 14:14

astone123 self-assigned this Mar 9, 2023

update links

e669582

lmiller1990 reviewed Mar 9, 2023

View reviewed changes

lmiller1990 reviewed Mar 10, 2023

View reviewed changes

use os.tmpdir

d1ea474

marktnoonan reviewed Mar 13, 2023

View reviewed changes

add test for monorepo third-party dependency resolution

541098c

marktnoonan approved these changes Mar 13, 2023

View reviewed changes

astone123 added 2 commits March 13, 2023 13:20

Merge branch 'develop' of github.com:cypress-io/cypress into ct-third…

371efb2

…-party-monorepo-resolution

add changelog entry

43792f5

astone123 changed the title ~~chore: discover CT community definitions in monorepos with hoisted dependencies~~ fix: discover CT community definitions in monorepos with hoisted dependencies Mar 13, 2023

add e2e test

b6acb62

astone123 commented Mar 13, 2023

View reviewed changes

astone123 requested a review from lmiller1990 March 13, 2023 23:52

fix paths for windows

b172a09

lmiller1990 approved these changes Mar 14, 2023

View reviewed changes

lmiller1990 merged commit cacdb1d into develop Mar 14, 2023

lmiller1990 deleted the ct-third-party-monorepo-resolution branch March 14, 2023 12:13

marktnoonan mentioned this pull request May 9, 2023

CT onboarding hangs waiting for dependency installation #26685

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: discover CT community definitions in monorepos with hoisted dependencies #26066

fix: discover CT community definitions in monorepos with hoisted dependencies #26066

astone123 commented Mar 9, 2023 •

edited

Loading

astone123 commented Mar 9, 2023

cypress bot commented Mar 9, 2023 •

edited

Loading

lmiller1990 Mar 9, 2023

astone123 Mar 9, 2023

lmiller1990 Mar 9, 2023

astone123 Mar 13, 2023

lmiller1990 left a comment

marktnoonan left a comment

astone123 Mar 13, 2023

lmiller1990 Mar 14, 2023

astone123 Mar 13, 2023

lmiller1990 left a comment

lmiller1990 Mar 14, 2023

lmiller1990 Mar 14, 2023


		packageJsonPaths = [...packageJsonPaths, ...newPackagePaths]

		const isCurrentRepositoryRoot = await isRepositoryRoot(directory)

fix: discover CT community definitions in monorepos with hoisted dependencies #26066

fix: discover CT community definitions in monorepos with hoisted dependencies #26066

Conversation

astone123 commented Mar 9, 2023 • edited Loading

Additional details

Steps to test

How has the user experience changed?

PR Tasks

astone123 commented Mar 9, 2023

cypress bot commented Mar 9, 2023 • edited Loading

6 flaky tests on run #44729 ↗︎

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lmiller1990 left a comment

Choose a reason for hiding this comment

marktnoonan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lmiller1990 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

astone123 commented Mar 9, 2023 •

edited

Loading

cypress bot commented Mar 9, 2023 •

edited

Loading