oneuptime/Common/Server/Utils/LocalFile.ts

import { PromiseRejectErrorFunction } from "../../Types/FunctionTypes";
import fs from "fs";
import CaptureSpan from "./Telemetry/CaptureSpan";

export default class LocalFile {
  @CaptureSpan()
  public static async copyDirectory(data: {
    source: string;
    destination: string;
  }): Promise<void> {
    const source: string = data.source;
    const destination: string = data.destination;

    // copy source to destination recursively
    return new Promise(
      (resolve: VoidFunction, reject: PromiseRejectErrorFunction) => {
        fs.cp(source, destination, { recursive: true }, (err: Error | null) => {
          if (err) {
            return reject(err);
          }
          resolve();
        });
      },
    );
  }

  @CaptureSpan()
  public static async copyFile(data: {
    source: string;
    destination: string;
  }): Promise<void> {
    return new Promise(
      (resolve: VoidFunction, reject: PromiseRejectErrorFunction) => {
        fs.copyFile(data.source, data.destination, (err: Error | null) => {
          if (err) {
            return reject(err);
          }
          resolve();
        });
      },
    );
  }

  @CaptureSpan()
  public static sanitizeFilePath(filePath: string): string {
    // remove double slashes
    return filePath.replace(/\/\//g, "/");
  }

  @CaptureSpan()
  public static getFileExtension(filePath: string): string {
    const fileExtention: Array<string> = filePath.split(".");
    return fileExtention[fileExtention.length - 1]?.toLowerCase() || "";
  }

  @CaptureSpan()
  public static async deleteFile(filePath: string): Promise<void> {
    if ((await this.doesFileExist(filePath)) === false) {
      return;
    }

    return new Promise(
      (resolve: VoidFunction, reject: PromiseRejectErrorFunction) => {
        fs.unlink(filePath, (err: Error | null) => {
          if (err) {
            return reject(err);
          }
          resolve();
        });
      },
    );
  }

  @CaptureSpan()
  public static async deleteDirectory(path: string): Promise<void> {
    if ((await this.doesDirectoryExist(path)) === false) {
      return;
    }

    return new Promise(
      (resolve: VoidFunction, reject: PromiseRejectErrorFunction) => {
        fs.rm(path, { recursive: true, force: true }, (err: Error | null) => {
          if (err) {
            return reject(err);
          }
          resolve();
        });
      },
    );
  }

  @CaptureSpan()
  public static async readDirectory(path: string): Promise<Array<fs.Dirent>> {
    return new Promise(
      (
        resolve: (entries: Array<fs.Dirent>) => void,
        reject: PromiseRejectErrorFunction,
      ) => {
        fs.readdir(
          path,
          { withFileTypes: true },
          (err: Error | null, entries: Array<fs.Dirent>) => {
            if (err) {
              return reject(err);
            }

            resolve(entries);
          },
        );
      },
    );
  }

  @CaptureSpan()
  public static async getListOfDirectories(path: string): Promise<string[]> {
    return new Promise(
      (
        resolve: (directories: string[]) => void,
        reject: PromiseRejectErrorFunction,
      ) => {
        fs.readdir(
          path,
          { withFileTypes: true },
          (err: Error | null, files: fs.Dirent[]) => {
            if (err) {
              return reject(err);
            }

            const directories: string[] = files
              .filter((file: fs.Dirent) => {
                return file.isDirectory();
              })
              .map((file: fs.Dirent) => {
                return file.name;
              });

            resolve(directories);
          },
        );
      },
    );
  }

  @CaptureSpan()
  public static async doesFileExist(path: string): Promise<boolean> {
    return new Promise(
      (
        resolve: (exists: boolean) => void,
        reject: PromiseRejectErrorFunction,
      ) => {
        fs.stat(path, (err: Error | null, stats: fs.Stats) => {
          if (err) {
            if ((err as any).code === "ENOENT") {
              return resolve(false);
            }
            return reject(err);
          }
          if (stats.isFile()) {
            return resolve(true);
          }
          return resolve(false);
        });
      },
    );
  }

  @CaptureSpan()
  public static async doesDirectoryExist(path: string): Promise<boolean> {
    return new Promise(
      (
        resolve: (exists: boolean) => void,
        reject: PromiseRejectErrorFunction,
      ) => {
        fs.stat(path, (err: Error | null, stats: fs.Stats) => {
          if (err) {
            if ((err as any).code === "ENOENT") {
              return resolve(false);
            }
            return reject(err);
          }
          if (stats.isDirectory()) {
            return resolve(true);
          }
          return resolve(false);
        });
      },
    );
  }

  @CaptureSpan()
  public static async deleteAllDataInDirectory(path: string): Promise<void> {
    if ((await this.doesDirectoryExist(path)) === false) {
      return;
    }

    return new Promise(
      (resolve: VoidFunction, reject: PromiseRejectErrorFunction) => {
        fs.rm(path, { recursive: true }, (err: Error | null) => {
          if (err) {
            return reject(err);
          }

          // now crate the directory again

          fs.mkdir(path, { recursive: true }, (err: Error | null) => {
            if (err) {
              return reject(err);
            }
            resolve();
          });
        });
      },
    );
  }

  @CaptureSpan()
  public static async makeDirectory(path: string): Promise<void> {
    return new Promise(
      (resolve: VoidFunction, reject: PromiseRejectErrorFunction) => {
        fs.mkdir(path, { recursive: true }, (err: Error | null) => {
          if (err) {
            return reject(err);
          }
          resolve();
        });
      },
    );
  }

  @CaptureSpan()
  public static async write(path: string, data: string): Promise<void> {
    return new Promise(
      (resolve: VoidFunction, reject: PromiseRejectErrorFunction) => {
        fs.writeFile(path, data, (err: Error | null) => {
          if (err) {
            return reject(err);
          }
          resolve();
        });
      },
    );
  }

  @CaptureSpan()
  public static async read(path: string): Promise<string> {
    return new Promise(
      (resolve: (data: string) => void, reject: PromiseRejectErrorFunction) => {
        fs.readFile(
          path,
          { encoding: "utf-8" },
          (err: Error | null, data: string) => {
            if (!err) {
              return resolve(data);
            }
            return reject(err);
          },
        );
      },
    );
  }

  @CaptureSpan()
  public static async readAsBuffer(path: string): Promise<Buffer> {
    return new Promise(
      (resolve: (data: Buffer) => void, reject: PromiseRejectErrorFunction) => {
        fs.readFile(path, (err: Error | null, data: Buffer) => {
          if (!err) {
            return resolve(data);
          }
          return reject(err);
        });
      },
    );
  }
}