[IMP] hooks: remove env related hooks

Author: mcm-odoo

src/runtime/hooks.ts

@@ -1,4 +1,3 @@
-import type { Env } from "./app";
 import { getCurrent } from "./component_node";
 import { onMounted, onPatched, onWillDestroy, onWillUnmount } from "./lifecycle_hooks";
 import { PluginConstructor, PluginManager } from "./plugins";
@@ -24,39 +23,6 @@ export function useRef<T extends HTMLElement = HTMLElement>(name: string): { el:
   };
 }
 
-// -----------------------------------------------------------------------------
-// useEnv and useSubEnv
-// -----------------------------------------------------------------------------
-
-/**
- * This hook is useful as a building block for some customized hooks, that may
- * need a reference to the env of the component calling them.
- */
-export function useEnv<E extends Env>(): E {
-  return getCurrent().component.env as any;
-}
-
-function extendEnv(currentEnv: Object, extension: Object): Object {
-  const env = Object.create(currentEnv);
-  const descrs = Object.getOwnPropertyDescriptors(extension);
-  return Object.freeze(Object.defineProperties(env, descrs));
-}
-
-/**
- * This hook is a simple way to let components use a sub environment.  Note that
- * like for all hooks, it is important that this is only called in the
- * constructor method.
- */
-export function useSubEnv(envExtension: Env) {
-  const node = getCurrent();
-  node.component.env = extendEnv(node.component.env as any, envExtension);
-  useChildSubEnv(envExtension);
-}
-
-export function useChildSubEnv(envExtension: Env) {
-  const node = getCurrent();
-  node.childEnv = extendEnv(node.childEnv, envExtension);
-}
 // -----------------------------------------------------------------------------
 // useEffect
 // -----------------------------------------------------------------------------

src/runtime/index.ts

@@ -47,15 +47,7 @@ export { untrack } from "./reactivity/computations";
 export { signal } from "./reactivity/signal";
 export { derived } from "./reactivity/derived";
 export { effect } from "./reactivity/effect";
-export {
-  useEffect,
-  useEnv,
-  useListener,
-  useRef,
-  useChildSubEnv,
-  useSubEnv,
-  usePlugins,
-} from "./hooks";
+export { useEffect, useListener, useRef, usePlugins } from "./hooks";
 export { batched, EventBus, htmlEscape, whenReady, markup } from "./utils";
 export {
   onWillStart,

tests/components/hooks.test.ts

@@ -10,12 +10,9 @@ import {
   onWillUpdateProps,
   useComponent,
   useEffect,
-  useEnv,
   useListener,
   useRef,
   proxy,
-  useChildSubEnv,
-  useSubEnv,
   xml,
   OwlError,
   props,
@@ -177,115 +174,6 @@ describe("hooks", () => {
     });
   });
 
-  test("can use useEnv", async () => {
-    expect.assertions(3);
-    class Test extends Component {
-      static template = xml`<div><t t-esc="env.val"/></div>`;
-      setup() {
-        expect(useEnv()).toBe(this.env);
-      }
-    }
-    const env = { val: 1 };
-    await mount(Test, fixture, { env });
-    expect(fixture.innerHTML).toBe("<div>1</div>");
-  });
-
-  test("useSubEnv modifies user env", async () => {
-    class Test extends Component {
-      static template = xml`<div><t t-esc="env.val"/></div>`;
-      setup() {
-        useSubEnv({ val2: 1 });
-      }
-    }
-    const env = { val: 3 };
-    const component = await mount(Test, fixture, { env });
-    expect(fixture.innerHTML).toBe("<div>3</div>");
-    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`<div><t t-esc="env.val"/></div>`;
-      setup() {
-        useChildSubEnv({ val2: 1 });
-      }
-    }
-    const env = { val: 3 };
-    const component = await mount(Test, fixture, { env });
-    expect(fixture.innerHTML).toBe("<div>3</div>");
-    expect(component.env).not.toHaveProperty("val2");
-    expect(component.env).toHaveProperty("val");
-  });
-
-  test("useSubEnv supports arbitrary descriptor", async () => {
-    let someVal = "maggot";
-    let someVal2 = "brain";
-
-    class Child extends Component {
-      static template = xml`<div><t t-esc="env.someVal" /> <t t-esc="env.someVal2" /></div>`;
-    }
-
-    class Test extends Component {
-      static template = xml`<Child />`;
-      static components = { Child };
-      setup() {
-        useSubEnv({
-          get someVal2() {
-            return someVal2;
-          },
-        });
-      }
-    }
-
-    const env = {
-      get someVal() {
-        return someVal;
-      },
-    };
-    const component = await mount(Test, fixture, { env });
-    expect(fixture.innerHTML).toBe("<div>maggot brain</div>");
-    someVal = "brain";
-    someVal2 = "maggot";
-    component.render(true);
-    await nextTick();
-    expect(fixture.innerHTML).toBe("<div>brain maggot</div>");
-  });
-
-  test("useChildSubEnv supports arbitrary descriptor", async () => {
-    let someVal = "maggot";
-    let someVal2 = "brain";
-
-    class Child extends Component {
-      static template = xml`<div><t t-esc="env.someVal" /> <t t-esc="env.someVal2" /></div>`;
-    }
-
-    class Test extends Component {
-      static template = xml`<Child />`;
-      static components = { Child };
-      setup() {
-        useChildSubEnv({
-          get someVal2() {
-            return someVal2;
-          },
-        });
-      }
-    }
-    someVal = "maggot";
-    const env = {
-      get someVal() {
-        return someVal;
-      },
-    };
-    const component = await mount(Test, fixture, { env });
-    expect(fixture.innerHTML).toBe("<div>maggot brain</div>");
-    someVal = "brain";
-    someVal2 = "maggot";
-    component.render(true);
-    await nextTick();
-    expect(fixture.innerHTML).toBe("<div>brain maggot</div>");
-  });
-
   test("can use useComponent", async () => {
     expect.assertions(2);
     class Test extends Component {
@@ -297,58 +185,6 @@ describe("hooks", () => {
     await mount(Test, fixture);
   });
 
-  test("parent and child env (with useSubEnv)", async () => {
-    class Child extends Component {
-      static template = xml`<div><t t-esc="env.val"/></div>`;
-    }
-
-    class Parent extends Component {
-      static template = xml`<t t-esc="env.val"/><Child/>`;
-      static components = { Child };
-      setup() {
-        useSubEnv({ val: 5 });
-      }
-    }
-    const env = { val: 3 };
-    await mount(Parent, fixture, { env });
-    expect(fixture.innerHTML).toBe("5<div>5</div>");
-  });
-
-  test("parent and child env (with useChildSubEnv)", async () => {
-    class Child extends Component {
-      static template = xml`<div><t t-esc="env.val"/></div>`;
-    }
-
-    class Parent extends Component {
-      static template = xml`<t t-esc="env.val"/><Child/>`;
-      static components = { Child };
-      setup() {
-        useChildSubEnv({ val: 5 });
-      }
-    }
-    const env = { val: 3 };
-    await mount(Parent, fixture, { env });
-    expect(fixture.innerHTML).toBe("3<div>5</div>");
-  });
-
-  test("parent and child env (with useChildSubEnv then useSubEnv)", async () => {
-    class Child extends Component {
-      static template = xml`<div t-if="env.hasParent"><t t-esc="env.val"/></div>`;
-    }
-
-    class Parent extends Component {
-      static template = xml`<t t-esc="env.val"/><Child/>`;
-      static components = { Child };
-      setup() {
-        useChildSubEnv({ hasParent: true });
-        useSubEnv({ val: 5 });
-      }
-    }
-    const env = { val: 3 };
-    await mount(Parent, fixture, { env });
-    expect(fixture.innerHTML).toBe("5<div>5</div>");
-  });
-
   test("can use onWillStart, onWillUpdateProps", async () => {
     const steps: string[] = [];
     async function slow(): Promise<string> {