bonob/tests/utils.test.ts

import { asURLSearchParams, mask, takeWithRepeats } from "../src/utils";

describe("asURLSearchParams", () => {
  describe("empty q", () => {
    it("should return empty params", () => {
      const q = {};
      const expected = new URLSearchParams();
      expect(asURLSearchParams(q)).toEqual(expected);
    });
  });

  describe("singular params", () => {
    it("should append each", () => {
      const q = {
        a: 1,
        b: "bee",
        c: false,
        d: true,
      };
      const expected = new URLSearchParams();
      expected.append("a", "1");
      expected.append("b", "bee");
      expected.append("c", "false");
      expected.append("d", "true");

      expect(asURLSearchParams(q)).toEqual(expected);
    });
  });

  describe("list params", () => {
    it("should append each", () => {
      const q = {
        a: [1, "two", false, true],
        b: "yippee",
      };

      const expected = new URLSearchParams();
      expected.append("a", "1");
      expected.append("a", "two");
      expected.append("a", "false");
      expected.append("a", "true");
      expected.append("b", "yippee");

      expect(asURLSearchParams(q)).toEqual(expected);
    });
  });
});

describe("takeWithRepeat", () => {
  describe("when there is nothing in the input", () => {
    it("should return an array of undefineds", () => {
      expect(takeWithRepeats([], 3)).toEqual([undefined, undefined, undefined]);
    });
  });

  describe("when there are exactly the amount required", () => {
    it("should return them all", () => {
      expect(takeWithRepeats(["a", undefined, "c"], 3)).toEqual([
        "a",
        undefined,
        "c",
      ]);
      expect(takeWithRepeats(["a"], 1)).toEqual(["a"]);
      expect(takeWithRepeats([undefined], 1)).toEqual([undefined]);
    });
  });

  describe("when there are less than the amount required", () => {
    it("should cycle through the ones available", () => {
      expect(takeWithRepeats(["a", "b"], 3)).toEqual(["a", "b", "a"]);
      expect(takeWithRepeats(["a", "b"], 5)).toEqual(["a", "b", "a", "b", "a"]);
    });
  });

  describe("when there more than the amount required", () => {
    it("should return the first n items", () => {
      expect(takeWithRepeats(["a", "b", "c"], 2)).toEqual(["a", "b"]);
      expect(takeWithRepeats(["a", undefined, "c"], 2)).toEqual([
        "a",
        undefined,
      ]);
    });
  });
});

describe("mask", () => {
  it.each([
    [{}, ["a", "b"], {}],
    [{ foo: "bar" }, ["a", "b"], { foo: "bar" }],
    [{ a: 1 }, ["a", "b"], { a: "****" }],
    [{ a: 1, b: "dog" }, ["a", "b"], { a: "****", b: "****" }],
    [
      { a: 1, b: "dog", foo: "bar" },
      ["a", "b"],
      { a: "****", b: "****", foo: "bar" },
    ],
  ])(
    "masking of %s, keys = %s, should result in %s",
    (original: any, keys: string[], expected: any) => {
      const copyOfOrig = JSON.parse(JSON.stringify(original));
      const masked = mask(original, keys);
      expect(masked).toEqual(expected);
      expect(original).toEqual(copyOfOrig);
    }
  );
});