Files
cypress/npm/vite-dev-server/client/initCypressTests.js
T
Bill Glesias 079030bb5f feat: support vite v5 (#29518)
* feat: support vite v5 [run ci]

* make sure to use correct path in windows if no cypress public path is provided [run ci]

* update snapshot [run ci]

* update docs on devServerPublicPathRoute for vite-dev-server

* update comments

* refactor resolveConfig test

---------

Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
2024-05-21 12:49:09 -04:00

98 lines
3.9 KiB
JavaScript

// This file is merged in a <script type=module> into index.html
// it will be used to load and kick start the selected spec
const CypressInstance = window.Cypress = parent.Cypress
const importsToLoad = []
/* Support file import logic, this should be removed once we
* are able to return relative paths from the supportFile
* Jira #UNIFY-1260
*/
const supportFile = CypressInstance.config('supportFile')
const projectRoot = CypressInstance.config('projectRoot')
const devServerPublicPathRoute = CypressInstance.config('devServerPublicPathRoute')
let devServerPublicPathBase = devServerPublicPathRoute
// In the case the devServerPublicPathRoute is set to the root, make sure we configure the loaders correctly to load relative paths
// This can be a case in vite 5 if a user wishes to have the same public path as their app (which is quite common)
if (devServerPublicPathRoute === '') {
devServerPublicPathBase = '.'
}
if (supportFile) {
let supportRelativeToProjectRoot = supportFile.replace(projectRoot, '')
if (CypressInstance.config('platform') === 'win32') {
const platformProjectRoot = projectRoot.replaceAll('/', '\\')
supportRelativeToProjectRoot = supportFile.replace(platformProjectRoot, '')
// Support relative path (as well as in some cases absolute path) lookup is done with unix style operators.
supportRelativeToProjectRoot = supportRelativeToProjectRoot.replaceAll('\\', '/')
}
// We need a slash before /cypress/supportFile.js if the devServerPublicPathRoute is populated, this happens by default
// with the current string replacement logic. Otherwise, we need to specify the relative path to look up if devServerPublicPathRoute
// is not defined as it would be in the base directory
const relativeUrl = `${devServerPublicPathBase}${supportRelativeToProjectRoot}`
importsToLoad.push({
load: () => import(relativeUrl),
absolute: supportFile,
relative: supportRelativeToProjectRoot,
relativeUrl,
})
}
// Using relative path wouldn't allow to load tests outside Vite project root folder
// So we use the "@fs" bit to load the test file using its absolute path
// Normalize path to not include a leading slash (different on Win32 vs Unix)
const normalizedAbsolutePath = CypressInstance.spec.absolute.replace(/^\//, '')
const testFileAbsolutePathRoute = `${devServerPublicPathBase}/@fs/${normalizedAbsolutePath}`
/* Spec file import logic */
// We need a slash before /src/my-spec.js, this does not happen by default.
importsToLoad.push({
load: () => import(testFileAbsolutePathRoute),
absolute: CypressInstance.spec.absolute,
relative: CypressInstance.spec.relative,
relativeUrl: testFileAbsolutePathRoute,
})
if (!CypressInstance) {
throw new Error('Tests cannot run without a reference to Cypress!')
}
// load the support and spec
CypressInstance.onSpecWindow(window, importsToLoad)
// then start the test process
CypressInstance.action('app:window:before:load', window)
// Before all tests we are mounting the root element,
// Cleaning up platform between tests is the responsibility of the specific adapter
// because unmounting react/vue component should be done using specific framework API
// (for devtools and to get rid of global event listeners from previous tests.)
CypressInstance.on('test:before:run', () => {
// leave the error overlay alone if it exists
if (document.body.querySelectorAll('vite-error-overlay').length) {
// make the error more readable by giving it more space
Cypress.action('cy:viewport:changed', { viewportWidth: 1000, viewportHeight: 500 })
return
}
// reset the viewport to default when in normal mode
Cypress.action('cy:viewport:changed', {
viewportWidth: Cypress.config('viewportWidth'),
viewportHeight: Cypress.config('viewportHeight'),
})
})
// Make usage of node test plugins possible
window.global = window
window.process = typeof process !== 'undefined' ? process : {}