import { Component, WEnv } from "../src/component"; import { makeDeferred, makeTestFixture, makeTestWEnv, nextMicroTick, nextTick, normalize } from "../demo/static/tests/helpers"; //------------------------------------------------------------------------------ // Setup and helpers //------------------------------------------------------------------------------ // We create before each test: // - fixture: a div, appended to the DOM, intended to be the target of dom // manipulations. Note that it is removed after each test. // - env: a WEnv, necessary to create new widgets let fixture: HTMLElement; let env: WEnv; beforeEach(() => { fixture = makeTestFixture(); env = makeTestWEnv(); env.qweb.addTemplate( "counter", `
` ); env.qweb.addTemplate("widgetA", `
Hello
`); env.qweb.addTemplate("widgetB", `
world
`); env.qweb.addTemplate("default", "
"); }); afterEach(() => { fixture.remove(); }); class Widget extends Component {} function children(w: Widget): Widget[] { const childrenMap = w.__widget__.children; return Object.keys(childrenMap).map(id => childrenMap[id]); } // Test widgets class Counter extends Widget { // class Counter extends Widget { template = "counter"; state = { counter: 0 }; inc() { this.updateState({ counter: this.state.counter + 1 }); } } class WidgetA extends Widget { template = "widgetA"; widgets = { b: WidgetB }; } class WidgetB extends Widget { template = "widgetB"; } //------------------------------------------------------------------------------ // Tests //------------------------------------------------------------------------------ describe("basic widget properties", () => { test("has no el after creation", async () => { const widget = new Widget(env); expect(widget.el).toBe(null); }); test("can be mounted", async () => { const widget = new Widget(env); await widget.mount(fixture); expect(fixture.innerHTML).toBe("
"); }); test("can be clicked on and updated", async () => { const counter = new Counter(env); const target = document.createElement("div"); await counter.mount(target); expect(target.innerHTML).toBe("
0
"); const button = (counter.el).getElementsByTagName("button")[0]; await button.click(); await nextMicroTick(); expect(target.innerHTML).toBe("
1
"); }); test("widget style and classname", async () => { class StyledWidget extends Widget { inlineTemplate = `
world
`; } const widget = new StyledWidget(env); await widget.mount(fixture); expect(fixture.innerHTML).toBe( `
world
` ); }); test("updateState before first render does not trigger a render", async () => { let renderCalls = 0; class TestW extends Widget { async willStart() { this.updateState({}); } async _render() { renderCalls++; return super._render(); } } const widget = new TestW(env); await widget.mount(fixture); expect(renderCalls).toBe(1); }); test("updateState does not allow adding extra keys", async () => { const widget = new Widget(env); try { await widget.updateState({ extra: 1 }); } catch (e) { expect(e.message).toMatch("Invalid key:"); } }); test("keeps a reference to env", async () => { const widget = new Widget(env); expect(widget.env).toBe(env); }); test("do not remove previously rendered dom if not necessary", async () => { const widget = new Widget(env); await widget.mount(fixture); expect(fixture.innerHTML).toBe(`
`); widget.el!.appendChild(document.createElement("span")); expect(fixture.innerHTML).toBe(`
`); widget.render(); expect(fixture.innerHTML).toBe(`
`); }); }); describe("lifecycle hooks", () => { test("willStart hook is called", async () => { let willstart = false; class HookWidget extends Widget { async willStart() { willstart = true; } } const widget = new HookWidget(env); await widget.mount(fixture); expect(willstart).toBe(true); }); test("mounted hook is not called if not in DOM", async () => { let mounted = false; class HookWidget extends Widget { async mounted() { mounted = true; } } const widget = new HookWidget(env); const target = document.createElement("div"); await widget.mount(target); expect(mounted).toBe(false); }); test("mounted hook is called if mounted in DOM", async () => { let mounted = false; class HookWidget extends Widget { async mounted() { mounted = true; } } const widget = new HookWidget(env); await widget.mount(fixture); expect(mounted).toBe(true); }); test("willStart hook is called on subwidget", async () => { let ok = false; class ParentWidget extends Widget { inlineTemplate = `
`; widgets = { child: ChildWidget }; } class ChildWidget extends Widget { async willStart() { ok = true; } } const widget = new ParentWidget(env); await widget.mount(fixture); expect(ok).toBe(true); }); test("mounted hook is called on subwidgets, in proper order", async () => { expect.assertions(4); let parentMounted = false; let childMounted = false; class ParentWidget extends Widget { inlineTemplate = `
`; widgets = { child: ChildWidget }; mounted() { expect(childMounted).toBe(false); parentMounted = true; } } class ChildWidget extends Widget { mounted() { expect(document.body.contains(this.el)).toBe(true); expect(parentMounted).toBe(true); childMounted = true; } } const widget = new ParentWidget(env); await widget.mount(fixture); expect(childMounted).toBe(true); }); test("willStart, mounted on subwidget rendered after main is mounted in some other position", async () => { expect.assertions(3); let hookCounter = 0; // the t-else part in the template is important. This is // necessary to have a situation that could confuse the vdom // patching algorithm class ParentWidget extends Widget { inlineTemplate = `
`; state = { ok: false }; widgets = { child: ChildWidget }; } class ChildWidget extends Widget { async willStart() { hookCounter++; } mounted() { expect(hookCounter).toBe(1); hookCounter++; } } const widget = new ParentWidget(env); await widget.mount(fixture); expect(hookCounter).toBe(0); // sub widget not created yet await widget.updateState({ ok: true }); expect(hookCounter).toBe(2); }); test("mounted hook is correctly called on subwidgets created in mounted hook", async done => { // the issue here is that the parent widget creates in the // mounted hook a new widget, which means that it modifies // in place its list of children. But this list of children is currently // being visited, so the mount action of the parent could cause a mount // action of the new child widget, even though it is not ready yet. expect.assertions(1); const target = document.createElement("div"); document.body.appendChild(target); class ParentWidget extends Widget { mounted() { const child = new ChildWidget(this); child.mount(this.el!); } } class ChildWidget extends Widget { mounted() { expect(this.el).toBeTruthy(); done(); } } const widget = new ParentWidget(env); await widget.mount(target); }); test("widgets are unmounted and destroyed if no longer in DOM", async () => { let steps: string[] = []; class ParentWidget extends Widget { state = { ok: true }; inlineTemplate = `
`; widgets = { child: ChildWidget }; } class ChildWidget extends Widget { constructor(parent) { super(parent); steps.push("init"); } async willStart() { steps.push("willstart"); } mounted() { steps.push("mounted"); } willUnmount() { steps.push("willunmount"); } destroyed() { steps.push("destroyed"); } } const widget = new ParentWidget(env); await widget.mount(fixture); expect(steps).toEqual(["init", "willstart", "mounted"]); await widget.updateState({ ok: false }); expect(steps).toEqual([ "init", "willstart", "mounted", "willunmount", "destroyed" ]); }); test("hooks are called in proper order in widget creation/destruction", async () => { let steps: string[] = []; class ParentWidget extends Widget { inlineTemplate = `
`; widgets = { child: ChildWidget }; constructor(parent) { super(parent); steps.push("p init"); } async willStart() { steps.push("p willstart"); } mounted() { steps.push("p mounted"); } willUnmount() { steps.push("p willunmount"); } destroyed() { steps.push("p destroyed"); } } class ChildWidget extends Widget { constructor(parent) { super(parent); steps.push("c init"); } async willStart() { steps.push("c willstart"); } mounted() { steps.push("c mounted"); } willUnmount() { steps.push("c willunmount"); } destroyed() { steps.push("c destroyed"); } } const widget = new ParentWidget(env); await widget.mount(fixture); widget.destroy(); expect(steps).toEqual([ "p init", "p willstart", "c init", "c willstart", "p mounted", "c mounted", "c willunmount", "c destroyed", "p willunmount", "p destroyed" ]); }); test("shouldUpdate hook prevent rerendering", async () => { let shouldUpdate = false; class TestWidget extends Widget { inlineTemplate = `
`; shouldUpdate() { return shouldUpdate; } } const widget = new TestWidget(env, { val: 42 }); await widget.mount(fixture); expect(fixture.innerHTML).toBe("
42
"); await widget.updateProps({ val: 123 }); expect(fixture.innerHTML).toBe("
42
"); shouldUpdate = true; await widget.updateProps({ val: 666 }); expect(fixture.innerHTML).toBe("
666
"); }); }); describe("destroy method", () => { test("destroy remove the widget from the DOM", async () => { const widget = new Widget(env); await widget.mount(fixture); expect(document.contains(widget.el)).toBe(true); widget.destroy(); expect(document.contains(widget.el)).toBe(false); expect(widget.__widget__.isMounted).toBe(false); expect(widget.__widget__.isDestroyed).toBe(true); }); test("destroying a widget twice only call destroyed once", async () => { let count = 0; class TestWidget extends Widget { destroyed() { count++; } } const widget = new TestWidget(env); await widget.mount(fixture); widget.destroy(); expect(count).toBe(1); widget.destroy(); expect(count).toBe(1); }); test("destroying a parent also destroys its children", async () => { const parent = new WidgetA(env); await parent.mount(fixture); const child = children(parent)[0]; expect(child.__widget__.isDestroyed).toBe(false); parent.destroy(); expect(child.__widget__.isDestroyed).toBe(true); }); test("destroy remove the parent/children link", async () => { const parent = new WidgetA(env); await parent.mount(fixture); const child = children(parent)[0]; expect(child.__widget__.parent).toBe(parent); expect(children(parent).length).toBe(1); child.destroy(); expect(child.__widget__.parent).toBe(null); expect(children(parent).length).toBe(0); }); test("destroying a widget before willStart is done", async () => { let def = makeDeferred(); let isRendered = false; class DelayedWidget extends Widget { willStart() { return def; } } expect(fixture.innerHTML).toBe(""); const widget = new DelayedWidget(env); widget.mount(fixture); expect(widget.__widget__.isStarted).toBe(false); expect(widget.__widget__.isMounted).toBe(false); expect(widget.__widget__.isDestroyed).toBe(false); widget.destroy(); expect(widget.__widget__.isMounted).toBe(false); expect(widget.__widget__.isStarted).toBe(false); expect(widget.__widget__.isDestroyed).toBe(true); def.resolve(); await nextTick(); expect(widget.__widget__.isStarted).toBe(false); expect(widget.__widget__.isMounted).toBe(false); expect(widget.__widget__.isDestroyed).toBe(true); expect(widget.__widget__.vnode).toBe(null); expect(fixture.innerHTML).toBe(""); expect(isRendered).toBe(false); }); }); describe("composition", () => { test("a widget with a sub widget", async () => { const widget = new WidgetA(env); await widget.mount(fixture); expect(fixture.innerHTML).toBe("
Hello
world
"); expect(children(widget)[0].__widget__.parent).toBe(widget); }); test("t-refs on widget are widgets", async () => { class WidgetC extends Widget { inlineTemplate = `
Hello
`; widgets = { b: WidgetB }; } const widget = new WidgetC(env); await widget.mount(fixture); expect(widget.refs.mywidgetb instanceof WidgetB).toBe(true); }); test("modifying a sub widget", async () => { class ParentWidget extends Widget { inlineTemplate = `
`; widgets = { Counter }; } const widget = new ParentWidget(env); await widget.mount(fixture); expect(fixture.innerHTML).toBe( "
0
" ); const button = fixture.getElementsByTagName("button")[0]; await button.click(); await nextMicroTick(); expect(fixture.innerHTML).toBe( "
1
" ); }); test("parent's elm for a children === children's elm, even after rerender", async () => { const widget = new WidgetA(env); await widget.mount(fixture); expect((widget.__widget__.vnode!.children![1]).elm).toBe( (children(widget)[0].__widget__.vnode).elm ); await children(widget)[0].render(); expect((widget.__widget__.vnode!.children![1]).elm).toBe( (children(widget)[0].__widget__.vnode).elm ); }); test("parent env is propagated to child widgets", async () => { const widget = new WidgetA(env); await widget.mount(fixture); expect(children(widget)[0].env).toBe(env); }); test("rerendering a widget with a sub widget", async () => { class ParentWidget extends Widget { inlineTemplate = `
`; widgets = { Counter }; } const widget = new ParentWidget(env); await widget.mount(fixture); const button = fixture.getElementsByTagName("button")[0]; await button.click(); await nextMicroTick(); expect(fixture.innerHTML).toBe( "
1
" ); await widget.render(); expect(fixture.innerHTML).toBe( "
1
" ); }); test("sub widgets are destroyed if no longer in dom, then recreated", async () => { class ParentWidget extends Widget { state = { ok: true }; inlineTemplate = `
`; widgets = { counter: Counter }; } const widget = new ParentWidget(env); await widget.mount(fixture); const button = fixture.getElementsByTagName("button")[0]; await button.click(); await nextMicroTick(); expect(fixture.innerHTML).toBe( "
1
" ); await widget.updateState({ ok: false }); expect(fixture.innerHTML).toBe("
"); await widget.updateState({ ok: true }); expect(fixture.innerHTML).toBe( "
0
" ); }); test("sub widgets with t-keep-alive are not destroyed if no longer in dom", async () => { class ParentWidget extends Widget { state = { ok: true }; inlineTemplate = `
`; widgets = { counter: Counter }; } const widget = new ParentWidget(env); await widget.mount(fixture); const button = fixture.getElementsByTagName("button")[0]; await button.click(); await nextMicroTick(); expect(fixture.innerHTML).toBe( "
1
" ); const counter = children(widget)[0]; expect(counter.__widget__.isMounted).toBe(true); await widget.updateState({ ok: false }); expect(fixture.innerHTML).toBe("
"); expect(counter.__widget__.isMounted).toBe(false); await widget.updateState({ ok: true }); expect(counter.__widget__.isMounted).toBe(true); expect(fixture.innerHTML).toBe( "
1
" ); }); test("sub widgets dom state with t-keep-alive is preserved", async () => { class ParentWidget extends Widget { state = { ok: true }; inlineTemplate = `
`; widgets = { InputWidget }; } class InputWidget extends Widget { inlineTemplate = ""; } const widget = new ParentWidget(env); await widget.mount(fixture); const input = fixture.getElementsByTagName("input")[0]; input.value = "test"; await widget.updateState({ ok: false }); expect(fixture.innerHTML).toBe("
"); await widget.updateState({ ok: true }); expect(fixture.innerHTML).toBe("
"); const input2 = fixture.getElementsByTagName("input")[0]; expect(input).toBe(input2); expect(input2.value).toBe("test"); }); test("sub widgets rendered in a loop", async () => { class ChildWidget extends Widget { inlineTemplate = ``; } class Parent extends Widget { inlineTemplate = `
`; state = { numbers: [1, 2, 3] }; widgets = { ChildWidget }; } const parent = new Parent(env); await parent.mount(fixture); expect(normalize(fixture.innerHTML)).toBe( normalize(`
1 2 3
`) ); }); test("sub widgets with some state rendered in a loop", async () => { let n = 1; class ChildWidget extends Widget { inlineTemplate = ``; constructor(parent) { super(parent); this.state = { n }; n++; } } env.qweb.addTemplate( "parent", `
` ); class Parent extends Widget { template = "parent"; state = { numbers: [1, 2, 3] }; widgets = { ChildWidget }; } const parent = new Parent(env); await parent.mount(fixture); await parent.updateState({ numbers: [1, 3] }); expect(normalize(fixture.innerHTML)).toBe( normalize(`
1 3
`) ); expect(env.qweb.templates.parent.toString()).toMatchSnapshot(); }); test("sub widgets between t-ifs", async () => { // this confuses the patching algorithm... class ChildWidget extends Widget { inlineTemplate = `child`; } class Parent extends Widget { inlineTemplate = `

hey

noo

test
`; state = { flag: false }; widgets = { ChildWidget }; } const parent = new Parent(env); await parent.mount(fixture); const child = children(parent)[0]; await parent.updateState({ flag: true }); expect(children(parent)[0]).toBe(child); expect(child.__widget__.isDestroyed).toBe(false); expect(normalize(fixture.innerHTML)).toBe( normalize(`

hey

child test
`) ); }); }); describe("props evaluation (with t-props directive)", () => { test("explicit object prop", async () => { class Parent extends Widget { inlineTemplate = `
`; widgets = { child: Child }; state = { val: 42 }; } class Child extends Widget { inlineTemplate = ``; state: { someval: number }; constructor(parent: Parent, props: { value: number }) { super(parent); this.state = { someval: props.value }; } } const widget = new Parent(env); await widget.mount(fixture); expect(fixture.innerHTML).toBe("
42
"); }); test("object prop value", async () => { class Parent extends Widget { inlineTemplate = `
`; widgets = { child: Child }; state = { val: 42 }; } class Child extends Widget { inlineTemplate = ``; state: { someval: number }; constructor(parent: Parent, props: { val: number }) { super(parent); this.state = { someval: props.val }; } } const widget = new Parent(env); await widget.mount(fixture); expect(fixture.innerHTML).toBe("
42
"); }); }); describe("other directives with t-widget", () => { test("t-on works as expected", async () => { let n = 0; class ParentWidget extends Widget { inlineTemplate = `
`; widgets = { child: Child }; someMethod(arg) { expect(arg).toBe(43); n++; } } class Child extends Widget {} const widget = new ParentWidget(env); await widget.mount(fixture); let child = children(widget)[0]; expect(n).toBe(0); child.trigger("customevent", 43); expect(n).toBe(1); child.destroy(); child.trigger("customevent", 43); expect(n).toBe(1); }); test("t-if works with t-widget", async () => { class ParentWidget extends Widget { inlineTemplate = `
`; widgets = { child: Child }; state = { flag: true }; } class Child extends Widget { inlineTemplate = "hey"; } const widget = new ParentWidget(env); await widget.mount(fixture); expect(fixture.innerHTML).toBe("
hey
"); await widget.updateState({ flag: false }); expect(fixture.innerHTML).toBe("
"); await widget.updateState({ flag: true }); expect(fixture.innerHTML).toBe("
hey
"); }); test("t-else works with t-widget", async () => { class ParentWidget extends Widget { inlineTemplate = `
somediv
`; widgets = { child: Child }; state = { flag: true }; } class Child extends Widget { inlineTemplate = "hey"; } const widget = new ParentWidget(env); await widget.mount(fixture); expect(normalize(fixture.innerHTML)).toBe("
somediv
"); await widget.updateState({ flag: false }); expect(normalize(fixture.innerHTML)).toBe("
hey
"); }); }); describe("random stuff/miscellaneous", () => { test("widget after a t-foreach", async () => { // this test makes sure that the foreach directive does not pollute sub // context with the inLoop variable, which is then used in the t-widget // directive as a key class Test extends Widget { inlineTemplate = `
txt
`; widgets = { widget: Widget }; } const widget = new Test(env); await widget.mount(fixture); expect(fixture.innerHTML).toBe("
txttxt
"); }); test("updating widget immediately", async () => { // in this situation, we protect against a bug that occurred: because of the // interplay between widgets and vnodes, a sub widget vnode was patched // twice. class Parent extends Widget { inlineTemplate = `
`; widgets = { child: Child }; state = { flag: false }; } class Child extends Widget { inlineTemplate = `abcdef`; } const widget = new Parent(env); await widget.mount(fixture); expect(fixture.innerHTML).toBe("
abc
"); await widget.updateState({ flag: true }); expect(fixture.innerHTML).toBe("
abcdef
"); }); test("snapshotting compiled code", async () => { env.qweb.addTemplate( "parent", `
` ); class Parent extends Widget { inlineTemplate = "parent"; widgets = { child: Child }; state = { flag: false }; } class Child extends Widget { inlineTemplate = `abcdef`; } const widget = new Parent(env); await widget.mount(fixture); expect(env.qweb.templates.parent.toString()).toMatchSnapshot(); }); }); describe("async rendering", () => { test("destroying a widget before start is over", async () => { let def = makeDeferred(); class W extends Widget { inlineTemplate = "invalid><"; willStart(): Promise { return def; } } const w = new W(env); w.mount(fixture); expect(w.__widget__.isDestroyed).toBe(false); expect(w.__widget__.isMounted).toBe(false); expect(w.__widget__.isStarted).toBe(false); w.destroy(); def.resolve(); await nextTick(); expect(w.__widget__.isDestroyed).toBe(true); expect(w.__widget__.isMounted).toBe(false); expect(w.__widget__.isStarted).toBe(false); }); test("destroying/recreating a subwidget with different props (if start is not over)", async () => { let def = makeDeferred(); let n = 0; class W extends Widget { inlineTemplate = `
`; widgets = { Child }; state = { val: 1 }; } class Child extends Widget { inlineTemplate = `child:`; constructor(parent, props) { super(parent, props); n++; } willStart(): Promise { return def; } } const w = new W(env); await w.mount(fixture); expect(n).toBe(0); w.updateState({ val: 2 }); expect(n).toBe(1); await nextTick(); w.updateState({ val: 3 }); expect(n).toBe(2); def.resolve(); await nextTick(); expect(children(w).length).toBe(1); expect(fixture.innerHTML).toBe("
child:3
"); }); test("creating two async widgets, scenario 1", async () => { let defA = makeDeferred(); let defB = makeDeferred(); class ChildA extends Widget { inlineTemplate = "a"; willStart(): Promise { return defA; } } class ChildB extends Widget { inlineTemplate = "b"; willStart(): Promise { return defB; } } class Parent extends Widget { inlineTemplate = `
`; widgets = { ChildA, ChildB }; state = { flagA: false, flagB: false }; } const parent = new Parent(env); await parent.mount(fixture); expect(fixture.innerHTML.replace(/\r?\n|\r|\s+/g, "")).toBe("
"); parent.updateState({ flagA: true }); await nextTick(); expect(fixture.innerHTML.replace(/\r?\n|\r|\s+/g, "")).toBe("
"); parent.updateState({ flagB: true }); await nextTick(); expect(fixture.innerHTML.replace(/\r?\n|\r|\s+/g, "")).toBe("
"); defB.resolve(); expect(fixture.innerHTML.replace(/\r?\n|\r|\s+/g, "")).toBe("
"); defA.resolve(); await nextTick(); expect(fixture.innerHTML.replace(/\r?\n|\r|\s+/g, "")).toBe( "
ab
" ); }); test("creating two async widgets, scenario 2", async () => { let defA = makeDeferred(); let defB = makeDeferred(); class ChildA extends Widget { inlineTemplate = `a`; updateProps(props): Promise { return defA.then(() => super.updateProps(props)); } } class ChildB extends Widget { inlineTemplate = `b`; willStart(): Promise { return defB; } } class Parent extends Widget { inlineTemplate = `
`; widgets = { ChildA, ChildB }; state = { valA: 1, valB: 2, flagB: false }; } const parent = new Parent(env); await parent.mount(fixture); expect(fixture.innerHTML.replace(/\r?\n|\r|\s+/g, "")).toBe( "
a1
" ); parent.updateState({ valA: 2 }); await nextTick(); expect(fixture.innerHTML.replace(/\r?\n|\r|\s+/g, "")).toBe( "
a1
" ); parent.updateState({ flagB: true }); await nextTick(); expect(fixture.innerHTML.replace(/\r?\n|\r|\s+/g, "")).toBe( "
a1
" ); defB.resolve(); expect(fixture.innerHTML.replace(/\r?\n|\r|\s+/g, "")).toBe( "
a1
" ); defA.resolve(); await nextTick(); expect(fixture.innerHTML.replace(/\r?\n|\r|\s+/g, "")).toBe( "
a2b2
" ); }); });