@fsai-flow/workflow 0.0.2 → 0.1.0

package/src/lib/LoggerProxy.ts

@@ -1,43 +0,0 @@
-/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
-// eslint-disable-next-line import/no-cycle
-import { ILogger, LogTypes } from './Interfaces';
-
-let logger: ILogger | undefined;
-
-export function init(loggerInstance: ILogger) {
-	logger = loggerInstance;
-}
-
-export function getInstance(): ILogger {
-	if (logger === undefined) {
-		throw new Error('LoggerProxy not initialized');
-	}
-
-	return logger;
-}
-
-export function log(type: LogTypes, message: string, meta: object = {}) {
-	getInstance().log(type, message, meta);
-}
-
-// Convenience methods below
-
-export function debug(message: string, meta: object = {}) {
-	getInstance().log('debug', message, meta);
-}
-
-export function info(message: string, meta: object = {}) {
-	getInstance().log('info', message, meta);
-}
-
-export function error(message: string, meta: object = {}) {
-	getInstance().log('error', message, meta);
-}
-
-export function verbose(message: string, meta: object = {}) {
-	getInstance().log('verbose', message, meta);
-}
-
-export function warn(message: string, meta: object = {}) {
-	getInstance().log('warn', message, meta);
-}

package/src/lib/MetadataUtils.ts

@@ -1,34 +0,0 @@
-import type { ITaskMetadata } from './Interfaces';
-import { hasKey } from './utils';
-
-function responseHasSubworkflowData(
-	response: unknown,
-): response is { executionId: string; workflowId: string } {
-	return ['executionId', 'workflowId'].every(
-		(x) => hasKey(response, x) && typeof response[x] === 'string',
-	);
-}
-
-type ISubWorkflowMetadata = Required<Pick<ITaskMetadata, 'subExecution' | 'subExecutionsCount'>>;
-
-function parseErrorResponseWorkflowMetadata(response: unknown): ISubWorkflowMetadata | undefined {
-	if (!responseHasSubworkflowData(response)) return undefined;
-
-	return {
-		subExecution: {
-			executionId: response.executionId,
-			workflowId: response.workflowId,
-		},
-		subExecutionsCount: 1,
-	};
-}
-
-export function parseErrorMetadata(error: unknown): ISubWorkflowMetadata | undefined {
-	if (hasKey(error, 'errorResponse')) {
-		return parseErrorResponseWorkflowMetadata(error.errorResponse);
-	}
-
-	// This accounts for cases where the backend attaches the properties on plain errors
-	// e.g. from custom nodes throwing literal `Error` or `ApplicationError` objects directly
-	return parseErrorResponseWorkflowMetadata(error);
-}

package/src/lib/NodeErrors.ts

@@ -1,332 +0,0 @@
-/* eslint-disable @typescript-eslint/no-shadow */
-/* eslint-disable @typescript-eslint/no-unsafe-call */
-/* eslint-disable no-param-reassign */
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-/* eslint-disable @typescript-eslint/no-unsafe-return */
-/* eslint-disable @typescript-eslint/no-unsafe-assignment */
-// eslint-disable-next-line max-classes-per-file
-import { parseString } from 'xml2js';
-// eslint-disable-next-line import/no-cycle
-import { INode, IStatusCodeMessages, JsonObject } from '..';
-
-/**
- * Top-level properties where an error message can be found in an API response.
- */
-const ERROR_MESSAGE_PROPERTIES = [
-	'cause',
-	'error',
-	'message',
-	'Message',
-	'msg',
-	'messages',
-	'description',
-	'reason',
-	'detail',
-	'details',
-	'errors',
-	'errorMessage',
-	'errorMessages',
-	'ErrorMessage',
-	'error_message',
-	'_error_message',
-	'errorDescription',
-	'error_description',
-	'error_summary',
-	'title',
-	'text',
-	'field',
-	'err',
-	'type',
-];
-
-/**
- * Top-level properties where an HTTP error code can be found in an API response.
- */
-const ERROR_STATUS_PROPERTIES = [
-	'statusCode',
-	'status',
-	'code',
-	'status_code',
-	'errorCode',
-	'error_code',
-];
-
-/**
- * Properties where a nested object can be found in an API response.
- */
-const ERROR_NESTING_PROPERTIES = ['error', 'err', 'response', 'body', 'data'];
-
-/**
- * Base class for specific NodeError-types, with functionality for finding
- * a value recursively inside an error object.
- */
-abstract class NodeError extends Error {
-	description: string | null | undefined;
-
-	cause: Error | JsonObject;
-
-	node: INode;
-
-	timestamp: number;
-
-	constructor(node: INode, error: Error | JsonObject) {
-		super();
-		this.name = this.constructor.name;
-		this.cause = error;
-		this.node = node;
-		this.timestamp = Date.now();
-
-		if (error.message) {
-			this.message = error.message as string;
-		}
-	}
-
-	/**
-	 * Finds property through exploration based on potential keys and traversal keys.
-	 * Depth-first approach.
-	 *
-	 * This method iterates over `potentialKeys` and, if the value at the key is a
-	 * truthy value, the type of the value is checked:
-	 * (1) if a string or number, the value is returned as a string; or
-	 * (2) if an array,
-	 * 		its string or number elements are collected as a long string,
-	 * 		its object elements are traversed recursively (restart this function
-	 *    with each object as a starting point), or
-	 * (3) if it is an object, it traverses the object and nested ones recursively
-	 * 		based on the `potentialKeys` and returns a string if found.
-	 *
-	 * If nothing found via `potentialKeys` this method iterates over `traversalKeys` and
-	 * if the value at the key is a traversable object, it restarts with the object as the
-	 * new starting point (recursion).
-	 * If nothing found for any of the `traversalKeys`, exploration continues with remaining
-	 * `traversalKeys`.
-	 *
-	 * Otherwise, if all the paths have been exhausted and no value is eligible, `null` is
-	 * returned.
-	 *
-	 * @param {JsonObject} error
-	 * @param {string[]} potentialKeys
-	 * @param {string[]} traversalKeys
-	 * @returns {string | null}
-	 */
-	protected findProperty(
-		error: JsonObject,
-		potentialKeys: string[],
-		traversalKeys: string[] = [],
-	): string | null {
-		// eslint-disable-next-line no-restricted-syntax
-		for (const key of potentialKeys) {
-			if (error[key]) {
-				if (typeof error[key] === 'string') return error[key] as string;
-				// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-				if (typeof error[key] === 'number') return error[key]!.toString();
-				if (Array.isArray(error[key])) {
-					// @ts-ignore
-					const resolvedErrors: string[] = error[key]
-						// @ts-ignore
-						.map((error) => {
-							if (typeof error === 'string') return error;
-							if (typeof error === 'number') return error.toString();
-							if (this.isTraversableObject(error)) {
-								return this.findProperty(error, potentialKeys);
-							}
-							return null;
-						})
-						.filter((errorValue: string | null) => errorValue !== null);
-
-					if (resolvedErrors.length === 0) {
-						return null;
-					}
-					return resolvedErrors.join(' | ');
-				}
-				if (this.isTraversableObject(error[key])) {
-					const property = this.findProperty(error[key] as JsonObject, potentialKeys);
-					if (property) {
-						return property;
-					}
-				}
-			}
-		}
-
-		// eslint-disable-next-line no-restricted-syntax
-		for (const key of traversalKeys) {
-			if (this.isTraversableObject(error[key])) {
-				const property = this.findProperty(error[key] as JsonObject, potentialKeys, traversalKeys);
-				if (property) {
-					return property;
-				}
-			}
-		}
-
-		return null;
-	}
-
-	/**
-	 * Check if a value is an object with at least one key, i.e. it can be traversed.
-	 */
-	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	protected isTraversableObject(value: any): value is JsonObject {
-		return (
-			value && typeof value === 'object' && !Array.isArray(value) && !!Object.keys(value).length
-		);
-	}
-
-	/**
-	 * Remove circular references from objects.
-	 */
-	protected removeCircularRefs(obj: JsonObject, seen = new Set()) {
-		seen.add(obj);
-		Object.entries(obj).forEach(([key, value]) => {
-			if (this.isTraversableObject(value)) {
-				// eslint-disable-next-line @typescript-eslint/no-unused-expressions
-				seen.has(value)
-					? (obj[key] = { circularReference: true })
-					: this.removeCircularRefs(value, seen);
-				return;
-			}
-			if (Array.isArray(value)) {
-				value.forEach((val, index) => {
-					if (seen.has(val)) {
-						value[index] = { circularReference: true };
-						return;
-					}
-					if (this.isTraversableObject(val)) {
-						this.removeCircularRefs(val, seen);
-					}
-				});
-			}
-		});
-	}
-}
-
-/**
- * Class for instantiating an operational error, e.g. an invalid credentials error.
- */
-export class NodeOperationError extends NodeError {
-	itemIndex?: number;
-	functionality?: string;
-	constructor(
-		node: INode,
-		error: Error | string,
-		options?: { description?: string; itemIndex?: number, functionality?: string }
-	) {
-		if (typeof error === 'string') {
-			error = new Error(error);
-		}
-		super(node, error);
-
-		if (options?.description) {
-			this.description = options.description;
-		}
-		if (options?.itemIndex !== undefined) {
-			this.itemIndex = options.itemIndex;
-		}
-		if (options?.functionality) {
-			this.functionality = options.functionality;
-		}
-	}
-}
-
-const STATUS_CODE_MESSAGES: IStatusCodeMessages = {
-	'4XX': 'Your request is invalid or could not be processed by the service',
-	'400': 'Bad request - please check your parameters',
-	'401': 'Authorization failed - please check your credentials',
-	'402': 'Payment required - perhaps check your payment details?',
-	'403': 'Forbidden - perhaps check your credentials?',
-	'404': 'The resource you are requesting could not be found',
-	'405': 'Method not allowed - please check you are using the right HTTP method',
-	'429': 'The service is receiving too many requests from you! Perhaps take a break?',
-
-	'5XX': 'The service failed to process your request',
-	'500': 'The service was not able to process your request',
-	'502': 'Bad gateway - the service failed to handle your request',
-	'503': 'Service unavailable - perhaps try again later?',
-	'504': 'Gateway timed out - perhaps try again later?',
-};
-
-const UNKNOWN_ERROR_MESSAGE = 'UNKNOWN ERROR - check the detailed error for more information';
-
-/**
- * Class for instantiating an error in an API response, e.g. a 404 Not Found response,
- * with an HTTP error code, an error message and a description.
- */
-export class NodeApiError extends NodeError {
-	httpCode: string | null;
-
-	constructor(
-		node: INode,
-		error: JsonObject,
-		{
-			message,
-			description,
-			httpCode,
-			parseXml,
-		}: { message?: string; description?: string; httpCode?: string; parseXml?: boolean } = {},
-	) {
-		super(node, error);
-		if (error['error']) {
-			// only for request library error
-			this.removeCircularRefs(error['error'] as JsonObject);
-		}
-		if (message) {
-			this.message = message;
-			this.description = description;
-			this.httpCode = httpCode ?? null;
-			return;
-		}
-
-		this.httpCode = this.findProperty(error, ERROR_STATUS_PROPERTIES, ERROR_NESTING_PROPERTIES);
-		this.setMessage();
-
-		if (parseXml) {
-			this.setDescriptionFromXml(error['error'] as string);
-			return;
-		}
-
-		this.description = this.findProperty(error, ERROR_MESSAGE_PROPERTIES, ERROR_NESTING_PROPERTIES);
-	}
-
-	private setDescriptionFromXml(xml: string) {
-		// eslint-disable-next-line @typescript-eslint/naming-convention
-		parseString(xml, { explicitArray: false }, (_, result) => {
-			if (!result) return;
-
-			const topLevelKey = Object.keys(result)[0];
-			this.description = this.findProperty(
-				// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-				result[topLevelKey],
-				ERROR_MESSAGE_PROPERTIES,
-				['Error'].concat(ERROR_NESTING_PROPERTIES),
-			);
-		});
-	}
-
-	/**
-	 * Set the error's message based on the HTTP status code.
-	 *
-	 * @returns {void}
-	 */
-	private setMessage() {
-		if (!this.httpCode) {
-			this.httpCode = null;
-			this.message = UNKNOWN_ERROR_MESSAGE;
-			return;
-		}
-
-		if (STATUS_CODE_MESSAGES[this.httpCode]) {
-			this.message = STATUS_CODE_MESSAGES[this.httpCode];
-			return;
-		}
-
-		switch (this.httpCode.charAt(0)) {
-			case '4':
-				this.message = STATUS_CODE_MESSAGES['4XX'];
-				break;
-			case '5':
-				this.message = STATUS_CODE_MESSAGES['5XX'];
-				break;
-			default:
-				this.message = UNKNOWN_ERROR_MESSAGE;
-		}
-	}
-}