feat: error logging

api/package.json

@@ -21,12 +21,13 @@
     "body-parser": "^1.20.2",
     "cookie-parser": "^1.4.6",
     "cors": "^2.8.5",
-    "document-drive": "1.0.0-alpha.24",
+    "document-drive": "1.0.0-alpha.25",
     "document-model": "^1.0.35",
     "document-model-libs": "^1.17.1",
     "dotenv": "^16.4.5",
     "ethers": "^5.7.2",
     "express": "^4.19.2",
+    "express-async-errors": "^3.1.1",
     "graphql": "^16.8.1",
     "graphql-middleware": "^6.1.35",
     "graphql-playground-html": "^1.6.30",

api/src/errors/BadRequestError.ts

@@ -0,0 +1,32 @@
+import { CustomError } from "./CustomError";
+
+export default class BadRequestError extends CustomError {
+  private static readonly _statusCode = 400;
+  private readonly _code: number;
+  private readonly _logging: boolean;
+  private readonly _context: { [key: string]: any };
+
+  constructor(params?: {code?: number, message?: string, logging?: boolean, context?: { [key: string]: any }}) {
+    const { code, message, logging } = params || {};
+
+    super(message || "Bad request");
+    this._code = code || BadRequestError._statusCode;
+    this._logging = logging || false;
+    this._context = params?.context || {};
+
+    // Only because we are extending a built in class
+    Object.setPrototypeOf(this, BadRequestError.prototype);
+  }
+
+  get errors() {
+    return [{ message: this.message, context: this._context }];
+  }
+
+  get statusCode() {
+    return this._code;
+  }
+
+  get logging() {
+    return this._logging;
+  }
+}

api/src/errors/CustomError.ts

@@ -0,0 +1,17 @@
+export type CustomErrorContent = {
+  message: string,
+  context?: { [key: string]: any }
+};
+
+export abstract class CustomError extends Error {
+  abstract readonly statusCode: number;
+  abstract readonly errors: CustomErrorContent[];
+  abstract readonly logging: boolean;
+
+  constructor(message: string) {
+    super(message);
+
+    // Only because we are extending a built in class
+    Object.setPrototypeOf(this, CustomError.prototype);
+  }
+}

api/src/errors/DocumentDriveError.ts

@@ -0,0 +1,32 @@
+import { CustomError } from "./CustomError";
+
+export default class DocumentDriveError extends CustomError {
+  private static readonly _statusCode = 400;
+  private readonly _code: number;
+  private readonly _logging: boolean;
+  private readonly _context: { [key: string]: any };
+
+  constructor(params?: { code?: number, message?: string, logging?: boolean, context?: { [key: string]: any } }) {
+    const { code, message, logging } = params || {};
+
+    super(message || "Bad request");
+    this._code = code || DocumentDriveError._statusCode;
+    this._logging = logging || false;
+    this._context = params?.context || {};
+
+    // Only because we are extending a built in class
+    Object.setPrototypeOf(this, DocumentDriveError.prototype);
+  }
+
+  get errors() {
+    return [{ message: this.message, context: this._context }];
+  }
+
+  get statusCode() {
+    return this._code;
+  }
+
+  get logging() {
+    return this._logging;
+  }
+}

api/src/graphql/server/index.ts

@@ -9,9 +9,11 @@ import cors from 'cors';
 import { PORT } from '../../env';
 import { schemaWithMiddleware as indexSchema } from './index/schema';
 import { schemaWithMiddleware as driveSchema } from './drive/schema';
-import { Context as IndexContext, createContext as createIndexContext } from './index/context';
+import { Context, Context as IndexContext, createContext as createIndexContext } from './index/context';
 import { Context as DriveContext, createContext as createDriveContext } from './drive/context';
 import { getChildLogger } from '../../logger';
+import "express-async-errors";
+import { errorHandler } from '../../middleware/errors';
 
 const logger = getChildLogger({ msgPrefix: 'SERVER' });
 
@@ -72,6 +74,7 @@ export const startServer = async (
     }),
   );
 
+  app.use(errorHandler);
   return httpServer.listen({ port: PORT }, () => {
     logger.info(`Running on ${PORT}`);
   });

api/src/middleware/errors.ts

@@ -0,0 +1,15 @@
+import { NextFunction, Request, Response } from "express";
+import { getChildLogger } from "../logger";
+import { CustomError } from "../errors/CustomError";
+
+const logger = getChildLogger({ msgPrefix: 'Generic Error Handler', });
+
+export const errorHandler = (err: Error, req: Request, res: Response, next: NextFunction) => {
+  err.cause = err.cause || 'Unknown';
+  logger.error({
+    msg: err.message,
+  });
+
+  console.log("TEST TEST TEST")
+  res.status(500).send({ errors: err.message });
+};

api/src/modules/document-drive/drive-resolver.ts

@@ -17,6 +17,7 @@ import stringify from 'json-stringify-deterministic';
 import { getChildLogger } from '../../logger';
 import { Context } from '../../graphql/server/drive/context';
 import { DocumentDriveAction } from 'document-model-libs/document-drive';
+import DocumentDriveError from '../../errors/DocumentDriveError';
 
 const logger = getChildLogger({ msgPrefix: 'Drive Resolver' });
 
@@ -234,9 +235,8 @@ export const getDrive = queryField('drive', {
     try {
       const drive = await ctx.prisma.document.getDrive(ctx.driveId ?? '1');
       return drive;
-    } catch (e) {
-      logger.error(e);
-      return null;
+    } catch (e: any) {
+      throw new DocumentDriveError({ code: 500, message: e.message ?? "Failed to get drive", logging: true, context: e })
     }
   },
 });
@@ -247,17 +247,23 @@ export const registerListener = mutationField('registerPullResponderListener', {
     filter: nonNull(InputListenerFilter),
   },
   resolve: async (_parent, { filter }, ctx: Context) => {
-    const result = await ctx.prisma.document.registerPullResponderListener(
-      ctx.driveId ?? '1',
-      {
+    try {
+      const result = await ctx.prisma.document.registerPullResponderListener(
+        ctx.driveId ?? '1',
+        {
           branch: filter.branch?.filter(b => !!b) as string[] ?? [],
           documentId: filter.documentId?.filter(b => !!b) as string[] ?? [],
           documentType: filter.documentType?.filter(b => !!b) as string[] ?? [],
           scope: filter.scope?.filter(b => !!b) as string[] ?? [],
-      },
-    );
+        },
+      );
+
+      return result;
+
+    } catch (e: any) {
+      throw new DocumentDriveError({ code: 500, message: e.message ?? "Failed to register listener", logging: true, context: e })
+    }
 
-    return result;
   },
 });
 
@@ -268,12 +274,16 @@ export const deleteListener = mutationField('deletePullResponderListener', {
     filter: nonNull(InputListenerFilter),
   },
   resolve: async (_parent, { filter }, ctx: Context) => {
-    const result = await ctx.prisma.document.deletePullResponderListener(
-      ctx.driveId ?? '1',
-      filter,
-    );
+    try {
+      const result = await ctx.prisma.document.deletePullResponderListener(
+        ctx.driveId ?? '1',
+        filter,
+      );
 
-    return result;
+      return result;
+    } catch (e: any) {
+      throw new DocumentDriveError({ code: 500, message: e.message ?? "Failed to delete listener", logging: true, context: e })
+    }
   },
 });
 
@@ -286,36 +296,42 @@ export const pushUpdates = mutationField('pushUpdates', {
     logger.info('pushUpdates')
     if (!strands || strands?.length === 0) return [];
 
-    const listenerRevisions: IListenerRevision[] = await Promise.all(strands.map(async (s) => {
-      const operations = s.operations?.map((o) => ({
-        ...o,
-        input: JSON.parse(o.input),
-        skip: o.skip ?? 0,
-        scope: s.scope as OperationScope,
-        branch: 'main',
-        scopes: ['global', 'local'],
-      })) ?? [];
-
-      const result = await ctx.prisma.document.pushUpdates(
-        s.driveId,
-        operations as Operation<DocumentDriveAction>[],
-        s.documentId ?? undefined,
-      );
-
-      if (result.status !== "SUCCESS") logger.error(result.error);
-
-      const revision = result.document?.operations[s.scope as OperationScope].slice().pop()?.index ?? -1;
-      return {
-        revision,
-        branch: s.branch,
-        documentId: s.documentId ?? '',
-        driveId: s.driveId,
-        scope: s.scope as OperationScope,
-        status: result.status,
-      };
-    }));
-
-    return listenerRevisions;
+    try {
+      const listenerRevisions: IListenerRevision[] = await Promise.all(strands.map(async (s) => {
+        const operations = s.operations?.map((o) => ({
+          ...o,
+          input: JSON.parse(o.input),
+          skip: o.skip ?? 0,
+          scope: s.scope as OperationScope,
+          branch: 'main',
+          scopes: ['global', 'local'],
+        })) ?? [];
+
+        const result = await ctx.prisma.document.pushUpdates(
+          s.driveId,
+          operations as Operation<DocumentDriveAction>[],
+          s.documentId ?? undefined,
+        );
+
+        if (result.status !== "SUCCESS") logger.error(result.error);
+
+        const revision = result.document?.operations[s.scope as OperationScope].slice().pop()?.index ?? -1;
+        return {
+          revision,
+          branch: s.branch,
+          documentId: s.documentId ?? '',
+          driveId: s.driveId,
+          scope: s.scope as OperationScope,
+          status: result.status,
+        };
+
+      }));
+
+
+      return listenerRevisions;
+    } catch (e: any) {
+      throw new DocumentDriveError({ code: 500, message: e.message ?? "Failed to push updates", logging: true, context: e })
+    }
   },
 });
 
@@ -346,9 +362,8 @@ export const acknowledge = mutationField('acknowledge', {
       );
 
       return result;
-    } catch (e) {
-      logger.error(e)
-      return false;
+    } catch (e: any) {
+      throw new DocumentDriveError({ code: 500, message: e.message ?? "Failed to acknowledge", logging: true, context: e })
     }
   },
 });

api/src/modules/document-drive/drives-resolver.ts

@@ -9,6 +9,7 @@ import {
 import { DocumentDriveState } from './drive-resolver';
 import { Context } from '../../graphql/server/drive/context';
 import logger from '../../logger';
+import DocumentDriveError from '../../errors/DocumentDriveError';
 
 export const DocumentDriveLocalState = objectType({
   name: 'DocumentDriveLocalState',
@@ -68,11 +69,15 @@ export const addDrive = mutationField('addDrive', {
     local: nonNull(DocumentDriveLocalStateInput),
   },
   resolve: async (_parent, { global, local }, ctx: Context) => {
-    const drive = await ctx.prisma.document.addDrive({
-      global: { id: global.id, name: global.name, icon: global.icon ?? null, slug: global.slug ?? null },
-      local: { availableOffline: local.availableOffline, sharingType: local.sharingType ?? null, listeners: [], triggers: [] },
-    });
-    return drive.state;
+    try {
+      const drive = await ctx.prisma.document.addDrive({
+        global: { id: global.id, name: global.name, icon: global.icon ?? null, slug: global.slug ?? null },
+        local: { availableOffline: local.availableOffline, sharingType: local.sharingType ?? null, listeners: [], triggers: [] },
+      });
+      return drive.state;
+    } catch (e: any) {
+      throw new DocumentDriveError({ code: 500, message: e.message ?? "Failed to add drive", logging: true, context: e })
+    }
   },
 });
 
@@ -84,9 +89,8 @@ export const deleteDrive = mutationField('deleteDrive', {
   resolve: async (_parent, { id }, ctx: Context) => {
     try {
       await ctx.prisma.document.deleteDrive(id);
-    } catch (e) {
-      logger.error(e);
-      return false;
+    } catch (e: any) {
+      throw new DocumentDriveError({ code: 500, message: e.message ?? "Failed to delete drive", logging: true, context: e })
     }
 
     return true;

api/src/modules/document/model.ts

@@ -45,8 +45,12 @@ export function getDocumentDriveCRUD(prisma: Prisma.TransactionClient) {
   );
 
   async function initialize() {
-    await driveServer.initialize();
-    await init(driveServer, prisma);
+    try {
+      await driveServer.initialize();
+      await init(driveServer, prisma);
+    } catch (e) {
+      console.log(e);
+    }
   }
 
   function clearDriveCache() {