From a951c484be03c47cce0abe05b09d0413e2ca4fd1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?G=C3=A9ry=20Debongnie?= <ged@odoo.com>
Date: Fri, 5 Apr 2019 23:28:21 +0200
Subject: [PATCH] ref: rename componentDidUpdate hook into 'updated'

closes #16
---
 src/component.ts        | 16 ++++++++++++----
 tests/component.test.ts | 16 ++++++++--------
 2 files changed, 20 insertions(+), 12 deletions(-)

diff --git a/src/component.ts b/src/component.ts
index cfa4b7e8..687694c2 100644
--- a/src/component.ts
+++ b/src/component.ts
@@ -154,6 +154,9 @@ export class Component<
    * It is not called on the initial render.  This is useful to get some
    * information which are in the DOM.  For example, the current position of the
    * scrollbar
+   *
+   * Note that at this point, it is not safe to rerender the widget. In
+   * particular, updateState calls should be avoided.
    */
   willPatch() {}
 
@@ -164,8 +167,13 @@ export class Component<
    * This method is not called on the initial render. It is useful to interact
    * with the DOM (for example, through an external library) whenever the
    * component was updated.
+   *
+   * Updating the widget state in this hook is possible, but not encouraged.
+   * One need to be careful, because updates here will cause rerender, which in
+   * turn will cause other calls to updated. So, we need to be particularly
+   * careful at avoiding endless cycles.
    */
-  componentDidUpdate() {}
+  updated() {}
 
   /**
    * willUnmount is a hook that is called each time a component is detached from
@@ -301,7 +309,7 @@ export class Component<
     if (this.__widget__.isMounted) {
       await this.render(true);
     }
-    this.componentDidUpdate();
+    this.updated();
   }
 
   async updateProps(
@@ -333,7 +341,7 @@ export class Component<
     if (this.__widget__.isStarted) {
       await this.render();
     }
-    this.componentDidUpdate();
+    this.updated();
   }
 
   //--------------------------------------------------------------------------
@@ -343,7 +351,7 @@ export class Component<
   async _updateProps(nextProps: Props): Promise<void> {
     this.props = nextProps;
     await this.render();
-    this.componentDidUpdate();
+    this.updated();
   }
 
   _patch(vnode) {
diff --git a/tests/component.test.ts b/tests/component.test.ts
index a3865496..ce83012f 100644
--- a/tests/component.test.ts
+++ b/tests/component.test.ts
@@ -387,13 +387,13 @@ describe("lifecycle hooks", () => {
     ]);
   });
 
-  test("componentDidUpdate hook is called after updateState", async () => {
+  test("updated hook is called after updateState", async () => {
     let n = 0;
 
     class TestWidget extends Widget {
       state = { a: 1 };
 
-      componentDidUpdate() {
+      updated() {
         n++;
       }
     }
@@ -408,11 +408,11 @@ describe("lifecycle hooks", () => {
     expect(n).toBe(1);
   });
 
-  test("componentDidUpdate hook is called after updateProps", async () => {
+  test("updated hook is called after updateProps", async () => {
     let n = 0;
 
     class TestWidget extends Widget {
-      componentDidUpdate() {
+      updated() {
         n++;
       }
     }
@@ -424,13 +424,13 @@ describe("lifecycle hooks", () => {
     expect(n).toBe(1);
   });
 
-  test("componentDidUpdate hook is called after updateEnv", async () => {
+  test("updated hook is called after updateEnv", async () => {
     let n = 0;
 
     class TestWidget extends Widget {
       state = { a: 1 };
 
-      componentDidUpdate() {
+      updated() {
         n++;
       }
     }
@@ -511,7 +511,7 @@ describe("lifecycle hooks", () => {
       willPatch() {
         steps.push("parent:willPatch");
       }
-      componentDidUpdate() {
+      updated() {
         steps.push("parent:updated");
       }
     }
@@ -520,7 +520,7 @@ describe("lifecycle hooks", () => {
       willPatch() {
         steps.push("child:willPatch");
       }
-      componentDidUpdate() {
+      updated() {
         steps.push("child:updated");
       }
     }