api-client/packages/hoppscotch-js-sandbox/src/__tests__/utils/pre-request.spec.ts

import {
  HoppRESTAuth,
  HoppRESTReqBody,
  HoppRESTRequest,
} from "@hoppscotch/data"
import { describe, expect, test } from "vitest"

import { getRequestSetterMethods } from "~/utils/pre-request"

const baseRequest: HoppRESTRequest = {
  v: "16",
  name: "Test Request",
  endpoint: "https://example.com/api",
  method: "GET",
  headers: [{ key: "X-Test", value: "val1", active: true, description: "" }],
  params: [{ key: "q", value: "search", active: true, description: "" }],
  body: { contentType: null, body: null },
  auth: { authType: "none", authActive: false },
  preRequestScript: "",
  testScript: "",
  requestVariables: [],
  responses: {},
}

describe("getRequestSetterMethods", () => {
  test("`setUrl` method", () => {
    const { methods, updatedRequest } = getRequestSetterMethods(baseRequest)
    methods.setUrl("https://updated.com/api")

    expect(updatedRequest.endpoint).toBe("https://updated.com/api")
  })

  test("`setMethod` should update the method (case preserved)", () => {
    const { methods, updatedRequest } = getRequestSetterMethods(baseRequest)
    methods.setMethod("post")

    expect(updatedRequest.method).toBe("post")
  })

  test("`setHeader` setter should update existing header case-insensitively", () => {
    const { methods, updatedRequest } = getRequestSetterMethods(baseRequest)
    methods.setHeader("x-test", "updatedVal")

    expect(
      updatedRequest.headers.find((h) => h.key.toLowerCase() === "x-test")
        ?.value
    ).toBe("updatedVal")
  })

  test("`setHeader` setter should add new header if not present", () => {
    const { methods, updatedRequest } = getRequestSetterMethods(baseRequest)
    methods.setHeader("X-New-Header", "newValue")

    expect(updatedRequest.headers.some((h) => h.key === "X-New-Header")).toBe(
      true
    )
    expect(
      updatedRequest.headers.find((h) => h.key === "X-New-Header")?.value
    ).toBe("newValue")
  })

  test("`removeHeader` setter should remove a header", () => {
    const { methods, updatedRequest } = getRequestSetterMethods(baseRequest)
    methods.removeHeader("X-Test")

    expect(
      updatedRequest.headers.find((h) => h.key === "X-Test")
    ).toBeUndefined()
  })

  test("`setParam` setter should update existing param case-insensitively", () => {
    const { methods, updatedRequest } = getRequestSetterMethods(baseRequest)
    methods.setParam("Q", "updatedParam")

    expect(
      updatedRequest.params.find((p) => p.key.toLowerCase() === "q")?.value
    ).toBe("updatedParam")
  })

  test("`setParam` setter should add new param if absent", () => {
    const { methods, updatedRequest } = getRequestSetterMethods(baseRequest)
    methods.setParam("newParam", "value")

    expect(updatedRequest.params.some((p) => p.key === "newParam")).toBe(true)
  })

  test("`removeParam` setter should remove a param", () => {
    const { methods, updatedRequest } = getRequestSetterMethods(baseRequest)
    methods.removeParam("q")

    expect(updatedRequest.params.find((p) => p.key === "q")).toBeUndefined()
  })

  test("`setBody` setter should update the body with complete replacement", () => {
    const { methods, updatedRequest } = getRequestSetterMethods(baseRequest)
    const newBody: HoppRESTReqBody = {
      contentType: "application/json",
      body: JSON.stringify({ changed: true }),
    }

    methods.setBody(newBody)
    expect(updatedRequest.body).toEqual(newBody)
  })

  test("`setBody` setter should support partial merge", () => {
    // Set up a request with existing body
    const requestWithBody: HoppRESTRequest = {
      ...baseRequest,
      body: {
        contentType: "application/json",
        body: JSON.stringify({ existing: "data" }),
      },
    }

    const { methods, updatedRequest } = getRequestSetterMethods(requestWithBody)

    // Only update contentType, preserving existing body
    methods.setBody({ contentType: "application/xml" })

    expect(updatedRequest.body).toEqual({
      contentType: "application/xml",
      body: JSON.stringify({ existing: "data" }),
    })
  })

  test("`setAuth` setter should update the authorization properties with complete replacement", () => {
    const { methods, updatedRequest } = getRequestSetterMethods(baseRequest)
    const newAuth: HoppRESTAuth = {
      authType: "basic",
      username: "abc",
      password: "123",
      authActive: true,
    }

    methods.setAuth(newAuth)
    expect(updatedRequest.auth).toEqual(newAuth)
  })

  test("`setAuth` setter should support partial merge", () => {
    // Set up a request with existing auth
    const requestWithAuth: HoppRESTRequest = {
      ...baseRequest,
      auth: {
        authType: "basic",
        username: "existing-user",
        password: "existing-pass",
        authActive: true,
      },
    }

    const { methods, updatedRequest } = getRequestSetterMethods(requestWithAuth)

    // Only update username, preserving other auth fields
    methods.setAuth({ username: "updated-user" } as Partial<HoppRESTAuth>)

    expect(updatedRequest.auth).toEqual({
      authType: "basic",
      username: "updated-user",
      password: "existing-pass",
      authActive: true,
    })
  })

  test("`setHeaders` setter throws error on invalid input", () => {
    const { methods } = getRequestSetterMethods(baseRequest)
    expect(() => methods.setHeaders(null)).toThrow()
  })

  test("`setParams` setter throws error on invalid input", () => {
    const { methods } = getRequestSetterMethods(baseRequest)
    expect(() => methods.setParams(null)).toThrow()
  })

  test("`setBody` setter throws error on invalid input", () => {
    const { methods } = getRequestSetterMethods(baseRequest)
    expect(() => methods.setBody("invalid_body")).toThrow()
  })

  test("`setAuth` setter throws error on invalid input", () => {
    const { methods } = getRequestSetterMethods(baseRequest)
    expect(() => methods.setAuth([6])).toThrow()
  })
})