From 988716ff011354cad0b8b2af2e3752e7d933bd8d Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Thu, 26 Feb 2015 16:53:15 -0800 Subject: [PATCH 1/3] [Edit] Refresh Library less aggressively Update the root object (used to populate the Library pane) less often, to avoid recreating the whole tree and thereby causing the tree to collapse. WTD-788. --- platform/commonUI/edit/bundle.json | 7 ++- .../edit/res/templates/edit-object.html | 7 ++- .../src/controllers/EditPanesController.js | 47 +++++++++++++++++++ 3 files changed, 58 insertions(+), 3 deletions(-) create mode 100644 platform/commonUI/edit/src/controllers/EditPanesController.js diff --git a/platform/commonUI/edit/bundle.json b/platform/commonUI/edit/bundle.json index 953497a388..35fae3de9b 100644 --- a/platform/commonUI/edit/bundle.json +++ b/platform/commonUI/edit/bundle.json @@ -16,6 +16,11 @@ "key": "EditActionController", "implementation": "EditActionController.js", "depends": [ "$scope" ] + }, + { + "key": "EditPanesController", + "implementation": "controllers/EditPanesController.js", + "depends": [ "$scope" ] } ], "actions": [ @@ -72,7 +77,7 @@ { "key": "edit-object", "templateUrl": "templates/edit-object.html", - "uses": [ "view", "context" ] + "uses": [ "view" ] }, { "key": "edit-action-buttons", diff --git a/platform/commonUI/edit/res/templates/edit-object.html b/platform/commonUI/edit/res/templates/edit-object.html index 2ff322e37c..662a77008a 100644 --- a/platform/commonUI/edit/res/templates/edit-object.html +++ b/platform/commonUI/edit/res/templates/edit-object.html @@ -18,10 +18,13 @@
-
+
- +
diff --git a/platform/commonUI/edit/src/controllers/EditPanesController.js b/platform/commonUI/edit/src/controllers/EditPanesController.js new file mode 100644 index 0000000000..eece0471be --- /dev/null +++ b/platform/commonUI/edit/src/controllers/EditPanesController.js @@ -0,0 +1,47 @@ +/*global define*/ + +define( + [], + function () { + "use strict"; + + /** + * Supports the Library and Elements panes in Edit mode. + * @constructor + */ + function EditPanesController($scope) { + var root; + + // Update root object based on represented object + function updateRoot(domainObject) { + var context = domainObject && + domainObject.getCapability('context'), + newRoot = context && context.getRoot(), + oldId = root && root.getId(), + newId = newRoot && newRoot.getId(); + + // Only update if this has actually changed, + // to avoid excessive refreshing. + if (oldId !== newId) { + root = newRoot; + } + } + + // Update root when represented object changes + $scope.$watch('domainObject', updateRoot); + + return { + /** + * Get the root-level domain object, as reported by the + * represented domain object. + * @returns {DomainObject} the root object + */ + getRoot: function () { + return root; + } + }; + } + + return EditPanesController; + } +); \ No newline at end of file From cb078e962012b7e23c65dc3c33aed37be8847753 Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Thu, 26 Feb 2015 17:02:22 -0800 Subject: [PATCH 2/3] [Edit] Test EditPanesController Test EditPanesController, particularly for the root cause of tree collapse, WTD-788. --- .../controllers/EditPanesControllerSpec.js | 94 +++++++++++++++++++ platform/commonUI/edit/test/suite.json | 1 + 2 files changed, 95 insertions(+) create mode 100644 platform/commonUI/edit/test/controllers/EditPanesControllerSpec.js diff --git a/platform/commonUI/edit/test/controllers/EditPanesControllerSpec.js b/platform/commonUI/edit/test/controllers/EditPanesControllerSpec.js new file mode 100644 index 0000000000..51bca0f217 --- /dev/null +++ b/platform/commonUI/edit/test/controllers/EditPanesControllerSpec.js @@ -0,0 +1,94 @@ +/*global define,describe,it,expect,beforeEach,jasmine*/ + +define( + ["../../src/controllers/EditPanesController"], + function (EditPanesController) { + "use strict"; + + describe("The Edit Panes controller", function () { + var mockScope, + mockDomainObject, + mockContext, + controller; + + beforeEach(function () { + mockScope = jasmine.createSpyObj("$scope", ["$watch"]); + mockDomainObject = jasmine.createSpyObj( + 'domainObject', + [ 'getId', 'getCapability' ] + ); + mockContext = jasmine.createSpyObj( + 'context', + [ 'getRoot' ] + ); + + mockDomainObject.getId.andReturn('test-id'); + mockDomainObject.getCapability.andReturn(mockContext); + + // Return a new instance of the root object each time + mockContext.getRoot.andCallFake(function () { + var mockRoot = jasmine.createSpyObj('root', ['getId']); + mockRoot.getId.andReturn('root-id'); + return mockRoot; + }); + + + controller = new EditPanesController(mockScope); + }); + + it("watches for the domain object in view", function () { + expect(mockScope.$watch).toHaveBeenCalledWith( + "domainObject", + jasmine.any(Function) + ); + }); + + it("exposes the root object found via the object's context capability", function () { + mockScope.$watch.mostRecentCall.args[1](mockDomainObject); + + // Verify that the correct capability was used + expect(mockDomainObject.getCapability) + .toHaveBeenCalledWith('context'); + + // Should have exposed the root from getRoot + expect(controller.getRoot().getId()).toEqual('root-id'); + }); + + it("preserves the same root instance to avoid excessive refreshing", function () { + var firstRoot; + // Expose the domain object + mockScope.$watch.mostRecentCall.args[1](mockDomainObject); + firstRoot = controller.getRoot(); + // Update! + mockScope.$watch.mostRecentCall.args[1](mockDomainObject); + // Should still have the same object instance, to avoid + // triggering the watch used by the template we're supporting + expect(controller.getRoot()).toBe(firstRoot); + }); + + // Complements the test above; the object pointed to should change + // when the actual root has changed (detected by identifier) + it("updates the root when it changes", function () { + var firstRoot; + // Expose the domain object + mockScope.$watch.mostRecentCall.args[1](mockDomainObject); + firstRoot = controller.getRoot(); + + // Change the exposed root + mockContext.getRoot.andCallFake(function () { + var mockRoot = jasmine.createSpyObj('root', ['getId']); + mockRoot.getId.andReturn('other-root-id'); + return mockRoot; + }); + + // Update! + mockScope.$watch.mostRecentCall.args[1](mockDomainObject); + + // Should still have the same object instance, to avoid + // triggering the watch used by the template we're supporting + expect(controller.getRoot()).not.toBe(firstRoot); + expect(controller.getRoot().getId()).toEqual('other-root-id'); + }); + }); + } +); \ No newline at end of file diff --git a/platform/commonUI/edit/test/suite.json b/platform/commonUI/edit/test/suite.json index 5744ff8ea8..94e077e242 100644 --- a/platform/commonUI/edit/test/suite.json +++ b/platform/commonUI/edit/test/suite.json @@ -13,6 +13,7 @@ "capabilities/EditableLookupCapability", "capabilities/EditablePersistenceCapability", "capabilities/EditorCapability", + "controllers/EditPanesController", "objects/EditableDomainObject", "objects/EditableDomainObjectCache", "objects/EditableModelCache", From 0d5a849a41394040605b1303a393a1e01710a9d5 Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Thu, 26 Feb 2015 17:05:13 -0800 Subject: [PATCH 3/3] [Edit] Restructure source folder Restructure sources associated with Edit mode; work on WTD-788 has increased number of sources here so more organization is useful. --- platform/commonUI/edit/bundle.json | 6 +++--- .../edit/src/{ => controllers}/EditActionController.js | 0 .../commonUI/edit/src/{ => controllers}/EditController.js | 2 +- .../commonUI/edit/src/{ => representers}/EditRepresenter.js | 0 .../edit/test/{ => controllers}/EditActionControllerSpec.js | 2 +- .../edit/test/{ => controllers}/EditControllerSpec.js | 2 +- .../edit/test/{ => representers}/EditRepresenterSpec.js | 2 +- platform/commonUI/edit/test/suite.json | 6 +++--- 8 files changed, 10 insertions(+), 10 deletions(-) rename platform/commonUI/edit/src/{ => controllers}/EditActionController.js (100%) rename platform/commonUI/edit/src/{ => controllers}/EditController.js (96%) rename platform/commonUI/edit/src/{ => representers}/EditRepresenter.js (100%) rename platform/commonUI/edit/test/{ => controllers}/EditActionControllerSpec.js (96%) rename platform/commonUI/edit/test/{ => controllers}/EditControllerSpec.js (98%) rename platform/commonUI/edit/test/{ => representers}/EditRepresenterSpec.js (98%) diff --git a/platform/commonUI/edit/bundle.json b/platform/commonUI/edit/bundle.json index 35fae3de9b..fca0e2cf72 100644 --- a/platform/commonUI/edit/bundle.json +++ b/platform/commonUI/edit/bundle.json @@ -9,12 +9,12 @@ "controllers": [ { "key": "EditController", - "implementation": "EditController.js", + "implementation": "controllers/EditController.js", "depends": [ "$scope", "navigationService" ] }, { "key": "EditActionController", - "implementation": "EditActionController.js", + "implementation": "controllers/EditActionController.js", "depends": [ "$scope" ] }, { @@ -97,7 +97,7 @@ ], "representers": [ { - "implementation": "EditRepresenter.js", + "implementation": "representers/EditRepresenter.js", "depends": [ "$q", "$log" ] }, { diff --git a/platform/commonUI/edit/src/EditActionController.js b/platform/commonUI/edit/src/controllers/EditActionController.js similarity index 100% rename from platform/commonUI/edit/src/EditActionController.js rename to platform/commonUI/edit/src/controllers/EditActionController.js diff --git a/platform/commonUI/edit/src/EditController.js b/platform/commonUI/edit/src/controllers/EditController.js similarity index 96% rename from platform/commonUI/edit/src/EditController.js rename to platform/commonUI/edit/src/controllers/EditController.js index 8c859ab126..cf07797429 100644 --- a/platform/commonUI/edit/src/EditController.js +++ b/platform/commonUI/edit/src/controllers/EditController.js @@ -4,7 +4,7 @@ * Module defining EditController. Created by vwoeltje on 11/14/14. */ define( - ["./objects/EditableDomainObject"], + ["../objects/EditableDomainObject"], function (EditableDomainObject) { "use strict"; diff --git a/platform/commonUI/edit/src/EditRepresenter.js b/platform/commonUI/edit/src/representers/EditRepresenter.js similarity index 100% rename from platform/commonUI/edit/src/EditRepresenter.js rename to platform/commonUI/edit/src/representers/EditRepresenter.js diff --git a/platform/commonUI/edit/test/EditActionControllerSpec.js b/platform/commonUI/edit/test/controllers/EditActionControllerSpec.js similarity index 96% rename from platform/commonUI/edit/test/EditActionControllerSpec.js rename to platform/commonUI/edit/test/controllers/EditActionControllerSpec.js index e0e23cada8..13369872af 100644 --- a/platform/commonUI/edit/test/EditActionControllerSpec.js +++ b/platform/commonUI/edit/test/controllers/EditActionControllerSpec.js @@ -1,7 +1,7 @@ /*global define,describe,it,expect,beforeEach,jasmine*/ define( - ["../src/EditActionController"], + ["../../src/controllers/EditActionController"], function (EditActionController) { "use strict"; diff --git a/platform/commonUI/edit/test/EditControllerSpec.js b/platform/commonUI/edit/test/controllers/EditControllerSpec.js similarity index 98% rename from platform/commonUI/edit/test/EditControllerSpec.js rename to platform/commonUI/edit/test/controllers/EditControllerSpec.js index 3dff5f7ed8..f945c499b8 100644 --- a/platform/commonUI/edit/test/EditControllerSpec.js +++ b/platform/commonUI/edit/test/controllers/EditControllerSpec.js @@ -1,7 +1,7 @@ /*global define,describe,it,expect,beforeEach,jasmine*/ define( - ["../src/EditController"], + ["../../src/controllers/EditController"], function (EditController) { "use strict"; diff --git a/platform/commonUI/edit/test/EditRepresenterSpec.js b/platform/commonUI/edit/test/representers/EditRepresenterSpec.js similarity index 98% rename from platform/commonUI/edit/test/EditRepresenterSpec.js rename to platform/commonUI/edit/test/representers/EditRepresenterSpec.js index 85d314fda6..1a11cb12bc 100644 --- a/platform/commonUI/edit/test/EditRepresenterSpec.js +++ b/platform/commonUI/edit/test/representers/EditRepresenterSpec.js @@ -1,7 +1,7 @@ /*global define,describe,it,expect,beforeEach,jasmine*/ define( - ["../src/EditRepresenter"], + ["../../src/representers/EditRepresenter"], function (EditRepresenter) { "use strict"; diff --git a/platform/commonUI/edit/test/suite.json b/platform/commonUI/edit/test/suite.json index 94e077e242..f3ace073eb 100644 --- a/platform/commonUI/edit/test/suite.json +++ b/platform/commonUI/edit/test/suite.json @@ -1,7 +1,4 @@ [ - "EditActionController", - "EditController", - "EditRepresenter", "actions/CancelAction", "actions/EditAction", "actions/PropertiesAction", @@ -13,10 +10,13 @@ "capabilities/EditableLookupCapability", "capabilities/EditablePersistenceCapability", "capabilities/EditorCapability", + "controllers/EditActionController", + "controllers/EditController", "controllers/EditPanesController", "objects/EditableDomainObject", "objects/EditableDomainObjectCache", "objects/EditableModelCache", + "representers/EditRepresenter", "representers/EditToolbar", "representers/EditToolbarRepresenter" ] \ No newline at end of file