mirror of
https://github.com/n8n-io/n8n.git
synced 2024-11-14 16:44:07 -08:00
Merge branch 'add-workflow-filters' of github.com:n8n-io/n8n into add-workflow-filters
This commit is contained in:
commit
6709fd3dde
|
@ -100,6 +100,9 @@ export class WorkflowEntity extends WithTimestampsAndStringId implements IWorkfl
|
||||||
|
|
||||||
@Column({ type: 'simple-array', default: '' })
|
@Column({ type: 'simple-array', default: '' })
|
||||||
nodeNames: string[];
|
nodeNames: string[];
|
||||||
|
|
||||||
|
@Column({ type: 'simple-array', default: '' })
|
||||||
|
webhookURLs: string[];
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -6,10 +6,16 @@ export class AddWorkflowFilterColumns1730286483664 implements ReversibleMigratio
|
||||||
column('credentialIds').text,
|
column('credentialIds').text,
|
||||||
column('nodeTypes').text,
|
column('nodeTypes').text,
|
||||||
column('nodeNames').text,
|
column('nodeNames').text,
|
||||||
|
column('webhookURLs').text,
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
||||||
async down({ schemaBuilder: { dropColumns } }: MigrationContext) {
|
async down({ schemaBuilder: { dropColumns } }: MigrationContext) {
|
||||||
await dropColumns('workflow_entity', ['credentialIds', 'nodeTypes', 'nodeNames']);
|
await dropColumns('workflow_entity', [
|
||||||
|
'credentialIds',
|
||||||
|
'nodeTypes',
|
||||||
|
'nodeNames',
|
||||||
|
'webhookURLs',
|
||||||
|
]);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -97,12 +97,14 @@ export class WorkflowRepository extends Repository<WorkflowEntity> {
|
||||||
.execute();
|
.execute();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// eslint-disable-next-line complexity
|
||||||
async getMany(
|
async getMany(
|
||||||
sharedWorkflowIds: string[],
|
sharedWorkflowIds: string[],
|
||||||
options: ListQuery.Options = {},
|
options: ListQuery.Options = {},
|
||||||
credentialIds: string[] = [],
|
credentialIds: string[] = [],
|
||||||
nodeTypes: string[] = [],
|
nodeTypes: string[] = [],
|
||||||
nodeName = '',
|
nodeName = '',
|
||||||
|
webhookURL = '',
|
||||||
) {
|
) {
|
||||||
if (sharedWorkflowIds.length === 0) return { workflows: [], count: 0 };
|
if (sharedWorkflowIds.length === 0) return { workflows: [], count: 0 };
|
||||||
|
|
||||||
|
@ -167,6 +169,10 @@ export class WorkflowRepository extends Repository<WorkflowEntity> {
|
||||||
where.nodeNames = Like(`%${escapeCommas(nodeName)}%`);
|
where.nodeNames = Like(`%${escapeCommas(nodeName)}%`);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (webhookURL) {
|
||||||
|
where.webhookURLs = Like(`%${escapeCommas(webhookURL)}%`);
|
||||||
|
}
|
||||||
|
|
||||||
const findManyOptions: FindManyOptions<WorkflowEntity> = {
|
const findManyOptions: FindManyOptions<WorkflowEntity> = {
|
||||||
select: { ...select, id: true },
|
select: { ...select, id: true },
|
||||||
where,
|
where,
|
||||||
|
|
|
@ -45,3 +45,19 @@ export function getEscapedNodeNames(workflow: WorkflowEntity): string[] {
|
||||||
|
|
||||||
return nodeNames;
|
return nodeNames;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function getEscapedWebhookURLs(workflow: WorkflowEntity): string[] {
|
||||||
|
const webhookURLs: string[] = [];
|
||||||
|
|
||||||
|
for (const node of workflow.nodes) {
|
||||||
|
if (
|
||||||
|
node.type === 'n8n-nodes-base.webhook' &&
|
||||||
|
typeof node.parameters.path === 'string' &&
|
||||||
|
node.parameters.path.length > 0
|
||||||
|
) {
|
||||||
|
webhookURLs.push(escapeCommas(node.parameters.path));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return webhookURLs;
|
||||||
|
}
|
||||||
|
|
|
@ -36,6 +36,7 @@ export declare namespace WorkflowRequest {
|
||||||
credentialIds?: string;
|
credentialIds?: string;
|
||||||
nodeTypes?: string;
|
nodeTypes?: string;
|
||||||
nodeName?: string;
|
nodeName?: string;
|
||||||
|
webhookURL?: string;
|
||||||
}
|
}
|
||||||
> & {
|
> & {
|
||||||
listQueryOptions: ListQuery.Options;
|
listQueryOptions: ListQuery.Options;
|
||||||
|
|
|
@ -33,7 +33,12 @@ import { RoleService } from '@/services/role.service';
|
||||||
import { TagService } from '@/services/tag.service';
|
import { TagService } from '@/services/tag.service';
|
||||||
import * as WorkflowHelpers from '@/workflow-helpers';
|
import * as WorkflowHelpers from '@/workflow-helpers';
|
||||||
|
|
||||||
import { getEncodedCredentialIds, getEncodedNodeTypes, getEscapedNodeNames } from './utils';
|
import {
|
||||||
|
getEncodedCredentialIds,
|
||||||
|
getEncodedNodeTypes,
|
||||||
|
getEscapedNodeNames,
|
||||||
|
getEscapedWebhookURLs,
|
||||||
|
} from './utils';
|
||||||
import { WorkflowHistoryService } from './workflow-history/workflow-history.service.ee';
|
import { WorkflowHistoryService } from './workflow-history/workflow-history.service.ee';
|
||||||
import { WorkflowSharingService } from './workflow-sharing.service';
|
import { WorkflowSharingService } from './workflow-sharing.service';
|
||||||
|
|
||||||
|
@ -65,6 +70,7 @@ export class WorkflowService {
|
||||||
credentialIds: string[] = [],
|
credentialIds: string[] = [],
|
||||||
nodeTypes: string[] = [],
|
nodeTypes: string[] = [],
|
||||||
nodeName = '',
|
nodeName = '',
|
||||||
|
webhookURL = '',
|
||||||
) {
|
) {
|
||||||
const sharedWorkflowIds = await this.workflowSharingService.getSharedWorkflowIds(user, {
|
const sharedWorkflowIds = await this.workflowSharingService.getSharedWorkflowIds(user, {
|
||||||
scopes: ['workflow:read'],
|
scopes: ['workflow:read'],
|
||||||
|
@ -77,6 +83,7 @@ export class WorkflowService {
|
||||||
credentialIds,
|
credentialIds,
|
||||||
nodeTypes,
|
nodeTypes,
|
||||||
nodeName,
|
nodeName,
|
||||||
|
webhookURL,
|
||||||
);
|
);
|
||||||
|
|
||||||
if (hasSharing(workflows)) {
|
if (hasSharing(workflows)) {
|
||||||
|
@ -204,6 +211,7 @@ export class WorkflowService {
|
||||||
credentialIds: getEncodedCredentialIds(workflow),
|
credentialIds: getEncodedCredentialIds(workflow),
|
||||||
nodeTypes: getEncodedNodeTypes(workflow),
|
nodeTypes: getEncodedNodeTypes(workflow),
|
||||||
nodeNames: getEscapedNodeNames(workflow),
|
nodeNames: getEscapedNodeNames(workflow),
|
||||||
|
webhookURLs: getEscapedWebhookURLs(workflow),
|
||||||
});
|
});
|
||||||
|
|
||||||
if (tagIds && !config.getEnv('workflowTagsDisabled')) {
|
if (tagIds && !config.getEnv('workflowTagsDisabled')) {
|
||||||
|
|
|
@ -38,7 +38,12 @@ import { UserManagementMailer } from '@/user-management/email';
|
||||||
import * as utils from '@/utils';
|
import * as utils from '@/utils';
|
||||||
import * as WorkflowHelpers from '@/workflow-helpers';
|
import * as WorkflowHelpers from '@/workflow-helpers';
|
||||||
|
|
||||||
import { getEncodedCredentialIds, getEncodedNodeTypes, getEscapedNodeNames } from './utils';
|
import {
|
||||||
|
getEncodedCredentialIds,
|
||||||
|
getEncodedNodeTypes,
|
||||||
|
getEscapedNodeNames,
|
||||||
|
getEscapedWebhookURLs,
|
||||||
|
} from './utils';
|
||||||
import { WorkflowExecutionService } from './workflow-execution.service';
|
import { WorkflowExecutionService } from './workflow-execution.service';
|
||||||
import { WorkflowHistoryService } from './workflow-history/workflow-history.service.ee';
|
import { WorkflowHistoryService } from './workflow-history/workflow-history.service.ee';
|
||||||
import { WorkflowRequest } from './workflow.request';
|
import { WorkflowRequest } from './workflow.request';
|
||||||
|
@ -119,6 +124,7 @@ export class WorkflowsController {
|
||||||
newWorkflow.credentialIds = getEncodedCredentialIds(newWorkflow);
|
newWorkflow.credentialIds = getEncodedCredentialIds(newWorkflow);
|
||||||
newWorkflow.nodeTypes = getEncodedNodeTypes(newWorkflow);
|
newWorkflow.nodeTypes = getEncodedNodeTypes(newWorkflow);
|
||||||
newWorkflow.nodeNames = getEscapedNodeNames(newWorkflow);
|
newWorkflow.nodeNames = getEscapedNodeNames(newWorkflow);
|
||||||
|
newWorkflow.webhookURLs = getEscapedWebhookURLs(newWorkflow);
|
||||||
|
|
||||||
let project: Project | null;
|
let project: Project | null;
|
||||||
const savedWorkflow = await Db.transaction(async (transactionManager) => {
|
const savedWorkflow = await Db.transaction(async (transactionManager) => {
|
||||||
|
@ -206,6 +212,7 @@ export class WorkflowsController {
|
||||||
req.query.credentialIds?.split(','),
|
req.query.credentialIds?.split(','),
|
||||||
req.query.nodeTypes?.split(','),
|
req.query.nodeTypes?.split(','),
|
||||||
req.query.nodeName,
|
req.query.nodeName,
|
||||||
|
req.query.webhookURL,
|
||||||
);
|
);
|
||||||
|
|
||||||
res.json({ count, data });
|
res.json({ count, data });
|
||||||
|
|
|
@ -127,6 +127,23 @@ describe('POST /workflows', () => {
|
||||||
expect(savedWorkflow.nodeNames[0]).toEqual(escapeCommas(workflow.nodes[0].name));
|
expect(savedWorkflow.nodeNames[0]).toEqual(escapeCommas(workflow.nodes[0].name));
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('should populate `nodeTypes`', async () => {
|
||||||
|
// ARRANGE
|
||||||
|
const workflow = makeWorkflow();
|
||||||
|
workflow.nodes[0].type = 'n8n-nodes-base.webhook';
|
||||||
|
workflow.nodes[0].parameters.path = 'foobar';
|
||||||
|
|
||||||
|
// ACT
|
||||||
|
await authOwnerAgent.post('/workflows').send(workflow).expect(200);
|
||||||
|
|
||||||
|
// ASSERT
|
||||||
|
const savedWorkflow = await getWorkflowById(workflow.id);
|
||||||
|
a.ok(savedWorkflow);
|
||||||
|
|
||||||
|
expect(savedWorkflow.webhookURLs).toHaveLength(1);
|
||||||
|
expect(savedWorkflow.webhookURLs[0]).toEqual(escapeCommas(workflow.nodes[0].parameters.path));
|
||||||
|
});
|
||||||
|
|
||||||
test('should return scopes on created workflow', async () => {
|
test('should return scopes on created workflow', async () => {
|
||||||
const payload = {
|
const payload = {
|
||||||
name: 'testing',
|
name: 'testing',
|
||||||
|
@ -666,7 +683,7 @@ describe('GET /workflows', () => {
|
||||||
expect(found.usedCredentials).toBeUndefined();
|
expect(found.usedCredentials).toBeUndefined();
|
||||||
});
|
});
|
||||||
|
|
||||||
test('should return workflows filtered by used node types', async () => {
|
test('should return workflows filtered by node name', async () => {
|
||||||
// ARRANGE
|
// ARRANGE
|
||||||
const node1: INode = {
|
const node1: INode = {
|
||||||
id: uuid(),
|
id: uuid(),
|
||||||
|
@ -730,6 +747,70 @@ describe('GET /workflows', () => {
|
||||||
expect(found.usedCredentials).toBeUndefined();
|
expect(found.usedCredentials).toBeUndefined();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('should return workflows filtered by node name', async () => {
|
||||||
|
// ARRANGE
|
||||||
|
const node1 = {
|
||||||
|
id: uuid(),
|
||||||
|
name: 'Action Network',
|
||||||
|
type: 'n8n-nodes-base.webhook',
|
||||||
|
parameters: { path: 'foobar' },
|
||||||
|
typeVersion: 1,
|
||||||
|
position: [0, 0],
|
||||||
|
} satisfies INode;
|
||||||
|
const workflow1 = await createWorkflow(
|
||||||
|
{ name: 'First', nodes: [node1], webhookURLs: [escapeCommas(node1.parameters.path)] },
|
||||||
|
owner,
|
||||||
|
);
|
||||||
|
|
||||||
|
const node2: INode = {
|
||||||
|
id: uuid(),
|
||||||
|
name: 'Action Network',
|
||||||
|
type: 'n8n-nodes-base.webhook',
|
||||||
|
parameters: { path: 'bar foo' },
|
||||||
|
typeVersion: 1,
|
||||||
|
position: [0, 0],
|
||||||
|
};
|
||||||
|
await createWorkflow({ name: 'Second', nodes: [node2] }, owner);
|
||||||
|
|
||||||
|
await createWorkflow({ name: 'Third' }, owner);
|
||||||
|
|
||||||
|
// ACT
|
||||||
|
const response = await authOwnerAgent
|
||||||
|
.get('/workflows')
|
||||||
|
.query(`webhookURL=${node1.parameters.path}`)
|
||||||
|
.expect(200);
|
||||||
|
|
||||||
|
// ASSERT
|
||||||
|
const ownerPersonalProject = await projectRepository.getPersonalProjectForUserOrFail(owner.id);
|
||||||
|
expect(response.body.count).toBe(1);
|
||||||
|
expect(response.body.data).toHaveLength(1);
|
||||||
|
expect(response.body.data[0]).toEqual(
|
||||||
|
objectContaining({
|
||||||
|
id: workflow1.id,
|
||||||
|
name: 'First',
|
||||||
|
active: workflow1.active,
|
||||||
|
tags: [],
|
||||||
|
createdAt: workflow1.createdAt.toISOString(),
|
||||||
|
updatedAt: workflow1.updatedAt.toISOString(),
|
||||||
|
versionId: workflow1.versionId,
|
||||||
|
homeProject: {
|
||||||
|
id: ownerPersonalProject.id,
|
||||||
|
name: owner.createPersonalProjectName(),
|
||||||
|
type: ownerPersonalProject.type,
|
||||||
|
},
|
||||||
|
sharedWithProjects: [],
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
const found = response.body.data.find(
|
||||||
|
(w: ListQuery.Workflow.WithOwnership) => w.name === 'First',
|
||||||
|
);
|
||||||
|
|
||||||
|
expect(found.nodes).toBeUndefined();
|
||||||
|
expect(found.sharedWithProjects).toHaveLength(0);
|
||||||
|
expect(found.usedCredentials).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
test('should return workflows with scopes when ?includeScopes=true', async () => {
|
test('should return workflows with scopes when ?includeScopes=true', async () => {
|
||||||
const [member1, member2] = await createManyUsers(2, {
|
const [member1, member2] = await createManyUsers(2, {
|
||||||
role: 'global:member',
|
role: 'global:member',
|
||||||
|
|
Loading…
Reference in a new issue