feat: Ability to track user activity navigation logs (#1167)

AB#105244

Co-authored-by: Tai Kamilla <taikamilla@gmail.com>
Co-authored-by: unai-reliefapp <123092672+unai-reliefapp@users.noreply.github.com>
Co-authored-by: MwanPygmay <59645813+MwanPygmay@users.noreply.github.com>
Co-authored-by: Yafar Valverde <15035750+TaiKamilla@users.noreply.github.com>

package.json

@@ -70,6 +70,7 @@
     "graphql-type-json": "^0.3.2",
     "graphql-ws": "^5.14.0",
     "http": "0.0.1-security",
+    "http-status-codes": "^2.3.0",
     "i18next": "^21.6.13",
     "i18next-http-middleware": "^3.2.0",
     "i18next-node-fs-backend": "^2.1.3",

src/abstractions/api-error.ts

@@ -0,0 +1,43 @@
+import { ReasonPhrases, StatusCodes } from 'http-status-codes';
+
+/** Error interface */
+export interface Error {
+  status: number;
+  fields: {
+    name: {
+      message: string;
+    };
+  };
+  message: string;
+  name: string;
+}
+
+/** Api Error class */
+class ApiError extends Error implements Error {
+  public status = 500;
+
+  public success = false;
+
+  public fields: { name: { message: string } } = { name: { message: '' } };
+
+  /**
+   * Api Error class
+   *
+   * @param msg Message
+   * @param statusCode Http status code number
+   * @param name Error name
+   */
+  constructor(
+    msg: string,
+    statusCode: number,
+    name: string = ReasonPhrases.INTERNAL_SERVER_ERROR
+  ) {
+    super();
+    this.message = msg;
+    this.status = statusCode;
+    this.name =
+      statusCode === StatusCodes.NOT_FOUND ? ReasonPhrases.NOT_FOUND : name;
+  }
+}
+
+export default ApiError;

src/abstractions/base.controller.ts

@@ -0,0 +1,22 @@
+import { Response } from 'express';
+import { StatusCodes } from 'http-status-codes';
+import { RouteDefinition } from '../types/route-definition';
+
+/**
+ * Provides services common to all API methods
+ */
+export default abstract class BaseController {
+  public abstract routes(): RouteDefinition[];
+
+  /**
+   * Global method to send API response.
+   *
+   * @param res Express response
+   * @param statusCode http status code
+   */
+  public send(res: Response, statusCode: number = StatusCodes.OK): void {
+    let obj = {};
+    obj = res.locals.data;
+    res.status(statusCode).send(obj);
+  }
+}

src/models/activityLog.model.ts

@@ -0,0 +1,36 @@
+import { AccessibleRecordModel, accessibleRecordsPlugin } from '@casl/mongoose';
+import mongoose, { Schema, Document } from 'mongoose';
+
+/** Mongoose activity log schema declaration */
+export interface ActivityLog extends Document {
+  kind: 'ActivityLog';
+  userId: mongoose.Types.ObjectId;
+  eventType: string;
+  metadata: any;
+  username: string;
+  attributes: any;
+  createdAt: Date;
+}
+
+/** Activity log documents interface declaration */
+const schema = new Schema<ActivityLog>(
+  {
+    userId: Schema.Types.ObjectId,
+    eventType: String,
+    username: String,
+    metadata: Schema.Types.Mixed,
+    attributes: Schema.Types.Mixed,
+  },
+  {
+    timestamps: { createdAt: 'createdAt' },
+  }
+);
+
+schema.plugin(accessibleRecordsPlugin);
+
+/** Mongoose activity log model */
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const ActivityLog = mongoose.model<
+  ActivityLog,
+  AccessibleRecordModel<ActivityLog>
+>('ActivityLog', schema);

src/models/index.ts

@@ -29,4 +29,5 @@ export * from './customNotification.model';
 export * from './layer.model';
 export * from './draftRecord.model';
 export * from './emailNotification.model';
+export * from './activityLog.model';
 export * from './emailDistributionList.model';