🔊 (game-server) Log errors in database in collection apierrors

Author: coyotte508

api-node/app/app.ts

@@ -88,6 +88,9 @@ async function listen(port = env.listen.port.api) {
             message: err.message,
           },
           user: ctx.state.user?._id,
+          meta: {
+            source: "api-node",
+          },
         });
         if (process.env.NODE_ENV !== "production" && !env.silent) {
           console.error(err);

api-node/app/models/apierror.ts

@@ -1,58 +1,6 @@
-import mongoose, { Document, Model, Schema, Types } from "mongoose";
+import makeSchema from "@lib/schemas/api-error";
+import mongoose from "mongoose";
 
-export interface ApiErrorDocument extends Document {
-  error: {
-    name: string;
-    message: string;
-    stack: string[];
-  };
-  request: {
-    url: string;
-    method: string;
-    /**
-     * Stringified content because mongodb doesn't support dots in keys
-     */
-    body: string;
-  };
-  meta?: unknown;
-  user: Types.ObjectId;
-  updatedAt?: Date;
-}
-
-interface ApiErrorModel extends Model<ApiErrorDocument> {
-  lastUnread(): Promise<ApiErrorDocument[]>;
-}
-
-const schema = new Schema<ApiErrorDocument, ApiErrorModel>(
-  {
-    error: {
-      name: String,
-      message: String,
-      stack: [String],
-    },
-    user: {
-      type: Schema.Types.ObjectId,
-      ref: "User",
-    },
-    request: {
-      url: String,
-      method: String,
-      body: String,
-    },
-    meta: {},
-  },
-  {
-    timestamps: true,
-    capped: { size: 10 * 1024 * 1024, max: 10 * 1000 },
-  }
-);
-
-schema.static("lastUnread", async function (this: ApiErrorModel) {
-  return await this.find({ read: false }).sort("-_id").limit(10);
-});
-
-schema.index({ user: 1, createdAt: -1 });
-
-const ApiError = mongoose.model("ApiError", schema);
+const ApiError = mongoose.model("ApiError", makeSchema());
 
 export default ApiError;

game-server/README.md

@@ -26,6 +26,7 @@ The game server needs to have a user with a role that has:
 - Read / Write access to the `gamenotifications` collection (`["insert", "find", "remove"]`)
 - Read / Write access to the `locks` collection (`["insert", "find", "remove", "update"]`)
 - Read access to the `gameinfos` collection, to load the game engines (`["find"]`)
+- Write access to the `apierrors` colletion (`["insert"]`)
 
 Due to mongoose (they should use `{authorizedCollections: true, nameOnly: true}`), this is also needed
 
@@ -35,6 +36,7 @@ For exemaple, in db shell:
 
 ```
 db.createRole({role: "game-server", privileges: [
+  {resource: {db: "gaia-project", collection: "apierrors"}, actions: ["insert"]},
   {resource: {db: "gaia-project", collection: "chatmessages"}, actions: ["insert"]},
   {resource: {db: "gaia-project", collection: "gameinfos"}, actions: ["find"]},
   {resource: {db: "gaia-project", collection: "gamenotifications"}, actions: ["insert", "find", "remove", "update"]},
@@ -43,6 +45,20 @@ db.createRole({role: "game-server", privileges: [
   {resource: {db: "gaia-project", collection: ""}, actions: ["listCollections"]}
 ], roles: []});
 
+// or
+
+db.updateRole("game-server", {privileges: [
+  {resource: {db: "gaia-project", collection: "apierrors"}, actions: ["insert"]},
+  {resource: {db: "gaia-project", collection: "chatmessages"}, actions: ["insert"]},
+  {resource: {db: "gaia-project", collection: "gameinfos"}, actions: ["find"]},
+  {resource: {db: "gaia-project", collection: "gamenotifications"}, actions: ["insert", "find", "remove", "update"]},
+  {resource: {db: "gaia-project", collection: "games"}, actions: ["find", "update"]},
+  {resource: {db: "gaia-project", collection: "locks"}, actions: ["insert", "find", "remove", "update"]},
+  {resource: {db: "gaia-project", collection: ""}, actions: ["listCollections"]}
+], roles: []});
+
+// and
+
 db.createUser({
   user: "<name>",
   pwd: passwordPrompt(),      // Or  "<cleartext password>"

game-server/app/app.ts

@@ -9,6 +9,7 @@ import morgan from "koa-morgan";
 import "./config/db";
 /* Configure passport */
 import env from "./config/env";
+import ApiError from "./models/apierror";
 /* Local stuff */
 import router from "./routes";
 
@@ -59,6 +60,23 @@ app.use(async (ctx, next) => {
       ctx.status = 500;
       ctx.body = { message: "Internal error" };
     }
+
+    await ApiError.create({
+      request: {
+        url: ctx.request.originalUrl,
+        method: ctx.request.method,
+        body: JSON.stringify(ctx.request.body),
+      },
+      error: {
+        name: err.name,
+        stack: err.stack,
+        message: err.message,
+      },
+      user: ctx.state.user?.id,
+      meta: {
+        source: "game-server",
+      },
+    });
   }
 });
 

game-server/app/models/apierror.ts

@@ -0,0 +1,6 @@
+import makeSchema from "@lib/schemas/api-error";
+import mongoose from "mongoose";
+
+const ApiError = mongoose.model("ApiError", makeSchema());
+
+export default ApiError;

site-lib/schemas/api-error.ts

@@ -0,0 +1,33 @@
+import { ApiError } from "@lib/api-error";
+import { Document, Model, Schema, Types } from "mongoose";
+
+export interface ApiErrorDocument extends Document, ApiError<Types.ObjectId> {}
+
+const repr = {
+  error: {
+    name: String,
+    message: String,
+    stack: [String],
+  },
+  user: {
+    type: Schema.Types.ObjectId,
+    ref: "User",
+  },
+  request: {
+    url: String,
+    method: String,
+    body: String,
+  },
+  meta: {},
+};
+
+export default function makeSchema<U extends Model<ApiErrorDocument> = Model<ApiErrorDocument>>() {
+  const schema = new Schema<ApiErrorDocument, U>(repr, {
+    timestamps: true,
+    capped: { size: 10 * 1024 * 1024, max: 10 * 1000 },
+  });
+
+  schema.index({ user: 1, createdAt: -1 });
+
+  return schema;
+}