test: separate nuxt legacy runtime tests #32481
Conversation
|
|
There was a problem hiding this comment.
Pull Request Overview
This PR separates Nuxt runtime tests to enable disabling v3/v4 features by introducing a dedicated legacy test suite.
- Added a new Nuxt legacy project configuration in vitest.config.ts with corresponding environment options and overrides.
- Updated test files by conditioning tests with skipIf based on the NUXT_LEGACY environment variable.
- Modified the test:runtime script in package.json to include the new nuxt-legacy project.
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| vitest.config.ts | Added nuxt legacy project configuration and environment options. |
| test/nuxt/*.test.ts | Conditioned tests to run only in legacy mode using skipIf. |
| package.json | Updated test command to run the nuxt-legacy project. |
WalkthroughThe changes introduce conditional execution for certain test cases in the Nuxt composables test suite, making them run only when the 📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (4)
🚧 Files skipped from review as they are similar to previous changes (4)
⏰ Context from checks skipped due to timeout of 90000ms (2)
✨ Finishing Touches
🧪 Generate Unit Tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
vitest.config.ts (1)
76-125: Consider refactoring to reduce configuration duplication.The "nuxt" and "nuxt-legacy" project configurations share significant overlap, particularly in
routeRules,experimental.appManifest, andimports.polyfillssettings. This duplication may lead to maintenance issues if these shared configurations need updates.Consider extracting shared configuration to reduce duplication:
+const sharedNuxtConfig = { + routeRules: { + '/specific-prerendered': { prerender: true }, + '/pre/test': { redirect: '/' }, + '/pre/**': { prerender: true }, + }, + experimental: { + appManifest: process.env.TEST_MANIFEST !== 'manifest-off', + }, + imports: { + polyfills: false, + }, +} await defineVitestProject({ test: { name: 'nuxt', dir: './test/nuxt', exclude: [...defaultExclude, '**/universal/**'], environment: 'nuxt', setupFiles: ['./test/setup-runtime.ts'], environmentOptions: { nuxt: { overrides: { + ...sharedNuxtConfig, - routeRules: { - '/specific-prerendered': { prerender: true }, - '/pre/test': { redirect: '/' }, - '/pre/**': { prerender: true }, - }, - experimental: { - appManifest: process.env.TEST_MANIFEST !== 'manifest-off', - }, - imports: { - polyfills: false, - }, }, }, }, }, }), await defineVitestProject({ test: { name: 'nuxt-legacy', dir: './test/nuxt', exclude: [...defaultExclude, '**/universal/**'], environment: 'nuxt', setupFiles: ['./test/setup-runtime.ts'], env: { NUXT_LEGACY: '1', }, environmentOptions: { nuxt: { overrides: { pages: true, + ...sharedNuxtConfig, + experimental: { + ...sharedNuxtConfig.experimental, + alwaysRunFetchOnKeyChange: true, + }, - routeRules: { - '/specific-prerendered': { prerender: true }, - '/pre/test': { redirect: '/' }, - '/pre/**': { prerender: true }, - }, - experimental: { - appManifest: process.env.TEST_MANIFEST !== 'manifest-off', - alwaysRunFetchOnKeyChange: true, - }, - imports: { - polyfills: false, - }, }, }, }, }, }),test/nuxt/nuxt-page.test.ts (1)
8-8: LGTM! Consider removing redundant conditional skipping.The conditional skipping is correctly implemented. However, since the entire
describeblock is already skipped whenNUXT_LEGACY !== '1'(line 8), the individual test skip on line 81 is redundant and can be removed for cleaner code.Consider removing the redundant skip condition:
- it.skipIf(process.env.NUXT_LEGACY !== '1')('should not remount a page when keepalive options are modified', async () => { + it('should not remount a page when keepalive options are modified', async () => {Also applies to: 81-81
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package.jsonis excluded by!package.json,!**/package.json
📒 Files selected for processing (6)
test/nuxt/composables.test.ts(4 hunks)test/nuxt/loading-indicator.test.ts(1 hunks)test/nuxt/nuxt-layout.test.ts(1 hunks)test/nuxt/nuxt-page.test.ts(2 hunks)test/nuxt/router.option.test.ts(1 hunks)vitest.config.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.ts`: Follow standard TypeScript conventions and best practices
**/*.ts: Follow standard TypeScript conventions and best practices
📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)
List of files the instruction was applied to:
test/nuxt/nuxt-page.test.tstest/nuxt/router.option.test.tstest/nuxt/loading-indicator.test.tstest/nuxt/nuxt-layout.test.tstest/nuxt/composables.test.tsvitest.config.ts
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: codeql (javascript-typescript)
- GitHub Check: build
- GitHub Check: code
🔇 Additional comments (7)
test/nuxt/router.option.test.ts (1)
26-26: LGTM! Proper conditional test execution for legacy environment.The conditional skipping is correctly implemented to ensure this test suite only runs in the legacy testing environment when
NUXT_LEGACY=1.test/nuxt/loading-indicator.test.ts (1)
80-80: LGTM! Granular conditional test execution implemented correctly.The individual test case is properly configured to only run in the legacy environment, demonstrating good granular control over legacy-specific functionality testing.
test/nuxt/nuxt-layout.test.ts (1)
108-108: LGTM! Consistent conditional test execution pattern.The test case correctly uses the established pattern for legacy-only test execution, maintaining consistency across the test suite.
test/nuxt/composables.test.ts (4)
827-827: LGTM: Appropriate legacy test conditional.The conditional skip for the reactive keys with
immediate: falsetest is correctly implemented. This test appears to validate legacy behaviour where reactive dependencies trigger fetches even with immediate set to false.
846-846: LGTM: Consistent legacy test pattern.The conditional skip for reactive request paths with
immediate: falsefollows the same pattern as other legacy tests. The test validates legacy behaviour with reactive request paths, which is appropriately classified as legacy-only.
916-916: LGTM: Experimental feature correctly flagged as legacy.The conditional skip for the
experimental.alwaysRunFetchOnKeyChangetest is appropriate. This experimental feature appears to be legacy-specific behaviour that should only be tested in the legacy environment.
1265-1265: LGTM: Entire useRoute test suite appropriately moved to legacy.The conditional skip for the entire
useRoutedescribe block is correctly implemented. Based on the test content, this appears to validate legacy routing utilities that should only be available in the legacy environment.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@nuxt/kit
nuxt
@nuxt/rspack-builder
@nuxt/schema
@nuxt/vite-builder
@nuxt/webpack-builder
commit: |
CodSpeed Performance ReportMerging #32481 will not alter performanceComparing Summary
|
…30665) Co-authored-by: Daniel Roe <daniel@roe.dev>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Daniel Roe <daniel@roe.dev>
🔗 Linked issue
📚 Description
This PR separates the nuxt runtime tests to be able to disable some v3/v4 related features.