feat: cache notification template by trigger identifier

apps/api/src/app/change/usecases/promote-notification-template-change/promote-notification-template-change.usecase.ts

@@ -12,7 +12,7 @@ import { ChangeEntityTypeEnum } from '@novu/shared';
 import { ApplyChange, ApplyChangeCommand } from '../apply-change';
 import { PromoteTypeChangeCommand } from '../promote-type-change.command';
 import { InvalidateCacheService } from '../../../shared/services/cache';
-import { entityBuilder } from '../../../shared/services/cache/keys';
+import { notificationTemplateQueryKeyBuild } from '../../../shared/services/cache/keys';
 
 @Injectable()
 export class PromoteNotificationTemplateChange {
@@ -136,9 +136,8 @@ export class PromoteNotificationTemplateChange {
       return;
     }
 
-    await this.invalidateCache.invalidateByKey({
-      key: entityBuilder().notificationTemplate({
-        _id: item._id,
+    await this.invalidateCache.invalidateQuery({
+      key: notificationTemplateQueryKeyBuild().invalidate({
         _environmentId: command.environmentId,
       }),
     });

apps/api/src/app/events/e2e/process-subscriber.e2e.ts

@@ -11,7 +11,7 @@ import axios from 'axios';
 import { ChannelTypeEnum, ISubscribersDefine, StepTypeEnum } from '@novu/shared';
 import { UpdateSubscriberPreferenceRequestDto } from '../../widgets/dtos/update-subscriber-preference-request.dto';
 import { CacheService, InvalidateCacheService } from '../../shared/services/cache';
-import { entityBuilder } from '../../shared/services/cache/keys';
+import { notificationTemplateQueryKeyBuild } from '../../shared/services/cache/keys';
 
 const axiosInstance = axios.create();
 
@@ -194,9 +194,8 @@ describe('Trigger event - process subscriber /v1/events/trigger (POST)', functio
 
     await updateSubscriberPreference(updateData, session.subscriberToken, template._id);
 
-    await invalidateCache.invalidateByKey({
-      key: entityBuilder().notificationTemplate({
-        _id: template._id,
+    await invalidateCache.invalidateQuery({
+      key: notificationTemplateQueryKeyBuild().invalidate({
         _environmentId: session.environment._id,
       }),
     });

apps/api/src/app/events/usecases/parse-event-request/parse-event-request.usecase.ts

@@ -9,12 +9,13 @@ import { v4 as uuidv4 } from 'uuid';
 
 import { ANALYTICS_SERVICE } from '../../../shared/shared.module';
 import { ApiException } from '../../../shared/exceptions/api.exception';
-import { VerifyPayload } from '../verify-payload/verify-payload.usecase';
-import { VerifyPayloadCommand } from '../verify-payload/verify-payload.command';
+import { VerifyPayload, VerifyPayloadCommand } from '../verify-payload';
 import { StorageHelperService } from '../../services/storage-helper-service/storage-helper.service';
 import { ParseEventRequestCommand } from './parse-event-request.command';
 import { TriggerHandlerQueueService } from '../../services/workflow-queue/trigger-handler-queue.service';
 import { MapTriggerRecipients, MapTriggerRecipientsCommand } from '../map-trigger-recipients';
+import { CachedQuery } from '../../../shared/interceptors/cached-query.interceptor';
+import { notificationTemplateQueryKeyBuild } from '../../../shared/services/cache/keys';
 
 @Injectable()
 export class ParseEventRequest {
@@ -48,10 +49,10 @@ export class ParseEventRequest {
 
     await this.validateSubscriberIdProperty(mappedRecipients);
 
-    const template = await this.notificationTemplateRepository.findByTriggerIdentifier(
-      command.environmentId,
-      command.identifier
-    );
+    const template = await this.getNotificationTemplateByTriggerIdentifier({
+      environmentId: command.environmentId,
+      triggerIdentifier: command.identifier,
+    });
 
     if (!template) {
       throw new UnprocessableEntityException('template_not_found');
@@ -136,6 +137,23 @@ export class ParseEventRequest {
     };
   }
 
+  @CachedQuery({
+    builder: (command: { triggerIdentifier: string; environmentId: string }) =>
+      notificationTemplateQueryKeyBuild().cache({
+        _environmentId: command.environmentId,
+        identifiers: { triggerIdentifier: command.triggerIdentifier },
+      }),
+  })
+  private async getNotificationTemplateByTriggerIdentifier(command: {
+    triggerIdentifier: string;
+    environmentId: string;
+  }) {
+    return await this.notificationTemplateRepository.findByTriggerIdentifier(
+      command.environmentId,
+      command.triggerIdentifier
+    );
+  }
+
   private async validateSubscriberIdProperty(to: ISubscribersDefine[]): Promise<boolean> {
     for (const subscriber of to) {
       const subscriberIdExists = typeof subscriber === 'string' ? subscriber : subscriber.subscriberId;

apps/api/src/app/events/usecases/send-message/send-message.usecase.ts

@@ -37,7 +37,13 @@ import {
 import { ANALYTICS_SERVICE } from '../../../shared/shared.module';
 import { ApiException } from '../../../shared/exceptions/api.exception';
 import { CachedEntity } from '../../../shared/interceptors/cached-entity.interceptor';
-import { buildCommonKey, CacheKeyPrefixEnum, CacheKeyTypeEnum } from '../../../shared/services/cache/keys';
+import {
+  buildCommonKey,
+  CacheKeyPrefixEnum,
+  CacheKeyTypeEnum,
+  notificationTemplateQueryKeyBuild,
+} from '../../../shared/services/cache/keys';
+import { CachedQuery } from '../../../shared/interceptors/cached-query.interceptor';
 
 @Injectable()
 export class SendMessage {
@@ -233,13 +239,11 @@ export class SendMessage {
     return result || template.critical;
   }
 
-  @CachedEntity({
+  @CachedQuery({
     builder: (command: { _id: string; environmentId: string }) =>
-      buildCommonKey({
-        type: CacheKeyTypeEnum.ENTITY,
-        keyEntity: CacheKeyPrefixEnum.NOTIFICATION_TEMPLATE,
-        environmentId: command.environmentId,
-        identifier: command._id,
+      notificationTemplateQueryKeyBuild().cache({
+        _environmentId: command.environmentId,
+        identifiers: { id: command._id },
       }),
   })
   private async getNotificationTemplate({ _id, environmentId }: { _id: string; environmentId: string }) {

apps/api/src/app/events/usecases/trigger-event/trigger-event.usecase.ts

@@ -20,6 +20,8 @@ import { ApiException } from '../../../shared/exceptions/api.exception';
 const LOG_CONTEXT = 'TriggerEventUseCase';
 
 import { PinoLogger } from '@novu/application-generic';
+import { notificationTemplateQueryKeyBuild } from '../../../shared/services/cache/keys';
+import { CachedQuery } from '../../../shared/interceptors/cached-query.interceptor';
 
 @Injectable()
 export class TriggerEvent {
@@ -54,10 +56,10 @@ export class TriggerEvent {
       organizationId: command.organizationId,
     });
 
-    const template = await this.notificationTemplateRepository.findByTriggerIdentifier(
-      command.environmentId,
-      command.identifier
-    );
+    const template = await this.getNotificationTemplateByTriggerIdentifier({
+      environmentId: command.environmentId,
+      triggerIdentifier: command.identifier,
+    });
 
     /*
      * Makes no sense to execute anything if template doesn't exist
@@ -136,6 +138,23 @@ export class TriggerEvent {
     this.performanceService.setEnd(mark);
   }
 
+  @CachedQuery({
+    builder: (command: { triggerIdentifier: string; environmentId: string }) =>
+      notificationTemplateQueryKeyBuild().cache({
+        _environmentId: command.environmentId,
+        identifiers: { triggerIdentifier: command.triggerIdentifier },
+      }),
+  })
+  private async getNotificationTemplateByTriggerIdentifier(command: {
+    triggerIdentifier: string;
+    environmentId: string;
+  }) {
+    return await this.notificationTemplateRepository.findByTriggerIdentifier(
+      command.environmentId,
+      command.triggerIdentifier
+    );
+  }
+
   private async validateTransactionIdProperty(
     transactionId: string,
     organizationId: string,

apps/api/src/app/notification-template/usecases/change-template-active-status/change-template-active-status.usecase.ts

@@ -5,7 +5,7 @@ import { ChangeEntityTypeEnum } from '@novu/shared';
 import { ChangeTemplateActiveStatusCommand } from './change-template-active-status.command';
 import { CreateChange, CreateChangeCommand } from '../../../change/usecases';
 import { InvalidateCacheService } from '../../../shared/services/cache';
-import { entityBuilder } from '../../../shared/services/cache/keys';
+import { notificationTemplateQueryKeyBuild } from '../../../shared/services/cache/keys';
 
 @Injectable()
 export class ChangeTemplateActiveStatus {
@@ -29,9 +29,8 @@ export class ChangeTemplateActiveStatus {
       throw new BadRequestException('You must provide a different status from the current status');
     }
 
-    await this.invalidateCache.invalidateByKey({
-      key: entityBuilder().notificationTemplate({
-        _id: command.templateId,
+    await this.invalidateCache.invalidateQuery({
+      key: notificationTemplateQueryKeyBuild().invalidate({
         _environmentId: command.environmentId,
       }),
     });

apps/api/src/app/notification-template/usecases/update-notification-template/update-notification-template.usecase.ts

@@ -22,7 +22,7 @@ import { ANALYTICS_SERVICE } from '../../../shared/shared.module';
 import { CacheService, InvalidateCacheService } from '../../../shared/services/cache';
 import { ApiException } from '../../../shared/exceptions/api.exception';
 import { NotificationStep } from '../../../shared/dtos/notification-step';
-import { entityBuilder } from '../../../shared/services/cache/keys';
+import { notificationTemplateQueryKeyBuild } from '../../../shared/services/cache/keys';
 
 @Injectable()
 export class UpdateNotificationTemplate {
@@ -38,9 +38,8 @@ export class UpdateNotificationTemplate {
   ) {}
 
   async execute(command: UpdateNotificationTemplateCommand): Promise<NotificationTemplateEntity> {
-    await this.invalidateCache.invalidateByKey({
-      key: entityBuilder().notificationTemplate({
-        _id: command.id,
+    await this.invalidateCache.invalidateQuery({
+      key: notificationTemplateQueryKeyBuild().invalidate({
         _environmentId: command.environmentId,
       }),
     });

apps/api/src/app/shared/services/cache/keys.ts

@@ -23,7 +23,7 @@ export const queryBuilder = () => {
 };
 
 export const entityBuilder = () => {
-  return { subscriber, integration, notificationTemplate, user, environmentByApiKey };
+  return { subscriber, integration, user, environmentByApiKey };
 };
 
 export const buildQueryKey = ({
@@ -121,14 +121,6 @@ const integration = ({ _id, _environmentId }: { _id: string; _environmentId: str
     identifier: _id,
   });
 
-const notificationTemplate = ({ _id, _environmentId }: { _id: string; _environmentId: string }): string =>
-  buildCommonKey({
-    type: CacheKeyTypeEnum.ENTITY,
-    keyEntity: CacheKeyPrefixEnum.NOTIFICATION_TEMPLATE,
-    environmentId: _environmentId,
-    identifier: _id,
-  });
-
 const user = ({ _id }: { _id: string }): string =>
   buildKeyById({
     type: CacheKeyTypeEnum.ENTITY,
@@ -170,3 +162,76 @@ export const buildKeyById = ({
   identifierPrefix?: string;
   identifier: string;
 }): string => `${type}:${keyEntity}:${identifierPrefix}=${identifier}`;
+
+export const notificationTemplateQueryKeyBuild = () => {
+  const cache = ({
+    _environmentId,
+    identifiers,
+  }: {
+    _environmentId: string;
+    identifiers: ({ id: string } & { triggerIdentifier?: string }) | ({ id?: string } & { triggerIdentifier: string });
+  }): string =>
+    buildQueryKeyByEnvironment({
+      type: CacheKeyTypeEnum.QUERY,
+      keyEntity: CacheKeyPrefixEnum.NOTIFICATION_TEMPLATE,
+      environmentId: _environmentId,
+      query: identifiers as unknown as Record<string, unknown>,
+    });
+
+  const invalidate = ({ _environmentId }: { _environmentId: string }): string =>
+    buildKeyByEnvironment({
+      type: CacheKeyTypeEnum.QUERY,
+      keyEntity: CacheKeyPrefixEnum.NOTIFICATION_TEMPLATE,
+      environmentId: _environmentId,
+    });
+
+  return {
+    cache,
+    invalidate,
+  };
+};
+
+/*
+ * const notificationTemplate = ({ _id, _environmentId }: { _id: string; _environmentId: string }): string =>
+ *   buildCommonKey({
+ *     type: CacheKeyTypeEnum.ENTITY,
+ *     keyEntity: CacheKeyPrefixEnum.NOTIFICATION_TEMPLATE,
+ *     environmentId: _environmentId,
+ *     identifier: _id,
+ *   });
+ */
+
+export const buildQueryKeyByEnvironment = ({
+  type,
+  keyEntity,
+  environmentIdPrefix = 'e',
+  environmentId,
+  query,
+}: {
+  type: CacheKeyTypeEnum;
+  keyEntity: CacheKeyPrefixEnum;
+  environmentIdPrefix?: string;
+  environmentId: string;
+  query: Record<string, unknown>;
+}): string => {
+  const keyBase = buildKeyByEnvironment({
+    type,
+    keyEntity,
+    environmentIdPrefix,
+    environmentId,
+  });
+
+  return `${keyBase}:${QUERY_PREFIX}=${JSON.stringify(query)}`;
+};
+
+export const buildKeyByEnvironment = ({
+  type,
+  keyEntity,
+  environmentIdPrefix = 'e',
+  environmentId,
+}: {
+  type: CacheKeyTypeEnum;
+  keyEntity: CacheKeyPrefixEnum;
+  environmentIdPrefix?: string;
+  environmentId: string;
+}): string => `${type}:${keyEntity}:${environmentIdPrefix}=${environmentId}`;