n8n/packages/cli/commands/start.ts

255 lines
7.3 KiB
TypeScript
Raw Normal View History

2019-08-28 06:28:47 -07:00
import * as localtunnel from 'localtunnel';
import {
TUNNEL_SUBDOMAIN_ENV,
2019-08-28 06:28:47 -07:00
UserSettings,
} from 'n8n-core';
2019-08-28 06:28:47 -07:00
import { Command, flags } from '@oclif/command';
2019-06-23 03:35:23 -07:00
const open = require('open');
2019-08-28 06:28:47 -07:00
import * as config from '../config';
2019-06-23 03:35:23 -07:00
import {
ActiveExecutions,
2019-06-23 03:35:23 -07:00
ActiveWorkflowRunner,
CredentialsOverwrites,
2020-10-22 06:46:03 -07:00
CredentialTypes,
2020-12-31 01:42:16 -08:00
DatabaseType,
2019-06-23 03:35:23 -07:00
Db,
ExternalHooks,
2019-06-23 03:35:23 -07:00
GenericHelpers,
LoadNodesAndCredentials,
NodeTypes,
Server,
TestWebhooks,
2019-06-23 03:35:23 -07:00
} from "../src";
let activeWorkflowRunner: ActiveWorkflowRunner.ActiveWorkflowRunner | undefined;
let processExistCode = 0;
2019-06-23 03:35:23 -07:00
2019-08-28 06:28:47 -07:00
export class Start extends Command {
static description = 'Starts n8n. Makes Web-UI available and starts active workflows';
static examples = [
`$ n8n start`,
`$ n8n start --tunnel`,
`$ n8n start -o`,
`$ n8n start --tunnel -o`,
];
static flags = {
help: flags.help({ char: 'h' }),
open: flags.boolean({
char: 'o',
description: 'opens the UI automatically in browser',
}),
tunnel: flags.boolean({
description: 'runs the webhooks via a hooks.n8n.cloud tunnel server. Use only for testing and development!',
}),
};
/**
* Opens the UI in browser
*/
static openBrowser() {
const editorUrl = GenericHelpers.getBaseUrl();
open(editorUrl, { wait: true })
.catch((error: Error) => {
console.log(`\nWas not able to open URL in browser. Please open manually by visiting:\n${editorUrl}\n`);
});
}
2019-06-23 03:35:23 -07:00
2019-08-28 06:28:47 -07:00
/**
* Stoppes the n8n in a graceful way.
* Make for example sure that all the webhooks from third party services
* get removed.
*/
static async stopProcess() {
console.log(`\nStopping n8n...`);
2019-06-23 03:35:23 -07:00
try {
const externalHooks = ExternalHooks();
await externalHooks.run('n8n.stop', []);
2019-06-23 03:35:23 -07:00
setTimeout(() => {
// In case that something goes wrong with shutdown we
// kill after max. 30 seconds no matter what
process.exit(processExistCode);
}, 30000);
2019-06-23 03:35:23 -07:00
const removePromises = [];
if (activeWorkflowRunner !== undefined) {
removePromises.push(activeWorkflowRunner.removeAll());
}
// Remove all test webhooks
const testWebhooks = TestWebhooks.getInstance();
removePromises.push(testWebhooks.removeAll());
await Promise.all(removePromises);
// Wait for active workflow executions to finish
const activeExecutionsInstance = ActiveExecutions.getInstance();
let executingWorkflows = activeExecutionsInstance.getActiveExecutions();
let count = 0;
while (executingWorkflows.length !== 0) {
if (count++ % 4 === 0) {
console.log(`Waiting for ${executingWorkflows.length} active executions to finish...`);
}
await new Promise((resolve) => {
setTimeout(resolve, 500);
});
executingWorkflows = activeExecutionsInstance.getActiveExecutions();
}
} catch (error) {
console.error('There was an error shutting down n8n.', error);
}
2019-08-28 06:28:47 -07:00
process.exit(processExistCode);
}
2019-06-23 03:35:23 -07:00
2019-08-28 06:28:47 -07:00
async run() {
// Make sure that n8n shuts down gracefully if possible
process.on('SIGTERM', Start.stopProcess);
process.on('SIGINT', Start.stopProcess);
2019-06-23 03:35:23 -07:00
2019-08-28 06:28:47 -07:00
const { flags } = this.parse(Start);
2019-06-23 03:35:23 -07:00
2019-08-28 06:28:47 -07:00
// Wrap that the process does not close but we can still use async
await (async () => {
2019-08-28 06:28:47 -07:00
try {
// Start directly with the init of the database to improve startup time
const startDbInitPromise = Db.init().catch(error => {
console.error(`There was an error initializing DB: ${error.message}`);
processExistCode = 1;
// @ts-ignore
process.emit('SIGINT');
});
2019-08-28 06:28:47 -07:00
// Make sure the settings exist
const userSettings = await UserSettings.prepareUserSettings();
// Load all node and credential types
const loadNodesAndCredentials = LoadNodesAndCredentials();
await loadNodesAndCredentials.init();
// Load the credentials overwrites if any exist
const credentialsOverwrites = CredentialsOverwrites();
await credentialsOverwrites.init();
// Load all external hooks
const externalHooks = ExternalHooks();
await externalHooks.init();
2019-08-28 06:28:47 -07:00
// Add the found types to an instance other parts of the application can use
const nodeTypes = NodeTypes();
await nodeTypes.init(loadNodesAndCredentials.nodeTypes);
const credentialTypes = CredentialTypes();
await credentialTypes.init(loadNodesAndCredentials.credentialTypes);
// Wait till the database is ready
await startDbInitPromise;
2020-12-31 01:42:16 -08:00
const dbType = await GenericHelpers.getConfigValue('database.type') as DatabaseType;
if (dbType === 'sqlite') {
const shouldRunVacuum = config.get('database.sqlite.executeVacuumOnStartup') as number;
if (shouldRunVacuum) {
2020-12-31 01:42:16 -08:00
Db.collections.Execution!.query("VACUUM;");
}
}
2019-08-28 06:28:47 -07:00
if (flags.tunnel === true) {
this.log('\nWaiting for tunnel ...');
let tunnelSubdomain;
if (process.env[TUNNEL_SUBDOMAIN_ENV] !== undefined && process.env[TUNNEL_SUBDOMAIN_ENV] !== '') {
tunnelSubdomain = process.env[TUNNEL_SUBDOMAIN_ENV];
} else if (userSettings.tunnelSubdomain !== undefined) {
tunnelSubdomain = userSettings.tunnelSubdomain;
}
if (tunnelSubdomain === undefined) {
2019-08-28 06:28:47 -07:00
// When no tunnel subdomain did exist yet create a new random one
const availableCharacters = 'abcdefghijklmnopqrstuvwxyz0123456789';
userSettings.tunnelSubdomain = Array.from({ length: 24 }).map(() => {
return availableCharacters.charAt(Math.floor(Math.random() * availableCharacters.length));
}).join('');
await UserSettings.writeUserSettings(userSettings);
}
2019-06-23 03:35:23 -07:00
2019-08-28 06:28:47 -07:00
const tunnelSettings: localtunnel.TunnelConfig = {
host: 'https://hooks.n8n.cloud',
subdomain: tunnelSubdomain,
2019-08-28 06:28:47 -07:00
};
2019-06-23 03:35:23 -07:00
2019-08-28 06:28:47 -07:00
const port = config.get('port') as number;
2019-06-23 03:35:23 -07:00
2019-08-28 06:28:47 -07:00
// @ts-ignore
const webhookTunnel = await localtunnel(port, tunnelSettings);
2019-06-23 03:35:23 -07:00
2019-08-28 06:28:47 -07:00
process.env.WEBHOOK_TUNNEL_URL = webhookTunnel.url + '/';
this.log(`Tunnel URL: ${process.env.WEBHOOK_TUNNEL_URL}\n`);
this.log('IMPORTANT! Do not share with anybody as it would give people access to your n8n instance!');
}
2019-06-23 03:35:23 -07:00
2019-08-28 06:28:47 -07:00
await Server.start();
2019-06-23 03:35:23 -07:00
2019-08-28 06:28:47 -07:00
// Start to get active workflows and run their triggers
activeWorkflowRunner = ActiveWorkflowRunner.getInstance();
await activeWorkflowRunner.init();
2019-06-23 03:35:23 -07:00
2019-08-28 06:28:47 -07:00
const editorUrl = GenericHelpers.getBaseUrl();
this.log(`\nEditor is now accessible via:\n${editorUrl}`);
2019-06-23 03:35:23 -07:00
2019-08-28 06:28:47 -07:00
// Allow to open n8n editor by pressing "o"
if (Boolean(process.stdout.isTTY) && process.stdin.setRawMode) {
process.stdin.setRawMode(true);
process.stdin.resume();
process.stdin.setEncoding('utf8');
let inputText = '';
2019-06-23 03:35:23 -07:00
2019-08-28 06:28:47 -07:00
if (flags.open === true) {
Start.openBrowser();
}
this.log(`\nPress "o" to open in Browser.`);
process.stdin.on("data", (key : string) => {
2019-08-28 06:28:47 -07:00
if (key === 'o') {
Start.openBrowser();
inputText = '';
} else if (key.charCodeAt(0) === 3) {
// Ctrl + c got pressed
Start.stopProcess();
} else {
// When anything else got pressed, record it and send it on enter into the child process
if (key.charCodeAt(0) === 13) {
// send to child process and print in terminal
process.stdout.write('\n');
2019-06-23 03:35:23 -07:00
inputText = '';
} else {
2019-08-28 06:28:47 -07:00
// record it and write into terminal
inputText += key;
process.stdout.write(key);
2019-06-23 03:35:23 -07:00
}
2019-08-28 06:28:47 -07:00
}
});
2019-06-23 03:35:23 -07:00
}
2019-08-28 06:28:47 -07:00
} catch (error) {
this.error(`There was an error: ${error.message}`);
2019-06-23 03:35:23 -07:00
2019-08-28 06:28:47 -07:00
processExistCode = 1;
// @ts-ignore
process.emit('SIGINT');
}
})();
}
}