mirror of
https://github.com/n8n-io/n8n.git
synced 2024-12-25 12:44:07 -08:00
fix(core): Ensure executions list is properly filtered for all users (#4765)
Also updates executions API to have EE version
This commit is contained in:
freya
GitHub
parent
ada73ed41d
commit
ddf787c087
|
|
@ -109,7 +109,7 @@ import type {
|
|||
import { userManagementRouter } from '@/UserManagement';
|
||||
import { resolveJwt } from '@/UserManagement/auth/jwt';
|
||||
|
||||
import { executionsController } from '@/api/executions.api';
|
||||
import { executionsController } from '@/executions/executions.controller';
|
||||
import { nodeTypesController } from '@/api/nodeTypes.api';
|
||||
import { tagsController } from '@/api/tags.api';
|
||||
import { loadPublicApiVersions } from '@/PublicApi';
|
||||
|
|
|
|||
70
packages/cli/src/executions/executions.controller.ee.ts
Normal file
70
packages/cli/src/executions/executions.controller.ee.ts
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
import express from 'express';
|
||||
import config from '@/config';
|
||||
import {
|
||||
IExecutionFlattedResponse,
|
||||
IExecutionResponse,
|
||||
IExecutionsListResponse,
|
||||
} from '@/Interfaces';
|
||||
import type { ExecutionRequest } from '@/requests';
|
||||
import * as ResponseHelper from '@/ResponseHelper';
|
||||
import { isSharingEnabled } from '@/UserManagement/UserManagementHelper';
|
||||
import { EEExecutionsService } from './executions.service.ee';
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/naming-convention
|
||||
export const EEExecutionsController = express.Router();
|
||||
|
||||
EEExecutionsController.use((req, res, next) => {
|
||||
if (!isSharingEnabled() || !config.getEnv('enterprise.workflowSharingEnabled')) {
|
||||
// skip ee router and use free one
|
||||
next('router');
|
||||
return;
|
||||
}
|
||||
// use ee router
|
||||
next();
|
||||
});
|
||||
|
||||
/**
|
||||
* GET /executions
|
||||
*/
|
||||
EEExecutionsController.get(
|
||||
'/',
|
||||
ResponseHelper.send(async (req: ExecutionRequest.GetAll): Promise<IExecutionsListResponse> => {
|
||||
return EEExecutionsService.getExecutionsList(req);
|
||||
}),
|
||||
);
|
||||
|
||||
/**
|
||||
* GET /executions/:id
|
||||
*/
|
||||
EEExecutionsController.get(
|
||||
'/:id',
|
||||
ResponseHelper.send(
|
||||
async (
|
||||
req: ExecutionRequest.Get,
|
||||
): Promise<IExecutionResponse | IExecutionFlattedResponse | undefined> => {
|
||||
return EEExecutionsService.getExecution(req);
|
||||
},
|
||||
),
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /executions/:id/retry
|
||||
*/
|
||||
EEExecutionsController.post(
|
||||
'/:id/retry',
|
||||
ResponseHelper.send(async (req: ExecutionRequest.Retry): Promise<boolean> => {
|
||||
return EEExecutionsService.retryExecution(req);
|
||||
}),
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /executions/delete
|
||||
* INFORMATION: We use POST instead of DELETE to not run into any issues with the query data
|
||||
* getting too long
|
||||
*/
|
||||
EEExecutionsController.post(
|
||||
'/delete',
|
||||
ResponseHelper.send(async (req: ExecutionRequest.Delete): Promise<void> => {
|
||||
await EEExecutionsService.deleteExecutions(req);
|
||||
}),
|
||||
);
|
||||
74
packages/cli/src/executions/executions.controller.ts
Normal file
74
packages/cli/src/executions/executions.controller.ts
Normal file
|
|
@ -0,0 +1,74 @@
|
|||
import express from 'express';
|
||||
import { LoggerProxy } from 'n8n-workflow';
|
||||
import {
|
||||
IExecutionFlattedResponse,
|
||||
IExecutionResponse,
|
||||
IExecutionsListResponse,
|
||||
} from '@/Interfaces';
|
||||
import * as ResponseHelper from '@/ResponseHelper';
|
||||
import { getLogger } from '@/Logger';
|
||||
import type { ExecutionRequest } from '@/requests';
|
||||
import { EEExecutionsController } from './executions.controller.ee';
|
||||
import { ExecutionsService } from './executions.service';
|
||||
|
||||
export const executionsController = express.Router();
|
||||
|
||||
/**
|
||||
* Initialise Logger if needed
|
||||
*/
|
||||
executionsController.use((req, res, next) => {
|
||||
try {
|
||||
LoggerProxy.getInstance();
|
||||
} catch (error) {
|
||||
LoggerProxy.init(getLogger());
|
||||
}
|
||||
next();
|
||||
});
|
||||
|
||||
executionsController.use('/', EEExecutionsController);
|
||||
|
||||
/**
|
||||
* GET /executions
|
||||
*/
|
||||
executionsController.get(
|
||||
'/',
|
||||
ResponseHelper.send(async (req: ExecutionRequest.GetAll): Promise<IExecutionsListResponse> => {
|
||||
return ExecutionsService.getExecutionsList(req);
|
||||
}),
|
||||
);
|
||||
|
||||
/**
|
||||
* GET /executions/:id
|
||||
*/
|
||||
executionsController.get(
|
||||
'/:id',
|
||||
ResponseHelper.send(
|
||||
async (
|
||||
req: ExecutionRequest.Get,
|
||||
): Promise<IExecutionResponse | IExecutionFlattedResponse | undefined> => {
|
||||
return ExecutionsService.getExecution(req);
|
||||
},
|
||||
),
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /executions/:id/retry
|
||||
*/
|
||||
executionsController.post(
|
||||
'/:id/retry',
|
||||
ResponseHelper.send(async (req: ExecutionRequest.Retry): Promise<boolean> => {
|
||||
return ExecutionsService.retryExecution(req);
|
||||
}),
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /executions/delete
|
||||
* INFORMATION: We use POST instead of DELETE to not run into any issues with the query data
|
||||
* getting too long
|
||||
*/
|
||||
executionsController.post(
|
||||
'/delete',
|
||||
ResponseHelper.send(async (req: ExecutionRequest.Delete): Promise<void> => {
|
||||
await ExecutionsService.deleteExecutions(req);
|
||||
}),
|
||||
);
|
||||
13
packages/cli/src/executions/executions.service.ee.ts
Normal file
13
packages/cli/src/executions/executions.service.ee.ts
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
import { User } from '@/databases/entities/User';
|
||||
import { getSharedWorkflowIds } from '@/WorkflowHelpers';
|
||||
import { ExecutionsService } from './executions.service';
|
||||
|
||||
export class EEExecutionsService extends ExecutionsService {
|
||||
/**
|
||||
* Function to get the workflow Ids for a User regardless of role
|
||||
*/
|
||||
static async getWorkflowIdsForUser(user: User): Promise<number[]> {
|
||||
// Get all workflows
|
||||
return getSharedWorkflowIds(user);
|
||||
}
|
||||
}
|
||||
|
|
@ -1,47 +1,39 @@
|
|||
/* eslint-disable no-restricted-syntax */
|
||||
/* eslint-disable @typescript-eslint/restrict-template-expressions */
|
||||
/* eslint-disable @typescript-eslint/no-non-null-assertion */
|
||||
/* eslint-disable @typescript-eslint/no-unsafe-assignment */
|
||||
/* eslint-disable @typescript-eslint/no-unsafe-return */
|
||||
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
|
||||
/* eslint-disable @typescript-eslint/no-unsafe-argument */
|
||||
/* eslint-disable @typescript-eslint/no-unused-vars */
|
||||
import express from 'express';
|
||||
import { validate as jsonSchemaValidate } from 'jsonschema';
|
||||
import { BinaryDataManager } from 'n8n-core';
|
||||
import {
|
||||
deepCopy,
|
||||
IDataObject,
|
||||
IWorkflowBase,
|
||||
JsonObject,
|
||||
jsonParse,
|
||||
LoggerProxy,
|
||||
Workflow,
|
||||
} from 'n8n-workflow';
|
||||
import { deepCopy, IDataObject, LoggerProxy, JsonObject, jsonParse, Workflow } from 'n8n-workflow';
|
||||
import { FindOperator, In, IsNull, LessThanOrEqual, Not, Raw } from 'typeorm';
|
||||
|
||||
import * as ActiveExecutions from '@/ActiveExecutions';
|
||||
import * as Db from '@/Db';
|
||||
import * as GenericHelpers from '@/GenericHelpers';
|
||||
import config from '@/config';
|
||||
import { User } from '@/databases/entities/User';
|
||||
import { DEFAULT_EXECUTIONS_GET_ALL_LIMIT } from '@/GenericHelpers';
|
||||
import {
|
||||
DatabaseType,
|
||||
IExecutionFlattedResponse,
|
||||
IExecutionResponse,
|
||||
IExecutionsListResponse,
|
||||
IWorkflowBase,
|
||||
IWorkflowExecutionDataProcess,
|
||||
} from '@/Interfaces';
|
||||
import { NodeTypes } from '@/NodeTypes';
|
||||
import * as ResponseHelper from '@/ResponseHelper';
|
||||
import { WorkflowRunner } from '@/WorkflowRunner';
|
||||
import config from '@/config';
|
||||
import { User } from '@db/entities/User';
|
||||
import { DEFAULT_EXECUTIONS_GET_ALL_LIMIT } from '@/GenericHelpers';
|
||||
import { getLogger } from '@/Logger';
|
||||
import * as Queue from '@/Queue';
|
||||
import type { ExecutionRequest } from '@/requests';
|
||||
import * as ResponseHelper from '@/ResponseHelper';
|
||||
import { getSharedWorkflowIds } from '@/WorkflowHelpers';
|
||||
import { WorkflowRunner } from '@/WorkflowRunner';
|
||||
import { DatabaseType, Db, GenericHelpers } from '..';
|
||||
|
||||
export const executionsController = express.Router();
|
||||
interface IGetExecutionsQueryFilter {
|
||||
id?: FindOperator<string>;
|
||||
finished?: boolean;
|
||||
mode?: string;
|
||||
retryOf?: string;
|
||||
retrySuccessId?: string;
|
||||
workflowId?: number | string;
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
waitTill?: FindOperator<any> | boolean;
|
||||
}
|
||||
|
||||
const schemaGetExecutionsQueryFilter = {
|
||||
$id: '/IGetExecutionsQueryFilter',
|
||||
|
|
@ -58,51 +50,33 @@ const schemaGetExecutionsQueryFilter = {
|
|||
|
||||
const allowedExecutionsQueryFilterFields = Object.keys(schemaGetExecutionsQueryFilter.properties);
|
||||
|
||||
interface IGetExecutionsQueryFilter {
|
||||
id?: FindOperator<string>;
|
||||
finished?: boolean;
|
||||
mode?: string;
|
||||
retryOf?: string;
|
||||
retrySuccessId?: string;
|
||||
workflowId?: number | string;
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
waitTill?: FindOperator<any> | boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialise Logger if needed
|
||||
export class ExecutionsService {
|
||||
/**
|
||||
* Function to get the workflow Ids for a User
|
||||
* Overridden in EE version to ignore roles
|
||||
*/
|
||||
executionsController.use((req, res, next) => {
|
||||
try {
|
||||
LoggerProxy.getInstance();
|
||||
} catch (error) {
|
||||
LoggerProxy.init(getLogger());
|
||||
static async getWorkflowIdsForUser(user: User): Promise<number[]> {
|
||||
// Get all workflows using owner role
|
||||
return getSharedWorkflowIds(user, ['owner']);
|
||||
}
|
||||
next();
|
||||
});
|
||||
|
||||
/**
|
||||
/**
|
||||
* Helper function to retrieve count of Executions
|
||||
*/
|
||||
async function getExecutionsCount(
|
||||
static async getExecutionsCount(
|
||||
countFilter: IDataObject,
|
||||
user: User,
|
||||
): Promise<{ count: number; estimated: boolean }> {
|
||||
): Promise<{ count: number; estimated: boolean }> {
|
||||
const dbType = (await GenericHelpers.getConfigValue('database.type')) as DatabaseType;
|
||||
const filteredFields = Object.keys(countFilter).filter((field) => field !== 'id');
|
||||
|
||||
// For databases other than Postgres, do a regular count
|
||||
// when filtering based on `workflowId` or `finished` fields.
|
||||
if (dbType !== 'postgresdb' || filteredFields.length > 0 || user.globalRole.name !== 'owner') {
|
||||
const sharedWorkflowIds = await getSharedWorkflowIds(user);
|
||||
|
||||
const count = await Db.collections.Execution.count({
|
||||
where: {
|
||||
workflowId: In(sharedWorkflowIds),
|
||||
...countFilter,
|
||||
},
|
||||
});
|
||||
const sharedWorkflowIds = await this.getWorkflowIdsForUser(user);
|
||||
|
||||
const countParams = { where: { workflowId: In(sharedWorkflowIds), ...countFilter } };
|
||||
const count = await Db.collections.Execution.count(countParams);
|
||||
return { count, estimated: false };
|
||||
}
|
||||
|
||||
|
|
@ -134,15 +108,10 @@ async function getExecutionsCount(
|
|||
});
|
||||
|
||||
return { count, estimated: false };
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* GET /executions
|
||||
*/
|
||||
executionsController.get(
|
||||
'/',
|
||||
ResponseHelper.send(async (req: ExecutionRequest.GetAll): Promise<IExecutionsListResponse> => {
|
||||
const sharedWorkflowIds = await getSharedWorkflowIds(req.user);
|
||||
static async getExecutionsList(req: ExecutionRequest.GetAll): Promise<IExecutionsListResponse> {
|
||||
const sharedWorkflowIds = await this.getWorkflowIdsForUser(req.user);
|
||||
if (sharedWorkflowIds.length === 0) {
|
||||
// return early since without shared workflows there can be no hits
|
||||
// (note: getSharedWorkflowIds() returns _all_ workflow ids for global owners)
|
||||
|
|
@ -263,7 +232,10 @@ executionsController.get(
|
|||
|
||||
const executions = await query.getMany();
|
||||
|
||||
const { count, estimated } = await getExecutionsCount(countFilter as IDataObject, req.user);
|
||||
const { count, estimated } = await this.getExecutionsCount(
|
||||
countFilter as IDataObject,
|
||||
req.user,
|
||||
);
|
||||
|
||||
const formattedExecutions = executions.map((execution) => {
|
||||
return {
|
||||
|
|
@ -285,24 +257,15 @@ executionsController.get(
|
|||
results: formattedExecutions,
|
||||
estimated,
|
||||
};
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* GET /executions/:id
|
||||
*/
|
||||
executionsController.get(
|
||||
'/:id',
|
||||
ResponseHelper.send(
|
||||
async (
|
||||
static async getExecution(
|
||||
req: ExecutionRequest.Get,
|
||||
): Promise<IExecutionResponse | IExecutionFlattedResponse | undefined> => {
|
||||
const { id: executionId } = req.params;
|
||||
|
||||
const sharedWorkflowIds = await getSharedWorkflowIds(req.user);
|
||||
|
||||
): Promise<IExecutionResponse | IExecutionFlattedResponse | undefined> {
|
||||
const sharedWorkflowIds = await this.getWorkflowIdsForUser(req.user);
|
||||
if (!sharedWorkflowIds.length) return undefined;
|
||||
|
||||
const { id: executionId } = req.params;
|
||||
const execution = await Db.collections.Execution.findOne({
|
||||
where: {
|
||||
id: executionId,
|
||||
|
|
@ -329,22 +292,13 @@ executionsController.get(
|
|||
id: id.toString(),
|
||||
...rest,
|
||||
};
|
||||
},
|
||||
),
|
||||
);
|
||||
|
||||
/**
|
||||
* POST /executions/:id/retry
|
||||
*/
|
||||
executionsController.post(
|
||||
'/:id/retry',
|
||||
ResponseHelper.send(async (req: ExecutionRequest.Retry): Promise<boolean> => {
|
||||
const { id: executionId } = req.params;
|
||||
|
||||
const sharedWorkflowIds = await getSharedWorkflowIds(req.user);
|
||||
}
|
||||
|
||||
static async retryExecution(req: ExecutionRequest.Retry): Promise<boolean> {
|
||||
const sharedWorkflowIds = await this.getWorkflowIdsForUser(req.user);
|
||||
if (!sharedWorkflowIds.length) return false;
|
||||
|
||||
const { id: executionId } = req.params;
|
||||
const execution = await Db.collections.Execution.findOne({
|
||||
where: {
|
||||
id: executionId,
|
||||
|
|
@ -404,7 +358,7 @@ executionsController.post(
|
|||
if (req.body.loadWorkflow) {
|
||||
// Loads the currently saved workflow to execute instead of the
|
||||
// one saved at the time of the execution.
|
||||
const workflowId = fullExecutionData.workflowData.id;
|
||||
const workflowId = fullExecutionData.workflowData.id as string;
|
||||
const workflowData = (await Db.collections.Workflow.findOne(workflowId)) as IWorkflowBase;
|
||||
|
||||
if (workflowData === undefined) {
|
||||
|
|
@ -458,17 +412,15 @@ executionsController.post(
|
|||
}
|
||||
|
||||
return !!executionData.finished;
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* POST /executions/delete
|
||||
* INFORMATION: We use POST instead of DELETE to not run into any issues with the query data
|
||||
* getting too long
|
||||
*/
|
||||
executionsController.post(
|
||||
'/delete',
|
||||
ResponseHelper.send(async (req: ExecutionRequest.Delete): Promise<void> => {
|
||||
static async deleteExecutions(req: ExecutionRequest.Delete): Promise<void> {
|
||||
const sharedWorkflowIds = await this.getWorkflowIdsForUser(req.user);
|
||||
if (sharedWorkflowIds.length === 0) {
|
||||
// return early since without shared workflows there can be no hits
|
||||
// (note: getSharedWorkflowIds() returns _all_ workflow ids for global owners)
|
||||
return;
|
||||
}
|
||||
const { deleteBefore, ids, filters: requestFiltersRaw } = req.body;
|
||||
let requestFilters;
|
||||
if (requestFiltersRaw) {
|
||||
|
|
@ -490,13 +442,6 @@ executionsController.post(
|
|||
throw new Error('Either "deleteBefore" or "ids" must be present in the request body');
|
||||
}
|
||||
|
||||
const sharedWorkflowIds = await getSharedWorkflowIds(req.user);
|
||||
if (sharedWorkflowIds.length === 0) {
|
||||
// return early since without shared workflows there can be no hits
|
||||
// (note: getSharedWorkflowIds() returns _all_ workflow ids for global owners)
|
||||
return;
|
||||
}
|
||||
|
||||
const binaryDataManager = BinaryDataManager.getInstance();
|
||||
|
||||
// delete executions by date, if user may access the underlying workflows
|
||||
|
|
@ -558,5 +503,5 @@ executionsController.post(
|
|||
|
||||
await Db.collections.Execution.delete(idsToDelete);
|
||||
}
|
||||
}),
|
||||
);
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue