feat: Improve Logger.error and fatal, return error (#48)

Co-authored-by: pike <pike@SilverAir>
commonpike · Dec 3, 2023 · 3aa598f · 3aa598f
1 parent c67d60a
commit 3aa598f
Show file tree

Hide file tree

Showing 16 changed files with 159 additions and 179 deletions.
diff --git a/src/auth/FacebookAuth.ts b/src/auth/FacebookAuth.ts
@@ -1,5 +1,5 @@
-import OAuth2Client from "./OAuth2Client";
 import Logger from "../services/Logger";
+import OAuth2Client from "./OAuth2Client";
 import Storage from "../services/Storage";
 
 export default class FacebookAuth extends OAuth2Client {
@@ -51,18 +51,15 @@ export default class FacebookAuth extends OAuth2Client {
     const result = await this.requestRemotePermissions("Facebook", url.href);
     if (result["error"]) {
       const msg = result["error_reason"] + " - " + result["error_description"];
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
     if (result["state"] !== state) {
       const msg = "Response state does not match request state";
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
     if (!result["code"]) {
       const msg = "Remote response did not return a code";
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
     return result["code"] as string;
   }
@@ -83,8 +80,7 @@ export default class FacebookAuth extends OAuth2Client {
 
     if (!result["access_token"]) {
       const msg = "Remote response did not return a access_token";
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
 
     return result["access_token"];
@@ -129,9 +125,9 @@ export default class FacebookAuth extends OAuth2Client {
     ];
 
     if (!llPageAccessToken) {
-      console.error(data);
-      throw new Error(
+      throw Logger.error(
         "No llPageAccessToken for page " + pageId + "  in response.",
+        data,
       );
     }
 
@@ -160,8 +156,10 @@ export default class FacebookAuth extends OAuth2Client {
       access_token: string;
     };
     if (!data["access_token"]) {
-      console.error(data);
-      throw new Error("No llUserAccessToken access_token in response.");
+      throw Logger.error(
+        "No llUserAccessToken access_token in response.",
+        data,
+      );
     }
 
     return data["access_token"];
@@ -182,8 +180,7 @@ export default class FacebookAuth extends OAuth2Client {
       name: string;
     };
     if (!data["id"]) {
-      console.error(data);
-      throw new Error("Can not get app scoped user id.");
+      throw Logger.error("Can not get app scoped user id.", data);
     }
     return data["id"];
   }
@@ -221,8 +218,11 @@ export default class FacebookAuth extends OAuth2Client {
    */
   private async handleApiResponse(response: Response): Promise<object> {
     if (!response.ok) {
-      Logger.error("FacebookAuth.handleApiResponse", response);
-      throw new Error(response.status + ":" + response.statusText);
+      throw Logger.error(
+        "FacebookAuth.handleApiResponse",
+        response.status + ":" + response.statusText,
+        response,
+      );
     }
     const data = await response.json();
     if (data.error) {
@@ -236,8 +236,7 @@ export default class FacebookAuth extends OAuth2Client {
         data.error.error_subcode +
         ") " +
         data.error.message;
-      Logger.error("FacebookAuth.handleApiResponse", error);
-      throw new Error(error);
+      throw Logger.error("FacebookAuth.handleApiResponse", error);
     }
     Logger.trace("FacebookAuth.handleApiResponse", "success");
     return data;
@@ -248,7 +247,6 @@ export default class FacebookAuth extends OAuth2Client {
    * @param error - the error returned from fetch
    */
   private handleApiError(error: Error): never {
-    Logger.error("FacebookAuth.handleApiError", error);
-    throw error;
+    throw Logger.error("FacebookAuth.handleApiError", error);
   }
 }
diff --git a/src/auth/InstagramAuth.ts b/src/auth/InstagramAuth.ts
@@ -52,18 +52,15 @@ export default class InstagramAuth extends FacebookAuth {
 
     if (result["error"]) {
       const msg = result["error_reason"] + " - " + result["error_description"];
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
     if (result["state"] !== state) {
       const msg = "Response state does not match request state";
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
     if (!result["code"]) {
       const msg = "Remote response did not return a code";
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
     return result["code"] as string;
   }

diff --git a/src/auth/LinkedInAuth.ts b/src/auth/LinkedInAuth.ts
@@ -1,5 +1,5 @@
-import OAuth2Client from "./OAuth2Client";
 import Logger from "../services/Logger";
+import OAuth2Client from "./OAuth2Client";
 import Storage from "../services/Storage";
 
 export default class LinkedInAuth extends OAuth2Client {
@@ -41,8 +41,7 @@ export default class LinkedInAuth extends OAuth2Client {
 
     if (!result["access_token"]) {
       const msg = "Remote response did not return a access_token";
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
     this.accessToken = result["access_token"];
     // now store it
@@ -74,18 +73,15 @@ export default class LinkedInAuth extends OAuth2Client {
     const result = await this.requestRemotePermissions("LinkedIn", url.href);
     if (result["error"]) {
       const msg = result["error_reason"] + " - " + result["error_description"];
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
     if (result["state"] !== state) {
       const msg = "Response state does not match request state";
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
     if (!result["code"]) {
       const msg = "Remote response did not return a code";
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
     return result["code"] as string;
   }
@@ -117,8 +113,7 @@ export default class LinkedInAuth extends OAuth2Client {
 
     if (!result["access_token"]) {
       const msg = "Remote response did not return a access_token";
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
 
     return result;
@@ -156,10 +151,11 @@ export default class LinkedInAuth extends OAuth2Client {
    */
   private async handleApiResponse(response: Response): Promise<object> {
     if (!response.ok) {
-      Logger.error("LinkedInAuth.handleApiResponse", "not ok");
-      Logger.error("LinkedInAuth.handleApiResponse", await response.json());
-      throw new Error(
+      Logger.warn("LinkedInAuth.handleApiResponse", "not ok");
+      throw Logger.error(
+        "LinkedInAuth.handleApiResponse",
         response.url + ":" + response.status + ", " + response.statusText,
+        await response.json(),
       );
     }
     const data = await response.json();
@@ -174,8 +170,7 @@ export default class LinkedInAuth extends OAuth2Client {
         data.error.error_subcode +
         ") " +
         data.error.message;
-      Logger.error("LinkedInAuth.handleApiResponse", error);
-      throw new Error(error);
+      throw Logger.error("LinkedInAuth.handleApiResponse", error);
     }
     Logger.trace("LinkedInAuth.handleApiResponse", "success");
     return data;

diff --git a/src/auth/RedditAuth.ts b/src/auth/RedditAuth.ts
@@ -1,5 +1,5 @@
-import OAuth2Client from "./OAuth2Client";
 import Logger from "../services/Logger";
+import OAuth2Client from "./OAuth2Client";
 import Storage from "../services/Storage";
 
 export default class RedditAuth extends OAuth2Client {
@@ -38,8 +38,7 @@ export default class RedditAuth extends OAuth2Client {
 
     if (!result["access_token"]) {
       const msg = "Remote response did not return a access_token";
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
     this.accessToken = result["access_token"];
     return this.accessToken;
@@ -66,18 +65,15 @@ export default class RedditAuth extends OAuth2Client {
     const result = await this.requestRemotePermissions("Reddit", url.href);
     if (result["error"]) {
       const msg = result["error_reason"] + " - " + result["error_description"];
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
     if (result["state"] !== state) {
       const msg = "Response state does not match request state";
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
     if (!result["code"]) {
       const msg = "Remote response did not return a code";
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
     return result["code"] as string;
   }
@@ -106,8 +102,7 @@ export default class RedditAuth extends OAuth2Client {
 
     if (!result["access_token"]) {
       const msg = "Remote response did not return a access_token";
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
 
     return result;
@@ -153,8 +148,11 @@ export default class RedditAuth extends OAuth2Client {
    */
   private async handleApiResponse(response: Response): Promise<object> {
     if (!response.ok) {
-      Logger.error("RedditAuth.handleApiResponse", "not ok");
-      throw new Error(response.status + ":" + response.statusText);
+      throw Logger.error(
+        "RedditAuth.handleApiResponse",
+        "not ok",
+        response.status + ":" + response.statusText,
+      );
     }
     const data = await response.json();
     if (data.error) {
@@ -168,8 +166,7 @@ export default class RedditAuth extends OAuth2Client {
         data.error.error_subcode +
         ") " +
         data.error.message;
-      Logger.error("RedditAuth.handleApiResponse", error);
-      throw new Error(error);
+      throw Logger.error("RedditAuth.handleApiResponse", error);
     }
     Logger.trace("RedditAuth.handleApiResponse", "success");
     return data;
@@ -180,7 +177,6 @@ export default class RedditAuth extends OAuth2Client {
    * @param error - the error returned from fetch
    */
   private handleApiError(error: Error): never {
-    Logger.error("RedditAuth.handleApiError", error);
-    throw error;
+    throw Logger.error("RedditAuth.handleApiError", error);
   }
 }
diff --git a/src/auth/TwitterAuth.ts b/src/auth/TwitterAuth.ts
@@ -1,8 +1,7 @@
-import { TwitterApi } from "twitter-api-v2";
-
-import OAuth2Client from "./OAuth2Client";
 import Logger from "../services/Logger";
+import OAuth2Client from "./OAuth2Client";
 import Storage from "../services/Storage";
+import { TwitterApi } from "twitter-api-v2";
 
 export default class TwitterAuth extends OAuth2Client {
   async setup() {
@@ -31,18 +30,15 @@ export default class TwitterAuth extends OAuth2Client {
     const result = await this.requestRemotePermissions("Twitter", url);
     if (result["error"]) {
       const msg = result["error_reason"] + " - " + result["error_description"];
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
     if (result["state"] !== state) {
       const msg = "Response state does not match request state";
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
     if (!result["code"]) {
       const msg = "Remote response did not return a code";
-      Logger.error(msg, result);
-      throw new Error(msg);
+      throw Logger.error(msg, result);
     }
 
     const tokens = await client.loginWithOAuth2({
@@ -51,7 +47,7 @@ export default class TwitterAuth extends OAuth2Client {
       redirectUri: this.getCallbackUrl(),
     });
     if (!tokens["accessToken"]) {
-      throw new Error("An accessToken was not returned");
+      throw Logger.error("An accessToken was not returned");
     }
 
     return tokens;

diff --git a/src/models/Feed.ts b/src/models/Feed.ts
@@ -97,7 +97,7 @@ export default class Feed {
     Logger.trace("Feed", "getPlatform", platformId);
     const platform = this.platforms[platformId];
     if (!platform) {
-      throw new Error("Unknown platform: " + platformId);
+      throw Logger.error("Unknown platform: " + platformId);
     }
     return platform;
   }
@@ -285,10 +285,10 @@ export default class Feed {
     Logger.trace("Feed", "schedulePost", path, platformId, date);
     const post = this.getPost(path, platformId);
     if (!post.valid) {
-      throw new Error("Post is not valid");
+      throw Logger.error("Post is not valid");
     }
     if (post.status !== PostStatus.UNSCHEDULED) {
-      throw new Error("Post is not unscheduled");
+      throw Logger.error("Post is not unscheduled");
     }
     post.schedule(date);
     return post;
@@ -319,10 +319,10 @@ export default class Feed {
       for (const folder of folders) {
         const post = platform.getPost(folder);
         if (!post.valid) {
-          throw new Error("Post is not valid");
+          throw Logger.error("Post is not valid");
         }
         if (post.status !== PostStatus.UNSCHEDULED) {
-          throw new Error("Post is not unscheduled");
+          throw Logger.error("Post is not unscheduled");
         }
         post.schedule(date);
         posts.push(post);
@@ -356,7 +356,7 @@ export default class Feed {
       Logger.info("Posting", platformId, path);
       await platform.publishPost(post, dryrun);
     } else {
-      throw new Error("Post is not valid");
+      throw Logger.error("Post is not valid");
     }
     return post;
   }

diff --git a/src/models/Platform.ts b/src/models/Platform.ts
@@ -159,7 +159,7 @@ export default class Platform {
    * @returns - any object
    */
   async setup() {
-    throw new Error(
+    throw Logger.error(
       "No setup implemented for " +
         this.id +
         ". Read the docs in the docs folder.",