feat(cdevents-notification): CDEvents notification to produce CDEvents (

#9997) * feat(cdevents-notification): CDEvents notification to produce CDEvents * fix: linter issue Sort the import statements * fix: cdevents files formatting * adding validations for URL and cdevents type * fix prettier formatting issue * update regex for URL validation * review comments on placeholder/regex configurable * lint issue with order import * lint issue Prettier
spinnaker · Dec 22, 2023 · fc96adb · fc96adb
1 parent 20d6ca8
commit fc96adb
Show file tree

Hide file tree

Showing 9 changed files with 86 additions and 2 deletions.
diff --git a/halconfig/settings.js b/halconfig/settings.js
@@ -142,6 +142,9 @@ window.spinnakerSettings = {
     pubsub: {
       enabled: true,
     },
+    cdevents: {
+      enabled: true,
+    },
     slack: slack,
     sms: sms,
   },

diff --git a/packages/app/src/settings.js b/packages/app/src/settings.js
@@ -178,6 +178,9 @@ window.spinnakerSettings = {
     sms: {
       enabled: true,
     },
+    cdevents: {
+      enabled: true,
+    },
   },
   onDemandClusterThreshold: Number(onDemandClusterThreshold),
   pollSchedule: 30000,

diff --git a/packages/core/src/config/settings.ts b/packages/core/src/config/settings.ts
@@ -21,6 +21,7 @@ export interface INotificationSettings {
   pubsub: { enabled: boolean };
   slack: { botName: string; enabled: boolean };
   sms: { enabled: boolean };
+  cdevents: { enabled: boolean };
 }
 
 export interface IFeatures {
@@ -152,6 +153,10 @@ export interface ISpinnakerSettings {
   useClassicFirewallLabels: boolean;
   kubernetesAdHocInfraWritesEnabled: boolean;
   changelogUrl: string;
+  cdevents?: {
+    validUrlPattern: string;
+    validCDEvent: string;
+  };
 }
 
 export const SETTINGS: ISpinnakerSettings = (window as any).spinnakerSettings || {};

diff --git a/packages/core/src/notification/modal/NotificationDetails.tsx b/packages/core/src/notification/modal/NotificationDetails.tsx
@@ -54,7 +54,10 @@ export class NotificationDetails extends React.Component<INotificationDetailsPro
   }
 
   private renderCustomMessage = (type: string, whenOption: string): React.ReactNode => {
-    if (whenOption !== 'manualJudgment' && ['email', 'slack', 'googlechat', 'microsoftteams'].includes(type)) {
+    if (
+      whenOption !== 'manualJudgment' &&
+      ['email', 'slack', 'googlechat', 'microsoftteams', 'cdevents'].includes(type)
+    ) {
       return (
         <FormikFormField
           name={`message["${whenOption}"].text`}

diff --git a/packages/core/src/notification/notification.types.ts b/packages/core/src/notification/notification.types.ts
@@ -6,6 +6,7 @@ import type { INotificationTypeConfig } from '../domain';
 import { Registry } from '../registry';
 
 import { bearyChatNotification } from './selector/types/bearychat/beary.notification';
+import { cdEventsNotification } from './selector/types/cdevents/cdevents.notification';
 import { emailNotification } from './selector/types/email/email.notification';
 import { githubstatusNotification } from './selector/types/githubstatus/githubstatus.notification';
 import { googlechatNotification } from './selector/types/googlechat/googlechat.notification';
@@ -23,6 +24,7 @@ import { smsNotification } from './selector/types/sms/sms.notification';
   pubsubNotification,
   slackNotification,
   smsNotification,
+  cdEventsNotification,
 ].forEach((config: INotificationTypeConfig) => {
   if (SETTINGS.notifications) {
     const notificationSetting: { enabled: boolean; botName?: string } =

diff --git a/packages/core/src/notification/selector/types/cdevents/CDEventsNotificationType.tsx b/packages/core/src/notification/selector/types/cdevents/CDEventsNotificationType.tsx
@@ -0,0 +1,36 @@
+import React from 'react';
+
+import type { INotificationTypeCustomConfig } from '../../../../domain';
+import { FormikFormField, TextInput, Validators } from '../../../../presentation';
+
+export class CDEventsNotificationType extends React.Component<INotificationTypeCustomConfig> {
+  public render() {
+    const { fieldName } = this.props;
+    return (
+      <>
+        <FormikFormField
+          label="Events Broker URL"
+          name={fieldName ? `${fieldName}.address` : 'address'}
+          validate={Validators.skipIfSpel(Validators.urlValue('Please enter a valid URL'))}
+          input={(props) => (
+            <TextInput
+              inputClassName={'form-control input-sm'}
+              {...props}
+              placeholder="Enter an events message broker URL"
+            />
+          )}
+          required={true}
+        />
+        <FormikFormField
+          label="CDEvents Type"
+          name={fieldName ? `${fieldName}.cdEventsType` : 'cdEventsType'}
+          validate={Validators.skipIfSpel(Validators.cdeventsTypeValue('Please enter a valid CDEvents Type'))}
+          input={(props) => (
+            <TextInput inputClassName={'form-control input-sm'} {...props} placeholder="Enter a CDEvents type" />
+          )}
+          required={true}
+        />
+      </>
+    );
+  }
+}
diff --git a/packages/core/src/notification/selector/types/cdevents/cdevents.notification.ts b/packages/core/src/notification/selector/types/cdevents/cdevents.notification.ts
@@ -0,0 +1,8 @@
+import { CDEventsNotificationType } from './CDEventsNotificationType';
+import type { INotificationTypeConfig } from '../../../../domain';
+
+export const cdEventsNotification: INotificationTypeConfig = {
+  component: CDEventsNotificationType,
+  key: 'cdevents',
+  label: 'CDEvents',
+};
diff --git a/packages/core/src/notification/selector/types/index.ts b/packages/core/src/notification/selector/types/index.ts
@@ -5,3 +5,4 @@ export * from './microsoftteams/MicrosoftTeamsNotificationType';
 export * from './pubsub/PubsubNotificationType';
 export * from './slack/SlackNotificationType';
 export * from './sms/SmsNotificationType';
+export * from './cdevents/CDEventsNotificationType';
diff --git a/packages/core/src/presentation/forms/validation/validators.ts b/packages/core/src/presentation/forms/validation/validators.ts
@@ -1,6 +1,7 @@
 import { isNumber } from 'lodash';
-import { robotToHuman } from '../../robotToHumanFilter/robotToHuman.filter';
 
+import { SETTINGS } from '../../../config/settings';
+import { robotToHuman } from '../../robotToHumanFilter/robotToHuman.filter';
 import type { IValidator } from './validation';
 
 const THIS_FIELD = 'This field';
@@ -9,13 +10,33 @@ const VALID_EMAIL_REGEX = new RegExp(
   '^(([^<>()\\[\\]\\\\.,;:\\s@"]+(\\.[^<>()\\[\\]\\\\.,;:\\s@"]+)*)|(".+"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$',
 );
 
+const urlPattern = SETTINGS.cdevents?.validUrlPattern ?? '^https?://.+$';
+const VALID_URL = new RegExp(urlPattern);
+
+const cdeventPattern = SETTINGS.cdevents?.validCDEvent ?? '^dev\\.cdevents\\.[^.]+\\.[^.]+$';
+const VALID_CDEVENT_REGEX = new RegExp(cdeventPattern);
+
 const emailValue = (message?: string): IValidator => {
   return function emailValue(val: string, label = THIS_FIELD) {
     message = message || `${label} is not a valid email address.`;
     return val && !VALID_EMAIL_REGEX.test(val) && message;
   };
 };
 
+const urlValue = (message?: string): IValidator => {
+  return function urlValue(val: string, label = THIS_FIELD) {
+    message = message || `${label} is not a valid URL.`;
+    return val && !VALID_URL.test(val) && message;
+  };
+};
+
+const cdeventsTypeValue = (message?: string): IValidator => {
+  return function cdeventsTypeValue(val: string, label = THIS_FIELD) {
+    message = message || `${label} is not a valid CDEvents Type.`;
+    return val && !VALID_CDEVENT_REGEX.test(val) && message;
+  };
+};
+
 const isRequired = (message?: string): IValidator => {
   return function isRequired(val: any, label = THIS_FIELD) {
     message = message || `${label} is required.`;
@@ -138,6 +159,8 @@ export const Validators = {
   arrayNotEmpty,
   checkBetween,
   emailValue,
+  cdeventsTypeValue,
+  urlValue,
   isNum,
   isRequired,
   isValidJson,