feat: Implement get connection flows API endpoint

This commit is contained in:
Faruk AYDIN
2024-03-10 16:11:07 +01:00
parent c1740aae6c
commit 6027cb7cb0
6 changed files with 171 additions and 1 deletions

View File

@@ -0,0 +1,20 @@
import { renderObject } from '../../../../helpers/renderer.js';
import paginateRest from '../../../../helpers/pagination-rest.js';
export default async (request, response) => {
const flowsQuery = request.currentUser.authorizedFlows
.clone()
.joinRelated({
steps: true,
})
.withGraphFetched({
steps: true,
})
.where('steps.connection_id', request.params.connectionId)
.orderBy('active', 'desc')
.orderBy('updated_at', 'desc');
const flows = await paginateRest(flowsQuery, request.query.page);
renderObject(response, flows);
};

View File

@@ -0,0 +1,128 @@
import { describe, it, expect, beforeEach } from 'vitest';
import request from 'supertest';
import app from '../../../../app.js';
import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id.js';
import { createUser } from '../../../../../test/factories/user.js';
import { createConnection } from '../../../../../test/factories/connection.js';
import { createFlow } from '../../../../../test/factories/flow.js';
import { createStep } from '../../../../../test/factories/step.js';
import { createPermission } from '../../../../../test/factories/permission.js';
import getFlowsMock from '../../../../../test/mocks/rest/api/v1/flows/get-flows.js';
describe('GET /api/v1/connections/:connectionId/flows', () => {
let currentUser, currentUserRole, token;
beforeEach(async () => {
currentUser = await createUser();
currentUserRole = await currentUser.$relatedQuery('role');
token = createAuthTokenByUserId(currentUser.id);
});
it('should return the flows data of specified connection for current user', async () => {
const currentUserFlowOne = await createFlow({ userId: currentUser.id });
const currentUserConnection = await createConnection({
userId: currentUser.id,
key: 'webhook',
});
const triggerStepFlowOne = await createStep({
flowId: currentUserFlowOne.id,
type: 'trigger',
appKey: 'webhook',
connectionId: currentUserConnection.id,
});
const actionStepFlowOne = await createStep({
flowId: currentUserFlowOne.id,
type: 'action',
});
const currentUserFlowTwo = await createFlow({ userId: currentUser.id });
await createStep({
flowId: currentUserFlowTwo.id,
type: 'trigger',
appKey: 'github',
});
await createStep({
flowId: currentUserFlowTwo.id,
type: 'action',
});
await createPermission({
action: 'read',
subject: 'Flow',
roleId: currentUserRole.id,
conditions: ['isCreator'],
});
const response = await request(app)
.get(`/api/v1/connections/${currentUserConnection.id}/flows`)
.set('Authorization', token)
.expect(200);
const expectedPayload = await getFlowsMock(
[currentUserFlowOne],
[triggerStepFlowOne, actionStepFlowOne]
);
expect(response.body).toEqual(expectedPayload);
});
it('should return the flows data of specified connection for another user', async () => {
const anotherUser = await createUser();
const anotherUserFlowOne = await createFlow({ userId: anotherUser.id });
const anotherUserConnection = await createConnection({
userId: anotherUser.id,
key: 'webhook',
});
const triggerStepFlowOne = await createStep({
flowId: anotherUserFlowOne.id,
type: 'trigger',
appKey: 'webhook',
connectionId: anotherUserConnection.id,
});
const actionStepFlowOne = await createStep({
flowId: anotherUserFlowOne.id,
type: 'action',
});
const anotherUserFlowTwo = await createFlow({ userId: anotherUser.id });
await createStep({
flowId: anotherUserFlowTwo.id,
type: 'trigger',
appKey: 'github',
});
await createStep({
flowId: anotherUserFlowTwo.id,
type: 'action',
});
await createPermission({
action: 'read',
subject: 'Flow',
roleId: currentUserRole.id,
conditions: [],
});
const response = await request(app)
.get(`/api/v1/connections/${anotherUserConnection.id}/flows`)
.set('Authorization', token)
.expect(200);
const expectedPayload = await getFlowsMock(
[anotherUserFlowOne],
[triggerStepFlowOne, actionStepFlowOne]
);
expect(response.body).toEqual(expectedPayload);
});
});

View File

@@ -15,6 +15,10 @@ const authorizationList = {
action: 'read', action: 'read',
subject: 'Flow', subject: 'Flow',
}, },
'GET /api/v1/connections/:connectionId/flows': {
action: 'read',
subject: 'Flow',
},
'GET /api/v1/apps/:appKey/flows': { 'GET /api/v1/apps/:appKey/flows': {
action: 'read', action: 'read',
subject: 'Flow', subject: 'Flow',

View File

@@ -15,7 +15,7 @@ const renderObject = (response, object, options) => {
let data = isPaginated(object) ? object.records : object; let data = isPaginated(object) ? object.records : object;
const type = isPaginated(object) const type = isPaginated(object)
? object.records[0].constructor.name ? object.records[0]?.constructor?.name || 'Object'
: Array.isArray(object) : Array.isArray(object)
? object?.[0]?.constructor?.name || 'Object' ? object?.[0]?.constructor?.name || 'Object'
: object.constructor.name; : object.constructor.name;

View File

@@ -0,0 +1,16 @@
import { Router } from 'express';
import asyncHandler from 'express-async-handler';
import { authenticateUser } from '../../../helpers/authentication.js';
import { authorizeUser } from '../../../helpers/authorization.js';
import getFlowsAction from '../../../controllers/api/v1/connections/get-flows.js';
const router = Router();
router.get(
'/:connectionId/flows',
authenticateUser,
authorizeUser,
asyncHandler(getFlowsAction)
);
export default router;

View File

@@ -10,6 +10,7 @@ import appAuthClientsRouter from './api/v1/app-auth-clients.js';
import appConfigsRouter from './api/v1/app-configs.ee.js'; import appConfigsRouter from './api/v1/app-configs.ee.js';
import flowsRouter from './api/v1/flows.js'; import flowsRouter from './api/v1/flows.js';
import appsRouter from './api/v1/apps.js'; import appsRouter from './api/v1/apps.js';
import connectionsRouter from './api/v1/connections.js';
import executionsRouter from './api/v1/executions.js'; import executionsRouter from './api/v1/executions.js';
import samlAuthProvidersRouter from './api/v1/admin/saml-auth-providers.ee.js'; import samlAuthProvidersRouter from './api/v1/admin/saml-auth-providers.ee.js';
import rolesRouter from './api/v1/admin/roles.ee.js'; import rolesRouter from './api/v1/admin/roles.ee.js';
@@ -30,6 +31,7 @@ router.use('/api/v1/app-auth-clients', appAuthClientsRouter);
router.use('/api/v1/app-configs', appConfigsRouter); router.use('/api/v1/app-configs', appConfigsRouter);
router.use('/api/v1/flows', flowsRouter); router.use('/api/v1/flows', flowsRouter);
router.use('/api/v1/apps', appsRouter); router.use('/api/v1/apps', appsRouter);
router.use('/api/v1/connections', connectionsRouter);
router.use('/api/v1/executions', executionsRouter); router.use('/api/v1/executions', executionsRouter);
router.use('/api/v1/admin/saml-auth-providers', samlAuthProvidersRouter); router.use('/api/v1/admin/saml-auth-providers', samlAuthProvidersRouter);
router.use('/api/v1/admin/roles', rolesRouter); router.use('/api/v1/admin/roles', rolesRouter);