diff --git a/packages/backend/src/controllers/api/v1/flows/create-step.js b/packages/backend/src/controllers/api/v1/flows/create-step.js new file mode 100644 index 00000000..f0bb71f7 --- /dev/null +++ b/packages/backend/src/controllers/api/v1/flows/create-step.js @@ -0,0 +1,14 @@ +import { renderObject } from '../../../../helpers/renderer.js'; + +export default async (request, response) => { + const flow = await request.currentUser.authorizedFlows + .clone() + .findById(request.params.flowId) + .throwIfNotFound(); + + const createdActionStep = await flow.createActionStep( + request.body.previousStepId + ); + + renderObject(response, createdActionStep, { status: 201 }); +}; diff --git a/packages/backend/src/controllers/api/v1/flows/create-step.test.js b/packages/backend/src/controllers/api/v1/flows/create-step.test.js new file mode 100644 index 00000000..efc599b5 --- /dev/null +++ b/packages/backend/src/controllers/api/v1/flows/create-step.test.js @@ -0,0 +1,176 @@ +import Crypto from 'node:crypto'; +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 { createFlow } from '../../../../../test/factories/flow.js'; +import { createStep } from '../../../../../test/factories/step.js'; +import createStepMock from '../../../../../test/mocks/rest/api/v1/flows/create-step.js'; +import { createPermission } from '../../../../../test/factories/permission.js'; + +describe('POST /api/v1/flows/:flowId/steps', () => { + let currentUser, flow, triggerStep, token; + + beforeEach(async () => { + currentUser = await createUser(); + + flow = await createFlow({ userId: currentUser.id }); + + triggerStep = await createStep({ flowId: flow.id, type: 'trigger' }); + + await createStep({ flowId: flow.id, type: 'action' }); + + token = await createAuthTokenByUserId(currentUser.id); + }); + + it('should return created step for current user', async () => { + await createPermission({ + roleId: currentUser.roleId, + subject: 'Flow', + action: 'read', + conditions: ['isCreator'], + }); + + await createPermission({ + roleId: currentUser.roleId, + subject: 'Flow', + action: 'update', + conditions: ['isCreator'], + }); + + const response = await request(app) + .post(`/api/v1/flows/${flow.id}/steps`) + .set('Authorization', token) + .send({ + previousStepId: triggerStep.id, + }) + .expect(201); + + const expectedPayload = await createStepMock({ + id: response.body.data.id, + position: 2, + }); + + expect(response.body).toMatchObject(expectedPayload); + }); + + it('should return created step for another user', async () => { + const anotherUser = await createUser(); + + const anotherUserFlow = await createFlow({ userId: anotherUser.id }); + + const anotherUserFlowTriggerStep = await createStep({ + flowId: anotherUserFlow.id, + type: 'trigger', + }); + + await createStep({ flowId: anotherUserFlow.id, type: 'action' }); + + await createPermission({ + roleId: currentUser.roleId, + subject: 'Flow', + action: 'read', + conditions: [], + }); + + await createPermission({ + roleId: currentUser.roleId, + subject: 'Flow', + action: 'update', + conditions: [], + }); + + const response = await request(app) + .post(`/api/v1/flows/${anotherUserFlow.id}/steps`) + .set('Authorization', token) + .send({ + previousStepId: anotherUserFlowTriggerStep.id, + }) + .expect(201); + + const expectedPayload = await createStepMock({ + id: response.body.data.id, + position: 2, + }); + + expect(response.body).toMatchObject(expectedPayload); + }); + + it('should return bad request response for invalid flow UUID', async () => { + await createPermission({ + roleId: currentUser.roleId, + subject: 'Flow', + action: 'read', + conditions: ['isCreator'], + }); + + await createPermission({ + roleId: currentUser.roleId, + subject: 'Flow', + action: 'update', + conditions: ['isCreator'], + }); + + await request(app) + .post('/api/v1/flows/invalidFlowUUID/steps') + .set('Authorization', token) + .send({ + previousStepId: triggerStep.id, + }) + .expect(400); + }); + + it('should return not found response for invalid flow UUID', async () => { + await createPermission({ + roleId: currentUser.roleId, + subject: 'Flow', + action: 'read', + conditions: ['isCreator'], + }); + + await createPermission({ + roleId: currentUser.roleId, + subject: 'Flow', + action: 'update', + conditions: ['isCreator'], + }); + + const notExistingFlowUUID = Crypto.randomUUID(); + + await request(app) + .post(`/api/v1/flows/${notExistingFlowUUID}/steps`) + .set('Authorization', token) + .send({ + previousStepId: triggerStep.id, + }) + .expect(404); + }); + + it('should return not found response for invalid flow UUID', async () => { + await createPermission({ + roleId: currentUser.roleId, + subject: 'Flow', + action: 'read', + conditions: ['isCreator'], + }); + + await createPermission({ + roleId: currentUser.roleId, + subject: 'Flow', + action: 'update', + conditions: ['isCreator'], + }); + + const notExistingStepUUID = Crypto.randomUUID(); + + await request(app) + .post(`/api/v1/flows/${flow.id}/steps`) + .set('Authorization', token) + .send({ + previousStepId: notExistingStepUUID, + }) + .expect(404); + }); +}); diff --git a/packages/backend/src/graphql/mutation-resolvers.js b/packages/backend/src/graphql/mutation-resolvers.js index 60c8b8ea..fffc1b04 100644 --- a/packages/backend/src/graphql/mutation-resolvers.js +++ b/packages/backend/src/graphql/mutation-resolvers.js @@ -1,5 +1,4 @@ import createConnection from './mutations/create-connection.js'; -import createStep from './mutations/create-step.js'; import createUser from './mutations/create-user.ee.js'; import deleteFlow from './mutations/delete-flow.js'; import deleteRole from './mutations/delete-role.ee.js'; @@ -23,7 +22,6 @@ import deleteCurrentUser from './mutations/delete-current-user.ee.js'; const mutationResolvers = { createConnection, createFlow, - createStep, createUser, deleteCurrentUser, deleteFlow, diff --git a/packages/backend/src/graphql/mutations/create-step.js b/packages/backend/src/graphql/mutations/create-step.js deleted file mode 100644 index 05b8d364..00000000 --- a/packages/backend/src/graphql/mutations/create-step.js +++ /dev/null @@ -1,56 +0,0 @@ -import App from '../../models/app.js'; -import Flow from '../../models/flow.js'; - -const createStep = async (_parent, params, context) => { - const conditions = context.currentUser.can('update', 'Flow'); - const userFlows = context.currentUser.$relatedQuery('flows'); - const allFlows = Flow.query(); - const flowsQuery = conditions.isCreator ? userFlows : allFlows; - - const { input } = params; - - if (input.appKey && input.key) { - await App.checkAppAndAction(input.appKey, input.key); - } - - if (input.appKey && !input.key) { - await App.findOneByKey(input.appKey); - } - - const flow = await flowsQuery - .findOne({ - id: input.flow.id, - }) - .throwIfNotFound(); - - const previousStep = await flow - .$relatedQuery('steps') - .findOne({ - id: input.previousStep.id, - }) - .throwIfNotFound(); - - const step = await flow.$relatedQuery('steps').insertAndFetch({ - key: input.key, - appKey: input.appKey, - type: 'action', - position: previousStep.position + 1, - }); - - const nextSteps = await flow - .$relatedQuery('steps') - .where('position', '>=', step.position) - .whereNot('id', step.id); - - const nextStepQueries = nextSteps.map(async (nextStep, index) => { - await nextStep.$query().patchAndFetch({ - position: step.position + index + 1, - }); - }); - - await Promise.all(nextStepQueries); - - return step; -}; - -export default createStep; diff --git a/packages/backend/src/graphql/schema.graphql b/packages/backend/src/graphql/schema.graphql index 4958b2f0..de30c7a9 100644 --- a/packages/backend/src/graphql/schema.graphql +++ b/packages/backend/src/graphql/schema.graphql @@ -4,7 +4,6 @@ type Query { type Mutation { createConnection(input: CreateConnectionInput): Connection createFlow(input: CreateFlowInput): Flow - createStep(input: CreateStepInput): Step createUser(input: CreateUserInput): UserWithAcceptInvitationUrl deleteCurrentUser: Boolean deleteFlow(input: DeleteFlowInput): Boolean @@ -266,17 +265,6 @@ input DuplicateFlowInput { id: String! } -input CreateStepInput { - id: String - previousStepId: String - key: String - appKey: String - connection: StepConnectionInput - flow: StepFlowInput - parameters: JSONObject - previousStep: PreviousStepInput -} - input UpdateStepInput { id: String previousStepId: String diff --git a/packages/backend/src/helpers/authorization.js b/packages/backend/src/helpers/authorization.js index eb71fda1..36210615 100644 --- a/packages/backend/src/helpers/authorization.js +++ b/packages/backend/src/helpers/authorization.js @@ -93,6 +93,10 @@ const authorizationList = { action: 'update', subject: 'Flow', }, + 'POST /api/v1/flows/:flowId/steps': { + action: 'update', + subject: 'Flow', + }, }; export const authorizeUser = async (request, response, next) => { diff --git a/packages/backend/src/models/flow.js b/packages/backend/src/models/flow.js index 7e657fbb..3c8a2811 100644 --- a/packages/backend/src/models/flow.js +++ b/packages/backend/src/models/flow.js @@ -135,6 +135,31 @@ class Flow extends Base { return this.$query().withGraphFetched('steps'); } + async createActionStep(previousStepId) { + const previousStep = await this.$relatedQuery('steps') + .findById(previousStepId) + .throwIfNotFound(); + + const createdStep = await this.$relatedQuery('steps').insertAndFetch({ + type: 'action', + position: previousStep.position + 1, + }); + + const nextSteps = await this.$relatedQuery('steps') + .where('position', '>=', createdStep.position) + .whereNot('id', createdStep.id); + + const nextStepQueries = nextSteps.map(async (nextStep, index) => { + return await nextStep.$query().patchAndFetch({ + position: createdStep.position + index + 1, + }); + }); + + await Promise.all(nextStepQueries); + + return createdStep; + } + async $beforeUpdate(opt, queryContext) { await super.$beforeUpdate(opt, queryContext); diff --git a/packages/backend/src/models/step.js b/packages/backend/src/models/step.js index 01f46190..4781d8b6 100644 --- a/packages/backend/src/models/step.js +++ b/packages/backend/src/models/step.js @@ -82,6 +82,8 @@ class Step extends Base { }); get webhookUrl() { + if (!this.webhookPath) return null; + return new URL(this.webhookPath, appConfig.webhookUrl).toString(); } diff --git a/packages/backend/src/routes/api/v1/flows.js b/packages/backend/src/routes/api/v1/flows.js index 38ce3201..e7d21e3b 100644 --- a/packages/backend/src/routes/api/v1/flows.js +++ b/packages/backend/src/routes/api/v1/flows.js @@ -5,6 +5,7 @@ import getFlowsAction from '../../../controllers/api/v1/flows/get-flows.js'; import getFlowAction from '../../../controllers/api/v1/flows/get-flow.js'; import updateFlowAction from '../../../controllers/api/v1/flows/update-flow.js'; import createFlowAction from '../../../controllers/api/v1/flows/create-flow.js'; +import createStepAction from '../../../controllers/api/v1/flows/create-step.js'; const router = Router(); @@ -12,5 +13,11 @@ router.get('/', authenticateUser, authorizeUser, getFlowsAction); router.get('/:flowId', authenticateUser, authorizeUser, getFlowAction); router.post('/', authenticateUser, authorizeUser, createFlowAction); router.patch('/:flowId', authenticateUser, authorizeUser, updateFlowAction); +router.post( + '/:flowId/steps', + authenticateUser, + authorizeUser, + createStepAction +); export default router; diff --git a/packages/backend/test/mocks/rest/api/v1/flows/create-step.js b/packages/backend/test/mocks/rest/api/v1/flows/create-step.js new file mode 100644 index 00000000..da23f51c --- /dev/null +++ b/packages/backend/test/mocks/rest/api/v1/flows/create-step.js @@ -0,0 +1,26 @@ +const createStepMock = async (step) => { + const data = { + id: step.id, + type: step.type || 'action', + key: step.key || null, + appKey: step.appKey || null, + iconUrl: step.iconUrl || null, + webhookUrl: step.webhookUrl || null, + status: step.status || 'incomplete', + position: step.position, + parameters: step.parameters || {}, + }; + + return { + data, + meta: { + type: 'Step', + count: 1, + isArray: false, + currentPage: null, + totalPages: null, + }, + }; +}; + +export default createStepMock; diff --git a/packages/web/src/components/Editor/index.jsx b/packages/web/src/components/Editor/index.jsx index 0995d300..51de3de9 100644 --- a/packages/web/src/components/Editor/index.jsx +++ b/packages/web/src/components/Editor/index.jsx @@ -4,7 +4,7 @@ import Box from '@mui/material/Box'; import IconButton from '@mui/material/IconButton'; import AddIcon from '@mui/icons-material/Add'; -import { CREATE_STEP } from 'graphql/mutations/create-step'; +import useCreateStep from 'hooks/useCreateStep'; import { UPDATE_STEP } from 'graphql/mutations/update-step'; import FlowStep from 'components/FlowStep'; import { FlowPropType } from 'propTypes/propTypes'; @@ -12,9 +12,9 @@ import { useQueryClient } from '@tanstack/react-query'; function Editor(props) { const [updateStep] = useMutation(UPDATE_STEP); - const [createStep, { loading: creationInProgress }] = - useMutation(CREATE_STEP); const { flow } = props; + const { mutateAsync: createStep, isPending: isCreateStepPending } = + useCreateStep(flow?.id); const [triggerStep] = flow.steps; const [currentStepId, setCurrentStepId] = React.useState(triggerStep.id); const queryClient = useQueryClient(); @@ -48,24 +48,13 @@ function Editor(props) { const addStep = React.useCallback( async (previousStepId) => { - const mutationInput = { - previousStep: { - id: previousStepId, - }, - flow: { - id: flow.id, - }, - }; - - const createdStep = await createStep({ - variables: { input: mutationInput }, + const { data: createdStep } = await createStep({ + previousStepId, }); - const createdStepId = createdStep.data.createStep.id; - setCurrentStepId(createdStepId); - await queryClient.invalidateQueries({ queryKey: ['flows', flow.id] }); + setCurrentStepId(createdStep.id); }, - [createStep, flow.id, queryClient], + [createStep], ); const openNextStep = React.useCallback((nextStep) => { @@ -101,7 +90,7 @@ function Editor(props) { addStep(step.id)} color="primary" - disabled={creationInProgress || flow.active} + disabled={isCreateStepPending || flow.active} > diff --git a/packages/web/src/components/EditorNew/EditorNew.jsx b/packages/web/src/components/EditorNew/EditorNew.jsx index 73d29c51..8858af6e 100644 --- a/packages/web/src/components/EditorNew/EditorNew.jsx +++ b/packages/web/src/components/EditorNew/EditorNew.jsx @@ -4,8 +4,9 @@ import { useQueryClient } from '@tanstack/react-query'; import { FlowPropType } from 'propTypes/propTypes'; import ReactFlow, { useNodesState, useEdgesState } from 'reactflow'; import 'reactflow/dist/style.css'; + import { UPDATE_STEP } from 'graphql/mutations/update-step'; -import { CREATE_STEP } from 'graphql/mutations/create-step'; +import useCreateStep from 'hooks/useCreateStep'; import { useAutoLayout } from './useAutoLayout'; import { useScrollBoundaries } from './useScrollBoundaries'; @@ -36,8 +37,9 @@ const edgeTypes = { const EditorNew = ({ flow }) => { const [updateStep] = useMutation(UPDATE_STEP); const queryClient = useQueryClient(); - const [createStep, { loading: stepCreationInProgress }] = - useMutation(CREATE_STEP); + + const { mutateAsync: createStep, isPending: isCreateStepPending } = + useCreateStep(flow?.id); const [nodes, setNodes, onNodesChange] = useNodesState( generateInitialNodes(flow), @@ -111,26 +113,11 @@ const EditorNew = ({ flow }) => { const onAddStep = useCallback( async (previousStepId) => { - const mutationInput = { - previousStep: { - id: previousStepId, - }, - flow: { - id: flow.id, - }, - }; + const { data: createdStep } = await createStep({ previousStepId }); - const { - data: { createStep: createdStep }, - } = await createStep({ - variables: { input: mutationInput }, - }); - - const createdStepId = createdStep.id; - await queryClient.invalidateQueries({ queryKey: ['flows', flow.id] }); - createdStepIdRef.current = createdStepId; + createdStepIdRef.current = createdStep.id; }, - [flow.id, createStep, queryClient], + [createStep], ); useEffect(() => { @@ -260,7 +247,7 @@ const EditorNew = ({ flow }) => { > { + const { data } = await api.post(`/v1/flows/${flowId}/steps`, { + previousStepId, + }); + + return data; + }, + + onSuccess: () => { + queryClient.invalidateQueries({ + queryKey: ['flows', flowId], + }); + }, + }); + + return query; +}