/*
* The MIT License (MIT)
*
* Copyright (c) 2015 - present Instructure, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
///
import { defineConfig } from 'vitest/config'
import { playwright } from '@vitest/browser-playwright'
import path from 'path'
import fs from 'fs'
import crypto from 'crypto'
import { createRequire } from 'module'
const require = createRequire(import.meta.url)
const momentTimezoneDir = path.dirname(require.resolve('moment-timezone'))
const momentDir = path.dirname(
require.resolve('moment', { paths: [momentTimezoneDir] })
)
const momentWithLocales = path.join(momentDir, 'min', 'moment-with-locales.js')
const packageDir = (pkgName: string) =>
path.resolve(__dirname, 'packages', pkgName.replace('@instructure/', ''))
// Packages deliberately NOT aliased to source, so Vite resolves them to their
// built `es/` output.
// This trades DX for speed — after editing the *source* of one
// of these, run that package's `build` before browser tests will see the change.
const PREBUNDLED_PACKAGES = ['@instructure/ui-icons', '@instructure/ui-themes']
PREBUNDLED_PACKAGES.filter((pkgName) => {
if (!fs.existsSync(path.join(packageDir(pkgName), 'es', 'index.js'))) {
throw new Error(`${pkgName} has no es/ build, run \`pnpm run bootstrap\`.`)
}
})
// Prebundled alongside PREBUNDLED_PACKAGES, but resolved from node_modules.
// SSR/hydration tests are the only that import these. Without prebundling,
// Vite may re-optimize mid-run, breaking dynamic imports and
// causing React and react-dom/server to use different optimizer generations.
const PREBUNDLED_MODULES = ['react-dom/server', 'react-dom/client']
const OPTIMIZED_DEPS = [...PREBUNDLED_PACKAGES, ...PREBUNDLED_MODULES]
// Uses CJS resolution; ESM-only entries may need a different check.
OPTIMIZED_DEPS.forEach((entry) => {
try {
require.resolve(entry, { paths: [__dirname] })
} catch {
throw new Error(
`optimizeDeps.include entry "${entry}" cannot be resolved from the repo ` +
`root, so Vite would skip prebundling it. Add it to the root ` +
`package.json devDependencies.`
)
}
})
// Create a hash of every file's updated time. This hash changes if any file's
// updated time changes
function getPrebundleStamp() {
const entries = PREBUNDLED_PACKAGES.flatMap((pkgName) =>
fs
.readdirSync(path.join(packageDir(pkgName), 'es'), {
recursive: true,
withFileTypes: true
})
.filter((entry) => entry.isFile())
.map((entry) => {
const file = path.join(entry.parentPath, entry.name)
return `${file}:${fs.statSync(file).mtimeMs}`
})
)
// sort to keep the hash stable across runs
return crypto
.createHash('sha1')
.update(entries.sort().join('\n'))
.digest('hex')
}
// Build Vite resolve aliases for every @instructure/* workspace package,
// pointing bare/subpath specifiers at TypeScript source.
// This lets browser-mode tests run without pre-building the library — Vite
// transforms source on demand.
function getWorkspaceAliases() {
const packagesDir = path.resolve(__dirname, 'packages')
const aliases: { find: string | RegExp; replacement: string }[] = []
for (const pkg of fs.readdirSync(packagesDir)) {
const pkgPath = path.join(packagesDir, pkg)
if (!fs.statSync(pkgPath).isDirectory()) continue
const pkgJsonPath = path.join(pkgPath, 'package.json')
if (!fs.existsSync(pkgJsonPath)) continue
const pkgJson = JSON.parse(fs.readFileSync(pkgJsonPath, 'utf8'))
const pkgName: string | undefined = pkgJson.name
if (!pkgName || !pkgName.startsWith('@instructure/')) continue
if (PREBUNDLED_PACKAGES.includes(pkgName)) continue
if (pkgJson.exports) {
for (const [subpath, target] of Object.entries(pkgJson.exports)) {
if (subpath.includes('*')) continue
const importPath =
(typeof target === 'object' ? target.import : target) || ''
// Map built output path (./es/X.js) back to source (./src/X.ts)
const srcPath = importPath
.replace(/^\.\/es\//, './src/')
.replace(/\.js$/, '.ts')
const resolved = path.join(pkgPath, srcPath)
if (!fs.existsSync(resolved)) continue
if (subpath === '.') {
// exact bare-name match: `@instructure/ui-x`
aliases.push({
find: new RegExp(`^${pkgName}$`),
replacement: resolved
})
} else {
// exact subpath match: `@instructure/ui-x/latest`
const sub = subpath.replace(/^\.\//, '')
aliases.push({
find: new RegExp(`^${pkgName}/${sub}$`),
replacement: resolved
})
}
}
}
// source imports: `@instructure/ui-x/src/...` -> package src dir
aliases.push({
find: `${pkgName}/src`,
replacement: path.join(pkgPath, 'src')
})
}
return aliases
}
export default defineConfig({
test: {
globals: true,
watchTriggerPatterns: [
{
// matches any file inside the __testfixtures__ directory
pattern: /^.*\/ui-codemods\/.*\/__testfixtures__\/.*$/,
// file is the full path. e.g. /Users/MyUser/code/instructure-ui/packages/ui-codemods/lib/__node_tests__/__testfixtures__/colors.input.ts
testsToRun: (file, _match) => {
const dirName = path.basename(path.dirname(file))
// reruns all tests that match the directory name of the test fixture
return `packages/ui-codemods/lib/__node_tests__/${dirName}.test.ts`
}
}
],
projects: [
// Node script tests
{
test: {
globals: true,
include: ['{packages,scripts}/**/__node_tests__/**/*.test.{ts,tsx}'],
environment: 'node',
name: { label: 'node', color: 'magenta' }
}
},
// Real browser tests
{
test: {
globals: true, // TODO try to set it to false
include: ['packages/**/__tests__/**/*.test.tsx'],
setupFiles: './vitest.setup.browser.ts',
name: { label: 'browser', color: 'green' },
browser: {
enabled: true,
provider: playwright(),
headless: true,
instances: [{ browser: 'chromium' }],
screenshotFailures: false,
commands: {
// off-page, so it hovers nothing the test renders
resetMouse: async ({ page }) => {
await page.mouse.move(-1, -1)
}
}
}
},
// A plugin that does nothing: it exists so the stamp becomes part of
// the dep optimizer's cache key, which hashes `plugins.map(p => p.name)`.
plugins: [{ name: `instui-prebundle-stamp:${getPrebundleStamp()}` }],
optimizeDeps: {
// https://vite.dev/config/dep-optimization-options#optimizedeps-include
include: OPTIMIZED_DEPS
},
resolve: {
// Keep a single copy of React.
// Prevents errors when a dependency pulls in a different version.
dedupe: ['react', 'react-dom'],
alias: [
// Bare `moment` -> the all-locales build. Matches
// `moment` exactly, never `moment-timezone` or `moment/`.
{ find: /^moment$/, replacement: momentWithLocales },
// `moment/` -> resolved package dir (e.g. moment/locale/*).
{ find: /^moment\/(.*)$/, replacement: path.join(momentDir, '$1') },
...getWorkspaceAliases()
]
}
}
]
}
})