Skip to content

Commit

Permalink
feat: allow store variants under step template
Browse files Browse the repository at this point in the history
  • Loading branch information
@djabarovgeorge
djabarovgeorge committed Sep 14, 2023
1 parent c1f0ee4 commit 6028806
Show file tree
Hide file tree
Showing 10 changed files with 261 additions and 84 deletions.
2 changes: 1 addition & 1 deletion apps/api/src/app/shared/dtos/message-template.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,5 @@ export class MessageTemplate {
};

@IsOptional()
_creatorId: string;
_creatorId?: string;
}
12 changes: 11 additions & 1 deletion apps/api/src/app/shared/dtos/notification-step.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import {
MonthlyTypeEnum,
OrdinalEnum,
OrdinalValueEnum,
StepVariantDto,
} from '@novu/shared';
import { IsBoolean, ValidateNested } from 'class-validator';

Expand Down Expand Up @@ -104,7 +105,7 @@ class DelayScheduledMetadata implements IDelayScheduledMetadata {
}

@ApiExtraModels(DigestRegularMetadata, DigestTimedMetadata, DelayRegularMetadata, DelayScheduledMetadata)
export class NotificationStep {
export class NotificationStepVariant implements StepVariantDto {
@ApiPropertyOptional()
_id?: string;

Expand Down Expand Up @@ -156,3 +157,12 @@ export class NotificationStep {
url: string;
};
}

@ApiExtraModels(DigestRegularMetadata, DigestTimedMetadata, DelayRegularMetadata, DelayScheduledMetadata)
export class NotificationStep extends NotificationStepVariant {
@ApiPropertyOptional({
type: NotificationStepVariant,
})
@ValidateNested()
variants?: NotificationStepVariant[];
}
83 changes: 59 additions & 24 deletions apps/api/src/app/workflows/e2e/create-notification-templates.e2e.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ describe('Create Workflow - /workflows (POST)', async () => {
it('should create email template', async function () {
const defaultMessageIsActive = true;

const testTemplate: Partial<CreateWorkflowRequestDto> = {
const templateRequestPayload: Partial<CreateWorkflowRequestDto> = {
name: 'test email template',
description: 'This is a test description',
tags: ['test-tag'],
Expand Down Expand Up @@ -91,36 +91,57 @@ describe('Create Workflow - /workflows (POST)', async () => {
],
},
],
variants: [
{
template: {
name: 'Better Message Template',
subject: 'Better subject',
preheader: 'Better pre header',
content: [{ type: EmailBlockTypeEnum.TEXT, content: 'This is a sample of Better text block' }],
type: StepTypeEnum.EMAIL,
},
active: defaultMessageIsActive,
},
],
},
],
};

const { body } = await session.testAgent.post(`/v1/workflows`).send(testTemplate);
const { body } = await session.testAgent.post(`/v1/workflows`).send(templateRequestPayload);

expect(body.data).to.be.ok;
const template: INotificationTemplate = body.data;
const templateRequestResult: INotificationTemplate = body.data;

expect(template._notificationGroupId).to.equal(testTemplate.notificationGroupId);
const message = template.steps[0];
const filters = message?.filters ? message?.filters[0] : null;
expect(templateRequestResult._notificationGroupId).to.equal(templateRequestPayload.notificationGroupId);
const message = templateRequestResult.steps[0];

const messageTest = testTemplate?.steps ? testTemplate?.steps[0] : null;
const filtersTest = messageTest?.filters ? messageTest.filters[0] : null;
const messageRequest = templateRequestPayload?.steps ? templateRequestPayload?.steps[0] : null;
const filtersTest = messageRequest?.filters ? messageRequest.filters[0] : null;

const children: IFieldFilterPart = filtersTest?.children[0] as IFieldFilterPart;

expect(message?.template?.name).to.equal(`${messageTest?.template?.name}`);
expect(message?.template?.name).to.equal(`${messageRequest?.template?.name}`);
expect(message?.template?.active).to.equal(defaultMessageIsActive);
expect(message?.template?.subject).to.equal(`${messageTest?.template?.subject}`);
expect(message?.template?.preheader).to.equal(`${messageTest?.template?.preheader}`);
expect(message?.template?.subject).to.equal(`${messageRequest?.template?.subject}`);
expect(message?.template?.preheader).to.equal(`${messageRequest?.template?.preheader}`);

const filters = message?.filters ? message?.filters[0] : null;
expect(filters?.type).to.equal(filtersTest?.type);
expect(filters?.children.length).to.equal(filtersTest?.children?.length);

expect(children.value).to.equal(children.value);
expect(children.operator).to.equal(children.operator);
expect(template.tags[0]).to.equal('test-tag');
expect(templateRequestResult.tags[0]).to.equal('test-tag');

const variantRequest = messageRequest?.variants ? messageRequest?.variants[0] : null;
const variantResult = templateRequestResult.steps[0]?.variants ? templateRequestResult.steps[0]?.variants[0] : null;
expect(variantResult?.template?.name).to.equal(variantRequest?.template?.name);
expect(variantResult?.template?.active).to.equal(variantRequest?.active);
expect(variantResult?.template?.subject).to.equal(variantRequest?.template?.subject);
expect(variantResult?.template?.preheader).to.equal(variantRequest?.template?.preheader);

if (Array.isArray(message?.template?.content) && Array.isArray(messageTest?.template?.content)) {
expect(message?.template?.content[0].type).to.equal(messageTest?.template?.content[0].type);
if (Array.isArray(message?.template?.content) && Array.isArray(messageRequest?.template?.content)) {
expect(message?.template?.content[0].type).to.equal(messageRequest?.template?.content[0].type);
} else {
throw new Error('content must be an array');
}
Expand All @@ -131,7 +152,10 @@ describe('Create Workflow - /workflows (POST)', async () => {
});
await session.testAgent.post(`/v1/changes/${change?._id}/apply`);

change = await changeRepository.findOne({ _environmentId: session.environment._id, _entityId: template._id });
change = await changeRepository.findOne({
_environmentId: session.environment._id,
_entityId: templateRequestResult._id,
});
await session.testAgent.post(`/v1/changes/${change?._id}/apply`);

const prodEnv = await getProductionEnvironment();
Expand All @@ -140,17 +164,17 @@ describe('Create Workflow - /workflows (POST)', async () => {

const prodVersionNotification = await notificationTemplateRepository.findOne({
_environmentId: prodEnv._id,
_parentId: template._id,
_parentId: templateRequestResult._id,
});

expect(prodVersionNotification?.tags[0]).to.equal(template.tags[0]);
expect(prodVersionNotification?.steps.length).to.equal(template.steps.length);
expect(prodVersionNotification?.triggers[0].type).to.equal(template.triggers[0].type);
expect(prodVersionNotification?.triggers[0].identifier).to.equal(template.triggers[0].identifier);
expect(prodVersionNotification?.active).to.equal(template.active);
expect(prodVersionNotification?.draft).to.equal(template.draft);
expect(prodVersionNotification?.name).to.equal(template.name);
expect(prodVersionNotification?.description).to.equal(template.description);
expect(prodVersionNotification?.tags[0]).to.equal(templateRequestResult.tags[0]);
expect(prodVersionNotification?.steps.length).to.equal(templateRequestResult.steps.length);
expect(prodVersionNotification?.triggers[0].type).to.equal(templateRequestResult.triggers[0].type);
expect(prodVersionNotification?.triggers[0].identifier).to.equal(templateRequestResult.triggers[0].identifier);
expect(prodVersionNotification?.active).to.equal(templateRequestResult.active);
expect(prodVersionNotification?.draft).to.equal(templateRequestResult.draft);
expect(prodVersionNotification?.name).to.equal(templateRequestResult.name);
expect(prodVersionNotification?.description).to.equal(templateRequestResult.description);

const prodVersionMessage = await messageTemplateRepository.findOne({
_environmentId: prodEnv._id,
Expand All @@ -162,6 +186,17 @@ describe('Create Workflow - /workflows (POST)', async () => {
expect(message?.template?.type).to.equal(prodVersionMessage?.type);
expect(message?.template?.content).to.deep.equal(prodVersionMessage?.content);
expect(message?.template?.active).to.equal(prodVersionMessage?.active);

const prodVersionVariant = await messageTemplateRepository.findOne({
_environmentId: prodEnv._id,
_parentId: variantResult._templateId,
});

expect(variantResult?.template?.name).to.equal(prodVersionVariant?.name);
expect(variantResult?.template?.subject).to.equal(prodVersionVariant?.subject);
expect(variantResult?.template?.type).to.equal(prodVersionVariant?.type);
expect(variantResult?.template?.content).to.deep.equal(prodVersionVariant?.content);
expect(variantResult?.template?.active).to.equal(prodVersionVariant?.active);
});

it('should create a valid notification', async () => {
Expand Down
9 changes: 8 additions & 1 deletion ...p/workflows/usecases/create-notification-template/create-notification-template.command.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ export class ChannelCTACommand {
action?: IMessageAction[];
}

export class NotificationStep {
export class NotificationStepVariant {
@IsString()
@IsOptional()
_templateId?: string;
Expand Down Expand Up @@ -128,6 +128,13 @@ export class NotificationStep {
metadata?: IWorkflowStepMetadata;
}

export class NotificationStep extends NotificationStepVariant {
@IsOptional()
@IsArray()
@ValidateNested()
variants?: NotificationStepVariant[];
}

export class MessageFilter {
isNegated: boolean;

Expand Down
Loading

0 comments on commit 6028806

Please sign in to comment.