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.

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 body head content injection in MDX when using layout #6779

Merged
merged 1 commit into from
Apr 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions .changeset/smart-files-flow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'astro': patch
'@astrojs/mdx': patch
---

Prevent body head content injection in MDX when using layout
2 changes: 2 additions & 0 deletions packages/astro/src/runtime/server/render/page.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ export async function renderPage(
route?: RouteData | undefined
): Promise<Response> {
if (!isAstroComponentFactory(componentFactory)) {
result._metadata.headInTree =
result.componentMetadata.get((componentFactory as any).moduleId)?.containsHead ?? false;
const pageProps: Record<string, any> = { ...(props ?? {}), 'server:root': true };

let output: ComponentIterable;
Expand Down
1 change: 1 addition & 0 deletions packages/integrations/mdx/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ export default function mdx(partialMdxOptions: Partial<MdxOptions> = {}): AstroI
// Ensures styles and scripts are injected into a `<head>`
// When a layout is not applied
code += `\nContent[Symbol.for('astro.needsHeadRendering')] = !Boolean(frontmatter.layout);`;
code += `\nContent.moduleId = ${JSON.stringify(id)};`

if (command === 'dev') {
// TODO: decline HMR updates until we have a stable approach
Expand Down
13 changes: 13 additions & 0 deletions packages/integrations/mdx/test/css-head-mdx.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -81,5 +81,18 @@ describe('Head injection w/ MDX', () => {
const bodyLinks = $('body link[rel=stylesheet]');
expect(bodyLinks).to.have.a.lengthOf(0);
});

it('Injection caused by delayed slots', async () => {
const html = await fixture.readFile('/componentwithtext/index.html');

// Using cheerio here because linkedom doesn't support head tag injection
const $ = cheerio.load(html);

const headLinks = $('head link[rel=stylesheet]');
expect(headLinks).to.have.a.lengthOf(1);

const bodyLinks = $('body link[rel=stylesheet]');
expect(bodyLinks).to.have.a.lengthOf(0);
});
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
const { inlineStyle, title, display = 'horizontal' } = Astro.props;
const lineEnding = display === 'horizontal' ? ', ' : '<br>';
---

{title && <h2 set:html={title} />}
<address style={inlineStyle}>
<span class="name">some name</span><Fragment set:html={lineEnding} />
line 1<Fragment set:html={lineEnding} />
line 2<Fragment set:html={lineEnding} />
line 3<Fragment set:html={lineEnding} />
line 4<Fragment set:html={lineEnding} />
line 5
</address>
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
// Extend the BaseLayout, adding space for a banner at the top of the page
// after the main heading, then the detail for the actual page
import ContentLayout from './ContentLayout.astro';
const { frontmatter } = Astro.props;
---

<ContentLayout>
<div class="content-container">
<article id="main-content" class="pad-z5 flow">
<h1 set:html={frontmatter.pageHeading ? frontmatter.pageHeading : frontmatter.title} />
<slot />
</article>
</div>
</ContentLayout>
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: ../layouts/DocumentLayout.astro
title: blah blah
---

import BasicBlock from '../components/BasicBlock.astro';

Some text for a paragraph.

<BasicBlock title="This causes css in wrong place." />

Some other text.