feat: Implement get flows API endpoint

packages/backend/src/controllers/api/v1/executions/get-execution.js

@@ -2,6 +2,7 @@ import { renderObject } from '../../../../helpers/renderer.js';
 
 export default async (request, response) => {
   const execution = await request.currentUser.authorizedExecutions
+    .clone()
     .withGraphFetched({
       flow: {
         steps: true,

packages/backend/src/controllers/api/v1/executions/get-executions.js

@@ -3,6 +3,7 @@ import paginateRest from '../../../../helpers/pagination-rest.js';
 
 export default async (request, response) => {
   const executionsQuery = request.currentUser.authorizedExecutions
+    .clone()
     .withSoftDeleted()
     .orderBy('created_at', 'desc')
     .withGraphFetched({

packages/backend/src/controllers/api/v1/flows/get-flow.js

@@ -2,6 +2,7 @@ import { renderObject } from '../../../../helpers/renderer.js';
 
 export default async (request, response) => {
   const flow = await request.currentUser.authorizedFlows
+    .clone()
     .withGraphJoined({ steps: true })
     .orderBy('steps.position', 'asc')
     .findOne({ 'flows.id': request.params.flowId })

packages/backend/src/controllers/api/v1/flows/get-flows.js

@@ -0,0 +1,21 @@
+import { renderObject } from '../../../../helpers/renderer.js';
+import paginateRest from '../../../../helpers/pagination-rest.js';
+
+export default async (request, response) => {
+  const flowsQuery = request.currentUser.authorizedFlows
+    .clone()
+    .withGraphFetched({
+      steps: true,
+    })
+    .where((builder) => {
+      if (request.query.name) {
+        builder.where('flows.name', 'ilike', `%${request.query.name}%`);
+      }
+    })
+    .orderBy('active', 'desc')
+    .orderBy('updated_at', 'desc');
+
+  const flows = await paginateRest(flowsQuery, request.query.page);
+
+  renderObject(response, flows);
+};

packages/backend/src/controllers/api/v1/flows/get-flows.test.js

@@ -0,0 +1,118 @@
+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';
+import { createUser } from '../../../../../test/factories/user';
+import { createFlow } from '../../../../../test/factories/flow';
+import { createStep } from '../../../../../test/factories/step';
+import { createPermission } from '../../../../../test/factories/permission';
+import getFlowsMock from '../../../../../test/mocks/rest/api/v1/flows/get-flows.js';
+
+describe('GET /api/v1/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 current user', async () => {
+    const currentUserFlowOne = await createFlow({ userId: currentUser.id });
+
+    const triggerStepFlowOne = await createStep({
+      flowId: currentUserFlowOne.id,
+      type: 'trigger',
+    });
+    const actionStepFlowOne = await createStep({
+      flowId: currentUserFlowOne.id,
+      type: 'action',
+    });
+
+    const currentUserFlowTwo = await createFlow({ userId: currentUser.id });
+
+    const triggerStepFlowTwo = await createStep({
+      flowId: currentUserFlowTwo.id,
+      type: 'trigger',
+    });
+    const actionStepFlowTwo = 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/flows')
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedPayload = await getFlowsMock(
+      [currentUserFlowTwo, currentUserFlowOne],
+      [
+        triggerStepFlowOne,
+        actionStepFlowOne,
+        triggerStepFlowTwo,
+        actionStepFlowTwo,
+      ]
+    );
+
+    expect(response.body).toEqual(expectedPayload);
+  });
+
+  it('should return the flows data of another user', async () => {
+    const anotherUser = await createUser();
+
+    const anotherUserFlowOne = await createFlow({ userId: anotherUser.id });
+
+    const triggerStepFlowOne = await createStep({
+      flowId: anotherUserFlowOne.id,
+      type: 'trigger',
+    });
+    const actionStepFlowOne = await createStep({
+      flowId: anotherUserFlowOne.id,
+      type: 'action',
+    });
+
+    const anotherUserFlowTwo = await createFlow({ userId: anotherUser.id });
+
+    const triggerStepFlowTwo = await createStep({
+      flowId: anotherUserFlowTwo.id,
+      type: 'trigger',
+    });
+    const actionStepFlowTwo = 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/flows')
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedPayload = await getFlowsMock(
+      [anotherUserFlowTwo, anotherUserFlowOne],
+      [
+        triggerStepFlowOne,
+        actionStepFlowOne,
+        triggerStepFlowTwo,
+        actionStepFlowTwo,
+      ]
+    );
+
+    expect(response.body).toEqual(expectedPayload);
+  });
+});

packages/backend/src/helpers/authorization.js

@@ -11,6 +11,10 @@ const authorizationList = {
     action: 'read',
     subject: 'Flow',
   },
+  'GET /api/v1/flows/': {
+    action: 'read',
+    subject: 'Flow',
+  },
   'GET /api/v1/executions/:executionId': {
     action: 'read',
     subject: 'Execution',

packages/backend/src/routes/api/v1/flows.js

@@ -2,10 +2,13 @@ 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/flows/get-flows.js';
 import getFlowAction from '../../../controllers/api/v1/flows/get-flow.js';
 
 const router = Router();
 
+router.get('/', authenticateUser, authorizeUser, asyncHandler(getFlowsAction));
+
 router.get(
   '/:flowId',
   authenticateUser,

packages/backend/test/mocks/rest/api/v1/flows/get-flows.js

@@ -0,0 +1,36 @@
+const getFlowsMock = async (flows, steps) => {
+  const data = flows.map((flow) => {
+    const flowSteps = steps.filter((step) => step.flowId === flow.id);
+
+    return {
+      active: flow.active,
+      id: flow.id,
+      name: flow.name,
+      status: flow.active ? 'published' : 'draft',
+      steps: flowSteps.map((step) => ({
+        appKey: step.appKey,
+        iconUrl: step.iconUrl,
+        id: step.id,
+        key: step.key,
+        parameters: step.parameters,
+        position: step.position,
+        status: step.status,
+        type: step.type,
+        webhookUrl: step.webhookUrl,
+      })),
+    };
+  });
+
+  return {
+    data: data,
+    meta: {
+      count: data.length,
+      currentPage: 1,
+      isArray: true,
+      totalPages: 1,
+      type: 'Flow',
+    },
+  };
+};
+
+export default getFlowsMock;