✨ Add route for getTaskById

Author: pkiparra

src/controllers/task.controller.test.ts

@@ -1,23 +1,28 @@
 import { Response } from 'express';
-import { BridgeRequest, FollowUpWithIntegrationEntities } from '../models';
+import {
+  BridgeRequest,
+  FollowUpWithIntegrationEntities,
+  IdBridgeRequest,
+  Task,
+} from '../models';
 import { TaskController } from './task.controller';
 
 describe('Task Controller', () => {
   const mockAdapter = {
-    getTasks: jest.fn(),
-    findAllByQuery: jest.fn(),
+    getTask: jest.fn(),
+    findById: jest.fn(),
     createFollowUp: jest.fn(),
   };
   const mockNext = jest.fn();
 
-  describe('findAllByQuery', () => {
+  describe('findById', () => {
     beforeEach(() => jest.clearAllMocks());
 
     it('Should check for providerConfig', async () => {
       const controller = new TaskController(mockAdapter);
 
-      const result = await controller.findAllByQuery(
-        {} as BridgeRequest<void>,
+      const result = await controller.findById(
+        { params: { id: '123' } } as IdBridgeRequest<Task>,
         {} as Response,
         mockNext,
       );
@@ -26,11 +31,11 @@ describe('Task Controller', () => {
       expect(mockNext).toHaveBeenCalled();
     });
 
-    it('Should check if adapter.getTasks is implemented', async () => {
+    it('Should check if adapter.getTask is implemented', async () => {
       const controller = new TaskController({});
 
-      const result = await controller.findAllByQuery(
-        {} as BridgeRequest<void>,
+      const result = await controller.findById(
+        { params: { id: '123' } } as IdBridgeRequest<Task>,
         {} as Response,
         mockNext,
       );
@@ -39,20 +44,21 @@ describe('Task Controller', () => {
       expect(mockNext).toHaveBeenCalled();
     });
 
-    it('Should handle erroneous adapter.getTasks call', async () => {
+    it('Should handle erroneous adapter.getTask call', async () => {
       const controller = new TaskController(mockAdapter);
 
-      mockAdapter.getTasks.mockRejectedValue(null);
+      mockAdapter.getTask.mockRejectedValue(null);
 
-      const result = await controller.findAllByQuery(
+      const result = await controller.findById(
         {
           providerConfig: {
             userId: '123',
             apiKey: '123123123',
             apiUrl: ':)',
             locale: 'de-DE',
           },
-        } as BridgeRequest<void>,
+          params: { id: '123' },
+        } as IdBridgeRequest<Task>,
         {} as Response,
         mockNext,
       );
@@ -65,7 +71,15 @@ describe('Task Controller', () => {
       const controller = new TaskController(mockAdapter);
       const mockResponse = { json: jest.fn() };
 
-      mockAdapter.getTasks.mockResolvedValue([]);
+      const mockTask: Task = {
+        id: '123',
+        content: 'string',
+        createdAt: 12345678,
+        dueAt: 12345678,
+        title: 'string',
+        type: 'string',
+      };
+      mockAdapter.getTask.mockResolvedValue(mockTask);
 
       const req = {
         providerConfig: {
@@ -74,20 +88,21 @@ describe('Task Controller', () => {
           apiUrl: ':)',
           locale: 'de-DE',
         },
-      } as BridgeRequest<void>;
+        params: { id: '123' },
+      } as IdBridgeRequest<Task>;
 
-      const result = await controller.findAllByQuery(
+      const result = await controller.findById(
         req,
         mockResponse as unknown as Response,
         mockNext,
       );
 
       expect(result).toBeUndefined();
-      expect(mockAdapter.getTasks).toHaveBeenCalledWith(
-        req,
+      expect(mockAdapter.getTask).toHaveBeenCalledWith(
         req.providerConfig,
+        req.params.id,
       );
-      expect(mockResponse.json).toHaveBeenCalledWith([]);
+      expect(mockResponse.json).toHaveBeenCalledWith(mockTask);
     });
   });
 

src/controllers/task.controller.ts

@@ -3,42 +3,36 @@ import {
   Adapter,
   BridgeRequest,
   FollowUpWithIntegrationEntities,
+  Task,
 } from '../models';
 import { infoLogger } from '../util';
 
 export class TaskController {
   constructor(private readonly adapter: Adapter) {}
 
-  async findAllByQuery(
-    req: BridgeRequest<void>,
-    res: Response,
-    next: NextFunction,
-  ) {
-    const { providerConfig } = req;
+  async findById(req: BridgeRequest<Task>, res: Response, next: NextFunction) {
+    const {
+      providerConfig,
+      params: { id },
+    } = req;
 
     if (!providerConfig) {
       next(new Error('Provider config not found'));
       return;
     }
 
-    if (!this.adapter.getTasks) {
+    if (!this.adapter.getTask) {
       next(new Error('Method not implemented'));
       return;
     }
 
     try {
-      infoLogger('getTasks', 'START', providerConfig.apiKey);
+      infoLogger('getTask', 'START', providerConfig.apiKey);
 
-      const followUps = await this.adapter.getTasks(req, providerConfig);
-
-      infoLogger(
-        'getTasks',
-        `Received ${followUps.length} follow ups`,
-        providerConfig.apiKey,
-      );
+      const task = await this.adapter.getTask(providerConfig, id);
 
-      infoLogger('getTasks', 'END', providerConfig.apiKey);
-      res.json(followUps);
+      infoLogger('getTask', 'END', providerConfig.apiKey);
+      res.json(task);
     } catch (err) {
       next(err);
     }

src/index.ts

@@ -152,8 +152,8 @@ export function start(
     controller.handleWebhook(req, res, next),
   );
 
-  app.get('/tasks', (req, res, next) =>
-    taskController.findAllByQuery(req, res, next),
+  app.get('/tasks/:id', (req, res, next) =>
+    taskController.findById(req, res, next),
   );
 
   app.post('/tasks', (req, res, next) => taskController.create(req, res, next));

src/models/adapter.model.ts

@@ -94,7 +94,7 @@ export interface Adapter {
   ) => Promise<{ apiKey: string; apiUrl: string }>;
   handleWebhook?: (req: Request) => Promise<IntegrationsEvent[]>;
   verifyWebhookRequest?: (req: Request) => Promise<boolean>;
-  getTasks?: (req: Request, config: Config) => Promise<Task[]>;
+  getTask?: (config: Config, id: string) => Promise<Task>;
   createFollowUp?: (
     config: Config,
     body: FollowUpWithIntegrationEntities,

src/models/task.model.ts

@@ -1,8 +1,8 @@
 export type Task = {
   id: string;
   content: string;
-  createdAt: Date;
-  dueAt: Date;
+  createdAt: number;
+  dueAt: number;
   title: string;
   type: string;
   link?: string;