oneuptime/CommonServer/Utils/CodeRepository/CodeRepository.ts

import Execute from "../Execute";
import LocalFile from "../LocalFile";
import logger from "../Logger";
import CodeRepositoryFile from "./CodeRepositoryFile";
import Dictionary from "Common/Types/Dictionary";
import ServiceLanguageUtil from "Common/Utils/ServiceLanguage";

export default class CodeRepositoryUtil {

  public static async cloneRepository(data: {
    repoPath: string;
    repoUrl: string;
  }): Promise<void> {
    const command: string = `cd ${data.repoPath} && git clone ${data.repoUrl}`;

    logger.debug("Executing command: " + command);

    const stdout: string = await Execute.executeCommand(command);

    logger.debug(stdout);
  }

  public static async pullChanges(data: { repoPath: string }): Promise<void> {
    const command: string = `cd ${data.repoPath} && git pull`;

    logger.debug("Executing command: " + command);

    const stdout: string = await Execute.executeCommand(command);

    logger.debug(stdout);
  }

  public static async createOrCheckoutBranch(data: {
    repoPath: string;
    branchName: string;
  }): Promise<void> {
    const command: string = `cd ${data.repoPath} && git checkout ${data.branchName} || git checkout -b ${data.branchName}`;

    logger.debug("Executing command: " + command);

    const stdout: string = await Execute.executeCommand(command);

    logger.debug(stdout);
  }

  public static getFileContent(data: {
    repoPath: string;
    filePath: string;
  }): Promise<string> {
    const path: string = LocalFile.sanitizeFilePath(
      `${data.repoPath}/${data.filePath}`,
    );

    const command: string = `cat ${path}`;

    logger.debug("Executing command: " + command);

    return Execute.executeCommand(`${command}`);
  }

  // discard all changes in the working directory
  public static async discardChanges(data: {
    repoPath: string;
  }): Promise<void> {
    const command: string = `cd ${data.repoPath} && git checkout .`;

    logger.debug("Executing command: " + command);

    const stdout: string = await Execute.executeCommand(command);

    logger.debug(stdout);
  }

  public static async writeToFile(data: {
    filePath: string;
    repoPath: string;
    content: string;
  }): Promise<void> {
    const totalPath: string = LocalFile.sanitizeFilePath(
      `${data.repoPath}/${data.filePath}`,
    );

    const command: string = `echo "${data.content}" > ${totalPath}`;

    logger.debug("Executing command: " + command);

    const stdout: string = await Execute.executeCommand(command);

    logger.debug(stdout);
  }

  public static async createDirectory(data: {
    repoPath: string;
    directoryPath: string;
  }): Promise<void> {
    const totalPath: string = LocalFile.sanitizeFilePath(
      `${data.repoPath}/${data.directoryPath}`,
    );

    const command: string = `mkdir ${totalPath}`;

    logger.debug("Executing command: " + command);

    const stdout: string = await Execute.executeCommand(command);

    logger.debug(stdout);
  }

  public static async deleteFile(data: {
    repoPath: string;
    filePath: string;
  }): Promise<void> {
    const totalPath: string = LocalFile.sanitizeFilePath(
      `${data.repoPath}/${data.filePath}`,
    );

    const command: string = `rm ${totalPath}`;

    logger.debug("Executing command: " + command);

    const stdout: string = await Execute.executeCommand(command);

    logger.debug(stdout);
  }

  public static async deleteDirectory(data: {
    repoPath: string;
    directoryPath: string;
  }): Promise<void> {
    const totalPath: string = LocalFile.sanitizeFilePath(
      `${data.repoPath}/${data.directoryPath}`,
    );

    const command: string = `rm -rf ${totalPath}`;

    logger.debug("Executing command: " + command);

    const stdout: string = await Execute.executeCommand(command);

    logger.debug(stdout);
  }

  public static async createBranch(data: {
    repoPath: string;
    branchName: string;
  }): Promise<void> {
    const command: string = `cd ${data.repoPath} && git checkout -b ${data.branchName}`;

    logger.debug("Executing command: " + command);

    const stdout: string = await Execute.executeCommand(command);

    logger.debug(stdout);
  }

  public static async checkoutBranch(data: {
    repoPath: string;
    branchName: string;
  }): Promise<void> {
    const command: string = `cd ${data.repoPath} && git checkout ${data.branchName}`;

    logger.debug("Executing command: " + command);

    const stdout: string = await Execute.executeCommand(command);

    logger.debug(stdout);
  }

  public static async addFilesToGit(data: {
    repoPath: string;
    filePaths: Array<string>;
  }): Promise<void> {
    const filePaths: Array<string> = data.filePaths.map((filePath: string) => {
      if (filePath.startsWith("/")) {
        // remove the leading slash and return
        return filePath.substring(1);
      }

      return filePath;
    });

    const command: string = `cd ${
      data.repoPath
    } && git add ${filePaths.join(" ")}`;

    logger.debug("Executing command: " + command);

    const stdout: string = await Execute.executeCommand(command);

    logger.debug(stdout);
  }

  public static async setUsername(data: {
    repoPath: string;
    username: string;
  }): Promise<void> {
    const command: string = `cd ${data.repoPath} && git config user.name "${data.username}"`;

    logger.debug("Executing command: " + command);

    const stdout: string = await Execute.executeCommand(command);

    logger.debug(stdout);
  }

  public static async commitChanges(data: {
    repoPath: string;
    message: string;
    username: string;
  }): Promise<void> {
    // set the username and email

    await this.setUsername({
      repoPath: data.repoPath,
      username: data.username,
    });

    const command: string = `cd ${data.repoPath} && git commit -m "${data.message}"`;

    logger.debug("Executing command: " + command);

    const stdout: string = await Execute.executeCommand(command);

    logger.debug(stdout);
  }

  public static async getGitCommitHashForFile(data: {
    repoPath: string;
    filePath: string;
  }): Promise<string> {
    if (!data.filePath.startsWith("/")) {
      data.filePath = "/" + data.filePath;
    }

    if (!data.repoPath.startsWith("/")) {
      data.repoPath = "/" + data.repoPath;
    }

    const { repoPath, filePath } = data;

    const command: string = `cd ${repoPath} && git log -1 --pretty=format:"%H" ".${filePath}"`;

    logger.debug("Executing command: " + command);

    const hash: string = await Execute.executeCommand(command);

    logger.debug(hash);

    return hash;
  }


  public static async listFilesInDirectory(data: {
    directoryPath: string;
    repoPath: string;
  }): Promise<Array<string>> {
    if (!data.directoryPath.startsWith("/")) {
      data.directoryPath = "/" + data.directoryPath;
    }

    if (!data.repoPath.startsWith("/")) {
      data.repoPath = "/" + data.repoPath;
    }

    const { directoryPath, repoPath } = data;

    let totalPath: string = `${repoPath}/${directoryPath}`;

    totalPath = LocalFile.sanitizeFilePath(totalPath); // clean up the path

    const output: string = await Execute.executeCommand(`ls ${totalPath}`);

    const fileNames: Array<string> = output.split("\n");

    return fileNames;
  }

  public static async getFilesInDirectory(data: {
    directoryPath: string;
    repoPath: string;
    acceptedFileExtensions?: Array<string>;
    ignoreFilesOrDirectories: Array<string>;
  }): Promise<{
    files: Dictionary<CodeRepositoryFile>;
    subDirectories: Array<string>;
  }> {
    if (!data.directoryPath.startsWith("/")) {
      data.directoryPath = "/" + data.directoryPath;
    }

    if (!data.repoPath.startsWith("/")) {
      data.repoPath = "/" + data.repoPath;
    }

    const { directoryPath, repoPath } = data;

    let totalPath: string = `${repoPath}/${directoryPath}`;

    totalPath = LocalFile.sanitizeFilePath(totalPath); // clean up the path

    const files: Dictionary<CodeRepositoryFile> = {};
    const output: string = await Execute.executeCommand(`ls ${totalPath}`);

    const fileNames: Array<string> = output.split("\n");

    const subDirectories: Array<string> = [];

    for (const fileName of fileNames) {
      if (fileName === "") {
        continue;
      }

      const filePath: string = LocalFile.sanitizeFilePath(
        `${directoryPath}/${fileName}`,
      );

      if (data.ignoreFilesOrDirectories.includes(fileName)) {
        continue;
      }

      const isDirectory: boolean = (
        await Execute.executeCommand(
          `file "${LocalFile.sanitizeFilePath(`${totalPath}/${fileName}`)}"`,
        )
      ).includes("directory");

      if (isDirectory) {
        subDirectories.push(
          LocalFile.sanitizeFilePath(`${directoryPath}/${fileName}`),
        );
        continue;
      } else if (
        data.acceptedFileExtensions &&
        data.acceptedFileExtensions.length > 0
      ) {
        let shouldSkip: boolean = true;

        for (const fileExtension of data.acceptedFileExtensions) {
          if (fileName.endsWith(fileExtension)) {
            shouldSkip = false;
            break;
          }
        }

        if (shouldSkip) {
          continue;
        }
      }

      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,
        }),
      };
    }

    return {
      files,
      subDirectories: subDirectories,
    };
  }

  public static async getFilesInDirectoryRecursive(data: {
    repoPath: string;
    directoryPath: string;
    acceptedFileExtensions: Array<string>;
    ignoreFilesOrDirectories: Array<string>;
  }): Promise<Dictionary<CodeRepositoryFile>> {
    let files: Dictionary<CodeRepositoryFile> = {};

    const { files: filesInDirectory, subDirectories } =
      await this.getFilesInDirectory({
        directoryPath: data.directoryPath,
        repoPath: data.repoPath,
        acceptedFileExtensions: data.acceptedFileExtensions,
        ignoreFilesOrDirectories: data.ignoreFilesOrDirectories,
      });

    files = {
      ...files,
      ...filesInDirectory,
    };

    for (const subDirectory of subDirectories) {
      files = {
        ...files,
        ...(await this.getFilesInDirectoryRecursive({
          repoPath: data.repoPath,
          directoryPath: subDirectory,
          acceptedFileExtensions: data.acceptedFileExtensions,
          ignoreFilesOrDirectories: data.ignoreFilesOrDirectories,
        })),
      };
    }

    return files;
  }
}