chore: convert @packages/network tests from mocha to vitest (#32630)

* start vitest convertion and convert connect spec to vitest

* chore: convert agent spec to vitest

* chore: convert block spec to vitest

* chore: convert client-certificates test to vitest and remove circular dependency on singletoon in agent and client certificats

* chore: convert the connect spec to vitest

* chore: convert cors spec to vitest

* chore: convert document domain spec to vitest

* chore: convert uri spec to vitest

* chore: cleanup files

Author: AtofStryker

.circleci/src/pipeline/@pipeline.yml

@@ -1784,7 +1784,7 @@ jobs:
                   source ./scripts/ensure-node.sh
                   yarn lerna run types
             - sanitize-verify-and-store-mocha-results:
-                expectedResultCount: 12
+                expectedResultCount: 11
 
   verify-release-readiness:
     <<: *defaults

guides/esm-migration.md

@@ -102,7 +102,7 @@ When migrating some of these projects away from the `ts-node` entry [see `@packa
 - [ ] packages/icons
 - [ ] packages/launcher
 - [ ] packages/net-stubbing
-- [ ] packages/network
+- [x] packages/network ✅ **COMPLETED**
 - [ ] packages/packherd-require
 - [ ] packages/proxy
 - [x] packages/rewriter ✅ **COMPLETED**

packages/network/.mocharc.js

@@ -7,7 +7,7 @@ import { getProxyForUrl } from 'proxy-from-env'
 import url from 'url'
 import { createRetryingSocket, getAddress } from './connect'
 import { lenientOptions } from './http-utils'
-import { ClientCertificateStore } from './client-certificates'
+import { clientCertificateStoreSingleton } from './client-certificates'
 import { CaOptions, getCaOptions } from './ca'
 
 const debug = debugModule('cypress:network:agent')
@@ -55,8 +55,6 @@ const mergeCAOptions = (options: https.RequestOptions, caOptions: CaOptions): ht
   }
 }
 
-export const clientCertificateStore = new ClientCertificateStore()
-
 type WithProxyOpts<RequestOptions> = RequestOptions & {
   proxy: string
   shouldRetry?: boolean
@@ -254,7 +252,7 @@ export class CombinedAgent {
       debug('got family %o', _.pick(options, 'family', 'href'))
 
       if (isHttps) {
-        _.assign(options, clientCertificateStore.getClientCertificateAgentOptionsForUrl(uri))
+        _.assign(options, clientCertificateStoreSingleton.getClientCertificateAgentOptionsForUrl(uri))
 
         return this.httpsAgent.addRequest(req, options as https.RequestOptions)
       }

packages/network/lib/agent.ts

@@ -2,7 +2,6 @@ import { URL, Url } from 'url'
 import debugModule from 'debug'
 import minimatch from 'minimatch'
 import fs from 'fs-extra'
-import { clientCertificateStore } from './agent'
 
 const { pki, asn1, pkcs12, util } = require('node-forge')
 
@@ -188,6 +187,8 @@ export class ClientCertificateStore {
   }
 }
 
+export const clientCertificateStoreSingleton = new ClientCertificateStore()
+
 /**
  * Load and parse the client certificate configuration.  The structure and content of this
  * has already been validated; this function reads cert content from file and adds it to the
@@ -200,7 +201,7 @@ export function loadClientCertificateConfig (config) {
   let index = 0
 
   try {
-    clientCertificateStore.clear()
+    clientCertificateStoreSingleton.clear()
 
     // The basic validation of the certificate configuration has already been done by this point
     // within the 'isValidClientCertificatesSet' function within packages/config/src/validation.js
@@ -324,12 +325,12 @@ export function loadClientCertificateConfig (config) {
           }
         })
 
-        clientCertificateStore.addClientCertificatesForUrl(urlClientCertificates)
+        clientCertificateStoreSingleton.addClientCertificatesForUrl(urlClientCertificates)
         index++
       })
 
       debug(
-        `loaded client certificates for ${clientCertificateStore.getCertCount()} URL(s)`,
+        `loaded client certificates for ${clientCertificateStoreSingleton.getCertCount()} URL(s)`,
       )
     }
   } catch (e: any) {

packages/network/lib/client-certificates.ts

@@ -10,8 +10,8 @@
     "clean-deps": "rimraf node_modules",
     "lint": "eslint --ext .js,.jsx,.ts,.tsx,.json, .",
     "test": "yarn test-unit",
-    "test-debug": "yarn test-unit --inspect-brk=5566",
-    "test-unit": "mocha --reporter mocha-multi-reporters --reporter-options configFile=../../mocha-reporter-config.json",
+    "test-debug": "npx vitest --inspect-brk --no-file-parallelism --test-timeout=0 --hook-timeout=0",
+    "test-unit": "vitest run",
     "test-watch": "yarn test-unit --watch",
     "tslint": "tslint --config ../ts/tslint.json --project ."
   },
@@ -32,13 +32,10 @@
     "@cypress/request-promise": "^5.0.0",
     "@packages/https-proxy": "0.0.0-development",
     "@packages/socket": "0.0.0-development",
-    "@packages/ts": "0.0.0-development",
     "@types/concat-stream": "1.6.0",
     "express": "4.21.0",
-    "mocha": "6.2.2",
-    "sinon": "7.3.1",
-    "sinon-chai": "3.7.0",
-    "typescript": "~5.4.5"
+    "typescript": "~5.4.5",
+    "vitest": "^3.2.4"
   },
   "files": [
     "lib"

packages/network/package.json

@@ -0,0 +1,64 @@
+import { describe, it, expect } from 'vitest'
+import _ from 'lodash'
+import net, { AddressInfo } from 'net'
+import * as connect from '../../lib/connect'
+
+describe('lib/connect', function () {
+  describe('.getAddress', function () {
+    it('resolves localhost on 127.0.0.1 immediately', {
+      // TODO: fix flaky test https://github.com/cypress-io/cypress/issues/23155
+      retry: 15,
+      timeout: 50,
+    }, async () => {
+      const server = net.createServer(_.partialRight(_.invoke, 'close'))
+
+      // start the server
+      await new Promise<void>((resolve) => {
+        server.listen({
+          port: 0,
+          host: '127.0.0.1',
+        }, resolve)
+      })
+
+      const address = await connect.getAddress((server.address() as AddressInfo).port, 'localhost')
+
+      expect(address).toEqual({
+        family: 4,
+        address: '127.0.0.1',
+      })
+
+      // stop the server
+      await new Promise<Error>((resolve) => {
+        server.close(resolve)
+      })
+    })
+
+    // Error: listen EADDRNOTAVAIL ::1
+    // NOTE: add an ipv6 lo if to the docker container
+    it('resolves localhost on ::1 immediately', {
+      timeout: 50,
+    }, async () => {
+      const server = net.createServer(_.partialRight(_.invoke, 'close'))
+
+      // start the server
+      await new Promise<void>((resolve) => {
+        server.listen({
+          port: 0,
+          host: '::1',
+        }, resolve)
+      })
+
+      const address = await connect.getAddress((server.address() as AddressInfo).port, 'localhost')
+
+      expect(address).toEqual({
+        family: 6,
+        address: '::1',
+      })
+
+      // stop the server
+      await new Promise<Error>((resolve) => {
+        server.close(resolve)
+      })
+    })
+  })
+})

packages/network/test/integration/connect.spec.ts

@@ -1,4 +1,4 @@
-import Promise from 'bluebird'
+import Bluebird from 'bluebird'
 import express from 'express'
 import http from 'http'
 import https from 'https'
@@ -31,11 +31,12 @@ function createExpressApp (requestCallback: (req) => void) {
   return app
 }
 
-function getCAInformation () {
-  return CA.create()
-  .then((ca) => {
-    return Promise.all([ca.generateServerCertificateKeys('localhost'), ca.getCACertPath()])
-  })
+async function getCAInformation () {
+  const ca = await CA.create()
+
+  const [serverCertificateKeys, caCertificatePath] = await Promise.all([ca.generateServerCertificateKeys('localhost'), ca.getCACertPath()])
+
+  return { serverCertificateKeys, caCertificatePath }
 }
 
 function onWsConnection (socket) {
@@ -51,43 +52,42 @@ export class Servers {
   caCertificatePath: string
   lastRequestHeaders: any
 
-  start (httpPort: number, httpsPort: number) {
-    return Promise.join(
+  async start (httpPort: number, httpsPort: number) {
+    const [app, { serverCertificateKeys, caCertificatePath }]: [Express.Application, {serverCertificateKeys: string[], caCertificatePath: string}] = await Promise.all([
       createExpressApp((req) => this.lastRequestHeaders = req.headers),
       getCAInformation(),
-    )
-    .spread((app: Express.Application, [serverCertificateKeys, caCertificatePath]: [serverCertificateKeys: string[], caCertificatePath: string]) => {
-      this.httpServer = Promise.promisifyAll(
-        allowDestroy(http.createServer(app)),
-      ) as http.Server & AsyncServer
-
-      this.wsServer = new SocketIOServer(this.httpServer)
-
-      this.caCertificatePath = caCertificatePath
-      this.https = { cert: serverCertificateKeys[0], key: serverCertificateKeys[1] }
-      this.httpsServer = Promise.promisifyAll(
-        allowDestroy(https.createServer(this.https, <http.RequestListener>app)),
-      ) as https.Server & AsyncServer
-
-      this.wssServer = new SocketIOServer(this.httpsServer)
-
-      ;[this.wsServer, this.wssServer].map((ws) => {
-        ws.on('connection', onWsConnection)
-      })
-
-      // @ts-skip
-      return Promise.join(
-        this.httpServer.listenAsync(httpPort),
-        this.httpsServer.listenAsync(httpsPort),
-      )
-      .return()
+    ])
+
+    this.httpServer = Bluebird.promisifyAll(
+      allowDestroy(http.createServer(app)),
+    ) as http.Server & AsyncServer
+
+    this.wsServer = new SocketIOServer(this.httpServer)
+
+    this.caCertificatePath = caCertificatePath
+    this.https = { cert: serverCertificateKeys[0], key: serverCertificateKeys[1] }
+    this.httpsServer = Bluebird.promisifyAll(
+      allowDestroy(https.createServer(this.https, <http.RequestListener>app)),
+    ) as https.Server & AsyncServer
+
+    this.wssServer = new SocketIOServer(this.httpsServer)
+
+    ;[this.wsServer, this.wssServer].map((ws) => {
+      ws.on('connection', onWsConnection)
     })
+
+    await Promise.all([
+      this.httpServer.listenAsync(httpPort),
+      this.httpsServer.listenAsync(httpsPort),
+    ])
+
+    return undefined
   }
 
-  stop () {
-    return Promise.join(
+  async stop () {
+    await Promise.all([
       this.httpServer.destroyAsync(),
       this.httpsServer.destroyAsync(),
-    )
+    ])
   }
 }