From 9cba53f22c45cf9fee5c001e6bd5d0befefa1786 Mon Sep 17 00:00:00 2001
From: Alexander Holliday <ajhollid@gmail.com>
Date: Sun, 28 Jul 2024 13:52:15 -0700
Subject: [PATCH] Feat/db/maintenance window (#472)

* Added comment to show where maintenance window should be applied

* Add maintenance window schema

* Added userID to model
---
 Server/models/MaintenanceWindow.js | 65 ++++++++++++++++++++++++++++++
 Server/service/jobQueue.js         |  2 +
 2 files changed, 67 insertions(+)
 create mode 100644 Server/models/MaintenanceWindow.js

diff --git a/Server/models/MaintenanceWindow.js b/Server/models/MaintenanceWindow.js
new file mode 100644
index 000000000..f6be12f67
--- /dev/null
+++ b/Server/models/MaintenanceWindow.js
@@ -0,0 +1,65 @@
+const mongoose = require("mongoose");
+
+/**
+ * MaintenanceWindow Schema
+ * @module MaintenanceWindow
+ * @typedef {Object} MaintenanceWindow
+ * @property {mongoose.Schema.Types.ObjectId} monitorId - The ID of the monitor. This is a reference to the Monitor model and is immutable.
+ * @property {Boolean} active - Indicates whether the maintenance window is active.
+ * @property {Boolean} oneTime - Indicates whether the maintenance window is a one-time event.
+ * @property {Date} start - The start date and time of the maintenance window.
+ * @property {Date} end - The end date and time of the maintenance window.
+ * @property {Date} expiry - The expiry date and time of the maintenance window. This is used for MongoDB's TTL index to automatically delete the document at this time. This field is set to the same value as `end` when `oneTime` is `true`.
+ *
+ * @example
+ *
+ * let maintenanceWindow = new MaintenanceWindow({
+ *   monitorId: monitorId,
+ *   active: active,
+ *   oneTime: oneTime,
+ *   start: start,
+ *   end: end,
+ * });
+ *
+ * if (oneTime) {
+ *   maintenanceWindow.expiry = end;
+ * }
+ *
+ */
+
+const MaintenanceWindow = mongoose.Schema(
+  {
+    monitorId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "Monitor",
+      immutable: true,
+    },
+    userId: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: "User",
+      immutable: true,
+    },
+    active: {
+      type: Boolean,
+    },
+    oneTime: {
+      type: Boolean,
+    },
+    start: {
+      type: Date,
+    },
+    end: {
+      type: Date,
+    },
+    expiry: {
+      type: Date,
+      index: { expires: "0s" },
+    },
+  },
+
+  {
+    timestamps: true,
+  }
+);
+
+module.exports = mongoose.model("MaintenanceWindow", MaintenanceWindow);
diff --git a/Server/service/jobQueue.js b/Server/service/jobQueue.js
index 534cffecd..c8ffd5e24 100644
--- a/Server/service/jobQueue.js
+++ b/Server/service/jobQueue.js
@@ -59,6 +59,8 @@ class JobQueue {
       QUEUE_NAME,
       async (job) => {
         try {
+          // TODO wrap this in a check to see if a maintenace window is active
+          // If so, don't process the job
           const res = await this.networkService.getStatus(job);
         } catch (error) {
           logger.error(`Error processing job ${job.id}: ${error.message}`, {