feat(API): Add tag support to public API (#8588)
Co-authored-by: Jesús Burgers <jesus.burgers@chakray.co.uk> Co-authored-by: Jesús Burgers <43568066+jburgers-chakray@users.noreply.github.com>
This commit is contained in:
Omar Ajoue
GitHub
@@ -1,4 +1,5 @@
|
||||
import type { SuperAgentTest } from 'supertest';
|
||||
import config from '@/config';
|
||||
import Container from 'typedi';
|
||||
import type { INode } from 'n8n-workflow';
|
||||
import { STARTING_NODES } from '@/constants';
|
||||
@@ -250,6 +251,43 @@ describe('GET /workflows', () => {
|
||||
}
|
||||
});
|
||||
|
||||
test('should return all owned workflows filtered by name', async () => {
|
||||
const workflowName = 'Workflow 1';
|
||||
|
||||
const [workflow] = await Promise.all([
|
||||
createWorkflow({ name: workflowName }, member),
|
||||
createWorkflow({}, member),
|
||||
]);
|
||||
|
||||
const response = await authMemberAgent.get(`/workflows?name=${workflowName}`);
|
||||
|
||||
expect(response.statusCode).toBe(200);
|
||||
expect(response.body.data.length).toBe(1);
|
||||
|
||||
const {
|
||||
id,
|
||||
connections,
|
||||
active,
|
||||
staticData,
|
||||
nodes,
|
||||
settings,
|
||||
name,
|
||||
createdAt,
|
||||
updatedAt,
|
||||
tags: wfTags,
|
||||
} = response.body.data[0];
|
||||
|
||||
expect(id).toBeDefined();
|
||||
expect(name).toBe(workflowName);
|
||||
expect(connections).toBeDefined();
|
||||
expect(active).toBe(false);
|
||||
expect(staticData).toBeDefined();
|
||||
expect(nodes).toBeDefined();
|
||||
expect(settings).toBeDefined();
|
||||
expect(createdAt).toBeDefined();
|
||||
expect(updatedAt).toBeDefined();
|
||||
});
|
||||
|
||||
test('should return all workflows for owner', async () => {
|
||||
await Promise.all([
|
||||
createWorkflow({}, owner),
|
||||
@@ -1111,3 +1149,308 @@ describe('PUT /workflows/:id', () => {
|
||||
expect(sharedWorkflow?.role).toEqual('workflow:owner');
|
||||
});
|
||||
});
|
||||
|
||||
describe('GET /workflows/:id/tags', () => {
|
||||
test('should fail due to missing API Key', testWithAPIKey('get', '/workflows/2/tags', null));
|
||||
|
||||
test('should fail due to invalid API Key', testWithAPIKey('get', '/workflows/2/tags', 'abcXYZ'));
|
||||
|
||||
test('should fail if workflowTagsDisabled', async () => {
|
||||
config.set('workflowTagsDisabled', true);
|
||||
|
||||
const response = await authOwnerAgent.get('/workflows/2/tags');
|
||||
|
||||
expect(response.statusCode).toBe(400);
|
||||
expect(response.body.message).toBe('Workflow Tags Disabled');
|
||||
});
|
||||
|
||||
test('should fail due to non-existing workflow', async () => {
|
||||
config.set('workflowTagsDisabled', false);
|
||||
|
||||
const response = await authOwnerAgent.get('/workflows/2/tags');
|
||||
|
||||
expect(response.statusCode).toBe(404);
|
||||
});
|
||||
|
||||
test('should return all tags of owned workflow', async () => {
|
||||
config.set('workflowTagsDisabled', false);
|
||||
|
||||
const tags = await Promise.all([await createTag({}), await createTag({})]);
|
||||
|
||||
const workflow = await createWorkflow({ tags }, member);
|
||||
|
||||
const response = await authMemberAgent.get(`/workflows/${workflow.id}/tags`);
|
||||
|
||||
expect(response.statusCode).toBe(200);
|
||||
expect(response.body.length).toBe(2);
|
||||
|
||||
for (const tag of response.body) {
|
||||
const { id, name, createdAt, updatedAt } = tag;
|
||||
|
||||
expect(id).toBeDefined();
|
||||
expect(name).toBeDefined();
|
||||
expect(createdAt).toBeDefined();
|
||||
expect(updatedAt).toBeDefined();
|
||||
|
||||
tags.forEach((tag: TagEntity) => {
|
||||
expect(tags.some((savedTag) => savedTag.id === tag.id)).toBe(true);
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
test('should return empty array if workflow does not have tags', async () => {
|
||||
config.set('workflowTagsDisabled', false);
|
||||
|
||||
const workflow = await createWorkflow({}, member);
|
||||
|
||||
const response = await authMemberAgent.get(`/workflows/${workflow.id}/tags`);
|
||||
|
||||
expect(response.statusCode).toBe(200);
|
||||
expect(response.body.length).toBe(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe('PUT /workflows/:id/tags', () => {
|
||||
test('should fail due to missing API Key', testWithAPIKey('put', '/workflows/2/tags', null));
|
||||
|
||||
test('should fail due to invalid API Key', testWithAPIKey('put', '/workflows/2/tags', 'abcXYZ'));
|
||||
|
||||
test('should fail if workflowTagsDisabled', async () => {
|
||||
config.set('workflowTagsDisabled', true);
|
||||
|
||||
const response = await authOwnerAgent.put('/workflows/2/tags').send([]);
|
||||
|
||||
expect(response.statusCode).toBe(400);
|
||||
expect(response.body.message).toBe('Workflow Tags Disabled');
|
||||
});
|
||||
|
||||
test('should fail due to non-existing workflow', async () => {
|
||||
config.set('workflowTagsDisabled', false);
|
||||
|
||||
const response = await authOwnerAgent.put('/workflows/2/tags').send([]);
|
||||
|
||||
expect(response.statusCode).toBe(404);
|
||||
});
|
||||
|
||||
test('should add the tags, workflow have not got tags previously', async () => {
|
||||
config.set('workflowTagsDisabled', false);
|
||||
|
||||
const workflow = await createWorkflow({}, member);
|
||||
const tags = await Promise.all([await createTag({}), await createTag({})]);
|
||||
|
||||
const payload = [
|
||||
{
|
||||
id: tags[0].id,
|
||||
},
|
||||
{
|
||||
id: tags[1].id,
|
||||
},
|
||||
];
|
||||
|
||||
const response = await authMemberAgent.put(`/workflows/${workflow.id}/tags`).send(payload);
|
||||
|
||||
expect(response.statusCode).toBe(200);
|
||||
expect(response.body.length).toBe(2);
|
||||
|
||||
for (const tag of response.body) {
|
||||
const { id, name, createdAt, updatedAt } = tag;
|
||||
|
||||
expect(id).toBeDefined();
|
||||
expect(name).toBeDefined();
|
||||
expect(createdAt).toBeDefined();
|
||||
expect(updatedAt).toBeDefined();
|
||||
|
||||
tags.forEach((tag: TagEntity) => {
|
||||
expect(tags.some((savedTag) => savedTag.id === tag.id)).toBe(true);
|
||||
});
|
||||
}
|
||||
|
||||
// Check the association in DB
|
||||
const sharedWorkflow = await Container.get(SharedWorkflowRepository).findOne({
|
||||
where: {
|
||||
userId: member.id,
|
||||
workflowId: workflow.id,
|
||||
},
|
||||
relations: ['workflow.tags'],
|
||||
});
|
||||
|
||||
expect(sharedWorkflow?.workflow.tags).toBeDefined();
|
||||
expect(sharedWorkflow?.workflow.tags?.length).toBe(2);
|
||||
if (sharedWorkflow?.workflow.tags !== undefined) {
|
||||
for (const tag of sharedWorkflow?.workflow.tags) {
|
||||
const { id, name, createdAt, updatedAt } = tag;
|
||||
|
||||
expect(id).toBeDefined();
|
||||
expect(name).toBeDefined();
|
||||
expect(createdAt).toBeDefined();
|
||||
expect(updatedAt).toBeDefined();
|
||||
|
||||
tags.forEach((tag: TagEntity) => {
|
||||
expect(tags.some((savedTag) => savedTag.id === tag.id)).toBe(true);
|
||||
});
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
test('should add the tags, workflow have some tags previously', async () => {
|
||||
config.set('workflowTagsDisabled', false);
|
||||
|
||||
const tags = await Promise.all([await createTag({}), await createTag({}), await createTag({})]);
|
||||
const oldTags = [tags[0], tags[1]];
|
||||
const newTags = [tags[0], tags[2]];
|
||||
const workflow = await createWorkflow({ tags: oldTags }, member);
|
||||
|
||||
// Check the association in DB
|
||||
const oldSharedWorkflow = await Container.get(SharedWorkflowRepository).findOne({
|
||||
where: {
|
||||
userId: member.id,
|
||||
workflowId: workflow.id,
|
||||
},
|
||||
relations: ['workflow.tags'],
|
||||
});
|
||||
|
||||
expect(oldSharedWorkflow?.workflow.tags).toBeDefined();
|
||||
expect(oldSharedWorkflow?.workflow.tags?.length).toBe(2);
|
||||
if (oldSharedWorkflow?.workflow.tags !== undefined) {
|
||||
for (const tag of oldSharedWorkflow?.workflow.tags) {
|
||||
const { id, name, createdAt, updatedAt } = tag;
|
||||
|
||||
expect(id).toBeDefined();
|
||||
expect(name).toBeDefined();
|
||||
expect(createdAt).toBeDefined();
|
||||
expect(updatedAt).toBeDefined();
|
||||
|
||||
oldTags.forEach((tag: TagEntity) => {
|
||||
expect(oldTags.some((savedTag) => savedTag.id === tag.id)).toBe(true);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const payload = [
|
||||
{
|
||||
id: newTags[0].id,
|
||||
},
|
||||
{
|
||||
id: newTags[1].id,
|
||||
},
|
||||
];
|
||||
|
||||
const response = await authMemberAgent.put(`/workflows/${workflow.id}/tags`).send(payload);
|
||||
|
||||
expect(response.statusCode).toBe(200);
|
||||
expect(response.body.length).toBe(2);
|
||||
|
||||
for (const tag of response.body) {
|
||||
const { id, name, createdAt, updatedAt } = tag;
|
||||
|
||||
expect(id).toBeDefined();
|
||||
expect(name).toBeDefined();
|
||||
expect(createdAt).toBeDefined();
|
||||
expect(updatedAt).toBeDefined();
|
||||
|
||||
newTags.forEach((tag: TagEntity) => {
|
||||
expect(newTags.some((savedTag) => savedTag.id === tag.id)).toBe(true);
|
||||
});
|
||||
}
|
||||
|
||||
// Check the association in DB
|
||||
const sharedWorkflow = await Container.get(SharedWorkflowRepository).findOne({
|
||||
where: {
|
||||
userId: member.id,
|
||||
workflowId: workflow.id,
|
||||
},
|
||||
relations: ['workflow.tags'],
|
||||
});
|
||||
|
||||
expect(sharedWorkflow?.workflow.tags).toBeDefined();
|
||||
expect(sharedWorkflow?.workflow.tags?.length).toBe(2);
|
||||
if (sharedWorkflow?.workflow.tags !== undefined) {
|
||||
for (const tag of sharedWorkflow?.workflow.tags) {
|
||||
const { id, name, createdAt, updatedAt } = tag;
|
||||
|
||||
expect(id).toBeDefined();
|
||||
expect(name).toBeDefined();
|
||||
expect(createdAt).toBeDefined();
|
||||
expect(updatedAt).toBeDefined();
|
||||
|
||||
newTags.forEach((tag: TagEntity) => {
|
||||
expect(newTags.some((savedTag) => savedTag.id === tag.id)).toBe(true);
|
||||
});
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
test('should fail to add the tags as one does not exist, workflow should maintain previous tags', async () => {
|
||||
config.set('workflowTagsDisabled', false);
|
||||
|
||||
const tags = await Promise.all([await createTag({}), await createTag({})]);
|
||||
const oldTags = [tags[0], tags[1]];
|
||||
const workflow = await createWorkflow({ tags: oldTags }, member);
|
||||
|
||||
// Check the association in DB
|
||||
const oldSharedWorkflow = await Container.get(SharedWorkflowRepository).findOne({
|
||||
where: {
|
||||
userId: member.id,
|
||||
workflowId: workflow.id,
|
||||
},
|
||||
relations: ['workflow.tags'],
|
||||
});
|
||||
|
||||
expect(oldSharedWorkflow?.workflow.tags).toBeDefined();
|
||||
expect(oldSharedWorkflow?.workflow.tags?.length).toBe(2);
|
||||
if (oldSharedWorkflow?.workflow.tags !== undefined) {
|
||||
for (const tag of oldSharedWorkflow?.workflow.tags) {
|
||||
const { id, name, createdAt, updatedAt } = tag;
|
||||
|
||||
expect(id).toBeDefined();
|
||||
expect(name).toBeDefined();
|
||||
expect(createdAt).toBeDefined();
|
||||
expect(updatedAt).toBeDefined();
|
||||
|
||||
oldTags.forEach((tag: TagEntity) => {
|
||||
expect(oldTags.some((savedTag) => savedTag.id === tag.id)).toBe(true);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const payload = [
|
||||
{
|
||||
id: oldTags[0].id,
|
||||
},
|
||||
{
|
||||
id: 'TagDoesNotExist',
|
||||
},
|
||||
];
|
||||
|
||||
const response = await authMemberAgent.put(`/workflows/${workflow.id}/tags`).send(payload);
|
||||
|
||||
expect(response.statusCode).toBe(404);
|
||||
expect(response.body.message).toBe('Some tags not found');
|
||||
|
||||
// Check the association in DB
|
||||
const sharedWorkflow = await Container.get(SharedWorkflowRepository).findOne({
|
||||
where: {
|
||||
userId: member.id,
|
||||
workflowId: workflow.id,
|
||||
},
|
||||
relations: ['workflow.tags'],
|
||||
});
|
||||
|
||||
expect(sharedWorkflow?.workflow.tags).toBeDefined();
|
||||
expect(sharedWorkflow?.workflow.tags?.length).toBe(2);
|
||||
if (sharedWorkflow?.workflow.tags !== undefined) {
|
||||
for (const tag of sharedWorkflow?.workflow.tags) {
|
||||
const { id, name, createdAt, updatedAt } = tag;
|
||||
|
||||
expect(id).toBeDefined();
|
||||
expect(name).toBeDefined();
|
||||
expect(createdAt).toBeDefined();
|
||||
expect(updatedAt).toBeDefined();
|
||||
|
||||
oldTags.forEach((tag: TagEntity) => {
|
||||
expect(oldTags.some((savedTag) => savedTag.id === tag.id)).toBe(true);
|
||||
});
|
||||
}
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user