make @packages/network an independent bundle

Author: AtofStryker

guides/esm-migration.md

@@ -53,7 +53,7 @@ When migrating some of these projects away from the `ts-node` entry [see `@packa
 - [x] packages/launcher ✅ **COMPLETED**
 - [x] packages/launchpad ✅ **COMPLETED**
 - [x] packages/net-stubbing ✅ **COMPLETED**
-- [ ] packages/network **PARTIAL** - entry point is JS
+- [x] packages/network ✅ **COMPLETED**
 - [x] packages/packherd-require ✅ **COMPLETED**
 - [ ] packages/proxy **PARTIAL** - entry point is JS
 - [x] packages/reporter ✅ **COMPLETED**

packages/network/.gitignore

@@ -0,0 +1,2 @@
+cjs/
+esm/

packages/network/README.md

@@ -18,7 +18,7 @@ See the individual class files in [`./lib`](./lib) for more information.
 
 ## Building
 
-Note: you should not ever need to build the .js files manually. `@packages/ts` provides require-time transpilation when in development.
+We currently build a CommonJS and an ESM version of this package. However, since this package is only consumed via CommonJS, we currently only build the CommonJS variant of the package.
 
 ```shell
 yarn workspace @packages/network build-prod

packages/network/lib/agent.ts

@@ -262,7 +262,7 @@ export class CombinedAgent {
   }
 }
 
-const getProxyOrTargetOverrideForUrl = (href) => {
+const getProxyOrTargetOverrideForUrl = (href: string) => {
   // HTTP_PROXY_TARGET_FOR_ORIGIN_REQUESTS is used for Cypress in Cypress E2E testing and will
   // force the parent Cypress server to treat the child Cypress server like a proxy without
   // having HTTP_PROXY set and will force traffic ONLY bound to that origin to behave
@@ -395,7 +395,7 @@ class HttpsAgent extends https.Agent {
     const port = options.uri?.port || '443'
     const hostname = options.uri?.hostname || 'localhost'
 
-    createProxySock({ proxy, shouldRetry: options.shouldRetry }, (originalErr?, proxySocket?, triggerRetry?) => {
+    createProxySock({ proxy, shouldRetry: options.shouldRetry }, (originalErr?: Error, proxySocket?: net.Socket, triggerRetry?: (err: Error) => void) => {
       if (originalErr) {
         const err: any = new Error(`A connection to the upstream proxy could not be established: ${originalErr.message}`)
 
@@ -406,12 +406,12 @@ class HttpsAgent extends https.Agent {
       }
 
       const onClose = () => {
-        triggerRetry(new Error('ERR_EMPTY_RESPONSE: The upstream proxy closed the socket after connecting but before sending a response.'))
+        triggerRetry?.(new Error('ERR_EMPTY_RESPONSE: The upstream proxy closed the socket after connecting but before sending a response.'))
       }
 
       const onError = (err: Error) => {
-        triggerRetry(err)
-        proxySocket.destroy()
+        triggerRetry?.(err)
+        proxySocket?.destroy()
       }
 
       let buffer = ''
@@ -423,15 +423,15 @@ class HttpsAgent extends https.Agent {
 
         if (!_.includes(buffer, _.repeat(CRLF, 2))) {
           // haven't received end of headers yet, keep buffering
-          proxySocket.once('data', onData)
+          proxySocket?.once('data', onData)
 
           return
         }
 
         // we've now gotten enough of a response not to retry
         // connecting to the proxy
-        proxySocket.removeListener('error', onError)
-        proxySocket.removeListener('close', onClose)
+        proxySocket?.removeListener('error', onError)
+        proxySocket?.removeListener('close', onClose)
 
         if (!isResponseStatusCode200(buffer)) {
           return cb(new Error(`Error establishing proxy connection. Response from server was: ${buffer}`), undefined)
@@ -453,14 +453,14 @@ class HttpsAgent extends https.Agent {
         cb(undefined, proxySocket)
       }
 
-      proxySocket.once('close', onClose)
-      proxySocket.once('error', onError)
-      proxySocket.once('data', onData)
+      proxySocket?.once('close', onClose)
+      proxySocket?.once('error', onError)
+      proxySocket?.once('data', onData)
 
       const connectReq = buildConnectReqHead(hostname, port, proxy)
 
-      proxySocket.setNoDelay(true)
-      proxySocket.write(connectReq)
+      proxySocket?.setNoDelay(true)
+      proxySocket?.write(connectReq)
     })
   }
 }

packages/network/lib/allow-destroy.ts

@@ -10,7 +10,7 @@ import type net from 'net'
 export function allowDestroy (server: net.Server) {
   let connections: net.Socket[] = []
 
-  function trackConn (conn) {
+  function trackConn (conn: net.Socket) {
     connections.push(conn)
 
     conn.on('close', () => {

packages/network/lib/blocked.ts

@@ -2,17 +2,17 @@ import _ from 'lodash'
 import minimatch from 'minimatch'
 import { stripProtocolAndDefaultPorts } from './uri'
 
-export function matches (urlToCheck, blockHosts) {
+export function matches (urlToCheck: string, blockHosts: string[]) {
   // normalize into flat array
-  blockHosts = [].concat(blockHosts)
+  const blockHostsNormalized: string[] = ([] as string[]).concat(blockHosts)
 
-  urlToCheck = stripProtocolAndDefaultPorts(urlToCheck)
+  const urlToCheckStripped = stripProtocolAndDefaultPorts(urlToCheck) as string
 
   // use minimatch against the url
   // to see if any match
-  const matchUrl = (hostMatcher) => {
-    return minimatch(urlToCheck, hostMatcher)
+  const matchUrl = (hostMatcher: string) => {
+    return minimatch(urlToCheckStripped, hostMatcher)
   }
 
-  return _.find(blockHosts, matchUrl)
+  return _.find(blockHostsNormalized, matchUrl)
 }

packages/network/lib/client-certificates.ts

@@ -2,8 +2,7 @@ import { URL, Url } from 'url'
 import debugModule from 'debug'
 import minimatch from 'minimatch'
 import fs from 'fs-extra'
-
-const { pki, asn1, pkcs12, util } = require('node-forge')
+import { pki, asn1, pkcs12, util } from 'node-forge'
 
 const debug = debugModule('cypress:network:client-certificates')
 
@@ -195,7 +194,22 @@ export const clientCertificateStoreSingleton = new ClientCertificateStore()
  * network ClientCertificateStore
  * @param config
  */
-export function loadClientCertificateConfig (config) {
+
+type Config = {
+  projectRoot: string
+  clientCertificates: Array<{
+    url: string
+    ca: string[]
+    certs: Array<{
+      cert: string
+      key: string
+      passphrase: string
+      pfx: string
+    }>
+  }>
+}
+
+export function loadClientCertificateConfig (config: Config) {
   const { clientCertificates } = config
 
   let index = 0
@@ -218,7 +232,7 @@ export function loadClientCertificateConfig (config) {
               const caRaw = loadBinaryFromFile(ca)
 
               try {
-                pki.certificateFromPem(caRaw)
+                pki.certificateFromPem(caRaw.toString())
               } catch (error: any) {
                 throw new Error(`Cannot parse CA cert: ${error.message}`)
               }
@@ -248,10 +262,10 @@ export function loadClientCertificateConfig (config) {
 
             debug(`loading PEM cert from '${cert.cert}'`)
             const pemRaw = loadBinaryFromFile(cert.cert)
-            let pemParsed = undefined
+            let pemParsed: pki.Certificate | undefined = undefined
 
             try {
-              pemParsed = pki.certificateFromPem(pemRaw)
+              pemParsed = pki.certificateFromPem(pemRaw.toString())
             } catch (error: any) {
               throw new Error(`Cannot parse PEM cert: ${error.message}`)
             }
@@ -270,13 +284,13 @@ export function loadClientCertificateConfig (config) {
 
             try {
               if (passphrase) {
-                if (!pki.decryptRsaPrivateKey(pemKeyRaw, passphrase)) {
+                if (!pki.decryptRsaPrivateKey(pemKeyRaw.toString(), passphrase)) {
                   throw new Error(
                     `Cannot decrypt PEM key with supplied passphrase (check the passphrase file content and that it doesn't have unexpected whitespace at the end)`,
                   )
                 }
               } else {
-                if (!pki.privateKeyFromPem(pemKeyRaw)) {
+                if (!pki.privateKeyFromPem(pemKeyRaw.toString())) {
                   throw new Error('Cannot load PEM key')
                 }
               }
@@ -363,7 +377,7 @@ function loadTextFromFile (filepath: string): string {
 /**
  * Extract subject from supplied pem instance
  */
-function extractSubjectFromPem (pem): string {
+function extractSubjectFromPem (pem: pki.Certificate): string {
   try {
     return pem.subject.attributes
     .map((attr) => [attr.shortName, attr.value].join('='))
@@ -391,9 +405,16 @@ function loadPfx (pfx: Buffer, passphrase: string | undefined) {
 /**
  * Extract subject from supplied pfx instance
  */
-function extractSubjectFromPfx (pfx) {
+function extractSubjectFromPfx (pfx: pkcs12.Pkcs12Pfx) {
   try {
-    const certs = pfx.getBags({ bagType: pki.oids.certBag })[pki.oids.certBag].map((item) => item.cert)
+    const bags = pfx.getBags({ bagType: pki.oids.certBag })
+    const certBag = bags[pki.oids.certBag]
+
+    if (!certBag || certBag.length === 0) {
+      throw new Error('No certificate bag found in PFX file')
+    }
+
+    const certs = certBag.map((item) => item.cert) as pki.Certificate[]
 
     return certs[0].subject.attributes.map((attr) => [attr.shortName, attr.value].join('=')).join(', ')
   } catch (e: any) {

packages/network/lib/connect.ts

@@ -58,7 +58,7 @@ export function getAddress (port: number, hostname: string): Bluebird<net.Addres
   .any()
 }
 
-export function getDelayForRetry (iteration) {
+export function getDelayForRetry (iteration: number) {
   return [0, 100, 200, 200][iteration]
 }
 
@@ -67,10 +67,10 @@ export interface RetryingOptions {
   port: number
   host: string | undefined
   useTls: boolean
-  getDelayMsForRetry: (iteration: number, err: Error) => number | undefined
+  getDelayMsForRetry: (iteration: number, err: Error | undefined) => number | undefined
 }
 
-function createSocket (opts: RetryingOptions, onConnect): net.Socket {
+function createSocket (opts: RetryingOptions, onConnect: () => void): net.Socket {
   const netOpts = _.defaults(_.pick(opts, 'family', 'host', 'port'), {
     family: 4,
   })
@@ -91,7 +91,7 @@ export function createRetryingSocket (
   }
 
   function tryConnect (iteration = 0) {
-    const retry = (err) => {
+    const retry = (err: Error | undefined) => {
       const delay = opts.getDelayMsForRetry(iteration, err)
 
       if (typeof delay === 'undefined') {
@@ -107,7 +107,7 @@ export function createRetryingSocket (
       }, delay)
     }
 
-    function onError (err) {
+    function onError (err: Error) {
       sock.on('error', (err) => {
         debug('second error received on retried socket %o', { opts, iteration, err })
       })

packages/network/lib/cors.ts

@@ -200,7 +200,7 @@ declare module 'url' {
   }
 }
 
-export function urlMatchesOriginProtectionSpace (urlStr, origin) {
+export function urlMatchesOriginProtectionSpace (urlStr: string, origin: string) {
   const normalizedUrl = uri.addDefaultPort(urlStr).format()
   const normalizedOrigin = uri.addDefaultPort(origin).format()
 

packages/network/package.json

@@ -2,10 +2,9 @@
   "name": "@packages/network",
   "version": "0.0.0-development",
   "private": true,
-  "main": "index.js",
+  "main": "cjs/index.js",
   "scripts": {
     "build": "yarn build:esm && yarn build:cjs",
-    "build-old": "tsc --project .",
     "build-prod": "yarn build",
     "build:cjs": "rimraf cjs && tsc -p tsconfig.cjs.json",
     "build:esm": "rimraf esm && tsc -p tsconfig.esm.json",
@@ -18,7 +17,8 @@
     "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 ."
+    "tslint": "tslint --config ../ts/tslint.json --project .",
+    "watch": "tsc -p tsconfig.cjs.json --watch"
   },
   "dependencies": {
     "@cypress/parse-domain": "2.4.0",
@@ -38,7 +38,9 @@
     "@packages/https-proxy": "0.0.0-development",
     "@packages/socket": "0.0.0-development",
     "@types/concat-stream": "1.6.0",
+    "@types/proxy-from-env": "1.0.4",
     "express": "4.21.0",
+    "rimraf": "6.0.1",
     "typescript": "~5.4.5",
     "vitest": "^3.2.4"
   },
@@ -47,5 +49,6 @@
     "esm"
   ],
   "types": "./lib/index.ts",
+  "module": "esm/index.js",
   "nx": {}
 }