Unverified Commit 7fba48ef authored by Janicklas Ralph's avatar Janicklas Ralph Committed by GitHub

Adding experimentalAdjustFallback feature to font optimization (#40185)

<!--


## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`

## Feature

- [x] Implements an existing feature request or RFC. Make sure the
feature request has been accepted for implementation before opening a
PR.
- [ ] Related issues linked using `fixes #number`
- [x] Integration tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have helpful link attached, see `contributing.md`

## Documentation / Examples

- [x] Make sure the linting passes by running `pnpm lint`
- [ ] The examples guidelines are followed from [our contributing
doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)
- [ ] -->
## Feature

- [x] Implements https://github.com/vercel/next.js/discussions/40112
- [x] Integration tests added

Adds a new option to the current font optimization to enable
experimental font size adjust

The new `optimizeFonts` config will be 
```
optimizeFonts: {
    inlineFonts: true,
    experimentalAdjustFallbacks: false,
  },
```

To enable the feature, set `experimentalAdjustFallbacks: true`

`optimizeFonts: false` will disable the entire feature (including
inlining google font definition)
Co-authored-by: 's avatarJJ Kasper <jj@jjsweb.site>
parent 8bf082a9
......@@ -177,7 +177,7 @@ export function getDefineEnv({
'process.env.__NEXT_STRICT_MODE': JSON.stringify(config.reactStrictMode),
'process.env.__NEXT_REACT_ROOT': JSON.stringify(hasReactRoot),
'process.env.__NEXT_OPTIMIZE_FONTS': JSON.stringify(
config.optimizeFonts && !dev
!dev && config.optimizeFonts
),
'process.env.__NEXT_OPTIMIZE_CSS': JSON.stringify(
config.experimental.optimizeCss && !dev
......@@ -1802,6 +1802,7 @@ export default async function getBaseWebpackConfig(
}
return new FontStylesheetGatheringPlugin({
isLikeServerless,
adjustFontFallbacks: config.experimental.adjustFontFallbacks,
})
})(),
new WellKnownErrorsPlugin(),
......
......@@ -284,7 +284,7 @@ export function getPageHandler(ctx: ServerlessHandlerCtx) {
const isPreviewMode = previewData !== false
if (process.env.__NEXT_OPTIMIZE_FONTS) {
renderOpts.optimizeFonts = true
renderOpts.optimizeFonts = process.env.__NEXT_OPTIMIZE_FONTS
/**
* __webpack_require__.__NEXT_FONT_MANIFEST__ is added by
* font-stylesheet-gathering-plugin
......
......@@ -5,6 +5,7 @@ import {
} from 'next/dist/compiled/webpack/webpack'
import {
getFontDefinitionFromNetwork,
getFontOverrideCss,
FontManifest,
} from '../../../server/font-utils'
import postcss from 'postcss'
......@@ -52,9 +53,17 @@ export class FontStylesheetGatheringPlugin {
gatheredStylesheets: Array<string> = []
manifestContent: FontManifest = []
isLikeServerless: boolean
adjustFontFallbacks?: boolean
constructor({ isLikeServerless }: { isLikeServerless: boolean }) {
constructor({
isLikeServerless,
adjustFontFallbacks,
}: {
isLikeServerless: boolean
adjustFontFallbacks?: boolean
}) {
this.isLikeServerless = isLikeServerless
this.adjustFontFallbacks = adjustFontFallbacks
}
private parserHandler = (
......@@ -212,7 +221,11 @@ export class FontStylesheetGatheringPlugin {
this.manifestContent = []
for (let promiseIndex in fontDefinitionPromises) {
const css = await fontDefinitionPromises[promiseIndex]
let css = await fontDefinitionPromises[promiseIndex]
if (this.adjustFontFallbacks) {
css += getFontOverrideCss(fontStylesheets[promiseIndex], css)
}
if (css) {
try {
......
......@@ -41,6 +41,7 @@ import { PrerenderManifest } from '../build'
import { PagesManifest } from '../build/webpack/plugins/pages-manifest-plugin'
import { getPagePath } from '../server/require'
import { Span } from '../trace'
import { FontConfig } from '../server/font-utils'
const exists = promisify(existsOrig)
......@@ -383,7 +384,7 @@ export default async function exportApp(
crossOrigin: nextConfig.crossOrigin,
optimizeCss: nextConfig.experimental.optimizeCss,
nextScriptWorkers: nextConfig.experimental.nextScriptWorkers,
optimizeFonts: nextConfig.optimizeFonts,
optimizeFonts: nextConfig.optimizeFonts as FontConfig,
largePageDataBytes: nextConfig.experimental.largePageDataBytes,
}
......@@ -587,7 +588,7 @@ export default async function exportApp(
subFolders,
buildExport: options.buildExport,
serverless: isTargetLikeServerless(nextConfig.target),
optimizeFonts: nextConfig.optimizeFonts,
optimizeFonts: nextConfig.optimizeFonts as FontConfig,
optimizeCss: nextConfig.experimental.optimizeCss,
disableOptimizedLoading:
nextConfig.experimental.disableOptimizedLoading,
......
import type { ComponentType } from 'react'
import type { FontManifest } from '../server/font-utils'
import type { FontManifest, FontConfig } from '../server/font-utils'
import type { GetStaticProps } from '../types'
import type { IncomingMessage, ServerResponse } from 'http'
import type { DomainLocale, NextConfigComplete } from '../server/config-shared'
......@@ -59,7 +59,7 @@ interface ExportPageInput {
serverRuntimeConfig: { [key: string]: any }
subFolders?: boolean
serverless: boolean
optimizeFonts: boolean
optimizeFonts: FontConfig
optimizeCss: any
disableOptimizedLoading: any
parentSpanId: any
......@@ -82,7 +82,7 @@ interface RenderOpts {
ampPath?: string
ampValidatorPath?: string
ampSkipValidation?: boolean
optimizeFonts?: boolean
optimizeFonts?: FontConfig
disableOptimizedLoading?: boolean
optimizeCss?: any
fontManifest?: FontManifest
......@@ -402,7 +402,7 @@ export default async function exportPage({
* TODO(prateekbh@): Remove this when experimental.optimizeFonts are being cleaned up.
*/
if (optimizeFonts) {
process.env.__NEXT_OPTIMIZE_FONTS = JSON.stringify(true)
process.env.__NEXT_OPTIMIZE_FONTS = JSON.stringify(optimizeFonts)
}
if (optimizeCss) {
process.env.__NEXT_OPTIMIZE_CSS = JSON.stringify(true)
......
......@@ -2,7 +2,7 @@ import type { __ApiPreviewProps } from './api-utils'
import type { CustomRoutes } from '../lib/load-custom-routes'
import type { DomainLocale } from './config'
import type { DynamicRoutes, PageChecker, Route } from './router'
import type { FontManifest } from './font-utils'
import type { FontManifest, FontConfig } from './font-utils'
import type { LoadComponentsReturnType } from './load-components'
import type { RouteMatch } from '../shared/lib/router/utils/route-matcher'
import type { MiddlewareRouteMatch } from '../shared/lib/router/utils/middleware-route-matcher'
......@@ -201,7 +201,7 @@ export default abstract class Server<ServerOptions extends Options = Options> {
customServer?: boolean
ampOptimizerConfig?: { [key: string]: any }
basePath: string
optimizeFonts: boolean
optimizeFonts: FontConfig
images: ImageConfigComplete
fontManifest?: FontManifest
disableOptimizedLoading?: boolean
......@@ -381,9 +381,9 @@ export default abstract class Server<ServerOptions extends Options = Options> {
ampOptimizerConfig: this.nextConfig.experimental.amp?.optimizer,
basePath: this.nextConfig.basePath,
images: this.nextConfig.images,
optimizeFonts: !!this.nextConfig.optimizeFonts && !dev,
optimizeFonts: this.nextConfig.optimizeFonts as FontConfig,
fontManifest:
this.nextConfig.optimizeFonts && !dev
(this.nextConfig.optimizeFonts as FontConfig) && !dev
? this.getFontManifest()
: undefined,
optimizeCss: this.nextConfig.experimental.optimizeCss,
......@@ -1194,6 +1194,7 @@ export default abstract class Server<ServerOptions extends Options = Options> {
locale,
locales,
defaultLocale,
optimizeFonts: this.renderOpts.optimizeFonts,
optimizeCss: this.renderOpts.optimizeCss,
nextScriptWorkers: this.renderOpts.nextScriptWorkers,
distDir: this.distDir,
......
......@@ -219,6 +219,9 @@ const configSchema = {
experimental: {
additionalProperties: false,
properties: {
adjustFontFallbacks: {
type: 'boolean',
},
amp: {
additionalProperties: false,
properties: {
......
......@@ -150,6 +150,7 @@ export interface ExperimentalConfig {
sri?: {
algorithm?: SubresourceIntegrityAlgorithm
}
adjustFontFallbacks?: boolean
}
export type ExportPathMap = {
......@@ -581,6 +582,7 @@ export const defaultConfig: NextConfig = {
amp: undefined,
urlImports: undefined,
modularizeImports: undefined,
adjustFontFallbacks: false,
},
}
......
import * as Log from '../build/output/log'
import { GOOGLE_FONT_PROVIDER } from '../shared/lib/constants'
import {
GOOGLE_FONT_PROVIDER,
DEFAULT_SERIF_FONT,
DEFAULT_SANS_SERIF_FONT,
} from '../shared/lib/constants'
const googleFontsMetrics = require('./google-font-metrics.json')
const https = require('https')
const CHROME_UA =
......@@ -11,6 +16,8 @@ export type FontManifest = Array<{
content: string
}>
export type FontConfig = boolean
function isGoogleFont(url: string): boolean {
return url.startsWith(GOOGLE_FONT_PROVIDER)
}
......@@ -77,3 +84,59 @@ export function getFontDefinitionFromManifest(
})?.content || ''
)
}
function parseGoogleFontName(css: string): Array<string> {
const regex = /font-family: ([^;]*)/g
const matches = css.matchAll(regex)
const fontNames = new Set<string>()
for (let font of matches) {
const fontFamily = font[1].replace(/^['"]|['"]$/g, '')
fontNames.add(fontFamily)
}
return [...fontNames]
}
function calculateOverrideCSS(font: string, fontMetrics: any) {
const fontName = font.toLowerCase().trim().replace(/ /g, '-')
const fontKey = font.toLowerCase().trim().replace(/ /g, '')
const { category, ascentOverride, descentOverride, lineGapOverride } =
fontMetrics[fontKey]
const fallbackFont =
category === 'serif' ? DEFAULT_SERIF_FONT : DEFAULT_SANS_SERIF_FONT
const ascent = (ascentOverride * 100).toFixed(2)
const descent = (descentOverride * 100).toFixed(2)
const lineGap = (lineGapOverride * 100).toFixed(2)
return `
@font-face {
font-family: "${fontName}-fallback";
ascent-override: ${ascent}%;
descent-override: ${descent}%;
line-gap-override: ${lineGap}%;
src: local("${fallbackFont}");
}
`
}
export function getFontOverrideCss(url: string, css: string) {
if (!isGoogleFont(url)) {
return ''
}
try {
const fontNames = parseGoogleFontName(css)
const fontMetrics = googleFontsMetrics
const fontCss = fontNames.reduce((cssStr, fontName) => {
cssStr += calculateOverrideCSS(fontName, fontMetrics)
return cssStr
}, '')
return fontCss
} catch (e) {
console.log('Error getting font override values - ', e)
return ''
}
}
This diff is collapsed.
......@@ -224,7 +224,9 @@ export default class NextNodeServer extends BaseServer {
* `process.env.__NEXT_OPTIMIZE_CSS`.
*/
if (this.renderOpts.optimizeFonts) {
process.env.__NEXT_OPTIMIZE_FONTS = JSON.stringify(true)
process.env.__NEXT_OPTIMIZE_FONTS = JSON.stringify(
this.renderOpts.optimizeFonts
)
}
if (this.renderOpts.optimizeCss) {
process.env.__NEXT_OPTIMIZE_CSS = JSON.stringify(true)
......
......@@ -20,7 +20,7 @@ if (process.env.NEXT_RUNTIME !== 'edge') {
}
type postProcessOptions = {
optimizeFonts: boolean
optimizeFonts: any
}
type renderOptions = {
......@@ -197,7 +197,7 @@ async function postProcessHTML(
return html
}
: null,
process.env.NEXT_RUNTIME !== 'edge' && process.env.__NEXT_OPTIMIZE_FONTS
process.env.NEXT_RUNTIME !== 'edge' && renderOpts.optimizeFonts
? async (html: string) => {
const getFontDefinition = (url: string): string => {
if (renderOpts.fontManifest) {
......
......@@ -16,7 +16,7 @@ import type {
import type { ImageConfigComplete } from '../shared/lib/image-config'
import type { Redirect } from '../lib/load-custom-routes'
import type { NextApiRequestCookies, __ApiPreviewProps } from './api-utils'
import type { FontManifest } from './font-utils'
import type { FontManifest, FontConfig } from './font-utils'
import type { LoadComponentsReturnType, ManifestItem } from './load-components'
import type {
GetServerSideProps,
......@@ -223,7 +223,7 @@ export type RenderOptsPartial = {
basePath: string
unstable_runtimeJS?: false
unstable_JsPreload?: false
optimizeFonts: boolean
optimizeFonts: FontConfig
fontManifest?: FontManifest
optimizeCss: any
nextScriptWorkers: any
......
......@@ -91,6 +91,8 @@ export const OPTIMIZED_FONT_PROVIDERS = [
{ url: GOOGLE_FONT_PROVIDER, preconnect: 'https://fonts.gstatic.com' },
{ url: 'https://use.typekit.net', preconnect: 'https://use.typekit.net' },
]
export const DEFAULT_SERIF_FONT = 'Times New Roman'
export const DEFAULT_SANS_SERIF_FONT = 'Arial'
export const STATIC_STATUS_PAGES = ['/500']
export const TRACE_OUTPUT_VERSION = 1
......
import type { BuildManifest } from '../../server/get-page-files'
import type { ServerRuntime } from 'next/types'
import type { NEXT_DATA } from './utils'
import type { FontConfig } from '../../server/font-utils'
import { createContext } from 'react'
......@@ -35,8 +36,8 @@ export type HtmlProps = {
styles?: React.ReactElement[] | React.ReactFragment
head?: Array<JSX.Element | null>
crossOrigin?: string
optimizeCss?: boolean
optimizeFonts?: boolean
optimizeCss?: any
optimizeFonts?: FontConfig
nextScriptWorkers?: boolean
runtime?: ServerRuntime
hasConcurrentFeatures?: boolean
......
......@@ -1983,6 +1983,12 @@ export async function server(task, opts) {
.source(opts.src || 'server/**/*.+(js|ts|tsx)')
.swc('server', { dev: opts.dev })
.target('dist/server')
await fs.copyFile(
join(__dirname, 'server/google-font-metrics.json'),
join(__dirname, 'dist/server/google-font-metrics.json')
)
notify('Compiled server files')
}
......
module.exports = {
cleanDistDir: false,
experimental: {
adjustFontFallbacks: true,
},
}
import '../styles/styles.css'
// This default export is required in a new `pages/_app.js` file.
export default function MyApp({ Component, pageProps }) {
return <Component {...pageProps} />
}
import * as React from 'react'
/// @ts-ignore
import Document, { Main, NextScript, Head, Html } from 'next/document'
export default class MyDocument extends Document {
render() {
return (
<Html>
<Head>
<link
rel="stylesheet"
href="https://fonts.googleapis.com/css2?family=Roboto&display=swap"
/>
<link
rel="stylesheet"
href="https://fonts.googleapis.com/css2?family=Open+Sans&family=Libre+Baskerville&display=swap"
/>
</Head>
<body>
<Main />
<NextScript />
</body>
</Html>
)
}
}
import React from 'react'
const Page = () => {
return <div>Hello!</div>
}
export default Page
......@@ -120,7 +120,7 @@ describe('Font Optimization', () => {
})
it(`should inline the ${property} fonts for static pages`, async () => {
const html = await renderViaHTTP(appPort, '/index')
const html = await renderViaHTTP(appPort, '/')
const $ = cheerio.load(html)
expect(await fsExists(builtPage('font-manifest.json'))).toBe(true)
expect(
......@@ -304,7 +304,7 @@ describe('Font Optimization', () => {
)
appPort = await findPort()
app = await nextStart(appDir, appPort)
builtServerPagesDir = join(appDir, '.next', 'serverless')
builtServerPagesDir = join(appDir, '.next', 'server')
builtPage = (file) => join(builtServerPagesDir, file)
})
afterAll(() => killApp(app))
......@@ -337,4 +337,37 @@ describe('Font Optimization', () => {
const { code } = await nextBuild(appDir)
expect(code).toBe(0)
})
describe('font override', () => {
let app, appPort
beforeAll(async () => {
const appDir = join(fixturesDir, 'font-override')
await nextBuild(appDir)
appPort = await findPort()
app = await nextStart(appDir, appPort)
})
afterAll(() => killApp(app))
it('should inline font-override values', async () => {
const html = await renderViaHTTP(appPort, '/')
const $ = cheerio.load(html)
const inlineStyle = $(
'style[data-href="https://fonts.googleapis.com/css2?family=Roboto&display=swap"]'
)
const inlineStyleMultiple = $(
'style[data-href="https://fonts.googleapis.com/css2?family=Open+Sans&family=Libre+Baskerville&display=swap"]'
)
expect(inlineStyle.length).toBe(1)
expect(inlineStyle.html()).toContain(
'@font-face{font-family:"roboto-fallback";ascent-override:92.77%;descent-override:24.41%;line-gap-override:0.00%;src:local("Arial")}'
)
expect(inlineStyleMultiple.length).toBe(1)
expect(inlineStyleMultiple.html()).toContain(
'@font-face{font-family:"libre-baskerville-fallback";ascent-override:97.00%;descent-override:27.00%;line-gap-override:0.00%;src:local("Times New Roman")}'
)
expect(inlineStyleMultiple.html()).toContain(
'@font-face{font-family:"open-sans-fallback";ascent-override:106.88%;descent-override:29.30%;line-gap-override:0.00%;src:local("Arial")}'
)
})
})
})
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