♻️ Refactor: Strongly-type error constants (#421)

* ♻️ Refactor: strongly-type AuthErrors

* ♻️ Refactor: strongly-type DbErrors

* ♻️ Refactor: strongly-type EventErrors

* ♻️ Refactor: strongly-type Gcal and GenericErrors

* ♻️ Refactor: strongly-type Gcal and SyncErrors

* ♻️ Refactor: strongly-type Gcal and SocketErrors

* ♻️ Refactor: strongly-type UserErrors

* 🐛 Fix: gcal.service import

* 🧹 Chore: add @ts-expect-error to express.server middleware

Author: tyler-dane

packages/backend/src/auth/controllers/auth.controller.test.ts

@@ -2,7 +2,7 @@ import { ObjectId } from "mongodb";
 import { WithId } from "mongodb";
 import { gCalendar } from "@core/types/gcal";
 import { Schema_User } from "@core/types/user.types";
-import { SyncError } from "@backend/common/constants/error.constants";
+import { SyncError } from "@backend/common/errors/sync/sync.errors";
 import mongoService from "@backend/common/services/mongo.service";
 import syncService from "@backend/sync/services/sync.service";
 import userService from "@backend/user/services/user.service";

packages/backend/src/auth/controllers/auth.controller.ts

@@ -18,11 +18,9 @@ import compassAuthService from "@backend/auth/services/compass.auth.service";
 import GoogleAuthService, {
   getGAuthClientForUser,
 } from "@backend/auth/services/google.auth.service";
-import {
-  GcalError,
-  SyncError,
-} from "@backend/common/constants/error.constants";
 import { error } from "@backend/common/errors/handlers/error.handler";
+import { GcalError } from "@backend/common/errors/integration/gcal/gcal.errors";
+import { SyncError } from "@backend/common/errors/sync/sync.errors";
 import { isInvalidGoogleToken } from "@backend/common/services/gcal/gcal.utils";
 import {
   ReqBody,

packages/backend/src/auth/middleware/auth.middleware.ts

@@ -1,11 +1,9 @@
 import { NextFunction, Request, Response } from "express";
 import { Status } from "@core/errors/status.codes";
 import { ENV, IS_DEV } from "@backend/common/constants/env.constants";
-import {
-  AuthError,
-  GcalError,
-} from "@backend/common/constants/error.constants";
+import { AuthError } from "@backend/common/errors/auth/auth.errors";
 import { error } from "@backend/common/errors/handlers/error.handler";
+import { GcalError } from "@backend/common/errors/integration/gcal/gcal.errors";
 import { SReqBody } from "@backend/common/types/express.types";
 import { hasGoogleHeaders } from "@backend/sync/util/sync.util";
 

packages/backend/src/auth/services/auth.utils.ts

@@ -1,6 +1,6 @@
 import { Credentials } from "google-auth-library";
 import GoogleAuthService from "@backend/auth/services/google.auth.service";
-import { AuthError } from "@backend/common/constants/error.constants";
+import { AuthError } from "@backend/common/errors/auth/auth.errors";
 import { error } from "@backend/common/errors/handlers/error.handler";
 
 export const initGoogleClient = async (

packages/backend/src/auth/services/compass.auth.service.ts

@@ -1,6 +1,6 @@
 import Session from "supertokens-node/recipe/session";
-import { SyncError } from "@backend/common/constants/error.constants";
 import { error } from "@backend/common/errors/handlers/error.handler";
+import { SyncError } from "@backend/common/errors/sync/sync.errors";
 import { getSync } from "@backend/sync/util/sync.queries";
 import { canDoIncrementalSync } from "@backend/sync/util/sync.util";
 import { findCompassUserBy } from "@backend/user/queries/user.queries";

packages/backend/src/auth/services/google.auth.service.ts

@@ -8,11 +8,9 @@ import { UserInfo_Google } from "@core/types/auth.types";
 import { gCalendar } from "@core/types/gcal";
 import { Schema_User } from "@core/types/user.types";
 import { ENV } from "@backend/common/constants/env.constants";
-import {
-  AuthError,
-  UserError,
-} from "@backend/common/constants/error.constants";
+import { AuthError } from "@backend/common/errors/auth/auth.errors";
 import { error } from "@backend/common/errors/handlers/error.handler";
+import { UserError } from "@backend/common/errors/user/user.errors";
 import { findCompassUserBy } from "@backend/user/queries/user.queries";
 import compassAuthService from "./compass.auth.service";
 

packages/backend/src/calendar/controllers/calendar.controller.ts

@@ -2,7 +2,7 @@ import { SessionRequest } from "supertokens-node/framework/express";
 import { Schema_CalendarList } from "@core/types/calendar.types";
 import { getGcalClient } from "@backend/auth/services/google.auth.service";
 import calendarService from "@backend/calendar/services/calendar.service";
-import { AuthError } from "@backend/common/constants/error.constants";
+import { AuthError } from "@backend/common/errors/auth/auth.errors";
 import { error } from "@backend/common/errors/handlers/error.handler";
 import gcalService from "@backend/common/services/gcal/gcal.service";
 import { Res_Promise } from "@backend/common/types/express.types";

packages/backend/src/common/constants/error.constants.ts

@@ -0,0 +1,38 @@
+import { Status } from "@core/errors/status.codes";
+import { ErrorMetadata } from "@backend/common/types/error.types";
+
+interface AuthErrors {
+  DevOnly: ErrorMetadata;
+  InadequatePermissions: ErrorMetadata;
+  MissingRefreshToken: ErrorMetadata;
+  NoUserId: ErrorMetadata;
+  NoGAuthAccessToken: ErrorMetadata;
+}
+
+export const AuthError: AuthErrors = {
+  DevOnly: {
+    description: "Only available during development",
+    status: Status.FORBIDDEN,
+    isOperational: true,
+  },
+  InadequatePermissions: {
+    description: "You don't have permission to do that",
+    status: Status.FORBIDDEN,
+    isOperational: true,
+  },
+  MissingRefreshToken: {
+    description: "No refresh token",
+    status: Status.BAD_REQUEST,
+    isOperational: true,
+  },
+  NoUserId: {
+    description: "Compass user was not created",
+    status: Status.INTERNAL_SERVER,
+    isOperational: false,
+  },
+  NoGAuthAccessToken: {
+    description: "No gauth access token",
+    status: Status.BAD_REQUEST,
+    isOperational: true,
+  },
+};

packages/backend/src/common/errors/auth/auth.errors.ts

@@ -0,0 +1,13 @@
+import { Status } from "@core/errors/status.codes";
+import { ErrorMetadata } from "@backend/common/types/error.types";
+
+interface DbErrors {
+  InvalidId: ErrorMetadata;
+}
+export const DbError: DbErrors = {
+  InvalidId: {
+    description: "id is invalid (according to Mongo)",
+    status: Status.BAD_REQUEST,
+    isOperational: true,
+  },
+};