fix(application-generic): Use V2 Preferences critical flag only if …

…it exists (#6563)
novuhq · Sep 24, 2024 · 0eceddc · 0eceddc
1 parent 7225753
commit 0eceddc
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 5 deletions.
diff --git a/apps/api/src/app/step-schemas/e2e/get-default-schema.e2e.ts b/apps/api/src/app/step-schemas/e2e/get-default-schema.e2e.ts
@@ -15,7 +15,7 @@ describe('Get Control Schema - /step-schemas/:stepType (GET)', async () => {
   it('should get control schema for email step', async function () {
     const { body } = await session.testAgent.get(`/v1/step-schemas/${StepTypeEnum.EMAIL}`);
 
-    const schema = body.data.schema;
+    const { schema } = body.data;
 
     expect(schema.type).to.equal('object');
     expect(schema.properties).to.have.property('subject');

diff --git a/apps/api/src/app/step-schemas/step-schemas.controller.ts b/apps/api/src/app/step-schemas/step-schemas.controller.ts
@@ -4,6 +4,7 @@ import { UserSessionData } from '@novu/shared';
 import { ExternalApiAccessible, UserSession } from '@novu/application-generic';
 import { StepType } from '@novu/framework';
 
+import { ApiOperation, ApiParam } from '@nestjs/swagger';
 import { GetStepSchemaCommand } from './usecases/get-step-schema/get-step-schema.command';
 import { UserAuthentication } from '../shared/framework/swagger/api.key.security';
 import { GetStepSchema } from './usecases/get-step-schema/get-step-schema.usecase';
@@ -16,6 +17,15 @@ export class StepSchemasController {
   constructor(private getStepDefaultSchemaUsecase: GetStepSchema) {}
 
   @Get('/:stepType')
+  @ApiOperation({
+    summary: 'Get step schema',
+    description: 'Get the schema for a step type',
+  })
+  @ApiParam({
+    name: 'stepType',
+    type: String,
+    description: 'The type of step to get the schema for.',
+  })
   @ExternalApiAccessible()
   async getStepSchema(
     @UserSession() user: UserSessionData,

diff --git a/...usecases/get-subscriber-template-preference/get-subscriber-template-preference.usecase.ts b/...usecases/get-subscriber-template-preference/get-subscriber-template-preference.usecase.ts
@@ -105,10 +105,12 @@ export class GetSubscriberTemplatePreference {
 
     const template = mapTemplateConfiguration({
       ...command.template,
-      // determine if any readOnly constraints have been set by the Workflow owner
-      critical: GetPreferences.checkIfWorkflowPreferencesIsReadOnly(
-        subscriberWorkflowPreferences,
-      ),
+      // Use the critical flag from the V2 Preference object if it exists
+      ...(subscriberWorkflowPreferences && {
+        critical: GetPreferences.checkIfWorkflowPreferencesIsReadOnly(
+          subscriberWorkflowPreferences,
+        ),
+      }),
     });
 
     return {