feat(auth): throw Error when auth type is not a valid one (#249)

octokit · Feb 3, 2021 · ffaefb5 · ffaefb5
1 parent f008655
commit ffaefb5
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 7 deletions.
diff --git a/src/auth.ts b/src/auth.ts
@@ -7,13 +7,16 @@ export async function auth(
   state: State,
   options: AuthOptions
 ): Promise<Authentication> {
-  if (options.type === "app") {
-    return getAppAuthentication(state);
-  }
+  const { type } = options;
 
-  if (options.type === "installation") {
-    return getInstallationAuthentication(state, options);
+  switch (type) {
+    case "app":
+      return getAppAuthentication(state);
+    case "installation":
+      return getInstallationAuthentication(state, options);
+    case "oauth":
+      return getOAuthAuthentication(state, options);
+    default:
+      throw new Error(`Invalid auth type: ${type}`);
   }
-
-  return getOAuthAuthentication(state, options);
 }
diff --git a/test/index.test.ts b/test/index.test.ts
@@ -58,6 +58,19 @@ test("README example for app auth", async () => {
   });
 });
 
+test("throws if invalid 'type' is provided", async () => {
+  const auth = createAppAuth({
+    appId: APP_ID,
+    privateKey: PRIVATE_KEY,
+  });
+
+  // @ts-expect-error TS2322
+  // Details here: https://github.com/octokit/auth-app.js/issues/216#issuecomment-772106164
+  await expect(auth({ type: "app2" })).rejects.toEqual(
+    new Error("Invalid auth type: app2")
+  );
+});
+
 test("README example for installation auth", async () => {
   const matchCreateInstallationAccessToken: MockMatcherFunction = (
     url,