feat: inspections (#3213)

Co-authored-by: Liyas Thomas <liyascthomas@gmail.com>

packages/hoppscotch-common/src/services/inspection/inspectors/header.inspector.ts

@@ -0,0 +1,78 @@
+import { Service } from "dioc"
+import { InspectionService, Inspector, InspectorResult } from ".."
+import { getI18n } from "~/modules/i18n"
+import { HoppRESTRequest } from "@hoppscotch/data"
+import { markRaw, ref } from "vue"
+import IconAlertTriangle from "~icons/lucide/alert-triangle"
+
+/**
+ * This inspector is responsible for inspecting the header of a request.
+ * It checks if the header contains cookies.
+ *
+ * NOTE: Initializing this service registers it as a inspector with the Inspection Service.
+ */
+export class HeaderInspectorService extends Service implements Inspector {
+  public static readonly ID = "HEADER_INSPECTOR_SERVICE"
+
+  private t = getI18n()
+
+  public readonly inspectorID = "header"
+
+  private readonly inspection = this.bind(InspectionService)
+
+  constructor() {
+    super()
+
+    this.inspection.registerInspector(this)
+  }
+
+  /**
+   * Checks if the header contains cookies
+   * @param req The request to inspect
+   * @returns The inspector results
+   */
+  getInspectorFor(req: HoppRESTRequest): InspectorResult[] {
+    const results = ref<InspectorResult[]>([])
+
+    const cookiesCheck = (headerKey: string) => {
+      const cookieKeywords = ["Cookie", "Set-Cookie", "Cookie2", "Set-Cookie2"]
+
+      return cookieKeywords.includes(headerKey)
+    }
+
+    const headers = req.headers
+
+    const headerKeys = Object.values(headers).map((header) => header.key)
+
+    const isContainCookies = headerKeys.includes("Cookie")
+
+    if (isContainCookies) {
+      headerKeys.forEach((headerKey, index) => {
+        if (cookiesCheck(headerKey)) {
+          results.value.push({
+            id: "header",
+            icon: markRaw(IconAlertTriangle),
+            text: {
+              type: "text",
+              text: this.t("inspections.header.cookie"),
+            },
+            severity: 2,
+            isApplicable: true,
+            locations: {
+              type: "header",
+              position: "key",
+              key: headerKey,
+              index: index,
+            },
+            doc: {
+              text: this.t("action.learn_more"),
+              link: "https://docs.hoppscotch.io/",
+            },
+          })
+        }
+      })
+    }
+
+    return results.value
+  }
+}