Nuxt/test/utils.ts

121 lines
3.5 KiB
TypeScript
Raw Normal View History

import { expect } from 'vitest'
import type { Page } from 'playwright'
import { parse } from 'devalue'
import { shallowReactive, shallowRef, reactive, ref } from 'vue'
import { createError } from 'h3'
import { createPage, getBrowser, url, useTestContext } from '@nuxt/test-utils'
export async function renderPage (path = '/') {
const ctx = useTestContext()
if (!ctx.options.browser) {
throw new Error('`renderPage` require `options.browser` to be set')
}
const browser = await getBrowser()
const page = await browser.newPage({})
const pageErrors: Error[] = []
const consoleLogs: { type: string, text: string }[] = []
page.on('console', (message) => {
consoleLogs.push({
type: message.type(),
text: message.text()
})
})
page.on('pageerror', (err) => {
pageErrors.push(err)
})
if (path) {
await page.goto(url(path), { waitUntil: 'networkidle' })
}
return {
page,
pageErrors,
consoleLogs
}
}
export async function expectNoClientErrors (path: string) {
const ctx = useTestContext()
if (!ctx.options.browser) {
return
}
2023-03-09 13:54:46 +00:00
const { page, pageErrors, consoleLogs } = (await renderPage(path))!
const consoleLogErrors = consoleLogs.filter(i => i.type === 'error')
const consoleLogWarnings = consoleLogs.filter(i => i.type === 'warning')
expect(pageErrors).toEqual([])
expect(consoleLogErrors).toEqual([])
expect(consoleLogWarnings).toEqual([])
2023-03-09 13:54:46 +00:00
await page.close()
}
type EqualityVal = string | number | boolean | null | undefined | RegExp
2023-01-22 16:46:45 +00:00
export async function expectWithPolling (
get: () => Promise<EqualityVal> | EqualityVal,
expected: EqualityVal,
2023-01-22 16:46:45 +00:00
retries = process.env.CI ? 100 : 30,
delay = process.env.CI ? 500 : 100
) {
let result: EqualityVal
2023-01-22 16:46:45 +00:00
for (let i = retries; i >= 0; i--) {
result = await get()
if (result?.toString() === expected?.toString()) {
2023-01-22 16:46:45 +00:00
break
}
await new Promise(resolve => setTimeout(resolve, delay))
}
expect(result?.toString(), `"${result?.toString()}" did not equal "${expected?.toString()}" in ${retries * delay}ms`).toEqual(expected?.toString())
2023-01-22 16:46:45 +00:00
}
export async function withLogs (callback: (page: Page, logs: string[]) => Promise<void>) {
let done = false
const page = await createPage()
const logs: string[] = []
page.on('console', (msg) => {
const text = msg.text()
if (done && !text.includes('[vite] server connection lost')) {
throw new Error(`Test finished prematurely before log: [${msg.type()}] ${text}`)
}
logs.push(text)
})
try {
await callback(page, logs)
} finally {
done = true
2023-03-09 13:54:46 +00:00
await page.close()
}
}
const revivers = {
NuxtError: (data: any) => createError(data),
EmptyShallowRef: (data: any) => shallowRef(JSON.parse(data)),
EmptyRef: (data: any) => ref(JSON.parse(data)),
ShallowRef: (data: any) => shallowRef(data),
ShallowReactive: (data: any) => shallowReactive(data),
Ref: (data: any) => ref(data),
Reactive: (data: any) => reactive(data),
// test fixture reviver only
BlinkingText: () => '<revivified-blink>'
}
export function parsePayload (payload: string) {
return parse(payload || '', revivers)
}
export function parseData (html: string) {
const { script, attrs } = html.match(/<script type="application\/json" id="__NUXT_DATA__"(?<attrs>[^>]+)>(?<script>.*?)<\/script>/)?.groups || {}
const _attrs: Record<string, string> = {}
for (const attr of attrs.matchAll(/( |^)(?<key>[\w-]+)+="(?<value>[^"]+)"/g)) {
_attrs[attr!.groups!.key] = attr!.groups!.value
}
return {
script: parsePayload(script || ''),
attrs: _attrs
}
}