Merge branch 'develop' into feat/cy-prompt

Author: ryanthemanuel

cli/CHANGELOG.md

@@ -1,4 +1,12 @@
 <!-- See the ../guides/writing-the-cypress-changelog.md for details on writing the changelog. -->
+## 14.5.2
+
+_Released 7/15/2025 (PENDING)_
+
+**Bugfixes:**
+
+- Fixed a regression introduced in [`14.5.0`](https://docs.cypress.io/guides/references/changelog#14-5-0) where the Stop button would not immediately stop the spec timer. Addresses [#31920](https://github.com/cypress-io/cypress/issues/31920).
+
 ## 14.5.1
 
 _Released 7/01/2025_

packages/app/cypress/e2e/runner/runner.ui.cy.ts

@@ -289,10 +289,15 @@ describe('src/cypress/runner', () => {
     it('user can stop test execution', () => {
       loadSpec({
         filePath: 'runner/stop-execution.runner.cy.js',
-        passCount: 0,
-        failCount: 1,
       })
 
+      // Click the stop button to stop execution
+      cy.get('.stop').click()
+
+      // Verify the UI updates immediately - stop button disappears, restart appears
+      cy.get('.stop', { timeout: 100 }).should('not.exist')
+      cy.get('.restart', { timeout: 100 }).should('be.visible')
+
       cy.get('.runnable-err-message').should('not.contain', 'ran afterEach even though specs were stopped')
       cy.get('.runnable-err-message').should('contain', 'Cypress test was stopped while running this command.')
     })

packages/driver/src/cypress/runner.ts

@@ -393,7 +393,7 @@ const isRootSuite = (suite) => {
   return suite && suite.root
 }
 
-const overrideRunnerHook = (Cypress, _runner, getTestById, getTest, setTest, getTests, cy) => {
+const overrideRunnerHook = (Cypress, _runner, getTestById, getTest, setTest, getTests, cy, abort) => {
   // bail if our _runner doesn't have a hook.
   // useful in tests
   if (!_runner.hook) {
@@ -557,22 +557,11 @@ const overrideRunnerHook = (Cypress, _runner, getTestById, getTest, setTest, get
         testAfterRun(test, Cypress)
         await testAfterRunAsync(test, Cypress)
 
-        // if the user has stopped the run, we need to abort,
+        // if the user has stopped the run and we are in run mode, we need to abort,
         // this needs to happen after the test:after:run events have fired
         // to ensure protocol can properly handle the abort
-        if (_runner.stopped) {
-          // abort the run
-          _runner.abort()
-
-          // emit the final 'end' event
-          // since our reporter depends on this event
-          // and mocha may never fire this because our
-          // runnable may never finish
-          _runner.emit('end')
-
-          // remove all the listeners
-          // so no more events fire
-          _runner.removeAllListeners()
+        if (_runner.stopped && isRunMode) {
+          abort()
         }
       })]
 
@@ -1407,7 +1396,22 @@ export default {
 
     const getOnlySuiteId = () => _onlySuiteId
 
-    overrideRunnerHook(Cypress, _runner, getTestById, getTest, setTest, getTests, cy)
+    const abort = () => {
+      // abort the run
+      _runner.abort()
+
+      // emit the final 'end' event
+      // since our reporter depends on this event
+      // and mocha may never fire this because our
+      // runnable may never finish
+      _runner.emit('end')
+
+      // remove all the listeners
+      // so no more events fire
+      _runner.removeAllListeners()
+    }
+
+    overrideRunnerHook(Cypress, _runner, getTestById, getTest, setTest, getTests, cy, abort)
 
     // this forces mocha to enqueue a duplicate test in the case of test retries
     const replacePreviousAttemptWith = (test) => {
@@ -1934,6 +1938,12 @@ export default {
         }
 
         _runner.stopped = true
+
+        // if we are in open mode, abort the run immediately
+        // since we want the user feedback to be immediate
+        if (Cypress.config('isInteractive')) {
+          abort()
+        }
       },
 
       getDisplayPropsForLog: LogUtils.getDisplayProps,

packages/server/lib/cloud/api/studio/get_studio_bundle.ts

@@ -10,8 +10,9 @@ import { verifySignatureFromFile } from '../../encryption'
 const pkg = require('@packages/root')
 const _delay = linearDelay(500)
 
-export const getStudioBundle = async ({ studioUrl, projectId, bundlePath }: { studioUrl: string, projectId?: string, bundlePath: string }) => {
+export const getStudioBundle = async ({ studioUrl, bundlePath }: { studioUrl: string, bundlePath: string }): Promise<string> => {
   let responseSignature: string | null = null
+  let responseManifestSignature: string | null = null
 
   await (asyncRetry(async () => {
     const response = await fetch(studioUrl, {
@@ -32,6 +33,7 @@ export const getStudioBundle = async ({ studioUrl, projectId, bundlePath }: { st
     }
 
     responseSignature = response.headers.get('x-cypress-signature')
+    responseManifestSignature = response.headers.get('x-cypress-manifest-signature')
 
     await new Promise<void>((resolve, reject) => {
       const writeStream = createWriteStream(bundlePath)
@@ -54,9 +56,15 @@ export const getStudioBundle = async ({ studioUrl, projectId, bundlePath }: { st
     throw new Error('Unable to get studio signature')
   }
 
+  if (!responseManifestSignature) {
+    throw new Error('Unable to get studio manifest signature')
+  }
+
   const verified = await verifySignatureFromFile(bundlePath, responseSignature)
 
   if (!verified) {
     throw new Error('Unable to verify studio signature')
   }
+
+  return responseManifestSignature
 }

packages/server/lib/cloud/studio/StudioLifecycleManager.ts

@@ -22,12 +22,13 @@ import { initializeTelemetryReporter, reportTelemetry } from './telemetry/Teleme
 import { telemetryManager } from './telemetry/TelemetryManager'
 import { BUNDLE_LIFECYCLE_MARK_NAMES, BUNDLE_LIFECYCLE_TELEMETRY_GROUP_NAMES } from './telemetry/constants/bundle-lifecycle'
 import { INITIALIZATION_TELEMETRY_GROUP_NAMES } from './telemetry/constants/initialization'
+import crypto from 'crypto'
 
 const debug = Debug('cypress:server:studio-lifecycle-manager')
 const routes = require('../routes')
 
 export class StudioLifecycleManager {
-  private static hashLoadingMap: Map<string, Promise<void>> = new Map()
+  private static hashLoadingMap: Map<string, Promise<Record<string, string>>> = new Map()
   private static watcher: chokidar.FSWatcher | null = null
   private studioManagerPromise?: Promise<StudioManager | null>
   private studioManager?: StudioManager
@@ -157,6 +158,7 @@ export class StudioLifecycleManager {
   }): Promise<StudioManager> {
     let studioPath: string
     let studioHash: string
+    let manifest: Record<string, string>
 
     initializeTelemetryReporter({
       projectSlug: projectId,
@@ -190,17 +192,32 @@ export class StudioLifecycleManager {
         StudioLifecycleManager.hashLoadingMap.set(studioHash, hashLoadingPromise)
       }
 
-      await hashLoadingPromise
+      manifest = await hashLoadingPromise
     } else {
       studioPath = process.env.CYPRESS_LOCAL_STUDIO_PATH
       studioHash = 'local'
+      manifest = {}
     }
 
     telemetryManager.mark(BUNDLE_LIFECYCLE_MARK_NAMES.ENSURE_STUDIO_BUNDLE_END)
 
     const serverFilePath = path.join(studioPath, 'server', 'index.js')
 
     const script = await readFile(serverFilePath, 'utf8')
+
+    if (!process.env.CYPRESS_LOCAL_STUDIO_PATH) {
+      const expectedHash = manifest['server/index.js']
+      const actualHash = crypto.createHash('sha256').update(script).digest('hex')
+
+      if (!expectedHash) {
+        throw new Error('Expected hash for studio server script not found in manifest')
+      }
+
+      if (actualHash !== expectedHash) {
+        throw new Error('Invalid hash for studio server script')
+      }
+    }
+
     const studioManager = new StudioManager()
 
     telemetryManager.mark(BUNDLE_LIFECYCLE_MARK_NAMES.STUDIO_MANAGER_SETUP_START)
@@ -220,6 +237,7 @@ export class StudioLifecycleManager {
         asyncRetry,
       },
       shouldEnableStudio: this.cloudStudioRequested,
+      manifest,
     })
 
     telemetryManager.mark(BUNDLE_LIFECYCLE_MARK_NAMES.STUDIO_MANAGER_SETUP_END)

packages/server/lib/cloud/studio/ensure_studio_bundle.ts

@@ -1,8 +1,9 @@
-import { remove, ensureDir } from 'fs-extra'
+import { remove, ensureDir, readFile, pathExists } from 'fs-extra'
 
 import tar from 'tar'
 import { getStudioBundle } from '../api/studio/get_studio_bundle'
 import path from 'path'
+import { verifySignature } from '../encryption'
 
 interface EnsureStudioBundleOptions {
   studioUrl: string
@@ -26,7 +27,7 @@ export const ensureStudioBundle = async ({
   projectId,
   studioPath,
   downloadTimeoutMs = DOWNLOAD_TIMEOUT,
-}: EnsureStudioBundleOptions) => {
+}: EnsureStudioBundleOptions): Promise<Record<string, string>> => {
   const bundlePath = path.join(studioPath, 'bundle.tar')
 
   // First remove studioPath to ensure we have a clean slate
@@ -35,10 +36,9 @@ export const ensureStudioBundle = async ({
 
   let timeoutId: NodeJS.Timeout
 
-  await Promise.race([
+  const responseManifestSignature: string = await Promise.race([
     getStudioBundle({
       studioUrl,
-      projectId,
       bundlePath,
     }),
     new Promise((_, reject) => {
@@ -48,10 +48,26 @@ export const ensureStudioBundle = async ({
     }),
   ]).finally(() => {
     clearTimeout(timeoutId)
-  })
+  }) as string
 
   await tar.extract({
     file: bundlePath,
     cwd: studioPath,
   })
+
+  const manifestPath = path.join(studioPath, 'manifest.json')
+
+  if (!(await pathExists(manifestPath))) {
+    throw new Error('Unable to find studio manifest')
+  }
+
+  const manifestContents = await readFile(manifestPath, 'utf8')
+
+  const verified = await verifySignature(manifestContents, responseManifestSignature)
+
+  if (!verified) {
+    throw new Error('Unable to verify studio signature')
+  }
+
+  return JSON.parse(manifestContents)
 }

packages/server/lib/cloud/studio/studio.ts

@@ -5,6 +5,7 @@ import Debug from 'debug'
 import { requireScript } from '../require_script'
 import path from 'path'
 import { reportStudioError, ReportStudioErrorOptions } from '../api/studio/report_studio_error'
+import crypto, { BinaryLike } from 'crypto'
 
 interface StudioServer { default: StudioServerDefaultShape }
 
@@ -15,6 +16,7 @@ interface SetupOptions {
   projectSlug?: string
   cloudApi: StudioCloudApi
   shouldEnableStudio: boolean
+  manifest: Record<string, string>
 }
 
 const debug = Debug('cypress:server:studio')
@@ -41,7 +43,7 @@ export class StudioManager implements StudioManagerShape {
     return manager
   }
 
-  async setup ({ script, studioPath, studioHash, projectSlug, cloudApi, shouldEnableStudio }: SetupOptions): Promise<void> {
+  async setup ({ script, studioPath, studioHash, projectSlug, cloudApi, shouldEnableStudio, manifest }: SetupOptions): Promise<void> {
     const { createStudioServer } = requireScript<StudioServer>(script).default
 
     this._studioServer = await createStudioServer({
@@ -50,6 +52,18 @@ export class StudioManager implements StudioManagerShape {
       projectSlug,
       cloudApi,
       betterSqlite3Path: path.dirname(require.resolve('better-sqlite3/package.json')),
+      manifest,
+      verifyHash: (contents: BinaryLike, expectedHash: string) => {
+        // If we are running locally, we don't need to verify the signature. This
+        // environment variable will get stripped in the binary.
+        if (process.env.CYPRESS_LOCAL_STUDIO_PATH) {
+          return true
+        }
+
+        const actualHash = crypto.createHash('sha256').update(contents).digest('hex')
+
+        return actualHash === expectedHash
+      },
     })
 
     this.status = shouldEnableStudio ? 'ENABLED' : 'INITIALIZED'