add error handling to core cli (#40)

hiroki0525 · Nov 5, 2023 · a3744db · a3744db
1 parent 6d2d216
commit a3744db
Show file tree

Hide file tree

Showing 5 changed files with 144 additions and 35 deletions.
diff --git a/.changeset/wild-cups-stare.md b/.changeset/wild-cups-stare.md
@@ -0,0 +1,6 @@
+---
+"@dandori/core": patch
+"@dandori/cli": patch
+---
+
+add error handling to core cli
diff --git a/packages/cli/src/core/__tests__/index.test.ts b/packages/cli/src/core/__tests__/index.test.ts
@@ -13,7 +13,9 @@ import DandoriCoreCli from "../index";
 import generateDandoriTasks, {
   ChatGPTFunctionCallModel,
   DandoriTask,
+  OptionalTaskPropsOption,
 } from "@dandori/core";
+import { logger } from "@dandori/libs";
 
 const tasks: DandoriTask[] = [
   {
@@ -31,6 +33,7 @@ vi.mock("@dandori/core", () => ({
 
 describe("DandoriCoreCli", () => {
   const mockConsole = vi.spyOn(console, "log").mockImplementation(() => {});
+  const mockLogError = vi.spyOn(logger, "error").mockImplementation(() => {});
   const inputFileName = "DandoriCoreCli.txt";
   const inputFileText = "DandoriCoreCli";
   const loadProcessArgv = (options: string[]) => {
@@ -68,18 +71,49 @@ describe("DandoriCoreCli", () => {
   });
 
   describe("with -m option", () => {
-    const model: ChatGPTFunctionCallModel = "gpt-4-0613";
+    describe("valid argument", () => {
+      const model: ChatGPTFunctionCallModel = "gpt-4-0613";
 
-    beforeEach(async () => {
-      loadProcessArgv(["-m", model]);
-      await new DandoriCoreCli().run();
+      beforeEach(async () => {
+        loadProcessArgv(["-m", model]);
+        await new DandoriCoreCli().run();
+      });
+
+      it("call generateDandoriTasks with valid model", () => {
+        expect(generateDandoriTasks).toHaveBeenCalledWith(inputFileText, {
+          envFilePath: undefined,
+          chatGPTModel: model,
+          optionalTaskProps: undefined,
+        });
+      });
     });
 
-    it("call generateDandoriTasks with envFilePath", () => {
-      expect(generateDandoriTasks).toHaveBeenCalledWith(inputFileText, {
-        envFilePath: undefined,
-        chatGPTModel: model,
-        optionalTaskProps: undefined,
+    describe("invalid argument", () => {
+      const model = "invalid-model";
+      const supportedChatGPTModels: ChatGPTFunctionCallModel[] = [
+        "gpt-3.5-turbo-0613",
+        "gpt-4-0613",
+      ];
+      const expectedMessage = `Unsupported model: ${model}. Supported models are ${supportedChatGPTModels.join(
+        ", ",
+      )}`;
+
+      beforeEach(() => {
+        loadProcessArgv(["-m", model]);
+      });
+
+      it("throw Error with valid message", async () => {
+        await expect(new DandoriCoreCli().run()).rejects.toThrow(
+          expectedMessage,
+        );
+      });
+
+      it("call logger.error with valid message", async () => {
+        try {
+          await new DandoriCoreCli().run();
+        } catch {
+          expect(mockLogError).toHaveBeenCalledWith(expectedMessage);
+        }
       });
     });
   });
@@ -102,18 +136,51 @@ describe("DandoriCoreCli", () => {
   });
 
   describe("with -o option", () => {
-    const optionalTaskProps = "deadline,description";
+    describe("valid argument", () => {
+      const optionalTaskProps = "deadline,description";
 
-    beforeEach(async () => {
-      loadProcessArgv(["-o", optionalTaskProps]);
-      await new DandoriCoreCli().run();
+      beforeEach(async () => {
+        loadProcessArgv(["-o", optionalTaskProps]);
+        await new DandoriCoreCli().run();
+      });
+
+      it("call generateDandoriTasks with valid optionalTaskProps", () => {
+        expect(generateDandoriTasks).toHaveBeenCalledWith(inputFileText, {
+          envFilePath: undefined,
+          chatGPTModel: undefined,
+          optionalTaskProps: optionalTaskProps.split(","),
+        });
+      });
     });
 
-    it("call generateDandoriTasks with envFilePath", () => {
-      expect(generateDandoriTasks).toHaveBeenCalledWith(inputFileText, {
-        envFilePath: undefined,
-        chatGPTModel: undefined,
-        optionalTaskProps: optionalTaskProps.split(","),
+    describe("invalid argument", () => {
+      const optionalTaskProps = "invalid";
+      const supportedOptionalTaskProps: OptionalTaskPropsOption = [
+        "description",
+        "deadline",
+        "assignee",
+        "all",
+      ];
+      const expectedMessage = `Unsupported optional task props: ${optionalTaskProps}. Supported optional task props are ${supportedOptionalTaskProps.join(
+        ", ",
+      )}`;
+
+      beforeEach(() => {
+        loadProcessArgv(["-o", optionalTaskProps]);
+      });
+
+      it("throw Error with valid message", async () => {
+        await expect(new DandoriCoreCli().run()).rejects.toThrow(
+          expectedMessage,
+        );
+      });
+
+      it("call logger.error with valid message", async () => {
+        try {
+          await new DandoriCoreCli().run();
+        } catch {
+          expect(mockLogError).toHaveBeenCalledWith(expectedMessage);
+        }
       });
     });
   });

diff --git a/packages/cli/src/core/index.ts b/packages/cli/src/core/index.ts
@@ -4,10 +4,37 @@ import chalk from "chalk";
 import generateDandoriTasks, {
   ChatGPTFunctionCallModel,
   DandoriTask,
+  OptionalTaskProps,
   OptionalTaskPropsOption,
 } from "@dandori/core";
 import { readFile } from "fs/promises";
-import { loadFile } from "@dandori/libs";
+import { loadFile, logger } from "@dandori/libs";
+
+const supportedChatGPTModels: ChatGPTFunctionCallModel[] = [
+  "gpt-3.5-turbo-0613",
+  "gpt-4-0613",
+];
+
+const isSupportedChatGPTModels = (
+  model?: string,
+): model is ChatGPTFunctionCallModel | undefined =>
+  model === undefined ||
+  supportedChatGPTModels.includes(model as ChatGPTFunctionCallModel);
+
+const supportedOptionalTaskProps: OptionalTaskPropsOption = [
+  "description",
+  "deadline",
+  "assignee",
+  "all",
+];
+
+const isSupportedOptionalTaskProps = (
+  props?: string[],
+): props is OptionalTaskPropsOption | undefined =>
+  props === undefined ||
+  props.every((prop) =>
+    supportedOptionalTaskProps.includes(prop as OptionalTaskProps),
+  );
 
 export default class DandoriCoreCli {
   private inputFile: string = "";
@@ -48,15 +75,27 @@ export default class DandoriCoreCli {
     const { envFile, optionalTaskProps, model } = this.program.opts<{
       envFile?: string;
       optionalTaskProps?: string;
-      model?: ChatGPTFunctionCallModel;
+      model?: string;
     }>();
-    // TODO: Error Handling of invalid options
+    if (!isSupportedChatGPTModels(model)) {
+      const logMessage = `Unsupported model: ${model}. Supported models are ${supportedChatGPTModels.join(
+        ", ",
+      )}`;
+      logger.error(logMessage);
+      throw new Error(logMessage);
+    }
+    const inputOptionalTaskProps = optionalTaskProps?.split(",");
+    if (!isSupportedOptionalTaskProps(inputOptionalTaskProps)) {
+      const logMessage = `Unsupported optional task props: ${optionalTaskProps}. Supported optional task props are ${supportedOptionalTaskProps.join(
+        ", ",
+      )}`;
+      logger.error(logMessage);
+      throw new Error(logMessage);
+    }
     return generateDandoriTasks(source.toString(), {
       envFilePath: envFile,
       chatGPTModel: model,
-      optionalTaskProps: optionalTaskProps?.split(
-        ",",
-      ) as OptionalTaskPropsOption,
+      optionalTaskProps: inputOptionalTaskProps,
     });
   }
 }
diff --git a/packages/core/src/__tests__/index.test.ts b/packages/core/src/__tests__/index.test.ts
@@ -3,7 +3,7 @@ import generateDandoriTasks, {
   DandoriTaskOptionalProperty,
   DandoriTaskProperty,
   DandoriTaskRequiredProperty,
-  OptionalAllDandoriTaskPropertiesName,
+  DandoriTaskOptionalAllProperty,
 } from "../index";
 import { describe, beforeEach, afterEach, it, vi, expect, Mock } from "vitest";
 import OpenAI from "openai";
@@ -217,9 +217,7 @@ describe("generateDandoriTasks", () => {
 
       describe("with all argument", () => {
         const source = "with all argument";
-        const optionalTaskProps: OptionalAllDandoriTaskPropertiesName[] = [
-          "all",
-        ];
+        const optionalTaskProps: DandoriTaskOptionalAllProperty[] = ["all"];
 
         beforeEach(async () => {
           result = await generateDandoriTasks(source, {

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -31,17 +31,16 @@ export type DandoriTaskOptionalProperty = Exclude<
   DandoriTaskRequiredProperty
 >;
 
-export type OptionalAllDandoriTaskPropertiesName = "all";
-const optionalAllDandoriTaskPropertiesName: OptionalAllDandoriTaskPropertiesName =
-  "all";
-export type OptionalTaskPropsOption = (
+export type DandoriTaskOptionalAllProperty = "all";
+const dandoriTaskOptionalAllProperty: DandoriTaskOptionalAllProperty = "all";
+export type OptionalTaskProps =
   | DandoriTaskOptionalProperty
-  | OptionalAllDandoriTaskPropertiesName
-)[];
+  | DandoriTaskOptionalAllProperty;
+export type OptionalTaskPropsOption = OptionalTaskProps[];
 const notIncludeAdditionalAllPropsName = (
   props: OptionalTaskPropsOption,
 ): props is DandoriTaskOptionalProperty[] =>
-  !props.includes(optionalAllDandoriTaskPropertiesName);
+  !props.includes(dandoriTaskOptionalAllProperty);
 
 export type GenerateDandoriTasksOptions = {
   chatGPTModel?: ChatGPTFunctionCallModel;