-
Notifications
You must be signed in to change notification settings - Fork 5
fix: disable HMR for SSR transforms to prevent ERR_LOAD_URL #110
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Brooooooklyn
wants to merge
1
commit into
main
Choose a base branch
from
fix/ssr-hmr-virtual-module-109
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+118
−4
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| /** | ||
| * Tests for SSR + HMR interaction (Issue #109). | ||
| * | ||
| * When using @oxc-angular/vite with Nitro or other SSR frameworks, the server-side | ||
| * bundle must NOT contain HMR initialization code that dynamically imports | ||
| * `@ng/component?c=...` virtual modules, because those are only served via | ||
| * HTTP middleware (not `resolveId`/`load` hooks), causing ERR_LOAD_URL. | ||
| * | ||
| * The fix: | ||
| * 1. The transform hook checks `options.ssr` and disables HMR for SSR transforms. | ||
| * 2. `resolveId`/`load` hooks handle `@ng/component` as a safety net, returning | ||
| * an empty module so the module runner never crashes. | ||
| */ | ||
| import { describe, it, expect } from 'vitest' | ||
|
|
||
| import { transformAngularFile } from '../index.js' | ||
|
|
||
| const COMPONENT_SOURCE = ` | ||
| import { Component } from '@angular/core'; | ||
|
|
||
| @Component({ | ||
| selector: 'app-root', | ||
| template: '<h1>Hello World</h1>', | ||
| }) | ||
| export class AppComponent {} | ||
| ` | ||
|
|
||
| describe('SSR + HMR (Issue #109)', () => { | ||
| it('should inject HMR code when hmr is enabled (client-side)', async () => { | ||
| const result = await transformAngularFile(COMPONENT_SOURCE, 'app.component.ts', { | ||
| hmr: true, | ||
| }) | ||
|
|
||
| expect(result.errors).toHaveLength(0) | ||
| // HMR initializer IIFE should be present | ||
| expect(result.code).toContain('ɵɵreplaceMetadata') | ||
| expect(result.code).toContain('import.meta.hot') | ||
| expect(result.code).toContain('angular:component-update') | ||
| }) | ||
|
|
||
| it('should NOT inject HMR code when hmr is disabled (SSR-side)', async () => { | ||
| const result = await transformAngularFile(COMPONENT_SOURCE, 'app.component.ts', { | ||
| hmr: false, | ||
| }) | ||
|
|
||
| expect(result.errors).toHaveLength(0) | ||
| // No HMR code should be present | ||
| expect(result.code).not.toContain('ɵɵreplaceMetadata') | ||
| expect(result.code).not.toContain('import.meta.hot') | ||
| expect(result.code).not.toContain('angular:component-update') | ||
| expect(result.code).not.toContain('@ng/component') | ||
| // But the component should still be compiled correctly | ||
| expect(result.code).toContain('ɵɵdefineComponent') | ||
| expect(result.code).toContain('AppComponent') | ||
| }) | ||
|
|
||
| it('should produce no templateUpdates when hmr is disabled', async () => { | ||
| const result = await transformAngularFile(COMPONENT_SOURCE, 'app.component.ts', { | ||
| hmr: false, | ||
| }) | ||
|
|
||
| expect(result.errors).toHaveLength(0) | ||
| expect(Object.keys(result.templateUpdates).length).toBe(0) | ||
| }) | ||
| }) | ||
|
|
||
| describe('Vite plugin SSR behavior (Issue #109)', () => { | ||
| it('angular() plugin should pass ssr flag through to disable HMR', async () => { | ||
| // This test validates the contract: when the Vite plugin receives | ||
| // ssr=true in the transform options, it should set hmr=false | ||
| // in the TransformOptions passed to transformAngularFile. | ||
| // | ||
| // The actual Vite plugin integration is tested via the e2e tests, | ||
| // but this validates the underlying compiler respects hmr=false. | ||
| const clientResult = await transformAngularFile(COMPONENT_SOURCE, 'app.component.ts', { | ||
| hmr: true, | ||
| }) | ||
| const ssrResult = await transformAngularFile(COMPONENT_SOURCE, 'app.component.ts', { | ||
| hmr: false, | ||
| }) | ||
|
|
||
| // Client should have HMR | ||
| expect(clientResult.code).toContain('ɵɵreplaceMetadata') | ||
|
|
||
| // SSR should NOT have HMR | ||
| expect(ssrResult.code).not.toContain('ɵɵreplaceMetadata') | ||
|
|
||
| // Both should have the component definition | ||
| expect(clientResult.code).toContain('ɵɵdefineComponent') | ||
| expect(ssrResult.code).toContain('ɵɵdefineComponent') | ||
| }) | ||
| }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing watcher registration for SSR transforms (
!isSSR) means external templates/styles read during SSR are cached but never invalidated on file change, becauseresourceCache.delete(...)only runs inside the customfs.watchcallback andhandleHotUpdateexplicitly ignores resource files. In SSR-only code paths (or before any client transform registers watchers), editingtemplateUrl/styleUrlscan leave SSR output stale until a restart.Useful? React with 👍 / 👎.