Merge branch 'change-api-calls' into remove-old-scenarios

Author: annahileta

client/src/api/index.js

@@ -124,6 +124,14 @@ export const api = Object.freeze({
       const response = await instance.get(`/workflows/definitions`);
       return response;
     },
+    getWorkflowTriggerRequirements: async workflowId => {
+      try {
+        const response = await instance.put(`/workflows/${workflowId}/requirements`);
+        return response;
+      } catch (error) {
+        return error.response;
+      }
+    },
     getWorkflowInstance: async workflow => {
       const response = await instance.get(`/workflows/${workflow.id}/instances/${workflow.instanceId}`);
       return response;

server/api/apiFactory.js

@@ -0,0 +1,63 @@
+const configureInterceptors = (api, accessToken) => {
+  // Request interceptor for API calls
+  api.interceptors.request.use(
+    async config => {
+      config.headers = {
+        Accept: 'application/json',
+        'Content-Type': 'application/json',
+      };
+      config.headers.Authorization = `Bearer ${accessToken}`;
+      return config;
+    },
+    error => {
+      Promise.reject(error);
+    }
+  );
+
+  api.interceptors.response.use(
+    response => response,
+    error => {
+      // eslint-disable-next-line no-console
+      console.error(`API call failed. Error:  ${error}`);
+      return Promise.reject(error);
+    }
+  );
+  return api;
+};
+
+const createAPI = (axios, accessToken) => {
+  const api = configureInterceptors(
+    axios.create({
+      withCredentials: false,
+    }),
+    accessToken
+  );
+  return api;
+};
+
+const createMaestroApi = (axios, basePath, accountId, accessToken) => {
+  const api = createAPI(axios, accessToken);
+
+  const getWorkflowDefinitions = async params => {
+    const response = await api.get(`${basePath}/accounts/${accountId}/workflows`, { params });
+    return response.data;
+  };
+
+  const getTriggerRequirements = async workflowId => {
+    const response = await api.get(`${basePath}/accounts/${accountId}/workflows/${workflowId}/trigger-requirements`);
+    return response.data;
+  };
+
+  const triggerWorkflow = async (args, triggerUrl) => {
+    const response = await api.post(triggerUrl, args);
+    return response.data;
+  };
+
+  return {
+    getWorkflowDefinitions,
+    getTriggerRequirements,
+    triggerWorkflow,
+  };
+};
+
+module.exports = { createMaestroApi };

server/api/index.js

@@ -0,0 +1,6 @@
+const axios = require('axios');
+const { createMaestroApi } = require('./apiFactory');
+
+const initMaestroApi = (accountId, basePath, accessToken) => createMaestroApi(axios, basePath, accountId, accessToken);
+
+module.exports = { initMaestroApi };

server/controllers/workflowsController.js

@@ -15,8 +15,8 @@ const docusign = require('docusign-esign');
 const config = require('../config');
 const WorkflowsService = require('../services/workflowsService');
 const createPrefixedLogger = require('../utils/logger');
-const { getParameterValueFromUrl } = require('../utils/utils');
 const { TEMPLATE_TYPE } = require('../constants');
+const { getPayloadBySchema } = require('../utils/utils');
 
 const oAuth = docusign.ApiClient.OAuth;
 const restApi = docusign.ApiClient.RestApi;
@@ -28,79 +28,6 @@ class WorkflowsController {
   static templatesPath = path.join(path.resolve(), 'assets/templates');
   static logger = createPrefixedLogger(WorkflowsController.name);
 
-  /**
-   * Creates workflow instance and sends a response.
-   */
-  static createWorkflow = async (req, res) => {
-    try {
-      const args = {
-        basePath: this.basePath,
-        accessToken: req.user.accessToken,
-        accountId: req.session.accountId,
-        templateType: req?.body?.templateType,
-      };
-      let templateResponse = await WorkflowsService.getTemplate(args);
-
-      if (!templateResponse.templateId) {
-        templateResponse = await WorkflowsService.createTemplate(args);
-      }
-
-      const workflow = await WorkflowsService.createWorkflow({
-        ...args,
-        templateId: templateResponse.templateId,
-        basePath: config.maestroApiUrl,
-      });
-
-      res.json({ workflowDefinitionId: workflow.workflowDefinitionId });
-    } catch (error) {
-      this.handleErrorResponse(error, res);
-    }
-  };
-
-  /**
-   * Cancels workflow instance and sends a response.
-   */
-  static cancelWorkflow = async (req, res) => {
-    try {
-      const result = await WorkflowsService.cancelWorkflowInstance({
-        instanceId: req?.params?.instanceId,
-        accessToken: req?.user?.accessToken || req?.session?.accessToken,
-        basePath: config.maestroApiUrl,
-        accountId: req.session.accountId,
-      });
-      res.status(200).send(result);
-    } catch (error) {
-      this.handleErrorResponse(error, res);
-    }
-  };
-
-  /**
-   * Publish workflow by id.
-   */
-  static publishWorkflow = async (req, res) => {
-    const workflowId = req?.body?.workflowId;
-
-    try {
-      let result = await WorkflowsService.publishWorkflow(
-        {
-          basePath: config.maestroApiUrl,
-          accessToken: req.user.accessToken,
-          accountId: req.session.accountId,
-        },
-        workflowId
-      );
-
-      res.status(200).send(result);
-    } catch (error) {
-      if (error?.errorMessage === 'Consent required') {
-        res.status(210).send(error.consentUrl);
-        return;
-      }
-
-      this.handleErrorResponse(error, res);
-    }
-  };
-
   /**
    * Gets workflow definitions and returns it.
    */
@@ -118,35 +45,16 @@ class WorkflowsController {
   };
 
   /**
-   * Gets workflow instance and returns it.
+   * Gets the requirements to trigger workflow.
    */
-  static getWorkflowInstance = async (req, res) => {
+  static getWorkflowTriggerRequirements = async (req, res) => {
     try {
-      const result = await WorkflowsService.getWorkflowInstance({
-        instanceId: req?.params?.instanceId,
-        definitionId: req?.params?.definitionId,
+      const results = await WorkflowsService.getWorkflowTriggerRequirements({
         accessToken: req?.user?.accessToken || req?.session?.accessToken,
         basePath: config.maestroApiUrl,
         accountId: req.session.accountId,
+        workflowId: req.params.definitionId,
       });
-      res.status(200).send(result);
-    } catch (error) {
-      this.handleErrorResponse(error, res);
-    }
-  };
-
-  /**
-   * Gets workflow instances and returns it.
-   */
-  static getWorkflowInstances = async (req, res) => {
-    try {
-      const results = await WorkflowsService.getWorkflowInstances({
-        definitionId: req.params.definitionId,
-        accessToken: req?.user?.accessToken || req?.session?.accessToken,
-        basePath: config.maestroApiUrl,
-        accountId: req.session.accountId,
-      });
-
       res.status(200).send(results);
     } catch (error) {
       this.handleErrorResponse(error, res);
@@ -159,58 +67,25 @@ class WorkflowsController {
   static triggerWorkflow = async (req, res) => {
     const { body } = req;
 
-    const mainArgs = {
+    const args = {
       templateType: req.query.type,
       workflowId: req.params.definitionId,
       accessToken: req?.user?.accessToken || req?.session?.accessToken,
       basePath: config.maestroApiUrl,
       accountId: req.session.accountId,
-      mtid: undefined,
-      mtsec: undefined,
     };
 
-    const bodyArgs = {};
-    if (req.query.type === TEMPLATE_TYPE.I9) {
-      bodyArgs.preparerName = validator.escape(body?.preparerName);
-      bodyArgs.preparerEmail = validator.escape(body?.preparerEmail);
-      bodyArgs.employeeName = validator.escape(body?.employeeName);
-      bodyArgs.employeeEmail = validator.escape(body?.employeeEmail);
-      bodyArgs.hrApproverName = validator.escape(body?.hrApproverName);
-      bodyArgs.hrApproverEmail = validator.escape(body?.hrApproverEmail);
-    }
-    if (req.query.type === TEMPLATE_TYPE.OFFER) {
-      bodyArgs.hrManagerName = validator.escape(body?.hrManagerName);
-      bodyArgs.hrManagerEmail = validator.escape(body?.hrManagerEmail);
-      bodyArgs.Company = validator.escape(body?.Company);
-    }
-    if (req.query.type === TEMPLATE_TYPE.NDA) {
-      bodyArgs.hrManagerName = validator.escape(body?.hrManagerName);
-      bodyArgs.hrManagerEmail = validator.escape(body?.hrManagerEmail);
-    }
-
-    const args = { ...mainArgs, ...bodyArgs };
-
     try {
-      const workflow = await WorkflowsService.getWorkflowDefinition(args);
-      args.mtid = getParameterValueFromUrl(workflow.triggerUrl, 'mtid');
-      args.mtsec = getParameterValueFromUrl(workflow.triggerUrl, 'mtsec');
+      const triggerRequirements = await WorkflowsService.getWorkflowTriggerRequirements(args);
+      const payload = getPayloadBySchema(body, triggerRequirements.trigger_input_schema);
 
-      const result = await WorkflowsService.triggerWorkflowInstance(args);
+      const result = await WorkflowsService.triggerWorkflowInstance(args, payload, triggerRequirements);
       res.status(200).send(result);
     } catch (error) {
       this.handleErrorResponse(error, res);
     }
   };
 
-  /**
-   * Download workflow template from assets/[name].json.
-   */
-  static downloadWorkflowTemplate = async (req, res) => {
-    const templateName = req.params.templateName;
-    const templatePath = path.resolve(this.templatesPath, templateName);
-    res.download(templatePath);
-  };
-
   static handleErrorResponse(error, res) {
     this.logger.error(`handleErrorResponse: ${error}`);
 

server/routes/workflowsRouter.js

@@ -4,15 +4,8 @@ const authMiddleware = require('../middlewares/authMiddleware');
 
 const router = Router();
 
-router.get('/:definitionId/instances', authMiddleware, workflowsController.getWorkflowInstances);
-router.get('/:definitionId/instances/:instanceId', authMiddleware, workflowsController.getWorkflowInstance);
-router.put('/:definitionId/instances/:instanceId/cancel', authMiddleware, workflowsController.cancelWorkflow);
-
-router.post('/create', authMiddleware, workflowsController.createWorkflow);
 router.put('/:definitionId/trigger', authMiddleware, workflowsController.triggerWorkflow);
-router.get('/download/:templateName', workflowsController.downloadWorkflowTemplate);
-
-router.post('/publish', authMiddleware, workflowsController.publishWorkflow);
 router.get('/definitions', authMiddleware, workflowsController.getWorkflowDefinitions);
+router.get('/:definitionId/requirements', authMiddleware, workflowsController.getWorkflowTriggerRequirements);
 
 module.exports = router;