mirror of
https://github.com/sourcegraph/sourcegraph.git
synced 2026-02-06 15:51:43 +00:00
7984c4abde
This file is produced by both Webpack and esbuild. It is not Webpack-specific. ``` fastmod -e yaml,ts,js,md,tsx WEBPACK_MANIFEST WEB_BUILD_MANIFEST fastmod -e yaml,ts,js,md,tsx,go webpack.manifest.json web.manifest.json fastmod -e yaml,ts,js,md,tsx,go webpackManifestPath webBuildManifestPath fastmod -e yaml,ts,js,md,tsx,go 'webpack manifest' 'web build manifest' fastmod -e go,ts,tsx webpackManifest webBuildManifest fastmod -e go,ts,tsx WebpackManifest WebBuildManifest # not all accepted ```
113 lines
4.1 KiB
TypeScript
113 lines
4.1 KiB
TypeScript
import { readFileSync, writeFileSync } from 'fs'
|
|
import path from 'path'
|
|
|
|
import type { WebpackPluginFunction } from 'webpack'
|
|
|
|
import type { SourcegraphContext } from '../../src/jscontext'
|
|
|
|
import { createJsContext, ENVIRONMENT_CONFIG, HTTPS_WEB_SERVER_URL, STATIC_INDEX_PATH } from '.'
|
|
|
|
const { NODE_ENV, STATIC_ASSETS_PATH } = ENVIRONMENT_CONFIG
|
|
|
|
export const WEB_BUILD_MANIFEST_PATH = path.resolve(STATIC_ASSETS_PATH, 'web.manifest.json')
|
|
export const HTML_INDEX_PATH = path.resolve(STATIC_ASSETS_PATH, 'index.html')
|
|
|
|
export const getWebBuildManifest = (): WebBuildManifest =>
|
|
JSON.parse(readFileSync(WEB_BUILD_MANIFEST_PATH, 'utf-8')) as WebBuildManifest
|
|
|
|
export interface WebBuildManifest {
|
|
/** Main app entry JS bundle */
|
|
'app.js': string
|
|
/** Main app entry CSS bundle, only used in production mode */
|
|
'app.css'?: string
|
|
/** Runtime bundle, only used in development mode */
|
|
'runtime.js'?: string
|
|
/** React entry bundle, only used in production mode */
|
|
'react.js'?: string
|
|
/** Opentelemetry entry bundle, only used in production mode */
|
|
'opentelemetry.js'?: string
|
|
/** If script files should be treated as JS modules. Required for esbuild bundle. */
|
|
isModule?: boolean
|
|
/** The node env value `production | development` */
|
|
environment?: 'development' | 'production'
|
|
}
|
|
|
|
interface GetHTMLPageOptions {
|
|
manifestFile: WebBuildManifest
|
|
/**
|
|
* Used to inject dummy `window.context` in integration tests.
|
|
*/
|
|
jsContext?: SourcegraphContext
|
|
/**
|
|
* Used to inject `window.context` received from the API proxy.
|
|
*/
|
|
jsContextScript?: string
|
|
}
|
|
|
|
/**
|
|
* Returns an HTML page similar to `cmd/frontend/internal/app/ui/app.html` but when running
|
|
* without the `frontend` service.
|
|
*
|
|
* Note: This page should be kept as close as possible to `app.html` to avoid any inconsistencies
|
|
* between our development server and the actual production server.
|
|
*/
|
|
export function getIndexHTML(options: GetHTMLPageOptions): string {
|
|
const { manifestFile, jsContext, jsContextScript } = options
|
|
|
|
const {
|
|
'app.js': appBundle,
|
|
'app.css': cssBundle,
|
|
'runtime.js': runtimeBundle,
|
|
'react.js': reactBundle,
|
|
'opentelemetry.js': oTelBundle,
|
|
isModule,
|
|
} = manifestFile
|
|
|
|
return `
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>Sourcegraph</title>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, viewport-fit=cover" />
|
|
<meta name="referrer" content="origin-when-cross-origin"/>
|
|
<meta name="color-scheme" content="light dark"/>
|
|
${cssBundle ? `<link rel="stylesheet" href="${cssBundle}">` : ''}
|
|
${
|
|
ENVIRONMENT_CONFIG.SOURCEGRAPHDOTCOM_MODE
|
|
? '<script src="https://js.sentry-cdn.com/ae2f74442b154faf90b5ff0f7cd1c618.min.js" crossorigin="anonymous"></script>'
|
|
: ''
|
|
}
|
|
</head>
|
|
<body>
|
|
<div id="root"></div>
|
|
<script>
|
|
// Optional value useful for checking if index.html is created by HtmlWebpackPlugin with the right NODE_ENV.
|
|
window.webpackBuildEnvironment = '${NODE_ENV}'
|
|
|
|
${
|
|
jsContextScript ||
|
|
`
|
|
// Required mock of the JS context object.
|
|
window.context = ${JSON.stringify(
|
|
jsContext ?? createJsContext({ sourcegraphBaseUrl: `${HTTPS_WEB_SERVER_URL}` })
|
|
)}
|
|
`
|
|
}
|
|
</script>
|
|
|
|
${runtimeBundle ? `<script src="${runtimeBundle}"></script>` : ''}
|
|
${reactBundle ? `<script src="${reactBundle}" ${isModule ? 'type="module"' : ''}></script>` : ''}
|
|
${oTelBundle ? `<script src="${oTelBundle}" ${isModule ? 'type="module"' : ''}></script>` : ''}
|
|
<script src="${appBundle}" ${isModule ? 'type="module"' : ''}></script>
|
|
</body>
|
|
</html>
|
|
`
|
|
}
|
|
|
|
export const writeIndexHTMLPlugin: WebpackPluginFunction = compiler => {
|
|
compiler.hooks.done.tap('WriteIndexHTMLPlugin', () => {
|
|
writeFileSync(STATIC_INDEX_PATH, getIndexHTML({ manifestFile: getWebBuildManifest() }), 'utf-8')
|
|
})
|
|
}
|