Cacie/chore/upgrade electron 27

.circleci/cache-version.txt

@@ -1,3 +1,3 @@
 # Bump this version to force CI to re-create the cache from scratch.
 
-11-20-23
+12-15-23

.circleci/workflows.yml

@@ -32,6 +32,7 @@ mainBuildFilters: &mainBuildFilters
         - 'feature/experimental-retries'
         - 'publish-binary'
         - 'em/shallow-checkout'
+        - 'cacie/chore/upgrade-electron-27'
 
 # usually we don't build Mac app - it takes a long time
 # but sometimes we want to really confirm we are doing the right thing
@@ -45,6 +46,7 @@ macWorkflowFilters: &darwin-workflow-filters
     - equal: [ 'feature/experimental-retries', << pipeline.git.branch >> ]
     - equal: [ 'chore/update_webpack_deps_to_latest_webpack4_compat', << pipeline.git.branch >> ]
     - equal: [ 'lerna-optimize-tasks', << pipeline.git.branch >> ]
+    - equal: [ 'cacie/chore/upgrade-electron-27', << pipeline.git.branch >> ]
     - matches:
         pattern: /^release\/\d+\.\d+\.\d+$/
         value: << pipeline.git.branch >>
@@ -59,6 +61,7 @@ linuxArm64WorkflowFilters: &linux-arm64-workflow-filters
     - equal: [ 'chore/update_webpack_deps_to_latest_webpack4_compat', << pipeline.git.branch >> ]
     - equal: [ 'chore/bump_loaders_and_optimize_webpack', << pipeline.git.branch >> ]
     - equal: [ 'lerna-optimize-tasks', << pipeline.git.branch >> ]
+    - equal: [ 'cacie/chore/upgrade-electron-27', << pipeline.git.branch >> ]
     - matches:
         pattern: /^release\/\d+\.\d+\.\d+$/
         value: << pipeline.git.branch >>
@@ -86,6 +89,7 @@ windowsWorkflowFilters: &windows-workflow-filters
     - equal: [ 'lerna-optimize-tasks', << pipeline.git.branch >> ]
     - equal: [ 'em/shallow-checkout', << pipeline.git.branch >> ]
     - equal: [ 'mschile/mochaEvents_win_sep', << pipeline.git.branch >> ]
+    - equal: [ 'cacie/chore/upgrade-electron-27', << pipeline.git.branch >> ]
     - matches:
         pattern: /^release\/\d+\.\d+\.\d+$/
         value: << pipeline.git.branch >>
@@ -94,7 +98,7 @@ executors:
   # the Docker image with Cypress dependencies and Chrome browser
   cy-doc:
     docker:
-      - image: cypress/browsers-internal:node18.15.0-chrome114-ff115
+      - image: cypress/browsers-internal:node18.17.0-chrome118-ff115
     # by default, we use "medium" to balance performance + CI costs. bump or reduce on a per-job basis if needed.
     resource_class: medium
     environment:
@@ -104,7 +108,7 @@ executors:
   # Docker image with non-root "node" user
   non-root-docker-user:
     docker:
-      - image: cypress/browsers-internal:node18.15.0-chrome114-ff115
+      - image: cypress/browsers-internal:node18.17.0-chrome118-ff115
         user: node
     environment:
       PLATFORM: linux
@@ -557,7 +561,7 @@ commands:
             if [[ ! -f better_sqlite3.node ]]; then
               docker run -d --name centos7-builder centos7-builder /bin/bash -c "sleep 1000000000"
               docker cp ~/cypress/node_modules/better-sqlite3 centos7-builder:/better-sqlite3
-              docker exec -it centos7-builder /bin/bash -c "cd /better-sqlite3 && source /root/.bashrc && chown -R root:root . && npm install --ignore-scripts && npx --no-install prebuild -r electron -t 25.0.0 --include-regex 'better_sqlite3.node$'"
+              docker exec -it centos7-builder /bin/bash -c "cd /better-sqlite3 && source /root/.bashrc && chown -R root:root . && npm install --ignore-scripts && npx --no-install prebuild -r electron -t 27.0.0 --include-regex 'better_sqlite3.node$'"
               docker cp centos7-builder:/better-sqlite3/build/Release/better_sqlite3.node ~/cypress/node_modules/better-sqlite3/build/Release/better_sqlite3.node
               docker rm -f centos7-builder
               cp ~/cypress/node_modules/better-sqlite3/build/Release/better_sqlite3.node ~/cypress/better_sqlite3.node
@@ -2342,7 +2346,7 @@ jobs:
     <<: *defaults
     resource_class: small
     docker:
-      - image: cypress/base-internal:18.15.0
+      - image: cypress/base-internal:18.17.0
     steps:
       - maybe_skip_binary_jobs
       - restore_workspace_binaries

.github/ISSUE_TEMPLATE/1-bug-report.yml

@@ -43,7 +43,7 @@ body:
     attributes:
       label: Node version
       description: What version of node.js are you using to run Cypress?
-      placeholder: ex. v18.15.0
+      placeholder: ex. v18.17.0
     validations:
       required: true
   - type: input

.github/ISSUE_TEMPLATE/2-memory-issue.yml

@@ -51,7 +51,7 @@ body:
     attributes:
       label: Node version
       description: What version of node.js are you using to run Cypress?
-      placeholder: ex. v18.15.0
+      placeholder: ex. v18.17.0
     validations:
       required: true
   - type: input

.github/ISSUE_TEMPLATE/3-install-issue.yml

@@ -38,7 +38,7 @@ body:
     attributes:
       label: Node version
       description: What version of node.js are you using to run Cypress?
-      placeholder: ex. v18.15.0
+      placeholder: ex. v18.17.0
     validations:
       required: true
   - type: dropdown

.github/workflows/update_v8_snapshot_cache.yml

@@ -48,6 +48,9 @@ jobs:
       - name: Determine snapshot files - Mac
         if: ${{ matrix.platform == 'macos-latest' }}
         run: echo "SNAPSHOT_FILES='tooling/v8-snapshot/cache/darwin/snapshot-meta.json'" >> $GITHUB_ENV
+      - name: Install setuptools - Mac
+        if: ${{ matrix.platform == 'macos-latest' }}
+        run: sudo -H pip install setuptools
       - name: Checkout
         uses: actions/checkout@v3
         with:

.node-version

@@ -1 +1 @@
-18.15.0
+18.17.1

centos7-builder.Dockerfile

@@ -1,5 +1,5 @@
 FROM centos:7
-# Install dependencies for re-building better-sqlite and setting devtoolset-8 as the default compiler
+# Install dependencies for re-building better-sqlite and setting devtoolset-8 as the default compiler.
 RUN yum -y install centos-release-scl curl python3 make atk-devel atk java-atk-wrapper at-spi2-atk gtk3 libXt libdrm mesa-libgbm Xvfb && yum -y install devtoolset-8-gcc devtoolset-8-gcc-c++
 RUN echo >> /etc/profile.d/devtoolset-8.sh 'source scl_source enable devtoolset-8'
 RUN curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash

cli/CHANGELOG.md

@@ -1,5 +1,5 @@
 <!-- See the ../guides/writing-the-cypress-changelog.md for details on writing the changelog. -->
-## 13.6.2
+## 13.7.0
 
 _Released 12/19/2023 (PENDING)_
 
@@ -13,6 +13,12 @@ _Released 12/19/2023 (PENDING)_
 
 - Updated ts-node from `10.9.1` to `10.9.2`. Fixed in [#28528](https://github.com/cypress-io/cypress/pull/28528).
 
+**Misc:**
+
+- Upgraded `electron` from `25.8.4` to `26.6.2`
+- Upgraded bundled Node.js version from `18.15.0` to `18.17.0`
+- Upraded bundled Chromium version from `114.0.5735.289` to `116.0.5845.228`
+
 ## 13.6.1
 
 _Released 12/5/2023_

docker-compose.yml

@@ -33,7 +33,7 @@ services:
       - .:/opt/cypress
   ci:
     # This should mirror the image used in workflows.yml
-    image: cypress/browsers-internal:node18.15.0-chrome114-ff115
+    image: cypress/browsers-internal:node18.17.0-chrome118-ff115
     ports:
       - 5566:5566
       - 5567:5567

package.json

@@ -145,7 +145,7 @@
     "dedent": "^0.7.0",
     "del": "3.0.0",
     "detect-port": "^1.3.0",
-    "electron": "25.8.4",
+    "electron": "27.1.3",
     "electron-builder": "^23.6.0",
     "enzyme-adapter-react-16": "1.12.1",
     "eslint": "7.22.0",
@@ -212,7 +212,7 @@
     "yarn-deduplicate": "3.1.0"
   },
   "engines": {
-    "node": ">=18.15.0",
+    "node": ">=18.17.0",
     "yarn": ">=1.17.3"
   },
   "productName": "Cypress",

packages/app/cypress/component/support/index.ts

@@ -49,5 +49,5 @@ registerMountFn({ plugins: [() => createRouter(), () => pinia] })
 
 installCustomPercyCommand()
 
-Cypress.on('uncaught:exception', (err) => !err.message.includes('ResizeObserver loop limit exceeded'))
+Cypress.on('uncaught:exception', (err) => !err.message.includes('ResizeObserver loop completed with undelivered notifications.'))
 Cypress.Commands.add('tabUntil', tabUntil)

packages/driver/cypress/e2e/issues/1244.cy.js

@@ -70,7 +70,7 @@ describe('issue 1244', () => {
     })
 
     // TODO: fix flaky test
-    it('does not strip link _parent', { retries: 15 }, () => {
+    it('does not strip link _parent', { retries: 5 }, () => {
       cy.get('iframe').then(($iframe) => {
         const $el = $iframe.contents().find('a.inline_parent')
 

packages/electron/README.md

@@ -36,7 +36,7 @@ Upgrading `electron` involves more than just bumping this package's `package.jso
     - the major version number of Node.js changes, since users rely on the bundled Node.js to load plugins and `.js` fixtures, or
     - there are changes to Electron that require new shared libraries to be installed on Linux, breaking existing CI setups, or
     - there is some other change that would break existing usage of Cypress (for example, a Web API feature being removed/added to the bundled Chromium)
-- [ ] **Create and publish Docker `base-internal` and `browsers-internal` family images matching the Node.js and Chromium versions in Electron.** These images live inside the [`cypress-docker-images`](https://github.com/cypress-io/cypress-docker-images/) repository. The `browsers-internal` image will be used inside our CI pipelines. The `base-internal` image will be used by the `browsers-internal` image and possibly other system images (described below). For general use of Cypress in Docker, we encourage the use of the [Cypress Docker Factory](https://github.com/cypress-io/cypress-docker-images#cypressfactory). This works great for using Cypress as an end user, but doesn't fully suit the needs for developing Cypress, as we require: 
+- [ ] **Create and publish Docker `base-internal` and `browsers-internal` family images matching the Node.js and Chromium versions in Electron.** These images live inside the [`cypress-docker-images`](https://github.com/cypress-io/cypress-docker-images/) repository. The `browsers-internal` image will be used inside our CI pipelines. The `base-internal` image will be used by the `browsers-internal` image and possibly other system images (described below). The Chromium version can be determined from the [DEPS](https://github.com/electron/electron/blob/main/DEPS) file in Electron's repository on the correct tag. The Node version can be determined from the [Electron Releases page](https://www.electronjs.org/docs/latest/tutorial/electron-timelines). For general use of Cypress in Docker, we encourage the use of the [Cypress Docker Factory](https://github.com/cypress-io/cypress-docker-images#cypressfactory). This works great for using Cypress as an end user, but doesn't fully suit the needs for developing Cypress, as we require: 
     - The installation of packages, such as `curl`, `xauth`, and `build-essential`/`make` needed for our [`circleci`](../../.circleci/config.yml) jobs/pipelines.
     - Specific images targeted to test Cypress on various node versions and distributions of linux, such as different versions of `ubuntu`.
 
@@ -45,19 +45,44 @@ Upgrading `electron` involves more than just bumping this package's `package.jso
     - The Ubuntu images in [base-internal](https://github.com/cypress-io/cypress-docker-images/tree/master/base-internal) are updated to be used in the [system binary tests](../../system-tests/test-binary) if any of the following are true for the images used inside the system binary tests:
       - The last two major [Ubuntu LTS Releases](https://ubuntu.com/about/release-cycle) are out-of-date.
       - The [NodeJS](https://nodejs.org/en) version is not the active LTS.
+- [ ] **Update `workflows.yml`**
+    - [ ] Ensure it references the new `base-internal` and `browsers-internal` Docker images
+    - [ ] Ensure the new Electron version is used as a build target in the `Build better-sqlite3 for CentOS 7` step
+    - [ ]
 
 - [ ] **Ensure that a matching Node.js version is enforced in the monorepo for local development and CI.** When Electron is upgraded, oftentimes, the bundled Node.js version that comes with Electron is updated as well. Because all unit and integration tests run in normal Node.js (not Electron's Node.js), it's important for this Node.js version to be synced with the monorepo. There are a few places where this needs to be done:
     - [ ] [`/.node-version`](../../.node-version) - used by `nvm` and other Node version managers
     - [ ] `@types/node` used throughout the monorepo to determine compatible node types. The major version of this package must reflect the node version set in [`/.node-version`](../../.node-version).
     - [ ] [github workflows](../../.github) - used for repository templates, vulnerability detection, and V8 snapshots. If the node version for Snyk needs to be updated, then the required pull request check into `develop` must also be updated. A repository administrator will need to accomplish this.
     - [ ] [`/package.json`](../../package.json) - update `engines`
-    - [ ] [`/scripts/run-docker-local.sh`](../../scripts/run-docker-local.sh) - update Docker image to the new matching `browsers` image
+    - [ ] [`docker-compose.yml`](../../docker-compose.yml) - update Docker image to the new matching `browsers` image
     - [ ] [`/system-tests/test-binary/*`](../../system-tests/test-binary) - update binary system tests to use the newly published Ubuntu and Node images mentioned above, if applicable
     - [ ] [`/.circleci/config.yml`](../../.circleci/config.yml)
         - Update the Docker `image`s to the new matching `browsers` image.
         - Update the `xcode` version to one with the same major Node.js version bundled. There is usually not an exact match, this is ok as long as the major version number as the same.
-    - [ ] Do a global search for the old Node.js version to identify any new areas that may need updating/unification, and update those locations (and this document!)
+    - [ ] Do a global search for the old Node.js version to identify any new areas that may need updating/unification, and update those locations (and this document!)  
+
+- [ ] For **binary publishing**, make sure the `electron` version that we updated in [`/package.json`](../../package.json) matches the `electron` version inside the [publish binary project](https://github.com/cypress-io/cypress-publish-binary/blob/main/package.json). This is to make sure add-on tests inside the publish-binary repository work locally, but are not required to install the correct version of `electron` in CI when publishing the binary. Ensure the electron target in this project's .circleci configuration is updated as well. Set the target branch on that project as a `branch` property on the request body in [../../scripts/binary/trigger-publish-binary-pipeline.js](../../scripts/binary/trigger-publish-binary-pipeline.js) script, so that you can test in CI. Remove this before merging, and ensure that branch is merged as well.
+
+
 - [ ] **Manually smoke test `cypress open`.** Upgrading Electron can break the `desktop-gui` in unexpected ways. Since testing in this area is weak, double-check that things like launching `cypress open`, signing into Cypress Cloud, and launching Electron tests still work.
+- [] **Manually smoke test `cypress run` in record mode** Upgrading Electron can cause `better-sqlite3` to SIGSEGV the Electron process.
 - [ ] **Fix failing tests.** Usually, these are due to breaking changes in either Node.js or Electron. Check the changelogs of both to find relevant changes.
-- [ ] For **binary publishing**, make sure the `electron` version that we updated in [`/package.json`](../../package.json) matches the `electron` version inside the [publish binary project](https://github.com/cypress-io/cypress-publish-binary/blob/main/package.json). This is to make sure add-on tests inside the publish-binary repository work locally, but are not required to install the correct version of `electron` in CI when publishing the binary.
-- [ ] If needed, update the **[V8 Snapshot Cache](https://github.com/cypress-io/cypress/actions/workflows/update_v8_snapshot_cache.yml)** by running the workflow. Make sure to use the branch that contains the electron updates to populate the `'workflow from'` and `'branch to update'` arguments. Select `'Generate from scratch'` and `'commit directly to branch'`. This will usually take 6-8 hours to complete and is best to not be actively developing on the branch when this workflow runs.
+
+- [ ] If needed, update the **[V8 Snapshot Cache](https://github.com/cypress-io/cypress/actions/workflows/update_v8_snapshot_cache.yml)** by running the GitHub workflow. Make sure to use the branch that contains the electron updates to populate the `'workflow from'` and `'branch to update'` arguments. Select `'Generate from scratch'` and `'commit directly to branch'`. This will usually take 6-8 hours to complete and is best to not be actively developing on the branch when this workflow runs.
+
+
+### Common Upgrade Issues
+
+#### Integrity Check Failures
+
+*Solution*: Update the string representation of `fs.readFileSync` in [scripts/binary/binary-integrity-check-source.js](../../scripts/binary/binary-integrity-check-source.js) to match the string generated by the new version of electron. Create a throw-away script and simply `console.log(fs.readFileSync.toString())`, and execute it with *Electron* rather than *Node*.
+
+#### ResizeObserver errors in Component Test
+
+*Solution*: This error is benign. From time to time, the error message we match against in order to swallow the error changes. Update the necessary support files with the new error message.
+
+#### Electron crashes immediately after initializing the Protocol database
+
+*Solution*: ???
+

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

@@ -82,7 +82,7 @@ function validateWithinViewport (subject: JQuery<HTMLElement>): Cypress.Chainabl
 
 Cypress.Commands.add('validateWithinViewport', { prevSubject: true }, validateWithinViewport)
 
-Cypress.on('uncaught:exception', (err) => !err.message.includes('ResizeObserver loop limit exceeded'))
+Cypress.on('uncaught:exception', (err) => !err.message.includes('ResizeObserver loop completed with undelivered notifications.'))
 
 registerMountFn()
 addVueCommand()

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

@@ -536,7 +536,7 @@ function getAutIframe () {
   return cy.get('iframe.aut-iframe').its('0.contentDocument.documentElement').then(cy.wrap) as Cypress.Chainable<JQuery<HTMLIFrameElement>>
 }
 
-Cypress.on('uncaught:exception', (err) => !err.message.includes('ResizeObserver loop limit exceeded'))
+Cypress.on('uncaught:exception', (err) => !err.message.includes('ResizeObserver loop completed with undelivered notifications.'))
 
 Cypress.Commands.add('scaffoldProject', scaffoldProject)
 

packages/server/lib/cloud/protocol.ts

@@ -168,7 +168,7 @@ export class ProtocolManager implements ProtocolManagerShape {
     debug('connecting to database at %s', dbPath)
 
     const db = Database(dbPath, {
-      nativeBinding: path.join(require.resolve('better-sqlite3/build/Release/better_sqlite3.node')),
+      nativeBinding: require.resolve(path.join('better-sqlite3', 'build', 'Release', 'better_sqlite3.node')),
       verbose: debugVerbose,
     })
 

scripts/binary/binary-cleanup.js

@@ -5,6 +5,7 @@ const del = require('del')
 const esbuild = require('esbuild')
 const tempDir = require('temp-dir')
 const workingDir = path.join(tempDir, 'binary-cleanup-workdir')
+const v8 = require('v8')
 
 fs.ensureDirSync(workingDir)
 
@@ -144,6 +145,8 @@ const createServerEntryPointBundle = async (buildAppDir) => {
 
   console.log(`compiling server entry point bundle to ${path.join(buildAppDir, 'packages', 'server', 'index.jsc')}`)
 
+  console.log('cachedDataVersionTag: ', v8.cachedDataVersionTag())
+
   // Use bytenode to compile the entry point bundle. This will save time on the v8 compile step and ensure the integrity of the entry point
   const bytenode = await import('bytenode')