feat: database transaction logging for all models (#1849)

* Database transaction logging middleware

* Review changes

* updated .gitignore

* logging middlware for all models

* fix lint

* fix format

* fix failing tests

src/models/Advertisement.ts

@@ -1,6 +1,7 @@
 import type { Types, Model, PopulatedDoc } from "mongoose";
 import { Schema, model, models } from "mongoose";
 import type { InterfaceUser } from "./User";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 /**
  * This is an interface, that represents database - (MongoDB) document for Advertisement.
  */
@@ -99,6 +100,8 @@ const advertisementSchema = new Schema(
   }
 );
 
+createLoggingMiddleware(advertisementSchema, "Advertisement");
+
 const advertisementModel = (): Model<InterfaceAdvertisement> =>
   model<InterfaceAdvertisement>("Advertisement", advertisementSchema);
 

src/models/CheckIn.ts

@@ -8,6 +8,7 @@ import {
   type Model,
 } from "mongoose";
 import { type InterfaceEventAttendee } from "./EventAttendee";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 
 export interface InterfaceCheckIn {
   _id: Types.ObjectId;
@@ -56,6 +57,8 @@ checkInSchema.index({
   eventAttendeeId: 1,
 });
 
+createLoggingMiddleware(checkInSchema, "CheckIn");
+
 const checkInModel = (): Model<InterfaceCheckIn> =>
   model<InterfaceCheckIn>("CheckIn", checkInSchema);
 

src/models/Comment.ts

@@ -2,6 +2,7 @@ import type { PopulatedDoc, Types, Document, Model } from "mongoose";
 import { Schema, model, models } from "mongoose";
 import type { InterfaceUser } from "./User";
 import type { InterfacePost } from "./Post";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 /**
  * This is an interface representing a document for a comment in the database(MongoDB).
  */
@@ -65,6 +66,8 @@ const commentSchema = new Schema(
   }
 );
 
+createLoggingMiddleware(commentSchema, "Comment");
+
 const commentModel = (): Model<InterfaceComment> =>
   model<InterfaceComment>("Comment", commentSchema);
 

src/models/DirectChat.ts

@@ -3,6 +3,7 @@ import { Schema, model, models } from "mongoose";
 import type { InterfaceDirectChatMessage } from "./DirectChatMessage";
 import type { InterfaceOrganization } from "./Organization";
 import type { InterfaceUser } from "./User";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 /**
  * This is an interface representing a document for direct chat in the database(MongoDB).
  */
@@ -63,6 +64,8 @@ const directChatSchema = new Schema(
   }
 );
 
+createLoggingMiddleware(directChatSchema, "DirectChat");
+
 const directChatModel = (): Model<InterfaceDirectChat> =>
   model<InterfaceDirectChat>("DirectChat", directChatSchema);
 

src/models/DirectChatMessage.ts

@@ -2,6 +2,7 @@ import type { PopulatedDoc, Types, Document, Model } from "mongoose";
 import { Schema, model, models } from "mongoose";
 import type { InterfaceDirectChat } from "./DirectChat";
 import type { InterfaceUser } from "./User";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 /**
  * This is an interface representing a document for a direct chat message in the database(MongoDB).
  */
@@ -58,6 +59,8 @@ const directChatMessageSchema = new Schema(
   }
 );
 
+createLoggingMiddleware(directChatMessageSchema, "DirectChatMessage");
+
 const directChatMessageModel = (): Model<InterfaceDirectChatMessage> =>
   model<InterfaceDirectChatMessage>(
     "DirectChatMessage",

src/models/Donation.ts

@@ -1,5 +1,6 @@
 import type { Types, Model } from "mongoose";
 import { Schema, model, models } from "mongoose";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 /**
  * This is an interface representing a document for a donation in the database(MongoDB).
  */
@@ -56,6 +57,8 @@ const donationSchema = new Schema(
   }
 );
 
+createLoggingMiddleware(donationSchema, "Donation");
+
 const donationModel = (): Model<InterfaceDonation> =>
   model<InterfaceDonation>("Donation", donationSchema);
 

src/models/EncodedImage.ts

@@ -1,5 +1,6 @@
 import type { Types, Model } from "mongoose";
 import { Schema, model, models } from "mongoose";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 /**
  * This is an interface that represents a database(MongoDB) document for Encoded Image.
  */
@@ -31,6 +32,8 @@ const encodedImageSchema = new Schema({
   },
 });
 
+createLoggingMiddleware(encodedImageSchema, "EncodedImage");
+
 const encodedImageModel = (): Model<InterfaceEncodedImage> =>
   model<InterfaceEncodedImage>("EncodedImage", encodedImageSchema);
 

src/models/EncodedVideo.ts

@@ -1,5 +1,6 @@
 import type { Types, Model } from "mongoose";
 import { Schema, model, models } from "mongoose";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 /**
  * This is an interface that represents a database(MongoDB) document for Encoded Video.
  */
@@ -31,6 +32,8 @@ const encodedVideoSchema = new Schema({
   },
 });
 
+createLoggingMiddleware(encodedVideoSchema, "EncodedVideo");
+
 const encodedVideoModel = (): Model<InterfaceEncodedVideo> =>
   model<InterfaceEncodedVideo>("EncodedVideo", encodedVideoSchema);
 

src/models/Event.ts

@@ -3,6 +3,7 @@ import { Schema, model, models } from "mongoose";
 import type { InterfaceOrganization } from "./Organization";
 import type { InterfaceUser } from "./User";
 import type { InterfaceRecurrenceRule } from "./RecurrenceRule";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 
 /**
  * This is an interface representing a document for an event in the database(MongoDB).
@@ -125,29 +126,25 @@ const eventSchema = new Schema(
     },
     endDate: {
       type: Date,
-      required: function (): () => boolean {
-        // @ts-expect-error Suppressing typescript error for conditional required field
+      required: function (this: InterfaceEvent): boolean {
         return !this.allDay;
       },
     },
     startTime: {
       type: Date,
-      required: function (): () => boolean {
-        // @ts-expect-error Suppressing typescript error for conditional required field
+      required: function (this: InterfaceEvent): boolean {
         return !this.allDay;
       },
     },
     endTime: {
       type: Date,
-      required: function (): () => boolean {
-        // @ts-expect-error Suppressing typescript error for conditional required field
+      required: function (this: InterfaceEvent): boolean {
         return !this.allDay;
       },
     },
     recurrance: {
       type: String,
-      required: function (): () => boolean {
-        // @ts-expect-error Suppressing typescript error for conditional required field
+      required: function (this: InterfaceEvent): boolean {
         return this.recurring;
       },
       enum: ["ONCE", "DAILY", "WEEKLY", "MONTHLY", "YEARLY"],
@@ -190,6 +187,8 @@ const eventSchema = new Schema(
   }
 );
 
+createLoggingMiddleware(eventSchema, "Event");
+
 const eventModel = (): Model<InterfaceEvent> =>
   model<InterfaceEvent>("Event", eventSchema);
 

src/models/EventAttendee.ts

@@ -3,6 +3,7 @@ import { Schema, model, models } from "mongoose";
 import type { InterfaceUser } from "./User";
 import type { InterfaceEvent } from "./Event";
 import type { InterfaceCheckIn } from "./CheckIn";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 
 export interface InterfaceEventAttendee {
   _id: Schema.Types.ObjectId;
@@ -32,6 +33,8 @@ const eventAttendeeSchema = new Schema({
 
 eventAttendeeSchema.index({ userId: 1, eventId: 1 }, { unique: true });
 
+createLoggingMiddleware(eventAttendeeSchema, "EventAttendee");
+
 const eventAttendeeModel = (): Model<InterfaceEventAttendee> =>
   model<InterfaceEventAttendee>("EventAttendee", eventAttendeeSchema);
 

src/models/Feedback.ts

@@ -1,6 +1,7 @@
 import type { Types, PopulatedDoc, Document, Model } from "mongoose";
 import { Schema, model, models } from "mongoose";
 import type { InterfaceEvent } from "./Event";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 
 export interface InterfaceFeedback {
   _id: Types.ObjectId;
@@ -39,6 +40,8 @@ feedbackSchema.index({
   eventId: 1,
 });
 
+createLoggingMiddleware(feedbackSchema, "Feedback");
+
 const feedbackModel = (): Model<InterfaceFeedback> =>
   model<InterfaceFeedback>("Feedback", feedbackSchema);
 

src/models/File.ts

@@ -1,6 +1,7 @@
 import type { Types, Model } from "mongoose";
 import { Schema, model, models } from "mongoose";
 import { v4 as uuidv4 } from "uuid";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 /**
  * This is an interface representing a document for a file in the database(MongoDB).
  */
@@ -58,6 +59,8 @@ const fileSchema = new Schema(
   }
 );
 
+createLoggingMiddleware(fileSchema, "File");
+
 const fileModel = (): Model<InterfaceFile> =>
   model<InterfaceFile>("File", fileSchema);
 

src/models/Group.ts

@@ -2,6 +2,7 @@ import type { PopulatedDoc, Types, Document, Model } from "mongoose";
 import { Schema, model, models } from "mongoose";
 import type { InterfaceOrganization } from "./Organization";
 import type { InterfaceUser } from "./User";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 /**
  * This is an interface representing a document for a group in the database(MongoDB).
  */
@@ -57,6 +58,8 @@ const groupSchema = new Schema(
   }
 );
 
+createLoggingMiddleware(groupSchema, "Group");
+
 const groupModel = (): Model<InterfaceGroup> =>
   model<InterfaceGroup>("Group", groupSchema);
 

src/models/GroupChat.ts

@@ -3,6 +3,7 @@ import { Schema, model, models } from "mongoose";
 import type { InterfaceGroupChatMessage } from "./GroupChatMessage";
 import type { InterfaceOrganization } from "./Organization";
 import type { InterfaceUser } from "./User";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 /**
  * This is an interface representing a document for a group chat in the database(MongoDB).
  */
@@ -69,6 +70,8 @@ const groupChatSchema = new Schema(
   }
 );
 
+createLoggingMiddleware(groupChatSchema, "GroupChat");
+
 const groupChatModel = (): Model<InterfaceGroupChat> =>
   model<InterfaceGroupChat>("GroupChat", groupChatSchema);
 

src/models/GroupChatMessage.ts

@@ -2,6 +2,7 @@ import type { Types, PopulatedDoc, Document, Model } from "mongoose";
 import { Schema, model, models } from "mongoose";
 import type { InterfaceGroupChat } from "./GroupChat";
 import type { InterfaceUser } from "./User";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 /**
  * This is an interface that represents a database(MongoDB) document for Group Chat Message.
  */
@@ -51,6 +52,8 @@ const groupChatMessageSchema = new Schema(
   }
 );
 
+createLoggingMiddleware(groupChatMessageSchema, "GroupChatMessage");
+
 const groupChatMessageModel = (): Model<InterfaceGroupChatMessage> =>
   model<InterfaceGroupChatMessage>("GroupChatMessage", groupChatMessageSchema);
 

src/models/ImageHash.ts

@@ -1,5 +1,6 @@
 import type { Types, Model } from "mongoose";
 import { Schema, model, models } from "mongoose";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 /**
  * This is an interface that represents a database(MongoDB) document for Image Hash.
  */
@@ -39,6 +40,8 @@ const imageHashSchema = new Schema({
   },
 });
 
+createLoggingMiddleware(imageHashSchema, "ImageHash");
+
 const imageHashModel = (): Model<InterfaceImageHash> =>
   model<InterfaceImageHash>("ImageHash", imageHashSchema);
 

src/models/Language.ts

@@ -1,5 +1,6 @@
 import type { Types, Document, PopulatedDoc, Model } from "mongoose";
 import { Schema, model, models } from "mongoose";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 /**
  * This is an interface that represents a database document.
  */
@@ -70,6 +71,8 @@ const languageSchema = new Schema({
   },
 });
 
+createLoggingMiddleware(languageSchema, "Language");
+
 const languageModel = (): Model<InterfaceLanguage> =>
   model<InterfaceLanguage>("Language", languageSchema);
 

src/models/MembershipRequest.ts

@@ -2,6 +2,7 @@ import type { PopulatedDoc, Types, Document, Model } from "mongoose";
 import { Schema, model, models } from "mongoose";
 import type { InterfaceOrganization } from "./Organization";
 import type { InterfaceUser } from "./User";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 /**
  * This is an interface that represents a database(MongoDB) document for Membership Request.
  */
@@ -36,6 +37,8 @@ const membershipRequestSchema = new Schema({
   },
 });
 
+createLoggingMiddleware(membershipRequestSchema, "MembershipRequest");
+
 const membershipRequestModel = (): Model<InterfaceMembershipRequest> =>
   model<InterfaceMembershipRequest>(
     "MembershipRequest",

src/models/Message.ts

@@ -2,6 +2,7 @@ import type { PopulatedDoc, Types, Document, Model } from "mongoose";
 import { Schema, model, models } from "mongoose";
 import type { InterfaceGroup } from "./Group";
 import type { InterfaceUser } from "./User";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 /**
  * This is an interface that represents a database(MongoDB) document for Message.
  */
@@ -63,6 +64,8 @@ const messageSchema = new Schema(
   }
 );
 
+createLoggingMiddleware(messageSchema, "Message");
+
 const messageModel = (): Model<InterfaceMessage> =>
   model<InterfaceMessage>("Message", messageSchema);
 

src/models/MessageChat.ts

@@ -1,6 +1,7 @@
 import type { PopulatedDoc, Types, Document, Model } from "mongoose";
 import { Schema, model, models } from "mongoose";
 import type { InterfaceUser } from "./User";
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 /**
  * This is an interface representing a document for a chat in the database(MongoDB).
  */
@@ -49,6 +50,8 @@ const messageChatSchema = new Schema(
   }
 );
 
+createLoggingMiddleware(messageChatSchema, "MessageChat");
+
 const messageChatModel = (): Model<InterfaceMessageChat> =>
   model<InterfaceMessageChat>("MessageChat", messageChatSchema);
 

src/models/Organization.ts

@@ -5,7 +5,7 @@ import type { InterfaceMessage } from "./Message";
 import type { InterfaceOrganizationCustomField } from "./OrganizationCustomField";
 import type { InterfacePost } from "./Post";
 import type { InterfaceUser } from "./User";
-
+import { createLoggingMiddleware } from "../libraries/dbLogger";
 /**
  * This is an interface that represents a database(MongoDB) document for Organization.
  */
@@ -178,6 +178,8 @@ const organizationSchema = new Schema(
   }
 );
 
+createLoggingMiddleware(organizationSchema, "Organization");
+
 const organizationModel = (): Model<InterfaceOrganization> =>
   model<InterfaceOrganization>("Organization", organizationSchema);