chore: refactor server request to TypeScript (#33610)

* chore: convert stream_buffer to TypeScript

* chore: convert request to TypeScript and to ES6 class

* fix: actually use rp in the deferredsourcemapcache and pass in the correct options to the request

Author: AtofStryker

packages/proxy/lib/http/index.ts

@@ -26,6 +26,7 @@ import type { Readable } from 'stream'
 import type { Request, Response } from 'express'
 import type { RemoteStates } from '@packages/server/lib/remote_states'
 import type { CookieJar, SerializableAutomationCookie } from '@packages/server/lib/util/cookies'
+import type { Request as ServerRequest } from '@packages/server/lib/request'
 import type { FoundBrowser, ProtocolManagerShape } from '@packages/types'
 import type Protocol from 'devtools-protocol'
 import type { ServiceWorkerClientEvent } from './util/service-worker-manager'
@@ -98,7 +99,7 @@ export type ServerCtx = Readonly<{
   netStubbingState: NetStubbingState
   middleware: HttpMiddlewareStacks
   socket: SocketBroadcaster
-  request: any
+  request: ServerRequest
   serverBus: EventEmitter
   getCurrentBrowser: () => FoundBrowser
 }>
@@ -273,7 +274,7 @@ export class Http {
   netStubbingState: NetStubbingState
   preRequests: PreRequests = new PreRequests()
   getCurrentBrowser: () => FoundBrowser
-  request: any
+  request: ServerRequest
   socket: SocketBroadcaster
   serverBus: EventEmitter
   renderedHTMLOrigins: {[key: string]: boolean} = {}
@@ -284,7 +285,7 @@ export class Http {
 
   constructor (opts: ServerCtx & { middleware?: HttpMiddlewareStacks }) {
     this.buffers = new HttpBuffers()
-    this.deferredSourceMapCache = new DeferredSourceMapCache(opts.request)
+    this.deferredSourceMapCache = new DeferredSourceMapCache(opts.request.rp)
     this.config = opts.config
     this.shouldCorrelatePreRequests = opts.shouldCorrelatePreRequests || (() => false)
     this.getFileServerToken = opts.getFileServerToken

packages/proxy/test/integration/net-stubbing.spec.ts

@@ -13,7 +13,7 @@ import { DocumentDomainInjection } from '@packages/network-tools'
 import { EventEmitter } from 'events'
 import { RemoteStates } from '@packages/server/lib/remote_states'
 import { CookieJar } from '@packages/server/lib/util/cookies'
-const Request = require('@packages/server/lib/request')
+import { Request as ServerRequest } from '@packages/server/lib/request'
 const getFixture = async () => {}
 
 describe('network stubbing', () => {
@@ -59,7 +59,7 @@ describe('network stubbing', () => {
       getCookieJar: () => new CookieJar(),
       remoteStates,
       getFileServerToken: () => 'fake-token',
-      request: new Request(),
+      request: new ServerRequest(),
       getRenderedHTMLOrigins: () => ({}),
       serverBus: new EventEmitter(),
       getCurrentBrowser: vi.fn(),

packages/proxy/test/unit/http/index.spec.ts

@@ -28,7 +28,7 @@ describe('http', function () {
         [HttpStages.Error]: { error },
       }
 
-      httpOpts = { config, middleware } as ServerCtx & { middleware?: HttpMiddlewareStacks }
+      httpOpts = { config, middleware, request: { rp: vi.fn() } } as ServerCtx & { middleware?: HttpMiddlewareStacks } & { request: { rp: Mock } }
     })
 
     it('calls IncomingRequest stack, then IncomingResponse stack', async function () {
@@ -277,7 +277,7 @@ describe('http', function () {
     let httpOpts
 
     beforeEach(function () {
-      httpOpts = { config: {}, middleware: {} }
+      httpOpts = { config: {}, middleware: {}, request: { rp: vi.fn() } }
     })
 
     it('resets preRequests when resetBetweenSpecs is true', function () {
@@ -321,7 +321,7 @@ describe('http', function () {
         [HttpStages.Error]: { error },
       }
 
-      httpOpts = { config, middleware } as ServerCtx & { middleware?: HttpMiddlewareStacks }
+      httpOpts = { config, middleware, request: { rp: vi.fn() } } as ServerCtx & { middleware?: HttpMiddlewareStacks } & { request: { rp: Mock } }
     })
 
     it('properly ignores requests that are controlled by a service worker', () => {

packages/rewriter/lib/deferred-source-map-cache.ts

@@ -3,6 +3,7 @@ import Debug from 'debug'
 import { rewriteJsSourceMapAsync } from './async-rewriters'
 import * as sourceMaps from './util/source-maps'
 import url from 'url'
+import type cypressRequestPromise from '@cypress/request-promise'
 
 const debug = Debug('cypress:rewriter:deferred-source-map-cache')
 
@@ -39,10 +40,10 @@ const getSourceMapHeader = (headers) => {
 export class DeferredSourceMapCache {
   _idCounter = 0
   requests: DeferredSourceMapRequest[] = []
-  requestLib: any
+  requestPromise: typeof cypressRequestPromise
 
-  constructor (requestLib) {
-    this.requestLib = requestLib
+  constructor (requestPromiseInstance: typeof cypressRequestPromise) {
+    this.requestPromise = requestPromiseInstance
   }
 
   defer = (request: DeferredSourceMapRequest) => {
@@ -82,16 +83,17 @@ export class DeferredSourceMapCache {
 
     // try to load it from the web
     const req = {
-      url: url.resolve(request.url, sourceMapUrl),
+      uri: url.resolve(request.url, sourceMapUrl),
       // TODO: this assumes that the sourcemap is on the same base domain, so it's safe to send the same headers
       // the browser sent for this sourcemap request - but if sourcemap is on a different domain, this will not
       // be true. need to use browser's cookiejar instead.
       headers,
       timeout: 5000,
+      resolveWithFullResponse: true,
     }
 
     try {
-      const { body } = await this.requestLib(req, true)
+      const { body } = await this.requestPromise(req)
 
       return body
     } catch (error) {

packages/rewriter/test/unit/deferred-source-map-cache.spec.ts

@@ -1,4 +1,5 @@
 import { describe, expect, it, vi } from 'vitest'
+import cypressRequestPromise from '@cypress/request-promise'
 import { DeferredSourceMapCache } from '../../lib/deferred-source-map-cache'
 import {
   testSourceWithExternalSourceMap,
@@ -11,7 +12,7 @@ describe('DeferredSourceMapCache', function () {
   let cache: DeferredSourceMapCache
 
   beforeEach(() => {
-    cache = new DeferredSourceMapCache(vi.fn())
+    cache = new DeferredSourceMapCache(vi.fn() as unknown as typeof cypressRequestPromise)
   })
 
   describe('#defer', () => {
@@ -109,16 +110,18 @@ describe('DeferredSourceMapCache', function () {
               return
             }
 
-            expect(cache.requestLib).toHaveBeenCalledWith({
-              url: 'http://somedomain.net/dir/test.js.map',
+            expect(cache.requestPromise).toHaveBeenCalledWith({
+              uri: 'http://somedomain.net/dir/test.js.map',
               headers: {},
               timeout: 5000,
-            }, true)
+              resolveWithFullResponse: true,
+            })
           }
         }
 
         beforeEach(() => {
-          cache.requestLib.mockResolvedValue({ body: testSourceMap })
+          // @ts-expect-error: @cypress/request-promise not typed
+          cache.requestPromise.mockResolvedValue({ body: testSourceMap })
         })
 
         it('with inlined base64 sourceMappingURL', testExternalSourceMap(testSourceWithInlineSourceMap, {}, false))