Testing components that use CSS modules is failing #910
Description
Environment
- Operating System: Darwin
- Node Version: v21.6.1
- Nuxt Version: 3.12.1
- CLI Version: 3.12.0
- Nitro Version: 2.9.6
- Package Manager: bun@1.1.21
- Builder: -
- User Config: compatibilityDate, devtools, modules
- Runtime Modules: @nuxt/test-utils/module@^3.14.0
- Build Modules: -
Reproduction
Describe the bug
When running tests on components that uses CSS Modules, the $style attribute is consistently set to undefined, causing the tests to fail.
Additional context
There are no examples in the Nuxt test examples folder that include CSS modules. I've read the documentation for @nuxt/test-utils, and it doesn't mention how to use it with CSS modules. I tried googling it, but I couldn't find any information on how to test Vue components with CSS modules. I only found an unanswered question regarding the same issue, e.g., #804. Since CSS modules work with Nuxt 'out of the box,' I believe testing components that use CSS modules should also work seamlessly.
Logs
❯ test.nuxt.test.ts (1) 5010ms
× my test 5009ms
⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯ Failed Tests 1 ⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯
FAIL test.nuxt.test.ts > my test
Error: Test timed out in 5000ms.
If this is a long-running test, pass a timeout value as the last argument or configure it globally with "testTimeout".
⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯[1/1]⎯
⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯ Unhandled Errors ⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯
Vitest caught 1 unhandled error during the test run.
This might cause false positive tests. Resolve unhandled errors to make sure your tests are not affected.
⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯ Unhandled Rejection ⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯
TypeError: Cannot read properties of undefined (reading 'someCssModuleClassName')
❯ Proxy._sfc_render app.vue:3:20
1| <template>
2| <div :class="$style.someCssModuleClassName">
3| <NuxtWelcome />
| ^
4| </div>
5| </template>
❯ Proxy.clonedComponent.render node_modules/.pnpm/@nuxt+test-utils@3.14.0_@vue+test-utils@2.4.6_h3@1.12.0_happy-dom@14.12.3_nitropack@2.9.7_pla_3tccdhrwarphrx6od5vsqeppdq/node_modules/@nuxt/test-utils/dist/runtime-utils/index.mjs:142:37
❯ renderComponentRoot node_modules/.pnpm/@vue+runtime-core@3.4.37/node_modules/@vue/runtime-core/dist/runtime-core.cjs.js:6267:16
❯ ReactiveEffect.componentUpdateFn [as fn] node_modules/.pnpm/@vue+runtime-core@3.4.37/node_modules/@vue/runtime-core/dist/runtime-core.cjs.js:4942:46
❯ ReactiveEffect.run node_modules/.pnpm/@vue+reactivity@3.4.37/node_modules/@vue/reactivity/dist/reactivity.cjs.js:181:19
❯ instance.update node_modules/.pnpm/@vue+runtime-core@3.4.37/node_modules/@vue/runtime-core/dist/runtime-core.cjs.js:5073:16
❯ setupRenderEffect node_modules/.pnpm/@vue+runtime-core@3.4.37/node_modules/@vue/runtime-core/dist/runtime-core.cjs.js:5083:5
❯ mountComponent node_modules/.pnpm/@vue+runtime-core@3.4.37/node_modules/@vue/runtime-core/dist/runtime-core.cjs.js:4851:7
❯ processComponent node_modules/.pnpm/@vue+runtime-core@3.4.37/node_modules/@vue/runtime-core/dist/runtime-core.cjs.js:4805:9
❯ patch node_modules/.pnpm/@vue+runtime-core@3.4.37/node_modules/@vue/runtime-core/dist/runtime-core.cjs.js:4334:11
This error originated in "test.nuxt.test.ts" test file. It doesn't mean the error was thrown inside the file itself, but while it was running.
The latest test that might've caused the error is "my test". It might mean one of the following:
- The error was thrown, while Vitest was running this test.
- If the error occurred after the test had been completed, this was the last documented test before it was thrown.
⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯
Test Files 1 failed (1)
Tests 1 failed (1)
Errors 1 error
Start at 18:00:20
Duration 5.24s