internal: (studio) quality of life improvements for the studio lifecycle

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

@@ -1,10 +1,9 @@
 import path from 'path'
 import os from 'os'
-import { ensureDir, copy, readFile } from 'fs-extra'
+import { ensureDir, copy, readFile, remove } from 'fs-extra'
 import { StudioManager } from '../../studio'
 import tar from 'tar'
 import { verifySignatureFromFile } from '../../encryption'
-import crypto from 'crypto'
 import fs from 'fs'
 import fetch from 'cross-fetch'
 import { agent } from '@packages/network'
@@ -47,6 +46,10 @@ const downloadStudioBundleToTempDirectory = async ({ studioUrl, projectId }: Opt
       encrypt: 'signed',
     })
 
+    if (!response.ok) {
+      throw new Error(`Failed to download studio bundle: ${response.statusText}`)
+    }
+
     responseSignature = response.headers.get('x-cypress-signature')
 
     await new Promise<void>((resolve, reject) => {
@@ -77,26 +80,12 @@ const downloadStudioBundleToTempDirectory = async ({ studioUrl, projectId }: Opt
   }
 }
 
-const getTarHash = (): Promise<string> => {
-  let hash = ''
-
-  return new Promise<string>((resolve, reject) => {
-    fs.createReadStream(bundlePath)
-    .pipe(crypto.createHash('sha256'))
-    .setEncoding('base64url')
-    .on('data', (data) => {
-      hash += String(data)
-    })
-    .on('error', reject)
-    .on('close', () => {
-      resolve(hash)
-    })
-  })
-}
-
 export const retrieveAndExtractStudioBundle = async ({ studioUrl, projectId }: Options): Promise<{ studioHash: string | undefined }> => {
+  // The studio hash is the last part of the studio URL, after the last slash and before the extension
+  const studioHash = studioUrl.split('/').pop()?.split('.')[0]
+
   // First remove studioPath to ensure we have a clean slate
-  await fs.promises.rm(studioPath, { recursive: true, force: true })
+  await remove(studioPath)
   await ensureDir(studioPath)
 
   // Note: CYPRESS_LOCAL_STUDIO_PATH is stripped from the binary, effectively removing this code path
@@ -112,8 +101,6 @@ export const retrieveAndExtractStudioBundle = async ({ studioUrl, projectId }: O
 
   await downloadStudioBundleToTempDirectory({ studioUrl, projectId })
 
-  const studioHash = await getTarHash()
-
   await tar.extract({
     file: bundlePath,
     cwd: studioPath,
@@ -177,6 +164,6 @@ export const getAndInitializeStudioManager = async ({ studioUrl, projectId, clou
       studioMethod: 'getAndInitializeStudioManager',
     })
   } finally {
-    await fs.promises.rm(bundlePath, { force: true })
+    await remove(bundlePath)
   }
 }

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

@@ -28,7 +28,7 @@ export const postStudioSession = async ({ projectId }: GetStudioSessionOptions)
     })
 
     if (!response.ok) {
-      throw new Error('Failed to create studio session')
+      throw new Error(`Failed to create studio session: ${response.statusText}`)
     }
 
     const data = await response.json()

packages/server/test/unit/cloud/api/studio/get_and_initialize_studio_manager_spec.ts

@@ -28,7 +28,11 @@ describe('getAndInitializeStudioManager', () => {
     ensureStub = sinon.stub()
     copyStub = sinon.stub()
     readFileStub = sinon.stub()
-    crossFetchStub = sinon.stub()
+    crossFetchStub = sinon.stub().resolves({
+      ok: true,
+      statusText: 'OK',
+    })
+
     createReadStreamStub = sinon.stub()
     createWriteStreamStub = sinon.stub()
     verifySignatureFromFileStub = sinon.stub()
@@ -38,9 +42,6 @@ describe('getAndInitializeStudioManager', () => {
 
     getAndInitializeStudioManager = (proxyquire('../lib/cloud/api/studio/get_and_initialize_studio_manager', {
       fs: {
-        promises: {
-          rm: rmStub.resolves(),
-        },
         createReadStream: createReadStreamStub,
         createWriteStream: createWriteStreamStub,
       },
@@ -49,6 +50,7 @@ describe('getAndInitializeStudioManager', () => {
         platform: () => 'linux',
       },
       'fs-extra': {
+        remove: rmStub.resolves(),
         ensureDir: ensureStub.resolves(),
         copy: copyStub.resolves(),
         readFile: readFileStub.resolves('console.log("studio script")'),
@@ -110,6 +112,8 @@ describe('getAndInitializeStudioManager', () => {
       })
 
       crossFetchStub.resolves({
+        ok: true,
+        statusText: 'OK',
         body: readStream,
         headers: {
           get: (header) => {
@@ -251,6 +255,8 @@ describe('getAndInitializeStudioManager', () => {
       })
 
       crossFetchStub.resolves({
+        ok: true,
+        statusText: 'OK',
         body: readStream,
         headers: {
           get: (header) => {
@@ -298,7 +304,7 @@ describe('getAndInitializeStudioManager', () => {
       expect(studioManagerSetupStub).to.be.calledWithMatch({
         script: 'console.log("studio script")',
         studioPath: '/tmp/cypress/studio',
-        studioHash: 'V8T1PKuSTK1h9gr-1Z2Wtx__bxTpCXWRZ57sKmPVTSs',
+        studioHash: 'abc',
       })
     })
 
@@ -318,6 +324,8 @@ describe('getAndInitializeStudioManager', () => {
 
       crossFetchStub.onFirstCall().rejects(new HttpError('Failed to fetch', 'url', 502, 'Bad Gateway', 'Bad Gateway', sinon.stub()))
       crossFetchStub.onSecondCall().resolves({
+        ok: true,
+        statusText: 'OK',
         body: readStream,
         headers: {
           get: (header) => {
@@ -365,7 +373,7 @@ describe('getAndInitializeStudioManager', () => {
       expect(studioManagerSetupStub).to.be.calledWithMatch({
         script: 'console.log("studio script")',
         studioPath: '/tmp/cypress/studio',
-        studioHash: 'V8T1PKuSTK1h9gr-1Z2Wtx__bxTpCXWRZ57sKmPVTSs',
+        studioHash: 'abc',
       })
     })
 
@@ -424,6 +432,43 @@ describe('getAndInitializeStudioManager', () => {
       })
     })
 
+    it('throws an error and returns a studio manager in error state if the response status is not ok', async () => {
+      const mockGetCloudUrl = sinon.stub()
+      const mockAdditionalHeaders = sinon.stub()
+      const cloud = {
+        getCloudUrl: mockGetCloudUrl,
+        additionalHeaders: mockAdditionalHeaders,
+      } as unknown as CloudDataSource
+
+      mockGetCloudUrl.returns('http://localhost:1234')
+      mockAdditionalHeaders.resolves({
+        a: 'b',
+        c: 'd',
+      })
+
+      crossFetchStub.resolves({
+        ok: false,
+        statusText: 'Some failure',
+      })
+
+      const projectId = '12345'
+
+      await getAndInitializeStudioManager({ studioUrl: 'http://localhost:1234/studio/bundle/abc.tgz', projectId, cloudDataSource: cloud })
+
+      expect(rmStub).to.be.calledWith('/tmp/cypress/studio')
+      expect(ensureStub).to.be.calledWith('/tmp/cypress/studio')
+      expect(createInErrorManagerStub).to.be.calledWithMatch({
+        error: sinon.match.instanceOf(Error).and(sinon.match.has('message', 'Failed to download studio bundle: Some failure')),
+        cloudApi: {
+          cloudUrl: 'http://localhost:1234',
+          cloudHeaders: { a: 'b', c: 'd' },
+        },
+        studioHash: undefined,
+        projectSlug: '12345',
+        studioMethod: 'getAndInitializeStudioManager',
+      })
+    })
+
     it('throws an error and returns a studio manager in error state if the signature verification fails', async () => {
       const mockGetCloudUrl = sinon.stub()
       const mockAdditionalHeaders = sinon.stub()
@@ -439,6 +484,8 @@ describe('getAndInitializeStudioManager', () => {
       })
 
       crossFetchStub.resolves({
+        ok: true,
+        statusText: 'OK',
         body: readStream,
         headers: {
           get: (header) => {
@@ -501,6 +548,8 @@ describe('getAndInitializeStudioManager', () => {
       })
 
       crossFetchStub.resolves({
+        ok: true,
+        statusText: 'OK',
         body: readStream,
         headers: {
           get: () => null,

packages/server/test/unit/cloud/api/studio/post_studio_session_spec.ts

@@ -54,6 +54,7 @@ describe('postStudioSession', () => {
   it('should throw immediately if the response is not ok', async () => {
     crossFetchStub.resolves({
       ok: false,
+      statusText: 'Some failure',
       json: () => {
         return Promise.resolve({
           error: 'Failed to create studio session',
@@ -63,7 +64,7 @@ describe('postStudioSession', () => {
 
     await expect(postStudioSession({
       projectId: '12345',
-    })).to.be.rejectedWith('Failed to create studio session')
+    })).to.be.rejectedWith('Failed to create studio session: Some failure')
 
     expect(crossFetchStub).to.have.been.calledOnce
   })