");
parent.state.valA = 2;
await nextMicroTick();
expect(steps.splice(0)).toEqual([
"Parent:setup",
"Parent:willStart",
"Parent:render",
"ChildA:setup",
"ChildA:willStart",
"ChildA:render",
"render",
"ChildA:mounted",
"Parent:mounted",
"Parent:render",
"ChildA:willUpdateProps",
]);
await nextMicroTick();
// For an unknown reason, this test fails on windows without the next microtick. It works
// in linux and osx, but fails on at least this machine.
// I do not see anything harmful in waiting an extra tick. But it is annoying to not
// know what is different.
await nextMicroTick();
expect(steps.splice(0)).toEqual(["ChildA:render", "render"]);
expect(fixture.innerHTML).toBe("
1
");
parent.state.valA = 3;
await nextMicroTick();
expect(steps.splice(0)).toEqual(["Parent:render", "ChildA:willUpdateProps"]);
await nextMicroTick();
// same as above
await nextMicroTick();
expect(steps).toEqual(["ChildA:render", "render"]);
expect(fixture.innerHTML).toBe("
");
// this change triggers a rendering of the parent. This rendering is delayed,
// because child is now waiting for def to be resolved
parent.state.val = "Framboise Girardin";
await nextTick();
expect(fixture.innerHTML).toBe("
");
// with this, we remove child, and subchild, even though it is not finished
// rendering from previous changes
parent.state.flag = false;
await nextTick();
expect(fixture.innerHTML).toBe("");
// we now resolve def, so the child rendering is now complete.
def.resolve();
await nextTick();
expect(fixture.innerHTML).toBe("");
expect(steps).toEqual([
"Parent:setup",
"Parent:willStart",
"Parent:render",
"Child:setup",
"Child:willStart",
"Child:render",
"SubChild:setup",
"SubChild:willStart",
"SubChild:render",
"SubChild:mounted",
"Child:mounted",
"Parent:mounted",
"Parent:render",
"Child:willUpdateProps",
"Child:render",
"SubChild:willUpdateProps",
"Parent:render",
"Parent:willPatch",
"Child:willUnmount",
"SubChild:willUnmount",
"SubChild:destroyed",
"Child:destroyed",
"Parent:patched",
]);
Object.freeze(steps);
});
test("rendering component again in next microtick", async () => {
const steps: string[] = [];
class Child extends Component {
static template = xml`
");
defs[0].resolve(); // resolve rendering initiated in A
await nextTick();
expect(fixture.innerHTML).toBe("
1b
"); // TODO: is this what we want?? 2b could be ok too
defs[1].resolve(); // resolve rendering initiated in B
await nextTick();
expect(fixture.innerHTML).toBe("
");
defB.resolve(); // resolve rendering initiated in A (still blocked in D)
await nextTick();
expect(fixture.innerHTML).toBe("
1c
");
defsD[0].resolve(); // resolve rendering initiated in C (should be ignored)
await nextTick();
expect(ComponentD.prototype.someValue).toBeCalledTimes(1);
expect(fixture.innerHTML).toBe("
1c
");
defsD[1].resolve(); // completely resolve rendering initiated in A
await nextTick();
expect(fixture.innerHTML).toBe("
");
defB.resolve(); // resolve rendering initiated in A (still blocked in D)
await nextTick();
expect(fixture.innerHTML).toBe("
1c
");
defsD[1].resolve(); // completely resolve rendering initiated in A
await nextTick();
expect(fixture.innerHTML).toBe("
2d
");
expect(ComponentD.prototype.someValue).toBeCalledTimes(2);
defsD[0].resolve(); // resolve rendering initiated in C (should be ignored)
await nextTick();
expect(fixture.innerHTML).toBe("
");
expect(steps).toEqual([
"ComponentA:setup",
"ComponentA:willStart",
"ComponentA:render",
"ComponentB:setup",
"ComponentB:willStart",
"ComponentB:render",
"ComponentB:mounted",
"ComponentA:mounted",
"ComponentA:render",
"ComponentB:willUpdateProps",
"ComponentB:render",
"ComponentA:willPatch",
"ComponentB:willPatch",
"ComponentB:patched",
"ComponentA:patched",
]);
Object.freeze(steps);
});
test("concurrent renderings scenario 9", async () => {
// Here is the global idea of this scenario:
// A
// / \
// B C
// |
// D
// A state is updated, triggering a whole re-rendering
// B is async, and blocked
// C (and D) are rendered
// C state is updated, producing a re-rendering of C and D
// this last re-rendering of C should be correctly re-mapped to the whole
// re-rendering
const steps: string[] = [];
const def = makeDeferred();
let stateC: any = null;
class ComponentD extends Component {
static template = xml``;
setup() {
useLogLifecycle(steps);
}
}
class ComponentC extends Component {
static template = xml`
");
expect(steps).toEqual([
"ComponentA:setup",
"ComponentA:willStart",
"ComponentA:render",
"ComponentB:setup",
"ComponentB:willStart",
"ComponentC:setup",
"ComponentC:willStart",
"ComponentB:render",
"ComponentC:render",
"ComponentD:setup",
"ComponentD:willStart",
"ComponentD:render",
"ComponentD:mounted",
"ComponentC:mounted",
"ComponentB:mounted",
"ComponentA:mounted",
"ComponentA:render",
"ComponentB:willUpdateProps",
"ComponentC:willUpdateProps",
"ComponentC:render",
"ComponentD:willUpdateProps",
"ComponentD:render",
"ComponentC:render",
"ComponentD:willUpdateProps",
"ComponentD:render",
"ComponentB:render",
"ComponentA:willPatch",
"ComponentB:willPatch",
"ComponentC:willPatch",
"ComponentD:willPatch",
"ComponentD:patched",
"ComponentC:patched",
"ComponentB:patched",
"ComponentA:patched",
]);
Object.freeze(steps);
});
test("concurrent renderings scenario 10", async () => {
// Here is the global idea of this scenario:
// A
// |
// B <- async willUpdateProps
// ----- <- conditional (initialy false)
// |
// C <- async willStart
// Render A and B normally
// Change the condition on B to trigger a re-rendering with C (async willStart)
// Change the state on A to trigger a global re-rendering, which is blocked
// in B (async willUpdateProps)
// Resolve the willStart of C: the first re-rendering has been cancelled by
// the global re-rendering, but handlers waiting for the rendering promise to
// resolve might execute and we don't want them to crash/do anything
const steps: string[] = [];
const defB = makeDeferred();
const defC = makeDeferred();
let stateB: any = null;
let rendered = 0;
class ComponentC extends Component {
static template = xml``;
setup() {
useLogLifecycle(steps);
onWillStart(() => defC);
}
get value() {
rendered++;
return this.props.value;
}
}
class ComponentB extends Component {
static template = xml`
");
expect(rendered).toBe(1);
expect(steps).toEqual([
"ComponentA:setup",
"ComponentA:willStart",
"ComponentA:render",
"ComponentB:setup",
"ComponentB:willStart",
"ComponentB:render",
"ComponentB:mounted",
"ComponentA:mounted",
"ComponentB:render",
"ComponentC:setup",
"ComponentC:willStart",
"ComponentA:render",
"ComponentB:willUpdateProps",
"ComponentB:render",
"ComponentC:destroyed",
"ComponentC:setup",
"ComponentC:willStart",
"ComponentC:render",
"ComponentA:willPatch",
"ComponentB:willPatch",
"ComponentC:mounted",
"ComponentB:patched",
"ComponentA:patched",
]);
Object.freeze(steps);
});
test("concurrent renderings scenario 11", async () => {
// This scenario is the following: we have a component being updated (by props),
// and then rendered (render method), but before the willUpdateProps resolves.
// We check that in that case, the return value of the render method is a promise
// that is resolved when the component is completely rendered (so, properly
// remapped to the promise of the ambient rendering)
const steps: string[] = [];
const def = makeDeferred();
let child: any = null;
class Child extends Component {
static template = xml`|`;
val = 3;
setup() {
useLogLifecycle(steps);
onWillUpdateProps(() => {
child = this;
return def;
});
}
}
class Parent extends Component {
static template = xml`
");
expect(steps).toEqual([
"Parent:setup",
"Parent:willStart",
"Parent:render",
"Child:setup",
"Child:willStart",
"Child:render",
"Child:mounted",
"Parent:mounted",
"Parent:render",
"Child:willUpdateProps",
"Child:render",
"Parent:willPatch",
"Child:willPatch",
"Child:patched",
"Parent:patched",
]);
Object.freeze(steps);
});
test("concurrent renderings scenario 12", async () => {
// In this scenario, we have a parent component that will be re-rendered
// several times simultaneously:
// - once in a tick: it will create a new fiber, render it, but will have
// to wait for its child (blocking) to be completed
// - twice in the next tick: it will twice reuse the same fiber (as it is
// rendered but not completed yet)
const steps: string[] = [];
const def = makeDeferred();
class Child extends Component {
static template = xml``;
setup() {
useLogLifecycle(steps);
onWillUpdateProps(() => def);
}
}
let rendered = 0;
class Parent extends Component {
static template = xml`
");
await nextTick(); // wait for changes triggered in mounted to be applied
expect(fixture.innerHTML).toBe("
1
");
parent.state.bool = true;
await nextTick(); // wait for this change to be applied
await nextTick(); // wait for changes triggered in mounted to be applied
expect(fixture.innerHTML).toBe("
`;
state = useState({ fromC: 3 });
setup() {
useLogLifecycle(steps);
c = this;
}
}
class B extends Component {
static template = xml`
`;
static components = { C };
setup() {
useLogLifecycle(steps);
b = this;
}
state = useState({ fromB: 2 });
}
class A extends Component {
static template = xml`
`;
static components = { B };
state = useState({ fromA: 1 });
setup() {
useLogLifecycle(steps);
}
}
const a = await mount(A, fixture);
expect(fixture.innerHTML).toBe("
123
");
// trigger a re-rendering of the whole tree
a.state.fromA += 10;
// wait enough for the whole tree to be re-rendered, but not patched yet
await nextMicroTick();
await nextMicroTick();
await nextMicroTick();
await nextMicroTick();
await nextMicroTick();
expect(fixture.innerHTML).toBe("
123
");
// trigger a re-rendering from C, which will remap its new fiber
c!.state.fromC += 10;
// trigger a re-rendering from B, which will remap its new fiber as well
b!.state.fromB += 10;
await nextTick();
// at this point, all re-renderings should have been done correctly, and
// the root fiber (A) counter should have been reset to 0, so the DOM should
// have been patched with the updated version of each component
expect(fixture.innerHTML).toBe(
"
`;
state = useState({ fromC: 3 });
setup() {
useLogLifecycle(steps);
c = this;
}
}
class B extends Component {
static template = xml`
`;
static components = { C };
setup() {
useLogLifecycle(steps);
b = this;
}
state = useState({ fromB: 2 });
}
class A extends Component {
static template = xml`
`;
static components = { B };
state = useState({ fromA: 1 });
setup() {
useLogLifecycle(steps);
}
}
const app = new App(A);
const a = await app.mount(fixture);
expect(fixture.innerHTML).toBe("
123
");
// trigger a re-rendering of the whole tree
a.state.fromA += 10;
// wait enough for the whole tree to be re-rendered, but not patched yet
await nextMicroTick();
await nextMicroTick();
await nextMicroTick();
await nextMicroTick();
await nextMicroTick();
expect(fixture.innerHTML).toBe("
123
");
// trigger a re-rendering from C, which will remap its new fiber
c!.state.fromC += 10;
// trigger a re-rendering from B, which will remap its new fiber as well
b!.state.fromB += 10;
// simulate a flush (nothing should have changed as no fiber should have its
// counter to 0)
app.scheduler.flush();
expect(fixture.innerHTML).toBe("
123
");
// wait a bit and simulate another flush (we expect nothing to change as well)
await nextMicroTick();
app.scheduler.flush();
expect(fixture.innerHTML).toBe("
`;
static components = { D };
state = { fromC: 3 }; // not reactive
setup() {
useLogLifecycle(steps);
c = this;
}
}
class B extends Component {
static template = xml`
`;
static components = { C };
setup() {
useLogLifecycle(steps);
b = this;
}
state = useState({ fromB: 2 });
}
class A extends Component {
static template = xml`
`;
static components = { B };
state = useState({ fromA: 1 });
setup() {
useLogLifecycle(steps);
}
}
const a = await mount(A, fixture);
expect(fixture.innerHTML).toBe("
123
");
// trigger a re-rendering of the whole tree
a.state.fromA += 10;
// wait enough for the whole tree to be re-rendered, but not patched yet
await nextMicroTick();
await nextMicroTick();
await nextMicroTick();
await nextMicroTick();
await nextMicroTick();
expect(fixture.innerHTML).toBe("
123
");
// trigger a re-rendering from C, which will remap its new fiber
c!.state.fromC += 10;
const prom = c!.render();
// trigger a re-rendering from B, which will remap its new fiber as well
b!.state.fromB += 10;
await nextTick();
// at this point, C rendering is still pending, and nothing should have been
// updated yet.
expect(fixture.innerHTML).toBe("
123
");
await prom;
expect(fixture.innerHTML).toBe(
"
111213
DDD
"
);
expect(steps).toEqual([
"A:setup",
"A:willStart",
"A:render",
"B:setup",
"B:willStart",
"B:render",
"C:setup",
"C:willStart",
"C:render",
"C:mounted",
"B:mounted",
"A:mounted",
"A:render",
"B:willUpdateProps",
"B:render",
"C:willUpdateProps",
"C:render",
"B:render",
"C:willUpdateProps",
"C:render",
"D:setup",
"D:willStart",
"D:render",
"A:willPatch",
"B:willPatch",
"C:willPatch",
"D:mounted",
"C:patched",
"B:patched",
"A:patched",
]);
Object.freeze(steps);
});
// test.skip("concurrent renderings scenario 17", async () => {
// class Parent extends Component {
// static template = xml``;
// state = useState({ value: 1 });
// }
// const parent = await mount(Parent, fixture);
// expect(fixture.innerHTML).toBe("1");
// parent.state.value = 2;
// parent.__owl__.fiber!.cancel();
// parent.state.value = 3; // update value directly
// await nextTick();
// expect(fixture.innerHTML).toBe("3");
// parent.state.value = 4; // update value after a tick
// await nextTick();
// expect(fixture.innerHTML).toBe("4");
// });
// TODO: unskip when t-key is reimplemented properly
test("calling render in destroy", async () => {
const steps: any[] = [];
let a: any = null;
let c: any = null;
class C extends Component {
static template = xml`
`;
}
let flag = false;
class B extends Component {
static template = xml``;
static components = { C };
setup() {
c = this;
onMounted(() => {
steps.push("B:mounted");
if (flag) {
this.render();
} else {
flag = true;
}
});
onWillUnmount(() => {
steps.push("B:willUnmount");
c.render();
});
}
}
class A extends Component {
static template = xml``;
static components = { B };
state = "a";
key = 1;
setup() {
a = this;
}
}
const app = new App(A);
await app.mount(fixture);
expect(fixture.innerHTML).toBe("
a
");
a.state = "A";
a.key = 2;
await a.render();
// this nextTick is critical, otherwise jest may silently swallow errors
await nextTick();
expect(steps).toStrictEqual(["B:mounted", "B:willUnmount", "B:mounted"]);
expect(fixture.innerHTML).toBe("
A
");
});
test("change state and call manually render: no unnecessary rendering", async () => {
const steps: string[] = [];
let numberOfRender = 0;
class Test extends Component {
static template = xml`
`;
state = useState({ val: 1 });
setup() {
useLogLifecycle(steps);
}
get value() {
numberOfRender++;
return this.state.val;
}
}
const test = await mount(Test, fixture);
expect(fixture.innerHTML).toBe("