convert file_server to TypeScript

Author: AtofStryker

packages/https-proxy/lib/index.ts

@@ -2,3 +2,5 @@ import { create as createProxy, reset as resetProxy } from './proxy'
 import { CA } from './ca'
 
 export { createProxy, resetProxy, CA }
+
+export type { Server } from './server'

packages/server/lib/file_server.js

@@ -0,0 +1,90 @@
+// TODO: move this to packages/core-file-server
+import _ from 'lodash'
+import debugModule from 'debug'
+import url from 'url'
+import http from 'http'
+import path from 'path'
+import send from 'send'
+import { httpUtils } from '@packages/network'
+import { allowDestroy } from './util/server_destroy'
+import random from './util/random'
+import networkFailures from './util/network_failures'
+import type { AddressInfo } from 'net'
+
+const debug = debugModule('cypress:server:file_server')
+
+export type FileServer = {
+  token: string
+  port: () => number
+  address: () => string
+  close: () => void
+}
+
+const onRequest = function (req: http.IncomingMessage, res: http.ServerResponse, expectedToken: string, fileServerFolder: string) {
+  const token = req.headers['x-cypress-authorization']
+
+  if (token !== expectedToken) {
+    debug('authorization failed on file_server request %o', { reqUrl: req.url, expectedToken, token })
+    res.statusCode = 401
+    res.end()
+
+    return
+  }
+
+  const args = _.compact([
+    fileServerFolder,
+    req.url,
+  ])
+
+  // strip off any query params from our req's url
+  // since we're pulling this from the file system
+  // it does not understand query params
+  // and make sure we decode the uri which swaps out
+  // %20 with white space
+  const file = decodeURI(url.parse(path.join(...args)).pathname as string)
+
+  res.setHeader('x-cypress-file-path', encodeURI(file))
+
+  return send(req, url.parse(req.url as string).pathname as string, {
+    root: path.resolve(fileServerFolder),
+  })
+  .on('error', (err) => {
+    res.setHeader('x-cypress-file-server-error', 'true')
+    res.setHeader('content-type', 'text/html')
+    res.statusCode = err.status
+
+    return res.end(networkFailures.get(file, err.status))
+  }).pipe(res)
+}
+
+export const create = (fileServerFolder: string): Promise<FileServer> => {
+  return new Promise(((resolve) => {
+    const token = random.id(64)
+
+    const srv = http.createServer(httpUtils.lenientOptions, (req: http.IncomingMessage, res: http.ServerResponse) => {
+      return onRequest(req, res, token, fileServerFolder)
+    })
+
+    allowDestroy(srv)
+
+    return srv.listen(0, '127.0.0.1', () => {
+      return resolve({
+        token,
+
+        port () {
+          return (srv.address() as AddressInfo).port
+        },
+
+        address () {
+          // @ts-expect-error - port is defined on the object context
+          return `http://localhost:${this.port()}`
+        },
+
+        close () {
+          // @ts-expect-error - destroyAsync is defined when allowDestroy is called
+          return srv.destroyAsync()
+        },
+      })
+    })
+  }))
+}

packages/server/lib/file_server.ts

@@ -12,6 +12,7 @@ import type { AddressInfo } from 'net'
 import url from 'url'
 import la from 'lazy-ass'
 import { createProxy as createHttpsProxy } from '@packages/https-proxy'
+import type { Server as HttpsProxyServer } from '@packages/https-proxy'
 import { getRoutesForRequest, netStubbingState, NetStubbingState } from '@packages/net-stubbing'
 import { agent, clientCertificates, httpUtils, concatStream } from '@packages/network'
 import { DocumentDomainInjection, getPath, parseUrlIntoHostProtocolDomainTldPort, removeDefaultPort } from '@packages/network-tools'
@@ -33,7 +34,7 @@ import type { Server as WebSocketServer } from 'ws'
 import { RemoteStates, RemoteState } from './remote_states'
 import { cookieJar, SerializableAutomationCookie } from './util/cookies'
 import { resourceTypeAndCredentialManager, ResourceTypeAndCredentialManager } from './util/resourceTypeAndCredentialManager'
-import fileServer from './file_server'
+import * as fileServer from './file_server'
 import appData from './util/app_data'
 import { graphqlWS } from '@packages/data-context/graphql/makeGraphQLServer'
 import statusCode from './util/status_code'
@@ -291,11 +292,11 @@ export class ServerBase<TSocket extends SocketE2E | SocketCt> {
             onUpgrade: this.onSniUpgrade.bind(this),
           }),
 
-          fileServer.create(fileServerFolder),
+          fileServer.create(fileServerFolder as string),
         ])
         .spread((httpsProxy, fileServer) => {
-          this._httpsProxy = httpsProxy
-          this._fileServer = fileServer
+          this._httpsProxy = httpsProxy as HttpsProxyServer
+          this._fileServer = fileServer as FileServer
 
           // if we have a baseUrl let's go ahead
           // and make sure the server is connectable!