Initial commit to release

packages/cli/src/ResponseHelper.ts

@@ -0,0 +1,176 @@
+import { Request, Response } from 'express';
+import { parse, stringify } from 'flatted';
+
+import {
+	IExecutionDb,
+	IExecutionFlatted,
+	IExecutionFlattedDb,
+	IExecutionResponse,
+	IWorkflowDb,
+} from './';
+
+/**
+ * Special Error which allows to return also an error code and http status code
+ *
+ * @export
+ * @class ReponseError
+ * @extends {Error}
+ */
+export class ReponseError extends Error {
+
+	// The HTTP status code of  response
+	httpStatusCode?: number;
+
+	// The error code in the resonse
+	errorCode?: number;
+
+	/**
+	 * Creates an instance of ReponseError.
+	 * @param {string} message The error message
+	 * @param {number} [errorCode] The error code which can be used by frontend to identify the actual error
+	 * @param {number} [httpStatusCode] The HTTP status code the response should have
+	 * @memberof ReponseError
+	 */
+	constructor(message: string, errorCode?: number, httpStatusCode?: number) {
+		super(message);
+		this.name = 'ReponseError';
+
+		if (errorCode) {
+			this.errorCode = errorCode;
+		}
+		if (httpStatusCode) {
+			this.httpStatusCode = httpStatusCode;
+		}
+	}
+}
+
+
+export function sendSuccessResponse(res: Response, data: any, raw?: boolean) { // tslint:disable-line:no-any
+	res.setHeader('Content-Type', 'application/json');
+
+	if (raw === true) {
+		res.send(JSON.stringify(data));
+		return;
+	} else {
+		res.send(JSON.stringify({
+			data
+		}));
+	}
+}
+
+
+export function sendErrorResponse(res: Response, error: ReponseError) {
+	let httpStatusCode = 500;
+	if (error.httpStatusCode) {
+		httpStatusCode = error.httpStatusCode;
+	}
+
+	if (process.env.NODE_ENV !== 'production') {
+		console.error('ERROR RESPONSE');
+		console.error(error);
+	}
+
+	const response = {
+		code: 0,
+		message: 'Unknown error',
+	};
+
+	if (error.errorCode) {
+		response.code = error.errorCode;
+	}
+	if (error.message) {
+		response.message = error.message;
+	}
+	if (error.stack && process.env.NODE_ENV !== 'production') {
+		// @ts-ignore
+		response.stack = error.stack;
+	}
+
+	res.status(httpStatusCode).send(JSON.stringify(response));
+}
+
+
+/**
+ * A helper function which does not just allow to return Promises it also makes sure that
+ * all the responses have the same format
+ *
+ *
+ * @export
+ * @param {(req: Request, res: Response) => Promise<any>} processFunction The actual function to process the request
+ * @returns
+ */
+
+export function send(processFunction: (req: Request, res: Response) => Promise<any>) { // tslint:disable-line:no-any
+
+	return async (req: Request, res: Response) => {
+		try {
+			const data = await processFunction(req, res);
+
+			// Success response
+			sendSuccessResponse(res, data);
+		} catch (error) {
+			// Error response
+			sendErrorResponse(res, error);
+		}
+	};
+}
+
+
+/**
+ * Flattens the Execution data.
+ * As it contains a lot of references which normally would be saved as duplicate data
+ * with regular JSON.stringify it gets flattened which keeps the references in place.
+ *
+ * @export
+ * @param {IExecutionDb} fullExecutionData The data to flatten
+ * @returns {IExecutionFlatted}
+ */
+export function flattenExecutionData(fullExecutionData: IExecutionDb): IExecutionFlatted {
+	// Flatten the data
+	const returnData: IExecutionFlatted = Object.assign({}, {
+		data: stringify(fullExecutionData.data),
+		mode: fullExecutionData.mode,
+		startedAt: fullExecutionData.startedAt,
+		stoppedAt: fullExecutionData.stoppedAt,
+		finished: fullExecutionData.finished ? fullExecutionData.finished : false,
+		workflowId: fullExecutionData.workflowId,
+		workflowData: fullExecutionData.workflowData!,
+	});
+
+	if (fullExecutionData.id !== undefined) {
+		returnData.id = fullExecutionData.id!.toString();
+	}
+
+	if (fullExecutionData.retryOf !== undefined) {
+		returnData.retryOf = fullExecutionData.retryOf!.toString();
+	}
+
+	if (fullExecutionData.retrySuccessId !== undefined) {
+		returnData.retrySuccessId = fullExecutionData.retrySuccessId!.toString();
+	}
+
+	return returnData;
+}
+
+
+/**
+ * Unflattens the Execution data.
+ *
+ * @export
+ * @param {IExecutionFlattedDb} fullExecutionData The data to unflatten
+ * @returns {IExecutionResponse}
+ */
+export function unflattenExecutionData(fullExecutionData: IExecutionFlattedDb): IExecutionResponse {
+
+	const returnData: IExecutionResponse = Object.assign({}, {
+		id: fullExecutionData.id.toString(),
+		workflowData: fullExecutionData.workflowData as IWorkflowDb,
+		data: parse(fullExecutionData.data),
+		mode: fullExecutionData.mode,
+		startedAt: fullExecutionData.startedAt,
+		stoppedAt: fullExecutionData.stoppedAt,
+		finished: fullExecutionData.finished ? fullExecutionData.finished : false
+	});
+
+	return returnData;
+}