From a5e03a688979446c77c02836ec9d58cd6734f2d4 Mon Sep 17 00:00:00 2001 From: Jiachi Liu Date: Fri, 17 Mar 2023 14:20:27 +0100 Subject: [PATCH 1/6] Support manifest.json static and dynamic route --- .../loaders/metadata/resolve-route-data.ts | 24 ++++-- .../loaders/next-metadata-route-loader.ts | 1 + .../src/lib/metadata/get-metadata-route.ts | 3 + .../src/lib/metadata/is-metadata-route.ts | 13 ++- .../src/lib/metadata/types/manifest-types.ts | 86 +++++++++++++++++++ .../lib/metadata/types/metadata-interface.ts | 4 +- .../next/src/server/lib/find-page-file.ts | 1 + packages/next/types/index.d.ts | 7 +- .../metadata-dynamic-routes/app/manifest.ts | 18 ++++ .../metadata-dynamic-routes/app/robots.ts | 4 +- .../metadata-dynamic-routes/app/sitemap.ts | 4 +- .../metadata-dynamic-routes/index.test.ts | 29 +++++++ 12 files changed, 170 insertions(+), 24 deletions(-) create mode 100644 packages/next/src/lib/metadata/types/manifest-types.ts create mode 100644 test/e2e/app-dir/metadata-dynamic-routes/app/manifest.ts diff --git a/packages/next/src/build/webpack/loaders/metadata/resolve-route-data.ts b/packages/next/src/build/webpack/loaders/metadata/resolve-route-data.ts index fbb39f7d7fab..b2f1b1edaaba 100644 --- a/packages/next/src/build/webpack/loaders/metadata/resolve-route-data.ts +++ b/packages/next/src/build/webpack/loaders/metadata/resolve-route-data.ts @@ -1,11 +1,12 @@ import type { - RobotsFile, - SitemapFile, + Robots, + Sitemap, } from '../../../../lib/metadata/types/metadata-interface' +import type { Manifest } from '../../../../lib/metadata/types/manifest-types' import { resolveAsArrayOrUndefined } from '../../../../lib/metadata/generate/utils' // convert robots data to txt string -export function resolveRobots(data: RobotsFile): string { +export function resolveRobots(data: Robots): string { let content = '' const rules = Array.isArray(data.rules) ? data.rules : [data.rules] for (const rule of rules) { @@ -40,7 +41,7 @@ export function resolveRobots(data: RobotsFile): string { // TODO-METADATA: support multi sitemap files // convert sitemap data to xml string -export function resolveSitemap(data: SitemapFile): string { +export function resolveSitemap(data: Sitemap): string { let content = '' content += '\n' content += '\n' @@ -60,15 +61,22 @@ export function resolveSitemap(data: SitemapFile): string { return content } +export function resolveManifest(data: Manifest): string { + return JSON.stringify(data) +} + export function resolveRouteData( - data: RobotsFile | SitemapFile, - fileType: 'robots' | 'sitemap' + data: Robots | Sitemap | Manifest, + fileType: 'robots' | 'sitemap' | 'manifest' ): string { if (fileType === 'robots') { - return resolveRobots(data as RobotsFile) + return resolveRobots(data as Robots) } if (fileType === 'sitemap') { - return resolveSitemap(data as SitemapFile) + return resolveSitemap(data as Sitemap) + } + if (fileType === 'manifest') { + return resolveManifest(data as Manifest) } return '' } diff --git a/packages/next/src/build/webpack/loaders/next-metadata-route-loader.ts b/packages/next/src/build/webpack/loaders/next-metadata-route-loader.ts index d465ec974508..6b3797e8e2b1 100644 --- a/packages/next/src/build/webpack/loaders/next-metadata-route-loader.ts +++ b/packages/next/src/build/webpack/loaders/next-metadata-route-loader.ts @@ -20,6 +20,7 @@ function getContentType(resourcePath: string) { if (name === 'favicon' && ext === 'ico') return 'image/x-icon' if (name === 'sitemap') return 'application/xml' if (name === 'robots') return 'text/plain' + if (name === 'manifest') return 'application/manifest+json' if (ext === 'png' || ext === 'jpeg' || ext === 'ico' || ext === 'svg') { return imageExtMimeTypeMap[ext] diff --git a/packages/next/src/lib/metadata/get-metadata-route.ts b/packages/next/src/lib/metadata/get-metadata-route.ts index b7644e32b94b..cddeda620615 100644 --- a/packages/next/src/lib/metadata/get-metadata-route.ts +++ b/packages/next/src/lib/metadata/get-metadata-route.ts @@ -20,6 +20,9 @@ export function normalizeMetadataRoute(page: string) { if (route === '/robots') { route += '.txt' } + if (route === '/manifest') { + route += '.json' + } route = `${route}/route` } return route diff --git a/packages/next/src/lib/metadata/is-metadata-route.ts b/packages/next/src/lib/metadata/is-metadata-route.ts index e58c978118a4..b27869a8f340 100644 --- a/packages/next/src/lib/metadata/is-metadata-route.ts +++ b/packages/next/src/lib/metadata/is-metadata-route.ts @@ -8,11 +8,11 @@ const getExtensionRegexString = (extensions: string[]) => `(?:${extensions.join('|')})` // When you only pass the file extension as `[]`, it will only match the static convention files -// e.g. /robots.txt, /sitemap.xml, /favicon.ico +// e.g. /robots.txt, /sitemap.xml, /favicon.ico, /manifest.json // When you pass the file extension as `['js', 'jsx', 'ts', 'tsx']`, it will also match the dynamic convention files -// e.g. /robots.js, /sitemap.tsx, /favicon.jsx +// e.g. /robots.js, /sitemap.tsx, /favicon.jsx, /manifest.ts // When `withExtension` is false, it will match the static convention files without the extension, by default it's true -// e.g. /robots, /sitemap, /favicon, use to match dynamic API routes like app/robots.ts +// e.g. /robots, /sitemap, /favicon, /manifest, use to match dynamic API routes like app/robots.ts export function isMetadataRouteFile( appDirRelativePath: string, pageExtensions: string[], @@ -33,6 +33,13 @@ export function isMetadataRouteFile( : '' }` ), + new RegExp( + `^[\\\\/]manifest${ + withExtension + ? `\\.${getExtensionRegexString(pageExtensions.concat('json'))}` + : '' + }` + ), new RegExp(`^[\\\\/]favicon\\.ico$`), // TODO-METADATA: add dynamic routes for metadata images new RegExp( diff --git a/packages/next/src/lib/metadata/types/manifest-types.ts b/packages/next/src/lib/metadata/types/manifest-types.ts new file mode 100644 index 000000000000..cf683abfae8f --- /dev/null +++ b/packages/next/src/lib/metadata/types/manifest-types.ts @@ -0,0 +1,86 @@ +export type Manifest = { + background_color?: string + categories?: string[] + description?: string + display?: 'fullscreen' | 'standalone' | 'minimal-ui' | 'browser' + display_override?: string[] + icons?: { + src: string + type?: string + sizes?: string + purpose?: 'any' | 'maskable' | 'monochrome' | 'badge' + }[] + id?: string + launch_handler?: { + platform?: 'windows' | 'macos' | 'linux' + url?: string + } + name?: string + orientation?: + | 'any' + | 'natural' + | 'landscape' + | 'portrait' + | 'portrait-primary' + | 'portrait-secondary' + | 'landscape-primary' + | 'landscape-secondary' + prefer_related_applications?: boolean + protocol_handlers?: { + protocol: string + url: string + title?: string + }[] + related_applications?: { + platform: string + url: string + id?: string + }[] + scope?: string + screenshots?: { + src: string + type?: string + sizes?: string + }[] + serviceworker?: { + src?: string + scope?: string + type?: string + update_via_cache?: 'import' | 'none' | 'all' + } + share_target?: { + action?: string + method?: 'get' | 'post' + enctype?: + | 'application/x-www-form-urlencoded' + | 'multipart/form-data' + | 'text/plain' + params?: { + name: string + value: string + required?: boolean + }[] + url?: string + title?: string + text?: string + files?: { + accept?: string[] + name?: string + }[] + } + short_name?: string + shortcuts?: { + name: string + short_name?: string + description?: string + url: string + icons?: { + src: string + type?: string + sizes?: string + purpose?: 'any' | 'maskable' | 'monochrome' | 'badge' + }[] + }[] + start_url?: string + theme_color?: string +} diff --git a/packages/next/src/lib/metadata/types/metadata-interface.ts b/packages/next/src/lib/metadata/types/metadata-interface.ts index 10deb233e5b5..d36373e4f0d9 100644 --- a/packages/next/src/lib/metadata/types/metadata-interface.ts +++ b/packages/next/src/lib/metadata/types/metadata-interface.ts @@ -554,10 +554,10 @@ type RobotsFile = { host?: string } -type SitemapFile = Array<{ +type Sitemap = Array<{ url: string lastModified?: string | Date }> export type ResolvingMetadata = Promise -export { Metadata, ResolvedMetadata, RobotsFile, SitemapFile } +export { Metadata, ResolvedMetadata, RobotsFile as Robots, Sitemap } diff --git a/packages/next/src/server/lib/find-page-file.ts b/packages/next/src/server/lib/find-page-file.ts index 61f25b1d58be..6cf514a83427 100644 --- a/packages/next/src/server/lib/find-page-file.ts +++ b/packages/next/src/server/lib/find-page-file.ts @@ -97,6 +97,7 @@ export function createValidFileMatcher( * /robots.txt| * /sitemap.xml| * /favicon.ico + * /manifest.json| * /icon.png|jpg| * /apple-touch-icon.png|jpg| * diff --git a/packages/next/types/index.d.ts b/packages/next/types/index.d.ts index 876d1a152d99..711cbacf434d 100644 --- a/packages/next/types/index.d.ts +++ b/packages/next/types/index.d.ts @@ -28,11 +28,8 @@ export type ServerRuntime = 'nodejs' | 'experimental-edge' | 'edge' | undefined // @ts-ignore This path is generated at build time and conflicts otherwise export { NextConfig } from '../dist/server/config' -export type { - Metadata, - RobotsFile, - SitemapFile, // @ts-ignore This path is generated at build time and conflicts otherwise -} from '../dist/lib/metadata/types/metadata-interface' +// @ts-ignore This path is generated at build time and conflicts otherwise +export type { Metadata } from '../dist/lib/metadata/types/metadata-interface' // Extend the React types with missing properties declare module 'react' { diff --git a/test/e2e/app-dir/metadata-dynamic-routes/app/manifest.ts b/test/e2e/app-dir/metadata-dynamic-routes/app/manifest.ts new file mode 100644 index 000000000000..736cffed86b6 --- /dev/null +++ b/test/e2e/app-dir/metadata-dynamic-routes/app/manifest.ts @@ -0,0 +1,18 @@ +export default function manifest() { + return { + name: 'Next.js App', + short_name: 'Next.js App', + description: 'Next.js App', + start_url: '/', + display: 'standalone', + background_color: '#fff', + theme_color: '#fff', + icons: [ + { + src: '/favicon.ico', + sizes: 'any', + type: 'image/x-icon', + }, + ], + } +} diff --git a/test/e2e/app-dir/metadata-dynamic-routes/app/robots.ts b/test/e2e/app-dir/metadata-dynamic-routes/app/robots.ts index 5a2bb37510ed..749881098a1e 100644 --- a/test/e2e/app-dir/metadata-dynamic-routes/app/robots.ts +++ b/test/e2e/app-dir/metadata-dynamic-routes/app/robots.ts @@ -1,6 +1,4 @@ -import type { RobotsFile } from 'next' - -export default function robots(): RobotsFile { +export default function robots() { return { rules: [ { diff --git a/test/e2e/app-dir/metadata-dynamic-routes/app/sitemap.ts b/test/e2e/app-dir/metadata-dynamic-routes/app/sitemap.ts index 76a55cc17e47..7b1426aa7ea4 100644 --- a/test/e2e/app-dir/metadata-dynamic-routes/app/sitemap.ts +++ b/test/e2e/app-dir/metadata-dynamic-routes/app/sitemap.ts @@ -1,6 +1,4 @@ -import type { SitemapFile } from 'next' - -export default function sitemap(): SitemapFile { +export default function sitemap() { return [ { url: 'https://example.com', diff --git a/test/e2e/app-dir/metadata-dynamic-routes/index.test.ts b/test/e2e/app-dir/metadata-dynamic-routes/index.test.ts index 43d9844c22d4..b529a8e35675 100644 --- a/test/e2e/app-dir/metadata-dynamic-routes/index.test.ts +++ b/test/e2e/app-dir/metadata-dynamic-routes/index.test.ts @@ -56,6 +56,35 @@ createNextDescribe( " `) }) + + it('should handle manifest.[ext] dynamic routes', async () => { + const res = await next.fetch('/manifest.json') + const json = await res.json() + + expect(res.headers.get('content-type')).toBe( + 'application/manifest+json' + ) + expect(res.headers.get('cache-control')).toBe( + 'public, max-age=0, must-revalidate' + ) + + expect(json).toMatchObject({ + name: 'Next.js App', + short_name: 'Next.js App', + description: 'Next.js App', + start_url: '/', + display: 'standalone', + background_color: '#fff', + theme_color: '#fff', + icons: [ + { + src: '/favicon.ico', + sizes: 'any', + type: 'image/x-icon', + }, + ], + }) + }) }) } ) From cd3d997576badd88c59e83703c48a77eacec0f37 Mon Sep 17 00:00:00 2001 From: Jiachi Liu Date: Fri, 17 Mar 2023 14:33:04 +0100 Subject: [PATCH 2/6] fix robots type --- .../loaders/metadata/resolve-route-data.test.ts | 11 +++++------ .../next/src/lib/metadata/types/metadata-interface.ts | 2 +- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/packages/next/src/build/webpack/loaders/metadata/resolve-route-data.test.ts b/packages/next/src/build/webpack/loaders/metadata/resolve-route-data.test.ts index 684d94ddc697..38261e75ee21 100644 --- a/packages/next/src/build/webpack/loaders/metadata/resolve-route-data.test.ts +++ b/packages/next/src/build/webpack/loaders/metadata/resolve-route-data.test.ts @@ -1,4 +1,4 @@ -import type { RobotsFile } from '../../../../lib/metadata/types/metadata-interface' +import type { Robots } from '../../../../lib/metadata/types/metadata-interface' import { resolveRobots, resolveSitemap } from './resolve-route-data' describe('resolveRouteData', () => { @@ -30,7 +30,7 @@ describe('resolveRouteData', () => { }) it('should error with ts when specify both wildcard userAgent and specific userAgent', () => { - const data1: RobotsFile = { + const data1: Robots = { rules: [ // @ts-expect-error userAgent is required for Array { @@ -43,15 +43,14 @@ describe('resolveRouteData', () => { ], } - const data2: RobotsFile = { + const data2: Robots = { rules: { - // @ts-expect-error When apply only 1 rule, only '*' or undefined is allowed - userAgent: 'Somebot', + // Can skip userAgent for single Robots allow: '/', }, } - const data3: RobotsFile = { + const data3: Robots = { rules: { allow: '/' }, } diff --git a/packages/next/src/lib/metadata/types/metadata-interface.ts b/packages/next/src/lib/metadata/types/metadata-interface.ts index d36373e4f0d9..bf4dd99bf278 100644 --- a/packages/next/src/lib/metadata/types/metadata-interface.ts +++ b/packages/next/src/lib/metadata/types/metadata-interface.ts @@ -538,7 +538,7 @@ type RobotsFile = { // Apply rules for all rules: | { - userAgent?: undefined | '*' + userAgent?: string | string[] allow?: string | string[] disallow?: string | string[] crawlDelay?: number From 82c5dedd8e5892a0b6f649f391c846f8e788eceb Mon Sep 17 00:00:00 2001 From: Jiachi Liu Date: Fri, 17 Mar 2023 14:39:25 +0100 Subject: [PATCH 3/6] add as const --- packages/next/src/build/webpack/loaders/metadata/discover.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/next/src/build/webpack/loaders/metadata/discover.ts b/packages/next/src/build/webpack/loaders/metadata/discover.ts index 91e8fbb5ce61..47f5ff3fdaf6 100644 --- a/packages/next/src/build/webpack/loaders/metadata/discover.ts +++ b/packages/next/src/build/webpack/loaders/metadata/discover.ts @@ -31,7 +31,7 @@ export const STATIC_METADATA_IMAGES = { filename: 'twitter-image', extensions: ['jpg', 'jpeg', 'png', 'gif'], }, -} +} as const // Produce all compositions with filename (icon, apple-icon, etc.) with extensions (png, jpg, etc.) async function enumMetadataFiles( From 9ed619790af741336cf6854e27e24f96a02f97f9 Mon Sep 17 00:00:00 2001 From: Jiachi Liu Date: Fri, 17 Mar 2023 17:27:52 +0100 Subject: [PATCH 4/6] update extension and fix typing --- packages/next/src/build/webpack/loaders/metadata/discover.ts | 2 +- packages/next/src/lib/metadata/get-metadata-route.ts | 2 +- packages/next/src/lib/metadata/is-metadata-route.ts | 2 +- test/e2e/app-dir/metadata-dynamic-routes/index.test.ts | 2 +- test/e2e/app-dir/metadata/app/basic/page.tsx | 2 +- test/e2e/app-dir/metadata/metadata.test.ts | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/next/src/build/webpack/loaders/metadata/discover.ts b/packages/next/src/build/webpack/loaders/metadata/discover.ts index 47f5ff3fdaf6..3081ded78e92 100644 --- a/packages/next/src/build/webpack/loaders/metadata/discover.ts +++ b/packages/next/src/build/webpack/loaders/metadata/discover.ts @@ -37,7 +37,7 @@ export const STATIC_METADATA_IMAGES = { async function enumMetadataFiles( dir: string, filename: string, - extensions: string[], + extensions: readonly string[], { resolvePath, loaderContext, diff --git a/packages/next/src/lib/metadata/get-metadata-route.ts b/packages/next/src/lib/metadata/get-metadata-route.ts index cddeda620615..10b56b893d60 100644 --- a/packages/next/src/lib/metadata/get-metadata-route.ts +++ b/packages/next/src/lib/metadata/get-metadata-route.ts @@ -21,7 +21,7 @@ export function normalizeMetadataRoute(page: string) { route += '.txt' } if (route === '/manifest') { - route += '.json' + route += '.webmanifest' } route = `${route}/route` } diff --git a/packages/next/src/lib/metadata/is-metadata-route.ts b/packages/next/src/lib/metadata/is-metadata-route.ts index b27869a8f340..739d26d0582a 100644 --- a/packages/next/src/lib/metadata/is-metadata-route.ts +++ b/packages/next/src/lib/metadata/is-metadata-route.ts @@ -4,7 +4,7 @@ import { STATIC_METADATA_IMAGES } from '../../build/webpack/loaders/metadata/dis // TODO-METADATA: support more metadata routes with more extensions const defaultExtensions = ['js', 'jsx', 'ts', 'tsx'] -const getExtensionRegexString = (extensions: string[]) => +const getExtensionRegexString = (extensions: readonly string[]) => `(?:${extensions.join('|')})` // When you only pass the file extension as `[]`, it will only match the static convention files diff --git a/test/e2e/app-dir/metadata-dynamic-routes/index.test.ts b/test/e2e/app-dir/metadata-dynamic-routes/index.test.ts index b529a8e35675..4b49a9e9e846 100644 --- a/test/e2e/app-dir/metadata-dynamic-routes/index.test.ts +++ b/test/e2e/app-dir/metadata-dynamic-routes/index.test.ts @@ -58,7 +58,7 @@ createNextDescribe( }) it('should handle manifest.[ext] dynamic routes', async () => { - const res = await next.fetch('/manifest.json') + const res = await next.fetch('/manifest.webmanifest') const json = await res.json() expect(res.headers.get('content-type')).toBe( diff --git a/test/e2e/app-dir/metadata/app/basic/page.tsx b/test/e2e/app-dir/metadata/app/basic/page.tsx index b9366e712bea..82f9f04e593a 100644 --- a/test/e2e/app-dir/metadata/app/basic/page.tsx +++ b/test/e2e/app-dir/metadata/app/basic/page.tsx @@ -25,7 +25,7 @@ export const metadata: Metadata = { authors: [{ name: 'huozhi' }, { name: 'tree', url: 'https://tree.com' }], themeColor: { color: 'cyan', media: '(prefers-color-scheme: dark)' }, colorScheme: 'dark', - manifest: 'https://github.com/manifest.json', + manifest: 'https://www.google.com/manifest', viewport: { width: 'device-width', initialScale: 1, diff --git a/test/e2e/app-dir/metadata/metadata.test.ts b/test/e2e/app-dir/metadata/metadata.test.ts index abff83ac1434..8efc08ef79c3 100644 --- a/test/e2e/app-dir/metadata/metadata.test.ts +++ b/test/e2e/app-dir/metadata/metadata.test.ts @@ -210,7 +210,7 @@ createNextDescribe( }) await matchMultiDom('link', 'rel', 'href', { - manifest: 'https://github.com/manifest.json', + manifest: 'https://www.google.com/manifest', author: 'https://tree.com', preconnect: '/preconnect-url', preload: '/preload-url', From a2088dc7f45e4ddb301b0a0c7909974f725be28f Mon Sep 17 00:00:00 2001 From: Jiachi Liu Date: Fri, 17 Mar 2023 17:41:54 +0100 Subject: [PATCH 5/6] add webmanifest in ext --- packages/next/src/lib/metadata/is-metadata-route.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/next/src/lib/metadata/is-metadata-route.ts b/packages/next/src/lib/metadata/is-metadata-route.ts index 739d26d0582a..d23578befa0a 100644 --- a/packages/next/src/lib/metadata/is-metadata-route.ts +++ b/packages/next/src/lib/metadata/is-metadata-route.ts @@ -36,7 +36,9 @@ export function isMetadataRouteFile( new RegExp( `^[\\\\/]manifest${ withExtension - ? `\\.${getExtensionRegexString(pageExtensions.concat('json'))}` + ? `\\.${getExtensionRegexString( + pageExtensions.concat('webmanifest', 'json') + )}` : '' }` ), From b0ca7da6106736b8a5cd87b4aa736ee6e8a878d1 Mon Sep 17 00:00:00 2001 From: Jiachi Liu Date: Fri, 17 Mar 2023 17:47:26 +0100 Subject: [PATCH 6/6] Add test for static asset --- .../app-dir/metadata/app/manifest.webmanifest | 9 +++++++++ test/e2e/app-dir/metadata/metadata.test.ts | 17 +++++++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 test/e2e/app-dir/metadata/app/manifest.webmanifest diff --git a/test/e2e/app-dir/metadata/app/manifest.webmanifest b/test/e2e/app-dir/metadata/app/manifest.webmanifest new file mode 100644 index 000000000000..f3e287945395 --- /dev/null +++ b/test/e2e/app-dir/metadata/app/manifest.webmanifest @@ -0,0 +1,9 @@ +{ + "name": "Next.js Static Manifest", + "short_name": "Next.js App", + "description": "Next.js App", + "start_url": "/", + "display": "standalone", + "background_color": "#fff", + "theme_color": "#fff" +} diff --git a/test/e2e/app-dir/metadata/metadata.test.ts b/test/e2e/app-dir/metadata/metadata.test.ts index 8efc08ef79c3..473282c78df8 100644 --- a/test/e2e/app-dir/metadata/metadata.test.ts +++ b/test/e2e/app-dir/metadata/metadata.test.ts @@ -687,6 +687,23 @@ createNextDescribe( expect(invalidSitemapResponse.status).toBe(404) }) + it('should support static manifest.webmanifest', async () => { + const res = await next.fetch('/manifest.webmanifest') + expect(res.headers.get('content-type')).toBe( + 'application/manifest+json' + ) + const manifest = await res.json() + expect(manifest).toMatchObject({ + name: 'Next.js Static Manifest', + short_name: 'Next.js App', + description: 'Next.js App', + start_url: '/', + display: 'standalone', + background_color: '#fff', + theme_color: '#fff', + }) + }) + if (isNextStart) { it('should build favicon.ico as a custom route', async () => { const appPathsManifest = JSON.parse(