n8n/packages/node-dev/src/Build.ts
कारतोफ्फेलस्क्रिप्ट™ 5db9c46043
ci: Break most of the circular dependencies in code (no-changelog) (#4990)
2022-12-21 10:46:26 +01:00

116 lines
3.7 KiB
TypeScript

/* eslint-disable @typescript-eslint/no-unsafe-argument */
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
import glob from 'fast-glob';
import { spawn } from 'child_process';
import { copyFile, mkdir, readFile, writeFile } from 'fs/promises';
import { join, dirname, resolve as resolvePath } from 'path';
import { file as tmpFile } from 'tmp-promise';
import { jsonParse } from 'n8n-workflow';
import { UserSettings } from 'n8n-core';
import type { IBuildOptions } from './Interfaces';
/**
* Create a custom tsconfig file as tsc currently has no way to define a base
* directory:
* https://github.com/Microsoft/TypeScript/issues/25430
*/
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
export async function createCustomTsconfig() {
// Get path to simple tsconfig file which should be used for build
const tsconfigPath = join(dirname(require.resolve('n8n-node-dev/src')), 'tsconfig-build.json');
// Read the tsconfig file
const tsConfigString = await readFile(tsconfigPath, { encoding: 'utf8' });
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
const tsConfig = jsonParse<{ include: string[] }>(tsConfigString);
// Set absolute include paths
const newIncludeFiles = [];
// eslint-disable-next-line no-restricted-syntax
for (const includeFile of tsConfig.include) {
newIncludeFiles.push(join(process.cwd(), includeFile));
}
tsConfig.include = newIncludeFiles;
// Write new custom tsconfig file
const { path, cleanup } = await tmpFile();
await writeFile(path, JSON.stringify(tsConfig, null, 2));
return {
path,
cleanup,
};
}
/**
* Builds and copies credentials and nodes
*
* @param {IBuildOptions} [options] Options to overwrite default behaviour
*/
export async function buildFiles({
destinationFolder = UserSettings.getUserN8nFolderCustomExtensionPath(),
watch,
}: IBuildOptions): Promise<string> {
const tscPath = join(dirname(require.resolve('typescript')), 'tsc');
const tsconfigData = await createCustomTsconfig();
await Promise.all(
['*.svg', '*.png', '*.node.json'].map(async (filenamePattern) => {
const files = await glob(`**/${filenamePattern}`);
for (const file of files) {
const src = resolvePath(process.cwd(), file);
const dest = resolvePath(destinationFolder, file);
await mkdir(dirname(dest), { recursive: true });
await copyFile(src, dest);
}
}),
);
// Supply a node base path so that it finds n8n-core and n8n-workflow
const nodeModulesPath = join(__dirname, '../../node_modules/');
let buildCommand = `${tscPath} --p ${
tsconfigData.path
} --outDir ${destinationFolder} --rootDir ${process.cwd()} --baseUrl ${nodeModulesPath}`;
if (watch) {
buildCommand += ' --watch';
}
try {
const buildProcess = spawn('node', buildCommand.split(' '), {
windowsVerbatimArguments: true,
cwd: process.cwd(),
});
// Forward the output of the child process to the main one
// that the user can see what is happening
// @ts-ignore
buildProcess.stdout.pipe(process.stdout);
// @ts-ignore
buildProcess.stderr.pipe(process.stderr);
// Make sure that the child process gets also always terminated
// when the main process does
process.on('exit', () => buildProcess.kill());
await new Promise<void>((resolve) => {
buildProcess.on('exit', resolve);
});
} catch (error) {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
let errorMessage = error.message;
if (error.stdout !== undefined) {
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
errorMessage = `${errorMessage}\nGot following output:\n${error.stdout}`;
}
throw new Error(errorMessage);
} finally {
// Remove the tmp tsconfig file
await tsconfigData.cleanup();
}
return destinationFolder;
}