@oneuptime/common 7.0.3010 → 7.0.3018

package/Server/Types/Workflow/Components/Email.ts

@@ -5,6 +5,7 @@ import ComponentMetadata, { Port } from "Common/Types/Workflow/Component";
 import ComponentID from "Common/Types/Workflow/ComponentID";
 import Components from "Common/Types/Workflow/Components/Email";
 import nodemailer, { Transporter } from "nodemailer";
+import SMTPTransport from "nodemailer/lib/smtp-transport";
 
 export default class Email extends ComponentCode {
   public constructor() {
@@ -48,53 +49,49 @@ export default class Email extends ComponentCode {
     }
 
     if (!args["to"]) {
-      throw options.onError(new BadDataException("to not found"));
+      throw options.onError(new BadDataException("To Email not found"));
     }
 
     if (args["to"] && typeof args["to"] !== "string") {
-      throw options.onError(new BadDataException("to is not type of string"));
+      throw options.onError(
+        new BadDataException("To Email is not type of string"),
+      );
     }
 
     if (!args["from"]) {
-      throw options.onError(new BadDataException("from not found"));
+      throw options.onError(new BadDataException("From Email not found"));
     }
 
     if (args["from"] && typeof args["from"] !== "string") {
-      throw options.onError(new BadDataException("from is not type of string"));
-    }
-
-    if (!args["smtp-username"]) {
-      throw options.onError(new BadDataException("email not found"));
+      throw options.onError(
+        new BadDataException("From Email is not type of string"),
+      );
     }
 
     if (args["smtp-username"] && typeof args["smtp-username"] !== "string") {
       throw options.onError(
-        new BadDataException("smtp-username is not type of string"),
+        new BadDataException("SMTP Username is not type of string"),
       );
     }
 
-    if (!args["smtp-password"]) {
-      throw options.onError(new BadDataException("email not found"));
-    }
-
     if (args["smtp-password"] && typeof args["smtp-password"] !== "string") {
       throw options.onError(
-        new BadDataException("smtp-username is not type of string"),
+        new BadDataException("SMTP Password is not type of string"),
       );
     }
 
     if (!args["smtp-host"]) {
-      throw options.onError(new BadDataException("email not found"));
+      throw options.onError(new BadDataException("SMTP Host not found"));
     }
 
     if (args["smtp-host"] && typeof args["smtp-host"] !== "string") {
       throw options.onError(
-        new BadDataException("smtp-host is not type of string"),
+        new BadDataException("SMTP Host is not type of string"),
       );
     }
 
     if (!args["smtp-port"]) {
-      throw options.onError(new BadDataException("email not found"));
+      throw options.onError(new BadDataException("SMTP Port not found"));
     }
 
     if (args["smtp-port"] && typeof args["smtp-port"] === "string") {
@@ -103,20 +100,30 @@ export default class Email extends ComponentCode {
 
     if (args["smtp-port"] && typeof args["smtp-port"] !== "number") {
       throw options.onError(
-        new BadDataException("smtp-host is not type of number"),
+        new BadDataException("SMTP Port is not type of number"),
       );
     }
 
     try {
-      const mailer: Transporter = nodemailer.createTransport({
+      const username: string | undefined =
+        args["smtp-username"]?.toString() || undefined;
+      const password: string | undefined =
+        args["smtp-password"]?.toString() || undefined;
+
+      const smtpTransport: SMTPTransport.Options = {
         host: args["smtp-host"]?.toString(),
         port: args["smtp-port"] as number,
         secure: Boolean(args["secure"]),
-        auth: {
-          user: args["smtp-username"] as string,
-          pass: args["smtp-password"] as string,
-        },
-      });
+      };
+
+      if (username && password) {
+        smtpTransport.auth = {
+          user: username,
+          pass: password,
+        };
+      }
+
+      const mailer: Transporter = nodemailer.createTransport(smtpTransport);
 
       await mailer.sendMail({
         from: args["from"].toString(),
@@ -135,7 +142,7 @@ export default class Email extends ComponentCode {
       options.log(err as Error);
       return Promise.resolve({
         returnValues: {},
-        executePort: successPort,
+        executePort: errorPort,
       });
     }
   }

package/Server/Utils/CodeRepository/CodeRepository.ts

@@ -3,9 +3,18 @@ import LocalFile from "../LocalFile";
 import logger from "../Logger";
 import CodeRepositoryFile from "./CodeRepositoryFile";
 import Dictionary from "Common/Types/Dictionary";
-import ServiceLanguageUtil from "Common/Utils/TechStack";
 
 export default class CodeRepositoryUtil {
+  public static getCurrentCommitHash(data: {
+    repoPath: string;
+  }): Promise<string> {
+    const command: string = `cd ${data.repoPath} && git rev-parse HEAD`;
+
+    logger.debug("Executing command: " + command);
+
+    return Execute.executeCommand(command);
+  }
+
   public static async addAllChangedFilesToGit(data: {
     repoPath: string;
   }): Promise<void> {
@@ -367,24 +376,11 @@ export default class CodeRepositoryUtil {
         }
       }
 
-      const gitCommitHash: string = await this.getGitCommitHashForFile({
-        filePath,
-        repoPath,
-      });
-
-      const fileExtension: string = fileName.split(".").pop() || "";
       files[filePath] = {
-        filePath: LocalFile.sanitizeFilePath(`${directoryPath}/${fileName}`),
-        gitCommitHash,
-        fileExtension,
-        fileName,
         fileContent: await this.getFileContent({
           filePath: LocalFile.sanitizeFilePath(`${directoryPath}/${fileName}`),
           repoPath,
         }),
-        fileLanguage: ServiceLanguageUtil.getLanguageByFileExtension({
-          fileExtension,
-        }),
       };
     }
 

package/Server/Utils/CodeRepository/CodeRepositoryFile.ts

@@ -1,10 +1,3 @@
-import TechStack from "Common/Types/ServiceCatalog/TechStack";
-
 export default interface CodeRepositoryFile {
-  filePath: string;
-  gitCommitHash: string;
-  fileExtension: string;
-  fileName: string;
   fileContent: string;
-  fileLanguage: TechStack;
 }

package/Types/Copilot/CopilotActionProps/DirectoryActionProp.ts

@@ -0,0 +1,3 @@
+export default interface DirectoryActionProp {
+  directoryPath: string;
+}

package/Types/Copilot/CopilotActionProps/ExceptionActionProp.ts

@@ -0,0 +1,4 @@
+export default interface ExceptionActionProp {
+  fingerprint: string;
+  message: string;
+}

package/Types/Copilot/CopilotActionProps/FileActionProp.ts

@@ -0,0 +1,5 @@
+export default interface FileActionProp {
+  filePath: string;
+  startLineNumber: number;
+  endLineNumber: number;
+}

package/Types/Copilot/CopilotActionProps/FunctionActionProp.ts

@@ -0,0 +1,5 @@
+export default interface FunctionActionProp {
+  filePath: string;
+  className?: string | undefined; // some languages are not class based.
+  functionName: string;
+}

package/Types/Copilot/CopilotActionProps/Index.ts

@@ -0,0 +1,96 @@
+import DirectoryActionProp from "./DirectoryActionProp";
+import FileActionProp from "./FileActionProp";
+import ExceptionActionProp from "./ExceptionActionProp";
+import SpanActionProp from "./SpanActionProp";
+import FunctionActionProp from "./FunctionActionProp";
+import CopilotActionType from "../CopilotActionType";
+
+type CopilotActionProp =
+  | DirectoryActionProp
+  | FileActionProp
+  | ExceptionActionProp
+  | SpanActionProp
+  | FunctionActionProp;
+
+export enum CopilotActionPropType {
+  Directory = "Directory",
+  File = "File",
+  Exception = "Exception",
+  Span = "Span",
+  Metric = "Metric",
+  Function = "Function",
+}
+
+export class CopilotActionPropUtil {
+  public static getCopilotActionPropByActionType(
+    actionType: CopilotActionType,
+  ): CopilotActionPropType {
+    if (actionType === CopilotActionType.FIX_EXCEPTIONS) {
+      return CopilotActionPropType.Exception;
+    }
+
+    if (actionType === CopilotActionType.FIX_PERFORMANCE_ISSUES) {
+      return CopilotActionPropType.Span;
+    }
+
+    if (actionType === CopilotActionType.FIX_BUGS) {
+      return CopilotActionPropType.Function;
+    }
+
+    if (actionType === CopilotActionType.IMPROVE_LOGS) {
+      return CopilotActionPropType.File;
+    }
+
+    if (actionType === CopilotActionType.IMPROVE_SPANS) {
+      return CopilotActionPropType.Function;
+    }
+
+    if (actionType === CopilotActionType.IMPROVE_METRICS) {
+      return CopilotActionPropType.Function;
+    }
+
+    if (actionType === CopilotActionType.ADD_LOGS) {
+      return CopilotActionPropType.File;
+    }
+
+    if (actionType === CopilotActionType.ADD_SPANS) {
+      return CopilotActionPropType.Function;
+    }
+
+    if (actionType === CopilotActionType.ADD_METRICS) {
+      return CopilotActionPropType.Function;
+    }
+
+    if (actionType === CopilotActionType.REFACTOR_CODE) {
+      return CopilotActionPropType.Function;
+    }
+
+    if (actionType === CopilotActionType.WRITE_UNIT_TESTS) {
+      return CopilotActionPropType.Function;
+    }
+
+    if (actionType === CopilotActionType.IMPROVE_UNIT_TESTS) {
+      return CopilotActionPropType.Function;
+    }
+
+    if (actionType === CopilotActionType.IMPROVE_COMMENTS) {
+      return CopilotActionPropType.File;
+    }
+
+    if (actionType === CopilotActionType.ADD_COMMENTS) {
+      return CopilotActionPropType.File;
+    }
+
+    if (actionType === CopilotActionType.ADD_README) {
+      return CopilotActionPropType.Directory;
+    }
+
+    if (actionType === CopilotActionType.IMPROVE_README) {
+      return CopilotActionPropType.File;
+    }
+
+    return CopilotActionPropType.File;
+  }
+}
+
+export default CopilotActionProp;

package/Types/Copilot/CopilotActionProps/SpanActionProp.ts

@@ -0,0 +1,4 @@
+export default interface SpanActionProp {
+  traceId: string;
+  spanId?: string;
+}

package/Types/Copilot/CopilotActionStatus.ts

@@ -1,6 +1,114 @@
 enum CopilotActionStatus {
+  // Processed States.
   PR_CREATED = "Pull Request Created", // PR created and waiting for review
-  NO_ACTION_REQUIRED = "No Action Required", // No PR needed. All is good.
+  NO_ACTION_REQUIRED = "No Action Required", // Code is all good. No action required. No PR created.
+  CANNOT_FIX = "Cannot Fix", // OneUptime Copilot tried to fix the issue but failed.
+
+  // Processing States
+  PROCESSING = "Processing", // Action is being processed.
+
+  // In Queue
+  IN_QUEUE = "In Queue", // Action is in queue.
+}
+
+export interface CopilotActionStatusData {
+  status: CopilotActionStatus;
+  description: string;
+}
+
+export class CopilotActionStatusUtil {
+  public static getAllCopilotActionStatuses(): Array<CopilotActionStatus> {
+    return [
+      CopilotActionStatus.PR_CREATED,
+      CopilotActionStatus.NO_ACTION_REQUIRED,
+      CopilotActionStatus.CANNOT_FIX,
+      CopilotActionStatus.PROCESSING,
+      CopilotActionStatus.IN_QUEUE,
+    ];
+  }
+
+  public static getCopilotActionStatus(status: string): CopilotActionStatus {
+    switch (status) {
+      case CopilotActionStatus.PR_CREATED:
+        return CopilotActionStatus.PR_CREATED;
+      case CopilotActionStatus.NO_ACTION_REQUIRED:
+        return CopilotActionStatus.NO_ACTION_REQUIRED;
+      case CopilotActionStatus.CANNOT_FIX:
+        return CopilotActionStatus.CANNOT_FIX;
+      case CopilotActionStatus.PROCESSING:
+        return CopilotActionStatus.PROCESSING;
+      case CopilotActionStatus.IN_QUEUE:
+        return CopilotActionStatus.IN_QUEUE;
+      default:
+        throw new Error(`Invalid CopilotActionStatus: ${status}`);
+    }
+  }
+
+  public static isCopilotActionStatus(status: string): boolean {
+    return CopilotActionStatusUtil.getAllCopilotActionStatuses().includes(
+      status as CopilotActionStatus,
+    );
+  }
+
+  public static isCopilotActionStatusArray(statuses: Array<string>): boolean {
+    return statuses.every((status: string) => {
+      return CopilotActionStatusUtil.isCopilotActionStatus(status);
+    });
+  }
+
+  // get processing status
+  public static getProcessingStatus(): CopilotActionStatus {
+    return CopilotActionStatus.PROCESSING;
+  }
+
+  // get in queue status
+  public static getInQueueStatus(): CopilotActionStatus {
+    return CopilotActionStatus.IN_QUEUE;
+  }
+
+  // get processed status
+  public static getProcessedStatus(): Array<CopilotActionStatus> {
+    return [
+      CopilotActionStatus.PR_CREATED,
+      CopilotActionStatus.NO_ACTION_REQUIRED,
+      CopilotActionStatus.CANNOT_FIX,
+    ];
+  }
+
+  // get copilot actiomn status data
+  public static getCopilotActionStatusData(
+    status: CopilotActionStatus,
+  ): CopilotActionStatusData {
+    switch (status) {
+      case CopilotActionStatus.PR_CREATED:
+        return {
+          status: CopilotActionStatus.PR_CREATED,
+          description: "Pull Request Created",
+        };
+      case CopilotActionStatus.NO_ACTION_REQUIRED:
+        return {
+          status: CopilotActionStatus.NO_ACTION_REQUIRED,
+          description: "No Action Required",
+        };
+      case CopilotActionStatus.CANNOT_FIX:
+        return {
+          status: CopilotActionStatus.CANNOT_FIX,
+          description: "Cannot Fix",
+        };
+      case CopilotActionStatus.PROCESSING:
+        return {
+          status: CopilotActionStatus.PROCESSING,
+          description: "Processing",
+        };
+      case CopilotActionStatus.IN_QUEUE:
+        return {
+          status: CopilotActionStatus.IN_QUEUE,
+          description: "In Queue",
+        };
+      default:
+        throw new Error(`Invalid CopilotActionStatus: ${status}`);
+    }
+  }
 }
 
 export default CopilotActionStatus;

package/Types/Copilot/CopilotActionType.ts

@@ -1,10 +1,212 @@
 enum CopilotActionType {
   IMPROVE_COMMENTS = "Improve Comments",
-  IMRPOVE_README = "Improve Readme",
+  ADD_COMMENTS = "Add Comments",
+
+  IMPROVE_README = "Improve Readme",
+  ADD_README = "Add Readme",
+
   FIX_GRAMMAR_AND_SPELLING = "Fix Grammar and Spelling",
   IMPROVE_VARIABLE_NAMES = "Improve Variable Names",
   REFACTOR_CODE = "Refactor Code",
+
   WRITE_UNIT_TESTS = "Write Unit Tests",
+  IMPROVE_UNIT_TESTS = "Improve Unit Tests",
+
+  IMPROVE_LOGS = "Improve Logs",
+  ADD_LOGS = "Add Logs",
+
+  IMPROVE_SPANS = "Improve Spans",
+  ADD_SPANS = "Add Spans",
+
+  IMPROVE_METRICS = "Improve Metrics",
+  ADD_METRICS = "Add Metrics",
+
+  FIX_EXCEPTIONS = "Fix Exceptions",
+  FIX_PERFORMANCE_ISSUES = "Fix Performance Issues",
+  FIX_BUGS = "Fix Bugs",
+
+  // SETUP_ACTIONS
+  SETUP_OPEN_TELEMETRY = "Setup OpenTelemetry",
+
+  // Setup Unit Test Framework
+  SETUP_UNIT_TEST_FRAMEWORK = "Setup Unit Test Framework",
+}
+
+export interface CopilotActionTypeData {
+  type: CopilotActionType;
+  description: string;
+  defaultPriority: number;
+  dependsOn: Array<CopilotActionType>;
+}
+
+export class CopilotActionTypeUtil {
+  public static getAllCopilotActionTypes(): Array<CopilotActionTypeData> {
+    return [
+      // Fix broken code.
+      {
+        type: CopilotActionType.FIX_EXCEPTIONS,
+        description: "Fix exceptions in your codebase",
+        defaultPriority: 1,
+        dependsOn: [CopilotActionType.SETUP_OPEN_TELEMETRY],
+      },
+      {
+        type: CopilotActionType.FIX_PERFORMANCE_ISSUES,
+        description: "Fix performance issues in your codebase",
+        defaultPriority: 1,
+        dependsOn: [CopilotActionType.SETUP_OPEN_TELEMETRY],
+      },
+      {
+        type: CopilotActionType.FIX_BUGS,
+        description: "Fix simple bugs and small issues in your codebase",
+        defaultPriority: 1,
+        dependsOn: [],
+      },
+
+      // Improve debugging.
+
+      // add logs, metircs and spans.
+
+      {
+        type: CopilotActionType.ADD_LOGS,
+        description: "Add OpenTelemetry logs in your codebase",
+        defaultPriority: 2,
+        dependsOn: [CopilotActionType.SETUP_OPEN_TELEMETRY],
+      },
+      {
+        type: CopilotActionType.ADD_SPANS,
+        description: "Add OpenTelemetry spans in your codebase",
+        defaultPriority: 2,
+        dependsOn: [CopilotActionType.SETUP_OPEN_TELEMETRY],
+      },
+      {
+        type: CopilotActionType.ADD_METRICS,
+        description: "Add OpenTelemetry metrics in your codebase",
+        defaultPriority: 2,
+        dependsOn: [CopilotActionType.SETUP_OPEN_TELEMETRY],
+      },
+      {
+        type: CopilotActionType.IMPROVE_LOGS,
+        description:
+          "Improve OpenTelemetry logs in your codebase where required to make debugging easier.",
+        defaultPriority: 2,
+        dependsOn: [CopilotActionType.SETUP_OPEN_TELEMETRY],
+      },
+      {
+        type: CopilotActionType.IMPROVE_SPANS,
+        description:
+          "Improve OpenTelemetry spans in your codebase where required to make debugging easier.",
+        defaultPriority: 2,
+        dependsOn: [CopilotActionType.SETUP_OPEN_TELEMETRY],
+      },
+      {
+        type: CopilotActionType.IMPROVE_METRICS,
+        description:
+          "Improve OpenTelemetry metrics in your codebase where required to make debugging easier.",
+        defaultPriority: 2,
+        dependsOn: [CopilotActionType.SETUP_OPEN_TELEMETRY],
+      },
+
+      // Improve code and test quality.
+      {
+        type: CopilotActionType.REFACTOR_CODE,
+        description: "Refactor code and make it into smaller units",
+        defaultPriority: 3,
+        dependsOn: [],
+      },
+      {
+        type: CopilotActionType.WRITE_UNIT_TESTS,
+        description: "Add unit tests",
+        defaultPriority: 3,
+        dependsOn: [CopilotActionType.SETUP_UNIT_TEST_FRAMEWORK],
+      },
+      {
+        type: CopilotActionType.IMPROVE_UNIT_TESTS,
+        description: "Improve unit tests",
+        defaultPriority: 3,
+        dependsOn: [CopilotActionType.SETUP_UNIT_TEST_FRAMEWORK],
+      },
+
+      // add comments.
+      {
+        type: CopilotActionType.IMPROVE_COMMENTS,
+        description: "Improve comments in your codebase",
+        defaultPriority: 4,
+        dependsOn: [],
+      },
+      {
+        type: CopilotActionType.ADD_COMMENTS,
+        description: "Add comments in your codebase",
+        defaultPriority: 4,
+        dependsOn: [],
+      },
+
+      // Add or improve README file.
+      {
+        type: CopilotActionType.ADD_README,
+        description: "Add a README file",
+        defaultPriority: 4,
+        dependsOn: [],
+      },
+      {
+        type: CopilotActionType.IMPROVE_README,
+        description: "Improve the README file",
+        defaultPriority: 4,
+        dependsOn: [],
+      },
+
+      // Fix grammar and spelling mistakes
+      {
+        type: CopilotActionType.FIX_GRAMMAR_AND_SPELLING,
+        description: "Fix grammar and spelling mistakes",
+        defaultPriority: 5,
+        dependsOn: [],
+      },
+      {
+        type: CopilotActionType.IMPROVE_VARIABLE_NAMES,
+        description: "Improve variable names and make it understandable",
+        defaultPriority: 5,
+        dependsOn: [],
+      },
+    ];
+  }
+
+  public static getSetupActionTypes(): Array<CopilotActionTypeData> {
+    return [
+      {
+        type: CopilotActionType.SETUP_OPEN_TELEMETRY,
+        description: "Setup OpenTelemetry in your codebase",
+        defaultPriority: 1,
+        dependsOn: [],
+      },
+      {
+        type: CopilotActionType.SETUP_UNIT_TEST_FRAMEWORK,
+        description: "Setup Unit Test Framework in your codebase",
+        defaultPriority: 1,
+        dependsOn: [],
+      },
+    ];
+  }
+
+  public static getCopilotActionType(
+    type: CopilotActionType,
+  ): CopilotActionTypeData {
+    return this.getAllCopilotActionTypes().find(
+      (copilotActionTypeData: CopilotActionTypeData) => {
+        return copilotActionTypeData.type === type;
+      },
+    ) as CopilotActionTypeData;
+  }
+
+  // get actions by priority.
+  public static getActionsByPriority(
+    priority: number,
+  ): Array<CopilotActionTypeData> {
+    return this.getAllCopilotActionTypes().filter(
+      (copilotActionTypeData: CopilotActionTypeData) => {
+        return copilotActionTypeData.defaultPriority === priority;
+      },
+    );
+  }
 }
 
 export default CopilotActionType;

package/Types/Icon/IconProp.ts

@@ -17,6 +17,7 @@ enum IconProp {
   ArrowUpDown = "ArrowUpDown",
   Cube = "Cube",
   Unarchive = "Unarchive",
+  CPUChip = "CPUChip",
   Swatch = "Swatch",
   Squares = "Squares",
   RectangleStack = "RectangleStack",

package/Types/Permission.ts

@@ -499,6 +499,9 @@ enum Permission {
   ReadCopilotCodeRepository = "ReadCopilotCodeRepository",
 
   ReadCopilotAction = "ReadCopilotAction",
+  CreateCopilotAction = "CreateCopilotAction",
+  DeleteCopilotAction = "DeleteCopilotAction",
+  EditCopilotAction = "EditCopilotAction",
 
   ReadCopilotPullRequest = "ReadCopilotPullRequest",
 
@@ -2556,6 +2559,29 @@ export class PermissionHelper {
         isAssignableToTenant: true,
         isAccessControlPermission: false,
       },
+      {
+        permission: Permission.EditCopilotAction,
+        title: "Edit Copilot Event",
+        description: "This permission can edit Copilot Event of this project.",
+        isAssignableToTenant: true,
+        isAccessControlPermission: false,
+      },
+      {
+        permission: Permission.DeleteCopilotAction,
+        title: "Delete Copilot Event",
+        description:
+          "This permission can delete Copilot Event of this project.",
+        isAssignableToTenant: true,
+        isAccessControlPermission: false,
+      },
+      {
+        permission: Permission.CreateCopilotAction,
+        title: "Create Copilot Event",
+        description:
+          "This permission can create Copilot Event of this project.",
+        isAssignableToTenant: true,
+        isAccessControlPermission: false,
+      },
 
       {
         permission: Permission.CreateProbeOwnerTeam,