chore: refactor network into two packages, network and network-tools. network-tools is expected to be used in simple environments, where network is intended to be used in the node context. additionally, makes these packages bundable and removes the ts-node entrypoint to make ESM possible.

Author: AtofStryker

.circleci/src/pipeline/@pipeline.yml

@@ -198,6 +198,8 @@ commands:
           name: Sync Cloud Validations
           command: |
             source ./scripts/ensure-node.sh
+            yarn workspace @packages/network-tools build
+            yarn workspace @packages/network build
             yarn gulp syncCloudValidations
       - run:
           name: Build packages
@@ -1234,6 +1236,8 @@ commands:
           name: Check if binary exists, exit if it does
           command: |
             source ./scripts/ensure-node.sh
+            yarn workspace @packages/network-tools build
+            yarn workspace @packages/network build
             yarn gulp e2eTestScaffold
             yarn check-binary-on-cdn --version $(node ./scripts/get-next-version.js) --type binary --file cypress.zip
 

guides/esm-migration.md

@@ -53,7 +53,8 @@ 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/network-tools ✅ **COMPLETED**
 - [x] packages/packherd-require ✅ **COMPLETED**
 - [ ] packages/proxy **PARTIAL** - entry point is JS
 - [x] packages/reporter ✅ **COMPLETED**
@@ -103,6 +104,7 @@ When migrating some of these projects away from the `ts-node` entry [see `@packa
 - [ ] packages/launcher
 - [ ] packages/net-stubbing
 - [x] packages/network ✅ **COMPLETED**
+- [x] packages/network-tools ✅ **COMPLETED**
 - [ ] packages/packherd-require
 - [ ] packages/proxy
 - [x] packages/rewriter ✅ **COMPLETED**

packages/config/package.json

@@ -40,12 +40,13 @@
   },
   "devDependencies": {
     "@packages/errors": "0.0.0-development",
-    "@packages/network": "0.0.0-development",
+    "@packages/network-tools": "0.0.0-development",
     "@packages/root": "0.0.0-development",
     "@packages/ts": "0.0.0-development",
     "@packages/types": "0.0.0-development",
     "babel-plugin-tester": "^10.1.0",
     "rimraf": "6.0.1",
+    "typescript": "~5.4.5",
     "vitest": "^3.2.4"
   },
   "files": [

packages/config/src/utils.ts

@@ -1,6 +1,6 @@
 import _ from 'lodash'
 import { toBoolean } from 'underscore.string'
-import * as uri from '@packages/network/lib/uri'
+import { origin } from '@packages/network-tools'
 
 export const hideKeys = (token?: string | number | boolean) => {
   if (!token) {
@@ -26,7 +26,7 @@ export function setUrls (obj: any) {
   const proxyUrl = `http://localhost:${obj.port}`
 
   const rootUrl = obj.baseUrl
-    ? uri.origin(obj.baseUrl)
+    ? origin(obj.baseUrl)
     : proxyUrl
 
   return {

packages/driver/package.json

@@ -26,7 +26,7 @@
     "@packages/config": "0.0.0-development",
     "@packages/errors": "0.0.0-development",
     "@packages/net-stubbing": "0.0.0-development",
-    "@packages/network": "0.0.0-development",
+    "@packages/network-tools": "0.0.0-development",
     "@packages/proxy": "0.0.0-development",
     "@packages/rewriter": "0.0.0-development",
     "@packages/runner": "0.0.0-development",

packages/driver/src/cy/commands/origin/validator.ts

@@ -2,8 +2,7 @@ import $utils from '../../../cypress/utils'
 import $errUtils from '../../../cypress/error_utils'
 import { difference, isPlainObject, isString, isFunction } from 'lodash'
 import type { LocationObject } from '../../../cypress/location'
-import * as cors from '@packages/network/lib/cors'
-import { DocumentDomainInjection } from '@packages/network/lib/document-domain-injection'
+import { policyFromConfig, DocumentDomainInjection } from '@packages/network-tools'
 
 const validOptionKeys = Object.freeze(['args'])
 
@@ -87,7 +86,7 @@ export class Validator {
 
     const injector = DocumentDomainInjection.InjectionBehavior(Cypress.config())
 
-    const policy = cors.policyFromConfig({ injectDocumentDomain: Cypress.config('injectDocumentDomain') })
+    const policy = policyFromConfig({ injectDocumentDomain: Cypress.config('injectDocumentDomain') })
 
     if (injector.urlsMatch(originLocation.href, specHref)) {
       $errUtils.throwErrByPath('origin.invalid_url_argument_same_origin', {

packages/driver/src/cypress.ts

@@ -45,7 +45,7 @@ import { PrimaryOriginCommunicator, SpecBridgeCommunicator } from './cross-origi
 import { setupAutEventHandlers } from './cypress/aut_event_handlers'
 
 import type { CachedTestState, ReporterRunState, RunState } from '@packages/types'
-import { DocumentDomainInjection } from '@packages/network/lib/document-domain-injection'
+import { DocumentDomainInjection } from '@packages/network-tools'
 import { setSpecContentSecurityPolicy } from './util/privileged_channel'
 
 import { telemetry } from '@packages/telemetry/src/browser'

packages/driver/src/cypress/location.ts

@@ -8,7 +8,7 @@
 
 import _ from 'lodash'
 import UrlParse from 'url-parse'
-import * as cors from '@packages/network/lib/cors'
+import { getSuperDomain, getSuperDomainOrigin } from '@packages/network-tools'
 
 const reHttp = /^https?:\/\//
 const reWww = /^www/
@@ -106,11 +106,11 @@ export class $Location {
   }
 
   getSuperDomainOrigin () {
-    return cors.getSuperDomainOrigin(this.remote.href)
+    return getSuperDomainOrigin(this.remote.href)
   }
 
   getSuperDomain () {
-    return cors.getSuperDomain(this.remote.href)
+    return getSuperDomain(this.remote.href)
   }
 
   getToString () {

packages/network-tools/.eslintignore

@@ -0,0 +1 @@
+**/tsconfig.json

packages/network-tools/.gitignore

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