Skip to content

Commit

Permalink
feat: Seclude main error handler to standalone util
Browse files Browse the repository at this point in the history
  • Loading branch information
@medikoo
medikoo committed Jan 8, 2021
1 parent b697e66 commit 847fa34
Show file tree
Hide file tree
Showing 5 changed files with 260 additions and 243 deletions.
90 changes: 0 additions & 90 deletions lib/classes/Error.js
View file
@@ -1,32 +1,11 @@
'use strict';

const chalk = require('chalk');
const { inspect } = require('util');
const { isError } = require('lodash');
const slsVersion = require('./../../package').version;
const isStandaloneExecutable = require('../utils/isStandaloneExecutable');
const sfeVersion = require('@serverless/enterprise-plugin/package.json').version;
const { sdkVersion } = require('@serverless/enterprise-plugin');

const consoleLog = (message) => {
console.log(message); // eslint-disable-line no-console
};

const resolveExceptionMeta = (exception) => {
if (isError(exception)) {
return {
name: exception.name,
title: exception.name.replace(/([A-Z])/g, ' $1'),
stack: exception.stack,
message: exception.message,
};
}
return {
title: 'Exception',
message: inspect(exception),
};
};

const writeMessage = (title, message) => {
let line = '';
while (line.length < 56 - title.length) {
Expand Down Expand Up @@ -62,75 +41,6 @@ module.exports.ServerlessError = ServerlessError;
// Deprecated - use ServerlessError instead
module.exports.SError = ServerlessError;

const userErrorNames = new Set(['ServerlessError', 'YAMLException']);

module.exports.logError = (exception, { forceExit = false, serverless } = {}) => {
const exceptionMeta = resolveExceptionMeta(exception);
const isUserError = userErrorNames.has(exceptionMeta.name);

const possiblyExit = () => {
if (forceExit) process.exit();
};

writeMessage(
exceptionMeta.title,
exceptionMeta.stack && (!isUserError || process.env.SLS_DEBUG)
? exceptionMeta.stack
: exceptionMeta.message
);

if (!isUserError && !process.env.SLS_DEBUG) {
const debugInfo = [
' ',
' For debugging logs, run again after setting the',
' "SLS_DEBUG=*" environment variable.',
].join('');
consoleLog(chalk.red(debugInfo));
consoleLog(' ');
}

const platform = process.platform;
const nodeVersion = process.version.replace(/^[v|V]/, '');

consoleLog(chalk.yellow(' Get Support --------------------------------------------'));
consoleLog(`${chalk.yellow(' Docs: ')}${'docs.serverless.com'}`);
consoleLog(`${chalk.yellow(' Bugs: ')}${'github.com/serverless/serverless/issues'}`);
consoleLog(`${chalk.yellow(' Issues: ')}${'forum.serverless.com'}`);

consoleLog(' ');
consoleLog(chalk.yellow(' Your Environment Information ---------------------------'));
consoleLog(chalk.yellow(` Operating System: ${platform}`));
consoleLog(chalk.yellow(` Node Version: ${nodeVersion}`));

const installationModePostfix = (() => {
if (isStandaloneExecutable) return ' (standalone)';
if (serverless && serverless.isLocallyInstalled) return ' (local)';
return '';
})();
consoleLog(
chalk.yellow(` Framework Version: ${slsVersion}${installationModePostfix}`)
);
consoleLog(chalk.yellow(` Plugin Version: ${sfeVersion}`));
consoleLog(chalk.yellow(` SDK Version: ${sdkVersion}`));

// only show components version if user is running Node 8+
const userNodeVersion = Number(process.version.split('.')[0].slice(1));
if (userNodeVersion >= 8) {
const componentsVersion = (() => {
try {
return require('@serverless/components/package').version;
} catch (error) {
return 'Unavailable';
}
})();
consoleLog(chalk.yellow(` Components Version: ${componentsVersion}`));
}
consoleLog(' ');

process.exitCode = 1;
possiblyExit();
};

module.exports.logWarning = (message) => {
if (process.env.SLS_WARNING_DISABLE) {
return;
Expand Down
110 changes: 110 additions & 0 deletions lib/cli/handle-error.js
View file
@@ -0,0 +1,110 @@
'use strict';

const path = require('path');
const { inspect } = require('util');
const isError = require('type/error/is');
const isObject = require('type/object/is');
const chalk = require('chalk');
const isStandaloneExecutable = require('../utils/isStandaloneExecutable');
const resolveLocalServerlessPath = require('./resolve-local-serverless-path');
const slsVersion = require('./../../package').version;
const sfeVersion = require('@serverless/enterprise-plugin/package.json').version;
const { sdkVersion } = require('@serverless/enterprise-plugin');

const userErrorNames = new Set(['ServerlessError', 'YAMLException']);
const serverlessPath = path.resolve(__dirname, '../Serverless.js');

const resolveExceptionMeta = (exception) => {
if (isError(exception)) {
return {
name: exception.name,
title: exception.name.replace(/([A-Z])/g, ' $1'),
stack: exception.stack,
message: exception.message,
};
}
return {
title: 'Exception',
message: inspect(exception),
};
};

const consoleLog = (message) => process.stdout.write(`${message}\n`);

const writeMessage = (title, message) => {
let line = '';
while (line.length < 56 - title.length) {
line = `${line}-`;
}

process.stdout.write(' \n');
consoleLog(chalk.yellow(` ${title} ${line}`));
consoleLog(' ');

if (message) {
consoleLog(` ${message.split('\n').join('\n ')}`);
}

consoleLog(' ');
};

module.exports = async (exception, options = {}) => {
if (!isObject(options)) options = {};
const { isUncaughtException, isLocallyInstalled } = options;
const exceptionMeta = resolveExceptionMeta(exception);
const isUserError = !isUncaughtException && userErrorNames.has(exceptionMeta.name);

writeMessage(
exceptionMeta.title,
exceptionMeta.stack && (!isUserError || process.env.SLS_DEBUG)
? exceptionMeta.stack
: exceptionMeta.message
);

if (!isUserError && !process.env.SLS_DEBUG) {
const debugInfo = [
' ',
' For debugging logs, run again after setting the',
' "SLS_DEBUG=*" environment variable.',
].join('');
consoleLog(chalk.red(debugInfo));
consoleLog(' ');
}

const platform = process.platform;
const nodeVersion = process.version.replace(/^[v|V]/, '');

consoleLog(chalk.yellow(' Get Support --------------------------------------------'));
consoleLog(`${chalk.yellow(' Docs: ')}docs.serverless.com`);
consoleLog(`${chalk.yellow(' Bugs: ')}github.com/serverless/serverless/issues`);
consoleLog(`${chalk.yellow(' Issues: ')}forum.serverless.com`);

consoleLog(' ');
consoleLog(chalk.yellow(' Your Environment Information ---------------------------'));
consoleLog(chalk.yellow(` Operating System: ${platform}`));
consoleLog(chalk.yellow(` Node Version: ${nodeVersion}`));

const installationModePostfix = await (async () => {
if (isStandaloneExecutable) return ' (standalone)';
if (isLocallyInstalled != null) return isLocallyInstalled ? ' (local)' : '';
return serverlessPath === (await resolveLocalServerlessPath()) ? ' (local)' : '';
})();
consoleLog(
chalk.yellow(` Framework Version: ${slsVersion}${installationModePostfix}`)
);
consoleLog(chalk.yellow(` Plugin Version: ${sfeVersion}`));
consoleLog(chalk.yellow(` SDK Version: ${sdkVersion}`));

const componentsVersion = (() => {
try {
return require('@serverless/components/package').version;
} catch (error) {
return 'Unavailable';
}
})();
consoleLog(chalk.yellow(` Components Version: ${componentsVersion}`));
consoleLog(' ');

process.exitCode = 1;
if (isUncaughtException) process.exit();
};
86 changes: 46 additions & 40 deletions scripts/serverless.js
View file
Expand Up @@ -13,56 +13,62 @@ if (require('../lib/utils/tabCompletion/isSupported') && process.argv[2] === 'co
return;
}

const logError = require('../lib/classes/Error').logError;
const handleError = require('../lib/cli/handle-error');

let serverless;

process.on('uncaughtException', (error) => logError(error, { forceExit: true, serverless }));
process.once('uncaughtException', (error) =>
handleError(error, {
isUncaughtException: true,
isLocallyInstalled: serverless && serverless.isLocallyInstalled,
})
);

const processSpanPromise = (async () => {
const wait = require('timers-ext/promise/sleep');
await wait(); // Ensure access to "processSpanPromise"
require('../lib/utils/analytics').sendPending({
serverlessExecutionSpan: processSpanPromise,
});

const BbPromise = require('bluebird');
const uuid = require('uuid');

const invocationId = uuid.v4();
if (process.env.SLS_DEBUG) {
// For performance reasons enabled only in SLS_DEBUG mode
BbPromise.config({
longStackTraces: true,
try {
const wait = require('timers-ext/promise/sleep');
await wait(); // Ensure access to "processSpanPromise"
require('../lib/utils/analytics').sendPending({
serverlessExecutionSpan: processSpanPromise,
});
}

const Serverless = require('../lib/Serverless');
serverless = new Serverless();
const BbPromise = require('bluebird');
const uuid = require('uuid');

try {
serverless.onExitPromise = processSpanPromise;
serverless.invocationId = invocationId;
await serverless.init();
if (serverless.invokedInstance) serverless = serverless.invokedInstance;
await serverless.run();
} catch (error) {
// If Enterprise Plugin, capture error
let enterpriseErrorHandler = null;
serverless.pluginManager.plugins.forEach((p) => {
if (p.enterprise && p.enterprise.errorHandler) {
enterpriseErrorHandler = p.enterprise.errorHandler;
}
});
if (!enterpriseErrorHandler) {
logError(error, { serverless });
return;
const invocationId = uuid.v4();
if (process.env.SLS_DEBUG) {
// For performance reasons enabled only in SLS_DEBUG mode
BbPromise.config({
longStackTraces: true,
});
}

const Serverless = require('../lib/Serverless');
serverless = new Serverless();

try {
await enterpriseErrorHandler(error, invocationId);
} catch (enterpriseErrorHandlerError) {
process.stdout.write(`${enterpriseErrorHandlerError.stack}\n`);
serverless.onExitPromise = processSpanPromise;
serverless.invocationId = invocationId;
await serverless.init();
if (serverless.invokedInstance) serverless = serverless.invokedInstance;
await serverless.run();
} catch (error) {
// If Enterprise Plugin, capture error
let enterpriseErrorHandler = null;
serverless.pluginManager.plugins.forEach((p) => {
if (p.enterprise && p.enterprise.errorHandler) {
enterpriseErrorHandler = p.enterprise.errorHandler;
}
});
if (!enterpriseErrorHandler) throw error;
try {
await enterpriseErrorHandler(error, invocationId);
} catch (enterpriseErrorHandlerError) {
process.stdout.write(`${enterpriseErrorHandlerError.stack}\n`);
}
throw error;
}
logError(error, { serverless });
} catch (error) {
handleError(error);
}
})();

0 comments on commit 847fa34

Please sign in to comment.