internal: rework studio handshake to allow better caching

[ryanthemanuel]

Additional details

Add a "handshake" mechanism to the studio workflow to get exact studio/protocol URLs up front. This allows for better caching.

Steps to test

How has the user experience changed?

PR Tasks

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

[cypress]

cypress    Run #62075

Run Properties:   Passed #62075  •  4e326ff34f: PR comment

Project	cypress
Branch Review	ryanm/fix/make-caching-possible
Run status	Passed #62075
Run duration	14m 31s
Commit	4e326ff34f: PR comment
Committer	Ryan Manuel
View all properties for this run ↗︎

---

Test results
Failures	0
Flaky	0
Pending	10
Skipped	0
Passing	589
View all changes introduced in this branch ↗︎

UI Coverage  0%
Untested elements	4
Tested elements	0

Accessibility  97.09%
Failed rules	0 critical   1 serious   0 moderate   0 minor
Failed elements	6

[Copilot]

Pull Request Overview

This PR reworks the studio handshake mechanism to allow better caching by introducing a dedicated studio session endpoint and refactoring studio manager initialization.

• Introduces a postStudioSession API to retrieve studio/protocol URLs before downloading the studio bundle.
• Adapts tests and project-base logic to integrate the new handshake flow.
• Updates studio manager creation and studio-app types to support the new caching mechanism.

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
scripts/gulp/tasks/gulpCloudDeliveredTypes.ts	Updated studio bundle download to use studioSession URL from postStudioSession.
packages/server/test/unit/project_spec.js	Modified test stubs and asynchronous callbacks for protocol management.
packages/server/test/unit/cloud/api/studio/post_studio_session_spec.ts	Added tests for the new postStudioSession API.
packages/server/test/unit/cloud/api/studio/get_and_initialize_studio_manager_spec.ts	Updated tests to supply studioUrl to the studio manager initializer.
packages/server/test/unit/StudioLifecycleManager_spec.ts	Adjusted studio lifecycle tests to use the postStudioSession stub.
packages/server/lib/project-base.ts	Refactored studio destruction logic for improved flow.
packages/server/lib/cloud/routes.ts	Updated API endpoints to include a studioSession route.
packages/server/lib/cloud/api/studio/post_studio_session.ts	Introduced a new API that posts to the studio session endpoint with retry logic.
packages/server/lib/cloud/api/studio/get_and_initialize_studio_manager.ts	Modified API to accept studioUrl and download the appropriate studio bundle.
packages/server/lib/StudioLifecycleManager.ts	Refactored studio manager creation logic to use the new postStudioSession and establish protocol setup.
packages/app/src/studio/studio-app-types.ts	Updated studio types to mark certain callbacks as optional and add new hooks.

Comments suppressed due to low confidence (2)

packages/app/src/studio/studio-app-types.ts:3

• [nitpick] Since onStudioPanelClose has been changed to optional and new hooks have been added, consider updating the documentation or inline comments to clarify how consumers should handle the absence of these properties.

export interface StudioPanelProps {

packages/server/test/unit/project_spec.js:885

• [nitpick] The updated async handling using a promise to capture the onStudioDestroy callback improves clarity. Ensure that this pattern is applied consistently across similar asynchronous test scenarios to avoid potential race conditions.

this.project.server.startWebsockets.callsFake(async (automation, config, callbacks) => {

[mschile]

Seems odd to destroy studio and then check if there is a protocolManager.

[ryanthemanuel]

Yeah good point. I think this is less confusing: 4e326ff (#31599)

[astone123]

Looks good 👍🏻

[cypress-bot]

Released in 14.3.3.

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