Skip to content

fix(nuxt): preserve route metadata assigned outside page #27587

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
danielroe merged 9 commits into from
Jun 13, 2024
Merged

fix(nuxt): preserve route metadata assigned outside page #27587

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
918d1ce
fix(nuxt): preserve route metadata assigned outside page
danielroe Jun 13, 2024
77a8713
chore: lint + add test case for options api
danielroe Jun 13, 2024
6bced52
[autofix.ci] apply automated fixes
autofix-ci[bot] Jun 13, 2024
78c56c5
chore: remove devtools
danielroe Jun 13, 2024
7638f90
chore: update fixture
danielroe Jun 13, 2024
0fe974f
Merge remote-tracking branch 'origin/main' into fix/page-meta
danielroe Jun 13, 2024
35282cb
fix: handle `definePageMeta` nested within another function
danielroe Jun 13, 2024
c97d8c7
Merge remote-tracking branch 'origin/main' into fix/page-meta
danielroe Jun 13, 2024
ad7d842
[autofix.ci] apply automated fixes
autofix-ci[bot] Jun 13, 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
Prev Previous commit
Next Next commit
chore: lint + add test case for options api
  • Loading branch information
@danielroe
danielroe committed Jun 13, 2024
commit 77a8713f09b6f96351c78454d0d616bb5eb10336
59 changes: 43 additions & 16 deletions packages/nuxt/test/page-metadata.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe, expect, it, vi } from 'vitest'
import { getRouteMeta, normalizeRoutes } from "../src/pages/utils"
import { describe, expect, it } from 'vitest'
import { getRouteMeta, normalizeRoutes } from '../src/pages/utils'
import type { NuxtPage } from '../schema'

const filePath = '/app/pages/index.vue'
Expand Down Expand Up @@ -47,6 +47,34 @@ describe('page metadata', () => {
}
`)
})

it('should extract serialisable metadata in options api', async () => {
const meta = await getRouteMeta(`
<script>
definePageMeta({
name: 'some-custom-name',
path: '/some-custom-path',
middleware: (from, to) => console.warn('middleware'),
})
export default {
setup() {
},
};
</script>
`, filePath)

expect(meta).toMatchInlineSnapshot(`
{
"meta": {
"__nuxt_dynamic_meta_key": Set {
"meta",
},
},
"name": "some-custom-name",
"path": "/some-custom-path",
}
`)
})
})

describe('normalizeRoutes', () => {
Expand All @@ -69,12 +97,12 @@ describe('normalizeRoutes', () => {
</script>
`, filePath))

page.meta ||= {}
page.meta.layout = 'test'
page.meta.foo = 'bar'
page.meta ||= {}
page.meta.layout = 'test'
page.meta.foo = 'bar'

const { routes, imports } = normalizeRoutes([page], new Set(), true)
expect({ routes, imports }).toMatchInlineSnapshot(`
const { routes, imports } = normalizeRoutes([page], new Set(), true)
expect({ routes, imports }).toMatchInlineSnapshot(`
{
"imports": Set {
"import { default as indexN6pT4Un8hYMeta } from "/app/pages/index.vue?macro=true";",
Expand All @@ -90,16 +118,16 @@ describe('normalizeRoutes', () => {
]",
}
`)
})
})

it('should produce valid route objects when used without extracted meta', async () => {
it('should produce valid route objects when used without extracted meta', () => {
const page: NuxtPage = { path: '/', file: filePath }
page.meta ||= {}
page.meta.layout = 'test'
page.meta.foo = 'bar'
page.meta ||= {}
page.meta.layout = 'test'
page.meta.foo = 'bar'

const { routes, imports } = normalizeRoutes([page], new Set())
expect({ routes, imports }).toMatchInlineSnapshot(`
const { routes, imports } = normalizeRoutes([page], new Set())
expect({ routes, imports }).toMatchInlineSnapshot(`
{
"imports": Set {
"import { default as indexN6pT4Un8hYMeta } from "/app/pages/index.vue?macro=true";",
Expand All @@ -116,6 +144,5 @@ describe('normalizeRoutes', () => {
]",
}
`)
})
})
})