feat: wip pause/resume bank feeds syncing

packages/server/src/api/controllers/Banking/BankAccountsController.ts

@@ -3,6 +3,7 @@ import { NextFunction, Request, Response, Router } from 'express';
 import BaseController from '@/api/controllers/BaseController';
 import { GetBankAccountSummary } from '@/services/Banking/BankAccounts/GetBankAccountSummary';
 import { BankAccountsApplication } from '@/services/Banking/BankAccounts/BankAccountsApplication';
+import { param } from 'express-validator';
 
 @Service()
 export class BankAccountsController extends BaseController {
@@ -26,10 +27,18 @@ export class BankAccountsController extends BaseController {
     router.post('/:bankAccountId/update', this.refreshBankAccount.bind(this));
     router.post(
       '/:bankAccountId/pause_feeds',
+      [
+        param('bankAccountId').exists().isNumeric().toInt(),
+      ],
+      this.validationResult,
       this.pauseBankAccountFeeds.bind(this)
     );
     router.post(
       '/:bankAccountId/resume_feeds',
+      [
+        param('bankAccountId').exists().isNumeric().toInt(),
+      ],
+      this.validationResult,
       this.resumeBankAccountFeeds.bind(this)
     );
 
@@ -117,6 +126,13 @@ export class BankAccountsController extends BaseController {
     }
   }
 
+  /**
+   * 
+   * @param {Request} req 
+   * @param {Response} res 
+   * @param {NextFunction} next 
+   * @returns {Promise<Response | void>}
+   */
   async resumeBankAccountFeeds(
     req: Request<{ bankAccountId: number }>,
     res: Response,
@@ -129,13 +145,21 @@ export class BankAccountsController extends BaseController {
       await this.bankAccountsApp.resumeBankAccount(tenantId, bankAccountId);
 
       return res.status(200).send({
-        message: '',
+        message: 'The bank account feeds syncing has been resumed.',
+        id: bankAccountId,
       });
     } catch (error) {
       next(error);
     }
   }
 
+  /**
+   * 
+   * @param {Request} req 
+   * @param {Response} res 
+   * @param {NextFunction} next 
+   * @returns {Promise<Response | void>}
+   */
   async pauseBankAccountFeeds(
     req: Request<{ bankAccountId: number }>,
     res: Response,
@@ -148,7 +172,8 @@ export class BankAccountsController extends BaseController {
       await this.bankAccountsApp.pauseBankAccount(tenantId, bankAccountId);
 
       return res.status(200).send({
-        message: '',
+        message: 'The bank account feeds syncing has been paused.',
+        id: bankAccountId,
       });
     } catch (error) {
       next(error);

packages/server/src/database/migrations/20240804084709_create_paused_at_column_to_plaid_items_table.js

@@ -0,0 +1,11 @@
+exports.up = function (knex) {
+  return knex.schema.table('plaid_items', (table) => {
+    table.datetime('paused_at');
+  });
+};
+
+exports.down = function (knex) {
+  return knex.schema.table('plaid_items', (table) => {
+    table.dropColumn('paused_at');
+  });
+};

packages/server/src/models/PlaidItem.ts

@@ -1,6 +1,8 @@
 import TenantModel from 'models/TenantModel';
 
 export default class PlaidItem extends TenantModel {
+  pausedAt: Date;
+
   /**
    * Table name.
    */
@@ -21,4 +23,19 @@ export default class PlaidItem extends TenantModel {
   static get relationMappings() {
     return {};
   }
+
+  /**
+   * Virtual attributes.
+   */
+  static get virtualAttributes() {
+    return ['isPaused'];
+  }
+
+  /**
+   * Detarmines whether the Plaid item feeds syncing is paused.
+   * @return {boolean}
+   */
+  get isPaused() {
+    return !!this.pausedAt;
+  }
 }

packages/server/src/services/Banking/BankAccounts/BankAccountsApplication.tsx

@@ -1,7 +1,8 @@
 import { Inject, Service } from 'typedi';
 import { DisconnectBankAccount } from './DisconnectBankAccount';
 import { RefreshBankAccountService } from './RefreshBankAccount';
-import { ResumeBankAccountFeeds } from './PauseBankAccountFeeds';
+import { PauseBankAccountFeeds } from './PauseBankAccountFeeds';
+import { ResumeBankAccountFeeds } from './ResumeBankAccountFeeds';
 
 @Service()
 export class BankAccountsApplication {
@@ -15,7 +16,7 @@ export class BankAccountsApplication {
   private resumeBankAccountFeedsService: ResumeBankAccountFeeds;
 
   @Inject()
-  private pauseBankAccountFeedsService: ResumeBankAccountFeeds;
+  private pauseBankAccountFeedsService: PauseBankAccountFeeds;
 
   /**
    * Disconnects the given bank account.
@@ -45,12 +46,12 @@ export class BankAccountsApplication {
 
   /**
    * Pauses the feeds sync of the given bank account.
-   * @param {number} tenantId 
-   * @param {number} bankAccountId 
+   * @param {number} tenantId
+   * @param {number} bankAccountId
    * @returns {Promise<void>}
    */
   async pauseBankAccount(tenantId: number, bankAccountId: number) {
-    return this.pauseBankAccountFeedsService.resumeBankAccountFeeds(
+    return this.pauseBankAccountFeedsService.pauseBankAccountFeeds(
       tenantId,
       bankAccountId
     );
@@ -58,8 +59,8 @@ export class BankAccountsApplication {
 
   /**
    * Resumes the feeds sync of the given bank account.
-   * @param {number} tenantId 
-   * @param {number} bankAccountId 
+   * @param {number} tenantId
+   * @param {number} bankAccountId
    * @returns {Promise<void>}
    */
   async resumeBankAccount(tenantId: number, bankAccountId: number) {

packages/server/src/services/Banking/BankAccounts/PauseBankAccountFeeds.tsx

@@ -1,9 +1,33 @@
-import { Service } from 'typedi';
+import { Inject, Service } from 'typedi';
+import { Knex } from 'knex';
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+import UnitOfWork from '@/services/UnitOfWork';
 
 @Service()
-export class ResumeBankAccountFeeds {
-  public resumeBankAccountFeeds(tenantId: number, bankAccountId: number) {
+export class PauseBankAccountFeeds {
+  @Inject()
+  private tenancy: HasTenancyService;
 
+  @Inject()
+  private uow: UnitOfWork;
 
+  /**
+   * Pauses the bankfeed syncing of the given bank account.
+   * @param {number} tenantId
+   * @param {number} bankAccountId
+   * @returns {Promise<void>}
+   */
+  public async pauseBankAccountFeeds(tenantId: number, bankAccountId: number) {
+    const { Account, PlaidItem } = this.tenancy.models(tenantId);
+
+    const oldAccount = await Account.query()
+      .findById(bankAccountId)
+      .withGraphFetched('plaidItem');
+
+    return this.uow.withTransaction(tenantId, async (trx: Knex.Transaction) => {
+      await PlaidItem.query().findById(oldAccount.plaidItem.id).patch({
+        pausedAt: null,
+      });
+    });
   }
 }

packages/server/src/services/Banking/BankAccounts/ResumeBankAccountFeeds.tsx

@@ -1,11 +1,32 @@
-import { Service } from "typedi";
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+import UnitOfWork from '@/services/UnitOfWork';
+import { Inject, Service } from 'typedi';
 
 @Service()
 export class ResumeBankAccountFeeds {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private uow: UnitOfWork;
+
   /**
-   *
+   * Resumes the bank feeds syncing of the bank account.
    * @param {number} tenantId
    * @param {number} bankAccountId
+   * @returns {Promise<void>}
    */
-  public resumeBankAccountFeeds(tenantId: number, bankAccountId: number) {}
+  public async resumeBankAccountFeeds(tenantId: number, bankAccountId: number) {
+    const { Account, PlaidItem } = this.tenancy.models(tenantId);
+
+    const oldAccount = await Account.query()
+      .findById(bankAccountId)
+      .withGraphFetched('plaidItem');
+
+    return this.uow.withTransaction(tenantId, async (trx: Knex.Transaction) => {
+      await PlaidItem.query().findById(oldAccount.plaidItem.id).patch({
+        pausedAt: new Date(),
+      });
+    });
+  }
 }