@oneuptime/common 9.3.16 → 9.3.18

package/Server/Utils/Monitor/Criteria/IncomingEmailCriteria.ts

@@ -0,0 +1,248 @@
+import logger from "../../../Utils/Logger";
+import DataToProcess from "../DataToProcess";
+import OneUptimeDate from "../../../../Types/Date";
+import {
+  CheckOn,
+  CriteriaFilter,
+  FilterType,
+} from "../../../../Types/Monitor/CriteriaFilter";
+import IncomingEmailMonitorRequest from "../../../../Types/Monitor/IncomingEmailMonitor/IncomingEmailMonitorRequest";
+import Typeof from "../../../../Types/Typeof";
+import CaptureSpan from "../../Telemetry/CaptureSpan";
+
+export default class IncomingEmailCriteria {
+  @CaptureSpan()
+  public static async isMonitorInstanceCriteriaFilterMet(input: {
+    dataToProcess: DataToProcess;
+    criteriaFilter: CriteriaFilter;
+  }): Promise<string | null> {
+    // Incoming Email Monitoring Checks
+
+    logger.debug(
+      "Checking IncomingEmailCriteria for Monitor: " +
+        input.dataToProcess.monitorId.toString(),
+    );
+
+    logger.debug(
+      "Data to process: " + JSON.stringify(input.dataToProcess, null, 2),
+    );
+
+    logger.debug(
+      "Criteria Filter: " + JSON.stringify(input.criteriaFilter, null, 2),
+    );
+
+    let value: number | string | undefined = input.criteriaFilter.value;
+
+    const emailData: IncomingEmailMonitorRequest =
+      input.dataToProcess as IncomingEmailMonitorRequest;
+
+    // Check on Email Received time
+    if (input.criteriaFilter.checkOn === CheckOn.EmailReceivedAt) {
+      logger.debug(
+        "Checking EmailReceivedAt for Monitor: " +
+          input.dataToProcess.monitorId.toString(),
+      );
+
+      const lastEmailTime: Date = emailData.emailReceivedAt;
+
+      logger.debug("Last Email Time: " + lastEmailTime);
+
+      const differenceInMinutes: number = OneUptimeDate.getDifferenceInMinutes(
+        lastEmailTime,
+        emailData.checkedAt || OneUptimeDate.getCurrentDate(),
+      );
+
+      logger.debug("Difference in minutes: " + differenceInMinutes);
+
+      if (!value) {
+        return null;
+      }
+
+      if (typeof value === Typeof.String) {
+        try {
+          value = parseInt(value as string);
+        } catch (err) {
+          logger.error(err);
+          return null;
+        }
+      }
+
+      if (typeof value !== Typeof.Number) {
+        return null;
+      }
+
+      if (input.criteriaFilter.filterType === FilterType.RecievedInMinutes) {
+        logger.debug(
+          "Checking RecievedInMinutes for Monitor: " +
+            input.dataToProcess.monitorId.toString(),
+        );
+        if (value && differenceInMinutes <= (value as number)) {
+          logger.debug(
+            "RecievedInMinutes for Monitor: " +
+              input.dataToProcess.monitorId.toString() +
+              " is true",
+          );
+          return `Email received in ${value} minutes. It was received ${differenceInMinutes} minutes ago.`;
+        }
+        return null;
+      }
+
+      if (input.criteriaFilter.filterType === FilterType.NotRecievedInMinutes) {
+        logger.debug(
+          "Checking NotRecievedInMinutes for Monitor: " +
+            input.dataToProcess.monitorId.toString(),
+        );
+        if (value && differenceInMinutes > (value as number)) {
+          logger.debug(
+            "NotRecievedInMinutes for Monitor: " +
+              input.dataToProcess.monitorId.toString() +
+              " is true",
+          );
+          return `Email not received in ${value} minutes. It was received ${differenceInMinutes} minutes ago.`;
+        }
+        return null;
+      }
+    }
+
+    // Check on Email Subject
+    if (
+      input.criteriaFilter.checkOn === CheckOn.EmailSubject &&
+      !emailData.onlyCheckForIncomingEmailReceivedAt
+    ) {
+      const subject: string = emailData.emailSubject || "";
+
+      return this.evaluateStringCriteria(
+        subject,
+        input.criteriaFilter,
+        "Email subject",
+      );
+    }
+
+    // Check on Email From
+    if (
+      input.criteriaFilter.checkOn === CheckOn.EmailFrom &&
+      !emailData.onlyCheckForIncomingEmailReceivedAt
+    ) {
+      const from: string = emailData.emailFrom || "";
+
+      return this.evaluateStringCriteria(
+        from,
+        input.criteriaFilter,
+        "Email from",
+      );
+    }
+
+    // Check on Email Body
+    if (
+      input.criteriaFilter.checkOn === CheckOn.EmailBody &&
+      !emailData.onlyCheckForIncomingEmailReceivedAt
+    ) {
+      const body: string = emailData.emailBody || "";
+
+      return this.evaluateStringCriteria(
+        body,
+        input.criteriaFilter,
+        "Email body",
+      );
+    }
+
+    // Check on Email To
+    if (
+      input.criteriaFilter.checkOn === CheckOn.EmailTo &&
+      !emailData.onlyCheckForIncomingEmailReceivedAt
+    ) {
+      const to: string = emailData.emailTo || "";
+
+      return this.evaluateStringCriteria(to, input.criteriaFilter, "Email to");
+    }
+
+    return null;
+  }
+
+  /**
+   * Evaluate string criteria filters
+   */
+  private static evaluateStringCriteria(
+    fieldValue: string,
+    criteriaFilter: CriteriaFilter,
+    fieldName: string,
+  ): string | null {
+    const value: string | number | undefined = criteriaFilter.value;
+
+    if (criteriaFilter.filterType === FilterType.Contains) {
+      if (
+        value &&
+        fieldValue.toLowerCase().includes((value as string).toLowerCase())
+      ) {
+        return `${fieldName} contains "${value}".`;
+      }
+      return null;
+    }
+
+    if (criteriaFilter.filterType === FilterType.NotContains) {
+      if (
+        value &&
+        !fieldValue.toLowerCase().includes((value as string).toLowerCase())
+      ) {
+        return `${fieldName} does not contain "${value}".`;
+      }
+      return null;
+    }
+
+    if (criteriaFilter.filterType === FilterType.EqualTo) {
+      if (
+        value &&
+        fieldValue.toLowerCase() === (value as string).toLowerCase()
+      ) {
+        return `${fieldName} equals "${value}".`;
+      }
+      return null;
+    }
+
+    if (criteriaFilter.filterType === FilterType.NotEqualTo) {
+      if (
+        value &&
+        fieldValue.toLowerCase() !== (value as string).toLowerCase()
+      ) {
+        return `${fieldName} does not equal "${value}".`;
+      }
+      return null;
+    }
+
+    if (criteriaFilter.filterType === FilterType.StartsWith) {
+      if (
+        value &&
+        fieldValue.toLowerCase().startsWith((value as string).toLowerCase())
+      ) {
+        return `${fieldName} starts with "${value}".`;
+      }
+      return null;
+    }
+
+    if (criteriaFilter.filterType === FilterType.EndsWith) {
+      if (
+        value &&
+        fieldValue.toLowerCase().endsWith((value as string).toLowerCase())
+      ) {
+        return `${fieldName} ends with "${value}".`;
+      }
+      return null;
+    }
+
+    if (criteriaFilter.filterType === FilterType.IsEmpty) {
+      if (!fieldValue || fieldValue.trim() === "") {
+        return `${fieldName} is empty.`;
+      }
+      return null;
+    }
+
+    if (criteriaFilter.filterType === FilterType.IsNotEmpty) {
+      if (fieldValue && fieldValue.trim() !== "") {
+        return `${fieldName} is not empty.`;
+      }
+      return null;
+    }
+
+    return null;
+  }
+}

package/Server/Utils/Monitor/DataToProcess.ts

@@ -1,4 +1,5 @@
 import IncomingMonitorRequest from "../../../Types/Monitor/IncomingMonitor/IncomingMonitorRequest";
+import IncomingEmailMonitorRequest from "../../../Types/Monitor/IncomingEmailMonitor/IncomingEmailMonitorRequest";
 import ServerMonitorResponse from "../../../Types/Monitor/ServerMonitor/ServerMonitorResponse";
 import ProbeMonitorResponse from "../../../Types/Probe/ProbeMonitorResponse";
 import LogMonitorResponse from "../../../Types/Monitor/LogMonitor/LogMonitorResponse";
@@ -9,6 +10,7 @@ import ExceptionMonitorResponse from "../../../Types/Monitor/ExceptionMonitor/Ex
 type DataToProcess =
   | ProbeMonitorResponse
   | IncomingMonitorRequest
+  | IncomingEmailMonitorRequest
   | ServerMonitorResponse
   | LogMonitorResponse
   | TraceMonitorResponse

package/Server/Utils/Monitor/MonitorCriteriaEvaluator.ts

@@ -2,6 +2,7 @@ import logger from "../Logger";
 import VMUtil from "../VM/VMAPI";
 import APIRequestCriteria from "./Criteria/APIRequestCriteria";
 import CustomCodeMonitoringCriteria from "./Criteria/CustomCodeMonitorCriteria";
+import IncomingEmailCriteria from "./Criteria/IncomingEmailCriteria";
 import IncomingRequestCriteria from "./Criteria/IncomingRequestCriteria";
 import SSLMonitorCriteria from "./Criteria/SSLMonitorCriteria";
 import ServerMonitorCriteria from "./Criteria/ServerMonitorCriteria";
@@ -394,6 +395,18 @@ ${contextBlock}
       }
     }
 
+    if (input.monitor.monitorType === MonitorType.IncomingEmail) {
+      const incomingEmailResult: string | null =
+        await IncomingEmailCriteria.isMonitorInstanceCriteriaFilterMet({
+          dataToProcess: input.dataToProcess,
+          criteriaFilter: input.criteriaFilter,
+        });
+
+      if (incomingEmailResult) {
+        return incomingEmailResult;
+      }
+    }
+
     if (input.monitor.monitorType === MonitorType.SSLCertificate) {
       const sslMonitorResult: string | null =
         await SSLMonitorCriteria.isMonitorInstanceCriteriaFilterMet({

package/Types/Monitor/CriteriaFilter.ts

@@ -47,6 +47,13 @@ export enum CheckOn {
 
   // Metric Monitors.
   MetricValue = "Metric Value",
+
+  // Incoming Email monitors.
+  EmailSubject = "Email Subject",
+  EmailFrom = "Email From Address",
+  EmailBody = "Email Body",
+  EmailTo = "Email To Address",
+  EmailReceivedAt = "Email Received",
 }
 
 export interface ServerMonitorOptions {

package/Types/Monitor/IncomingEmailMonitor/IncomingEmailMonitorRequest.ts

@@ -0,0 +1,25 @@
+import Dictionary from "../../Dictionary";
+import ObjectID from "../../ObjectID";
+import MonitorEvaluationSummary from "../MonitorEvaluationSummary";
+
+export interface EmailAttachment {
+  filename: string;
+  contentType: string;
+  size: number;
+}
+
+export default interface IncomingEmailMonitorRequest {
+  projectId: ObjectID;
+  monitorId: ObjectID;
+  emailFrom: string;
+  emailTo: string;
+  emailSubject: string;
+  emailBody: string;
+  emailBodyHtml?: string | undefined;
+  emailHeaders?: Dictionary<string> | undefined;
+  emailReceivedAt: Date;
+  checkedAt: Date;
+  attachments?: Array<EmailAttachment> | undefined;
+  onlyCheckForIncomingEmailReceivedAt?: boolean | undefined;
+  evaluationSummary?: MonitorEvaluationSummary | undefined;
+}

package/Types/Monitor/MonitorCriteriaInstance.ts

@@ -94,6 +94,33 @@ export default class MonitorCriteriaInstance extends DatabaseProperty {
       return monitorCriteriaInstance;
     }
 
+    if (arg.monitorType === MonitorType.IncomingEmail) {
+      const monitorCriteriaInstance: MonitorCriteriaInstance =
+        new MonitorCriteriaInstance();
+
+      monitorCriteriaInstance.data = {
+        id: ObjectID.generate().toString(),
+        monitorStatusId: arg.monitorStatusId,
+        filterCondition: FilterCondition.All,
+        filters: [
+          {
+            checkOn: CheckOn.EmailReceivedAt,
+            filterType: FilterType.RecievedInMinutes,
+            value: 30,
+          },
+        ],
+        incidents: [],
+        alerts: [],
+        createAlerts: false,
+        changeMonitorStatus: true,
+        createIncidents: false,
+        name: `Check if ${arg.monitorName} is online`,
+        description: `This criteria checks if the ${arg.monitorName} is online`,
+      };
+
+      return monitorCriteriaInstance;
+    }
+
     if (arg.monitorType === MonitorType.Logs) {
       const monitorCriteriaInstance: MonitorCriteriaInstance =
         new MonitorCriteriaInstance();
@@ -658,6 +685,46 @@ export default class MonitorCriteriaInstance extends DatabaseProperty {
       };
     }
 
+    if (arg.monitorType === MonitorType.IncomingEmail) {
+      monitorCriteriaInstance.data = {
+        id: ObjectID.generate().toString(),
+        monitorStatusId: arg.monitorStatusId,
+        filterCondition: FilterCondition.Any,
+        filters: [
+          {
+            checkOn: CheckOn.EmailReceivedAt,
+            filterType: FilterType.NotRecievedInMinutes,
+            value: 30, // if email is not received in 30 minutes, then the monitor is offline
+          },
+        ],
+        alerts: [
+          {
+            title: `${arg.monitorName} is offline`,
+            description: `${arg.monitorName} is currently offline. No email received.`,
+            alertSeverityId: arg.alertSeverityId,
+            autoResolveAlert: true,
+            id: ObjectID.generate().toString(),
+            onCallPolicyIds: [],
+          },
+        ],
+        createAlerts: false,
+        incidents: [
+          {
+            title: `${arg.monitorName} is offline`,
+            description: `${arg.monitorName} is currently offline. No email received.`,
+            incidentSeverityId: arg.incidentSeverityId,
+            autoResolveIncident: true,
+            id: ObjectID.generate().toString(),
+            onCallPolicyIds: [],
+          },
+        ],
+        changeMonitorStatus: true,
+        createIncidents: true,
+        name: `Check if ${arg.monitorName} is offline`,
+        description: `This criteria checks if the ${arg.monitorName} is offline`,
+      };
+    }
+
     if (
       arg.monitorType === MonitorType.CustomJavaScriptCode ||
       arg.monitorType === MonitorType.SyntheticMonitor

package/Types/Monitor/MonitorType.ts

@@ -1,4 +1,5 @@
 import BadDataException from "../Exception/BadDataException";
+import IconProp from "../Icon/IconProp";
 
 enum MonitorType {
   Manual = "Manual",
@@ -8,6 +9,7 @@ enum MonitorType {
   Kubernetes = "Kubernetes",
   IP = "IP",
   IncomingRequest = "Incoming Request",
+  IncomingEmail = "Incoming Email",
   Port = "Port",
   Server = "Server",
   SSLCertificate = "SSL Certificate",
@@ -29,6 +31,7 @@ export interface MonitorTypeProps {
   monitorType: MonitorType;
   description: string;
   title: string;
+  icon: IconProp;
 }
 
 export class MonitorTypeHelper {
@@ -52,24 +55,28 @@ export class MonitorTypeHelper {
         title: "API",
         description:
           "This monitor type lets you monitor any API - GET, POST, PUT, DELETE or more.",
+        icon: IconProp.Code,
       },
       {
         monitorType: MonitorType.Manual,
         title: "Manual",
         description:
           "This monitor is a static monitor and will not actually monitor anything. It will however help you to integrate OneUptime with external monitoring tools and utilities.",
+        icon: IconProp.EmptyCircle,
       },
       {
         monitorType: MonitorType.Website,
         title: "Website",
         description:
           "This monitor type lets you monitor landing pages like home page of your company / blog or more.",
+        icon: IconProp.Globe,
       },
       {
         monitorType: MonitorType.Ping,
         title: "Ping",
         description:
           "This monitor type does the basic ping test of an endpoint.",
+        icon: IconProp.Signal,
       },
       /*
        * {
@@ -77,6 +84,7 @@ export class MonitorTypeHelper {
        *     title: 'Kubernetes',
        *     description:
        *         'This monitor types lets you monitor Kubernetes clusters.',
+       *     icon: IconProp.Cube,
        * },
        */
       {
@@ -84,64 +92,82 @@ export class MonitorTypeHelper {
         title: "IP",
         description:
           "This monitor type lets you monitor any IPv4 or IPv6 addresses.",
+        icon: IconProp.AltGlobe,
       },
       {
         monitorType: MonitorType.IncomingRequest,
         title: "Incoming Request",
         description:
           "This monitor type lets you ping OneUptime from any external device or service with a custom payload.",
+        icon: IconProp.Webhook,
+      },
+      {
+        monitorType: MonitorType.IncomingEmail,
+        title: "Incoming Email",
+        description:
+          "This monitor type triggers alerts when emails are received at a unique email address with matching criteria.",
+        icon: IconProp.Email,
       },
       {
         monitorType: MonitorType.Port,
         title: "Port",
         description: "This monitor type lets you monitor any TCP or UDP port.",
+        icon: IconProp.Terminal,
       },
       {
         monitorType: MonitorType.Server,
         title: "Server / VM",
         description:
           "This monitor type lets you monitor any server, VM, or any machine.",
+        icon: IconProp.Cube,
       },
       {
         monitorType: MonitorType.SSLCertificate,
         title: "SSL Certificate",
         description:
           "This monitor type lets you monitor SSL certificates of any domain.",
+        icon: IconProp.ShieldCheck,
       },
       {
         monitorType: MonitorType.SyntheticMonitor,
         title: "Synthetic Monitor",
         description:
           "This monitor type lets you monitor your web application UI.",
+        icon: IconProp.Window,
       },
       {
         monitorType: MonitorType.CustomJavaScriptCode,
         title: "Custom JavaScript Code",
         description:
           "This monitor type lets you run custom JavaScript code on a schedule.",
+        icon: IconProp.Code,
       },
       {
         monitorType: MonitorType.Logs,
         title: "Logs",
         description: "This monitor type lets you monitor logs from any source.",
+        icon: IconProp.Logs,
       },
       {
         monitorType: MonitorType.Exceptions,
         title: "Exceptions",
         description:
           "This monitor type lets you monitor exceptions and error groups from any source.",
+        icon: IconProp.Bug,
       },
       {
         monitorType: MonitorType.Traces,
         title: "Traces",
         description:
           "This monitor type lets you monitor traces from any source.",
+        icon: IconProp.Waterfall,
       },
       {
         monitorType: MonitorType.Metrics,
         title: "Metrics",
         description:
           "This monitor type lets you monitor metrics from any source.",
+        icon: IconProp.Heartbeat,
       },
     ];
 
@@ -202,6 +228,7 @@ export class MonitorTypeHelper {
       MonitorType.SyntheticMonitor,
       MonitorType.CustomJavaScriptCode,
       MonitorType.IncomingRequest,
+      MonitorType.IncomingEmail,
       MonitorType.Server,
       MonitorType.Logs,
       MonitorType.Metrics,
@@ -215,6 +242,7 @@ export class MonitorTypeHelper {
   ): boolean {
     return (
       monitorType === MonitorType.IncomingRequest ||
+      monitorType === MonitorType.IncomingEmail ||
       monitorType === MonitorType.Server
     );
   }

package/UI/Components/CardSelect/CardSelect.tsx

@@ -0,0 +1,105 @@
+import IconProp from "../../../Types/Icon/IconProp";
+import Icon, { SizeProp } from "../Icon/Icon";
+import React, { FunctionComponent, ReactElement } from "react";
+
+export interface CardSelectOption {
+  value: string;
+  title: string;
+  description: string;
+  icon: IconProp;
+}
+
+export interface ComponentProps {
+  options: Array<CardSelectOption>;
+  value?: string | undefined;
+  onChange: (value: string) => void;
+  error?: string | undefined;
+  tabIndex?: number | undefined;
+  dataTestId?: string | undefined;
+}
+
+const CardSelect: FunctionComponent<ComponentProps> = (
+  props: ComponentProps,
+): ReactElement => {
+  return (
+    <div data-testid={props.dataTestId}>
+      <div className="grid grid-cols-1 gap-4 sm:grid-cols-2 lg:grid-cols-3">
+        {props.options.map((option: CardSelectOption, index: number) => {
+          const isSelected: boolean = props.value === option.value;
+
+          return (
+            <div
+              key={index}
+              tabIndex={props.tabIndex ? props.tabIndex + index : index}
+              onClick={() => {
+                props.onChange(option.value);
+              }}
+              onKeyDown={(e: React.KeyboardEvent) => {
+                if (e.key === "Enter" || e.key === " ") {
+                  e.preventDefault();
+                  props.onChange(option.value);
+                }
+              }}
+              className={`relative flex cursor-pointer rounded-lg border p-4 shadow-sm focus:outline-none transition-all duration-200 hover:border-indigo-400 hover:shadow-md ${
+                isSelected
+                  ? "border-indigo-500 bg-indigo-50/50"
+                  : "border-gray-200 bg-white"
+              }`}
+              role="radio"
+              aria-checked={isSelected}
+              data-testid={`card-select-option-${option.value}`}
+            >
+              <div className="flex w-full items-start">
+                <div
+                  className={`flex h-10 w-10 flex-shrink-0 items-center justify-center rounded-lg ${
+                    isSelected ? "bg-indigo-100" : "bg-gray-100"
+                  }`}
+                >
+                  <Icon
+                    icon={option.icon}
+                    size={SizeProp.Large}
+                    className={`h-5 w-5 ${
+                      isSelected ? "text-indigo-600" : "text-gray-600"
+                    }`}
+                  />
+                </div>
+                <div className="ml-4 flex-1">
+                  <span
+                    className={`block text-sm font-semibold ${
+                      isSelected ? "text-gray-900" : "text-gray-900"
+                    }`}
+                  >
+                    {option.title}
+                  </span>
+                  <span
+                    className={`mt-1 block text-sm ${
+                      isSelected ? "text-gray-600" : "text-gray-500"
+                    }`}
+                  >
+                    {option.description}
+                  </span>
+                </div>
+                {isSelected && (
+                  <div className="flex-shrink-0 ml-2">
+                    <Icon
+                      icon={IconProp.CheckCircle}
+                      size={SizeProp.Large}
+                      className="h-5 w-5 text-indigo-500"
+                    />
+                  </div>
+                )}
+              </div>
+            </div>
+          );
+        })}
+      </div>
+      {props.error && (
+        <p className="mt-2 text-sm text-red-600" role="alert">
+          {props.error}
+        </p>
+      )}
+    </div>
+  );
+};
+
+export default CardSelect;