move registries into env, reorganize some code

web/static/tests/helpers/test_data.ts

@@ -1,39 +1,20 @@
-import { readFile } from "fs";
 import { BaseMenuItem, getMenuInfo } from "../../src/ts/loaders";
-import { actionRegistry, viewRegistry } from "../../src/ts/registries";
 import { ActionDescription } from "../../src/ts/store/action_manager_mixin";
 import { MenuInfo } from "../../src/ts/store/store";
-import { Registry } from "../../src/ts/core/registry";
 
 export interface TestData {
   menuInfo: MenuInfo;
   actions: ActionDescription[];
-  actionRegistry: typeof actionRegistry;
-  viewRegistry: typeof viewRegistry;
-  templates: string;
 }
 
-let templates: string;
-
-export async function makeTestData(): Promise<TestData> {
-  if (!templates) {
-    templates = await loadTemplates();
-  }
-  const _actionRegistry: typeof actionRegistry = new Registry();
-  (<any>_actionRegistry).map = Object.assign({}, (<any>actionRegistry).map);
-  const _viewRegistry: typeof actionRegistry = new Registry();
-  (<any>_viewRegistry).map = Object.assign({}, (<any>actionRegistry).map);
-
+export function makeTestData(): TestData {
   return {
     menuInfo: makeMenuInfo(),
-    actions: makeActionData(),
-    actionRegistry: _actionRegistry,
-    viewRegistry: _viewRegistry,
-    templates
+    actions: makeActionData()
   };
 }
 
-export function makeMenuInfo(): MenuInfo {
+function makeMenuInfo(): MenuInfo {
   const items: BaseMenuItem[] = [
     {
       id: 96,
@@ -215,10 +196,28 @@ function makeActionData(): ActionDescription[] {
   ];
 }
 
-function loadTemplates(): Promise<string> {
-  return new Promise((resolve, reject) => {
-    readFile("web/static/src/xml/templates.xml", "utf-8", (err, result) => {
-      resolve(result);
-    });
-  });
-}
+// function loadTemplates(): Promise<string> {
+//   return new Promise((resolve, reject) => {
+//     readFile("web/static/src/xml/templates.xml", "utf-8", (err, result) => {
+//       resolve(result);
+//     });
+//   });
+// }
+
+// export async function makeTestData(): Promise<TestData> {
+//   if (!templates) {
+//     templates = await loadTemplates();
+//   }
+//   const _actionRegistry: typeof actionRegistry = new Registry();
+//   (<any>_actionRegistry).map = Object.assign({}, (<any>actionRegistry).map);
+//   const _viewRegistry: typeof actionRegistry = new Registry();
+//   (<any>_viewRegistry).map = Object.assign({}, (<any>actionRegistry).map);
+
+//   return {
+//     menuInfo: makeMenuInfo(),
+//     actions: makeActionData(),
+//     actionRegistry: _actionRegistry,
+//     viewRegistry: _viewRegistry,
+//     templates
+//   };
+// }

web/static/tests/helpers/test_env.ts

@@ -1,13 +1,17 @@
+import { readFileSync } from "fs";
 import { WEnv } from "../../src/ts/core/component";
 import { QWeb } from "../../src/ts/core/qweb_vdom";
 import { Registry } from "../../src/ts/core/registry";
 import { idGenerator } from "../../src/ts/core/utils";
-import { Env, makeEnv } from "../../src/ts/env";
-import { IRouter } from "../../src/ts/services/router";
-import { MenuInfo, Store } from "../../src/ts/store/store";
+import { Env, InitData, linkStoreToEnv, makeEnv } from "../../src/ts/env";
+import {
+  actionRegistry as AR,
+  viewRegistry as VR
+} from "../../src/ts/registries";
+import { Store } from "../../src/ts/store/store";
 import { MockRouter } from "./mock_router";
 import { MockServer } from "./mock_server";
-import { TestData } from "./test_data";
+import { makeTestData, TestData } from "./test_data";
 
 //------------------------------------------------------------------------------
 // Types
@@ -17,11 +21,16 @@ export interface TestEnv extends Env {
   store: Store;
 }
 
-export interface TestInfo extends Partial<TestData> {
+export interface TestInfo extends Partial<InitData>, Partial<TestData> {
   mockRPC?(this: MockServer, route: string, params: any): Promise<any>;
-  router?: IRouter;
 }
 
+//------------------------------------------------------------------------------
+// Code
+//------------------------------------------------------------------------------
+
+const TEMPLATES = readFileSync("web/static/src/xml/templates.xml", "utf-8");
+
 export function makeTestWEnv(): WEnv {
   return {
     qweb: new QWeb(),
@@ -29,44 +38,50 @@ export function makeTestWEnv(): WEnv {
   };
 }
 
-//------------------------------------------------------------------------------
-// Code
-//------------------------------------------------------------------------------
-
 export function makeTestEnv(info: TestInfo = {}): TestEnv {
-  const templates = info.templates || "";
-  const menuInfo: MenuInfo = info.menuInfo || {
-    menus: {},
-    actionMap: {},
-    roots: []
-  };
-  const actionRegistry = info.actionRegistry || new Registry();
-  const viewRegistry = info.viewRegistry || new Registry();
-  const actions = info.actions || [];
+  const templates = info.templates || TEMPLATES;
+  const testData: TestData = makeTestData();
+  if (info.menuInfo) {
+    testData.menuInfo = info.menuInfo;
+  }
+  if (info.actions) {
+    testData.actions = info.actions;
+  }
 
-  const data: TestData = {
-    menuInfo,
-    actions,
+  const actionRegistry = info.actionRegistry || cloneRegistry(AR);
+  const viewRegistry = info.viewRegistry || cloneRegistry(VR);
+
+  let rpc = info.services && info.services.rpc;
+  if (!rpc) {
+    const mockServer = new MockServer(testData);
+    rpc = function(route: string, params: any): Promise<any> {
+      if (info.mockRPC) {
+        return info.mockRPC.call(mockServer, route, params);
+      }
+      return mockServer.rpc(route, params);
+    };
+  }
+
+  const router = (info.services && info.services.router) || new MockRouter();
+  const initData: InitData = {
+    services: {
+      rpc,
+      router
+    },
     actionRegistry,
     viewRegistry,
     templates
   };
 
-  const mockServer = new MockServer(data);
-
-  function rpc(route: string, params: any): Promise<any> {
-    if (info.mockRPC) {
-      return info.mockRPC.call(mockServer, route, params);
-    }
-    return mockServer.rpc(route, params);
-  }
-  const services = {
-    rpc,
-    router: info.router || new MockRouter()
-  };
-
-  const store = new Store(services, menuInfo, actionRegistry, viewRegistry);
-  const env = makeEnv(store, templates);
+  const env = makeEnv(initData);
+  const store = new Store(env, testData.menuInfo);
+  linkStoreToEnv(env, store);
   const testEnv = Object.assign({ store }, env);
   return testEnv;
 }
+
+function cloneRegistry<T>(registry: Registry<T>): Registry<T> {
+  const clone: Registry<T> = new Registry();
+  (<any>clone).map = Object.assign({}, (<any>registry).map);
+  return clone;
+}

web/static/tests/store/action_manager_mixin_test.ts

@@ -1,5 +1,5 @@
-import { makeTestData, makeTestEnv } from "../helpers";
 import { Registry } from "../../src/ts/core/registry";
+import { makeTestEnv } from "../helpers";
 
 //------------------------------------------------------------------------------
 // Tests
@@ -7,9 +7,7 @@ import { Registry } from "../../src/ts/core/registry";
 
 test("does not reload action if already done", async () => {
   const routes: string[] = [];
-  const data = await makeTestData();
   const testEnv = makeTestEnv({
-    ...data,
     mockRPC(route, params) {
       routes.push(route);
       return this.rpc(route, params);
@@ -28,9 +26,7 @@ test("does not reload action if already done", async () => {
 });
 
 test("display a warning if client action is not in registry", async () => {
-  const data = await makeTestData();
-  data.actionRegistry = new Registry();
-  const testEnv = makeTestEnv(data);
+  const testEnv = makeTestEnv({ actionRegistry: new Registry() });
 
   await testEnv.store.doAction(131);
 
@@ -40,9 +36,7 @@ test("display a warning if client action is not in registry", async () => {
 });
 
 test("display a warning if view is not in registry", async () => {
-  const data = await makeTestData();
-  data.viewRegistry = new Registry();
-  const testEnv = makeTestEnv(data);
+  const testEnv = makeTestEnv({ viewRegistry: new Registry() });
 
   await testEnv.store.doAction(250);
 

web/static/tests/store/store.test.ts

@@ -1,4 +1,9 @@
-import { makeTestData, makeTestEnv, nextMicroTick } from "../helpers";
+import { Store } from "../../src/ts/store/store";
+import { makeTestEnv, nextMicroTick, TestInfo } from "../helpers";
+
+function makeTestStore(info?: TestInfo): Store {
+  return makeTestEnv(info).store;
+}
 
 //------------------------------------------------------------------------------
 // Tests
@@ -8,18 +13,18 @@ describe("rpc", () => {
   test("properly translate query in route", async () => {
     expect.assertions(1);
 
-    const store = makeTestEnv({
+    const store = makeTestStore({
       mockRPC(route, params) {
         expect(route).toBe("/web/dataset/call_kw/test/hey");
         return this.rpc(route, params);
       }
-    }).store;
+    });
 
     await store.rpc({ model: "test", method: "hey" });
   });
 
   test("trigger proper events", async () => {
-    const store = makeTestEnv().store;
+    const store = makeTestStore();
     const events: string[] = [];
     store.on("rpc_status", null, s => {
       events.push(s);
@@ -34,7 +39,7 @@ describe("rpc", () => {
 
 describe("notifications", () => {
   test("can subscribe and add notification", () => {
-    const store = makeTestEnv().store;
+    const store = makeTestStore();
     expect(store.state.notifications.length).toBe(0);
     const id = store.addNotification({
       title: "test",
@@ -45,7 +50,7 @@ describe("notifications", () => {
   });
 
   test("can close a notification", () => {
-    const store = makeTestEnv().store;
+    const store = makeTestStore();
 
     const id = store.addNotification({
       title: "test",
@@ -59,7 +64,7 @@ describe("notifications", () => {
 
   test("notifications closes themselves after a while", () => {
     jest.useFakeTimers();
-    const store = makeTestEnv().store;
+    const store = makeTestStore();
 
     store.addNotification({ title: "test", message: "message" });
 
@@ -71,7 +76,7 @@ describe("notifications", () => {
 
   test("sticky notifications do not close themselves after a while", () => {
     jest.useFakeTimers();
-    const store = makeTestEnv().store;
+    const store = makeTestStore();
 
     store.addNotification({
       title: "test",
@@ -88,32 +93,32 @@ describe("notifications", () => {
 
 describe("state transitions", () => {
   test("toggle menu", async () => {
-    const data = await makeTestData();
-    const store = makeTestEnv(data).store;
+    const env = makeTestEnv();
+    const store = env.store;
     expect(store.state.inHome).toBe(true);
     store.toggleHomeMenu();
 
     // should still be in home menu since no app is currently active
     expect(store.state.inHome).toBe(true);
-    expect(store.services.router.getQuery()).toEqual({ home: true });
+    expect(env.services.router.getQuery()).toEqual({ home: true });
 
     const promise = store.activateMenuItem(96);
-    expect(store.services.router.getQuery()).toEqual({ home: true });
+    expect(env.services.router.getQuery()).toEqual({ home: true });
 
     await promise;
     store.activateController(store.lastController!);
     expect(store.state.inHome).toBe(false);
-    expect(store.services.router.getQuery()).toEqual({
+    expect(env.services.router.getQuery()).toEqual({
       action_id: "131",
       menu_id: "96"
     });
 
     store.toggleHomeMenu();
     expect(store.state.inHome).toBe(true);
-    expect(store.services.router.getQuery()).toEqual({ home: true });
+    expect(env.services.router.getQuery()).toEqual({ home: true });
     store.toggleHomeMenu();
     expect(store.state.inHome).toBe(false);
-    expect(store.services.router.getQuery()).toEqual({
+    expect(env.services.router.getQuery()).toEqual({
       action_id: "131",
       menu_id: "96"
     });
@@ -121,8 +126,7 @@ describe("state transitions", () => {
 
   test("document title", async () => {
     document.title = "Odoo";
-    const data = await makeTestData();
-    const store = makeTestEnv(data).store;
+    const store = makeTestStore();
     expect(store.state.inHome).toBe(true);
     expect(document.title).toBe("Odoo");
     const promise = store.activateMenuItem(96);

web/static/tests/ui/home_menu.test.ts

@@ -1,5 +1,5 @@
 import { HomeMenu } from "../../src/ts/ui/home_menu";
-import { makeTestData, makeTestEnv, makeTestFixture } from "../helpers";
+import { makeTestEnv, makeTestFixture } from "../helpers";
 
 //------------------------------------------------------------------------------
 // Setup and helpers
@@ -20,9 +20,8 @@ afterEach(() => {
 //------------------------------------------------------------------------------
 
 test("can be rendered", async () => {
-  const data = await makeTestData();
-  const testEnv = makeTestEnv(data);
-  const props = { menuInfo: data.menuInfo };
+  const testEnv = makeTestEnv();
+  const props = { menuInfo: testEnv.store.menuInfo };
   const homeMenu = new HomeMenu(testEnv, props);
   await homeMenu.mount(fixture);
   expect(fixture.innerHTML).toMatchSnapshot();

web/static/tests/ui/navbar.test.ts

@@ -11,12 +11,11 @@ let env: helpers.TestEnv;
 let props: Props;
 let menuInfo: MenuInfo;
 
-beforeEach(async () => {
+beforeEach(() => {
   fixture = helpers.makeTestFixture();
-  const data = await helpers.makeTestData();
-  env = helpers.makeTestEnv(data);
+  env = helpers.makeTestEnv();
   props = { inHome: false, app: null };
-  menuInfo = helpers.makeMenuInfo();
+  menuInfo = env.store.menuInfo;
 });
 
 afterEach(() => {

web/static/tests/ui/notification.test.ts

@@ -11,8 +11,7 @@ let env: helpers.TestEnv;
 
 beforeEach(async () => {
   fixture = helpers.makeTestFixture();
-  const data = await helpers.makeTestData();
-  env = helpers.makeTestEnv(data);
+  env = helpers.makeTestEnv();
 });
 
 afterEach(() => {

web/static/tests/ui/root.test.ts

@@ -1,7 +1,7 @@
+import { Registry } from "../../src/ts/core/registry";
 import { Root } from "../../src/ts/ui/root";
 import * as helpers from "../helpers";
-import { makeTestData, makeTestEnv } from "../helpers";
-import { Registry } from "../../src/ts/core/registry";
+import { makeTestEnv } from "../helpers";
 
 //------------------------------------------------------------------------------
 // Setup and helpers
@@ -22,17 +22,15 @@ afterEach(() => {
 //------------------------------------------------------------------------------
 
 test("can be rendered (in home menu)", async () => {
-  const data = await makeTestData();
-  const testEnv = makeTestEnv(data);
+  const testEnv = makeTestEnv();
   const root = new Root(testEnv, testEnv.store);
   await root.mount(fixture);
   expect(fixture.innerHTML).toMatchSnapshot();
 });
 
 test("if url has action_id, will render action and navigate to proper menu_id", async () => {
-  const data = await makeTestData();
   const router = new helpers.MockRouter({ action_id: "131" });
-  const testEnv = makeTestEnv({ ...data, router });
+  const testEnv = makeTestEnv({ services: <any>{ router } });
   await helpers.nextTick();
 
   const root = new Root(testEnv, testEnv.store);
@@ -46,8 +44,7 @@ test("if url has action_id, will render action and navigate to proper menu_id",
 });
 
 test("start with no action => clicks on client action => discuss is rendered", async () => {
-  const data = await makeTestData();
-  const testEnv = makeTestEnv(data);
+  const testEnv = makeTestEnv();
   const root = new Root(testEnv, testEnv.store);
   await root.mount(fixture);
 
@@ -64,9 +61,7 @@ test("start with no action => clicks on client action => discuss is rendered", a
 });
 
 test("clicks on client action with invalid key => empty widget is rendered + warning", async () => {
-  const data = await makeTestData();
-  data.actionRegistry = new Registry();
-  const testEnv = makeTestEnv(data);
+  const testEnv = makeTestEnv({ actionRegistry: new Registry() });
   const root = new Root(testEnv, testEnv.store);
   await root.mount(fixture);
 
@@ -78,9 +73,7 @@ test("clicks on client action with invalid key => empty widget is rendered + war
 });
 
 test("open act window action with invalid viewtype => empty widget is rendered + warning", async () => {
-  const data = await makeTestData();
-  data.viewRegistry = new Registry();
-  const testEnv = makeTestEnv(data);
+  const testEnv = makeTestEnv({ viewRegistry: new Registry() });
   const root = new Root(testEnv, testEnv.store);
   await root.mount(fixture);