mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2024-09-19 22:37:31 -07:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

refactor(core): Avoid passing around static state like default timezone (no-changelog) (#7221)

Browse source
This commit is contained in:
कारतोफ्फेलस्क्रिप्ट™ 2023-10-27 14:17:52 +02:00 committed by GitHub
parent 62c096710f
commit 35bb42c1b9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
31 changed files with 76 additions and 224 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
packages/cli/src/AbstractServer.ts
View file

@ -37,8 +37,6 @@ export abstract class AbstractServer {
protected sslCert: string;
protected timezone: string;
protected restEndpoint: string;
protected endpointWebhook: string;
@ -61,8 +59,6 @@ export abstract class AbstractServer {
this.sslKey = config.getEnv('ssl_key');
this.sslCert = config.getEnv('ssl_cert');
this.timezone = config.getEnv('generic.timezone');
this.restEndpoint = config.getEnv('endpoints.rest');
this.endpointWebhook = config.getEnv('endpoints.webhook');
this.endpointWebhookTest = config.getEnv('endpoints.webhookTest');

20
packages/cli/src/CredentialsHelper.ts
View file

@ -106,7 +106,6 @@ export class CredentialsHelper extends ICredentialsHelper {
incomingRequestOptions: IHttpRequestOptions | IRequestOptionsSimplified,
workflow: Workflow,
node: INode,
defaultTimezone: string,
): Promise<IHttpRequestOptions> {
const requestOptions = incomingRequestOptions;
const credentialType = this.credentialTypes.getByName(typeName);
@ -131,20 +130,13 @@ export class CredentialsHelper extends ICredentialsHelper {
if (authenticate.type === 'generic') {
Object.entries(authenticate.properties).forEach(([outerKey, outerValue]) => {
Object.entries(outerValue).forEach(([key, value]) => {
keyResolved = this.resolveValue(
key,
{ $credentials: credentials },
workflow,
node,
defaultTimezone,
);
keyResolved = this.resolveValue(key, { $credentials: credentials }, workflow, node);
valueResolved = this.resolveValue(
value as string,
{ $credentials: credentials },
workflow,
node,
defaultTimezone,
);
// @ts-ignore
@ -226,7 +218,6 @@ export class CredentialsHelper extends ICredentialsHelper {
additionalKeys: IWorkflowDataProxyAdditionalKeys,
workflow: Workflow,
node: INode,
defaultTimezone: string,
): string {
if (typeof parameterValue !== 'string' || parameterValue.charAt(0) !== '=') {
return parameterValue;
@ -236,7 +227,6 @@ export class CredentialsHelper extends ICredentialsHelper {
node,
parameterValue,
'internal',
defaultTimezone,
additionalKeys,
undefined,
'',
@ -347,7 +337,6 @@ export class CredentialsHelper extends ICredentialsHelper {
nodeCredentials: INodeCredentialsDetails,
type: string,
mode: WorkflowExecuteMode,
defaultTimezone: string,
raw?: boolean,
expressionResolveValues?: ICredentialsExpressionResolveValues,
): Promise<ICredentialDataDecryptedObject> {
@ -367,7 +356,6 @@ export class CredentialsHelper extends ICredentialsHelper {
decryptedDataOriginal,
type,
mode,
defaultTimezone,
expressionResolveValues,
canUseSecrets,
);
@ -381,7 +369,6 @@ export class CredentialsHelper extends ICredentialsHelper {
decryptedDataOriginal: ICredentialDataDecryptedObject,
type: string,
mode: WorkflowExecuteMode,
defaultTimezone: string,
expressionResolveValues?: ICredentialsExpressionResolveValues,
canUseSecrets?: boolean,
): ICredentialDataDecryptedObject {
@ -413,8 +400,6 @@ export class CredentialsHelper extends ICredentialsHelper {
});
if (expressionResolveValues) {
const timezone = expressionResolveValues.workflow.settings.timezone ?? defaultTimezone;
try {
decryptedData = expressionResolveValues.workflow.expression.getParameterValue(
decryptedData as INodeParameters,
@ -424,7 +409,6 @@ export class CredentialsHelper extends ICredentialsHelper {
expressionResolveValues.node.name,
expressionResolveValues.connectionInputData,
mode,
timezone,
additionalKeys,
undefined,
false,
@ -447,7 +431,6 @@ export class CredentialsHelper extends ICredentialsHelper {
mockNode,
decryptedData as INodeParameters,
mode,
defaultTimezone,
additionalKeys,
undefined,
undefined,
@ -597,7 +580,6 @@ export class CredentialsHelper extends ICredentialsHelper {
credentialsDecrypted.data,
credentialType,
'internal' as WorkflowExecuteMode,
additionalData.timezone,
undefined,
user.isOwner,
);

6
packages/cli/src/Server.ts
View file

@ -727,14 +727,12 @@ export class Server extends AbstractServer {
const additionalData = await WorkflowExecuteAdditionalData.getBase(req.user.id);
const mode: WorkflowExecuteMode = 'internal';
const timezone = config.getEnv('generic.timezone');
const credentialsHelper = Container.get(CredentialsHelper);
const decryptedDataOriginal = await credentialsHelper.getDecrypted(
additionalData,
credential as INodeCredentialsDetails,
credential.type,
mode,
timezone,
true,
);
@ -743,7 +741,6 @@ export class Server extends AbstractServer {
decryptedDataOriginal,
credential.type,
mode,
timezone,
);
const signatureMethod = oauthCredentials.signatureMethod as string;
@ -870,14 +867,12 @@ export class Server extends AbstractServer {
const additionalData = await WorkflowExecuteAdditionalData.getBase(req.user.id);
const mode: WorkflowExecuteMode = 'internal';
const timezone = config.getEnv('generic.timezone');
const credentialsHelper = Container.get(CredentialsHelper);
const decryptedDataOriginal = await credentialsHelper.getDecrypted(
additionalData,
credential as INodeCredentialsDetails,
credential.type,
mode,
timezone,
true,
);
const oauthCredentials = credentialsHelper.applyDefaultsAndOverwrites(
@ -885,7 +880,6 @@ export class Server extends AbstractServer {
decryptedDataOriginal,
credential.type,
mode,
timezone,
);
const options: AxiosRequestConfig = {

8
packages/cli/src/WebhookHelpers.ts
View file

@ -246,7 +246,6 @@ export async function executeWebhook(
workflowStartNode,
webhookData.webhookDescription.responseMode,
executionMode,
additionalData.timezone,
additionalKeys,
undefined,
'onReceived',
@ -255,7 +254,6 @@ export async function executeWebhook(
workflowStartNode,
webhookData.webhookDescription.responseCode,
executionMode,
additionalData.timezone,
additionalKeys,
undefined,
200,
@ -265,7 +263,6 @@ export async function executeWebhook(
workflowStartNode,
webhookData.webhookDescription.responseData,
executionMode,
additionalData.timezone,
additionalKeys,
undefined,
'firstEntryJson',
@ -288,7 +285,6 @@ export async function executeWebhook(
workflowStartNode,
'={{$parameter["options"]["binaryData"]}}',
executionMode,
additionalData.timezone,
additionalKeys,
undefined,
false,
@ -370,7 +366,6 @@ export async function executeWebhook(
workflowStartNode,
webhookData.webhookDescription.responseHeaders,
executionMode,
additionalData.timezone,
additionalKeys,
undefined,
undefined,
@ -644,7 +639,6 @@ export async function executeWebhook(
workflowStartNode,
webhookData.webhookDescription.responsePropertyName,
executionMode,
additionalData.timezone,
additionalKeys,
undefined,
undefined,
@ -658,7 +652,6 @@ export async function executeWebhook(
workflowStartNode,
webhookData.webhookDescription.responseContentType,
executionMode,
additionalData.timezone,
additionalKeys,
undefined,
undefined,
@ -704,7 +697,6 @@ export async function executeWebhook(
workflowStartNode,
webhookData.webhookDescription.responseBinaryPropertyName,
executionMode,
additionalData.timezone,
additionalKeys,
undefined,
'data',

3
packages/cli/src/WorkflowExecuteAdditionalData.ts
View file

@ -1006,7 +1006,6 @@ export function sendDataToUI(type: string, data: IDataObject | IDataObject[]) {
/**
* Returns the base additional data without webhooks
*
*/
export async function getBase(
userId: string,
@ -1015,7 +1014,6 @@ export async function getBase(
): Promise<IWorkflowExecuteAdditionalData> {
const urlBaseWebhook = WebhookHelpers.getWebhookBaseUrl();
const timezone = config.getEnv('generic.timezone');
const webhookBaseUrl = urlBaseWebhook + config.getEnv('endpoints.webhook');
const webhookWaitingBaseUrl = urlBaseWebhook + config.getEnv('endpoints.webhookWaiting');
const webhookTestBaseUrl = urlBaseWebhook + config.getEnv('endpoints.webhookTest');
@ -1026,7 +1024,6 @@ export async function getBase(
credentialsHelper: Container.get(CredentialsHelper),
executeWorkflow,
restApiUrl: urlBaseWebhook + config.getEnv('endpoints.rest'),
timezone,
instanceBaseUrl: urlBaseWebhook,
webhookBaseUrl,
webhookWaitingBaseUrl,

5
packages/cli/src/config/index.ts
View file

@ -3,6 +3,7 @@ import dotenv from 'dotenv';
import { tmpdir } from 'os';
import { mkdirSync, mkdtempSync, readFileSync } from 'fs';
import { join } from 'path';
import { setGlobalState } from 'n8n-workflow';
import { schema } from './schema';
import { inTest, inE2ETests } from '@/constants';
@ -73,6 +74,10 @@ config.validate({
allowed: 'strict',
});
setGlobalState({
defaultTimezone: config.getEnv('generic.timezone'),
});
// eslint-disable-next-line import/no-default-export
export default config;
export type Config = typeof config;

6
packages/cli/src/credentials/oauth2Credential.api.ts
View file

@ -65,14 +65,12 @@ oauth2CredentialController.get(
const credentialType = credential.type;
const mode: WorkflowExecuteMode = 'internal';
const timezone = config.getEnv('generic.timezone');
const credentialsHelper = Container.get(CredentialsHelper);
const decryptedDataOriginal = await credentialsHelper.getDecrypted(
additionalData,
credential as INodeCredentialsDetails,
credentialType,
mode,
timezone,
true,
);
@ -93,7 +91,6 @@ oauth2CredentialController.get(
decryptedDataOriginal,
credentialType,
mode,
timezone,
);
const token = new Csrf();
@ -208,14 +205,12 @@ oauth2CredentialController.get(
const additionalData = await WorkflowExecuteAdditionalData.getBase(state.cid);
const mode: WorkflowExecuteMode = 'internal';
const timezone = config.getEnv('generic.timezone');
const credentialsHelper = Container.get(CredentialsHelper);
const decryptedDataOriginal = await credentialsHelper.getDecrypted(
additionalData,
credential as INodeCredentialsDetails,
credential.type,
mode,
timezone,
true,
);
const oauthCredentials = credentialsHelper.applyDefaultsAndOverwrites(
@ -223,7 +218,6 @@ oauth2CredentialController.get(
decryptedDataOriginal,
credential.type,
mode,
timezone,
);
const token = new Csrf();

3
packages/cli/src/eventbus/MessageEventBusDestination/MessageEventBusDestinationWebhook.ee.ts
View file

@ -18,7 +18,6 @@ import type {
} from 'n8n-workflow';
import { CredentialsHelper } from '@/CredentialsHelper';
import { Agent as HTTPSAgent } from 'https';
import config from '@/config';
import { isLogStreamingEnabled } from '../MessageEventBus/MessageEventBusHelper';
import { eventMessageGenericDestinationTestEvent } from '../EventMessageClasses/EventMessageGeneric';
import { MessageEventBus } from '../MessageEventBus/MessageEventBus';
@ -107,13 +106,11 @@ export class MessageEventBusDestinationWebhook
async matchDecryptedCredentialType(credentialType: string) {
const foundCredential = Object.entries(this.credentials).find((e) => e[0] === credentialType);
if (foundCredential) {
const timezone = config.getEnv('generic.timezone');
const credentialsDecrypted = await this.credentialsHelper?.getDecrypted(
{ secretsHelpers: SecretsHelpers } as unknown as IWorkflowExecuteAdditionalData,
foundCredential[1],
foundCredential[0],
'internal',
timezone,
true,
);
return credentialsDecrypted;

3
packages/cli/test/unit/CredentialsHelper.test.ts
View file

@ -267,8 +267,6 @@ describe('CredentialsHelper', () => {
nodeTypes,
});
const timezone = 'America/New_York';
for (const testData of tests) {
test(testData.description, async () => {
mockNodesAndCredentials.loadedCredentials = {
@ -286,7 +284,6 @@ describe('CredentialsHelper', () => {
deepCopy(incomingRequestOptions),
workflow,
node,
timezone,
);
expect(result).toEqual(testData.output);

41
packages/core/src/NodeExecuteFunctions.ts
View file

@ -105,6 +105,7 @@ import {
createDeferredPromise,
deepCopy,
fileTypeFromMimeType,
getGlobalState,
isObjectEmpty,
isResourceMapperValue,
validateFieldType,
@ -131,7 +132,7 @@ import {
UM_EMAIL_TEMPLATES_PWRESET,
} from './Constants';
import { extractValue } from './ExtractValue';
import type { ExtendedValidationResult, IResponseError, IWorkflowSettings } from './Interfaces';
import type { ExtendedValidationResult, IResponseError } from './Interfaces';
import { getClientCredentialsToken } from './OAuth2Helper';
import {
getAllWorkflowExecutionMetadata,
@ -1544,7 +1545,6 @@ export async function httpRequestWithAuthentication(
requestOptions,
workflow,
node,
additionalData.timezone,
);
return await httpRequest(requestOptions);
} catch (error) {
@ -1577,7 +1577,6 @@ export async function httpRequestWithAuthentication(
requestOptions,
workflow,
node,
additionalData.timezone,
);
}
// retry the request
@ -1740,7 +1739,6 @@ export async function requestWithAuthentication(
requestOptions as IHttpRequestOptions,
workflow,
node,
additionalData.timezone,
);
return await proxyRequestToAxios(workflow, additionalData, node, requestOptions as IDataObject);
} catch (error) {
@ -1765,7 +1763,6 @@ export async function requestWithAuthentication(
requestOptions as IHttpRequestOptions,
workflow,
node,
additionalData.timezone,
);
// retry the request
return await proxyRequestToAxios(
@ -1972,7 +1969,6 @@ export async function getCredentials(
nodeCredentials,
type,
mode,
additionalData.timezone,
false,
expressionResolveValues,
);
@ -2222,7 +2218,6 @@ export function getNodeParameter(
parameterName: string,
itemIndex: number,
mode: WorkflowExecuteMode,
timezone: string,
additionalKeys: IWorkflowDataProxyAdditionalKeys,
executeData?: IExecuteData,
fallbackValue?: any,
@ -2253,7 +2248,6 @@ export function getNodeParameter(
node.name,
connectionInputData,
mode,
timezone,
additionalKeys,
executeData,
false,
@ -2308,7 +2302,6 @@ export function getNodeWebhookUrl(
node: INode,
additionalData: IWorkflowExecuteAdditionalData,
mode: WorkflowExecuteMode,
timezone: string,
additionalKeys: IWorkflowDataProxyAdditionalKeys,
isTest?: boolean,
): string | undefined {
@ -2327,7 +2320,6 @@ export function getNodeWebhookUrl(
node,
webhookDescription.path,
mode,
timezone,
additionalKeys,
);
if (path === undefined) {
@ -2338,7 +2330,6 @@ export function getNodeWebhookUrl(
node,
webhookDescription.isFullPath,
mode,
timezone,
additionalKeys,
undefined,
false,
@ -2348,17 +2339,9 @@ export function getNodeWebhookUrl(
/**
* Returns the timezone for the workflow
*
*/
export function getTimezone(
workflow: Workflow,
additionalData: IWorkflowExecuteAdditionalData,
): string {
// eslint-disable-next-line @typescript-eslint/prefer-optional-chain
if (workflow.settings !== undefined && workflow.settings.timezone !== undefined) {
return (workflow.settings as IWorkflowSettings).timezone as string;
}
return additionalData.timezone;
export function getTimezone(workflow: Workflow): string {
return workflow.settings.timezone ?? getGlobalState().defaultTimezone;
}
/**
@ -2508,7 +2491,7 @@ const getCommonWorkflowFunctions = (
getRestApiUrl: () => additionalData.restApiUrl,
getInstanceBaseUrl: () => additionalData.instanceBaseUrl,
getInstanceId: () => Container.get(InstanceSettings).instanceId,
getTimezone: () => getTimezone(workflow, additionalData),
getTimezone: () => getTimezone(workflow),
prepareOutputData: async (outputData) => [outputData],
});
@ -2772,7 +2755,6 @@ export function getExecutePollFunctions(
parameterName,
itemIndex,
mode,
additionalData.timezone,
getAdditionalKeys(additionalData, mode, runExecutionData),
undefined,
fallbackValue,
@ -2831,7 +2813,6 @@ export function getExecuteTriggerFunctions(
parameterName,
itemIndex,
mode,
additionalData.timezone,
getAdditionalKeys(additionalData, mode, runExecutionData),
undefined,
fallbackValue,
@ -2890,7 +2871,6 @@ export function getExecuteFunctions(
node.name,
connectionInputData,
mode,
additionalData.timezone,
getAdditionalKeys(additionalData, mode, runExecutionData),
executeData,
);
@ -2983,7 +2963,6 @@ export function getExecuteFunctions(
parameterName,
itemIndex,
mode,
additionalData.timezone,
getAdditionalKeys(additionalData, mode, runExecutionData),
executeData,
fallbackValue,
@ -3142,7 +3121,6 @@ export function getExecuteFunctions(
parameterName,
itemIndex,
mode,
additionalData.timezone,
getAdditionalKeys(additionalData, mode, runExecutionData),
executeData,
fallbackValue,
@ -3159,7 +3137,6 @@ export function getExecuteFunctions(
connectionInputData,
{},
mode,
additionalData.timezone,
getAdditionalKeys(additionalData, mode, runExecutionData),
executeData,
);
@ -3306,7 +3283,6 @@ export function getExecuteSingleFunctions(
node.name,
connectionInputData,
mode,
additionalData.timezone,
getAdditionalKeys(additionalData, mode, runExecutionData),
executeData,
);
@ -3377,7 +3353,6 @@ export function getExecuteSingleFunctions(
parameterName,
itemIndex,
mode,
additionalData.timezone,
getAdditionalKeys(additionalData, mode, runExecutionData),
executeData,
fallbackValue,
@ -3394,7 +3369,6 @@ export function getExecuteSingleFunctions(
connectionInputData,
{},
mode,
additionalData.timezone,
getAdditionalKeys(additionalData, mode, runExecutionData),
executeData,
);
@ -3489,7 +3463,6 @@ export function getLoadOptionsFunctions(
parameterName,
itemIndex,
mode,
additionalData.timezone,
getAdditionalKeys(additionalData, mode, runExecutionData),
undefined,
fallbackValue,
@ -3538,7 +3511,6 @@ export function getExecuteHookFunctions(
parameterName,
itemIndex,
mode,
additionalData.timezone,
getAdditionalKeys(additionalData, mode, runExecutionData),
undefined,
fallbackValue,
@ -3552,7 +3524,6 @@ export function getExecuteHookFunctions(
node,
additionalData,
mode,
additionalData.timezone,
getAdditionalKeys(additionalData, mode, null),
isTest,
);
@ -3615,7 +3586,6 @@ export function getExecuteWebhookFunctions(
parameterName,
itemIndex,
mode,
additionalData.timezone,
getAdditionalKeys(additionalData, mode, null),
undefined,
fallbackValue,
@ -3653,7 +3623,6 @@ export function getExecuteWebhookFunctions(
node,
additionalData,
mode,
additionalData.timezone,
getAdditionalKeys(additionalData, mode, null),
),
getWebhookName: () => webhookData.webhookDescription.name,

1
packages/core/src/WorkflowExecute.ts
View file

@ -1402,7 +1402,6 @@ export class WorkflowExecute {
checkNode,
requiredInputs,
this.mode,
this.additionalData.timezone,
{ $version: checkNode.typeVersion },
undefined,
[],

1
packages/core/test/helpers/index.ts
View file

@ -135,7 +135,6 @@ export function WorkflowExecuteAdditionalData(
executeWorkflow: async (workflowInfo: IExecuteWorkflowInfo) => {},
sendDataToUI: (message: string) => {},
restApiUrl: '',
timezone: 'America/New_York',
webhookBaseUrl: 'webhook',
webhookWaitingBaseUrl: 'webhook-waiting',
webhookTestBaseUrl: 'webhook-test',

1
packages/editor-ui/src/components/VariableSelector.vue
View file

@ -515,7 +515,6 @@ export default defineComponent({
connectionInputData,
{},
'manual',
this.rootStore.timezone,
additionalKeys,
);
const proxy = dataProxy.getDataProxy();

1
packages/editor-ui/src/mixins/nodeHelpers.ts
View file

@ -646,7 +646,6 @@ export const nodeHelpers = defineComponent({
data as INode,
nodeType.subtitle,
'internal',
this.rootStore.timezone,
{},
undefined,
PLACEHOLDER_FILLED_AT_EXECUTION_TIME,

1
packages/editor-ui/src/mixins/workflowHelpers.ts
View file

@ -216,7 +216,6 @@ export function resolveParameter(
activeNode!.name,
_connectionInputData,
'manual',
useRootStore().timezone,
additionalKeys,
_executeData,
false,

1
packages/editor-ui/src/plugins/codemirror/completions/__tests__/mock.ts
View file

@ -304,7 +304,6 @@ const dataProxy = new WorkflowDataProxy(
lastNodeConnectionInputData || [],
{},
'manual',
'America/New_York',
{},
executeData,
);

3
packages/editor-ui/src/stores/n8nRoot.store.ts
View file

@ -1,6 +1,6 @@
import { CLOUD_BASE_URL_PRODUCTION, CLOUD_BASE_URL_STAGING, STORES } from '@/constants';
import type { IRestApiContext, RootState } from '@/Interface';
import type { IDataObject } from 'n8n-workflow';
import { setGlobalState, type IDataObject } from 'n8n-workflow';
import { defineStore } from 'pinia';
const { VUE_APP_URL_BASE_API } = import.meta.env;
@ -79,6 +79,7 @@ export const useRootStore = defineStore(STORES.ROOT, {
},
setTimezone(timezone: string): void {
this.timezone = timezone;
setGlobalState({ defaultTimezone: timezone });
},
setExecutionTimeout(executionTimeout: number): void {
this.executionTimeout = executionTimeout;

1
packages/nodes-base/test/nodes/Helpers.ts
View file

@ -176,7 +176,6 @@ export function WorkflowExecuteAdditionalData(
executeWorkflow: async (workflowInfo: IExecuteWorkflowInfo): Promise<any> => {},
sendDataToUI: (message: string) => {},
restApiUrl: '',
timezone: workflowTestData?.input.workflowData.settings?.timezone || 'America/New_York',
webhookBaseUrl: 'webhook',
webhookWaitingBaseUrl: 'webhook-waiting',
webhookTestBaseUrl: 'webhook-test',

26
packages/workflow/src/Expression.ts
View file

@ -23,6 +23,7 @@ import { extend, extendOptional } from './Extensions';
import { extendedFunctions } from './Extensions/ExtendedFunctions';
import { extendSyntax } from './Extensions/ExpressionExtension';
import { evaluateExpression, setErrorHandler } from './ExpressionEvaluatorProxy';
import { getGlobalState } from './GlobalState';
const IS_FRONTEND_IN_DEV_MODE =
typeof process === 'object' &&
@ -32,13 +33,13 @@ const IS_FRONTEND_IN_DEV_MODE =
const IS_FRONTEND = typeof process === 'undefined' || IS_FRONTEND_IN_DEV_MODE;
export const isSyntaxError = (error: unknown): error is SyntaxError =>
const isSyntaxError = (error: unknown): error is SyntaxError =>
error instanceof SyntaxError || (error instanceof Error && error.name === 'SyntaxError');
export const isExpressionError = (error: unknown): error is ExpressionError =>
const isExpressionError = (error: unknown): error is ExpressionError =>
error instanceof ExpressionError || error instanceof ExpressionExtensionError;
export const isTypeError = (error: unknown): error is TypeError =>
const isTypeError = (error: unknown): error is TypeError =>
error instanceof TypeError || (error instanceof Error && error.name === 'TypeError');
// Make sure that error get forwarded
@ -58,11 +59,7 @@ const fnConstructors = {
};
export class Expression {
workflow: Workflow;
constructor(workflow: Workflow) {
this.workflow = workflow;
}
constructor(private readonly workflow: Workflow) {}
static resolveWithoutWorkflow(expression: string, data: IDataObject = {}) {
return tmpl.tmpl(expression, data);
@ -84,7 +81,7 @@ export class Expression {
if (value instanceof Date) {
// We don't want to use JSON.stringify for dates since it disregards workflow timezone
result = DateTime.fromJSDate(value, {
zone: this.workflow.settings?.timezone ?? 'default',
zone: this.workflow.settings?.timezone ?? getGlobalState().defaultTimezone,
}).toISO();
} else {
result = JSON.stringify(value);
@ -114,7 +111,6 @@ export class Expression {
activeNodeName: string,
connectionInputData: INodeExecutionData[],
mode: WorkflowExecuteMode,
timezone: string,
additionalKeys: IWorkflowDataProxyAdditionalKeys,
executeData?: IExecuteData,
returnObjectAsString = false,
@ -143,7 +139,6 @@ export class Expression {
connectionInputData,
siblingParameters,
mode,
timezone,
additionalKeys,
executeData,
-1,
@ -371,7 +366,6 @@ export class Expression {
node: INode,
parameterValue: string | boolean | undefined,
mode: WorkflowExecuteMode,
timezone: string,
additionalKeys: IWorkflowDataProxyAdditionalKeys,
executeData?: IExecuteData,
defaultValue?: boolean | number | string | unknown[],
@ -399,7 +393,6 @@ export class Expression {
node.name,
connectionInputData,
mode,
timezone,
additionalKeys,
executeData,
) as boolean | number | string | undefined;
@ -415,7 +408,6 @@ export class Expression {
node: INode,
parameterValue: NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[],
mode: WorkflowExecuteMode,
timezone: string,
additionalKeys: IWorkflowDataProxyAdditionalKeys,
executeData?: IExecuteData,
defaultValue: NodeParameterValueType | undefined = undefined,
@ -445,7 +437,6 @@ export class Expression {
node.name,
connectionInputData,
mode,
timezone,
additionalKeys,
executeData,
false,
@ -461,7 +452,6 @@ export class Expression {
node.name,
connectionInputData,
mode,
timezone,
additionalKeys,
executeData,
false,
@ -487,7 +477,6 @@ export class Expression {
activeNodeName: string,
connectionInputData: INodeExecutionData[],
mode: WorkflowExecuteMode,
timezone: string,
additionalKeys: IWorkflowDataProxyAdditionalKeys,
executeData?: IExecuteData,
returnObjectAsString = false,
@ -513,7 +502,6 @@ export class Expression {
activeNodeName,
connectionInputData,
mode,
timezone,
additionalKeys,
executeData,
returnObjectAsString,
@ -531,7 +519,6 @@ export class Expression {
activeNodeName,
connectionInputData,
mode,
timezone,
additionalKeys,
executeData,
returnObjectAsString,
@ -551,7 +538,6 @@ export class Expression {
activeNodeName,
connectionInputData,
mode,
timezone,
additionalKeys,
executeData,
returnObjectAsString,

15
packages/workflow/src/GlobalState.ts Normal file
View file

@ -0,0 +1,15 @@
import { deepCopy } from './utils';
export interface GlobalState {
defaultTimezone: string;
}
let globalState: GlobalState = { defaultTimezone: 'America/New_York' };
export function setGlobalState(state: GlobalState) {
globalState = state;
}
export function getGlobalState() {
return deepCopy(globalState);
}

3
packages/workflow/src/Interfaces.ts
View file

@ -196,7 +196,6 @@ export abstract class ICredentialsHelper {
requestOptions: IHttpRequestOptions | IRequestOptionsSimplified,
workflow: Workflow,
node: INode,
defaultTimezone: string,
): Promise<IHttpRequestOptions>;
abstract preAuthentication(
@ -217,7 +216,6 @@ export abstract class ICredentialsHelper {
nodeCredentials: INodeCredentialsDetails,
type: string,
mode: WorkflowExecuteMode,
defaultTimezone: string,
raw?: boolean,
expressionResolveValues?: ICredentialsExpressionResolveValues,
): Promise<ICredentialDataDecryptedObject>;
@ -1862,7 +1860,6 @@ export interface IWorkflowExecuteAdditionalData {
instanceBaseUrl: string;
setExecutionStatus?: (status: ExecutionStatus) => void;
sendDataToUI?: (type: string, data: IDataObject | IDataObject[]) => void;
timezone: string;
webhookBaseUrl: string;
webhookWaitingBaseUrl: string;
webhookTestBaseUrl: string;

6
packages/workflow/src/NodeHelpers.ts
View file

@ -885,7 +885,6 @@ export function getNodeWebhooks(
node,
webhookDescription.path,
mode,
additionalData.timezone,
{},
);
if (nodeWebhookPath === undefined) {
@ -909,7 +908,6 @@ export function getNodeWebhooks(
node,
webhookDescription.isFullPath,
'internal',
additionalData.timezone,
{},
undefined,
false,
@ -918,7 +916,6 @@ export function getNodeWebhooks(
node,
webhookDescription.restartWebhook,
'internal',
additionalData.timezone,
{},
undefined,
false,
@ -929,7 +926,6 @@ export function getNodeWebhooks(
node,
webhookDescription.httpMethod,
mode,
additionalData.timezone,
{},
undefined,
'GET',
@ -1037,7 +1033,6 @@ export function getNodeInputs(
node,
nodeTypeData.inputs,
'internal',
'',
{},
) || []) as ConnectionTypes[];
} catch (e) {
@ -1060,7 +1055,6 @@ export function getNodeOutputs(
node,
nodeTypeData.outputs,
'internal',
'',
{},
) || []) as ConnectionTypes[];
} catch (e) {

1
packages/workflow/src/RoutingNode.ts
View file

@ -701,7 +701,6 @@ export class RoutingNode {
this.node.name,
this.connectionInputData,
this.mode,
this.additionalData.timezone,
additionalKeys ?? {},
executeData,
returnObjectAsString,

67
packages/workflow/src/WorkflowDataProxy.ts
View file

@ -28,6 +28,7 @@ import { ExpressionError } from './ExpressionError';
import type { Workflow } from './Workflow';
import { augmentArray, augmentObject } from './AugmentObject';
import { deepCopy } from './utils';
import { getGlobalState } from './GlobalState';
export function isResourceLocatorValue(value: unknown): value is INodeParameterResourceLocator {
return Boolean(
@ -48,57 +49,28 @@ const isScriptingNode = (nodeName: string, workflow: Workflow) => {
};
export class WorkflowDataProxy {
private workflow: Workflow;
private runExecutionData: IRunExecutionData | null;
private defaultReturnRunIndex: number;
private runIndex: number;
private itemIndex: number;
private activeNodeName: string;
private contextNodeName: string;
private connectionInputData: INodeExecutionData[];
private siblingParameters: INodeParameters;
private mode: WorkflowExecuteMode;
private selfData: IDataObject;
private additionalKeys: IWorkflowDataProxyAdditionalKeys;
private executeData: IExecuteData | undefined;
private defaultTimezone: string;
private timezone: string;
// TODO: Clean that up at some point and move all the options into an options object
constructor(
workflow: Workflow,
private workflow: Workflow,
runExecutionData: IRunExecutionData | null,
runIndex: number,
itemIndex: number,
activeNodeName: string,
private runIndex: number,
private itemIndex: number,
private activeNodeName: string,
connectionInputData: INodeExecutionData[],
siblingParameters: INodeParameters,
mode: WorkflowExecuteMode,
defaultTimezone: string,
additionalKeys: IWorkflowDataProxyAdditionalKeys,
executeData?: IExecuteData,
defaultReturnRunIndex = -1,
selfData = {},
contextNodeName?: string,
private siblingParameters: INodeParameters,
private mode: WorkflowExecuteMode,
private additionalKeys: IWorkflowDataProxyAdditionalKeys,
private executeData?: IExecuteData,
private defaultReturnRunIndex = -1,
private selfData: IDataObject = {},
private contextNodeName: string = activeNodeName,
) {
this.activeNodeName = activeNodeName;
this.contextNodeName = contextNodeName || activeNodeName;
this.workflow = workflow;
this.runExecutionData = isScriptingNode(this.contextNodeName, workflow)
? runExecutionData !== null
? augmentObject(runExecutionData)
@ -109,16 +81,7 @@ export class WorkflowDataProxy {
? augmentArray(connectionInputData)
: connectionInputData;
this.defaultReturnRunIndex = defaultReturnRunIndex;
this.runIndex = runIndex;
this.itemIndex = itemIndex;
this.siblingParameters = siblingParameters;
this.mode = mode;
this.defaultTimezone = defaultTimezone;
this.timezone = workflow.settings?.timezone ?? defaultTimezone;
this.selfData = selfData;
this.additionalKeys = additionalKeys;
this.executeData = executeData;
this.timezone = workflow.settings?.timezone ?? getGlobalState().defaultTimezone;
Settings.defaultZone = this.timezone;
}
@ -266,7 +229,6 @@ export class WorkflowDataProxy {
that.activeNodeName,
that.connectionInputData,
that.mode,
that.timezone,
that.additionalKeys,
that.executeData,
false,
@ -1185,7 +1147,6 @@ export class WorkflowDataProxy {
that.activeNodeName,
that.connectionInputData,
that.mode,
that.timezone,
that.additionalKeys,
that.executeData,
false,
@ -1204,10 +1165,10 @@ export class WorkflowDataProxy {
this.connectionInputData,
that.siblingParameters,
that.mode,
that.defaultTimezone,
that.additionalKeys,
that.executeData,
defaultReturnRunIndex,
{},
that.contextNodeName,
);
return dataProxy.getDataProxy();

1
packages/workflow/src/index.ts
View file

@ -9,6 +9,7 @@ export * from './Authentication';
export * from './Constants';
export * from './Cron';
export * from './DeferredPromise';
export * from './GlobalState';
export * from './Interfaces';
export * from './MessageEventBus';
export * from './ExecutionStatus';

25
packages/workflow/test/Expression.test.ts
View file

@ -3,7 +3,6 @@
*/
import { DateTime, Duration, Interval } from 'luxon';
import { Expression } from '@/Expression';
import { Workflow } from '@/Workflow';
import * as Helpers from './Helpers';
import type { ExpressionTestEvaluation, ExpressionTestTransform } from './ExpressionFixtures/base';
@ -21,6 +20,7 @@ for (const evaluator of ['tmpl', 'tournament'] as const) {
describe('getParameterValue()', () => {
const nodeTypes = Helpers.NodeTypes();
const workflow = new Workflow({
id: '1',
nodes: [
{
name: 'node',
@ -35,10 +35,10 @@ for (const evaluator of ['tmpl', 'tournament'] as const) {
active: false,
nodeTypes,
});
const expression = new Expression(workflow);
const expression = workflow.expression;
const evaluate = (value: string) =>
expression.getParameterValue(value, null, 0, 0, 'node', [], 'manual', '', {});
expression.getParameterValue(value, null, 0, 0, 'node', [], 'manual', {});
it('should not be able to use global built-ins from denylist', () => {
expect(evaluate('={{document}}')).toEqual({});
@ -84,9 +84,13 @@ for (const evaluator of ['tmpl', 'tournament'] as const) {
expect(evaluate('={{DateTime.now().toLocaleString()}}')).toEqual(
DateTime.now().toLocaleString(),
);
jest.useFakeTimers({ now: new Date() });
expect(evaluate('={{Interval.after(new Date(), 100)}}')).toEqual(
Interval.after(new Date(), 100),
);
jest.useRealTimers();
expect(evaluate('={{Duration.fromMillis(100)}}')).toEqual(Duration.fromMillis(100));
expect(evaluate('={{new Object()}}')).toEqual(new Object());
@ -170,6 +174,7 @@ for (const evaluator of ['tmpl', 'tournament'] as const) {
describe('Test all expression value fixtures', () => {
const nodeTypes = Helpers.NodeTypes();
const workflow = new Workflow({
id: '1',
nodes: [
{
name: 'node',
@ -185,21 +190,11 @@ for (const evaluator of ['tmpl', 'tournament'] as const) {
nodeTypes,
});
const expression = new Expression(workflow);
const expression = workflow.expression;
const evaluate = (value: string, data: INodeExecutionData[]) => {
const itemIndex = data.length === 0 ? -1 : 0;
return expression.getParameterValue(
value,
null,
0,
itemIndex,
'node',
data,
'manual',
'',
{},
);
return expression.getParameterValue(value, null, 0, itemIndex, 'node', data, 'manual', {});
};
for (const t of baseFixtures) {

19
packages/workflow/test/ExpressionExtensions/DateExtensions.test.ts
View file

@ -3,7 +3,10 @@
*/
import { DateTime } from 'luxon';
import { evaluate, getLocalISOString, TEST_TIMEZONE } from './Helpers';
import { getGlobalState } from '@/GlobalState';
import { evaluate, getLocalISOString } from './Helpers';
const { defaultTimezone } = getGlobalState();
describe('Data Transformation Functions', () => {
describe('Date Data Transformation Functions', () => {
@ -16,17 +19,17 @@ describe('Data Transformation Functions', () => {
test('.beginningOf("week") should work correctly on a date', () => {
expect(evaluate('={{ DateTime.local(2023, 1, 20).beginningOf("week") }}')).toEqual(
DateTime.local(2023, 1, 16, { zone: TEST_TIMEZONE }),
DateTime.local(2023, 1, 16, { zone: defaultTimezone }),
);
expect(evaluate('={{ new Date(2023, 0, 20).beginningOf("week") }}')).toEqual(
DateTime.local(2023, 1, 16, { zone: TEST_TIMEZONE }).toJSDate(),
DateTime.local(2023, 1, 16, { zone: defaultTimezone }).toJSDate(),
);
});
test('.beginningOf("week") should work correctly on a string', () => {
const evaluatedDate = evaluate('={{ "2023-01-30".toDate().beginningOf("week") }}');
const expectedDate = DateTime.local(2023, 1, 23, { zone: TEST_TIMEZONE }).toJSDate();
const expectedDate = DateTime.local(2023, 1, 23, { zone: defaultTimezone }).toJSDate();
if (evaluatedDate && evaluatedDate instanceof Date) {
expect(evaluatedDate.toDateString()).toEqual(expectedDate.toDateString());
@ -35,7 +38,7 @@ describe('Data Transformation Functions', () => {
test('.beginningOf("month") should work correctly on a string', () => {
const evaluatedDate = evaluate('={{ "2023-06-16".toDate().beginningOf("month") }}');
const expectedDate = DateTime.local(2023, 6, 1, { zone: TEST_TIMEZONE }).toJSDate();
const expectedDate = DateTime.local(2023, 6, 1, { zone: defaultTimezone }).toJSDate();
if (evaluatedDate && evaluatedDate instanceof Date) {
expect(evaluatedDate.toDateString()).toEqual(expectedDate.toDateString());
@ -44,7 +47,7 @@ describe('Data Transformation Functions', () => {
test('.beginningOf("year") should work correctly on a string', () => {
const evaluatedDate = evaluate('={{ "2023-01-30".toDate().beginningOf("year") }}');
const expectedDate = DateTime.local(2023, 1, 1, { zone: TEST_TIMEZONE }).toJSDate();
const expectedDate = DateTime.local(2023, 1, 1, { zone: defaultTimezone }).toJSDate();
if (evaluatedDate && evaluatedDate instanceof Date) {
expect(evaluatedDate.toDateString()).toEqual(expectedDate.toDateString());
@ -53,10 +56,10 @@ describe('Data Transformation Functions', () => {
test('.endOfMonth() should work correctly on a date', () => {
expect(evaluate('={{ DateTime.local(2023, 1, 16).endOfMonth() }}')).toEqual(
DateTime.local(2023, 1, 31, 23, 59, 59, 999, { zone: TEST_TIMEZONE }),
DateTime.local(2023, 1, 31, 23, 59, 59, 999, { zone: defaultTimezone }),
);
expect(evaluate('={{ new Date(2023, 0, 16).endOfMonth() }}')).toEqual(
DateTime.local(2023, 1, 31, 23, 59, 59, 999, { zone: TEST_TIMEZONE }).toJSDate(),
DateTime.local(2023, 1, 31, 23, 59, 59, 999, { zone: defaultTimezone }).toJSDate(),
);
});

9
packages/workflow/test/ExpressionExtensions/Helpers.ts
View file

@ -1,10 +1,7 @@
import type { IDataObject } from '@/Interfaces';
import { Expression } from '@/Expression';
import { Workflow } from '@/Workflow';
import * as Helpers from '../Helpers';
export const TEST_TIMEZONE = 'America/New_York';
export const nodeTypes = Helpers.NodeTypes();
export const workflow = new Workflow({
nodes: [
@ -20,11 +17,8 @@ export const workflow = new Workflow({
connections: {},
active: false,
nodeTypes,
settings: {
timezone: TEST_TIMEZONE,
},
});
export const expression = new Expression(workflow);
export const expression = workflow.expression;
export const evaluate = (value: string, values?: IDataObject[]) =>
expression.getParameterValue(
@ -35,7 +29,6 @@ export const evaluate = (value: string, values?: IDataObject[]) =>
'node',
values?.map((v) => ({ json: v })) ?? [],
'manual',
TEST_TIMEZONE,
{},
);

13
packages/workflow/test/Helpers.ts
View file

@ -37,6 +37,8 @@ import type { Workflow } from '@/Workflow';
import { WorkflowDataProxy } from '@/WorkflowDataProxy';
import { WorkflowHooks } from '@/WorkflowHooks';
import * as NodeHelpers from '@/NodeHelpers';
import { deepCopy } from '@/utils';
import { getGlobalState } from '@/GlobalState';
export interface INodeTypesObject {
[key: string]: INodeType;
@ -127,7 +129,6 @@ export function getNodeParameter(
parameterName: string,
itemIndex: number,
mode: WorkflowExecuteMode,
timezone: string,
additionalKeys: IWorkflowDataProxyAdditionalKeys,
executeData: IExecuteData,
fallbackValue?: any,
@ -153,7 +154,6 @@ export function getNodeParameter(
node.name,
connectionInputData,
mode,
timezone,
additionalKeys,
);
} catch (e) {
@ -240,7 +240,6 @@ export function getExecuteFunctions(
parameterName,
itemIndex,
mode,
additionalData.timezone,
{},
fallbackValue,
);
@ -255,7 +254,7 @@ export function getExecuteFunctions(
return additionalData.restApiUrl;
},
getTimezone: (): string => {
return additionalData.timezone;
return workflow.settings.timezone ?? getGlobalState().defaultTimezone;
},
getExecuteData: (): IExecuteData => {
return executeData;
@ -277,7 +276,6 @@ export function getExecuteFunctions(
connectionInputData,
{},
mode,
additionalData.timezone,
{},
executeData,
);
@ -421,7 +419,7 @@ export function getExecuteSingleFunctions(
return additionalData.restApiUrl;
},
getTimezone: (): string => {
return additionalData.timezone;
return workflow.settings.timezone ?? getGlobalState().defaultTimezone;
},
getExecuteData: (): IExecuteData => {
return executeData;
@ -444,7 +442,6 @@ export function getExecuteSingleFunctions(
parameterName,
itemIndex,
mode,
additionalData.timezone,
{},
fallbackValue,
);
@ -466,7 +463,6 @@ export function getExecuteSingleFunctions(
connectionInputData,
{},
mode,
additionalData.timezone,
{},
executeData,
);
@ -679,7 +675,6 @@ export function WorkflowExecuteAdditionalData(): IWorkflowExecuteAdditionalData
executeWorkflow: async (workflowInfo: IExecuteWorkflowInfo): Promise<any> => {},
sendDataToUI: (message: string) => {},
restApiUrl: '',
timezone: 'America/New_York',
webhookBaseUrl: 'webhook',
webhookWaitingBaseUrl: 'webhook-waiting',
webhookTestBaseUrl: 'webhook-test',

3
packages/workflow/test/Workflow.test.ts
View file

@ -1182,7 +1182,6 @@ describe('Workflow', () => {
];
const nodeTypes = Helpers.NodeTypes();
const timezone = 'America/New_York';
for (const testData of tests) {
test(testData.description, () => {
@ -1310,7 +1309,6 @@ describe('Workflow', () => {
activeNodeName,
connectionInputData,
'manual',
timezone,
{},
);
expect(result).toEqual(testData.output[parameterName]);
@ -1465,7 +1463,6 @@ describe('Workflow', () => {
activeNodeName,
connectionInputData,
'manual',
timezone,
{},
);

3
packages/workflow/test/WorkflowDataProxy.test.ts
View file

@ -253,10 +253,9 @@ describe('WorkflowDataProxy', () => {
0,
0,
nameLastNode,
lastNodeConnectionInputData || [],
lastNodeConnectionInputData ?? [],
{},
'manual',
'America/New_York',
{},
executeData,
);