Fix memory leak when ColumnSet is used with Editor (#1455)

* Fix issue with the Editor mixin resetting _alwaysOnWidgetColumns everything _configColumns is called. * Throw error if Editor is mixed in before ColumnSet * Update ColumnSet documentation with mixin order information Co-authored-by: Ed Hager <[email protected]>
dojo · Apr 9, 2020 · 8d5d55c · 8d5d55c
1 parent f5a8d95
commit 8d5d55c
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/ColumnSet.js b/ColumnSet.js
@@ -185,6 +185,12 @@ define([
 		//		columns from each other. This mainly serves the purpose of allowing for
 		//		column locking.
 
+		constructor: function () {
+			if ('_editorInstances' in this) {
+				throw new Error('When used with Editor ColumnSet must be mixed in before Editor.');
+			}
+		},
+
 		postCreate: function () {
 			var self = this;
 			this.inherited(arguments);

diff --git a/Editor.js b/Editor.js
@@ -169,9 +169,13 @@ define([
 			this._editorsPendingStartup = [];
 		},
 
+		configStructure: function () {
+			this._alwaysOnWidgetColumns = [];
+			this.inherited(arguments);
+		},
+
 		_configColumns: function () {
 			var columnArray = this.inherited(arguments);
-			this._alwaysOnWidgetColumns = [];
 			for (var i = 0, l = columnArray.length; i < l; i++) {
 				if (columnArray[i].editor) {
 					this._configureEditorColumn(columnArray[i]);

diff --git a/doc/components/mixins/ColumnSet.md b/doc/components/mixins/ColumnSet.md
@@ -55,4 +55,8 @@ The ColumnSet mixin supports the following additional instance methods.
 ### Method Summary
 Method | Description
 ------ | -----------
-`styleColumnSet(columnsetId, css)` | Programmatically adds styles to a columnset, by injecting a rule into a stylesheet in the document.  Returns a handle with a `remove` function, which can be called to later remove the added style rule.  Styles added via this method will be removed when the instance is destroyed if `cleanAddedRules` is set to `true`.
+`styleColumnSet(columnsetId, css)` | Programmatically adds styles to a columnset, by injecting a rule into a stylesheet in the document.  Returns a handle with a `remove` function, which can be called to later remove the added style rule.  Styles added via this method will be removed when the instance is destroyed if `cleanAddedRules` is set to `true`.
+
+## Mixin Order
+
+`ColumnSet` must be mixed in **before** `Editor` when both are used together.