feat: add support for Digest authorization (#4339)

Co-authored-by: jamesgeorge007 <25279263+jamesgeorge007@users.noreply.github.com>
Co-authored-by: nivedin <nivedinp@gmail.com>

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

@@ -0,0 +1,106 @@
+import {
+  HoppRESTRequest,
+  HoppRESTResponseOriginalRequest,
+} from "@hoppscotch/data"
+import { Service } from "dioc"
+import { computed, markRaw, Ref } from "vue"
+
+import { getI18n } from "~/modules/i18n"
+import { AgentInterceptorService } from "~/platform/std/interceptors/agent"
+import { InterceptorService } from "~/services/interceptor.service"
+import { RESTTabService } from "~/services/tab/rest"
+import IconAlertTriangle from "~icons/lucide/alert-triangle"
+import { InspectionService, Inspector, InspectorResult } from ".."
+
+/**
+ * This inspector is responsible for inspecting the authorization properties of a request.
+ * Only applies to REST tabs currently.
+ *
+ * NOTE: Initializing this service registers it as a inspector with the Inspection Service.
+ */
+export class AuthorizationInspectorService
+  extends Service
+  implements Inspector
+{
+  public static readonly ID = "AUTHORIZATION_INSPECTOR_SERVICE"
+
+  private t = getI18n()
+
+  public readonly inspectorID = "authorization"
+
+  private readonly inspection = this.bind(InspectionService)
+  private readonly interceptorService = this.bind(InterceptorService)
+  private readonly agentService = this.bind(AgentInterceptorService)
+  private readonly restTabService = this.bind(RESTTabService)
+
+  override onServiceInit() {
+    this.inspection.registerInspector(this)
+  }
+
+  private resolveAuthType(auth: HoppRESTRequest["auth"]) {
+    if (auth.authType !== "inherit") {
+      return auth.authType
+    }
+
+    const activeTabDocument =
+      this.restTabService.currentActiveTab.value.document
+
+    if (activeTabDocument.type === "example-response") {
+      return null
+    }
+
+    const { inheritedProperties } = activeTabDocument
+
+    if (!inheritedProperties) {
+      return null
+    }
+
+    return inheritedProperties.auth.inheritedAuth.authType
+  }
+
+  getInspections(
+    req: Readonly<Ref<HoppRESTRequest | HoppRESTResponseOriginalRequest>>
+  ) {
+    return computed(() => {
+      const currentInterceptorIDValue =
+        this.interceptorService.currentInterceptorID.value
+
+      if (!currentInterceptorIDValue) {
+        return []
+      }
+
+      const auth = req.value.auth
+
+      const results: InspectorResult[] = []
+
+      // `Agent` interceptor is recommended while using Digest Auth
+      const isUnsupportedInterceptor =
+        this.interceptorService.currentInterceptorID.value !==
+        this.agentService.interceptorID
+
+      const resolvedAuthType = this.resolveAuthType(auth)
+
+      if (resolvedAuthType === "digest" && isUnsupportedInterceptor) {
+        results.push({
+          id: "url",
+          icon: markRaw(IconAlertTriangle),
+          text: {
+            type: "text",
+            text: this.t("authorization.digest.inspector_warning"),
+          },
+          severity: 2,
+          isApplicable: true,
+          locations: {
+            type: "url",
+          },
+          doc: {
+            text: this.t("action.learn_more"),
+            link: "https://docs.hoppscotch.io/documentation/features/inspections",
+          },
+        })
+      }
+
+      return results
+    })
+  }
+}