");
expect(component.env).toHaveProperty("val2");
expect(component.env).toHaveProperty("val");
});
test("useChildSubEnv does not pollute user env", async () => {
class Test extends Component {
static template = xml`
");
});
test("can use onWillStart, onWillUpdateProps", async () => {
const steps: string[] = [];
async function slow(): Promise {
return new Promise((resolve) => {
setTimeout(() => {
resolve("slow");
}, 0);
});
}
function useMyHook() {
onWillStart(async () => {
steps.push(await slow());
steps.push("onWillStart");
});
onWillUpdateProps(async (nextProps) => {
expect(nextProps).toEqual({ value: 2 });
steps.push(await slow());
steps.push("onWillUpdateProps");
});
}
function use2ndHook() {
onWillStart(() => {
steps.push("on2ndStart");
});
onWillUpdateProps((nextProps) => {
expect(nextProps).toEqual({ value: 2 });
steps.push("on2ndUpdate");
});
}
class MyComponent extends Component {
static template = xml``;
setup() {
useMyHook();
use2ndHook();
}
}
class App extends Component {
static template = xml``;
static components = { MyComponent };
state = useState({ value: 1 });
}
const app = await mount(App, fixture);
expect(fixture.innerHTML).toBe("1");
// NOTE: 'on2ndStart' appears first in the list even though
// the 'use2ndHook' is declared after 'useMyHook'. This is
// because Promise.all is used to call the callbacks specified
// in the hooks, which runs them simultaneously.
// Additionally, 'slow' should be listed before 'onWillStart'
// because call to `slow` is awaited.
expect(steps).toEqual(["on2ndStart", "slow", "onWillStart"]);
app.state.value = 2;
await nextTick();
expect(fixture.innerHTML).toBe("2");
expect(steps).toEqual([
"on2ndStart",
"slow",
"onWillStart",
"on2ndUpdate",
"slow",
"onWillUpdateProps",
]);
});
test("useExternalListener", async () => {
let n = 0;
class MyComponent extends Component {
static template = xml``;
setup() {
useExternalListener(window, "click", this.increment);
}
increment() {
n++;
}
}
class App extends Component {
static template = xml``;
static components = { MyComponent };
state = useState({ flag: false });
}
const app = await mount(App, fixture);
expect(n).toBe(0);
window.dispatchEvent(new Event("click"));
expect(n).toBe(0);
app.state.flag = true;
await nextTick();
window.dispatchEvent(new Event("click"));
expect(n).toBe(1);
app.state.flag = false;
await nextTick();
window.dispatchEvent(new Event("click"));
expect(n).toBe(1);
});
describe("useEffect hook", () => {
test("effect runs on mount, is reapplied on patch, and is cleaned up on unmount and before reapplying", async () => {
let cleanupRun = 0;
let steps = [];
class MyComponent extends Component {
state = useState({
value: 0,
});
setup() {
useEffect(() => {
steps.push(`value is ${this.state.value}`);
return () =>
steps.push(`cleaning up for value = ${this.state.value} (cleanup ${cleanupRun++})`);
});
}
}
MyComponent.template = xml``;
const component = await mount(MyComponent, fixture);
steps.push("before state mutation");
component.state.value++;
// Wait for an owl render
await new Promise((resolve) => requestAnimationFrame(resolve));
steps.push("after state mutation");
await component.__owl__.destroy();
expect(steps).toEqual([
"value is 0",
"before state mutation",
// While one might expect value to be 0 at cleanup, because the value is
// read during cleanup from the state rather than captured by a dependency
// it already has the new value. Having this in business code is a symptom
// of a missing dependency and can lead to bugs.
"cleaning up for value = 1 (cleanup 0)",
"value is 1",
"after state mutation",
"cleaning up for value = 1 (cleanup 1)",
]);
});
test("effect can depend on stuff in dom", async () => {
class MyComponent extends Component {
static template = xml`
`;
state = useState({
value: false,
});
setup() {
const ref = useRef("div");
useEffect(
(el) => {
logStep("effect started:" + (el ? "EL" : "NULL"));
return () => logStep("cleaning up effect:" + (el ? "EL" : "NULL"));
},
() => [ref.el]
);
}
}
const component = await mount(MyComponent, fixture);
expect(["effect started:NULL"]).toBeLogged();
component.state.value = true;
await nextTick();
expect(["cleaning up effect:NULL", "effect started:EL"]).toBeLogged();
});
test("dependencies prevent effects from rerunning when unchanged", async () => {
let steps = [];
class MyComponent extends Component {
state = useState({
a: 0,
b: 0,
});
setup() {
useEffect(
(a) => {
steps.push(`Effect a: ${a}`);
return () => steps.push(`cleaning up for a: ${a}`);
},
() => [this.state.a]
);
useEffect(
(b) => {
steps.push(`Effect b: ${b}`);
return () => steps.push(`cleaning up for b: ${b}`);
},
() => [this.state.b]
);
useEffect(
(a, b) => {
steps.push(`Effect ab: {a: ${a}, b: ${b}}`);
return () => steps.push(`cleaning up for ab: {a: ${a}, b: ${b}}`);
},
() => [this.state.a, this.state.b]
);
}
}
MyComponent.template = xml``;
steps.push("before mount");
const component = await mount(MyComponent, fixture);
steps.push("after mount");
steps.push("before state mutation: a");
component.state.a++;
// Wait for an owl render
await new Promise((resolve) => requestAnimationFrame(resolve));
steps.push("after state mutation: a");
steps.push("before state mutation: b");
component.state.b++;
// Wait for an owl render
await new Promise((resolve) => requestAnimationFrame(resolve));
steps.push("after state mutation: b");
await component.__owl__.destroy();
expect(steps).toEqual([
// All effects run on mount
"before mount",
"Effect a: 0",
"Effect b: 0",
"Effect ab: {a: 0, b: 0}",
"after mount",
"before state mutation: a",
// Cleanups run in reverse order
// Cleanup for b is not run
"cleaning up for a: 0",
"Effect a: 1",
"cleaning up for ab: {a: 0, b: 0}",
// Effect b is not run
"Effect ab: {a: 1, b: 0}",
"after state mutation: a",
"before state mutation: b",
"cleaning up for b: 0",
// Cleanup for a is not run
// Effect a is not run
"Effect b: 1",
"cleaning up for ab: {a: 1, b: 0}",
"Effect ab: {a: 1, b: 1}",
"after state mutation: b",
// All cleanups run on unmount
"cleaning up for ab: {a: 1, b: 1}",
"cleaning up for b: 1",
"cleaning up for a: 1",
]);
});
test("effect with empty dependency list never reruns", async () => {
let steps = [];
class MyComponent extends Component {
state = useState({
value: 0,
});
setup() {
useEffect(
() => {
steps.push(`value is ${this.state.value}`);
return () => steps.push(`cleaning up for ${this.state.value}`);
},
() => []
);
}
}
MyComponent.template = xml``;
const component = await mount(MyComponent, fixture);
steps.push("before state mutation");
component.state.value++;
// Wait for an owl render
await new Promise((resolve) => requestAnimationFrame(resolve));
// Value was correctly changed inside the component
expect(elem(component).textContent).toBe("1");
steps.push("after state mutation");
await component.__owl__.destroy();
expect(steps).toEqual([
"value is 0",
"before state mutation",
// no cleanup or effect caused by mutation
"after state mutation",
// Value being clean
"cleaning up for 1",
]);
});
test("properly behaves when the effect function throws", async () => {
let originalconsoleError = console.error;
let originalconsoleWarn = console.warn;
console.error = jest.fn(() => {});
console.warn = jest.fn(() => {});
class MyComponent extends Component {
static template = xml``;
setup() {
useEffect(
() => {
throw new Error("Intentional error");
},
() => []
);
}
}
let error: OwlError;
const app = new App(MyComponent);
const appError = nextAppError(app);
const mountProm = app.mount(fixture).catch((e: Error) => (error = e));
await expect(appError).resolves.toThrow("error occured in the owl lifecycle");
await mountProm;
expect(error!.cause.message).toBe("Intentional error");
// no console.error because the error has been caught in this test
expect(console.error).toHaveBeenCalledTimes(0);
console.error = originalconsoleError;
// 1 console.warn because app is destroyed
expect(console.warn).toHaveBeenCalledTimes(1);
console.warn = originalconsoleWarn;
});
});
});