chore: upgrade lerna to 6, cache build step #26913

jordanpowell88 · 2023-06-01T19:49:17Z

Closes Upgrade Lerna to latest version #26798

Additional details

This PR does the following:

Upgrades Lerna from 5 => 6
Adds build as cacheable step

It allows for the build steps for the following packages to be cached locally and in the distributed cache (using Nx Cloud):

cypress (cli/)
@cypress/angular
create-cypress-tests
@cypress/schematic
@cypress/mount-utils
@cypress/react
@cypress/react18
@cypress/svelte
@cypress/vite-dev-server
@cypress/vite-plugin-cypress-esm
@cypress/vue
@cypress/vue2
@cypress/webpack-dev-server
@cypress/webpack-preprocessor
@packages/electron
@packages/errors
@packages/example
@packages/extension
@packages/icons
@packages/packherd-require
@packages/runner
@packages/telemetry
@packages/v8-snapshot-require
@tooling/electron-mksnapshot
@tooling/packherd
@tooling/v8-snapshot

Rationale

Most of the time when we work on the Cypress repo, we are only editing files in a few packages. If we've already built the source code for the other packages that we did not edit, then we shouldn't waste time and compute resources building all of those packages again.

We can use Lerna (using Nx under the hood) to cache builds when there have been no source code changes in the package. This way, when you run yarn or yarn build, Lerna only builds the packages that we haven't already built with that exact source code in the past.

As of right now we are being cautious to avoid accidental false positive cache hits, so we have configured Nx to invalidate the build cache for a package when any source files in the package change. In the future, and as we cache more steps, we should be able to fine-tune this so that we can exclude files that don't affect build outputs (*.md files, .eslintignore, etc.).

You can tell if Nx built your package from cache or not based on the output. To the right of the command, you will see some information in brackets like this

> @cypress/react18:build  [existing outputs match the cache, left as is]

This tells us that Nx did not actually build the @cypress/react18 package, but it pulled the build output from cache, because we've built @cypress/react18 with this exact source code before.

To better understand Nx features related to caching, you can read the following

Escape hatches

If you are building the Cypress monorepo and Nx is incorrectly pulling a build from cache, you can run the command with the --skip-nx-cache flag, or set NX_SKIP_NX_CACHE=true in your environment to force Nx to build everything from source and to ignore the cache. This normally should not happen, and if it does, then it means that we need to update the Nx configuration in the repo.

Going forward

We still have a bunch of packages that are built and tasks that are run using Gulp. These can't be orchestrated or cached by Nx. There are lots of performance gains to be made by moving these tasks out of Gulp and executing them via yarn scripts with Nx. In the future, we will slowly move these tasks out of Gulp and use Nx to orchestrate and cache them.

Steps to test

Run yarn locally on this branch. A lot of the packages that we build during the postinstall step should be taken from the remote cache if you haven't changed any code since CI has already built these packages and uploaded the results to Nx Cloud.

Make a change to the source code of a package from the list above, then run yarn again, and verify that the package was not built from cache but was actually built with your new source code changes.

How has the user experience changed?

n/a

PR Tasks

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

cypress · 2023-06-01T21:22:48Z

4 failed and 35 flaky tests on run #49712 ↗︎

4	27875	1347	0	35

Details:

Merge branch 'develop' into jordanpowell88/lerna-6
Project: cypress	Commit: `1e00362bf2`
Status: Errored	Duration: 23:34 💡
Started: Aug 10, 2023 3:12 PM	Ended: Aug 10, 2023 3:36 PM

user_agent_override.cy.ts • 1 failed test • 5x-driver-electron

View Output Video

Test		Artifacts
user agent override > persists modified user agent after cy.go		`Output` `Video`

commands/navigation.cy.ts • 1 failed test • 5x-driver-chrome

View Output Video

Test		Artifacts
cy.origin navigation > #consoleProps > .go()		`Output` `Video`

specs_list_latest_runs.cy.ts • 1 flaky test • app-e2e

View Output Video

Test		Artifacts
App/Cloud Integration - Latest runs and Average duration > when no runs are recorded > shows placeholders for all visible specs		`Output` `Screenshots` `Video`

cypress-in-cypress-component.cy.ts • 1 flaky test • app-e2e

View Output Video

Test		Artifacts
Cypress In Cypress CT > default config > redirects to the specs list with error if a spec is not found		`Output` `Screenshots` `Video`

cypress-origin-communicator.cy.ts • 1 flaky test • app-e2e

View Output Video

Test		Artifacts
Cypress In Cypress Origin Communicator > cy.origin passivity with app interactions > passes upon test reload mid test execution		`Output` `Screenshots` `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/commands/assertions.cy.ts • 1 flaky test • 5x-driver-firefox

View Output Video

Test		Artifacts
cy.origin assertions > #consoleProps > .should() and .and()		`Output`

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

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

lmiller1990 · 2023-08-01T02:54:51Z

Looks good, just need a rebase and one more +1.

jordanpowell88 · 2023-08-08T16:15:13Z

.circleci/workflows.yml

@@ -1913,7 +1914,7 @@ jobs:
      - restore_cached_workspace
      - run:
          name: Build
-          command: yarn workspace @cypress/webpack-preprocessor build
+          command: yarn lerna run build --scope @cypress/webpack-preprocessor


In order for these jobs to leverage caching we need to change them from yarn workspace commands to yarn lerna run commands

jordanpowell88 · 2023-08-08T16:26:55Z

cli/package.json

+    "targets": {
+      "build": {
+        "outputs": [
+          "{projectRoot}/types",


We have to specify these outputs because we generate /types in CI. By default, Nx looks in the following directories so deviations from those standards need to be specified.

jordanpowell88 · 2023-08-08T16:27:47Z

npm/angular/package.json

+          "{workspaceRoot}/scripts"
+        ],
+        "outputs": [
+          "{workspaceRoot}/cli/angular"


Because we copy these assets to the /cli directory we need to specify them here.

jordanpowell88 · 2023-08-08T16:30:46Z

npm/angular/package.json

+    "targets": {
+      "build": {
+        "inputs": [
+          "{workspaceRoot}/scripts"


We specify /scripts because we still rely upon many node scripts for handling building (amongst other things). Any changes to a script should invalidate this lib. Eventually we can become more targeted and stricter in the future but we want to be more conservative to start off

jordanpowell88 · 2023-08-08T16:31:49Z

npm/create-cypress-tests/package.json

@@ -23,14 +22,15 @@
    "commander": "6.2.1",
    "find-up": "5.0.0",
    "fs-extra": "^9.1.0",
-    "inquirer": "7.3.3",
+    "glob": "^7.1.6",
+    "inquirer": "8.2.4",


This is a required change as Lerna 6 depends upon [email protected]+

jordanpowell88 · 2023-08-08T16:33:05Z

npm/cypress-schematic/package.json

+    "targets": {
+      "build": {
+        "outputs": [
+          "{projectRoot}/src/**/*.js",


We have to specify these like this because we currently do not place build assets in an outDir and get placed next to the ts files

AtofStryker

Changeset looks good to me. Do we need to change the CONTRIBUTING guide to omit build-prod? https://github.com/cypress-io/cypress/blob/jordanpowell88/lerna-6/CONTRIBUTING.md#package-level-scripts

astone123 · 2023-08-09T21:44:35Z

@AtofStryker we could do that. I'm not sure why it's in there anyway, no one should be running build-prod during development. Although, I'm not sure if we need to update it

AtofStryker · 2023-08-09T21:47:57Z

@astone123 didn't we remove those build steps entirely though? It a) doesn't make sense why they are there and b) since we removed the steps, shouldn't we just update the contributing doc to remove them as well? otherwise the scripts would just fail, right?

astone123 · 2023-08-09T21:49:46Z

@AtofStryker no, there are still a few packages that use build-prod, so that script still exists. I just removed the ones that were

"build-prod": "yarn build"

because they were exactly the same and we can cache them if they're called as build instead

AtofStryker · 2023-08-09T21:53:32Z

@astone123 OK that makes sense. So in CI when we run the unit-tests build-prod will also call build as well to check the TS compilation or is that different now?

astone123 · 2023-08-09T21:55:36Z

@AtofStryker yeah that's right, I added a call to build here to make sure things are built correctly before we run the tests

AtofStryker

OK makes sense to me!

cypress-bot · 2023-08-15T20:16:12Z

Released in 12.17.4.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v12.17.4, please open a new issue.

jordanpowell88 requested a review from astone123 June 1, 2023 20:17

Base automatically changed from jordanpowell88/add-linting to develop June 2, 2023 20:47

jordanpowell88 marked this pull request as draft June 5, 2023 16:40

astone123 force-pushed the jordanpowell88/lerna-6 branch from 3447479 to 0ab0281 Compare July 27, 2023 20:29

astone123 marked this pull request as ready for review July 28, 2023 16:20

astone123 changed the title ~~chore: update lerna to 6~~ chore: upgrade lerna to 6 Jul 28, 2023

astone123 requested a review from lmiller1990 July 28, 2023 16:20

lmiller1990 approved these changes Aug 1, 2023

View reviewed changes

astone123 force-pushed the jordanpowell88/lerna-6 branch from 4da5978 to dc39d62 Compare August 3, 2023 16:40

astone123 changed the title ~~chore: upgrade lerna to 6~~ chore: upgrade lerna to 6, cache build step Aug 7, 2023

astone123 force-pushed the jordanpowell88/lerna-6 branch from 7dcf95b to 242e6db Compare August 7, 2023 19:24

jordanpowell88 commented Aug 8, 2023

View reviewed changes

astone123 requested a review from lmiller1990 August 8, 2023 18:14

astone123 approved these changes Aug 8, 2023

View reviewed changes

astone123 requested review from mjhenkes and AtofStryker August 8, 2023 20:22

jordanpowell88 and others added 7 commits August 9, 2023 11:14

chore: update build-npm-modules script

8e90764

chore: update build-npm-modules script

5fdf503

chore: update build-npm-modules script

2ae9834

chore: update build-npm-modules script

5c542b6

chore: update lerna to 6

52e8749

[run ci]

7a3e0c5

try caching build step

4ce8303

astone123 added 11 commits August 9, 2023 12:39

we can't clean without building after

a907650

add dependencies on scripts for npm packages

e4fa53c

update commands

0de66ba

add config for data-context build step

f6f248c

fix output configurations for npm packages, add gitignores

3187987

revert changes to config and data-context build steps

157ad39

fix outputs

63fb938

run with cache

81c4d6e

fix outputs for cli

6dec4a0

actually fix outputs

0c1fc8c

test with cache

c4d5aab

astone123 force-pushed the jordanpowell88/lerna-6 branch from 77a44be to c4d5aab Compare August 9, 2023 18:39

AtofStryker requested changes Aug 9, 2023

View reviewed changes

astone123 requested a review from AtofStryker August 9, 2023 21:53

AtofStryker approved these changes Aug 9, 2023

View reviewed changes

Merge branch 'develop' into jordanpowell88/lerna-6

1e00362

nagash77 merged commit 9e60aeb into develop Aug 10, 2023
2 of 3 checks passed

nagash77 deleted the jordanpowell88/lerna-6 branch August 10, 2023 15:12

cypress-bot bot locked as resolved and limited conversation to collaborators Aug 15, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: upgrade lerna to 6, cache build step #26913

chore: upgrade lerna to 6, cache build step #26913

jordanpowell88 commented Jun 1, 2023 •

edited by astone123

Loading

cypress bot commented Jun 1, 2023 •

edited

Loading

lmiller1990 commented Aug 1, 2023

jordanpowell88 Aug 8, 2023

jordanpowell88 Aug 8, 2023

jordanpowell88 Aug 8, 2023

jordanpowell88 Aug 8, 2023

jordanpowell88 Aug 8, 2023

jordanpowell88 Aug 8, 2023

AtofStryker left a comment

astone123 commented Aug 9, 2023 •

edited

Loading

AtofStryker commented Aug 9, 2023

astone123 commented Aug 9, 2023

AtofStryker commented Aug 9, 2023

astone123 commented Aug 9, 2023

AtofStryker left a comment

cypress-bot bot commented Aug 15, 2023

chore: upgrade lerna to 6, cache build step #26913

chore: upgrade lerna to 6, cache build step #26913

Conversation

jordanpowell88 commented Jun 1, 2023 • edited by astone123 Loading

Additional details

Rationale

Escape hatches

Going forward

Steps to test

How has the user experience changed?

PR Tasks

cypress bot commented Jun 1, 2023 • edited Loading

4 failed and 35 flaky tests on run #49712 ↗︎

lmiller1990 commented Aug 1, 2023

jordanpowell88 Aug 8, 2023

Choose a reason for hiding this comment

jordanpowell88 Aug 8, 2023

Choose a reason for hiding this comment

jordanpowell88 Aug 8, 2023

Choose a reason for hiding this comment

jordanpowell88 Aug 8, 2023

Choose a reason for hiding this comment

jordanpowell88 Aug 8, 2023

Choose a reason for hiding this comment

jordanpowell88 Aug 8, 2023

Choose a reason for hiding this comment

AtofStryker left a comment

Choose a reason for hiding this comment

astone123 commented Aug 9, 2023 • edited Loading

AtofStryker commented Aug 9, 2023

astone123 commented Aug 9, 2023

AtofStryker commented Aug 9, 2023

astone123 commented Aug 9, 2023

AtofStryker left a comment

Choose a reason for hiding this comment

cypress-bot bot commented Aug 15, 2023

jordanpowell88 commented Jun 1, 2023 •

edited by astone123

Loading

cypress bot commented Jun 1, 2023 •

edited

Loading

astone123 commented Aug 9, 2023 •

edited

Loading