refactor: Add DeepRequired type and Instrument decorator

libs/application-generic/src/http/utils.types.ts

@@ -4,6 +4,15 @@
  */
 export type WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] };
 
+/**
+ * Recursively make all properties of type `T` required.
+ */
+export type DeepRequired<T> = T extends object
+  ? {
+      [P in keyof T]-?: DeepRequired<T[P]>;
+    }
+  : T;
+
 /**
  * Transform S to CONSTANT_CASE.
  */

libs/application-generic/src/usecases/get-preferences/get-preferences.usecase.ts

@@ -14,7 +14,7 @@ import { MergePreferences } from '../merge-preferences/merge-preferences.usecase
 import { MergePreferencesCommand } from '../merge-preferences/merge-preferences.command';
 
 export type PreferenceSet = {
-  workflowResourcePreference: PreferencesEntity & {
+  workflowResourcePreference?: PreferencesEntity & {
     preferences: WorkflowPreferences;
   };
   workflowUserPreference?: PreferencesEntity & {
@@ -145,12 +145,8 @@ export class GetPreferences {
       }) as Promise<PreferenceSet['subscriberGlobalPreference'] | null>,
     ]);
 
-    if (workflowResourcePreference === null) {
-      throw new PreferencesNotFoundException(command);
-    }
-
     return {
-      workflowResourcePreference,
+      ...(workflowResourcePreference ? { workflowResourcePreference } : {}),
       ...(workflowUserPreference ? { workflowUserPreference } : {}),
       ...(subscriberWorkflowPreference ? { subscriberWorkflowPreference } : {}),
       ...(subscriberGlobalPreference ? { subscriberGlobalPreference } : {}),

libs/application-generic/src/usecases/get-subscriber-global-preference/get-subscriber-global-preference.usecase.ts

@@ -13,7 +13,7 @@ import { ApiException } from '../../utils/exceptions';
 import { GetPreferences } from '../get-preferences';
 import { GetSubscriberPreference } from '../get-subscriber-preference/get-subscriber-preference.usecase';
 import { filteredPreference } from '../get-subscriber-template-preference/get-subscriber-template-preference.usecase';
-import { InstrumentUsecase } from '../../instrumentation';
+import { Instrument, InstrumentUsecase } from '../../instrumentation';
 
 @Injectable()
 export class GetSubscriberGlobalPreference {
@@ -54,6 +54,7 @@ export class GetSubscriberGlobalPreference {
     };
   }
 
+  @Instrument()
   private async getSubscriberGlobalPreference(
     command: GetSubscriberGlobalPreferenceCommand,
     subscriberId: string,
@@ -95,6 +96,7 @@ export class GetSubscriberGlobalPreference {
     };
   }
 
+  @Instrument()
   private async getActiveChannels(
     command: GetSubscriberGlobalPreferenceCommand,
   ): Promise<ChannelTypeEnum[]> {

libs/application-generic/src/usecases/get-subscriber-preference/get-subscriber-preference.usecase.ts

@@ -23,6 +23,7 @@ import {
   overridePreferences,
 } from '../get-subscriber-template-preference';
 import { MergePreferencesCommand } from '../merge-preferences/merge-preferences.command';
+import { mapTemplateConfiguration } from '../get-subscriber-template-preference/get-subscriber-template-preference.usecase';
 
 @Injectable()
 export class GetSubscriberPreference {
@@ -183,10 +184,10 @@ export class GetSubscriberPreference {
             enabled: true,
             overrides,
           },
-          template: {
+          template: mapTemplateConfiguration({
             ...workflow,
             critical: merged.preferences.all.readOnly,
-          },
+          }),
           type: PreferencesTypeEnum.SUBSCRIBER_WORKFLOW,
         };
       },

libs/application-generic/src/usecases/get-subscriber-template-preference/get-subscriber-template-preference.usecase.ts

@@ -25,7 +25,7 @@ import { GetSubscriberTemplatePreferenceCommand } from './get-subscriber-templat
 import { ApiException } from '../../utils/exceptions';
 import { buildSubscriberKey, CachedEntity } from '../../services/cache';
 import { GetPreferences } from '../get-preferences';
-import { InstrumentUsecase } from '../../instrumentation';
+import { Instrument, InstrumentUsecase } from '../../instrumentation';
 
 const PRIORITY_ORDER = [
   PreferenceOverrideSourceEnum.TEMPLATE,
@@ -89,6 +89,7 @@ export class GetSubscriberTemplatePreference {
     };
   }
 
+  @Instrument()
   private async getSubscriberWorkflowPreference(
     command: GetSubscriberTemplatePreferenceCommand,
     subscriberId: string,
@@ -148,6 +149,7 @@ export class GetSubscriberTemplatePreference {
     };
   }
 
+  @Instrument()
   private async getWorkflowOverride(
     command: GetSubscriberTemplatePreferenceCommand,
   ) {
@@ -172,6 +174,7 @@ export class GetSubscriberTemplatePreference {
     });
   }
 
+  @Instrument()
   private async getChannels(
     command: GetSubscriberTemplatePreferenceCommand,
   ): Promise<IPreferenceChannels> {
@@ -196,6 +199,7 @@ export class GetSubscriberTemplatePreference {
     return initialChannels;
   }
 
+  @Instrument()
   private async queryActiveChannels(
     command: GetSubscriberTemplatePreferenceCommand,
   ): Promise<ChannelTypeEnum[]> {
@@ -354,7 +358,7 @@ export const filteredPreference = (
     {},
   );
 
-function mapTemplateConfiguration(
+export function mapTemplateConfiguration(
   template: NotificationTemplateEntity,
 ): ITemplateConfiguration {
   return {

libs/application-generic/src/usecases/merge-preferences/merge-preferences.command.ts

@@ -2,7 +2,7 @@ import { BaseCommand } from '../../commands';
 import { PreferenceSet } from '../get-preferences/get-preferences.usecase';
 
 export class MergePreferencesCommand extends BaseCommand {
-  workflowResourcePreference: PreferenceSet['workflowResourcePreference'];
+  workflowResourcePreference?: PreferenceSet['workflowResourcePreference'];
   workflowUserPreference?: PreferenceSet['workflowUserPreference'];
   subscriberGlobalPreference?: PreferenceSet['subscriberGlobalPreference'];
   subscriberWorkflowPreference?: PreferenceSet['subscriberWorkflowPreference'];

libs/application-generic/src/usecases/merge-preferences/merge-preferences.spec.ts

@@ -46,6 +46,12 @@ const testCases: TestCase[] = [
     expectedType: PreferencesTypeEnum.WORKFLOW_RESOURCE,
     readOnly: false,
   },
+  {
+    comment: 'Subscriber global only',
+    types: [PreferencesTypeEnum.SUBSCRIBER_GLOBAL],
+    expectedType: PreferencesTypeEnum.SUBSCRIBER_GLOBAL,
+    readOnly: false,
+  },
   {
     comment: 'Subscriber workflow overrides workflow resource',
     types: [

libs/application-generic/src/usecases/merge-preferences/merge-preferences.usecase.ts

@@ -1,17 +1,9 @@
-import { PreferencesTypeEnum, WorkflowPreferences } from '@novu/shared';
+import { PreferencesTypeEnum } from '@novu/shared';
 import { PreferencesEntity } from '@novu/dal';
 import { deepMerge } from '../../utils';
 import { GetPreferencesResponseDto } from '../get-preferences';
 import { MergePreferencesCommand } from './merge-preferences.command';
-
-/**
- * Recursively make all properties of type `T` required.
- */
-type DeepRequired<T> = T extends object
-  ? {
-      [P in keyof T]-?: DeepRequired<T[P]>;
-    }
-  : T;
+import { DeepRequired } from '../../http/utils.types';
 
 /**
  * Merge preferences for a subscriber.