chore: reowrked tests to use a runBrowserTest to allow previewing the results in a browser

2024-02-17 21:12:54 +01:00
parent 1c55b894c9
commit 3b540d0c48
7 changed files with 254 additions and 132 deletions
--- a/test/util/browser-test.ts
+++ b/test/util/browser-test.ts
@@ -0,0 +1,129 @@
+import {Plugin, InputPluginOption, RollupOptions, OutputOptions, RollupOutput} from "rollup";
+import {TestOptions as BrowserTestOptions, TestOutput as PuppeteerTestOutput} from "./puppeteer-run-test.js";
+import { rollup } from "rollup";
+import serveTest, {LogCallback} from "./serve-test.js";
+import type {ExecutionContext} from "ava";
+import {getCode, TestOutput} from "./code-output.ts";
+
+
+// /**
+//  * The AVA context used to test (ie t.snapshot(..) )
+//  */
+// t: ExecutionContext
+//
+//
+// filterOutput:{
+//     html: true,
+//         console: ['log','error','warn'],// TODO: or warning? need to check what possible values are
+//         errors: true, // again don't know possible values
+//         responses: true, // interesting to see what other values were requested
+//         requestsFailed: true, // will probably also be replicated into console errors, but helpful to have if imports werent found
+// }
+
+
+// try{
+//     // Track requests, errors and console
+//     page.on('console', message => {
+//         let [type, text] = [message.type(), message.text()];
+//         if(replaceHost){
+//             text = text.replaceAll(hostUrl, replaceHostWith!);
+//         }
+//         if((<any>filterOutput.console)?.includes?.(<any>type) ?? (filterOutput.console === true)){// TODO: add callback option
+//             output.console?.push(`[${type}] ${text}`);
+//         }
+//     }).on('pageerror', ({ message }) => {
+//         let text = message;
+//         if(replaceHost){
+//             text = text.replaceAll(hostUrl, replaceHostWith!);
+//         }
+//         if(filterOutput.errors === true) {// TODO add callback option
+//             output.errors?.push(text)
+//         }
+//     }).on('response', response => {
+//         let [status, url] = [response.status(), response.url()]
+//         if(replaceHost){
+//             url = url.replaceAll(hostUrl, replaceHostWith!);
+//         }
+//         if(filterOutput.responses === true) {// TODO add callback option
+//             output.responses?.push(`${status} ${url}`)
+//         }
+//     }).on('requestfailed', request => {
+//         let [failure, url] = [request.failure()?.errorText, request.url()];
+//         if(replaceHost){
+//             failure = failure?.replaceAll(hostUrl, replaceHostWith!);
+//             url = url.replaceAll(hostUrl, replaceHostWith!);
+//         }
+//         if(filterOutput.requestsFailed === true) {// TODO add callback option
+//             output.requestsFailed?.push(`${failure} ${url}`)
+//         }
+//     });
+
+//                     testOptions.t?.snapshot?.(testOutput);
+
+export interface OutputFilterOptions {
+    html?: boolean
+    console?: ('log'|'error'|'warn')[] | true
+    errors?: boolean, // again don't know possible values
+    responses?: boolean, // interesting to see what other values were requested
+    requestsFailed?: boolean, // will probably also be replicated into console errors, but helpful to have if imports werent found
+}
+export interface BrowserTestInput extends BrowserTestOptions{
+    log?: LogCallback;
+    /**
+     * Optionally specify what to filter from the output
+     */
+    filterOutput?: OutputFilterOptions;
+}
+
+
+export interface BrowserTestOutput extends PuppeteerTestOutput{
+    code: TestOutput[];
+}
+
+export  async function runBrowserTest(
+    build: RollupOptions,
+    test?: BrowserTestInput | false,
+    output?: OutputOptions
+) : Promise<Partial<BrowserTestOutput>>{
+    const resolvedPlugins = await Promise.resolve(build.plugins||null);
+    let pluginsArray : InputPluginOption[] = [];
+    if(resolvedPlugins && resolvedPlugins instanceof Array){
+        pluginsArray = resolvedPlugins
+    }else if(resolvedPlugins){
+        pluginsArray = [resolvedPlugins];
+    }
+
+    let testOutput: Partial<BrowserTestOutput> = {};
+    const bundle = await rollup({
+      ...build,
+        plugins: [
+            ...pluginsArray,
+            // TODO check if browser output is requested (either for snapshot or for testing)
+            ...(test? [serveTest({
+                // TODO: intercept output from the serveTest? (and include as one bit in output options below, for snapshotting)
+                ...test,
+                log: test.log ?? console.log,
+                onResult: (output)=>{
+                    testOutput = {...testOutput, ...output};
+                }
+            })]: [])
+        ]
+    });
+
+    // TODO make configurable?
+    const generated = await bundle.generate({
+        dir: 'output', // Output all files
+        format: 'es', //  iifi and cjs should be added to tests
+        sourcemap: true,// Test if #sourcemapUrl is not accidentally included in the html-output
+        chunkFileNames: '[name].js',
+        entryFileNames: '[name].mjs',
+        assetFileNames: '[name].[extname]',
+    });
+
+    if(output){
+        testOutput.code = await getCode(bundle, output);
+    }
+
+    return testOutput
+
+}