chore: Add tests for appendParams function and error checking

Author: saldanaj97

__tests__/appendParams.test.ts

@@ -0,0 +1,38 @@
+import { appendParams } from "../src/utils/appendParams"
+
+describe("Util Functions (appendParams)", () => {
+  it("should append parameters to the URL", () => {
+    const URL = "https://example.com"
+    const params = {
+      param1: "value1",
+      param2: 123,
+      param3: true,
+      param4: undefined,
+    }
+    const expectedURL = "https://example.com&param1=value1&param2=123&param3=1"
+    const result = appendParams(URL, params)
+    expect(result).toBe(expectedURL)
+  })
+
+  it("should handle boolean parameters correctly", () => {
+    const URL = "https://example.com"
+    const params = {
+      param1: true,
+      param2: false,
+    }
+    const expectedURL = "https://example.com&param1=1&param2=0"
+    const result = appendParams(URL, params)
+    expect(result).toBe(expectedURL)
+  })
+
+  it("should handle undefined parameters correctly", () => {
+    const URL = "https://example.com"
+    const params = {
+      param1: "value1",
+      param2: undefined,
+    }
+    const expectedURL = "https://example.com&param1=value1"
+    const result = appendParams(URL, params)
+    expect(result).toBe(expectedURL)
+  })
+})

__tests__/errorChecking.test.ts

@@ -0,0 +1,54 @@
+import { dateParamErrorChecking } from "../src/utils/errorChecking"
+
+describe("Util Functions (dateParamErrorChecking)", () => {
+  const currentDate = new Date("2024-05-15T00:00:00Z")
+
+  it("should throw an error if start_range_end is less than start_range_begin", () => {
+    const params = {
+      start_range_begin: "2024-05-13T00:00:00Z",
+      start_range_end: "2024-05-12T00:00:00Z", // One day before start_range_begin
+    }
+    expect(() => dateParamErrorChecking(params)).toThrow("start_range_end must be greater than start_range_begin.")
+  })
+
+  it("should throw an error if start_range_begin is more than 90 days ago and start_range_end is omitted", () => {
+    const ninetyOneDaysAgo = new Date(currentDate)
+    ninetyOneDaysAgo.setDate(ninetyOneDaysAgo.getDate() - 91) // Adjusted to 91 days ago
+    const params = {
+      start_range_begin: ninetyOneDaysAgo.toISOString(),
+    }
+
+    expect(() => dateParamErrorChecking(params)).toThrow(
+      "start_range_begin must be within the last 90 days if start_range_end is omitted."
+    )
+  })
+
+  it("should throw an error if finish_range_end is less than finish_range_begin", () => {
+    const params = {
+      finish_range_begin: "2024-05-13T00:00:00Z",
+      finish_range_end: "2024-05-12T00:00:00Z", // One day before finish_range_begin
+    }
+    expect(() => dateParamErrorChecking(params)).toThrow("finish_range_end must be greater than finish_range_begin.")
+  })
+
+  it("should throw an error if finish_range_begin is more than 90 days ago and finish_range_end is omitted", () => {
+    const ninetyOneDaysAgo = new Date(currentDate)
+    ninetyOneDaysAgo.setDate(ninetyOneDaysAgo.getDate() - 91) // Adjusted to 91 days ago
+    const params = {
+      finish_range_begin: ninetyOneDaysAgo.toISOString(),
+    }
+    expect(() => dateParamErrorChecking(params)).toThrow(
+      "finish_range_begin must be within the last 90 days if finish_range_end is omitted."
+    )
+  })
+
+  it("should return 'PASS' if all error checks pass", () => {
+    const params = {
+      start_range_begin: "2024-05-01T00:00:00Z",
+      start_range_end: "2024-05-14T00:00:00Z", // One day after currentDate
+      finish_range_begin: "2024-05-01T00:00:00Z",
+      finish_range_end: "2024-05-14T00:00:00Z", // One day after currentDate
+    }
+    expect(dateParamErrorChecking(params)).toBe("PASS")
+  })
+})

src/utils/errorChecking.ts

@@ -9,35 +9,50 @@ export const dateParamErrorChecking = ({
   finish_range_begin?: string
   finish_range_end?: string
 }) => {
-  // Error checking for start_range_begin and start_range_end
+  const currentDate = new Date()
+  const ninetyDaysAgo = new Date(currentDate)
+  ninetyDaysAgo.setDate(ninetyDaysAgo.getDate() - 90)
+
   if (start_range_begin && start_range_end) {
+    if (!isValidDate(start_range_begin) || !isValidDate(start_range_end)) {
+      throw new Error("Invalid date format provided for start_range_begin or start_range_end.")
+    }
     const startBeginDate = new Date(start_range_begin)
     const startEndDate = new Date(start_range_end)
-    const ninetyDaysAgo = new Date()
-    ninetyDaysAgo.setDate(ninetyDaysAgo.getDate() - 90)
-
     if (startBeginDate >= startEndDate) {
       throw new Error("start_range_end must be greater than start_range_begin.")
     }
+  }
+
+  if (start_range_begin && !start_range_end) {
+    const startBeginDate = new Date(start_range_begin)
     if (startBeginDate < ninetyDaysAgo) {
       throw new Error("start_range_begin must be within the last 90 days if start_range_end is omitted.")
     }
   }
 
-  // Error checking for finish_range_begin and finish_range_end
   if (finish_range_begin && finish_range_end) {
+    if (!isValidDate(finish_range_begin) || !isValidDate(finish_range_end)) {
+      throw new Error("Invalid date format provided for finish_range_begin or finish_range_end.")
+    }
     const finishBeginDate = new Date(finish_range_begin)
     const finishEndDate = new Date(finish_range_end)
-    const ninetyDaysAgo = new Date()
-    ninetyDaysAgo.setDate(ninetyDaysAgo.getDate() - 90)
-
     if (finishBeginDate >= finishEndDate) {
       throw new Error("finish_range_end must be greater than finish_range_begin.")
     }
+  }
+
+  if (finish_range_begin && !finish_range_end) {
+    const finishBeginDate = new Date(finish_range_begin)
     if (finishBeginDate < ninetyDaysAgo) {
       throw new Error("finish_range_begin must be within the last 90 days if finish_range_end is omitted.")
     }
   }
 
   return "PASS"
 }
+
+const isValidDate = (dateString: string) => {
+  const regex = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$/ // ISO 8601 format without milliseconds and UTC timezone
+  return regex.test(dateString) && !isNaN(Date.parse(dateString))
+}