File size: 15,265 Bytes
1e92f2d |
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 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 |
import type {
NodePath,
types as BabelTypes,
} from 'next/dist/compiled/babel/core'
import type { PluginObj } from 'next/dist/compiled/babel/core'
import { SERVER_PROPS_SSG_CONFLICT } from '../../../lib/constants'
import { SERVER_PROPS_ID, STATIC_PROPS_ID } from '../../../shared/lib/constants'
export const EXPORT_NAME_GET_STATIC_PROPS = 'getStaticProps'
export const EXPORT_NAME_GET_STATIC_PATHS = 'getStaticPaths'
export const EXPORT_NAME_GET_SERVER_PROPS = 'getServerSideProps'
const ssgExports = new Set([
EXPORT_NAME_GET_STATIC_PROPS,
EXPORT_NAME_GET_STATIC_PATHS,
EXPORT_NAME_GET_SERVER_PROPS,
// legacy methods added so build doesn't fail from importing
// server-side only methods
`unstable_getStaticProps`,
`unstable_getStaticPaths`,
`unstable_getServerProps`,
`unstable_getServerSideProps`,
])
type PluginState = {
refs: Set<NodePath<BabelTypes.Identifier>>
isPrerender: boolean
isServerProps: boolean
done: boolean
}
function decorateSsgExport(
t: typeof BabelTypes,
path: NodePath<BabelTypes.Program>,
state: PluginState
): void {
const gsspName = state.isPrerender ? STATIC_PROPS_ID : SERVER_PROPS_ID
const gsspId = t.identifier(gsspName)
const addGsspExport = (
exportPath:
| NodePath<BabelTypes.ExportDefaultDeclaration>
| NodePath<BabelTypes.ExportNamedDeclaration>
): void => {
if (state.done) {
return
}
state.done = true
const [pageCompPath] = exportPath.replaceWithMultiple([
t.exportNamedDeclaration(
t.variableDeclaration(
// We use 'var' instead of 'let' or 'const' for ES5 support. Since
// this runs in `Program#exit`, no ES2015 transforms (preset env)
// will be ran against this code.
'var',
[t.variableDeclarator(gsspId, t.booleanLiteral(true))]
),
[t.exportSpecifier(gsspId, gsspId)]
),
exportPath.node,
])
exportPath.scope.registerDeclaration(
pageCompPath as NodePath<BabelTypes.Node>
)
}
path.traverse({
ExportDefaultDeclaration(exportDefaultPath) {
addGsspExport(exportDefaultPath)
},
ExportNamedDeclaration(exportNamedPath) {
addGsspExport(exportNamedPath)
},
})
}
const isDataIdentifier = (name: string, state: PluginState): boolean => {
if (ssgExports.has(name)) {
if (name === EXPORT_NAME_GET_SERVER_PROPS) {
if (state.isPrerender) {
throw new Error(SERVER_PROPS_SSG_CONFLICT)
}
state.isServerProps = true
} else {
if (state.isServerProps) {
throw new Error(SERVER_PROPS_SSG_CONFLICT)
}
state.isPrerender = true
}
return true
}
return false
}
export default function nextTransformSsg({
types: t,
}: {
types: typeof BabelTypes
}): PluginObj<PluginState> {
function getIdentifier(
path:
| NodePath<BabelTypes.FunctionDeclaration>
| NodePath<BabelTypes.FunctionExpression>
| NodePath<BabelTypes.ArrowFunctionExpression>
): NodePath<BabelTypes.Identifier> | null {
const parentPath = path.parentPath
if (parentPath.type === 'VariableDeclarator') {
const pp = parentPath as NodePath<BabelTypes.VariableDeclarator>
const name = pp.get('id')
return name.node.type === 'Identifier'
? (name as NodePath<BabelTypes.Identifier>)
: null
}
if (parentPath.type === 'AssignmentExpression') {
const pp = parentPath as NodePath<BabelTypes.AssignmentExpression>
const name = pp.get('left')
return name.node.type === 'Identifier'
? (name as NodePath<BabelTypes.Identifier>)
: null
}
if (path.node.type === 'ArrowFunctionExpression') {
return null
}
return path.node.id && path.node.id.type === 'Identifier'
? (path.get('id') as NodePath<BabelTypes.Identifier>)
: null
}
function isIdentifierReferenced(
ident: NodePath<BabelTypes.Identifier>
): boolean {
const b = ident.scope.getBinding(ident.node.name)
if (b?.referenced) {
// Functions can reference themselves, so we need to check if there's a
// binding outside the function scope or not.
if (b.path.type === 'FunctionDeclaration') {
return !b.constantViolations
.concat(b.referencePaths)
// Check that every reference is contained within the function:
.every((ref) => ref.findParent((p) => p === b.path))
}
return true
}
return false
}
function markFunction(
path:
| NodePath<BabelTypes.FunctionDeclaration>
| NodePath<BabelTypes.FunctionExpression>
| NodePath<BabelTypes.ArrowFunctionExpression>,
state: PluginState
): void {
const ident = getIdentifier(path)
if (ident?.node && isIdentifierReferenced(ident)) {
state.refs.add(ident)
}
}
function markImport(
path:
| NodePath<BabelTypes.ImportSpecifier>
| NodePath<BabelTypes.ImportDefaultSpecifier>
| NodePath<BabelTypes.ImportNamespaceSpecifier>,
state: PluginState
): void {
const local = path.get('local') as NodePath<BabelTypes.Identifier>
if (isIdentifierReferenced(local)) {
state.refs.add(local)
}
}
return {
visitor: {
Program: {
enter(path, state) {
state.refs = new Set<NodePath<BabelTypes.Identifier>>()
state.isPrerender = false
state.isServerProps = false
state.done = false
path.traverse(
{
VariableDeclarator(variablePath, variableState) {
if (variablePath.node.id.type === 'Identifier') {
const local = variablePath.get(
'id'
) as NodePath<BabelTypes.Identifier>
if (isIdentifierReferenced(local)) {
variableState.refs.add(local)
}
} else if (variablePath.node.id.type === 'ObjectPattern') {
const pattern = variablePath.get(
'id'
) as NodePath<BabelTypes.ObjectPattern>
const properties = pattern.get('properties')
properties.forEach((p) => {
const local = p.get(
p.node.type === 'ObjectProperty'
? 'value'
: p.node.type === 'RestElement'
? 'argument'
: (function () {
throw new Error('invariant')
})()
) as NodePath<BabelTypes.Identifier>
if (isIdentifierReferenced(local)) {
variableState.refs.add(local)
}
})
} else if (variablePath.node.id.type === 'ArrayPattern') {
const pattern = variablePath.get(
'id'
) as NodePath<BabelTypes.ArrayPattern>
const elements = pattern.get('elements')
elements.forEach((e) => {
let local: NodePath<BabelTypes.Identifier>
if (e.node?.type === 'Identifier') {
local = e as NodePath<BabelTypes.Identifier>
} else if (e.node?.type === 'RestElement') {
local = e.get(
'argument'
) as NodePath<BabelTypes.Identifier>
} else {
return
}
if (isIdentifierReferenced(local)) {
variableState.refs.add(local)
}
})
}
},
FunctionDeclaration: markFunction,
FunctionExpression: markFunction,
ArrowFunctionExpression: markFunction,
ImportSpecifier: markImport,
ImportDefaultSpecifier: markImport,
ImportNamespaceSpecifier: markImport,
ExportNamedDeclaration(exportNamedPath, exportNamedState) {
const specifiers = exportNamedPath.get('specifiers')
if (specifiers.length) {
specifiers.forEach((s) => {
if (
isDataIdentifier(
t.isIdentifier(s.node.exported)
? s.node.exported.name
: s.node.exported.value,
exportNamedState
)
) {
s.remove()
}
})
if (exportNamedPath.node.specifiers.length < 1) {
exportNamedPath.remove()
}
return
}
const decl = exportNamedPath.get('declaration') as NodePath<
| BabelTypes.FunctionDeclaration
| BabelTypes.VariableDeclaration
>
if (decl == null || decl.node == null) {
return
}
switch (decl.node.type) {
case 'FunctionDeclaration': {
const name = decl.node.id!.name
if (isDataIdentifier(name, exportNamedState)) {
exportNamedPath.remove()
}
break
}
case 'VariableDeclaration': {
const inner = decl.get(
'declarations'
) as NodePath<BabelTypes.VariableDeclarator>[]
inner.forEach((d) => {
if (d.node.id.type !== 'Identifier') {
return
}
const name = d.node.id.name
if (isDataIdentifier(name, exportNamedState)) {
d.remove()
}
})
break
}
default: {
break
}
}
},
},
state
)
if (!state.isPrerender && !state.isServerProps) {
return
}
const refs = state.refs
let count: number
function sweepFunction(
sweepPath:
| NodePath<BabelTypes.FunctionDeclaration>
| NodePath<BabelTypes.FunctionExpression>
| NodePath<BabelTypes.ArrowFunctionExpression>
): void {
const ident = getIdentifier(sweepPath)
if (
ident?.node &&
refs.has(ident) &&
!isIdentifierReferenced(ident)
) {
++count
if (
t.isAssignmentExpression(sweepPath.parentPath.node) ||
t.isVariableDeclarator(sweepPath.parentPath.node)
) {
sweepPath.parentPath.remove()
} else {
sweepPath.remove()
}
}
}
function sweepImport(
sweepPath:
| NodePath<BabelTypes.ImportSpecifier>
| NodePath<BabelTypes.ImportDefaultSpecifier>
| NodePath<BabelTypes.ImportNamespaceSpecifier>
): void {
const local = sweepPath.get(
'local'
) as NodePath<BabelTypes.Identifier>
if (refs.has(local) && !isIdentifierReferenced(local)) {
++count
sweepPath.remove()
if (
(sweepPath.parent as BabelTypes.ImportDeclaration).specifiers
.length === 0
) {
sweepPath.parentPath.remove()
}
}
}
do {
;(path.scope as any).crawl()
count = 0
path.traverse({
// eslint-disable-next-line no-loop-func
VariableDeclarator(variablePath) {
if (variablePath.node.id.type === 'Identifier') {
const local = variablePath.get(
'id'
) as NodePath<BabelTypes.Identifier>
if (refs.has(local) && !isIdentifierReferenced(local)) {
++count
variablePath.remove()
}
} else if (variablePath.node.id.type === 'ObjectPattern') {
const pattern = variablePath.get(
'id'
) as NodePath<BabelTypes.ObjectPattern>
const beforeCount = count
const properties = pattern.get('properties')
properties.forEach((p) => {
const local = p.get(
p.node.type === 'ObjectProperty'
? 'value'
: p.node.type === 'RestElement'
? 'argument'
: (function () {
throw new Error('invariant')
})()
) as NodePath<BabelTypes.Identifier>
if (refs.has(local) && !isIdentifierReferenced(local)) {
++count
p.remove()
}
})
if (
beforeCount !== count &&
pattern.get('properties').length < 1
) {
variablePath.remove()
}
} else if (variablePath.node.id.type === 'ArrayPattern') {
const pattern = variablePath.get(
'id'
) as NodePath<BabelTypes.ArrayPattern>
const beforeCount = count
const elements = pattern.get('elements')
elements.forEach((e) => {
let local: NodePath<BabelTypes.Identifier>
if (e.node?.type === 'Identifier') {
local = e as NodePath<BabelTypes.Identifier>
} else if (e.node?.type === 'RestElement') {
local = e.get(
'argument'
) as NodePath<BabelTypes.Identifier>
} else {
return
}
if (refs.has(local) && !isIdentifierReferenced(local)) {
++count
e.remove()
}
})
if (
beforeCount !== count &&
pattern.get('elements').length < 1
) {
variablePath.remove()
}
}
},
FunctionDeclaration: sweepFunction,
FunctionExpression: sweepFunction,
ArrowFunctionExpression: sweepFunction,
ImportSpecifier: sweepImport,
ImportDefaultSpecifier: sweepImport,
ImportNamespaceSpecifier: sweepImport,
})
} while (count)
decorateSsgExport(t, path, state)
},
},
},
}
}
|