Unverified Commit 56b097a8 authored by Janicklas Ralph's avatar Janicklas Ralph Committed by GitHub

Updating size-adjust calculation (#41406)

<!--
Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change that you're making:




## Bug

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

## Feature

- [ ] 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`
- [ ] Integration tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have a helpful link attached, see `contributing.md`

## Documentation / Examples

- [ ] 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/examples/adding-examples.md)
-->

Updating size-adjust calc to use azAvgWidth instead of xAvgCharWidth
Co-authored-by: 's avatarHannes Bornö <hannes.borno@vercel.com>
Co-authored-by: 's avatarBalázs Orbán <info@balazsorban.com>
Co-authored-by: 's avatarJJ Kasper <jj@jjsweb.site>
parent 77ba4a86
......@@ -6,7 +6,7 @@ import fontFromBuffer from '@next/font/dist/fontkit'
import type { AdjustFontFallback, FontLoader } from 'next/font'
import { promisify } from 'util'
import { validateData } from './utils'
import { calcAzWidth, validateData } from './utils'
const fetchFonts: FontLoader = async ({
functionName,
......@@ -58,6 +58,7 @@ const fetchFonts: FontLoader = async ({
lineGap: fontMetadata.lineGap,
unitsPerEm: fontMetadata.unitsPerEm,
xAvgCharWidth: (fontMetadata as any)['OS/2']?.xAvgCharWidth,
azAvgWidth: calcAzWidth(fontMetadata),
})
adjustFontFallbackMetrics = {
fallbackFont,
......
import type { Font } from 'fontkit'
const allowedDisplayValues = ['auto', 'block', 'swap', 'fallback', 'optional']
const formatValues = (values: string[]) =>
......@@ -91,3 +93,12 @@ export function validateData(functionName: string, data: any): FontOptions {
declarations,
}
}
// Calculating the a-z average width
export function calcAzWidth(font: Font) {
const widths = font
.glyphsForString('abcdefghijklmnopqrstuvwxyz')
.map((glyph) => glyph.advanceWidth)
const totalWidth = widths.reduce((sum, width) => sum + width, 0)
return totalWidth / widths.length
}
......@@ -119,14 +119,14 @@ export function calculateOverrideValues(fontMetrics: any) {
}
export function calculateSizeAdjustValues(fontMetrics: any) {
let { category, ascent, descent, lineGap, unitsPerEm, xAvgCharWidth } =
let { category, ascent, descent, lineGap, unitsPerEm, azAvgWidth } =
fontMetrics
const fallbackFont =
category === 'serif' ? DEFAULT_SERIF_FONT : DEFAULT_SANS_SERIF_FONT
let sizeAdjust = xAvgCharWidth
? xAvgCharWidth / fallbackFont.xAvgCharWidth
: 1
const mainFontAvgWidth = azAvgWidth / unitsPerEm
const fallbackFontAvgWidth = fallbackFont.azAvgWidth / fallbackFont.unitsPerEm
let sizeAdjust = azAvgWidth ? mainFontAvgWidth / fallbackFontAvgWidth : 1
ascent = formatOverrideValue(ascent / (unitsPerEm * sizeAdjust))
descent = formatOverrideValue(descent / (unitsPerEm * sizeAdjust))
......
......@@ -100,8 +100,15 @@ export const OPTIMIZED_FONT_PROVIDERS = [
export const DEFAULT_SERIF_FONT = {
name: 'Times New Roman',
xAvgCharWidth: 821,
azAvgWidth: 940.6538,
unitsPerEm: 2048,
}
export const DEFAULT_SANS_SERIF_FONT = {
name: 'Arial',
xAvgCharWidth: 904,
azAvgWidth: 1002.5769,
unitsPerEm: 2048,
}
export const DEFAULT_SANS_SERIF_FONT = { name: 'Arial', xAvgCharWidth: 904 }
export const STATIC_STATUS_PAGES = ['/500']
export const TRACE_OUTPUT_VERSION = 1
......
......@@ -363,12 +363,12 @@ describe('@next/font/google', () => {
const ascentOverride = await browser.eval(
'Array.from(document.fonts.values()).find(font => font.family.includes("Indie_Flower_Fallback")).ascentOverride'
)
expect(ascentOverride).toBe('185.52%')
expect(ascentOverride).toBe('109.1%')
const descentOverride = await browser.eval(
'Array.from(document.fonts.values()).find(font => font.family.includes("Indie_Flower_Fallback")).descentOverride'
)
expect(descentOverride).toBe('93.32%')
expect(descentOverride).toBe('54.88%')
const lineGapOverride = await browser.eval(
'Array.from(document.fonts.values()).find(font => font.family.includes("Indie_Flower_Fallback")).lineGapOverride'
......@@ -378,7 +378,7 @@ describe('@next/font/google', () => {
const sizeAdjust = await browser.eval(
'Array.from(document.fonts.values()).find(font => font.family.includes("Indie_Flower_Fallback")).sizeAdjust'
)
expect(sizeAdjust).toBe('52.32%')
expect(sizeAdjust).toBe('88.97%')
})
test('Fraunces', async () => {
......@@ -387,12 +387,12 @@ describe('@next/font/google', () => {
const ascentOverride = await browser.eval(
'Array.from(document.fonts.values()).find(font => font.family.includes("Fraunces_Fallback")).ascentOverride'
)
expect(ascentOverride).toBe('63.47%')
expect(ascentOverride).toBe('83.79%')
const descentOverride = await browser.eval(
'Array.from(document.fonts.values()).find(font => font.family.includes("Fraunces_Fallback")).descentOverride'
)
expect(descentOverride).toBe('16.55%')
expect(descentOverride).toBe('21.85%')
const lineGapOverride = await browser.eval(
'Array.from(document.fonts.values()).find(font => font.family.includes("Fraunces_Fallback")).lineGapOverride'
......@@ -402,7 +402,7 @@ describe('@next/font/google', () => {
const sizeAdjust = await browser.eval(
'Array.from(document.fonts.values()).find(font => font.family.includes("Fraunces_Fallback")).sizeAdjust'
)
expect(sizeAdjust).toBe('154.08%')
expect(sizeAdjust).toBe('116.72%')
})
})
......@@ -413,12 +413,12 @@ describe('@next/font/google', () => {
const ascentOverride = await browser.eval(
'Array.from(document.fonts.values()).find(font => font.family.includes("Indie_Flower_Fallback")).ascentOverride'
)
expect(ascentOverride).toBe('185.52%')
expect(ascentOverride).toBe('109.1%')
const descentOverride = await browser.eval(
'Array.from(document.fonts.values()).find(font => font.family.includes("Indie_Flower_Fallback")).descentOverride'
)
expect(descentOverride).toBe('93.32%')
expect(descentOverride).toBe('54.88%')
const lineGapOverride = await browser.eval(
'Array.from(document.fonts.values()).find(font => font.family.includes("Indie_Flower_Fallback")).lineGapOverride'
......@@ -428,7 +428,7 @@ describe('@next/font/google', () => {
const sizeAdjust = await browser.eval(
'Array.from(document.fonts.values()).find(font => font.family.includes("Indie_Flower_Fallback")).sizeAdjust'
)
expect(sizeAdjust).toBe('52.32%')
expect(sizeAdjust).toBe('88.97%')
})
test('Fraunces', async () => {
......@@ -437,12 +437,12 @@ describe('@next/font/google', () => {
const ascentOverride = await browser.eval(
'Array.from(document.fonts.values()).find(font => font.family.includes("Fraunces_Fallback")).ascentOverride'
)
expect(ascentOverride).toBe('63.47%')
expect(ascentOverride).toBe('83.79%')
const descentOverride = await browser.eval(
'Array.from(document.fonts.values()).find(font => font.family.includes("Fraunces_Fallback")).descentOverride'
)
expect(descentOverride).toBe('16.55%')
expect(descentOverride).toBe('21.85%')
const lineGapOverride = await browser.eval(
'Array.from(document.fonts.values()).find(font => font.family.includes("Fraunces_Fallback")).lineGapOverride'
......@@ -452,7 +452,7 @@ describe('@next/font/google', () => {
const sizeAdjust = await browser.eval(
'Array.from(document.fonts.values()).find(font => font.family.includes("Fraunces_Fallback")).sizeAdjust'
)
expect(sizeAdjust).toBe('154.08%')
expect(sizeAdjust).toBe('116.72%')
})
})
})
......
......@@ -332,14 +332,14 @@ describe('Font Optimization', () => {
)
expect(inlineStyle.length).toBe(1)
expect(inlineStyle.html()).toContain(
'@font-face{font-family:"Roboto Fallback";ascent-override:72.42%;descent-override:19.06%;line-gap-override:0.00%;size-adjust:128.10%;src:local("Arial")}'
'@font-face{font-family:"Roboto Fallback";ascent-override:91.03%;descent-override:23.95%;line-gap-override:0.00%;size-adjust:101.92%;src:local("Arial")}'
)
expect(inlineStyleMultiple.length).toBe(1)
expect(inlineStyleMultiple.html()).toContain(
'@font-face{font-family:"Libre Baskerville Fallback";ascent-override:155.24%;descent-override:43.21%;line-gap-override:0.00%;size-adjust:62.48%;src:local("Times New Roman")}'
'@font-face{font-family:"Libre Baskerville Fallback";ascent-override:75.85%;descent-override:21.11%;line-gap-override:0.00%;size-adjust:127.88%;src:local("Times New Roman")}'
)
expect(inlineStyleMultiple.html()).toContain(
'@font-face{font-family:"Open Sans Fallback";ascent-override:82.66%;descent-override:22.66%;line-gap-override:0.00%;size-adjust:129.31%;src:local("Arial")}'
'@font-face{font-family:"Open Sans Fallback";ascent-override:100.16%;descent-override:27.45%;line-gap-override:0.00%;size-adjust:106.71%;src:local("Arial")}'
)
})
})
......
......@@ -107,11 +107,11 @@ describe('@next/font/google loader', () => {
fs: {} as any,
})
expect(adjustFontFallback).toEqual({
ascentOverride: '47.65%',
descentOverride: '11.88%',
ascentOverride: '88.84%',
descentOverride: '22.14%',
fallbackFont: 'Arial',
lineGapOverride: '0.00%',
sizeAdjust: '203.32%',
sizeAdjust: '109.04%',
})
expect(fallbackFonts).toBeUndefined()
})
......@@ -130,11 +130,11 @@ describe('@next/font/google loader', () => {
fs: {} as any,
})
expect(adjustFontFallback).toEqual({
ascentOverride: '148.26%',
descentOverride: '41.13%',
ascentOverride: '80.28%',
descentOverride: '22.27%',
fallbackFont: 'Arial',
lineGapOverride: '0.00%',
sizeAdjust: '66.37%',
sizeAdjust: '122.56%',
})
expect(fallbackFonts).toBeUndefined()
})
......@@ -153,11 +153,11 @@ describe('@next/font/google loader', () => {
fs: {} as any,
})
expect(adjustFontFallback).toEqual({
ascentOverride: '63.47%',
descentOverride: '16.55%',
ascentOverride: '83.79%',
descentOverride: '21.85%',
fallbackFont: 'Times New Roman',
lineGapOverride: '0.00%',
sizeAdjust: '154.08%',
sizeAdjust: '116.72%',
})
expect(fallbackFonts).toEqual(['Abc', 'Def'])
})
......
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