lwc/packages/@lwc/integration-not-karma/configs/base.js at 0734767eb3ab0295a888f233aa9c9c40b7dd54d5 · salesforce/lwc · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
import { join } from 'node:path';
import { LWC_VERSION } from '@lwc/shared';
import { resolvePathOutsideRoot } from '../helpers/utils.js';

/**
 * We want to convert from parsed options (true/false) to a `process.env` with only strings.
 * This drops `false` values and converts everything else to a string.
 */
const envify = (obj) => {
    const clone = {};
    for (const [key, val] of Object.entries(obj)) {
        if (val !== false) {
            clone[key] = String(val);
        }
    }
    return clone;
};
const pluck = (obj, keys) => Object.fromEntries(keys.map((k) => [k, obj[k]]));
const maybeImport = (file, condition) => (condition ? `await import('${file}');` : '');

/** @type {() => import("@web/test-runner").TestRunnerConfig} */
export default (options) => {
    /** `process.env` to inject into test environment. */
    const env = envify({
        ...pluck(options, [
            'API_VERSION',
            'DISABLE_DETACHED_REHYDRATION',
            'DISABLE_NATIVE_CUSTOM_ELEMENT_LIFECYCLE',
            'DISABLE_STATIC_CONTENT_OPTIMIZATION',
            'ENABLE_ARIA_REFLECTION_GLOBAL_POLYFILL',
            'ENGINE_SERVER',
            'FORCE_NATIVE_SHADOW_MODE_FOR_TEST',
            'NATIVE_SHADOW',
        ]),
        LWC_VERSION,
        NODE_ENV: options.NODE_ENV_FOR_TEST,
    });

    return {
        // FIXME: Parallelism breaks tests that rely on focus/requestAnimationFrame, because they often
        // time out before they receive focus. But it also makes the full suite take 3x longer to run...
        // Potential workaround: https://github.com/modernweb-dev/web/issues/2588
        concurrency: 1,
        browserLogs: false,
        nodeResolve: true,
        rootDir: join(import.meta.dirname, '..'),
        plugins: [
            {
                name: 'lwc-base-plugin',
                resolveImport({ source }) {
                    if (source === 'wire-service') {
                        return resolvePathOutsideRoot('../wire-service/dist/index.js');
                    }
                },
                async transform(ctx) {
                    if (ctx.type === 'application/javascript') {
                        // FIXME: copy/paste Nolan's spiel about why we do this ugly thing
                        return ctx.body.replace(
                            /process\.env\.NODE_ENV === 'test-karma-lwc'/g,
                            'true'
                        );
                    }
                },
            },
        ],
        testRunnerHtml: (testFramework) =>
            `<!DOCTYPE html>
        <html>
          <head>
            <script type="module">
            globalThis.process = ${JSON.stringify({ env })};
            globalThis.lwcRuntimeFlags = ${JSON.stringify(
                pluck(options, [
                    'DISABLE_NATIVE_CUSTOM_ELEMENT_LIFECYCLE',
                    'DISABLE_DETACHED_REHYDRATION',
                ])
            )};

            ${maybeImport('@lwc/synthetic-shadow', !options.NATIVE_SHADOW)}
            ${maybeImport('@lwc/aria-reflection', options.ENABLE_ARIA_REFLECTION_GLOBAL_POLYFILL)}
            </script>
            <script type="module" src="./helpers/setup.js"></script>
            <script type="module" src="${testFramework}"></script>
          </head>
        </html>`,
    };
};