Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ FROM node:24 AS builder

WORKDIR /app
COPY package.json .
RUN yarn install
RUN yarn config set registry https://registry.npmjs.org/ \
&& yarn install

COPY /. .
RUN yarn build-ts
Expand Down
625 changes: 291 additions & 334 deletions package-lock.json

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@
"moment-timezone": "^0.5.31",
"mustache": "^3.0.1",
"nats": "2.10.0",
"notifme-sdk": "^1.16.13",
"notifme-sdk": "^1.16.25",
"pg": "^8.2.1",
"prom-client": "^15.1.3",
"reflect-metadata": "^0.1.13",
"typeorm": "0.3.17",
"typeorm": "^0.3.28",
"winston": "^3.2.1"
},
"overrides": {
Expand Down
96 changes: 91 additions & 5 deletions src/common/mustacheHelper.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { Event } from '../notification/service/notificationService';
import moment from 'moment-timezone';
import e, { json } from 'express';
import {EVENT_TYPE, ParsedScoopNotification} from "./types";
import { ciMaterials ,ParsedCIEvent,vulnerability,severityCount,WebhookParsedEvent,ParseApprovalEvent,ParseConfigApprovalEvent,ParsedCDEvent} from './types';
import { ciMaterials ,ParsedCIEvent,vulnerability,severityCount,WebhookParsedEvent,ParseApprovalEvent,ParseConfigApprovalEvent,ParsedCDEvent,ParseDeploymentApprovedEvent,ParseConfigApprovedEvent,ParsePromotionApprovedEvent} from './types';
import Mustache from "mustache";
import {getCommitsFromGitTriggers} from "./getCommitsFromGitTriggers";
export class MustacheHelper {
Expand Down Expand Up @@ -73,7 +73,7 @@ export class MustacheHelper {
return parsedScoopNotification
}

parseEvent(event: Event, isSlackNotification?: boolean): ParsedCIEvent | ParsedCDEvent | ParseApprovalEvent | ParseConfigApprovalEvent | ParseArtifactPromotionEvent | ParsedScoopNotification{
parseEvent(event: Event, isSlackNotification?: boolean): ParsedCIEvent | ParsedCDEvent | ParseApprovalEvent | ParseConfigApprovalEvent | ParseArtifactPromotionEvent | ParsedScoopNotification | ParseDeploymentApprovedEvent | ParseConfigApprovedEvent | ParsePromotionApprovedEvent{
if(event.eventTypeId===EVENT_TYPE.ScoopNotification){
return this.parseScoopNotification(event)
}
Expand All @@ -93,13 +93,14 @@ export class MustacheHelper {

// Handle approval events FIRST (before checking pipelineType)
if (event.eventTypeId===EVENT_TYPE.Approval){
let imageTagNames,imageComment,imageLink,approvalLink;
let imageTagNames,imageComment,imageLink,approvalLink,approvalAction;
let index = -1;
if (event.payload.dockerImageUrl) index = event.payload.dockerImageUrl.lastIndexOf(":");
if (event.payload.imageTagNames) imageTagNames = event.payload.imageTagNames;
if (event.payload.imageComment) imageComment = event.payload.imageComment;
if (baseURL && event.payload.imageApprovalLink) imageLink =`${baseURL}${event.payload.imageApprovalLink}`;
if (baseURL && event.payload.approvalLink) approvalLink = `${baseURL}${event.payload.approvalLink}`;
if (event.payload.approvalAction) approvalAction = event.payload.approvalAction;

return {
eventTime: timestamp,
Expand All @@ -113,16 +114,21 @@ export class MustacheHelper {
tags:imageTagNames,
imageApprovalLink:imageLink,
approvalLink:approvalLink,
approvalAction:approvalAction,
isApprovalRequested: approvalAction === 'requested',
isApprovalApproved: approvalAction === 'approved',
isApprovalCancelled: approvalAction === 'cancelled',
}
}

if (event.eventTypeId===EVENT_TYPE.ConfigApproval){
let protectConfigFileType,protectConfigFileName,protectConfigComment,protectConfigLink,envName,approvalLink;
let protectConfigFileType,protectConfigFileName,protectConfigComment,protectConfigLink,envName,approvalLink,approvalAction;
if (event.payload.protectConfigFileType) protectConfigFileType = event.payload.protectConfigFileType;
if (event.payload.protectConfigFileName) protectConfigFileName = event.payload.protectConfigFileName;
if (event.payload.protectConfigComment) protectConfigComment = event.payload.protectConfigComment.split("\n");
if (baseURL && event.payload.protectConfigLink) protectConfigLink =`${baseURL}${event.payload.protectConfigLink}`;
if (baseURL && event.payload.approvalLink) approvalLink = `${baseURL}${event.payload.approvalLink}`;
if (event.payload.approvalAction) approvalAction = event.payload.approvalAction;
if (!event.payload.envName){
envName="Base configuration"
}
Expand All @@ -140,13 +146,93 @@ export class MustacheHelper {
protectConfigComment:protectConfigComment,
protectConfigLink:protectConfigLink,
approvalLink:approvalLink,
approvalAction:approvalAction,
isApprovalRequested: approvalAction === 'requested',
isApprovalApproved: approvalAction === 'approved',
isApprovalCancelled: approvalAction === 'cancelled',
}
}

// Handle DeploymentApproved event
if (event.eventTypeId===EVENT_TYPE.DeploymentApproved){
let imageTagNames, imageComment, imageLink;
let index = -1;
if (event.payload.dockerImageUrl) index = event.payload.dockerImageUrl.lastIndexOf(":");
if (event.payload.imageTagNames) imageTagNames = event.payload.imageTagNames;
if (event.payload.imageComment) imageComment = event.payload.imageComment;
if (baseURL && event.payload.imageApprovalLink) imageLink = `${baseURL}${event.payload.imageApprovalLink}`;

return {
eventTime: timestamp,
slackTimestamp: slackTimestamp,
triggeredBy: event.payload.triggeredBy || "NA",
appName: event.payload.appName || "NA",
envName: event.payload.envName || "NA",
pipelineName: event.payload.pipelineName || "NA",
imageTag: index >= 0 ? event.payload.dockerImageUrl.substring(index + 1) : "NA",
comment: imageComment,
tags: imageTagNames,
imageApprovalLink: imageLink,
dockerImageUrl: event.payload.dockerImageUrl,
}
}

// Handle ConfigApproved event
if (event.eventTypeId===EVENT_TYPE.ConfigApproved){
let protectConfigFileType, protectConfigFileName, protectConfigComment, protectConfigLink, envName;
if (event.payload.protectConfigFileType) protectConfigFileType = event.payload.protectConfigFileType;
if (event.payload.protectConfigFileName) protectConfigFileName = event.payload.protectConfigFileName;
if (event.payload.protectConfigComment) protectConfigComment = event.payload.protectConfigComment.split("\n");
if (baseURL && event.payload.protectConfigLink) protectConfigLink = `${baseURL}${event.payload.protectConfigLink}`;
if (!event.payload.envName){
envName = "Base configuration"
}
else{
envName = event.payload.envName
}
return {
eventTime: timestamp,
slackTimestamp: slackTimestamp,
triggeredBy: event.payload.triggeredBy || "NA",
appName: event.payload.appName || "NA",
envName: envName,
protectConfigFileType: protectConfigFileType,
protectConfigFileName: protectConfigFileName,
protectConfigComment: protectConfigComment,
protectConfigLink: protectConfigLink,
}
}

// Handle PromotionApproved event
if (event.eventTypeId===EVENT_TYPE.PromotionApproved){
let artifactPromotionRequestViewLink, imageTagNames, imageComment, imagePromotionSource, envName;
let index = -1;
if (event.payload.dockerImageUrl) index = event.payload.dockerImageUrl.lastIndexOf(":");
if (baseURL && event.payload.artifactPromotionRequestViewLink) artifactPromotionRequestViewLink = `${baseURL}${event.payload.artifactPromotionRequestViewLink}`;
if (event.payload.imageTagNames) imageTagNames = event.payload.imageTagNames;
if (event.payload.imageComment) imageComment = event.payload.imageComment;
if (event.payload.promotionArtifactSource) imagePromotionSource = event.payload.promotionArtifactSource;
if (event.payload.envName) envName = event.payload.envName;

return {
eventTime: timestamp,
slackTimestamp: slackTimestamp,
triggeredBy: event.payload.triggeredBy || "NA",
appName: event.payload.appName || "NA",
envName: event.payload.envName || envName,
imageTag: index >= 0 ? event.payload.dockerImageUrl.substring(index + 1) : "NA",
imageTagNames: imageTagNames,
imageComment: imageComment,
promotionArtifactSource: imagePromotionSource,
artifactPromotionRequestViewLink: artifactPromotionRequestViewLink,
dockerImageUrl: event.payload.dockerImageUrl,
}
}

// Now handle CI/CD events (which need material parsing)
let material = event.payload.material;
let ciMaterials;
if (event.eventTypeId!==EVENT_TYPE.Approval && event.eventTypeId!==EVENT_TYPE.ConfigApproval && event.eventTypeId!=EVENT_TYPE.ImagePromotion){
if (event.eventTypeId!==EVENT_TYPE.Approval && event.eventTypeId!==EVENT_TYPE.ConfigApproval && event.eventTypeId!=EVENT_TYPE.ImagePromotion && event.eventTypeId!==EVENT_TYPE.DeploymentApproved && event.eventTypeId!==EVENT_TYPE.ConfigApproved && event.eventTypeId!==EVENT_TYPE.PromotionApproved){
ciMaterials = material.ciMaterials ? material.ciMaterials.map((ci) => {
if (material && material.gitTriggers && material.gitTriggers[ci.id]) {
let trigger = material.gitTriggers[ci.id];
Expand Down
52 changes: 51 additions & 1 deletion src/common/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,10 @@ export interface ParseApprovalEvent {
imageLink?: string;
imageTag: string;
approvalLink?: string;

approvalAction?: string; // "requested", "approved", or "cancelled"
isApprovalRequested?: boolean;
isApprovalApproved?: boolean;
isApprovalCancelled?: boolean;
}
export interface ParseConfigApprovalEvent {
eventTime: number | string;
Expand All @@ -101,6 +104,50 @@ export interface ParseConfigApprovalEvent {
protectConfigFileName: string;
protectConfigLink?: string;
approvalLink?: string;
approvalAction?: string; // "requested", "approved", or "cancelled"
isApprovalRequested?: boolean;
isApprovalApproved?: boolean;
isApprovalCancelled?: boolean;
}

export interface ParseDeploymentApprovedEvent {
eventTime: number | string;
slackTimestamp?: string;
triggeredBy: string;
appName: string;
pipelineName: string;
envName: string;
tags?: string[];
comment?: string;
imageApprovalLink?: string;
imageTag: string;
dockerImageUrl?: string;
}

export interface ParseConfigApprovedEvent {
eventTime: number | string;
slackTimestamp?: string;
triggeredBy: string;
appName: string;
envName: string;
protectConfigComment?: string[];
protectConfigFileType: string;
protectConfigFileName: string;
protectConfigLink?: string;
}

export interface ParsePromotionApprovedEvent {
eventTime: number | string;
slackTimestamp?: string;
triggeredBy: string;
appName: string;
envName: string;
imageTagNames?: string[];
imageComment?: string;
artifactPromotionRequestViewLink?: string;
promotionArtifactSource?: string;
imageTag: string;
dockerImageUrl?: string;
}

export interface ParsedScoopNotification {
Expand Down Expand Up @@ -153,6 +200,9 @@ export enum EVENT_TYPE {
ImagePromotion = 7,
ImageScan = 8,
ScoopNotification = 9,
DeploymentApproved = 10,
ConfigApproved = 11,
PromotionApproved = 12,
}

export enum ENV_TYPE_INT{
Expand Down
8 changes: 6 additions & 2 deletions src/destination/destinationHandlers/sesHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -217,11 +217,15 @@ export class SESService implements Handler {
parsedEvent['fromEmail'] = event.payload['fromEmail'];
parsedEvent['toEmail'] = event.payload['toEmail'];
let json: string
if(event.eventTypeId===4 || event.eventTypeId === EVENT_TYPE.ImagePromotion){
// Handle Approval, ImagePromotion, DeploymentApproved, and PromotionApproved events
if(event.eventTypeId===4 || event.eventTypeId === EVENT_TYPE.ImagePromotion ||
event.eventTypeId === EVENT_TYPE.DeploymentApproved || event.eventTypeId === EVENT_TYPE.PromotionApproved){
let commentDisplayStyle = (event.payload.imageComment === "") ? 'none' : 'inline';
let tagDisplayStyle = (event.payload.imageTagNames === null) ? 'none' : 'inline';
json = Mustache.render(template, { ...parsedEvent, commentDisplayStyle ,tagDisplayStyle});
}else if(event.eventTypeId===5){
}
// Handle ConfigApproval and ConfigApproved events
else if(event.eventTypeId===5 || event.eventTypeId === EVENT_TYPE.ConfigApproved){
let commentDisplayStyle = (event.payload.protectConfigComment === "") ? 'none' : 'inline';
json = Mustache.render(template, { ...parsedEvent, commentDisplayStyle });
}
Expand Down
49 changes: 47 additions & 2 deletions src/destination/destinationHandlers/slackHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -145,10 +145,12 @@ export class SlackService implements Handler {
if (event.eventTypeId == EVENT_TYPE.ScoopNotification){
const date = moment(event.eventTime);
event.payload.scoopNotificationConfig.data.interceptedAt = date.unix();
jsons = Mustache.render(template, event.payload.scoopNotificationConfig.data);
const safeTemplate = this.preprocessEqualsApproval(template);
jsons = Mustache.render(safeTemplate, event.payload.scoopNotificationConfig.data);
}else{
let parsedEvent = this.mh.parseEvent(event as Event, true);
jsons = Mustache.render(template, parsedEvent);
const safeTemplate = this.preprocessEqualsApproval(template);
jsons = Mustache.render(safeTemplate, parsedEvent);
}
let j = JSON.parse(jsons)
const res = await sdk.send(
Expand All @@ -163,6 +165,49 @@ export class SlackService implements Handler {
}
}

// Preprocess templates that use a non-standard Mustache helper syntax like:
// {{#equals approvalAction "requested"}} ... {{/equals}}
// We translate them into boolean section checks exposed by MustacheHelper:
// {{#isApprovalRequested}} ... {{/isApprovalRequested}}
private preprocessEqualsApproval(template: string): string {
const mappings: Record<string, { open: RegExp; name: string }>[] = [
{ requested: { open: /\{\{#equals\s+approvalAction\s+\"requested\"\}\}/g, name: 'isApprovalRequested' } } as any,
{ approved: { open: /\{\{#equals\s+approvalAction\s+\"approved\"\}\}/g, name: 'isApprovalApproved' } } as any,
{ cancelled: { open: /\{\{#equals\s+approvalAction\s+\"cancelled\"\}\}/g, name: 'isApprovalCancelled' } } as any,
] as unknown as Record<string, { open: RegExp; name: string }>[];

let output = template;
// For each variant, iteratively replace the closest closing tag
const variants: { open: RegExp; name: string }[] = [
{ open: /\{\{#equals\s+approvalAction\s+\"requested\"\}\}/g, name: 'isApprovalRequested' },
{ open: /\{\{#equals\s+approvalAction\s+\"approved\"\}\}/g, name: 'isApprovalApproved' },
{ open: /\{\{#equals\s+approvalAction\s+\"cancelled\"\}\}/g, name: 'isApprovalCancelled' },
];

for (const v of variants) {
// Reset lastIndex just in case
v.open.lastIndex = 0;
let match: RegExpExecArray | null;
while ((match = v.open.exec(output)) !== null) {
const startIdx = match.index;
const before = output.substring(0, startIdx);
const afterOpen = output.substring(startIdx + match[0].length);
const closeIdx = afterOpen.indexOf('{{/equals}}');
if (closeIdx === -1) {
// No close found; leave as is to surface a clear error later
continue;
}
const between = afterOpen.substring(0, closeIdx);
const afterClose = afterOpen.substring(closeIdx + '{{/equals}}'.length);
const replaced = `{{#${v.name}}}` + between + `{{/${v.name}}}`;
output = before + replaced + afterClose;
// Move regex pointer forward to avoid infinite loops
v.open.lastIndex = (before + replaced).length;
}
}
return output;
}

private async saveNotificationEventSuccessLog(result: any, event: Event, p: any, setting: NotificationSettings) {
if (result["status"] == "error") {
await this.saveNotificationEventFailureLog(event, p, setting)
Expand Down
9 changes: 7 additions & 2 deletions src/destination/destinationHandlers/smtpHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import {UsersRepository} from "../../repository/usersRepository";
import { SMTPConfigRepository } from '../../repository/smtpConfigRepository';
import { MustacheHelper } from '../../common/mustacheHelper';
import {CustomError} from "../../entities/events";
import {EVENT_TYPE} from "../../common/types";

//https://github.com/notifme/notifme-sdk/blob/master/src/models/notification-request.js#L132
export class SMTPService implements Handler {
Expand Down Expand Up @@ -217,11 +218,15 @@ export class SMTPService implements Handler {
parsedEvent['fromEmail'] = event.payload['fromEmail'];
parsedEvent['toEmail'] = event.payload['toEmail'];
let json: string
if(event.eventTypeId===4){
// Handle Approval, ImagePromotion, DeploymentApproved, and PromotionApproved events
if(event.eventTypeId===4 || event.eventTypeId === EVENT_TYPE.ImagePromotion ||
event.eventTypeId === EVENT_TYPE.DeploymentApproved || event.eventTypeId === EVENT_TYPE.PromotionApproved){
let commentDisplayStyle = (event.payload.imageComment === "") ? 'none' : 'inline';
let tagDisplayStyle = (event.payload.imageTagNames === null) ? 'none' : 'inline';
json = Mustache.render(template, { ...parsedEvent, commentDisplayStyle ,tagDisplayStyle});
}else if(event.eventTypeId===5){
}
// Handle ConfigApproval and ConfigApproved events
else if(event.eventTypeId===5 || event.eventTypeId === EVENT_TYPE.ConfigApproved){
let commentDisplayStyle = (event.payload.protectConfigComment === "") ? 'none' : 'inline';
json = Mustache.render(template, { ...parsedEvent, commentDisplayStyle });
}else{
Expand Down
Loading