owl/tests/utils.test.ts

import {
  escape,
  htmlTrim,
  idGenerator,
  memoize,
  debounce,
  findInTree,
  shallowEqual,
  patch,
  unpatch
} from "../src/utils";

describe("escape", () => {
  test("normal strings", () => {
    const text = "abc";
    expect(escape(text)).toBe(text);
  });

  test("special symbols", () => {
    const text = "<ok>";
    expect(escape(text)).toBe("&lt;ok&gt;");
  });
});

describe("htmlTrim", () => {
  test("basic use", () => {
    expect(htmlTrim("abc")).toBe("abc");
    expect(htmlTrim("  abc")).toBe(" abc");
    expect(htmlTrim("abc  ")).toBe("abc ");
    expect(htmlTrim("   abc   ")).toBe(" abc ");
    expect(htmlTrim("abc\n   ")).toBe("abc ");
    expect(htmlTrim("\n ")).toBe(" ");
    expect(htmlTrim(" \n ")).toBe(" ");
    expect(htmlTrim("  ")).toBe(" ");
    expect(htmlTrim("")).toBe("");
  });
});

describe("idGenerator", () => {
  test("basic use", () => {
    let gen = idGenerator();
    expect(gen()).toBe(1);
    expect(gen()).toBe(2);
    expect(gen()).toBe(3);
  });
});

describe("memoize", () => {
  test("return correct value", () => {
    const f = memoize((a, b) => a + b);
    expect(f(1, 3)).toBe(4);
  });

  test("does not recompute if not needed", () => {
    let nCalls = 0;
    function origFunction(a: number, b: number): number {
      nCalls++;
      return a + b;
    }
    const memoized = memoize(origFunction);

    expect(memoized(1, 3)).toBe(4);
    expect(memoized(1, 3)).toBe(4);
    expect(nCalls).toBe(1);
  });
});

describe("debounce", () => {
  test("works as expected", () => {
    jest.useFakeTimers();
    let n = 0;
    let f = debounce(() => n++, 100);
    expect(n).toBe(0);
    f();
    expect(n).toBe(0);
    f();
    expect(n).toBe(0);
    jest.advanceTimersByTime(90);
    expect(n).toBe(0);
    jest.advanceTimersByTime(20);
    expect(n).toBe(1);
  });
});

describe("findInTree", () => {
  test("can find stuff in tree", () => {
    let tree = {
      id: 1,
      children: [{ id: 2, children: [] }, { id: 3, key: "hello", children: [] }]
    };
    const match1 = findInTree(tree, t => t.id === 3);
    expect((<any>match1).key).toBe("hello");
    const match2 = findInTree(tree, t => t.id === 4);
    expect(match2).toBe(null);
  });
});

describe("shallowEqual", () => {
  test("simple comparisons", () => {
    const obj1 = {};
    expect(shallowEqual(obj1, obj1)).toBe(true);
    expect(shallowEqual({}, {})).toBe(true);
    expect(shallowEqual({ a: 1 }, {})).toBe(false);
    expect(shallowEqual({ a: 1 }, { a: 1 })).toBe(true);
    expect(shallowEqual({ a: 1 }, ["a"])).toBe(false);
  });
});

describe("patch/unpatch", () => {
  test("can monkey patch a class", () => {
    class Test {
      n = 1;

      doSomething(): string {
        return "hey";
      }
    }

    patch(Test, "some_custo", {
      doSomething(): string {
        this.n = this.n + 1;
        return this._super();
      }
    });

    const t = new Test();
    expect(t.n).toBe(1);
    expect(t.doSomething()).toBe("hey");
    expect(t.n).toBe(2);
  });

  test("cannot patch a class twice with same patch name", () => {
    class Test {}

    patch(Test, "some_custo", {});
    expect(() => {
      patch(Test, "some_custo", {});
    }).toThrow();
  });

  test("can unpatch a class", () => {
    class Test {
      doSomething(): number {
        return 1;
      }
    }

    patch(Test, "some_custo", {
      doSomething(): number {
        return this._super() + 2;
      }
    });

    const t = new Test();
    expect(t.doSomething()).toBe(3);

    unpatch(Test, "some_custo");
    expect(t.doSomething()).toBe(1);
  });
});