-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
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
Fix duplicated CSS modules inlining #9531
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 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,5 @@ | ||
--- | ||
'astro': patch | ||
--- | ||
|
||
Fixes duplicated CSS modules content when it's imported by both Astro files and framework components |
This file contains 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
This file contains 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 |
---|---|---|
@@ -1,4 +1,3 @@ | ||
import type { RuntimeMode } from '../@types/astro.js'; | ||
import type { ModuleLoader } from '../core/module-loader/index.js'; | ||
import { viteID } from '../core/util.js'; | ||
import { isBuildableCSSRequest } from './util.js'; | ||
|
@@ -13,37 +12,48 @@ interface ImportedStyle { | |
/** Given a filePath URL, crawl Vite’s module graph to find all style imports. */ | ||
export async function getStylesForURL( | ||
filePath: URL, | ||
loader: ModuleLoader, | ||
mode: RuntimeMode | ||
loader: ModuleLoader | ||
): Promise<{ urls: Set<string>; styles: ImportedStyle[] }> { | ||
const importedCssUrls = new Set<string>(); | ||
// Map of url to injected style object. Use a `url` key to deduplicate styles | ||
const importedStylesMap = new Map<string, ImportedStyle>(); | ||
|
||
for await (const importedModule of crawlGraph(loader, viteID(filePath), true)) { | ||
if (isBuildableCSSRequest(importedModule.url)) { | ||
let ssrModule: Record<string, any>; | ||
try { | ||
// The SSR module is possibly not loaded. Load it if it's null. | ||
ssrModule = importedModule.ssrModule ?? (await loader.import(importedModule.url)); | ||
} catch { | ||
// The module may not be inline-able, e.g. SCSS partials. Skip it as it may already | ||
// be inlined into other modules if it happens to be in the graph. | ||
continue; | ||
// In dev, we inline all styles if possible | ||
let css = ''; | ||
// If this is a plain CSS module, the default export should be a string | ||
if (typeof importedModule.ssrModule?.default === 'string') { | ||
css = importedModule.ssrModule.default; | ||
} | ||
if ( | ||
mode === 'development' && // only inline in development | ||
typeof ssrModule?.default === 'string' // ignore JS module styles | ||
) { | ||
importedStylesMap.set(importedModule.url, { | ||
id: importedModule.id ?? importedModule.url, | ||
url: importedModule.url, | ||
content: ssrModule.default, | ||
}); | ||
} else { | ||
// NOTE: We use the `url` property here. `id` would break Windows. | ||
importedCssUrls.add(importedModule.url); | ||
// Else try to load it | ||
else { | ||
const url = new URL(importedModule.url, 'http://localhost'); | ||
// Mark url with ?inline so Vite will return the CSS as plain string, even for CSS modules | ||
url.searchParams.set('inline', ''); | ||
const modId = `${decodeURI(url.pathname)}${url.search}`; | ||
|
||
Comment on lines
+31
to
+34
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We used to load the CSS file without the |
||
try { | ||
// The SSR module is possibly not loaded. Load it if it's null. | ||
const ssrModule = await loader.import(modId); | ||
css = ssrModule.default; | ||
} catch { | ||
// Some CSS modules, e.g. from Vue files, may not work with the ?inline query. | ||
// If so, we fallback to a url instead | ||
if (modId.includes('.module.')) { | ||
importedCssUrls.add(importedModule.url); | ||
} | ||
// The module may not be inline-able, e.g. SCSS partials. Skip it as it may already | ||
// be inlined into other modules if it happens to be in the graph. | ||
continue; | ||
} | ||
} | ||
|
||
importedStylesMap.set(importedModule.url, { | ||
id: importedModule.id ?? importedModule.url, | ||
url: importedModule.url, | ||
content: css, | ||
}); | ||
} | ||
} | ||
|
||
|
This file contains 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
This file contains 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
This file contains 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.
I removed this check (and the
mode
param entirely) as it seems like we only use this function in dev now.