src/campaign: Cache list endpoint

apps/api/src/campaign/campaign.controller.ts

@@ -31,6 +31,10 @@ import { ApiTags } from '@nestjs/swagger'
 import { CampaignNewsService } from '../campaign-news/campaign-news.service'
 import { CampaignSubscribeDto } from './dto/campaign-subscribe.dto'
 
+import { CacheInterceptor, CacheKey } from '@nestjs/cache-manager'
+import { UseInterceptors } from '@nestjs/common'
+import { CAMPAIGN_LIST } from '../common/cacheKeys'
+
 @ApiTags('campaign')
 @Controller('campaign')
 export class CampaignController {
@@ -41,6 +45,8 @@ export class CampaignController {
   ) {}
 
   @Get('list')
+  @UseInterceptors(CacheInterceptor)
+  @CacheKey(CAMPAIGN_LIST)
   @Public()
   async getData() {
     return this.campaignService.listCampaigns()

apps/api/src/campaign/campaign.service.ts

@@ -41,14 +41,17 @@ import {
   NotificationService,
   donationNotificationSelect,
 } from '../sockets/notifications/notification.service'
-import { DonationMetadata } from '../donations/dontation-metadata.interface'
+
 import { Expense } from '@prisma/client'
 import { SendGridParams } from '../notifications/providers/notifications.sendgrid.types'
 import * as NotificationData from '../notifications/notification-data.json'
 import { ConfigService } from '@nestjs/config'
 import { DateTime } from 'luxon'
 import { CampaignSubscribeDto } from './dto/campaign-subscribe.dto'
 import { MarketingNotificationsService } from '../notifications/notifications.service'
+import { CACHE_MANAGER } from '@nestjs/cache-manager'
+import { Cache } from 'cache-manager'
+import { CAMPAIGN_LIST } from '../common/cacheKeys'
 
 @Injectable()
 export class CampaignService {
@@ -60,6 +63,7 @@ export class CampaignService {
     @Inject(forwardRef(() => MarketingNotificationsService))
     private marketingNotificationsService: MarketingNotificationsService,
     private readonly config: ConfigService,
+    @Inject(CACHE_MANAGER) private cacheManager: Cache,
   ) {}
 
   async listCampaigns(): Promise<CampaignListItem[]> {
@@ -643,6 +647,7 @@ export class CampaignService {
             ...updatedDonation,
             person: updatedDonation.person,
           })
+          await this.cacheManager.del(CAMPAIGN_LIST)
         } else if (
           donation.status === DonationStatus.succeeded &&
           newDonationStatus === DonationStatus.refund
@@ -656,6 +661,7 @@ export class CampaignService {
             ...updatedDonation,
             person: updatedDonation.person,
           })
+          await this.cacheManager.del(CAMPAIGN_LIST)
         }
         return updatedDonation
       } catch (error) {
@@ -713,6 +719,7 @@ export class CampaignService {
       if (newDonationStatus === DonationStatus.succeeded) {
         await this.vaultService.incrementVaultAmount(donation.targetVaultId, donation.amount, tx)
         this.notificationService.sendNotification('successfulDonation', donation)
+        await this.cacheManager.del(CAMPAIGN_LIST)
       }
 
       return donation

apps/api/src/common/cacheKeys.ts

@@ -0,0 +1,5 @@
+/**
+ * List of cache key definitions for manual manipulation(e.g. deleting, caching) etc..
+ */
+
+export const CAMPAIGN_LIST = 'campaignList'

apps/api/src/donations/donations.service.ts

@@ -1,7 +1,7 @@
 import Stripe from 'stripe'
 import { ConfigService } from '@nestjs/config'
 import { InjectStripeClient } from '@golevelup/nestjs-stripe'
-import { BadRequestException, Injectable, Logger, NotFoundException } from '@nestjs/common'
+import { BadRequestException, Inject, Injectable, Logger, NotFoundException } from '@nestjs/common'
 import {
   Campaign,
   Donation,
@@ -28,6 +28,9 @@ import { CreateStripePaymentDto } from './dto/create-stripe-payment.dto'
 import { ImportStatus } from '../bank-transactions-file/dto/bank-transactions-import-status.dto'
 import { DonationQueryDto } from '../common/dto/donation-query-dto'
 import { CreateAffiliateDonationDto } from '../affiliate/dto/create-affiliate-donation.dto'
+import { CACHE_MANAGER } from '@nestjs/cache-manager'
+import { Cache } from 'cache-manager'
+import { CAMPAIGN_LIST } from '../common/cacheKeys'
 
 @Injectable()
 export class DonationsService {
@@ -38,6 +41,7 @@ export class DonationsService {
     private prisma: PrismaService,
     private vaultService: VaultService,
     private exportService: ExportService,
+    @Inject(CACHE_MANAGER) private cacheManager: Cache,
   ) {}
   async listPrices(type?: Stripe.PriceListParams.Type, active?: boolean): Promise<Stripe.Price[]> {
     const listResponse = await this.stripeClient.prices.list({ active, type, limit: 100 }).then(
@@ -340,6 +344,7 @@ export class DonationsService {
         },
       })
     }
+    await this.cacheManager.del(CAMPAIGN_LIST)
     return donation
   }
 
@@ -588,6 +593,7 @@ export class DonationsService {
           donationDto.amount,
           tx,
         )
+        await this.cacheManager.del(CAMPAIGN_LIST)
         return ImportStatus.SUCCESS
       }
 
@@ -609,6 +615,7 @@ export class DonationsService {
           data: { status: DonationStatus.succeeded, updatedAt: donationDto.updatedAt },
         }),
       ])
+      await this.cacheManager.del(CAMPAIGN_LIST)
     })
   }