Unverified Commit bf8ee1ed authored by Hannes Bornö's avatar Hannes Bornö Committed by GitHub

Add support for font loaders (#40746)

For some context:
[https://vercel.slack.com/archives/CGU8HUTUH/p1662124179102509](https://vercel.slack.com/archives/CGU8HUTUH/p1662124179102509)

Continuation of #40221 and #40227

Adds `experimental.fontLoaders`.

SWC next-font-loaders (#40221) transforms font loader (e.g. #40227) call
expressions into an import with the function call arguments as a query.

The imports will be matched by `next-font-loader`. It runs the
configured font loaders - emits font files and returns CSS. Exports are
added, and the font-family is made locally scoped. The returned CSS is
turned into a CSS module with `css-loader` which lets you consume the
font-family.

`FontLoaderManifestPlugin` creates a manifest of the preloaded font
files for each entrypoint. Preload/preconnect are then added in
`_document.tsx` if any font files were found for that path.
Co-authored-by: 's avatarJJ Kasper <jj@jjsweb.site>
parent ef9ba450
...@@ -204,6 +204,7 @@ export function getEdgeServerEntry(opts: { ...@@ -204,6 +204,7 @@ export function getEdgeServerEntry(opts: {
pagesType: opts.pagesType, pagesType: opts.pagesType,
appDirLoader: Buffer.from(opts.appDirLoader || '').toString('base64'), appDirLoader: Buffer.from(opts.appDirLoader || '').toString('base64'),
sriEnabled: !opts.isDev && !!opts.config.experimental.sri?.algorithm, sriEnabled: !opts.isDev && !!opts.config.experimental.sri?.algorithm,
hasFontLoaders: !!opts.config.experimental.fontLoaders,
} }
return { return {
......
...@@ -59,6 +59,7 @@ import { ...@@ -59,6 +59,7 @@ import {
APP_BUILD_MANIFEST, APP_BUILD_MANIFEST,
FLIGHT_SERVER_CSS_MANIFEST, FLIGHT_SERVER_CSS_MANIFEST,
RSC_MODULE_TYPES, RSC_MODULE_TYPES,
FONT_LOADER_MANIFEST,
} from '../shared/lib/constants' } from '../shared/lib/constants'
import { getSortedRoutes, isDynamicRoute } from '../shared/lib/router/utils' import { getSortedRoutes, isDynamicRoute } from '../shared/lib/router/utils'
import { __ApiPreviewProps } from '../server/api-utils' import { __ApiPreviewProps } from '../server/api-utils'
...@@ -828,6 +829,9 @@ export default async function build( ...@@ -828,6 +829,9 @@ export default async function build(
config.optimizeFonts ? path.join(serverDir, FONT_MANIFEST) : null, config.optimizeFonts ? path.join(serverDir, FONT_MANIFEST) : null,
BUILD_ID_FILE, BUILD_ID_FILE,
appDir ? path.join(serverDir, APP_PATHS_MANIFEST) : null, appDir ? path.join(serverDir, APP_PATHS_MANIFEST) : null,
config.experimental.fontLoaders
? path.join(serverDir, FONT_LOADER_MANIFEST)
: null,
] ]
.filter(nonNullable) .filter(nonNullable)
.map((file) => path.join(config.distDir, file)), .map((file) => path.join(config.distDir, file)),
......
...@@ -123,6 +123,9 @@ function getBaseSWCOptions({ ...@@ -123,6 +123,9 @@ function getBaseSWCOptions({
isServer: !!isServerLayer, isServer: !!isServerLayer,
} }
: false, : false,
fontLoaders:
nextConfig?.experimental?.fontLoaders &&
Object.keys(nextConfig.experimental.fontLoaders),
} }
} }
......
...@@ -61,6 +61,7 @@ import loadJsConfig from './load-jsconfig' ...@@ -61,6 +61,7 @@ import loadJsConfig from './load-jsconfig'
import { loadBindings } from './swc' import { loadBindings } from './swc'
import { AppBuildManifestPlugin } from './webpack/plugins/app-build-manifest-plugin' import { AppBuildManifestPlugin } from './webpack/plugins/app-build-manifest-plugin'
import { SubresourceIntegrityPlugin } from './webpack/plugins/subresource-integrity-plugin' import { SubresourceIntegrityPlugin } from './webpack/plugins/subresource-integrity-plugin'
import { FontLoaderManifestPlugin } from './webpack/plugins/font-loader-manifest-plugin'
const NEXT_PROJECT_ROOT = pathJoin(__dirname, '..', '..') const NEXT_PROJECT_ROOT = pathJoin(__dirname, '..', '..')
const NEXT_PROJECT_ROOT_DIST = pathJoin(NEXT_PROJECT_ROOT, 'dist') const NEXT_PROJECT_ROOT_DIST = pathJoin(NEXT_PROJECT_ROOT, 'dist')
...@@ -1508,6 +1509,7 @@ export default async function getBaseWebpackConfig( ...@@ -1508,6 +1509,7 @@ export default async function getBaseWebpackConfig(
'next-middleware-asset-loader', 'next-middleware-asset-loader',
'next-middleware-wasm-loader', 'next-middleware-wasm-loader',
'next-app-loader', 'next-app-loader',
'next-font-loader',
].reduce((alias, loader) => { ].reduce((alias, loader) => {
// using multiple aliases to replace `resolveLoader.modules` // using multiple aliases to replace `resolveLoader.modules`
alias[loader] = path.join(__dirname, 'webpack', 'loaders', loader) alias[loader] = path.join(__dirname, 'webpack', 'loaders', loader)
...@@ -1838,6 +1840,7 @@ export default async function getBaseWebpackConfig( ...@@ -1838,6 +1840,7 @@ export default async function getBaseWebpackConfig(
new MiddlewarePlugin({ new MiddlewarePlugin({
dev, dev,
sriEnabled: !dev && !!config.experimental.sri?.algorithm, sriEnabled: !dev && !!config.experimental.sri?.algorithm,
hasFontLoaders: !!config.experimental.fontLoaders,
}), }),
isClient && isClient &&
new BuildManifestPlugin({ new BuildManifestPlugin({
...@@ -1890,6 +1893,9 @@ export default async function getBaseWebpackConfig( ...@@ -1890,6 +1893,9 @@ export default async function getBaseWebpackConfig(
isClient && isClient &&
!!config.experimental.sri?.algorithm && !!config.experimental.sri?.algorithm &&
new SubresourceIntegrityPlugin(config.experimental.sri.algorithm), new SubresourceIntegrityPlugin(config.experimental.sri.algorithm),
isClient &&
config.experimental.fontLoaders &&
new FontLoaderManifestPlugin(),
!dev && !dev &&
isClient && isClient &&
new (require('./webpack/plugins/telemetry-plugin').TelemetryPlugin)( new (require('./webpack/plugins/telemetry-plugin').TelemetryPlugin)(
......
...@@ -3,11 +3,13 @@ import { webpack } from 'next/dist/compiled/webpack/webpack' ...@@ -3,11 +3,13 @@ import { webpack } from 'next/dist/compiled/webpack/webpack'
import { loader, plugin } from '../../helpers' import { loader, plugin } from '../../helpers'
import { ConfigurationContext, ConfigurationFn, pipe } from '../../utils' import { ConfigurationContext, ConfigurationFn, pipe } from '../../utils'
import { getCssModuleLoader, getGlobalCssLoader } from './loaders' import { getCssModuleLoader, getGlobalCssLoader } from './loaders'
import { getFontLoader } from './loaders/font-loader'
import { import {
getCustomDocumentError, getCustomDocumentError,
getGlobalImportError, getGlobalImportError,
getGlobalModuleImportError, getGlobalModuleImportError,
getLocalModuleImportError, getLocalModuleImportError,
getFontLoaderDocumentImportError,
} from './messages' } from './messages'
import { getPostCssPlugins } from './plugins' import { getPostCssPlugins } from './plugins'
...@@ -199,6 +201,59 @@ export const css = curry(async function css( ...@@ -199,6 +201,59 @@ export const css = curry(async function css(
}) })
) )
// Resolve the configured font loaders, the resolved files are noop files that next-font-loader will match
let fontLoaders: [string, string][] | undefined = ctx.experimental.fontLoaders
? Object.entries(ctx.experimental.fontLoaders).map(
([fontLoader, fontLoaderOptions]: any) => [
require.resolve(fontLoader),
fontLoaderOptions,
]
)
: undefined
// Font loaders cannot be imported in _document.
fontLoaders?.forEach(([fontLoaderPath, fontLoaderOptions]) => {
fns.push(
loader({
oneOf: [
markRemovable({
test: fontLoaderPath,
// Use a loose regex so we don't have to crawl the file system to
// find the real file name (if present).
issuer: /pages[\\/]_document\./,
use: {
loader: 'error-loader',
options: {
reason: getFontLoaderDocumentImportError(),
},
},
}),
],
})
)
// Matches the resolved font loaders noop files to run next-font-loader
fns.push(
loader({
oneOf: [
markRemovable({
sideEffects: false,
test: fontLoaderPath,
issuer: {
and: [
{
or: [ctx.rootDirectory, regexClientEntry],
},
],
not: [/node_modules/],
},
use: getFontLoader(ctx, lazyPostCSSInitializer, fontLoaderOptions),
}),
],
})
)
})
// CSS Modules support must be enabled on the server and client so the class // CSS Modules support must be enabled on the server and client so the class
// names are available for SSR or Prerendering. // names are available for SSR or Prerendering.
if (ctx.experimental.appDir && !ctx.isProduction) { if (ctx.experimental.appDir && !ctx.isProduction) {
......
import { webpack } from 'next/dist/compiled/webpack/webpack'
import { ConfigurationContext } from '../../../utils'
import { getClientStyleLoader } from './client'
import { cssFileResolve } from './file-resolve'
export function getFontLoader(
ctx: ConfigurationContext,
postcss: any,
fontLoaderOptions: any
): webpack.RuleSetUseItem[] {
const loaders: webpack.RuleSetUseItem[] = []
if (ctx.isClient) {
// Add appropriate development mode or production mode style
// loader
loaders.push(
getClientStyleLoader({
isAppDir: !!ctx.experimental.appDir,
isDevelopment: ctx.isDevelopment,
assetPrefix: ctx.assetPrefix,
})
)
}
loaders.push({
loader: require.resolve('../../../../loaders/css-loader/src'),
options: {
postcss,
importLoaders: 1,
// Use CJS mode for backwards compatibility:
esModule: false,
url: (url: string, resourcePath: string) =>
cssFileResolve(url, resourcePath, ctx.experimental.urlImports),
import: (url: string, _: any, resourcePath: string) =>
cssFileResolve(url, resourcePath, ctx.experimental.urlImports),
modules: {
// Do not transform class names (CJS mode backwards compatibility):
exportLocalsConvention: 'asIs',
// Server-side (Node.js) rendering support:
exportOnlyLocals: ctx.isServer,
// Disallow global style exports so we can code-split CSS and
// not worry about loading order.
mode: 'pure',
getLocalIdent: (
_context: any,
_localIdentName: any,
exportName: string,
_options: any,
meta: any
) => {
// hash from next-font-loader
return `__${exportName}_${meta.fontFamilyHash}`
},
},
fontLoader: true,
},
})
loaders.push({
loader: 'next-font-loader',
options: {
isServer: ctx.isServer,
assetPrefix: ctx.assetPrefix,
fontLoaderOptions,
postcss,
},
})
return loaders
}
...@@ -31,3 +31,9 @@ export function getCustomDocumentError() { ...@@ -31,3 +31,9 @@ export function getCustomDocumentError() {
'pages/_document.js' 'pages/_document.js'
)}. Please move global styles to ${chalk.cyan('pages/_app.js')}.` )}. Please move global styles to ${chalk.cyan('pages/_app.js')}.`
} }
export function getFontLoaderDocumentImportError() {
return `Font loaders ${chalk.bold('cannot')} be used within ${chalk.cyan(
'pages/_document.js'
)}.`
}
...@@ -4,7 +4,6 @@ ...@@ -4,7 +4,6 @@
*/ */
import CssSyntaxError from './CssSyntaxError' import CssSyntaxError from './CssSyntaxError'
import Warning from '../../postcss-loader/src/Warning' import Warning from '../../postcss-loader/src/Warning'
// import { icssParser, importParser, urlParser } from './plugins'
import { stringifyRequest } from '../../../stringify-request' import { stringifyRequest } from '../../../stringify-request'
const moduleRegExp = /\.module\.\w+$/i const moduleRegExp = /\.module\.\w+$/i
...@@ -128,6 +127,7 @@ function normalizeOptions(rawOptions, loaderContext) { ...@@ -128,6 +127,7 @@ function normalizeOptions(rawOptions, loaderContext) {
: rawOptions.importLoaders, : rawOptions.importLoaders,
esModule: esModule:
typeof rawOptions.esModule === 'undefined' ? true : rawOptions.esModule, typeof rawOptions.esModule === 'undefined' ? true : rawOptions.esModule,
fontLoader: rawOptions.fontLoader,
} }
} }
...@@ -169,10 +169,11 @@ export default async function loader(content, map, meta) { ...@@ -169,10 +169,11 @@ export default async function loader(content, map, meta) {
const { icssParser, importParser, urlParser } = require('./plugins') const { icssParser, importParser, urlParser } = require('./plugins')
const replacements = [] const replacements = []
const exports = [] // if it's a font loader next-font-loader will have exports that should be exported as is
const exports = options.fontLoader ? meta.exports : []
if (shouldUseModulesPlugins(options)) { if (shouldUseModulesPlugins(options)) {
plugins.push(...getModulesPlugins(options, this)) plugins.push(...getModulesPlugins(options, this, meta))
} }
const importPluginImports = [] const importPluginImports = []
......
...@@ -135,7 +135,7 @@ function shouldUseIcssPlugin(options) { ...@@ -135,7 +135,7 @@ function shouldUseIcssPlugin(options) {
return options.icss === true || Boolean(options.modules) return options.icss === true || Boolean(options.modules)
} }
function getModulesPlugins(options, loaderContext) { function getModulesPlugins(options, loaderContext, meta) {
const { const {
mode, mode,
getLocalIdent, getLocalIdent,
...@@ -154,11 +154,17 @@ function getModulesPlugins(options, loaderContext) { ...@@ -154,11 +154,17 @@ function getModulesPlugins(options, loaderContext) {
extractImports(), extractImports(),
modulesScope({ modulesScope({
generateScopedName(exportName) { generateScopedName(exportName) {
return getLocalIdent(loaderContext, localIdentName, exportName, { return getLocalIdent(
context: localIdentContext, loaderContext,
hashPrefix: localIdentHashPrefix, localIdentName,
regExp: localIdentRegExp, exportName,
}) {
context: localIdentContext,
hashPrefix: localIdentHashPrefix,
regExp: localIdentRegExp,
},
meta
)
}, },
exportGlobals: options.modules.exportGlobals, exportGlobals: options.modules.exportGlobals,
}), }),
......
...@@ -15,6 +15,7 @@ export type EdgeSSRLoaderQuery = { ...@@ -15,6 +15,7 @@ export type EdgeSSRLoaderQuery = {
appDirLoader?: string appDirLoader?: string
pagesType?: 'app' | 'pages' | 'root' pagesType?: 'app' | 'pages' | 'root'
sriEnabled: boolean sriEnabled: boolean
hasFontLoaders: boolean
} }
export default async function edgeSSRLoader(this: any) { export default async function edgeSSRLoader(this: any) {
...@@ -32,6 +33,7 @@ export default async function edgeSSRLoader(this: any) { ...@@ -32,6 +33,7 @@ export default async function edgeSSRLoader(this: any) {
appDirLoader: appDirLoaderBase64, appDirLoader: appDirLoaderBase64,
pagesType, pagesType,
sriEnabled, sriEnabled,
hasFontLoaders,
} = this.getOptions() } = this.getOptions()
const appDirLoader = Buffer.from( const appDirLoader = Buffer.from(
...@@ -103,6 +105,9 @@ export default async function edgeSSRLoader(this: any) { ...@@ -103,6 +105,9 @@ export default async function edgeSSRLoader(this: any) {
const subresourceIntegrityManifest = ${ const subresourceIntegrityManifest = ${
sriEnabled ? 'self.__SUBRESOURCE_INTEGRITY_MANIFEST' : 'undefined' sriEnabled ? 'self.__SUBRESOURCE_INTEGRITY_MANIFEST' : 'undefined'
} }
const fontLoaderManifest = ${
hasFontLoaders ? 'self.__FONT_LOADER_MANIFEST' : 'undefined'
}
const render = getRender({ const render = getRender({
pageType, pageType,
...@@ -122,6 +127,7 @@ export default async function edgeSSRLoader(this: any) { ...@@ -122,6 +127,7 @@ export default async function edgeSSRLoader(this: any) {
subresourceIntegrityManifest, subresourceIntegrityManifest,
config: ${stringifiedConfig}, config: ${stringifiedConfig},
buildId: ${JSON.stringify(buildId)}, buildId: ${JSON.stringify(buildId)},
fontLoaderManifest,
}) })
export const ComponentMod = pageMod export const ComponentMod = pageMod
......
...@@ -2,6 +2,7 @@ import type { NextConfig } from '../../../../server/config-shared' ...@@ -2,6 +2,7 @@ import type { NextConfig } from '../../../../server/config-shared'
import type { DocumentType, AppType } from '../../../../shared/lib/utils' import type { DocumentType, AppType } from '../../../../shared/lib/utils'
import type { BuildManifest } from '../../../../server/get-page-files' import type { BuildManifest } from '../../../../server/get-page-files'
import type { ReactLoadableManifest } from '../../../../server/load-components' import type { ReactLoadableManifest } from '../../../../server/load-components'
import type { FontLoaderManifest } from '../../plugins/font-loader-manifest-plugin'
import WebServer from '../../../../server/web-server' import WebServer from '../../../../server/web-server'
import { import {
...@@ -28,6 +29,7 @@ export function getRender({ ...@@ -28,6 +29,7 @@ export function getRender({
serverCSSManifest, serverCSSManifest,
config, config,
buildId, buildId,
fontLoaderManifest,
}: { }: {
pagesType?: 'app' | 'pages' | 'root' pagesType?: 'app' | 'pages' | 'root'
dev: boolean dev: boolean
...@@ -47,6 +49,7 @@ export function getRender({ ...@@ -47,6 +49,7 @@ export function getRender({
appServerMod: any appServerMod: any
config: NextConfig config: NextConfig
buildId: string buildId: string
fontLoaderManifest: FontLoaderManifest
}) { }) {
const isAppPath = pagesType === 'app' const isAppPath = pagesType === 'app'
const baseLoadComponentResult = { const baseLoadComponentResult = {
...@@ -54,6 +57,7 @@ export function getRender({ ...@@ -54,6 +57,7 @@ export function getRender({
buildManifest, buildManifest,
reactLoadableManifest, reactLoadableManifest,
subresourceIntegrityManifest, subresourceIntegrityManifest,
fontLoaderManifest,
Document, Document,
App: appMod?.default as AppType, App: appMod?.default as AppType,
} }
......
import path from 'path'
import loaderUtils from 'next/dist/compiled/loader-utils3'
import postcssFontLoaderPlugn from './postcss-font-loader'
type FontLoader = (options: {
functionName: string
data: any[]
config: any
emitFontFile: (content: Buffer, ext: string, preload: boolean) => string
}) => Promise<{ css: string; fallbackFonts: string[] }>
export default async function nextFontLoader(this: any) {
const fontLoaderSpan = this.currentTraceSpan.traceChild('next-font-loader')
return fontLoaderSpan.traceAsyncFn(async () => {
const callback = this.async()
const {
isServer,
assetPrefix,
fontLoaderOptions,
postcss: getPostcss,
} = this.getOptions()
const emitFontFile = (content: Buffer, ext: string, preload: boolean) => {
const opts = { context: this.rootContext, content }
const interpolatedName = loaderUtils.interpolateName(
this,
// Font files ending with .p.(woff|woff2|eot|ttf|otf) are preloaded
`static/fonts/[hash]${preload ? '.p' : ''}.${ext}`,
opts
)
const outputPath = `${assetPrefix}/_next/${interpolatedName}`
if (!isServer) {
this.emitFile(interpolatedName, content, null)
}
return outputPath
}
// next-swc next_font_loaders turns each function call argument into JSON seperated by semicolons
let [functionName, ...data] = this.resourceQuery.slice(1).split(';')
data = data.map((value: string) => JSON.parse(value))
try {
const fontLoader: FontLoader = require(path.join(
this.resourcePath,
'../loader.js'
)).default
let { css, fallbackFonts } = await fontLoader({
functionName,
data,
config: fontLoaderOptions,
emitFontFile,
})
const { postcss } = await getPostcss()
// Exports will be exported as is from css-loader instead of a CSS module export
const exports: { name: any; value: any }[] = []
const fontFamilyHash = loaderUtils.getHashDigest(
Buffer.from(css),
'md5',
'hex',
6
)
// Add CSS classes, exports and make the font-family localy scoped by turning it unguessable
const result = await postcss(
postcssFontLoaderPlugn(exports, fontFamilyHash, fallbackFonts)
).process(css, {
from: undefined,
})
// Reuse ast in css-loader
const ast = {
type: 'postcss',
version: result.processor.version,
root: result.root,
}
callback(null, result.css, null, { exports, ast, fontFamilyHash })
} catch (err: any) {
err.stack = false
callback(err)
}
})
}
import postcss, { Declaration } from 'postcss'
const postcssFontLoaderPlugn = (
exports: { name: any; value: any }[],
fontFamilyHash: string,
fallbackFonts: string[] = []
) => {
return {
postcssPlugin: 'postcss-font-loader',
Once(root: any) {
const fontFamilies: string[] = []
let rawFamily: string | undefined
let fontWeight: string | undefined
let fontStyle: string | undefined
const formatFamily = (family: string) => {
if (family[0] === "'" || family[0] === '"') {
family = family.slice(1, family.length - 1)
}
// Turn the font family unguessable to make it localy scoped
return `'__${family.replace(/ /g, '_')}_${fontFamilyHash}'`
}
for (const node of root.nodes) {
if (node.type === 'atrule' && node.name === 'font-face') {
const familyNode = node.nodes.find(
(decl: Declaration) => decl.prop === 'font-family'
)
if (!familyNode) {
continue
}
if (!rawFamily) {
let family: string = familyNode.value
if (family[0] === "'" || family[0] === '"') {
family = family.slice(1, family.length - 1)
}
rawFamily = family
}
const formattedFamily = formatFamily(familyNode.value)
familyNode.value = formattedFamily
if (fontFamilies.includes(formattedFamily)) {
continue
}
fontFamilies.push(formattedFamily)
// Only extract weight and style from first encountered family, the rest will treated as fallbacks
if (fontFamilies.length > 1) {
continue
}
// Extract weight and style from first encountered @font-face
const weight = node.nodes.find(
(decl: Declaration) => decl.prop === 'font-weight'
)
// Skip if the value includes ' ', then it's a range of possible values
if (weight && !weight.value.includes(' ')) {
fontWeight = weight.value
}
const style = node.nodes.find(
(decl: Declaration) => decl.prop === 'font-style'
)
// Skip if the value includes ' ', then it's a range of possible values
if (style && !style.value.includes(' ')) {
fontStyle = style.value
}
}
}
const [mainFontFamily, ...adjustFontFallbacks] = fontFamilies
// If fallback fonts were provided from the font loader, they should be used before the adjustFontFallbacks
const formattedFontFamilies = [
mainFontFamily,
...fallbackFonts,
...adjustFontFallbacks,
].join(', ')
// Add class with family, weight and style
const classRule = new postcss.Rule({ selector: '.className' })
classRule.nodes = [
new postcss.Declaration({
prop: 'font-family',
value: formattedFontFamilies,
}),
...(fontWeight
? [
new postcss.Declaration({
prop: 'font-weight',
value: fontWeight,
}),
]
: []),
...(fontStyle
? [
new postcss.Declaration({
prop: 'font-style',
value: fontStyle,
}),
]
: []),
]
root.nodes.push(classRule)
// Add class that defines a variable with the font family
const varialbeRule = new postcss.Rule({ selector: '.variable' })
varialbeRule.nodes = [
new postcss.Declaration({
prop: rawFamily
? `--next-font-${rawFamily.toLowerCase().replace(/ /g, '-')}${
fontWeight ? `-${fontWeight}` : ''
}${fontStyle === 'italic' ? `-${fontStyle}` : ''}`
: '',
value: formattedFontFamilies,
}),
]
root.nodes.push(varialbeRule)
// Export @font-face values as is
exports.push({
name: 'style',
value: {
fontFamily: formattedFontFamilies,
fontWeight: fontWeight && Number(fontWeight),
fontStyle,
},
})
},
}
}
postcssFontLoaderPlugn.postcss = true
export default postcssFontLoaderPlugn
import { webpack, sources } from 'next/dist/compiled/webpack/webpack'
import getRouteFromEntrypoint from '../../../server/get-route-from-entrypoint'
import { FONT_LOADER_MANIFEST } from '../../../shared/lib/constants'
export type FontLoaderManifest = {
pages: {
[path: string]: string[]
}
}
const PLUGIN_NAME = 'FontLoaderManifestPlugin'
// Creates a manifest of all fonts that should be preloaded given a route
export class FontLoaderManifestPlugin {
apply(compiler: webpack.Compiler) {
compiler.hooks.make.tap(PLUGIN_NAME, (compilation) => {
compilation.hooks.processAssets.tap(
{
name: PLUGIN_NAME,
stage: webpack.Compilation.PROCESS_ASSETS_STAGE_ADDITIONS,
},
(assets: any) => {
const fontLoaderManifest: FontLoaderManifest = {
pages: {},
}
for (const entrypoint of compilation.entrypoints.values()) {
const pagePath = getRouteFromEntrypoint(entrypoint.name!)
if (!pagePath) {
continue
}
const fontFiles: string[] = entrypoint.chunks
.flatMap((chunk: any) => [...chunk.auxiliaryFiles])
.filter((file: string) =>
/\.(woff|woff2|eot|ttf|otf)$/.test(file)
)
// Font files ending with .p.(woff|woff2|eot|ttf|otf) are preloaded
const preloadedFontFiles: string[] = fontFiles.filter(
(file: string) => /\.p.(woff|woff2|eot|ttf|otf)$/.test(file)
)
// Create an entry for the path even if no files should preload. If that's the case a preconnect tag is added.
if (fontFiles.length > 0) {
fontLoaderManifest.pages[pagePath] = preloadedFontFiles
}
}
const manifest = JSON.stringify(fontLoaderManifest, null, 2)
assets[`server/${FONT_LOADER_MANIFEST}.js`] = new sources.RawSource(
`self.__FONT_LOADER_MANIFEST=${manifest}`
)
assets[`server/${FONT_LOADER_MANIFEST}.json`] = new sources.RawSource(
manifest
)
}
)
})
return
}
}
...@@ -19,6 +19,7 @@ import { ...@@ -19,6 +19,7 @@ import {
NEXT_CLIENT_SSR_ENTRY_SUFFIX, NEXT_CLIENT_SSR_ENTRY_SUFFIX,
FLIGHT_SERVER_CSS_MANIFEST, FLIGHT_SERVER_CSS_MANIFEST,
SUBRESOURCE_INTEGRITY_MANIFEST, SUBRESOURCE_INTEGRITY_MANIFEST,
FONT_LOADER_MANIFEST,
} from '../../../shared/lib/constants' } from '../../../shared/lib/constants'
import { import {
getPageStaticInfo, getPageStaticInfo,
...@@ -85,7 +86,7 @@ function isUsingIndirectEvalAndUsedByExports(args: { ...@@ -85,7 +86,7 @@ function isUsingIndirectEvalAndUsedByExports(args: {
function getEntryFiles( function getEntryFiles(
entryFiles: string[], entryFiles: string[],
meta: EntryMetadata, meta: EntryMetadata,
opts: { sriEnabled: boolean } opts: { sriEnabled: boolean; hasFontLoaders: boolean }
) { ) {
const files: string[] = [] const files: string[] = []
if (meta.edgeSSR) { if (meta.edgeSSR) {
...@@ -114,6 +115,10 @@ function getEntryFiles( ...@@ -114,6 +115,10 @@ function getEntryFiles(
`server/${MIDDLEWARE_BUILD_MANIFEST}.js`, `server/${MIDDLEWARE_BUILD_MANIFEST}.js`,
`server/${MIDDLEWARE_REACT_LOADABLE_MANIFEST}.js` `server/${MIDDLEWARE_REACT_LOADABLE_MANIFEST}.js`
) )
if (opts.hasFontLoaders) {
files.push(`server/${FONT_LOADER_MANIFEST}.js`)
}
} }
files.push( files.push(
...@@ -127,7 +132,7 @@ function getEntryFiles( ...@@ -127,7 +132,7 @@ function getEntryFiles(
function getCreateAssets(params: { function getCreateAssets(params: {
compilation: webpack.Compilation compilation: webpack.Compilation
metadataByEntry: Map<string, EntryMetadata> metadataByEntry: Map<string, EntryMetadata>
opts: { sriEnabled: boolean } opts: { sriEnabled: boolean; hasFontLoaders: boolean }
}) { }) {
const { compilation, metadataByEntry, opts } = params const { compilation, metadataByEntry, opts } = params
return (assets: any) => { return (assets: any) => {
...@@ -790,10 +795,20 @@ function getExtractMetadata(params: { ...@@ -790,10 +795,20 @@ function getExtractMetadata(params: {
export default class MiddlewarePlugin { export default class MiddlewarePlugin {
private readonly dev: boolean private readonly dev: boolean
private readonly sriEnabled: boolean private readonly sriEnabled: boolean
private readonly hasFontLoaders: boolean
constructor({ dev, sriEnabled }: { dev: boolean; sriEnabled: boolean }) {
constructor({
dev,
sriEnabled,
hasFontLoaders,
}: {
dev: boolean
sriEnabled: boolean
hasFontLoaders: boolean
}) {
this.dev = dev this.dev = dev
this.sriEnabled = sriEnabled this.sriEnabled = sriEnabled
this.hasFontLoaders = hasFontLoaders
} }
public apply(compiler: webpack.Compiler) { public apply(compiler: webpack.Compiler) {
...@@ -836,7 +851,10 @@ export default class MiddlewarePlugin { ...@@ -836,7 +851,10 @@ export default class MiddlewarePlugin {
getCreateAssets({ getCreateAssets({
compilation, compilation,
metadataByEntry, metadataByEntry,
opts: { sriEnabled: this.sriEnabled }, opts: {
sriEnabled: this.sriEnabled,
hasFontLoaders: this.hasFontLoaders,
},
}) })
) )
}) })
......
...@@ -24,6 +24,7 @@ import { ...@@ -24,6 +24,7 @@ import {
EXPORT_MARKER, EXPORT_MARKER,
FLIGHT_MANIFEST, FLIGHT_MANIFEST,
FLIGHT_SERVER_CSS_MANIFEST, FLIGHT_SERVER_CSS_MANIFEST,
FONT_LOADER_MANIFEST,
PAGES_MANIFEST, PAGES_MANIFEST,
PHASE_EXPORT, PHASE_EXPORT,
PRERENDER_MANIFEST, PRERENDER_MANIFEST,
...@@ -389,6 +390,9 @@ export default async function exportApp( ...@@ -389,6 +390,9 @@ export default async function exportApp(
optimizeFonts: nextConfig.optimizeFonts as FontConfig, optimizeFonts: nextConfig.optimizeFonts as FontConfig,
largePageDataBytes: nextConfig.experimental.largePageDataBytes, largePageDataBytes: nextConfig.experimental.largePageDataBytes,
serverComponents: !!nextConfig.experimental.appDir, serverComponents: !!nextConfig.experimental.appDir,
fontLoaderManifest: nextConfig.experimental.fontLoaders
? require(join(distDir, 'server', `${FONT_LOADER_MANIFEST}.json`))
: undefined,
} }
const { serverRuntimeConfig, publicRuntimeConfig } = nextConfig const { serverRuntimeConfig, publicRuntimeConfig } = nextConfig
......
...@@ -11,6 +11,7 @@ import type { ...@@ -11,6 +11,7 @@ import type {
NEXT_DATA, NEXT_DATA,
} from '../shared/lib/utils' } from '../shared/lib/utils'
import type { ScriptProps } from '../client/script' import type { ScriptProps } from '../client/script'
import type { FontLoaderManifest } from '../build/webpack/plugins/font-loader-manifest-plugin'
import { BuildManifest, getPageFiles } from '../server/get-page-files' import { BuildManifest, getPageFiles } from '../server/get-page-files'
import { htmlEscapeJsonString } from '../server/htmlescape' import { htmlEscapeJsonString } from '../server/htmlescape'
...@@ -353,6 +354,54 @@ function getAmpPath(ampPath: string, asPath: string): string { ...@@ -353,6 +354,54 @@ function getAmpPath(ampPath: string, asPath: string): string {
return ampPath || `${asPath}${asPath.includes('?') ? '&' : '?'}amp=1` return ampPath || `${asPath}${asPath.includes('?') ? '&' : '?'}amp=1`
} }
function getFontLoaderLinks(
fontLoaderManifest: FontLoaderManifest | undefined,
dangerousAsPath: string,
assetPrefix: string = ''
) {
if (!fontLoaderManifest) {
return {
preconnect: null,
preload: null,
}
}
const appFontsEntry = fontLoaderManifest.pages['/_app']
const pageFontsEntry = fontLoaderManifest.pages[dangerousAsPath]
const preloadedFontFiles = [
...(appFontsEntry ?? []),
...(pageFontsEntry ?? []),
]
// If no font files should preload but there's an entry for the path, add a preconnect tag.
const preconnectToSelf = !!(
preloadedFontFiles.length === 0 &&
(appFontsEntry || pageFontsEntry)
)
return {
preconnect: preconnectToSelf ? (
<link rel="preconnect" href="/" crossOrigin="anonymous" />
) : null,
preload: preloadedFontFiles
? preloadedFontFiles.map((fontFile) => {
const ext = /\.(woff|woff2|eot|ttf|otf)$/.exec(fontFile)![1]
return (
<link
key={fontFile}
rel="preload"
href={`${assetPrefix}/_next/${encodeURI(fontFile)}`}
as="font"
type={`font/${ext}`}
crossOrigin="anonymous"
/>
)
})
: null,
}
}
// Use `React.Component` to avoid errors from the RSC checks because // Use `React.Component` to avoid errors from the RSC checks because
// it can't be imported directly in Server Components: // it can't be imported directly in Server Components:
// //
...@@ -608,6 +657,8 @@ export class Head extends React.Component<HeadProps> { ...@@ -608,6 +657,8 @@ export class Head extends React.Component<HeadProps> {
disableOptimizedLoading, disableOptimizedLoading,
optimizeCss, optimizeCss,
optimizeFonts, optimizeFonts,
assetPrefix,
fontLoaderManifest,
} = this.context } = this.context
const disableRuntimeJS = unstable_runtimeJS === false const disableRuntimeJS = unstable_runtimeJS === false
...@@ -722,6 +773,12 @@ export class Head extends React.Component<HeadProps> { ...@@ -722,6 +773,12 @@ export class Head extends React.Component<HeadProps> {
process.env.NEXT_RUNTIME !== 'edge' && inAmpMode process.env.NEXT_RUNTIME !== 'edge' && inAmpMode
) )
const fontLoaderLinks = getFontLoaderLinks(
fontLoaderManifest,
dangerousAsPath,
assetPrefix
)
return ( return (
<head {...getHeadHTMLProps(this.props)}> <head {...getHeadHTMLProps(this.props)}>
{this.context.isDevelopment && ( {this.context.isDevelopment && (
...@@ -762,6 +819,9 @@ export class Head extends React.Component<HeadProps> { ...@@ -762,6 +819,9 @@ export class Head extends React.Component<HeadProps> {
{children} {children}
{optimizeFonts && <meta name="next-font-preconnect" />} {optimizeFonts && <meta name="next-font-preconnect" />}
{fontLoaderLinks.preconnect}
{fontLoaderLinks.preload}
{process.env.NEXT_RUNTIME !== 'edge' && inAmpMode && ( {process.env.NEXT_RUNTIME !== 'edge' && inAmpMode && (
<> <>
<meta <meta
......
...@@ -28,6 +28,7 @@ import type { PagesManifest } from '../build/webpack/plugins/pages-manifest-plug ...@@ -28,6 +28,7 @@ import type { PagesManifest } from '../build/webpack/plugins/pages-manifest-plug
import type { BaseNextRequest, BaseNextResponse } from './base-http' import type { BaseNextRequest, BaseNextResponse } from './base-http'
import type { PayloadOptions } from './send-payload' import type { PayloadOptions } from './send-payload'
import type { PrerenderManifest } from '../build' import type { PrerenderManifest } from '../build'
import type { FontLoaderManifest } from '../build/webpack/plugins/font-loader-manifest-plugin'
import { parse as parseQs } from 'querystring' import { parse as parseQs } from 'querystring'
import { format as formatUrl, parse as parseUrl } from 'url' import { format as formatUrl, parse as parseUrl } from 'url'
...@@ -218,6 +219,7 @@ export default abstract class Server<ServerOptions extends Options = Options> { ...@@ -218,6 +219,7 @@ export default abstract class Server<ServerOptions extends Options = Options> {
supportsDynamicHTML?: boolean supportsDynamicHTML?: boolean
serverComponentManifest?: any serverComponentManifest?: any
serverCSSManifest?: any serverCSSManifest?: any
fontLoaderManifest?: FontLoaderManifest
renderServerComponentData?: boolean renderServerComponentData?: boolean
serverComponentProps?: any serverComponentProps?: any
largePageDataBytes?: number largePageDataBytes?: number
...@@ -230,6 +232,7 @@ export default abstract class Server<ServerOptions extends Options = Options> { ...@@ -230,6 +232,7 @@ export default abstract class Server<ServerOptions extends Options = Options> {
protected customRoutes: CustomRoutes protected customRoutes: CustomRoutes
protected serverComponentManifest?: any protected serverComponentManifest?: any
protected serverCSSManifest?: any protected serverCSSManifest?: any
protected fontLoaderManifest?: FontLoaderManifest
public readonly hostname?: string public readonly hostname?: string
public readonly port?: number public readonly port?: number
...@@ -252,6 +255,7 @@ export default abstract class Server<ServerOptions extends Options = Options> { ...@@ -252,6 +255,7 @@ export default abstract class Server<ServerOptions extends Options = Options> {
protected abstract getPrerenderManifest(): PrerenderManifest protected abstract getPrerenderManifest(): PrerenderManifest
protected abstract getServerComponentManifest(): any protected abstract getServerComponentManifest(): any
protected abstract getServerCSSManifest(): any protected abstract getServerCSSManifest(): any
protected abstract getFontLoaderManifest(): FontLoaderManifest | undefined
protected abstract attachRequestMeta( protected abstract attachRequestMeta(
req: BaseNextRequest, req: BaseNextRequest,
parsedUrl: NextUrlWithParsedQuery parsedUrl: NextUrlWithParsedQuery
...@@ -370,6 +374,9 @@ export default abstract class Server<ServerOptions extends Options = Options> { ...@@ -370,6 +374,9 @@ export default abstract class Server<ServerOptions extends Options = Options> {
this.serverCSSManifest = serverComponents this.serverCSSManifest = serverComponents
? this.getServerCSSManifest() ? this.getServerCSSManifest()
: undefined : undefined
this.fontLoaderManifest = this.nextConfig.experimental.fontLoaders
? this.getFontLoaderManifest()
: undefined
this.renderOpts = { this.renderOpts = {
poweredByHeader: this.nextConfig.poweredByHeader, poweredByHeader: this.nextConfig.poweredByHeader,
......
...@@ -387,6 +387,9 @@ const configSchema = { ...@@ -387,6 +387,9 @@ const configSchema = {
workerThreads: { workerThreads: {
type: 'boolean', type: 'boolean',
}, },
fontLoaders: {
type: 'object',
},
}, },
type: 'object', type: 'object',
}, },
......
...@@ -150,6 +150,7 @@ export interface ExperimentalConfig { ...@@ -150,6 +150,7 @@ export interface ExperimentalConfig {
algorithm?: SubresourceIntegrityAlgorithm algorithm?: SubresourceIntegrityAlgorithm
} }
adjustFontFallbacks?: boolean adjustFontFallbacks?: boolean
fontLoaders?: { [fontLoader: string]: any }
} }
export type ExportPathMap = { export type ExportPathMap = {
......
...@@ -1126,6 +1126,10 @@ export default class DevServer extends Server { ...@@ -1126,6 +1126,10 @@ export default class DevServer extends Server {
return undefined return undefined
} }
protected getFontLoaderManifest() {
return undefined
}
protected async hasMiddleware(): Promise<boolean> { protected async hasMiddleware(): Promise<boolean> {
return this.hasPage(this.actualMiddlewareFile!) return this.hasPage(this.actualMiddlewareFile!)
} }
...@@ -1353,6 +1357,7 @@ export default class DevServer extends Server { ...@@ -1353,6 +1357,7 @@ export default class DevServer extends Server {
this.serverComponentManifest = super.getServerComponentManifest() this.serverComponentManifest = super.getServerComponentManifest()
this.serverCSSManifest = super.getServerCSSManifest() this.serverCSSManifest = super.getServerCSSManifest()
} }
this.fontLoaderManifest = super.getFontLoaderManifest()
return super.findPageComponents({ pathname, query, params, isAppPath }) return super.findPageComponents({ pathname, query, params, isAppPath })
} catch (err) { } catch (err) {
......
...@@ -45,6 +45,7 @@ import { ...@@ -45,6 +45,7 @@ import {
FLIGHT_SERVER_CSS_MANIFEST, FLIGHT_SERVER_CSS_MANIFEST,
SERVERLESS_DIRECTORY, SERVERLESS_DIRECTORY,
SERVER_DIRECTORY, SERVER_DIRECTORY,
FONT_LOADER_MANIFEST,
} from '../shared/lib/constants' } from '../shared/lib/constants'
import { recursiveReadDirSync } from './lib/recursive-readdir-sync' import { recursiveReadDirSync } from './lib/recursive-readdir-sync'
import { format as formatUrl, UrlWithParsedQuery } from 'url' import { format as formatUrl, UrlWithParsedQuery } from 'url'
...@@ -524,7 +525,8 @@ export default class NextNodeServer extends BaseServer { ...@@ -524,7 +525,8 @@ export default class NextNodeServer extends BaseServer {
params.path[0] === 'media' || params.path[0] === 'media' ||
params.path[0] === this.buildId || params.path[0] === this.buildId ||
params.path[0] === 'pages' || params.path[0] === 'pages' ||
params.path[1] === 'pages' params.path[1] === 'pages' ||
params.path[0] === 'fonts'
) { ) {
this.setImmutableAssetCacheControl(res) this.setImmutableAssetCacheControl(res)
} }
...@@ -822,6 +824,7 @@ export default class NextNodeServer extends BaseServer { ...@@ -822,6 +824,7 @@ export default class NextNodeServer extends BaseServer {
// https://github.com/vercel/next.js/blob/df7cbd904c3bd85f399d1ce90680c0ecf92d2752/packages/next/server/render.tsx#L947-L952 // https://github.com/vercel/next.js/blob/df7cbd904c3bd85f399d1ce90680c0ecf92d2752/packages/next/server/render.tsx#L947-L952
renderOpts.serverComponentManifest = this.serverComponentManifest renderOpts.serverComponentManifest = this.serverComponentManifest
renderOpts.serverCSSManifest = this.serverCSSManifest renderOpts.serverCSSManifest = this.serverCSSManifest
renderOpts.fontLoaderManifest = this.fontLoaderManifest
if ( if (
this.nextConfig.experimental.appDir && this.nextConfig.experimental.appDir &&
...@@ -1016,6 +1019,11 @@ export default class NextNodeServer extends BaseServer { ...@@ -1016,6 +1019,11 @@ export default class NextNodeServer extends BaseServer {
)) ))
} }
protected getFontLoaderManifest() {
if (!this.nextConfig.experimental.fontLoaders) return undefined
return require(join(this.distDir, 'server', `${FONT_LOADER_MANIFEST}.json`))
}
protected getFallback(page: string): Promise<string> { protected getFallback(page: string): Promise<string> {
page = normalizePagePath(page) page = normalizePagePath(page)
const cacheFs = this.getCacheFilesystem() const cacheFs = this.getCacheFilesystem()
......
...@@ -26,6 +26,7 @@ import type { ...@@ -26,6 +26,7 @@ import type {
} from 'next/types' } from 'next/types'
import type { UnwrapPromise } from '../lib/coalesced-function' import type { UnwrapPromise } from '../lib/coalesced-function'
import type { ReactReadableStream } from './node-web-streams-helper' import type { ReactReadableStream } from './node-web-streams-helper'
import type { FontLoaderManifest } from '../build/webpack/plugins/font-loader-manifest-plugin'
import React from 'react' import React from 'react'
import { StyleRegistry, createStyleRegistry } from 'styled-jsx' import { StyleRegistry, createStyleRegistry } from 'styled-jsx'
...@@ -232,6 +233,7 @@ export type RenderOptsPartial = { ...@@ -232,6 +233,7 @@ export type RenderOptsPartial = {
resolvedAsPath?: string resolvedAsPath?: string
serverComponentManifest?: any serverComponentManifest?: any
serverCSSManifest?: any serverCSSManifest?: any
fontLoaderManifest?: FontLoaderManifest
distDir?: string distDir?: string
locale?: string locale?: string
locales?: string[] locales?: string[]
...@@ -1446,6 +1448,7 @@ export async function renderToHTML( ...@@ -1446,6 +1448,7 @@ export async function renderToHTML(
nextScriptWorkers: renderOpts.nextScriptWorkers, nextScriptWorkers: renderOpts.nextScriptWorkers,
runtime: globalRuntime, runtime: globalRuntime,
largePageDataBytes: renderOpts.largePageDataBytes, largePageDataBytes: renderOpts.largePageDataBytes,
fontLoaderManifest: renderOpts.fontLoaderManifest,
} }
const document = ( const document = (
......
...@@ -131,6 +131,11 @@ export default class NextWebServer extends BaseServer<WebServerOptions> { ...@@ -131,6 +131,11 @@ export default class NextWebServer extends BaseServer<WebServerOptions> {
return this.serverOptions.webServerConfig.extendRenderOpts.serverCSSManifest return this.serverOptions.webServerConfig.extendRenderOpts.serverCSSManifest
} }
protected getFontLoaderManifest() {
return this.serverOptions.webServerConfig.extendRenderOpts
.fontLoaderManifest
}
protected generateRoutes(): { protected generateRoutes(): {
headers: Route[] headers: Route[]
rewrites: { rewrites: {
......
...@@ -27,6 +27,7 @@ export const APP_PATH_ROUTES_MANIFEST = 'app-path-routes-manifest.json' ...@@ -27,6 +27,7 @@ export const APP_PATH_ROUTES_MANIFEST = 'app-path-routes-manifest.json'
export const BUILD_MANIFEST = 'build-manifest.json' export const BUILD_MANIFEST = 'build-manifest.json'
export const APP_BUILD_MANIFEST = 'app-build-manifest.json' export const APP_BUILD_MANIFEST = 'app-build-manifest.json'
export const SUBRESOURCE_INTEGRITY_MANIFEST = 'subresource-integrity-manifest' export const SUBRESOURCE_INTEGRITY_MANIFEST = 'subresource-integrity-manifest'
export const FONT_LOADER_MANIFEST = 'font-loader-manifest'
export const EXPORT_MARKER = 'export-marker.json' export const EXPORT_MARKER = 'export-marker.json'
export const EXPORT_DETAIL = 'export-detail.json' export const EXPORT_DETAIL = 'export-detail.json'
export const PRERENDER_MANIFEST = 'prerender-manifest.json' export const PRERENDER_MANIFEST = 'prerender-manifest.json'
......
...@@ -2,6 +2,7 @@ import type { BuildManifest } from '../../server/get-page-files' ...@@ -2,6 +2,7 @@ import type { BuildManifest } from '../../server/get-page-files'
import type { ServerRuntime } from 'next/types' import type { ServerRuntime } from 'next/types'
import type { NEXT_DATA } from './utils' import type { NEXT_DATA } from './utils'
import type { FontConfig } from '../../server/font-utils' import type { FontConfig } from '../../server/font-utils'
import type { FontLoaderManifest } from '../../build/webpack/plugins/font-loader-manifest-plugin'
import { createContext } from 'react' import { createContext } from 'react'
...@@ -42,6 +43,7 @@ export type HtmlProps = { ...@@ -42,6 +43,7 @@ export type HtmlProps = {
runtime?: ServerRuntime runtime?: ServerRuntime
hasConcurrentFeatures?: boolean hasConcurrentFeatures?: boolean
largePageDataBytes?: number largePageDataBytes?: number
fontLoaderManifest?: FontLoaderManifest
} }
export const HtmlContext = createContext<HtmlProps>(null as any) export const HtmlContext = createContext<HtmlProps>(null as any)
......
import { createNext, FileRef } from 'e2e-utils'
import { NextInstance } from 'test/lib/next-modes/base'
import { check, getRedboxSource } from 'next-test-utils'
import webdriver from 'next-webdriver'
import { join } from 'path'
describe('font-loader-in-document-error', () => {
let next: NextInstance
beforeAll(async () => {
next = await createNext({
files: {
pages: new FileRef(join(__dirname, 'font-loader-in-document/pages')),
'next.config.js': new FileRef(
join(__dirname, 'font-loader-in-document/next.config.js')
),
},
dependencies: {
'@next/font': 'canary',
},
})
})
afterAll(() => next.destroy())
test('font loader inside _document', async () => {
const browser = await webdriver(next.appPort, '/')
await check(() => getRedboxSource(browser), /Font loaders/)
expect(await getRedboxSource(browser)).toInclude(
'Font loaders cannot be used within pages/_document.js'
)
})
})
module.exports = {
experimental: {
fontLoaders: {
'@next/font/google': {
subsets: ['latin'],
},
},
},
}
import { Html, Head, Main, NextScript } from 'next/document'
import { Abel } from '@next/font/google'
// eslint-disable-next-line no-unused-vars
const abel = Abel({ variant: '400' })
export default function Document() {
return (
<Html>
<Head />
<body>
<Main />
<NextScript />
</body>
</Html>
)
}
export default function Index() {
return <p>Hello world</p>
}
import { Inter, Roboto } from '@next/font/google'
const inter = Inter({ variant: '900', display: 'swap', preload: false })
const roboto = Roboto({
variant: '100-italic',
display: 'swap',
preload: true,
})
export default function Component() {
return (
<>
<div id="comp-with-fonts-inter" className={inter.className}>
{JSON.stringify(inter)}
</div>
<div id="comp-with-fonts-roboto" style={roboto.style}>
{JSON.stringify(roboto)}
</div>
</>
)
}
module.exports = {
experimental: {
fontLoaders: {
'@next/font/google': {
subsets: ['latin'],
},
},
},
}
import { Open_Sans } from '@next/font/google'
const openSans = Open_Sans()
function MyApp({ Component, pageProps }) {
return (
<>
<div id="app-open-sans" className={openSans.className}>
{JSON.stringify(openSans)}
</div>
<Component {...pageProps} />
</>
)
}
export { openSans }
export default MyApp
import { Fira_Code, Albert_Sans, Inter, Roboto } from '@next/font/google'
const firaCode = Fira_Code()
const albertSans = Albert_Sans({
variant: 'variable-italic',
adjustFontFallback: false,
})
const inter = Inter({ variant: '900', display: 'swap' }) // Don't preload by default when swap
const roboto = Roboto({
variant: '100-italic',
display: 'swap',
preload: true,
})
export default function WithFonts() {
return (
<>
{/* Fira Code Variable */}
<div
id="variables-fira-code"
className={firaCode.variable}
style={{ fontFamily: 'var(--next-font-fira-code)' }}
>
With variables
</div>
<div
id="without-variables-fira-code"
style={{ fontFamily: 'var(--next-font-fira-code)' }}
>
Without variables
</div>
{/* Albert Sant Variable Italic */}
<div
id="variables-albert-sans-italic"
className={albertSans.variable}
style={{ fontFamily: 'var(--next-font-albert-sans-italic)' }}
>
With variables
</div>
<div
id="without-variables-albert-sans-italic"
style={{ fontFamily: 'var(--next-font-albert-sans-italic)' }}
>
Without variables
</div>
{/* Inter 900 */}
<div
id="variables-inter-900"
className={inter.variable}
style={{ fontFamily: 'var(--next-font-inter-900)' }}
>
With variables
</div>
<div
id="without-variables-inter-900"
style={{ fontFamily: 'var(--next-font-inter-900)' }}
>
Without variables
</div>
{/* Roboto 100 Italic */}
<div
id="variables-roboto-100-italic"
className={roboto.variable}
style={{ fontFamily: 'var(--next-font-roboto-100-italic)' }}
>
With variables
</div>
<div
id="without-variables-roboto-100-italic"
style={{ fontFamily: 'var(--next-font-roboto-100-italic)' }}
>
Without variables
</div>
</>
)
}
import { Open_Sans } from '@next/font/google'
const openSans = Open_Sans({ fallback: ['system-ui', 'Arial'] })
export default function WithFonts() {
return (
<>
<div id="with-fallback-fonts-classname" className={openSans.className}>
{JSON.stringify(openSans)}
</div>
<div id="with-fallback-fonts-style" style={openSans.style}>
{JSON.stringify(openSans)}
</div>
<div
id="with-fallback-fonts-variable"
style={{ fontFamily: 'var(--next-font-open-sans)' }}
className={openSans.variable}
>
{JSON.stringify(openSans)}
</div>
</>
)
}
import CompWithFonts from '../components/CompWithFonts'
import { openSans } from './_app'
export default function WithFonts() {
return (
<>
<CompWithFonts />
<div id="with-fonts-open-sans" className={openSans.className}>
{JSON.stringify(openSans)}
</div>
<div id="with-fonts-open-sans-style" style={openSans.style} />
</>
)
}
export default function WithoutFonts() {
return <p id="hello-world">Hello world</p>
}
import cheerio from 'cheerio'
import { createNext, FileRef } from 'e2e-utils'
import { NextInstance } from 'test/lib/next-modes/base'
import { renderViaHTTP } from 'next-test-utils'
import { join } from 'path'
const mockedGoogleFontResponses = require.resolve(
'./google-font-mocked-responses.js'
)
describe('@next/font/google basepath', () => {
let next: NextInstance
if ((global as any).isNextDeploy) {
it('should skip next deploy for now', () => {})
return
}
beforeAll(async () => {
next = await createNext({
files: {
pages: new FileRef(join(__dirname, 'basepath/pages')),
'next.config.js': new FileRef(
join(__dirname, 'basepath/next.config.js')
),
},
dependencies: {
'@next/font': 'canary',
},
env: {
NEXT_FONT_GOOGLE_MOCKED_RESPONSES: mockedGoogleFontResponses,
},
})
})
afterAll(() => next.destroy())
test('preload correct files', async () => {
const html = await renderViaHTTP(next.url, '/dashboard')
const $ = cheerio.load(html)
// Preconnect
expect($('link[rel="preconnect"]').length).toBe(0)
// Preload
expect($('link[as="font"]').length).toBe(1)
expect($('link[as="font"]').get(0).attribs).toEqual({
as: 'font',
crossorigin: 'anonymous',
href: '/dashboard/_next/static/fonts/0812efcfaefec5ea.p.woff2',
rel: 'preload',
type: 'font/woff2',
})
})
})
module.exports = {
basePath: '/dashboard',
experimental: {
fontLoaders: {
'@next/font/google': {
subsets: ['latin'],
},
},
},
}
import { Open_Sans } from '@next/font/google'
const openSans = Open_Sans()
export default function Inter() {
return <p className={openSans.className}>Hello world</p>
}
This diff is collapsed.
import cheerio from 'cheerio'
import { createNext, FileRef } from 'e2e-utils'
import { NextInstance } from 'test/lib/next-modes/base'
import { renderViaHTTP } from 'next-test-utils'
import { join } from 'path'
import webdriver from 'next-webdriver'
const mockedGoogleFontResponses = require.resolve(
'./google-font-mocked-responses.js'
)
describe('@next/font/google', () => {
let next: NextInstance
if ((global as any).isNextDeploy) {
it('should skip next deploy for now', () => {})
return
}
beforeAll(async () => {
next = await createNext({
files: {
pages: new FileRef(join(__dirname, 'app/pages')),
components: new FileRef(join(__dirname, 'app/components')),
'next.config.js': new FileRef(join(__dirname, 'app/next.config.js')),
},
dependencies: {
'@next/font': 'canary',
},
env: {
NEXT_FONT_GOOGLE_MOCKED_RESPONSES: mockedGoogleFontResponses,
},
})
})
afterAll(() => next.destroy())
describe('import values', () => {
test('page with font', async () => {
const html = await renderViaHTTP(next.url, '/with-fonts')
const $ = cheerio.load(html)
// _app.js
expect(JSON.parse($('#app-open-sans').text())).toEqual({
className: '__className_bbc724',
variable: '__variable_bbc724',
style: {
fontFamily: "'__Open_Sans_bbc724', '__open-sans-fallback_bbc724'",
fontStyle: 'normal',
},
})
// with-fonts.js
expect(JSON.parse($('#with-fonts-open-sans').text())).toEqual({
className: '__className_bbc724',
variable: '__variable_bbc724',
style: {
fontFamily: "'__Open_Sans_bbc724', '__open-sans-fallback_bbc724'",
fontStyle: 'normal',
},
})
// CompWithFonts.js
expect(JSON.parse($('#comp-with-fonts-inter').text())).toEqual({
className: '__className_17e98a',
variable: '__variable_17e98a',
style: {
fontFamily: "'__Inter_17e98a', '__inter-fallback_17e98a'",
fontStyle: 'normal',
fontWeight: 900,
},
})
expect(JSON.parse($('#comp-with-fonts-roboto').text())).toEqual({
className: '__className_72084b',
variable: '__variable_72084b',
style: {
fontFamily: "'__Roboto_72084b', '__roboto-fallback_72084b'",
fontStyle: 'italic',
fontWeight: 100,
},
})
})
})
describe('computed styles', () => {
test('page with fonts', async () => {
const browser = await webdriver(next.url, '/with-fonts')
// _app.js
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#app-open-sans")).fontFamily'
)
).toBe('__Open_Sans_bbc724, __open-sans-fallback_bbc724')
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#app-open-sans")).fontWeight'
)
).toBe('400')
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#app-open-sans")).fontStyle'
)
).toBe('normal')
// with-fonts.js
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#with-fonts-open-sans")).fontFamily'
)
).toBe('__Open_Sans_bbc724, __open-sans-fallback_bbc724')
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#with-fonts-open-sans")).fontWeight'
)
).toBe('400')
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#with-fonts-open-sans")).fontStyle'
)
).toBe('normal')
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#with-fonts-open-sans-style")).fontWeight'
)
).toBe('400')
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#with-fonts-open-sans-style")).fontStyle'
)
).toBe('normal')
// CompWithFonts.js
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#comp-with-fonts-inter")).fontFamily'
)
).toBe('__Inter_17e98a, __inter-fallback_17e98a')
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#comp-with-fonts-inter")).fontWeight'
)
).toBe('900')
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#comp-with-fonts-inter")).fontStyle'
)
).toBe('normal')
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#comp-with-fonts-roboto")).fontFamily'
)
).toBe('__Roboto_72084b, __roboto-fallback_72084b')
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#comp-with-fonts-roboto")).fontWeight'
)
).toBe('100')
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#comp-with-fonts-roboto")).fontStyle'
)
).toBe('italic')
})
test('page using variables', async () => {
const browser = await webdriver(next.url, '/variables')
// Fira Code Variable
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#variables-fira-code")).fontFamily'
)
).toBe('__Fira_Code_a1dc08, __fira-code-fallback_a1dc08')
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#without-variables-fira-code")).fontFamily'
)
).not.toBe('__Fira_Code_a1dc08, __fira-code-fallback_a1dc08')
// Albert Sant Variable Italic
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#variables-albert-sans-italic")).fontFamily'
)
).toBe('__Albert_Sans_2b85d2')
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#without-variables-albert-sans-italic")).fontFamily'
)
).not.toBe('__Albert_Sans_2b85d2')
// Inter 900
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#variables-inter-900")).fontFamily'
)
).toBe('__Inter_ea3712, __inter-fallback_ea3712')
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#without-variables-inter-900")).fontFamily'
)
).not.toBe('__Inter_ea3712, __inter-fallback_ea3712')
// Roboto 100 Italic
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#variables-roboto-100-italic")).fontFamily'
)
).toBe('__Roboto_72084b, __roboto-fallback_72084b')
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#without-variables-roboto-100-italic")).fontFamily'
)
).not.toBe('__Roboto_72084b')
})
test('page using fallback fonts', async () => {
const browser = await webdriver(next.url, '/with-fallback')
// .className
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#with-fallback-fonts-classname")).fontFamily'
)
).toBe(
'__Open_Sans_bbc724, system-ui, Arial, __open-sans-fallback_bbc724'
)
// .style
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#with-fallback-fonts-style")).fontFamily'
)
).toBe(
'__Open_Sans_bbc724, system-ui, Arial, __open-sans-fallback_bbc724'
)
// .variable
expect(
await browser.eval(
'getComputedStyle(document.querySelector("#with-fallback-fonts-variable")).fontFamily'
)
).toBe(
'__Open_Sans_bbc724, system-ui, Arial, __open-sans-fallback_bbc724'
)
})
})
describe('preload', () => {
test('page with fonts', async () => {
const html = await renderViaHTTP(next.url, '/with-fonts')
const $ = cheerio.load(html)
// Preconnect
expect($('link[rel="preconnect"]').length).toBe(0)
expect($('link[as="font"]').length).toBe(2)
// From /_app
expect($('link[as="font"]').get(0).attribs).toEqual({
as: 'font',
crossorigin: 'anonymous',
href: '/_next/static/fonts/0812efcfaefec5ea.p.woff2',
rel: 'preload',
type: 'font/woff2',
})
expect($('link[as="font"]').get(1).attribs).toEqual({
as: 'font',
crossorigin: 'anonymous',
href: '/_next/static/fonts/4f3dcdf40b3ca86d.p.woff2',
rel: 'preload',
type: 'font/woff2',
})
})
test('page without fonts', async () => {
const html = await renderViaHTTP(next.url, '/without-fonts')
const $ = cheerio.load(html)
// Preconnect
expect($('link[rel="preconnect"]').length).toBe(0)
// From _app
expect($('link[as="font"]').length).toBe(1)
expect($('link[as="font"]').get(0).attribs).toEqual({
as: 'font',
crossorigin: 'anonymous',
href: '/_next/static/fonts/0812efcfaefec5ea.p.woff2',
rel: 'preload',
type: 'font/woff2',
})
})
})
})
import cheerio from 'cheerio'
import { createNext, FileRef } from 'e2e-utils'
import { NextInstance } from 'test/lib/next-modes/base'
import { renderViaHTTP } from 'next-test-utils'
import { join } from 'path'
const mockedGoogleFontResponses = require.resolve(
'./google-font-mocked-responses.js'
)
const isDev = (global as any).isNextDev
describe('@next/font/google with-font-declarations-file', () => {
let next: NextInstance
if ((global as any).isNextDeploy) {
it('should skip next deploy for now', () => {})
return
}
beforeAll(async () => {
next = await createNext({
files: {
pages: new FileRef(
join(__dirname, 'with-font-declarations-file/pages')
),
components: new FileRef(
join(__dirname, 'with-font-declarations-file/components')
),
'fonts.js': new FileRef(
join(__dirname, 'with-font-declarations-file/fonts.js')
),
'next.config.js': new FileRef(
join(__dirname, 'with-font-declarations-file/next.config.js')
),
},
dependencies: {
'@next/font': 'canary',
},
env: {
NEXT_FONT_GOOGLE_MOCKED_RESPONSES: mockedGoogleFontResponses,
},
})
})
afterAll(() => next.destroy())
test('preload correct files at /inter', async () => {
const html = await renderViaHTTP(next.url, '/inter')
const $ = cheerio.load(html)
// Preconnect
expect($('link[rel="preconnect"]').length).toBe(0)
if (isDev) {
// In dev all fonts will be preloaded since it's before DCE
expect($('link[as="font"]').length).toBe(3)
} else {
// Preload
expect($('link[as="font"]').length).toBe(2)
// From /_app
expect($('link[as="font"]').get(0).attribs).toEqual({
as: 'font',
crossorigin: 'anonymous',
href: '/_next/static/fonts/0812efcfaefec5ea.p.woff2',
rel: 'preload',
type: 'font/woff2',
})
// From /inter
expect($('link[as="font"]').get(1).attribs).toEqual({
as: 'font',
crossorigin: 'anonymous',
href: '/_next/static/fonts/4a7f86e553ee7e51.p.woff2',
rel: 'preload',
type: 'font/woff2',
})
}
})
test('preload correct files at /roboto', async () => {
const html = await renderViaHTTP(next.url, '/roboto')
const $ = cheerio.load(html)
// Preconnect
expect($('link[rel="preconnect"]').length).toBe(0)
if (isDev) {
// In dev all fonts will be preloaded since it's before DCE
expect($('link[as="font"]').length).toBe(3)
} else {
// Preload
expect($('link[as="font"]').length).toBe(2)
// From /_app
expect($('link[as="font"]').get(0).attribs).toEqual({
as: 'font',
crossorigin: 'anonymous',
href: '/_next/static/fonts/0812efcfaefec5ea.p.woff2',
rel: 'preload',
type: 'font/woff2',
})
// From /roboto
expect($('link[as="font"]').get(1).attribs).toEqual({
as: 'font',
crossorigin: 'anonymous',
href: '/_next/static/fonts/9a7e84b4dd095b33.p.woff2',
rel: 'preload',
type: 'font/woff2',
})
}
})
})
import Link from 'next/link'
import { roboto } from '../fonts'
export default function Roboto() {
return (
<Link href="/inter">
<a className={roboto.className}>To inter</a>
</Link>
)
}
import {
Open_Sans,
Source_Code_Pro,
Abel,
Inter,
Roboto,
} from '@next/font/google'
const openSans = Open_Sans()
const sourceCodePro = Source_Code_Pro({ display: 'swap', preload: false })
const abel = Abel({ variant: '400', display: 'optional', preload: false })
const inter = Inter({ display: 'block', preload: true })
const roboto = Roboto({ variant: '400' })
export { openSans, sourceCodePro, abel, inter, roboto }
module.exports = {
experimental: {
fontLoaders: {
'@next/font/google': {
subsets: ['latin'],
},
},
},
}
import { openSans, sourceCodePro, abel } from '../fonts'
function MyApp({ Component, pageProps }) {
return (
<div className={openSans.variable}>
<div className={sourceCodePro.variable}>
<div style={abel.style}>
<Component {...pageProps} />
</div>
</div>
</div>
)
}
export default MyApp
import Link from 'next/link'
import { inter } from '../fonts'
export default function Inter() {
return (
<Link href="/roboto">
<a className={inter.className}>To roboto</a>
</Link>
)
}
import RobotoComp from '../components/roboto-comp'
export default function Roboto() {
return <RobotoComp />
}
import cheerio from 'cheerio'
import { createNext, FileRef } from 'e2e-utils'
import { NextInstance } from 'test/lib/next-modes/base'
import { renderViaHTTP } from 'next-test-utils'
import { join } from 'path'
const mockedGoogleFontResponses = require.resolve(
'./google-font-mocked-responses.js'
)
describe('@next/font/google without-preloaded-fonts without _app', () => {
let next: NextInstance
if ((global as any).isNextDeploy) {
it('should skip next deploy for now', () => {})
return
}
beforeAll(async () => {
next = await createNext({
files: {
'pages/no-preload.js': new FileRef(
join(__dirname, 'without-preloaded-fonts/pages/no-preload.js')
),
'pages/without-fonts.js': new FileRef(
join(__dirname, 'without-preloaded-fonts/pages/without-fonts.js')
),
'next.config.js': new FileRef(
join(__dirname, 'without-preloaded-fonts/next.config.js')
),
},
dependencies: {
'@next/font': 'canary',
},
env: {
NEXT_FONT_GOOGLE_MOCKED_RESPONSES: mockedGoogleFontResponses,
},
})
})
afterAll(() => next.destroy())
test('without preload', async () => {
const html = await renderViaHTTP(next.url, '/no-preload')
const $ = cheerio.load(html)
// Preconnect
expect($('link[rel="preconnect"]').length).toBe(1)
expect($('link[rel="preconnect"]').get(0).attribs).toEqual({
crossorigin: 'anonymous',
href: '/',
rel: 'preconnect',
})
// Preload
expect($('link[as="font"]').length).toBe(0)
})
test('without fonts', async () => {
const html = await renderViaHTTP(next.url, '/without-fonts')
const $ = cheerio.load(html)
expect($('link[rel="preconnect"]').length).toBe(0)
expect($('link[as="font"]').length).toBe(0)
})
})
describe('@next/font/google no preloads with _app', () => {
let next: NextInstance
if ((global as any).isNextDeploy) {
it('should skip next deploy for now', () => {})
return
}
beforeAll(async () => {
next = await createNext({
files: {
'pages/_app.js': new FileRef(
join(__dirname, 'without-preloaded-fonts/pages/_app.js')
),
'pages/no-preload.js': new FileRef(
join(__dirname, 'without-preloaded-fonts/pages/no-preload.js')
),
'pages/without-fonts.js': new FileRef(
join(__dirname, 'without-preloaded-fonts/pages/without-fonts.js')
),
'next.config.js': new FileRef(
join(__dirname, 'without-preloaded-fonts/next.config.js')
),
},
dependencies: {
'@next/font': 'canary',
},
env: {
NEXT_FONT_GOOGLE_MOCKED_RESPONSES: mockedGoogleFontResponses,
},
})
})
afterAll(() => next.destroy())
test('without preload', async () => {
const html = await renderViaHTTP(next.url, '/no-preload')
const $ = cheerio.load(html)
// Preconnect
expect($('link[rel="preconnect"]').length).toBe(1)
expect($('link[rel="preconnect"]').get(0).attribs).toEqual({
crossorigin: 'anonymous',
href: '/',
rel: 'preconnect',
})
// Preload
expect($('link[as="font"]').length).toBe(0)
})
test('without fonts', async () => {
const html = await renderViaHTTP(next.url, '/without-fonts')
const $ = cheerio.load(html)
// Preconnect
expect($('link[rel="preconnect"]').length).toBe(1)
expect($('link[rel="preconnect"]').get(0).attribs).toEqual({
crossorigin: 'anonymous',
href: '/',
rel: 'preconnect',
})
// Preload
expect($('link[as="font"]').length).toBe(0)
})
})
module.exports = {
experimental: {
fontLoaders: {
'@next/font/google': {
subsets: ['latin'],
},
},
},
}
import { Abel } from '@next/font/google'
const abel = Abel({ variant: '400', display: 'optional', preload: false })
function MyApp({ Component, pageProps }) {
return (
<div className={abel.className}>
<Component {...pageProps} />
</div>
)
}
export default MyApp
import { Abel } from '@next/font/google'
const abel = Abel({ variant: '400', display: 'optional', preload: false })
export default function NoPreload() {
return <p className={abel.className}>Hello world</p>
}
export default function WithoutFonts() {
return <p>Hello world</p>
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment