Skip to content

Fix client reference access causing metadata missing #70732

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

Merged
huozhi merged 6 commits into from
Oct 4, 2024
Merged

Fix client reference access causing metadata missing #70732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
df0a964
fix client reference access
huozhi Oct 2, 2024
8f5b3a4
check if has metadata export
huozhi Oct 2, 2024
ae4853a
change viewport
huozhi Oct 2, 2024
8847ec6
refine tests and simplify logic
huozhi Oct 3, 2024
8f417b6
update test
huozhi Oct 3, 2024
4626bf2
simpliy test
huozhi Oct 3, 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
9 changes: 0 additions & 9 deletions packages/next/src/lib/metadata/resolve-metadata.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ import {
import { resolveOpenGraph, resolveTwitter } from './resolvers/resolve-opengraph'
import { resolveTitle } from './resolvers/resolve-title'
import { resolveAsArrayOrUndefined } from './generate/utils'
import { isClientReference } from '../client-reference'
import {
getComponentTypeModule,
getLayoutOrPageModule,
Expand Down Expand Up @@ -331,9 +330,6 @@ async function getDefinedViewport(
props: any,
tracingProps: { route: string }
): Promise<Viewport | ViewportResolver | null> {
if (isClientReference(mod)) {
return null
}
if (typeof mod.generateViewport === 'function') {
const { route } = tracingProps
return (parent: ResolvingViewport) =>
Expand All @@ -356,11 +352,6 @@ async function getDefinedMetadata(
props: any,
tracingProps: { route: string }
): Promise<Metadata | MetadataResolver | null> {
// Layer is a client component, we just skip it. It can't have metadata exported.
// Return early to avoid accessing properties error for client references.
if (isClientReference(mod)) {
return null
}
if (typeof mod.generateMetadata === 'function') {
const { route } = tracingProps
return (parent: ResolvingMetadata) =>
Expand Down
12 changes: 12 additions & 0 deletions test/e2e/app-dir/reexport-client-component-metadata/app/layout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
export default function Layout({ children }: { children: React.ReactNode }) {
return (
<html>
<body>{children}</body>
</html>
)
}

export const metadata = {
title: 'Root Layout',
description: 'Root Description',
}
5 changes: 5 additions & 0 deletions test/e2e/app-dir/reexport-client-component-metadata/app/no-override/page-content.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
'use client'

export default function PageContent() {
return <h1>Page 2 Content</h1>
}
3 changes: 3 additions & 0 deletions test/e2e/app-dir/reexport-client-component-metadata/app/no-override/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import PageContent from './page-content'

export default PageContent
5 changes: 5 additions & 0 deletions test/e2e/app-dir/reexport-client-component-metadata/app/override/page-content.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
'use client'

export default function PageContent() {
return <h1>Page 1 Content</h1>
}
8 changes: 8 additions & 0 deletions test/e2e/app-dir/reexport-client-component-metadata/app/override/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import PageContent from './page-content'

export const metadata = {
title: 'Page 1',
description: 'Page 1 Description',
}

export default PageContent
39 changes: 39 additions & 0 deletions ...e2e/app-dir/reexport-client-component-metadata/reexport-client-component-metadata.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import { nextTestSetup } from 'e2e-utils'

describe('app-dir - reexport-client-component-metadata', () => {
const { next } = nextTestSetup({
files: __dirname,
})

it('should render the page metadata if override', async () => {
const $ = await next.render$('/override')
expect($('title').text()).toBe('Page 1')
expect($('meta[name="description"]').attr('content')).toBe(
'Page 1 Description'
)

const browser = await next.browser('/override')
expect(await browser.elementByCss('title').text()).toBe('Page 1')
expect(
await browser
.elementByCss('meta[name="description"]')
.getAttribute('content')
).toBe('Page 1 Description')
})

it('should render the layout metadata if not override', async () => {
const $ = await next.render$('/no-override')
expect($('title').text()).toBe('Root Layout')
expect($('meta[name="description"]').attr('content')).toBe(
'Root Description'
)

const browser = await next.browser('/no-override')
expect(await browser.elementByCss('title').text()).toBe('Root Layout')
expect(
await browser
.elementByCss('meta[name="description"]')
.getAttribute('content')
).toBe('Root Description')
})
})