feat(server): move updating plaid transactions to background job

2026-02-19 06:10:31 +00:00 · 2024-02-03 13:59:46 +02:00
parent b940c6dd17
commit e0ddcb022a
16 changed files with 150 additions and 68 deletions
--- a/packages/server/src/services/Banking/Plaid/PlaidSyncDB.ts
+++ b/packages/server/src/services/Banking/Plaid/PlaidSyncDB.ts
@@ -0,0 +1,126 @@
+import * as R from 'ramda';
+import { Inject, Service } from 'typedi';
+import bluebird from 'bluebird';
+import { entries, groupBy } from 'lodash';
+import { CreateAccount } from '@/services/Accounts/CreateAccount';
+import { PlaidAccount, PlaidTransaction } from '@/interfaces';
+import {
+  transformPlaidAccountToCreateAccount,
+  transformPlaidTrxsToCashflowCreate,
+} from './utils';
+import NewCashflowTransactionService from '@/services/Cashflow/NewCashflowTransactionService';
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+
+@Service()
+export class PlaidSyncDb {
+  @Inject()
+  private tenancy: HasTenancyService;
+
+  @Inject()
+  private createAccountService: CreateAccount;
+
+  @Inject()
+  private createCashflowTransactionService: NewCashflowTransactionService;
+
+  /**
+   * Syncs the plaid accounts to the system accounts.
+   * @param {number} tenantId Tenant ID.
+   * @param {PlaidAccount[]} plaidAccounts
+   * @returns {Promise<void>}
+   */
+  public async syncBankAccounts(
+    tenantId: number,
+    plaidAccounts: PlaidAccount[]
+  ): Promise<void> {
+    const accountCreateDTOs = R.map(transformPlaidAccountToCreateAccount)(
+      plaidAccounts
+    );
+    await bluebird.map(
+      accountCreateDTOs,
+      (createAccountDTO: any) =>
+        this.createAccountService.createAccount(tenantId, createAccountDTO),
+      { concurrency: 10 }
+    );
+  }
+
+  /**
+   * Synsc the Plaid transactions to the system GL entries.
+   * @param {number} tenantId - Tenant ID.
+   * @param {number} plaidAccountId - Plaid account ID.
+   * @param {PlaidTransaction[]} plaidTranasctions - Plaid transactions
+   */
+  public async syncAccountTranactions(
+    tenantId: number,
+    plaidAccountId: number,
+    plaidTranasctions: PlaidTransaction[]
+  ): Promise<void> {
+    const { Account } = this.tenancy.models(tenantId);
+
+    const cashflowAccount = await Account.query()
+      .findOne({ plaidAccountId })
+      .throwIfNotFound();
+
+    const openingEquityBalance = await Account.query().findOne(
+      'slug',
+      'opening-balance-equity'
+    );
+    // Transformes the Plaid transactions to cashflow create DTOs.
+    const transformTransaction = transformPlaidTrxsToCashflowCreate(
+      cashflowAccount.id,
+      openingEquityBalance.id
+    );
+    const accountsCashflowDTO = R.map(transformTransaction)(plaidTranasctions);
+
+    // Creating account transaction queue.
+    await bluebird.map(
+      accountsCashflowDTO,
+      (cashflowDTO) =>
+        this.createCashflowTransactionService.newCashflowTransaction(
+          tenantId,
+          cashflowDTO
+        ),
+      { concurrency: 10 }
+    );
+  }
+
+  /**
+   * Syncs the accounts transactions in paraller under controlled concurrency.
+   * @param {number} tenantId
+   * @param {PlaidTransaction[]} plaidTransactions
+   */
+  public async syncAccountsTransactions(
+    tenantId: number,
+    plaidAccountsTransactions: PlaidTransaction[]
+  ): Promise<void> {
+    const groupedTrnsxByAccountId = entries(
+      groupBy(plaidAccountsTransactions, 'account_id')
+    );
+    await bluebird.map(
+      groupedTrnsxByAccountId,
+      ([plaidAccountId, plaidTransactions]: [number, PlaidTransaction[]]) => {
+        return this.syncAccountTranactions(
+          tenantId,
+          plaidAccountId,
+          plaidTransactions
+        );
+      },
+      { concurrency: 10 }
+    );
+  }
+
+  /**
+   * Syncs the Plaid item last transaction cursor.
+   * @param {number} tenantId - Tenant ID.
+   * @param {string} itemId - Plaid item ID.
+   * @param {string} lastCursor - Last transaction cursor.
+   */
+  public async syncTransactionsCursor(
+    tenantId: number,
+    plaidItemId: string,
+    lastCursor: string
+  ) {
+    const { PlaidItem } = this.tenancy.models(tenantId);
+
+    await PlaidItem.query().findById(plaidItemId).patch({ lastCursor });
+  }
+}