mirror of
https://github.com/cypress-io/cypress.git
synced 2026-05-07 23:40:21 -05:00
Tim Griesser
181 lines
4.9 KiB
TypeScript
181 lines
4.9 KiB
TypeScript
import httpProxy from 'http-proxy'
|
|
import _ from 'lodash'
|
|
import Debug from 'debug'
|
|
import { ErrorRequestHandler, Router } from 'express'
|
|
import send from 'send'
|
|
import { getPathToDist } from '@packages/resolve-dist'
|
|
|
|
import { fs } from './util/fs'
|
|
import type { SpecsStore } from './specs-store'
|
|
import type { Browser } from './browsers/types'
|
|
import type { NetworkProxy } from '@packages/proxy'
|
|
import type { Cfg } from './project-base'
|
|
import xhrs from './controllers/xhrs'
|
|
import { runner, ServeOptions } from './controllers/runner'
|
|
import { iframesController } from './controllers/iframes'
|
|
import type { DataContext } from '@packages/data-context/src/DataContext'
|
|
|
|
const debug = Debug('cypress:server:routes')
|
|
|
|
export interface InitializeRoutes {
|
|
ctx: DataContext
|
|
specsStore: SpecsStore
|
|
config: Cfg
|
|
getSpec: () => Cypress.Spec | null
|
|
getCurrentBrowser: () => Browser
|
|
nodeProxy: httpProxy
|
|
networkProxy: NetworkProxy
|
|
getRemoteState: () => Cypress.RemoteState
|
|
onError: (...args: unknown[]) => any
|
|
testingType: Cypress.TestingType
|
|
exit?: boolean
|
|
}
|
|
|
|
function replaceBody (ctx: DataContext) {
|
|
return `<body><script>window.__CYPRESS_GRAPHQL_PORT__ = ${JSON.stringify(ctx.gqlServerPort)};</script>\n`
|
|
}
|
|
|
|
export const createCommonRoutes = ({
|
|
config,
|
|
networkProxy,
|
|
testingType,
|
|
getSpec,
|
|
getCurrentBrowser,
|
|
specsStore,
|
|
getRemoteState,
|
|
nodeProxy,
|
|
ctx,
|
|
exit,
|
|
}: InitializeRoutes) => {
|
|
const makeServeConfig = (options: Partial<ServeOptions>) => {
|
|
const config = {
|
|
...options.config,
|
|
testingType,
|
|
browser: options.getCurrentBrowser?.(),
|
|
specs: options.specsStore?.specFiles,
|
|
} as Cfg
|
|
|
|
if (testingType === 'e2e') {
|
|
config.remote = getRemoteState()
|
|
}
|
|
|
|
// TODO: move the component file watchers in here
|
|
// and update them in memory when they change and serve
|
|
// them straight to the HTML on load
|
|
|
|
debug('serving runner index.html with config %o',
|
|
_.pick(config, 'version', 'platform', 'arch', 'projectName'))
|
|
|
|
// base64 before embedding so user-supplied contents can't break out of <script>
|
|
// https://github.com/cypress-io/cypress/issues/4952
|
|
|
|
const base64Config = Buffer.from(JSON.stringify(config)).toString('base64')
|
|
|
|
return {
|
|
base64Config,
|
|
projectName: config.projectName,
|
|
}
|
|
}
|
|
|
|
const router = Router()
|
|
|
|
router.get(['/api', '/__/api'], (req, res) => {
|
|
const options = makeServeConfig({
|
|
config,
|
|
getCurrentBrowser,
|
|
specsStore,
|
|
})
|
|
|
|
res.json(options)
|
|
})
|
|
|
|
if (process.env.CYPRESS_INTERNAL_VITE_APP_PORT) {
|
|
const proxy = httpProxy.createProxyServer({
|
|
target: `http://localhost:${process.env.CYPRESS_INTERNAL_VITE_APP_PORT}/`,
|
|
})
|
|
|
|
router.get('/__vite__/', (req, res) => {
|
|
ctx.html.appHtml().then((html) => res.send(html)).catch((e) => res.status(500).send({ stack: e.stack }))
|
|
})
|
|
|
|
// TODO: can namespace this onto a "unified" route like __app-unified__
|
|
// make sure to update the generated routes inside of vite.config.ts
|
|
router.get('/__vite__/*', (req, res) => {
|
|
debug('Proxy to __vite__')
|
|
proxy.web(req, res, {}, (e) => {})
|
|
})
|
|
} else {
|
|
router.get('/__vite__/*', (req, res) => {
|
|
const pathToFile = getPathToDist('app', req.params[0])
|
|
|
|
if (req.params[0] === '') {
|
|
return fs.readFile(pathToFile, 'utf8')
|
|
.then((file) => {
|
|
res.send(file.replace('<body>', replaceBody(ctx)))
|
|
})
|
|
}
|
|
|
|
return send(req, pathToFile).pipe(res)
|
|
})
|
|
}
|
|
|
|
router.get('/__cypress/runner/*', (req, res) => {
|
|
runner.handle(testingType, req, res)
|
|
})
|
|
|
|
router.all('/__cypress/xhrs/*', (req, res, next) => {
|
|
xhrs.handle(req, res, config, next)
|
|
})
|
|
|
|
router.get('/__cypress/iframes/*', (req, res) => {
|
|
if (testingType === 'e2e') {
|
|
iframesController.e2e({ config, getSpec, getRemoteState }, req, res)
|
|
}
|
|
|
|
if (testingType === 'component') {
|
|
iframesController.component({ config, nodeProxy }, req, res)
|
|
}
|
|
})
|
|
|
|
const clientRoute = config.clientRoute
|
|
|
|
if (!clientRoute) {
|
|
throw Error(`clientRoute is required. Received ${clientRoute}`)
|
|
}
|
|
|
|
router.get(clientRoute, (req, res) => {
|
|
debug('Serving Cypress front-end by requested URL:', req.url)
|
|
|
|
runner.serve(req, res, testingType === 'e2e' ? 'runner' : 'runner-ct', {
|
|
config,
|
|
testingType,
|
|
getSpec,
|
|
getCurrentBrowser,
|
|
getRemoteState,
|
|
specsStore,
|
|
exit,
|
|
})
|
|
})
|
|
|
|
router.all('*', (req, res) => {
|
|
networkProxy.handleHttpRequest(req, res)
|
|
})
|
|
|
|
// when we experience uncaught errors
|
|
// during routing just log them out to
|
|
// the console and send 500 status
|
|
// and report to raygun (in production)
|
|
const errorHandlingMiddleware: ErrorRequestHandler = (err, req, res) => {
|
|
console.log(err.stack) // eslint-disable-line no-console
|
|
|
|
res.set('x-cypress-error', err.message)
|
|
res.set('x-cypress-stack', JSON.stringify(err.stack))
|
|
|
|
res.sendStatus(500)
|
|
}
|
|
|
|
router.use(errorHandlingMiddleware)
|
|
|
|
return router
|
|
}
|