wip(okam-core): optimize observable method naming for private method …

…using double underline and up $nextTick init
ecomfe · Jan 4, 2019 · dfecb09 · dfecb09
1 parent 4e17767
commit dfecb09
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 34 deletions.
diff --git a/packages/okam-core/src/extend/data/observable/ComputedObserver.js b/packages/okam-core/src/extend/data/observable/ComputedObserver.js
@@ -132,7 +132,7 @@ export default class ComputedObserver {
             result[k] = this.initDeps(k);
         });
 
-        this.ctx.$setData(result);
+        this.ctx.__setViewData(result);
     }
 
     /**
@@ -181,7 +181,7 @@ export default class ComputedObserver {
             : (old !== value || (typeof old === 'object'));
         if (neeUpdate) {
             ctx.data[p] = value;
-            ctx.$setData({[p]: value});
+            ctx.__setViewData({[p]: value});
             this.notifyWatcher(value, old, [p]);
         }
     }

diff --git a/packages/okam-core/src/extend/data/observable/Observer.js b/packages/okam-core/src/extend/data/observable/Observer.js
@@ -230,7 +230,7 @@ export default class Observer {
             this.setContextData(this.rawData);
         }
 
-        this.ctx.$setData({[selector]: val});
+        this.ctx.__setViewData({[selector]: val});
         this.notifyWatcher(val, oldVal, paths);
     }
 

diff --git a/packages/okam-core/src/extend/data/observable/base.js b/packages/okam-core/src/extend/data/observable/base.js
@@ -157,12 +157,12 @@ export default {
          * @private
          */
         created() {
-            this.$waitingDataUpQueues = [];
+            this.__waitingSetDataQueue = [];
             this.__dataUpTaskNum = 0;
 
             // init nextTick callback
-            this.__nextTickCallback = this.$notifySetDataDone.bind(this);
-            this.__executeDataUpdate = this.$executeDataUpdate.bind(this);
+            this.__nextTickCallback = this.__notifySetDataDone.bind(this);
+            this.__executeDataUpdate = this.__doDataUpdate.bind(this);
 
             this.$dataListener = new EventListener();
             this.__propsObserver = makePropsObservable(this);
@@ -182,8 +182,8 @@ export default {
          * @private
          */
         detached() {
-            this.$upQueues = null;
-            this.$waitingDataUpQueues = null;
+            this.__setDataQueue = null;
+            this.__upDoneCallbackQueue = null;
 
             this.$dataListener.dispose();
             this.$dataListener = null;
@@ -201,18 +201,20 @@ export default {
              * @param {Function} callback the callback to execute
              */
             $nextTick(callback) {
-                let queues = this.$waitingDataUpQueues;
-                if (queues) {
-                    queues.push(callback);
+                let queues = this.__upDoneCallbackQueue;
+                if (!queues) {
+                    queues = this.__upDoneCallbackQueue = [];
                 }
+
+                queues.push(callback);
             },
 
             /**
              * Notify setData done
              *
              * @private
              */
-            $notifySetDataDone() {
+            __notifySetDataDone() {
                 if (this.$isDestroyed || this.__dataUpTaskNum === 0) {
                     return;
                 }
@@ -223,7 +225,7 @@ export default {
                 }
 
                 this.__dataUpTaskNum = 0;
-                let queues = this.$waitingDataUpQueues;
+                let queues = this.__upDoneCallbackQueue;
                 /* istanbul ignore next */
                 if (queues) {
                     let num = queues.length;
@@ -243,44 +245,57 @@ export default {
              *
              * @private
              */
-            $executeDataUpdate() {
+            __doDataUpdate() {
                 if (this.$isDestroyed) {
                     return;
                 }
 
-                let queues = this.$upQueues;
-                /* istanbul ignore next */
-                if (queues) {
-                    // TODO optimize value update: merge operations
-                    // call lifecycle beforeUpdate hook
-                    this.beforeUpdate && this.beforeUpdate();
-                    this.setData(getSetDataPaths(queues), this.__nextTickCallback);
-                    this.$upQueues = null;
+                let queues = this.__setDataQueue;
+                this.__setDataQueue = null;
+                if (!queues || !queues.length) {
+                    return;
                 }
+
+                // call lifecycle beforeUpdate hook
+                this.beforeUpdate && this.beforeUpdate();
+                this.setData(getSetDataPaths(queues), this.__nextTickCallback);
             },
 
             /**
              * Set the view data. It'll not update the view immediately, it's deferred
              * to execute when enter the next event loop.
              *
              * @private
-             * @param {string|Object} obj the data to set or the path to set
-             * @param {*=} value the new value to set, optional
+             * @param {Object} obj the data to set
              */
-            $setData(obj, value) {
-                if (typeof obj === 'string') {
-                    obj = {[obj]: value};
-                }
-
-                let queues = this.$upQueues;
+            __setViewData(obj) {
+                let queues = this.__setDataQueue;
                 let isUpdating = !!queues;
-                queues || (queues = this.$upQueues = []);
+                queues || (queues = this.__setDataQueue = []);
                 queues.push(obj);
 
                 if (!isUpdating) {
                     this.__dataUpTaskNum++;
                     nextTick(this.__executeDataUpdate);
                 }
+            },
+
+            /**
+             * Set the view data. It'll not update the view immediately, it's deferred
+             * to execute when enter the next event loop.
+             *
+             * @private
+             * @param {string|Object} obj the data to set or the path to set
+             * @param {*=} value the new value to set, optional
+             */
+            $setData(obj, value) {
+                console.warn('cannot call this API directly, it is private and will be deprecated in future');
+
+                if (typeof obj === 'string') {
+                    obj = {[obj]: value};
+                }
+
+                this.__setViewData(obj);
             }
         }
     }

diff --git a/packages/okam-core/test/tasks/extend/data/observable/wx/index.spec.js b/packages/okam-core/test/tasks/extend/data/observable/wx/index.spec.js
@@ -676,7 +676,7 @@ describe('observable', function () {
         instance.setData = spySetData;
 
         instance.created();
-        instance.$notifySetDataDone();
+        instance.__notifySetDataDone();
         expect(spyUpdated).toNotHaveBeenCalled();
     });
 
@@ -844,12 +844,12 @@ describe('observable', function () {
         instance.setData = spySetData;
 
         instance.created();
-        instance.$waitingDataUpQueues = null;
+        instance.__upDoneCallbackQueue = null;
 
         let spyFunc1 = createSpy(() => {});
         instance.$nextTick(spyFunc1);
 
-        instance.$waitingDataUpQueues = [];
+        instance.__upDoneCallbackQueue = [];
         instance.a = 6;
 
         let spyFunc2 = createSpy(() => {});