forked from vercel/next.js
/
font-stylesheet-gathering-plugin.ts
276 lines (252 loc) · 8.66 KB
/
font-stylesheet-gathering-plugin.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
import {
webpack,
BasicEvaluatedExpression,
sources,
} from 'next/dist/compiled/webpack/webpack'
import {
getFontDefinitionFromNetwork,
getFontOverrideCss,
FontManifest,
FontConfig,
} from '../../../server/font-utils'
import postcss from 'postcss'
import minifier from 'next/dist/compiled/cssnano-simple'
import {
FONT_MANIFEST,
OPTIMIZED_FONT_PROVIDERS,
} from '../../../shared/lib/constants'
import * as Log from '../../output/log'
function minifyCss(css: string): Promise<string> {
return postcss([
minifier(
{
excludeAll: true,
discardComments: true,
normalizeWhitespace: { exclude: false },
},
postcss
),
])
.process(css, { from: undefined })
.then((res) => res.css)
}
function isNodeCreatingLinkElement(node: any) {
const callee = node.callee as any
if (callee.type !== 'Identifier') {
return false
}
const componentNode = node.arguments[0] as any
if (componentNode.type !== 'Literal') {
return false
}
// React has pragma: _jsx.
// Next has pragma: __jsx.
return (
(callee.name === '_jsx' || callee.name === '__jsx') &&
componentNode.value === 'link'
)
}
export class FontStylesheetGatheringPlugin {
compiler?: webpack.Compiler
gatheredStylesheets: Array<string> = []
manifestContent: FontManifest = []
isLikeServerless: boolean
optimizeFonts: FontConfig
constructor({
isLikeServerless,
optimizeFonts,
}: {
isLikeServerless: boolean
optimizeFonts: FontConfig
}) {
this.isLikeServerless = isLikeServerless
this.optimizeFonts = optimizeFonts
}
private parserHandler = (
factory: ReturnType<webpack.Compiler['createNormalModuleFactory']>
): void => {
const JS_TYPES = ['auto', 'esm', 'dynamic']
// Do an extra walk per module and add interested visitors to the walk.
for (const type of JS_TYPES) {
factory.hooks.parser
.for('javascript/' + type)
.tap(this.constructor.name, (parser: any) => {
/**
* Webpack fun facts:
* `parser.hooks.call.for` cannot catch calls for user defined identifiers like `__jsx`
* it can only detect calls for native objects like `window`, `this`, `eval` etc.
* In order to be able to catch calls of variables like `__jsx`, first we need to catch them as
* Identifier and then return `BasicEvaluatedExpression` whose `id` and `type` webpack matches to
* invoke hook for call.
* See: https://github.com/webpack/webpack/blob/webpack-4/lib/Parser.js#L1931-L1932.
*/
parser.hooks.evaluate
.for('Identifier')
.tap(this.constructor.name, (node: any) => {
// We will only optimize fonts from first party code.
if (parser?.state?.module?.resource.includes('node_modules')) {
return
}
let result
if (node.name === '_jsx' || node.name === '__jsx') {
result = new BasicEvaluatedExpression()
// @ts-ignore
result.setRange(node.range)
result.setExpression(node)
result.setIdentifier(node.name)
// This was added in webpack 5.
result.getMembers = () => []
}
return result
})
const jsxNodeHandler = (node: any) => {
if (node.arguments.length !== 2) {
// A font link tag has only two arguments rel=stylesheet and href='...'
return
}
if (!isNodeCreatingLinkElement(node)) {
return
}
// node.arguments[0] is the name of the tag and [1] are the props.
const arg1 = node.arguments[1]
const propsNode =
arg1.type === 'ObjectExpression' ? (arg1 as any) : undefined
const props: { [key: string]: string } = {}
if (propsNode) {
propsNode.properties.forEach((prop: any) => {
if (prop.type !== 'Property') {
return
}
if (
prop.key.type === 'Identifier' &&
prop.value.type === 'Literal'
) {
props[prop.key.name] = prop.value.value as string
}
})
}
if (
!props.rel ||
props.rel !== 'stylesheet' ||
!props.href ||
!OPTIMIZED_FONT_PROVIDERS.some(({ url }) =>
props.href.startsWith(url)
)
) {
return false
}
this.gatheredStylesheets.push(props.href)
const buildInfo = parser?.state?.module?.buildInfo
if (buildInfo) {
buildInfo.valueDependencies.set(
FONT_MANIFEST,
this.gatheredStylesheets
)
}
}
// React JSX transform:
parser.hooks.call
.for('_jsx')
.tap(this.constructor.name, jsxNodeHandler)
// Next.js JSX transform:
parser.hooks.call
.for('__jsx')
.tap(this.constructor.name, jsxNodeHandler)
// New React JSX transform:
parser.hooks.call
.for('imported var')
.tap(this.constructor.name, jsxNodeHandler)
})
}
}
public apply(compiler: webpack.Compiler) {
this.compiler = compiler
compiler.hooks.normalModuleFactory.tap(
this.constructor.name,
this.parserHandler
)
compiler.hooks.make.tapAsync(this.constructor.name, (compilation, cb) => {
if (this.isLikeServerless) {
/**
* Inline font manifest for serverless case only.
* For target: server drive the manifest through physical file and less of webpack magic.
*/
const mainTemplate = compilation.mainTemplate
mainTemplate.hooks.requireExtensions.tap(
this.constructor.name,
(source: string) => {
return `${source}
// Font manifest declaration
__webpack_require__.__NEXT_FONT_MANIFEST__ = ${JSON.stringify(
this.manifestContent
)};
// Enable feature:
process.env.__NEXT_OPTIMIZE_FONTS = ${JSON.stringify(
this.optimizeFonts
)};`
}
)
}
compilation.hooks.finishModules.tapAsync(
this.constructor.name,
async (modules: any, modulesFinished: Function) => {
let fontStylesheets = this.gatheredStylesheets
const fontUrls = new Set<string>()
modules.forEach((module: any) => {
const fontDependencies =
module?.buildInfo?.valueDependencies?.get(FONT_MANIFEST)
if (fontDependencies) {
fontDependencies.forEach((v: string) => fontUrls.add(v))
}
})
fontStylesheets = Array.from(fontUrls)
const fontDefinitionPromises = fontStylesheets.map((url) =>
getFontDefinitionFromNetwork(url)
)
this.manifestContent = []
for (let promiseIndex in fontDefinitionPromises) {
let css = await fontDefinitionPromises[promiseIndex]
if (this.optimizeFonts?.experimentalAdjustFallbacks) {
css += getFontOverrideCss(fontStylesheets[promiseIndex], css)
}
if (css) {
try {
const content = await minifyCss(css)
this.manifestContent.push({
url: fontStylesheets[promiseIndex],
content,
})
} catch (err) {
Log.warn(
`Failed to minify the stylesheet for ${fontStylesheets[promiseIndex]}. Skipped optimizing this font.`
)
console.error(err)
}
}
}
// @ts-expect-error invalid assets type
compilation.assets[FONT_MANIFEST] = new sources.RawSource(
JSON.stringify(this.manifestContent, null, ' ')
)
modulesFinished()
}
)
cb()
})
compiler.hooks.make.tap(this.constructor.name, (compilation) => {
// @ts-ignore TODO: Remove ignore when webpack 5 is stable
compilation.hooks.processAssets.tap(
{
name: this.constructor.name,
// @ts-ignore TODO: Remove ignore when webpack 5 is stable
stage: webpack.Compilation.PROCESS_ASSETS_STAGE_ADDITIONS,
},
(assets: any) => {
assets['../' + FONT_MANIFEST] = new sources.RawSource(
JSON.stringify(this.manifestContent, null, ' ')
)
}
)
})
}
}