[PoC] make frame with nulls clear items & array containers

Author: etpinard

src/plots/plots.js

@@ -1549,8 +1549,14 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
         for(i = 0; i < containerPaths.length; i++) {
             containerProp = Lib.nestedProperty(expandedObj, containerPaths[i]);
             containerVal = containerProp.get();
-            containerProp.set(null);
-            Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);
+
+            if(!containerVal) {
+                Lib.nestedProperty(containerObj, containerPaths[i]).set(null);
+            }
+            else {
+                containerProp.set(null);
+                Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);
+            }
         }
     }
 
@@ -1564,15 +1570,20 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
             if(!srcContainer) continue;
 
             destProp = Lib.nestedProperty(dest, containerPaths[i]);
-
             destContainer = destProp.get();
+
             if(!Array.isArray(destContainer)) {
                 destContainer = [];
                 destProp.set(destContainer);
             }
 
             for(j = 0; j < srcContainer.length; j++) {
-                destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcContainer[j]);
+                var srcObj = srcContainer[j];
+
+                if(srcObj === null) destContainer[j] = {};
+                else {
+                    destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcObj);
+                }
             }
 
             destProp.set(destContainer);

test/jasmine/tests/lib_test.js

@@ -590,6 +590,20 @@ describe('Test lib.js:', function() {
             expect(computed).toLooseDeepEqual(expected);
         });
 
+        it('does not skip over array container set to null values', function() {
+            var input = {title: 'clear annotations', annotations: null};
+            var expected = {title: 'clear annotations', annotations: null};
+            var computed = Lib.expandObjectPaths(input);
+            expect(computed).toLooseDeepEqual(expected);
+        });
+
+        it('expands array containers', function() {
+            var input = {title: 'clear annotation 1', 'annotations[1]': { title: 'new' }};
+            var expected = {title: 'clear annotation 1', annotations: [null, { title: 'new' }]};
+            var computed = Lib.expandObjectPaths(input);
+            expect(computed).toLooseDeepEqual(expected);
+        });
+
         // TODO: This test is unimplemented since it's a currently-unused corner case.
         // Getting the test to pass requires some extension (pun?) to extendDeepNoArrays
         // that's intelligent enough to only selectively merge *some* arrays, in particular

test/jasmine/tests/plots_test.js

@@ -427,4 +427,89 @@ describe('Test Plots', function() {
             expect(gd._transitioning).toBeUndefined();
         });
     });
+
+    describe('extendLayout', function() {
+
+        it('extend each container items', function() {
+            var dest = {
+                annotations: [{
+                    text: '1',
+                    x: 1,
+                    y: 1
+                }, {
+                    text: '2',
+                    x: 2,
+                    y: 2
+                }]
+            };
+
+            var src = {
+                annotations: [{
+                    text: '1-new'
+                }, {
+                    text: '2-new'
+                }]
+            };
+
+            Plots.extendLayout(dest, src);
+
+            expect(dest).toEqual({
+                annotations: [{
+                    text: '1-new',
+                    x: 1,
+                    y: 1
+                }, {
+                    text: '2-new',
+                    x: 2,
+                    y: 2
+                }]
+            });
+        });
+
+        it('clears container items when applying null src items', function() {
+            var dest = {
+                annotations: [{
+                    text: '1',
+                    x: 1,
+                    y: 1
+                }, {
+                    text: '2',
+                    x: 2,
+                    y: 2
+                }]
+            };
+
+            var src = {
+                annotations: [null, null]
+            };
+
+            Plots.extendLayout(dest, src);
+
+            expect(dest).toEqual({
+                annotations: [{}, {}]
+            });
+        });
+
+        it('clears container applying null src', function() {
+            var dest = {
+                annotations: [{
+                    text: '1',
+                    x: 1,
+                    y: 1
+                }, {
+                    text: '2',
+                    x: 2,
+                    y: 2
+                }]
+            };
+
+            var src = { annotations: null };
+
+            Plots.extendLayout(dest, src);
+
+            expect(dest).toEqual({
+                annotations: null
+            });
+        });
+    });
 });