feat: secure clear function, refactor a new utils #31

src/commands/clear.ts

@@ -7,11 +7,20 @@ import fs from "fs";
 import path from "path";
 
 import { logger } from "../utils/logger";
+import { isAsiAirDirectoryF } from "../utils/utils";
 
-export const dropThumbnails = (
-  dir: string,
-  isRecursiveCall: boolean = false,
-) => {
+const clear = (dir: string) => {
+  if (!isAsiAirDirectoryF(dir).isAsiAirDirectory) {
+    logger.errorThrow("Not an ASIAIR directory!");
+  }
+
+  dropThumbnails(dir);
+  dropEmptyDirectories(dir);
+};
+
+export default clear;
+
+const dropThumbnails = (dir: string, isRecursiveCall: boolean = false) => {
   // Default parameter set to current directory
   const files = fs.readdirSync(dir);
   files.forEach(file => {
@@ -30,7 +39,7 @@ export const dropThumbnails = (
     logger.info("Asiair dump cleaning - Thumbnails deleted ✅");
 };
 
-export const dropEmptyDirectories = (dir: string) => {
+const dropEmptyDirectories = (dir: string) => {
   const isDirEmpty = (directory: string): boolean => {
     const files = fs.readdirSync(directory);
     if (files.length === 0) {

src/commands/prepare.ts

@@ -8,6 +8,7 @@
   getFitsFromDirectory,
   matchSetFile,
   getImageSpecFromSetName,
+  isAsiAirDirectoryF,
 } from "../utils/utils";
 import {
   FileImageSpec,
@@ -173,12 +174,8 @@
   projectDirectory: string,
 ): Promise<FileImageSpec[]> => {
   // if ASIAIR used, may stores the lights+flats files in either the Autorun or Plan directories.
-
-  const autorunDirectory = `${inputDirectory}/Autorun`;
-  const planDirectory = `${inputDirectory}/Plan`;
-
-  const isAsiAirDump =
-    fs.existsSync(autorunDirectory) || fs.existsSync(planDirectory);
+  const { isAsiAirDirectory, autorunDirectory, planDirectory } =
+    isAsiAirDirectoryF(inputDirectory);
 
   const logFiles = (files: unknown[]) => {
     logger.info(`Found ${files.length} FITS in input dir ${inputDirectory}.`);
@@ -188,7 +185,7 @@
     logger.errorThrow(`Input directory ${inputDirectory} does not exists.`);
   }
 
-  if (!isAsiAirDump) {
+  if (!isAsiAirDirectory) {
     const allFiles = getFitsFromDirectory({
       directory: inputDirectory,
       projectDirectory,
@@ -205,16 +202,16 @@
 
   const autorunFiles = fs.existsSync(autorunDirectory)
     ? getFitsFromDirectory({
         directory: autorunDirectory,
         projectDirectory,
       })
     : [];
 
   const planFiles = fs.existsSync(planDirectory)
     ? getFitsFromDirectory({
         directory: planDirectory,
         projectDirectory,
       })
     : [];
 
   if (autorunFiles.length === 0 && planFiles.length === 0) {
@@ -474,12 +471,12 @@
   for (const lightsFlatsMatch of lightsFlatsMatches) {
     const lights = lightsFlatsMatch.isManualMatch
       ? allLights.filter(
           light =>
             light.sequenceId === lightsFlatsMatch.lightSequenceId &&
             light.setName === lightsFlatsMatch.lightSetName,
         )
       : allLights.filter(
           light => light.setName === lightsFlatsMatch.lightSetName,
         );
     if (!lights) {
       throw new Error(

src/poto-siril.ts

@@ -1,6 +1,6 @@
 import { Command } from "commander";
 import prepare, { PrepareProps } from "./commands/prepare";
-import { dropThumbnails, dropEmptyDirectories } from "./commands/clear";
+import clear from "./commands/clear";
 import { generateScripts } from "./commands/preprocess.generate-scripts";
 import { runScripts } from "./commands/preprocess.exec-scripts";
 import { POTO_VERSION } from "./utils/const";
@@ -20,8 +20,7 @@ program
   .argument("<path>", "directory to clear")
   .allowExcessArguments(false)
   .action(directory => {
-    dropThumbnails(directory);
-    dropEmptyDirectories(directory);
+    clear(directory);
   });
 
 program

src/tests/e2e/__snapshots__/e2e-testing.spec.ts.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`E2E No Darks/Biases matching, multiples sequences should warn if no matching darks and biases 2`] = `
+exports[`E2E no Darks/Biases matching, multiples sequences should warn if no matching darks and biases 2`] = `
 "{
   "generatedAt": "2024-10-15T00:00:00.000Z",
   "potoVersion": "poto-siril 0.5.0",
@@ -543,7 +543,7 @@ exports[`E2E No Darks/Biases matching, multiples sequences should warn if no mat
 }"
 `;
 
-exports[`E2E No Darks/Biases matching, multiples sequences should warn if no matching darks and biases 3`] = `
+exports[`E2E no Darks/Biases matching, multiples sequences should warn if no matching darks and biases 3`] = `
 [
   "prompt: [
   {
@@ -2004,6 +2004,8 @@ exports[`E2E should be neat 8`] = `
   "debug: Deleted: tmp/asiair-dump-1/Autorun/Flat/Flat_1.0ms_Bin1_H_gain100_20240511-094307_-10.5C_0002_thn.jpg",
   "debug: Deleted: tmp/asiair-dump-1/Autorun/Flat/Flat_1.0ms_Bin1_H_gain100_20240511-094308_-10.5C_0003_thn.jpg",
   "info: Asiair dump cleaning - Thumbnails deleted ✅",
+  "info: Asiair dump cleaning - Empty dirs deleted ✅",
+  "info: Asiair dump cleaning - Thumbnails deleted ✅",
   "info: Deleted: tmp/asiair-dump-1/empty/empty",
   "info: Deleted: tmp/asiair-dump-1/empty",
   "info: Asiair dump cleaning - Empty dirs deleted ✅",

src/tests/e2e/e2e-testing.spec.ts

@@ -7,7 +7,7 @@ import prepare, {
   SelectedInputSubDirectoryChoices,
 } from "../../commands/prepare";
 import { POTO_JSON } from "../../utils/const";
-import { dropThumbnails, dropEmptyDirectories } from "../../commands/clear";
+import clear from "../../commands/clear";
 import { generateScripts } from "../../commands/preprocess.generate-scripts";
 import {
   getRealDataFromSample,
@@ -119,7 +119,7 @@ describe("E2E", () => {
     });
     expect(files.filter(f => f.endsWith("_thn.jpg"))).toHaveLength(3);
 
-    dropThumbnails(asiAirDirectory);
+    clear(asiAirDirectory);
 
     files = fs.readdirSync(asiAirDirectory, {
       recursive: true,
@@ -137,7 +137,7 @@ describe("E2E", () => {
       true,
     );
 
-    dropEmptyDirectories(asiAirDirectory);
+    clear(asiAirDirectory);
 
     expect(fs.existsSync(path.join(asiAirDirectory, "empty", "empty"))).toBe(
       false,
@@ -447,7 +447,7 @@ describe("E2E", () => {
     });
   });
 
-  describe("No Darks/Biases matching, multiples sequences", () => {
+  describe("no Darks/Biases matching, multiples sequences", () => {
     it("should warn if no matching darks and biases", async () => {
       promptMock
         .mockResolvedValueOnce({
@@ -806,4 +806,10 @@ describe("E2E", () => {
       expect(logMessages).toContain(logAfterTheCheckDirectory);
     });
   });
+
+  describe("clear function tests", () => {
+    it("should throw not asiair directory", async () => {
+      expect(() => clear(bankDirectory)).toThrow("Not an ASIAIR directory!");
+    });
+  });
 });

src/tests/fixtures.ts

@@ -1,7 +1,7 @@
 import path from "path";
 import fs from "fs";
 import { logger } from "../utils/logger";
-import { imageType } from "src/utils/types";
+import { imageType } from "../utils/types";
 
 const tmpDir = "tmp";
 

src/utils/utils.ts

@@ -271,3 +271,24 @@ export const getImageSpecFromSetName = (setName: string): ImageSpec => {
         gain: Number(setName.split("_")[3].replace("gain", "")),
       } as ImageSpec);
 };
+
+/**
+ * Detect if ASIAIR directory structure is present.
+ */
+export const isAsiAirDirectoryF = (
+  directory: string,
+): {
+  isAsiAirDirectory: boolean;
+  autorunDirectory: string;
+  planDirectory: string;
+} => {
+  const autorunDirectory = `${directory}/Autorun`;
+  const planDirectory = `${directory}/Plan`;
+
+  return {
+    isAsiAirDirectory:
+      fs.existsSync(autorunDirectory) || fs.existsSync(planDirectory),
+    autorunDirectory,
+    planDirectory,
+  };
+};