Skip to content
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.

Sign up for GitHub

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

Prevent usage of astro:content in the client #11827

Merged
merged 7 commits into from
Aug 27, 2024
Merged

Prevent usage of astro:content in the client #11827

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f031d8d
Prevent usage of astro:content in the client
matthewp Aug 23, 2024
51a5c22
Fix build errors
matthewp Aug 23, 2024
16366d2
Update .changeset/neat-dots-hear.md
matthewp Aug 27, 2024
0142501
Throw an AstroError
matthewp Aug 27, 2024
b66a0f2
Merge branch 'next' into no-astro-content-in-client
matthewp Aug 27, 2024
63b674c
Just throw
matthewp Aug 27, 2024
5747564
Merge branch 'no-astro-content-in-client' of github.com:withastro/ast…
matthewp Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .changeset/neat-dots-hear.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
'astro': major
---

Prevent usage of `astro:content` in the client

Usage of `astro:content` in the client has always been discouraged because it leads to all of your content winding up in your client bundle, and can possibly leaks secrets.

This formally makes doing so impossible, adding to the previous warning with errors.

In the future Astro might add APIs for client-usage based on needs.
35 changes: 22 additions & 13 deletions packages/astro/src/content/vite-plugin-content-virtual-mod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,18 +253,27 @@ export async function generateContentEntryFile({
renderEntryGlobResult = getStringifiedCollectionFromLookup('render', relContentDir, lookupMap);
}

let virtualModContents =
nodeFs
.readFileSync(contentPaths.virtualModTemplate, 'utf-8')
.replace('@@CONTENT_DIR@@', relContentDir)
.replace("'@@CONTENT_ENTRY_GLOB_PATH@@'", contentEntryGlobResult)
.replace("'@@DATA_ENTRY_GLOB_PATH@@'", dataEntryGlobResult)
.replace("'@@RENDER_ENTRY_GLOB_PATH@@'", renderEntryGlobResult)
.replace('/* @@LOOKUP_MAP_ASSIGNMENT@@ */', `lookupMap = ${JSON.stringify(lookupMap)};`) +
(isClient
? `
console.warn('astro:content is only supported running server-side. Using it in the browser will lead to bloated bundles and slow down page load. In the future it will not be supported.');`
: '');
let virtualModContents: string;
if(isClient) {
// Empty exports is probably enough to break the build.
// If for some reason its being imported as a side-effect ala `import 'astro:content';` then throw an error message.
matthewp marked this conversation as resolved.
Show resolved Hide resolved
virtualModContents = `export {};
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this really needed? I think for astro:env I just throw without returning any content

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point, removed

throw new Error('astro:content is only supported running server-side.');`;

throw new AstroError({
...AstroErrorData.ServerOnlyModule,
message: AstroErrorData.ServerOnlyModule.message('astro:content'),
});
} else {
virtualModContents =
nodeFs
.readFileSync(contentPaths.virtualModTemplate, 'utf-8')
.replace('@@CONTENT_DIR@@', relContentDir)
.replace("'@@CONTENT_ENTRY_GLOB_PATH@@'", contentEntryGlobResult)
.replace("'@@DATA_ENTRY_GLOB_PATH@@'", dataEntryGlobResult)
.replace("'@@RENDER_ENTRY_GLOB_PATH@@'", renderEntryGlobResult)
.replace('/* @@LOOKUP_MAP_ASSIGNMENT@@ */', `lookupMap = ${JSON.stringify(lookupMap)};`);
}

return virtualModContents;
}
Expand Down Expand Up @@ -360,7 +369,7 @@ export async function generateLookupMap({
const contentEntryType = contentEntryConfigByExt.get(extname(filePath));
if (!contentEntryType) throw UnexpectedLookupMapError;

const { id, slug: generatedSlug } = await getContentEntryIdAndSlug({
const { id, slug: generatedSlug } = getContentEntryIdAndSlug({
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is an unrelated change, but this await is on a sync function, so I removed.

entry: pathToFileURL(filePath),
contentDir,
collection,
Expand Down
Loading