chore: move build utilities to Compiler class (#10904)
Fixes: FRMW-2866
This commit is contained in:
Harminder Virk authored and 
GitHub committed
1 parent
c1930bd656
commit
428fce5313
5 files changed
+389
-273
No files matched your search
@@ -1,273 +1,7 @@
|
||||
import path from "path"
|
||||
import { access, constants, copyFile, rm } from "node:fs/promises"
|
||||
import type tsStatic from "typescript"
|
||||
import { logger } from "@medusajs/framework/logger"
|
||||
import { ConfigModule } from "@medusajs/framework/types"
|
||||
import { getConfigFile } from "@medusajs/framework/utils"
|
||||
import {
|
||||
ADMIN_ONLY_OUTPUT_DIR,
|
||||
ADMIN_RELATIVE_OUTPUT_DIR,
|
||||
ADMIN_SOURCE_DIR,
|
||||
} from "../utils"
|
||||
import { Compiler } from "@medusajs/framework/build-tools"
|
||||
|
||||
const INTEGRATION_TESTS_FOLDER = "integration-tests"
|
||||
|
||||
function computeDist(
|
||||
projectRoot: string,
|
||||
tsConfig: { options: { outDir?: string } }
|
||||
): string {
|
||||
const distFolder = tsConfig.options.outDir ?? ".medusa/server"
|
||||
return path.isAbsolute(distFolder)
|
||||
? distFolder
|
||||
: path.join(projectRoot, distFolder)
|
||||
}
|
||||
|
||||
async function loadTsConfig(projectRoot: string) {
|
||||
const ts = await import("typescript")
|
||||
const tsConfig = parseTSConfig(projectRoot, ts)
|
||||
if (!tsConfig) {
|
||||
logger.error("Unable to compile backend source")
|
||||
return false
|
||||
}
|
||||
|
||||
return tsConfig!
|
||||
}
|
||||
|
||||
/**
|
||||
* Copies the file to the destination without throwing any
|
||||
* errors if the source file is missing
|
||||
*/
|
||||
async function copy(source: string, destination: string) {
|
||||
let sourceExists = false
|
||||
try {
|
||||
await access(source, constants.F_OK)
|
||||
sourceExists = true
|
||||
} catch (error) {
|
||||
if (error.code !== "ENOENT") {
|
||||
throw error
|
||||
}
|
||||
}
|
||||
|
||||
if (sourceExists) {
|
||||
await copyFile(path.join(source), path.join(destination))
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes the directory and its children recursively and
|
||||
* ignores any errors
|
||||
*/
|
||||
async function clean(path: string) {
|
||||
await rm(path, { recursive: true }).catch(() => {})
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads the medusa config file or exits with an error
|
||||
*/
|
||||
async function loadMedusaConfig(directory: string) {
|
||||
/**
|
||||
* Parsing the medusa config file to ensure it is error
|
||||
* free
|
||||
*/
|
||||
const { configModule, configFilePath, error } =
|
||||
await getConfigFile<ConfigModule>(directory, "medusa-config")
|
||||
if (error) {
|
||||
console.error(`Failed to load medusa-config.js`)
|
||||
console.error(error)
|
||||
return
|
||||
}
|
||||
|
||||
return { configFilePath, configModule }
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses the tsconfig file or exits with an error in case
|
||||
* the file is invalid
|
||||
*/
|
||||
function parseTSConfig(projectRoot: string, ts: typeof tsStatic) {
|
||||
let tsConfigErrors: null | tsStatic.Diagnostic = null
|
||||
|
||||
const tsConfig = ts.getParsedCommandLineOfConfigFile(
|
||||
path.join(projectRoot, "tsconfig.json"),
|
||||
{
|
||||
inlineSourceMap: true,
|
||||
excludes: [],
|
||||
},
|
||||
{
|
||||
...ts.sys,
|
||||
useCaseSensitiveFileNames: true,
|
||||
getCurrentDirectory: () => projectRoot,
|
||||
onUnRecoverableConfigFileDiagnostic: (error) => (tsConfigErrors = error),
|
||||
}
|
||||
)
|
||||
|
||||
if (tsConfigErrors) {
|
||||
const compilerHost = ts.createCompilerHost({})
|
||||
console.error(
|
||||
ts.formatDiagnosticsWithColorAndContext([tsConfigErrors], compilerHost)
|
||||
)
|
||||
return
|
||||
}
|
||||
|
||||
if (tsConfig!.errors.length) {
|
||||
const compilerHost = ts.createCompilerHost({})
|
||||
console.error(
|
||||
ts.formatDiagnosticsWithColorAndContext(tsConfig!.errors, compilerHost)
|
||||
)
|
||||
return
|
||||
}
|
||||
|
||||
return tsConfig!
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the backend project using TSC
|
||||
*/
|
||||
async function buildBackend(
|
||||
projectRoot: string,
|
||||
tsConfig: tsStatic.ParsedCommandLine
|
||||
): Promise<boolean> {
|
||||
const startTime = process.hrtime()
|
||||
logger.info("Compiling backend source...")
|
||||
|
||||
const dist = computeDist(projectRoot, tsConfig)
|
||||
|
||||
logger.info(`Removing existing "${path.relative(projectRoot, dist)}" folder`)
|
||||
await clean(dist)
|
||||
|
||||
/**
|
||||
* Ignoring admin and integration tests from the compiled
|
||||
* files
|
||||
*/
|
||||
const filesToCompile = tsConfig.fileNames.filter((fileName) => {
|
||||
return (
|
||||
!fileName.includes(`${ADMIN_SOURCE_DIR}/`) &&
|
||||
!fileName.includes(`${INTEGRATION_TESTS_FOLDER}/`)
|
||||
)
|
||||
})
|
||||
|
||||
const ts = await import("typescript")
|
||||
const program = ts.createProgram(filesToCompile, {
|
||||
...tsConfig.options,
|
||||
...{
|
||||
outDir: dist,
|
||||
|
||||
/**
|
||||
* Disable inline source maps when the user has enabled
|
||||
* source maps within the config file
|
||||
*/
|
||||
inlineSourceMap: !tsConfig.options.sourceMap,
|
||||
},
|
||||
})
|
||||
|
||||
const emitResult = program.emit()
|
||||
const diagnostics = ts
|
||||
.getPreEmitDiagnostics(program)
|
||||
.concat(emitResult.diagnostics)
|
||||
|
||||
/**
|
||||
* Log errors (if any)
|
||||
*/
|
||||
if (diagnostics.length) {
|
||||
console.error(
|
||||
ts.formatDiagnosticsWithColorAndContext(
|
||||
diagnostics,
|
||||
ts.createCompilerHost({})
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Exit early if no output is written to the disk
|
||||
*/
|
||||
if (emitResult.emitSkipped) {
|
||||
logger.warn("Backend build completed without emitting any output")
|
||||
return false
|
||||
}
|
||||
|
||||
/**
|
||||
* Copying package manager files
|
||||
*/
|
||||
await copy(
|
||||
path.join(projectRoot, "package.json"),
|
||||
path.join(dist, "package.json")
|
||||
)
|
||||
await copy(path.join(projectRoot, "yarn.lock"), path.join(dist, "yarn.lock"))
|
||||
await copy(path.join(projectRoot, "pnpm.lock"), path.join(dist, "pnpm.lock"))
|
||||
await copy(
|
||||
path.join(projectRoot, "package-lock.json"),
|
||||
path.join(dist, "package-lock.json")
|
||||
)
|
||||
|
||||
const duration = process.hrtime(startTime)
|
||||
const seconds = (duration[0] + duration[1] / 1e9).toFixed(2)
|
||||
|
||||
if (diagnostics.length) {
|
||||
logger.warn(`Backend build completed with errors (${seconds}s)`)
|
||||
} else {
|
||||
logger.info(`Backend build completed successfully (${seconds}s)`)
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the frontend project using the "@medusajs/admin-bundler"
|
||||
*/
|
||||
async function buildFrontend(
|
||||
projectRoot: string,
|
||||
adminOnly: boolean,
|
||||
tsConfig: tsStatic.ParsedCommandLine
|
||||
): Promise<boolean> {
|
||||
const startTime = process.hrtime()
|
||||
const configFile = await loadMedusaConfig(projectRoot)
|
||||
if (!configFile) {
|
||||
return false
|
||||
}
|
||||
|
||||
const dist = computeDist(projectRoot, tsConfig)
|
||||
|
||||
const adminOutputPath = adminOnly
|
||||
? path.join(projectRoot, ADMIN_ONLY_OUTPUT_DIR)
|
||||
: path.join(dist, ADMIN_RELATIVE_OUTPUT_DIR)
|
||||
|
||||
const adminSource = path.join(projectRoot, ADMIN_SOURCE_DIR)
|
||||
const adminOptions = {
|
||||
disable: false,
|
||||
sources: [adminSource],
|
||||
...configFile.configModule.admin,
|
||||
outDir: adminOutputPath,
|
||||
}
|
||||
|
||||
if (adminOptions.disable && !adminOnly) {
|
||||
return false
|
||||
}
|
||||
|
||||
if (!adminOptions.disable && adminOnly) {
|
||||
logger.warn(
|
||||
`You are building using the flag --admin-only but the admin is enabled in your medusa-config, If you intend to host the dashboard separately you should disable the admin in your medusa config`
|
||||
)
|
||||
}
|
||||
|
||||
try {
|
||||
logger.info("Compiling frontend source...")
|
||||
const { build: buildProductionBuild } = await import(
|
||||
"@medusajs/admin-bundler"
|
||||
)
|
||||
await buildProductionBuild(adminOptions)
|
||||
const duration = process.hrtime(startTime)
|
||||
const seconds = (duration[0] + duration[1] / 1e9).toFixed(2)
|
||||
|
||||
logger.info(`Frontend build completed successfully (${seconds}s)`)
|
||||
return true
|
||||
} catch (error) {
|
||||
logger.error("Unable to compile frontend source")
|
||||
console.error(error)
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
export default async function ({
|
||||
export default async function build({
|
||||
directory,
|
||||
adminOnly,
|
||||
}: {
|
||||
@@ -275,20 +9,21 @@ export default async function ({
|
||||
adminOnly: boolean
|
||||
}): Promise<boolean> {
|
||||
logger.info("Starting build...")
|
||||
const compiler = new Compiler(directory, logger)
|
||||
|
||||
const tsConfig = await loadTsConfig(directory)
|
||||
const tsConfig = await compiler.loadTSConfigFile()
|
||||
if (!tsConfig) {
|
||||
logger.error("Unable to compile application")
|
||||
return false
|
||||
}
|
||||
|
||||
const promises: Promise<any>[] = []
|
||||
|
||||
if (!adminOnly) {
|
||||
promises.push(buildBackend(directory, tsConfig))
|
||||
promises.push(compiler.buildAppBackend(tsConfig))
|
||||
}
|
||||
|
||||
promises.push(buildFrontend(directory, adminOnly, tsConfig))
|
||||
|
||||
const bundler = await import("@medusajs/admin-bundler")
|
||||
promises.push(compiler.buildAppFrontend(adminOnly, tsConfig, bundler))
|
||||
await Promise.all(promises)
|
||||
return true
|
||||
}
|
||||
Reference in new issue
Block a user