perf: Cache customer accounts [DEV-4973] (#674)

perf: Cache customer accounts

Author: DaevMithran

src/controllers/admin/organisation.ts

@@ -12,6 +12,8 @@ import type {
 } from '../../types/admin.js';
 import { PaymentAccountService } from '../../services/api/payment-account.js';
 import { CheqdNetwork } from '@cheqd/sdk';
+import { LocalStore } from '../../database/cache/store.js';
+import { PaymentAccountEntity } from '../../database/entities/payment.account.entity.js';
 
 dotenv.config();
 
@@ -73,16 +75,23 @@ export class OrganisationController {
 				email,
 				description,
 			});
-			const paymentAccount = await PaymentAccountService.instance.find({ customer: customer });
+            
+            const cachedAccounts = LocalStore.instance.getCustomerAccounts(response.locals.customer.customerId);
+            let paymentAccounts: PaymentAccountEntity[];
+            if (cachedAccounts?.length == 2) {
+                paymentAccounts = cachedAccounts;
+            } else {
+                paymentAccounts = await PaymentAccountService.instance.find({ customer: response.locals.customer });
+            }
 
-			if (!customer || paymentAccount.length === 0) {
+			if (!customer || paymentAccounts.length === 0) {
 				response.status(StatusCodes.NOT_FOUND).json({
 					error: 'Customer for updating not found',
 				} satisfies AdminOrganisationUpdateUnsuccessfulResponseBody);
 			}
 
-			const testnetAddress = paymentAccount.find((acc) => acc.namespace === CheqdNetwork.Testnet)?.address;
-			const mainnetAddress = paymentAccount.find((acc) => acc.namespace === CheqdNetwork.Mainnet)?.address;
+			const testnetAddress = paymentAccounts.find((acc) => acc.namespace === CheqdNetwork.Testnet)?.address;
+			const mainnetAddress = paymentAccounts.find((acc) => acc.namespace === CheqdNetwork.Mainnet)?.address;
 
 			return response.status(StatusCodes.OK).json({
 				name: customer.name,

src/controllers/api/account.ts

@@ -32,6 +32,8 @@ import { SubscriptionService } from '../../services/admin/subscription.js';
 import { RoleService } from '../../services/api/role.js';
 import { getStripeObjectKey } from '../../utils/index.js';
 import { KeyService } from '../../services/api/key.js';
+import { LocalStore } from '../../database/cache/store.js';
+
 dotenv.config();
 
 export class AccountController {
@@ -76,7 +78,14 @@ export class AccountController {
 					error: 'Bad state cause there is no customer assigned to the user yet. Please contact administrator.',
 				} satisfies UnsuccessfulQueryCustomerResponseBody);
 			}
-			const paymentAccounts = await PaymentAccountService.instance.find({ customer: response.locals.customer });
+            
+            const cachedAccounts = LocalStore.instance.getCustomerAccounts(response.locals.customer.customerId);
+            let paymentAccounts: PaymentAccountEntity[];
+            if (cachedAccounts?.length == 2) {
+                paymentAccounts = cachedAccounts;
+            } else {
+                paymentAccounts = await PaymentAccountService.instance.find({ customer: response.locals.customer });
+            }
 			const result: QueryCustomerResponseBody = {
 				customer: {
 					customerId: response.locals.customer.customerId,

src/database/cache/store.ts

@@ -0,0 +1,26 @@
+import NodeCache from 'node-cache';
+import * as dotenv from 'dotenv';
+
+import { PaymentAccountEntity } from '../entities/payment.account.entity.js';
+
+dotenv.config();
+
+let { LOCAL_STORE_TTL = 600 } = process.env;
+
+export class LocalStore {
+	private cache: NodeCache;
+
+	public static instance = new LocalStore();
+
+	constructor() {
+		this.cache = new NodeCache();
+	}
+
+	setCustomerAccounts(key: string, data: PaymentAccountEntity[]) {
+		this.cache.set(key, data, +LOCAL_STORE_TTL);
+	}
+
+	getCustomerAccounts(key: string) {
+		return this.cache.get(key) as PaymentAccountEntity[] | undefined;
+	}
+}

src/services/api/store.ts

@@ -58,6 +58,7 @@ import { toTPublicKeyEd25519 } from '../helpers.js';
 import type { APIServiceOptions } from '../../types/admin.js';
 import { SupportedKeyTypes } from '@veramo/utils';
 import { PaymentAccountEntity } from '../../database/entities/payment.account.entity.js';
+import { LocalStore } from '../../database/cache/store.js';
 
 dotenv.config();
 
@@ -130,7 +131,17 @@ export class PostgresIdentityService extends DefaultIdentityService {
 		}
 		const dbConnection = Connection.instance.dbConnection;
 
-		const paymentAccounts = await PaymentAccountService.instance.find({ customer }, ['key']);
+		const cachedAccounts = LocalStore.instance.getCustomerAccounts(customer.customerId);
+		let paymentAccounts: PaymentAccountEntity[];
+		if (cachedAccounts?.length == 2) {
+			paymentAccounts = cachedAccounts;
+		} else {
+			paymentAccounts = await PaymentAccountService.instance.find({ customer }, ['key']);
+
+			if (paymentAccounts.length > 0) {
+				LocalStore.instance.setCustomerAccounts(customer.customerId, paymentAccounts);
+			}
+		}
 
 		// One customer may / may not have one Mainnet paymentAccount
 		const providerMainnet = await this.createCheqdProvider(customer, CheqdNetwork.Mainnet, paymentAccounts);

src/services/identity/postgres.ts

@@ -8,6 +8,7 @@ declare global {
 			PORT: string;
 			NPM_CONFIG_LOGLEVEL: string;
 			LOG_LEVEL: string | 'info';
+			LOCAL_STORE_TTL: string | undefined;
 
 			// Network API endpoints
 			MAINNET_RPC_URL: string;