chore: add better-sqlite3 dependency

cli/CHANGELOG.md

@@ -14,6 +14,7 @@ _Released 03/14/2023 (PENDING)_
 **Dependency Updates:**
 
 - Upgraded [`mocha-junit-reporter`](https://github.com/michaelleeallen/mocha-junit-reporter) from `2.1.0` to `2.2.0` to be able to use [new placeholders](https://github.com/michaelleeallen/mocha-junit-reporter/pull/163) such as `[suiteFilename]` or `[suiteName]` when defining the test report name. Addressed in [#25922](https://github.com/cypress-io/cypress/pull/25922).
+- Added [`better-sqlite3`]() to support storing test run information which will be sent when recording to the Cloud
 
 ## 12.7.0
 

package.json

@@ -276,4 +276,4 @@
     "sharp": "0.29.3",
     "vue-template-compiler": "2.6.12"
   }
-}
+}

packages/server/lib/cloud/protocol.ts

@@ -3,8 +3,9 @@ import { NodeVM } from 'vm2'
 import Debug from 'debug'
 import CDP from 'chrome-remote-interface'
 import type { ProtocolManager, AppCaptureProtocolInterface } from '@packages/types'
-
-// TODO(protocol): This is basic for now but will evolve as we progress with the protocol wor
+import Database from 'better-sqlite3'
+import path from 'path'
+import os from 'os'
 
 const debug = Debug('cypress:server:protocol')
 
@@ -19,9 +20,13 @@ const setupProtocol = async (url?: string): Promise<AppCaptureProtocolInterface
   }
 
   if (script) {
+    const cypressProtocolDirectory = path.join(os.tmpdir(), 'cypress', 'protocol')
+
+    // TODO(protocol): Handle any errors here appropriately. Likely, we will want to handle all errors in the initialization process similarly (e.g. downloading, file permissions, etc.)
+    await fs.ensureDir(cypressProtocolDirectory)
     const vm = new NodeVM({
       console: 'inherit',
-      sandbox: { Debug, CDP },
+      sandbox: { nodePath: path, Debug, CDP, Database, CY_PROTOCOL_DIR: cypressProtocolDirectory, betterSqlite3Binding: path.join(require.resolve('better-sqlite3/build/Release/better_sqlite3.node')) },
     })
 
     const { AppCaptureProtocol } = vm.run(script)
@@ -34,6 +39,7 @@ const setupProtocol = async (url?: string): Promise<AppCaptureProtocolInterface
 
 class ProtocolManagerImpl implements ProtocolManager {
   private protocol: AppCaptureProtocolInterface | undefined
+  private db: Database
 
   protocolEnabled (): boolean {
     return !!this.protocol
@@ -45,16 +51,14 @@ class ProtocolManagerImpl implements ProtocolManager {
     this.protocol = await setupProtocol(url)
   }
 
-  connectToBrowser (options) {
+  async connectToBrowser (options) {
     debug('connecting to browser for new spec')
-    this.protocol?.connectToBrowser(options)
+    return this.protocol?.connectToBrowser(options)
   }
 
   beforeSpec (spec) {
     debug('initializing new spec %O', spec)
     this.protocol?.beforeSpec(spec)
-
-    // Initialize DB here
   }
 
   afterSpec () {

packages/server/package.json

@@ -4,6 +4,7 @@
   "private": true,
   "main": "index.js",
   "scripts": {
+    "build": "electron-rebuild -o better-sqlite3",
     "build-prod": "tsc || echo 'built, with type errors'",
     "check-ts": "tsc --noEmit && yarn -s tslint",
     "clean-deps": "rimraf node_modules",
@@ -37,6 +38,7 @@
     "ansi_up": "5.0.0",
     "ast-types": "0.13.3",
     "base64url": "^3.0.1",
+    "better-sqlite3": "8.2.0",
     "black-hole-stream": "0.0.1",
     "bluebird": "3.7.2",
     "bundle-require": "3.0.4",
@@ -138,6 +140,7 @@
     "@cypress/json-schemas": "5.39.0",
     "@cypress/sinon-chai": "2.9.1",
     "@cypress/webpack-dev-server": "0.0.0-development",
+    "@electron/rebuild": "3.2.10",
     "@ffprobe-installer/ffprobe": "1.1.0",
     "@packages/config": "0.0.0-development",
     "@packages/data-context": "0.0.0-development",

packages/server/test/support/fixtures/cloud/protocol/test-protocol.js

@@ -0,0 +1,40 @@
+/* global Debug, CDP, CY_PROTOCOL_DIR, betterSqlite3Binding, nodePath, Database */
+
+const AppCaptureProtocol = class {
+  constructor () {
+    this.Debug = Debug
+    this.CDP = CDP
+    this.CY_PROTOCOL_DIR = CY_PROTOCOL_DIR
+    this.betterSqlite3Binding = betterSqlite3Binding
+    this.nodePath = nodePath
+    this.Database = Database
+
+    this.connectToBrowser = this.connectToBrowser.bind(this)
+    this.beforeSpec = this.beforeSpec.bind(this)
+    this.afterSpec = this.afterSpec.bind(this)
+    this.beforeTest = this.beforeTest.bind(this)
+  }
+
+  async connectToBrowser ({
+    target,
+    host,
+    port,
+  }) {
+    return Promise.resolve()
+  }
+
+  beforeSpec (spec) {
+
+  }
+
+  afterSpec (spec) {
+  }
+
+  beforeTest (test) {
+
+  }
+}
+
+module.exports = {
+  AppCaptureProtocol,
+}

packages/server/test/unit/cloud/environment_spec.ts

@@ -6,7 +6,7 @@ import { exec } from 'child_process'
 import originalResolvePackagePath from 'resolve-package-path'
 import proxyquire from 'proxyquire'
 
-describe('lib/cloud/api', () => {
+describe('lib/cloud/environment', () => {
   beforeEach(() => {
     delete process.env.CYPRESS_API_URL
     process.env.CYPRESS_ENV_DEPENDENCIES = base64url.encode(JSON.stringify({

packages/server/test/unit/cloud/protocol_spec.ts

@@ -0,0 +1,109 @@
+import '../../spec_helper'
+import ProtocolManager from '../../../lib/cloud/protocol'
+import path from 'path'
+
+describe('lib/cloud/protocol', () => {
+  beforeEach(() => {
+    process.env.CYPRESS_LOCAL_PROTOCOL_PATH = path.join(__dirname, '..', '..', 'support', 'fixtures', 'cloud', 'protocol', 'test-protocol.js')
+  })
+
+  afterEach(() => {
+    delete process.env.CYPRESS_LOCAL_PROTOCOL_PATH
+  })
+
+  it('should be able to setup the protocol', async () => {
+    const protocolManager = new ProtocolManager()
+
+    await protocolManager.setupProtocol()
+
+    const protocol = (protocolManager as any).protocol
+
+    expect(protocolManager.protocolEnabled()).to.be.true
+    expect(protocol.Debug).not.to.be.undefined
+    expect(protocol.CDP).not.to.be.undefined
+    expect(protocol.CY_PROTOCOL_DIR).not.to.be.undefined
+    expect(protocol.betterSqlite3Binding).not.to.be.undefined
+    expect(protocol.nodePath).not.to.be.undefined
+    expect(protocol.Database).not.to.be.undefined
+  })
+
+  it('should be able to connect to the browser', async () => {
+    const protocolManager = new ProtocolManager()
+
+    await protocolManager.setupProtocol()
+
+    const protocol = (protocolManager as any).protocol
+
+    sinon.stub(protocol, 'connectToBrowser').resolves()
+
+    await protocolManager.connectToBrowser({
+      target: 'target',
+      host: 'host',
+      port: 1234,
+    })
+
+    expect(protocol.connectToBrowser).to.be.calledWith({
+      target: 'target',
+      host: 'host',
+      port: 1234,
+    })
+  })
+
+  it('should be able to initialize a new spec', async () => {
+    const protocolManager = new ProtocolManager()
+
+    await protocolManager.setupProtocol()
+
+    const protocol = (protocolManager as any).protocol
+
+    sinon.stub(protocol, 'beforeSpec').resolves()
+
+    await protocolManager.beforeSpec({
+      name: 'spec',
+      relative: 'relative',
+      absolute: 'absolute',
+    })
+
+    expect(protocol.beforeSpec).to.be.calledWith({
+      name: 'spec',
+      relative: 'relative',
+      absolute: 'absolute',
+    })
+  })
+
+  it('should be able to initialize a new test', async () => {
+    const protocolManager = new ProtocolManager()
+
+    await protocolManager.setupProtocol()
+
+    const protocol = (protocolManager as any).protocol
+
+    sinon.stub(protocol, 'beforeTest').resolves()
+
+    await protocolManager.beforeTest({
+      id: 'id',
+      title: 'test',
+      wallClockStartedAt: 1234,
+    })
+
+    expect(protocol.beforeTest).to.be.calledWith({
+      id: 'id',
+      title: 'test',
+      wallClockStartedAt: 1234,
+    })
+  })
+
+  it('should be able to clean up after a spec', async () => {
+    const protocolManager = new ProtocolManager()
+
+    await protocolManager.setupProtocol()
+
+    const protocol = (protocolManager as any).protocol
+
+    sinon.stub(protocol, 'afterSpec').resolves()
+
+    await protocolManager.afterSpec()
+
+    expect(protocol.afterSpec).to.be.called
+  })
+})

packages/types/src/protocol.ts

@@ -3,7 +3,7 @@ import type { SpecFile } from '.'
 // TODO(protocol): This is basic for now but will evolve as we progress with the protocol work
 
 export interface AppCaptureProtocolInterface {
-  connectToBrowser (options: { target: string, host: string, port: number }): void
+  connectToBrowser (options: { target: string, host: string, port: number }): Promise<void>
   beforeSpec (spec: SpecFile & { instanceId: string }): void
   afterSpec (): void
   beforeTest (test: { id: string, title: string, wallClockStartedAt: number }): void

scripts/binary/binary-cleanup.js

@@ -63,6 +63,7 @@ const getDependencyPathsToKeep = async (buildAppDir) => {
       'openbsd',
       'sunos',
       'win32'].map((platform) => path.join(unixBuildAppDir, `node_modules/default-gateway/${platform}.js`)),
+    path.join(unixBuildAppDir, 'node_modules/vm2/lib/bridge.js'),
   ])
   let esbuildResult
   let newEntryPointsFound = true

scripts/binary/build.ts

@@ -121,7 +121,7 @@ export async function buildCypressApp (options: BuildCypressAppOpts) {
   fs.writeJsonSync(meta.distDir('package.json'), {
     ...packageJsonContents,
     scripts: {
-      postinstall: 'patch-package',
+      postinstall: 'patch-package && yarn workspace @packages/server build',
     },
   }, { spaces: 2 })