|
| 1 | +import esbuild from 'esbuild'; |
| 2 | +import copy from 'esbuild-plugin-copy'; |
| 3 | +import { wasmLoader } from 'esbuild-plugin-wasm'; |
| 4 | +import path from 'path'; |
| 5 | +import fs from 'fs'; |
| 6 | +import { fileURLToPath } from 'url'; |
| 7 | + |
| 8 | +const __filename = fileURLToPath(import.meta.url); |
| 9 | +const __dirname = path.dirname(__filename); |
| 10 | + |
| 11 | +const isProduction = process.env.NODE_ENV === 'production'; |
| 12 | + |
| 13 | +function generateHtmlPlugin(options) { |
| 14 | + return { |
| 15 | + name: 'firefox-profiler-generate-html', |
| 16 | + setup(build) { |
| 17 | + const { outdir, publicPath } = build.initialOptions; |
| 18 | + build.initialOptions.metafile = true; |
| 19 | + build.onEnd(async (result) => { |
| 20 | + await generateHTML(result.metafile, { ...options, outdir, publicPath }); |
| 21 | + }); |
| 22 | + }, |
| 23 | + }; |
| 24 | +} |
| 25 | + |
| 26 | +const baseConfig = { |
| 27 | + bundle: true, |
| 28 | + minify: isProduction, |
| 29 | + absWorkingDir: __dirname, |
| 30 | + loader: { |
| 31 | + '.png': 'file', |
| 32 | + '.jpg': 'file', |
| 33 | + '.svg': 'file', |
| 34 | + '.worker.js': 'file', |
| 35 | + }, |
| 36 | + alias: { |
| 37 | + 'firefox-profiler': './src', |
| 38 | + 'firefox-profiler-res': './res', |
| 39 | + }, |
| 40 | +}; |
| 41 | + |
| 42 | +const templateHTML = fs.readFileSync( |
| 43 | + path.join(__dirname, 'res/index.html'), |
| 44 | + 'utf8' |
| 45 | +); |
| 46 | + |
| 47 | +export const mainBundleConfig = { |
| 48 | + ...baseConfig, |
| 49 | + format: 'esm', |
| 50 | + platform: 'browser', |
| 51 | + target: 'es2022', |
| 52 | + sourcemap: true, |
| 53 | + splitting: true, |
| 54 | + entryPoints: ['src/index.tsx'], |
| 55 | + outdir: 'dist', |
| 56 | + metafile: true, |
| 57 | + publicPath: '/', |
| 58 | + entryNames: '[name]-[hash]', |
| 59 | + define: { |
| 60 | + 'process.env.L10N': process.env.L10N |
| 61 | + ? JSON.stringify(process.env.L10N) |
| 62 | + : 'undefined', |
| 63 | + AVAILABLE_STAGING_LOCALES: process.env.L10N |
| 64 | + ? JSON.stringify(fs.readdirSync('./locales')) |
| 65 | + : 'undefined', |
| 66 | + // no need to define NODE_ENV: |
| 67 | + // esbuild automatically defines NODE_ENV based on the value for "minify" |
| 68 | + }, |
| 69 | + external: ['zlib'], |
| 70 | + plugins: [ |
| 71 | + wasmLoader(), |
| 72 | + copy({ |
| 73 | + resolveFrom: __dirname, |
| 74 | + assets: [ |
| 75 | + { from: ['res/_headers'], to: ['dist'] }, |
| 76 | + { from: ['res/_redirects'], to: ['dist'] }, |
| 77 | + { from: ['res/contribute.json'], to: ['dist'] }, |
| 78 | + { from: ['res/robots.txt'], to: ['dist'] }, |
| 79 | + { from: ['res/service-worker-compat.js'], to: ['dist'] }, |
| 80 | + { from: ['res/img/favicon.png'], to: ['dist/res/img'] }, |
| 81 | + { from: ['docs-user/**/*'], to: ['dist/docs'] }, |
| 82 | + { from: ['locales/**/*'], to: ['dist/locales'] }, |
| 83 | + ], |
| 84 | + }), |
| 85 | + generateHtmlPlugin({ |
| 86 | + filename: 'index.html', |
| 87 | + entryPoint: 'src/index.tsx', |
| 88 | + templateHTML, |
| 89 | + }), |
| 90 | + ], |
| 91 | +}; |
| 92 | + |
| 93 | +// Common build configuration for node-based tools |
| 94 | +export const nodeBaseConfig = { |
| 95 | + ...baseConfig, |
| 96 | + platform: 'node', |
| 97 | + target: 'node16', |
| 98 | + splitting: false, |
| 99 | + format: 'cjs', |
| 100 | + bundle: true, |
| 101 | + external: ['fs', 'path', 'crypto', 'zlib'], |
| 102 | + plugins: [ |
| 103 | + wasmLoader({ |
| 104 | + mode: 'embedded', |
| 105 | + }), |
| 106 | + ], |
| 107 | +}; |
| 108 | + |
| 109 | +async function buildAll() { |
| 110 | + // Clean dist directory |
| 111 | + if (fs.existsSync('dist')) { |
| 112 | + fs.rmSync('dist', { recursive: true }); |
| 113 | + } |
| 114 | + |
| 115 | + const builds = []; |
| 116 | + |
| 117 | + // Main app build |
| 118 | + builds.push(esbuild.build(mainBundleConfig)); |
| 119 | + |
| 120 | + // Node tools (if requested) |
| 121 | + if (process.argv.includes('--node-tools')) { |
| 122 | + // Symbolicator CLI |
| 123 | + builds.push( |
| 124 | + esbuild.build({ |
| 125 | + ...nodeBaseConfig, |
| 126 | + entryPoints: ['src/symbolicator-cli/index.ts'], |
| 127 | + outfile: 'dist/symbolicator-cli.js', |
| 128 | + }) |
| 129 | + ); |
| 130 | + } |
| 131 | + |
| 132 | + // Wait for all builds to complete |
| 133 | + const buildResults = await Promise.all(builds); |
| 134 | + |
| 135 | + // Save metafile data to a file, for example to allow visualizing bundle size. |
| 136 | + if (buildResults[0].metafile) { |
| 137 | + fs.writeFileSync( |
| 138 | + 'dist/metafile.json', |
| 139 | + JSON.stringify(buildResults[0].metafile, null, 2) |
| 140 | + ); |
| 141 | + console.log('📊 Metafile saved to dist/metafile.json'); |
| 142 | + } |
| 143 | + |
| 144 | + console.log('✅ Build completed'); |
| 145 | +} |
| 146 | + |
| 147 | +async function generateHTML(metafileJson, options) { |
| 148 | + const { entryPoint, templateHTML, filename, outdir, publicPath } = options; |
| 149 | + |
| 150 | + const htmlOutputPath = outdir + '/' + filename; |
| 151 | + |
| 152 | + function convertPath(oldPath) { |
| 153 | + const prefixToStrip = outdir + '/'; |
| 154 | + |
| 155 | + if (!oldPath || !oldPath.startsWith || !oldPath.startsWith(prefixToStrip)) { |
| 156 | + throw new Error( |
| 157 | + `Unexpected path ${oldPath} which seems to be outside the outdir (which is set to ${outdir})` |
| 158 | + ); |
| 159 | + } |
| 160 | + |
| 161 | + const relativePath = oldPath.slice(prefixToStrip.length); |
| 162 | + if (publicPath) { |
| 163 | + // e.g. publicPath === '/' |
| 164 | + return publicPath + relativePath; |
| 165 | + } |
| 166 | + return relativePath; |
| 167 | + } |
| 168 | + |
| 169 | + if (!metafileJson || !metafileJson.outputs) { |
| 170 | + throw new Error('No outputs detected'); |
| 171 | + } |
| 172 | + |
| 173 | + const [mainBundlePath, mainBundle] = Object.entries( |
| 174 | + metafileJson.outputs |
| 175 | + ).find(([_bundlePath, bundle]) => bundle.entryPoint === entryPoint); |
| 176 | + |
| 177 | + const extraHeadTags = []; |
| 178 | + |
| 179 | + // Main JS bundle |
| 180 | + extraHeadTags.push( |
| 181 | + `<script src="${convertPath(mainBundlePath)}" type="module" async></script>` |
| 182 | + ); |
| 183 | + |
| 184 | + // Main Stylesheet |
| 185 | + if (mainBundle.cssBundle) { |
| 186 | + extraHeadTags.push( |
| 187 | + `<link rel="stylesheet" href="${convertPath(mainBundle.cssBundle)}">` |
| 188 | + ); |
| 189 | + } |
| 190 | + |
| 191 | + // Preload startup chunks |
| 192 | + const startupChunks = mainBundle.imports.filter( |
| 193 | + (imp) => imp.kind === 'import-statement' // as opposed to 'dynamic-import' |
| 194 | + ); |
| 195 | + for (const startupChunk of startupChunks) { |
| 196 | + extraHeadTags.push( |
| 197 | + `<link rel="modulepreload" href="${convertPath(startupChunk.path)}">` |
| 198 | + ); |
| 199 | + } |
| 200 | + |
| 201 | + // Insert tags before </head> |
| 202 | + const extraHeadStr = extraHeadTags.map((s) => ' ' + s).join('\n'); |
| 203 | + const html = templateHTML.replace( |
| 204 | + '</head>', |
| 205 | + '\n' + extraHeadStr + '\n </head>' |
| 206 | + ); |
| 207 | + |
| 208 | + // Write the final HTML |
| 209 | + fs.writeFileSync(htmlOutputPath, html); |
| 210 | +} |
| 211 | + |
| 212 | +// Run build if called directly |
| 213 | +if (import.meta.url === `file://${process.argv[1]}`) { |
| 214 | + buildAll().catch(console.error); |
| 215 | +} |
0 commit comments