|
| 1 | +import type { NextConfigComplete } from '../../server/config-shared' |
| 2 | +import type { __ApiPreviewProps } from '../../server/api-utils' |
| 3 | + |
| 4 | +import { setGlobal } from '../../trace' |
| 5 | +import * as Log from '../output/log' |
| 6 | +import * as path from 'node:path' |
| 7 | +import loadConfig from '../../server/config' |
| 8 | +import { PHASE_ANALYZE } from '../../shared/lib/constants' |
| 9 | +import { turbopackAnalyze, type AnalyzeContext } from '../turbopack-analyze' |
| 10 | +import { durationToString } from '../duration-to-string' |
| 11 | +import { cp, writeFile, mkdir } from 'node:fs/promises' |
| 12 | +import { |
| 13 | + collectAppFiles, |
| 14 | + collectPagesFiles, |
| 15 | + createPagesMapping, |
| 16 | +} from '../entries' |
| 17 | +import { createValidFileMatcher } from '../../server/lib/find-page-file' |
| 18 | +import { findPagesDir } from '../../lib/find-pages-dir' |
| 19 | +import { PAGE_TYPES } from '../../lib/page-types' |
| 20 | +import loadCustomRoutes from '../../lib/load-custom-routes' |
| 21 | +import { generateRoutesManifest } from '../generate-routes-manifest' |
| 22 | +import { checkIsAppPPREnabled } from '../../server/lib/experimental/ppr' |
| 23 | +import { normalizeAppPath } from '../../shared/lib/router/utils/app-paths' |
| 24 | +import http from 'node:http' |
| 25 | + |
| 26 | +// @ts-expect-error types are in @types/serve-handler |
| 27 | +import serveHandler from 'next/dist/compiled/serve-handler' |
| 28 | +import { Telemetry } from '../../telemetry/storage' |
| 29 | +import { eventAnalyzeCompleted } from '../../telemetry/events' |
| 30 | +import { traceGlobals } from '../../trace/shared' |
| 31 | +import type { RoutesManifest } from '..' |
| 32 | + |
| 33 | +const ANALYZE_PATH = '.next/diagnostics/analyze' |
| 34 | + |
| 35 | +export type AnalyzeOptions = { |
| 36 | + dir: string |
| 37 | + reactProductionProfiling?: boolean |
| 38 | + noMangling?: boolean |
| 39 | + appDirOnly?: boolean |
| 40 | + serve?: boolean |
| 41 | + port?: number |
| 42 | +} |
| 43 | + |
| 44 | +export default async function analyze({ |
| 45 | + dir, |
| 46 | + reactProductionProfiling = false, |
| 47 | + noMangling = false, |
| 48 | + appDirOnly = false, |
| 49 | + serve = false, |
| 50 | + port = 4000, |
| 51 | +}: AnalyzeOptions): Promise<void> { |
| 52 | + try { |
| 53 | + const config: NextConfigComplete = await loadConfig(PHASE_ANALYZE, dir, { |
| 54 | + silent: false, |
| 55 | + reactProductionProfiling, |
| 56 | + }) |
| 57 | + |
| 58 | + process.env.NEXT_DEPLOYMENT_ID = config.deploymentId || '' |
| 59 | + |
| 60 | + const distDir = path.join(dir, '.next') |
| 61 | + const telemetry = new Telemetry({ distDir }) |
| 62 | + setGlobal('phase', PHASE_ANALYZE) |
| 63 | + setGlobal('distDir', distDir) |
| 64 | + setGlobal('telemetry', telemetry) |
| 65 | + |
| 66 | + Log.info('Analyzing a production build...') |
| 67 | + |
| 68 | + const analyzeContext: AnalyzeContext = { |
| 69 | + config, |
| 70 | + dir, |
| 71 | + distDir, |
| 72 | + noMangling, |
| 73 | + appDirOnly, |
| 74 | + } |
| 75 | + |
| 76 | + const { duration: analyzeDuration, shutdownPromise } = |
| 77 | + await turbopackAnalyze(analyzeContext) |
| 78 | + |
| 79 | + const durationString = durationToString(analyzeDuration) |
| 80 | + Log.event( |
| 81 | + `Analyze data created successfully in ${durationString}. To explore it, run \`next experimental-analyze --serve\`.` |
| 82 | + ) |
| 83 | + |
| 84 | + await shutdownPromise |
| 85 | + |
| 86 | + await cp( |
| 87 | + path.join(__dirname, '../../bundle-analyzer'), |
| 88 | + path.join(dir, ANALYZE_PATH), |
| 89 | + { recursive: true } |
| 90 | + ) |
| 91 | + |
| 92 | + // Collect and write routes for the bundle analyzer |
| 93 | + const routes = await collectRoutesForAnalyze(dir, config, appDirOnly) |
| 94 | + |
| 95 | + await mkdir(path.join(dir, ANALYZE_PATH, 'data'), { recursive: true }) |
| 96 | + await writeFile( |
| 97 | + path.join(dir, ANALYZE_PATH, 'data', 'routes.json'), |
| 98 | + JSON.stringify(routes, null, 2) |
| 99 | + ) |
| 100 | + |
| 101 | + telemetry.record( |
| 102 | + eventAnalyzeCompleted({ |
| 103 | + success: true, |
| 104 | + durationInSeconds: Math.round(analyzeDuration), |
| 105 | + totalPageCount: routes.length, |
| 106 | + }) |
| 107 | + ) |
| 108 | + |
| 109 | + if (serve) { |
| 110 | + await startServer(path.join(dir, ANALYZE_PATH), port) |
| 111 | + } |
| 112 | + } catch (e) { |
| 113 | + const telemetry = traceGlobals.get('telemetry') as Telemetry | undefined |
| 114 | + if (telemetry) { |
| 115 | + telemetry.record( |
| 116 | + eventAnalyzeCompleted({ |
| 117 | + success: false, |
| 118 | + }) |
| 119 | + ) |
| 120 | + } |
| 121 | + |
| 122 | + throw e |
| 123 | + } |
| 124 | +} |
| 125 | + |
| 126 | +/** |
| 127 | + * Collects all routes from the project for the bundle analyzer. |
| 128 | + * Returns a list of route paths (both static and dynamic). |
| 129 | + */ |
| 130 | +async function collectRoutesForAnalyze( |
| 131 | + dir: string, |
| 132 | + config: NextConfigComplete, |
| 133 | + appDirOnly: boolean |
| 134 | +): Promise<string[]> { |
| 135 | + const { pagesDir, appDir } = findPagesDir(dir) |
| 136 | + const validFileMatcher = createValidFileMatcher(config.pageExtensions, appDir) |
| 137 | + |
| 138 | + let appType: RoutesManifest['appType'] |
| 139 | + if (pagesDir && appDir) { |
| 140 | + appType = 'hybrid' |
| 141 | + } else if (pagesDir) { |
| 142 | + appType = 'pages' |
| 143 | + } else if (appDir) { |
| 144 | + appType = 'app' |
| 145 | + } else { |
| 146 | + throw new Error('No pages or app directory found.') |
| 147 | + } |
| 148 | + |
| 149 | + const { appPaths } = appDir |
| 150 | + ? await collectAppFiles(appDir, validFileMatcher) |
| 151 | + : { appPaths: [] } |
| 152 | + const pagesPaths = pagesDir |
| 153 | + ? await collectPagesFiles(pagesDir, validFileMatcher) |
| 154 | + : null |
| 155 | + |
| 156 | + const appMapping = await createPagesMapping({ |
| 157 | + pagePaths: appPaths, |
| 158 | + isDev: false, |
| 159 | + pagesType: PAGE_TYPES.APP, |
| 160 | + pageExtensions: config.pageExtensions, |
| 161 | + pagesDir, |
| 162 | + appDir, |
| 163 | + appDirOnly, |
| 164 | + }) |
| 165 | + |
| 166 | + const pagesMapping = pagesPaths |
| 167 | + ? await createPagesMapping({ |
| 168 | + pagePaths: pagesPaths, |
| 169 | + isDev: false, |
| 170 | + pagesType: PAGE_TYPES.PAGES, |
| 171 | + pageExtensions: config.pageExtensions, |
| 172 | + pagesDir, |
| 173 | + appDir, |
| 174 | + appDirOnly, |
| 175 | + }) |
| 176 | + : null |
| 177 | + |
| 178 | + const pageKeys = { |
| 179 | + pages: pagesMapping ? Object.keys(pagesMapping) : [], |
| 180 | + app: appMapping |
| 181 | + ? Object.keys(appMapping).map((key) => normalizeAppPath(key)) |
| 182 | + : undefined, |
| 183 | + } |
| 184 | + |
| 185 | + // Load custom routes |
| 186 | + const { redirects, headers, rewrites } = await loadCustomRoutes(config) |
| 187 | + |
| 188 | + // Compute restricted redirect paths |
| 189 | + const restrictedRedirectPaths = ['/_next'].map((pathPrefix) => |
| 190 | + config.basePath ? `${config.basePath}${pathPrefix}` : pathPrefix |
| 191 | + ) |
| 192 | + |
| 193 | + const isAppPPREnabled = checkIsAppPPREnabled(config.experimental.ppr) |
| 194 | + |
| 195 | + // Generate routes manifest |
| 196 | + const { routesManifest } = generateRoutesManifest({ |
| 197 | + appType, |
| 198 | + pageKeys, |
| 199 | + config, |
| 200 | + redirects, |
| 201 | + headers, |
| 202 | + rewrites, |
| 203 | + restrictedRedirectPaths, |
| 204 | + isAppPPREnabled, |
| 205 | + }) |
| 206 | + |
| 207 | + return routesManifest.dynamicRoutes |
| 208 | + .map((r) => r.page) |
| 209 | + .concat(routesManifest.staticRoutes.map((r) => r.page)) |
| 210 | +} |
| 211 | + |
| 212 | +function startServer(dir: string, port: number): Promise<void> { |
| 213 | + const server = http.createServer((req, res) => { |
| 214 | + return serveHandler(req, res, { |
| 215 | + public: dir, |
| 216 | + }) |
| 217 | + }) |
| 218 | + |
| 219 | + return new Promise((resolve, reject) => { |
| 220 | + function onError(err: Error) { |
| 221 | + server.close(() => { |
| 222 | + reject(err) |
| 223 | + }) |
| 224 | + } |
| 225 | + |
| 226 | + server.on('error', onError) |
| 227 | + |
| 228 | + server.listen(port, () => { |
| 229 | + const address = server.address() |
| 230 | + if (address == null) { |
| 231 | + reject(new Error('Unable to get server address')) |
| 232 | + return |
| 233 | + } |
| 234 | + |
| 235 | + // No longer needed after startup |
| 236 | + server.removeListener('error', onError) |
| 237 | + |
| 238 | + let addressString |
| 239 | + if (typeof address === 'string') { |
| 240 | + addressString = address |
| 241 | + } else { |
| 242 | + addressString = `${address.address === '::' ? 'localhost' : address.address}:${address.port}` |
| 243 | + } |
| 244 | + |
| 245 | + Log.info(`Bundle analyzer available at http://${addressString}`) |
| 246 | + resolve() |
| 247 | + }) |
| 248 | + }) |
| 249 | +} |
0 commit comments