@refinitiv-ui/efx-grid 6.0.126 → 6.0.128

package/lib/rt-grid/es6/Grid.js

@@ -175,12 +175,6 @@ import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js
 * @description Fired only when a row will be removed through Grid's API and before occurring of the actual removal
 */
 
-/** @type {string}
-* @private
-* @const
-*/
-const SUB_ID = "SUB_ID";
-
 /** @private
 * @param {RowDefinition} rowDef
 * @return {Object}
@@ -315,10 +309,10 @@ let Grid = function(placeholder, config) {
 
 	t._onDataChanged = t._onDataChanged.bind(t);
 	t._onQuote2PostUpdate = t._onQuote2PostUpdate.bind(t);
+	t._onQ2DataChanged = t._onQ2DataChanged.bind(t);
 	t._onDataComposed = t._onDataComposed.bind(t);
 	t._onSubSegmentChanged = t._onSubSegmentChanged.bind(t);
 	t._recalculateFormulas = t._recalculateFormulas.bind(t);
-	t._updateStreamingData = t._updateStreamingData.bind(t);
 	t.updateColumnTitle = t.updateColumnTitle.bind(t);
 	t._populateTimeSeriesChildren = t._populateTimeSeriesChildren.bind(t);
 
@@ -330,7 +324,7 @@ let Grid = function(placeholder, config) {
 	t._updateRowData = t._updateRowData.bind(t);
 	t._onFormulaDataChanged = t._onFormulaDataChanged.bind(t);
 	t._onFormulaDataRequired = t._onFormulaDataRequired.bind(t);
-	t._addMemberOfChain = t._addMemberOfChain.bind(t);
+	t._registerConstituents = t._registerConstituents.bind(t);
 	t._onColumnAdded = t._onColumnAdded.bind(t);
 	t._onRowExpansionBinding = t._onRowExpansionBinding.bind(t);
 	t._onColumnHeaderBinding = t._onColumnHeaderBinding.bind(t);
@@ -345,9 +339,9 @@ let Grid = function(placeholder, config) {
 	t._onVScroll = t._onVScroll.bind(t);
 	t._selfScrollToRow = t._selfScrollToRow.bind(t);
 
-	t._streamingConflator = new Conflator(50, t._updateStreamingData);
+	t._dcConflator = new Conflator(50, t._onDataChanged);
 	t._formulaConflator = new Conflator(300, t._onFormulaDataChanged);
-	t._chainConflator = new Conflator(100, t._addMemberOfChain);
+	t._chainConflator = new Conflator(100, t._registerConstituents);
 	t._columnTitleConflator = new Conflator(0, t.updateColumnTitle);
 	t._timeSeriesChildConflator = new Conflator(0, t._populateTimeSeriesChildren);
 
@@ -484,7 +478,7 @@ Grid.prototype._sharedDataSource = false;
  */
 Grid.prototype._sharedSorter = false;
 
-/** JET.Quotes2 Subscription
+/** JET/RTK's Quotes2 subscription object
  * @type {Object}
  * @private
  */
@@ -502,7 +496,7 @@ Grid.prototype._columnSorter = null;
 /** @private
 * @type {Conflator}
 */
-Grid.prototype._streamingConflator = null;
+Grid.prototype._dcConflator = null;
 /** @private
 * @type {SnapshotFiller}
 */
@@ -525,10 +519,6 @@ Grid.prototype._fnEngine = null;
 */
 Grid.prototype._formulaConflator = null;
 
-/** @private
-* @type {Object.<string, Object>}
-*/
-Grid.prototype._chainMembers = null;
 /** @private
 * @type {Conflator}
 */
@@ -637,7 +627,15 @@ Grid.prototype.dispose = function() {
 	this._grid.dispose();
 	this._connector.reset();
 
-	if(!this._sharedDataSource) { // make sure that it is the final grid, and that it will be dispose data
+	if(!this._sharedDataSource) { // Make sure that this is the final grid, and its data is disposed
+		if(this._subs) {
+			this._subs.removeEventListener("postUpdate", this._onQuote2PostUpdate);
+			this._subs.removeEventListener("dataChanged", this._onQ2DataChanged);
+			this._subs["dispose"]();
+		}
+		if(this._dc) {
+			this._dc.dispose();
+		}
 		if(this._dt) {
 			this._dt.dispose();
 		}
@@ -645,12 +643,7 @@ Grid.prototype.dispose = function() {
 			this._dv.dispose();
 		}
 	}
-	this._mainGrid = this._dt = this._dv = null;
-
-	if(this._subs) {
-		this._subs["dispose"]();
-		this._subs = null;
-	}
+	this._mainGrid = this._dc = this._dt = this._dv = this._subs = null;
 
 	if(this._focusingArgs) {
 		_clearTimeout(this._focusingArgs.id);
@@ -679,7 +672,11 @@ Grid.prototype.listen = Grid.prototype.addEventListener;
 /** @public
 */
 Grid.prototype.initSubscription = function() {
-	if(!this._dc || this._dc.getSubscriptions()) { // Subscription is already initialized
+	if(this._subs) { // Subscription is already initialized
+		return;
+	}
+	if(this._sharedDataSource) {
+		this._subs = this._mainGrid._subs;
 		return;
 	}
 
@@ -692,6 +689,9 @@ Grid.prototype.initSubscription = function() {
 	}
 	if(q) {
 		s = q["create"]();
+		if(this._RTK && this._RTK.prefetchWorkaround) { // The workaround for RTK Quotes has a bug concerning the removal of the last row; it isn't removed.
+			s.addRic("DUMMY.WORKAROUND", "DUMMY.WORKAROUND");
+		}
 	}
 	if(!s) {
 		return;
@@ -702,8 +702,8 @@ Grid.prototype.initSubscription = function() {
 
 	this._subs = s;
 	this._subs["start"]();
-	this._dc.setSubscriptions(s);
 	this._subs.addEventListener("postUpdate", this._onQuote2PostUpdate);
+	this._subs.addEventListener("dataChanged", this._onQ2DataChanged);
 
 	// TODO: Subscriptions should be registered per row.
 	// However, chain subscription cannot be integrated with DataConnector in this current implementation.
@@ -712,7 +712,7 @@ Grid.prototype.initSubscription = function() {
 	for(let i = 0; i < len; ++i) {
 		let rowDef = rowDefs[i];
 		if(rowDef) {
-			rowDef.subscribeForUpdates();
+			rowDef.subscribeForUpdates(s);
 		}
 	}
 };
@@ -2320,29 +2320,31 @@ Grid.prototype._initDuplicateRicData = function(rowDef) {
 };
 
 /** @private
-* @param {Object} rowDef
-* @param {Array<Object>} children
+* @param {Object} newRowDef
 */
-Grid.prototype._cloneChain = function(rowDef) {
-	let rowDefs = this._connector.getRowDefByRic(rowDef.getSymbol());
+Grid.prototype._cloneChain = function(newRowDef) {
+	let rowDefs = this._connector.getRowDefByRic(newRowDef.getSymbol());
 	let firstRowDef = rowDefs ? rowDefs[0] : null;
 	let constituents = firstRowDef ? firstRowDef.getChildren() : null;
-
-	if(!constituents) {
-		return;
-	}
-	let count = constituents.length;
-	if(count < 0 ) {
+	let count = constituents ? constituents.length : 0;
+	if(count < 0) {
 		return;
 	}
 
-	let subId = rowDef.getData(SUB_ID);
+	let subId = newRowDef.getSubId();
+	if(!subId) {
+		return; // A chain without subscription cannot have constituents
+	}
+	let evtArg = {
+		"subId": subId
+	};
 	for (let i = 0; i < count; i++) {
-		let childRowDef = constituents[i];
-		let rowData = childRowDef.cloneRowData();
-		rowData["SUB_ID"] = subId;
-		let rid = subId + rowData["RIC"];
-		this._dc.setRowData(rid, rowData);
+		let childRowDef = constituents[i]; // TODO: the constituents should be sorted by CHILD_ORDER first
+		evtArg["ric"] = childRowDef.getRic();
+		evtArg["values"] = childRowDef.cloneRowData();
+		evtArg["values"]["SUB_ID"] = subId; // Imitate real-time service responses
+
+		this._onQ2DataChanged(evtArg); // WARNING: evtArg is shared across multiple calls
 	}
 };
 /** @public
@@ -2368,10 +2370,10 @@ Grid.prototype.insertRow = function(rowOption, rowRef) {
 		}
 	}
 	let rowDef = new RowDefinition(rowOption);
-	rowDef.setDataSource(this._dc); // This could also subscribe chain index/ric to JET/RTK
+	rowDef.registerToView(this._dv, this._getRowId(rowRef));
+	rowDef.setDataSource(this._dc, this._subs); // This could also subscribe chain index/ric to JET/RTK
 	this._initDuplicateRicData(rowDef);
 
-	rowDef.registerToView(this._dv, this._getRowId(rowRef));
 	if(rowOption && rowOption["hidden"]) {
 		this._dv.hideRow(rowDef.getRowId()); // Try to obtain rowId in rowDef since rowId is not assigned when new rows are created.
 	}
@@ -2680,17 +2682,16 @@ Grid.prototype.removeAllRows = function() {
 	if(!this._dt.getRowCount()) {
 		return;
 	}
+	// Data source is not shared at this point
 	let rowDefs = this._getAllRowDefinitions();
 
-	if(!this._sharedDataSource) {
-		this._dc.clearAllData();
-		this._dt.clearAllData();
-		this._clearDataUpdates();
-	}
+	this._dc.clearAllData();
+	this._dt.clearAllData();
+	this._clearDataUpdates();
 
-	rowDefs.forEach(RowDefinition.dispose);
+	rowDefs.forEach(RowDefinition.dispose); // Each individual subscription is unsubscribed along with disposed rowDef
 
-	this._streamingConflator.reset();
+	this._dcConflator.reset();
 	this._formulaConflator.reset();
 	this._chainConflator.reset();
 	this._connector.removeAllRics();
@@ -3587,94 +3588,127 @@ Grid.prototype._onQuote2PostUpdate = function (e) {
 	}
 };
 
-/** @private
-* @param {!Object} e
-*/
-Grid.prototype._onDataChanged = function(e) {
-	let rowData = e["rowData"]; // Use rowData to retrieve corresponding subscription object
-	if (!rowData || this._unlinking) {
-		return; // This must be a global change
+/**
+* @private
+* @param {Object} e
+ */
+Grid.prototype._onQ2DataChanged = function (e) {
+	let subId = e["subId"];
+	let rowDef = this._getRowDefinitionById(subId);
+	if(!rowDef) {
+		return; // WARNING: This should not be happened because row has been removed but the data is still received
 	}
-	let rowDef = rowData[ROW_DEF];
 
-	if(rowDef) {
-		let rowId = rowDef.getRowId();
-		if(rowId) {
-			// e["rid"] could be from JET/RTK (rowId + ric) or static data update (rowId)
-			let curRowData = this._dc.getRowData(e["rid"]);
-			if (curRowData) {
-				if(rowDef.addUpdate(e)) { // This is the only place that update array can grow. It is used for blinking data.
-					this._dt._hasNewUpdates = true; // Mark data table for cleaning it up later
+	let values = e["values"];
+	if (values) {
+		let ric = e["ric"];
+		if(rowDef.verifyConstituent(ric)) {
+			let parentDef = rowDef;
+			let childDef = parentDef.getConstituent(ric);
+			if(childDef) { // The constituent will share the same sub id as its parent
+				rowDef = childDef;
+			} else {
+				rowDef = childDef = parentDef.addConstituent(ric);
+				if(!childDef) {
+					return; // Parent chain is not alive
 				}
-				this._updateStreamingData();
-			} else if(rowDef.isAutoGenerated()) { // Subscription and its parent has been removed by Real-time provider
-				rowDef.setParent(null); // Manually remove child reference from its parent
-				this._removeRow(rowDef);
+				this._connector.addRic(childDef); // TODO: JET/RTK should not re-subscribe this
+				this._registerConstituents(childDef);
 			}
 		}
-		return;
-	}
 
-	// The new data update has no row definition, meaning that we have found a new constituent from a chain.
-	let subId = rowData[SUB_ID]; // The constituent will share the same sub id as its parent
-	if(subId) {
-		let parentDef = this._getRowDefinitionById(subId);
-		if(parentDef && parentDef.isChain() && parentDef.getRic() !== rowData["RIC"]) { // TODO: Check for delayed ric
-			if(!this._chainMembers) {
-				this._chainMembers = {};
-			}
-			if(!this._chainMembers[e["rid"]]) { // Prevent duplication
-				this._chainMembers[e["rid"]] = rowData;
-				this._addMemberOfChain(rowData);
-			}
-		}
+		rowDef.setRowData(values); // Trigger data changes
+	} else if(rowDef.isConstituent()) { // Subscription and its parent has been removed by Real-time provider
+		rowDef.setParent(null); // Manually remove child reference from its parent
+		this._removeRow(rowDef);
 	}
 };
+
 /** @private
-* @param {!Object} rowData
+* @param {RowDefinition} rowDef
 */
-Grid.prototype._addMemberOfChain = function(rowData) {
-	if(this._chainConflator.conflate(rowData)) {
+Grid.prototype._registerConstituents = function(rowDef) {
+	if(this._chainConflator.conflate(rowDef)) {
 		return;
 	}
+	let view = this._dv;
+	let dt = view ? view.getDataSource() : null;
+	if(!dt) {
+		return;
+	}
+
+	let childDefs = this._chainConflator.popAllData(); // This must have no duplication
+	let childCount = childDefs ? childDefs.length : 0;
 
-	let rows = this._chainConflator.popAllData(); // This must have no duplication
-	let len = rows ? rows.length : 0;
+	// Validate row definition and collect its info
 	let i;
+	let validDefs = [];
+	let maxCountMap = {};
+	for(i = 0; i < childCount; ++i) {
+		let childDef = childDefs[i];
+		let parentDef = childDef.getParent();
+		if(!parentDef) {
+			break; // A constituent without parent cannot be added to the view
+		}
+		let parentRowId = parentDef.getRowId();
+		let maxCount = maxCountMap[parentRowId];
+		if(maxCount == null) {
+			maxCount = maxCountMap[parentRowId] = parentDef.countChildInView();
+		}
+		validDefs.push(childDef);
+	}
+
+	childCount = validDefs.length;
+	if(!childCount) {
+		return;
+	}
 
 	let prevState = false;
-	if(len > 1) {
+	if(childCount > 1) {
 		prevState = this._dt.freeze(); // Avoid sorting for each insertion
 	}
-	let childDefs = [];
-	for(i = 0; i < len; ++i) {
-		rowData = /** @type{!Object} */(rows[i]);
-		let subId = rowData[SUB_ID];
-		let parentDef = this._getRowDefinitionById(subId);
-		if(parentDef) {
-			let childDef = parentDef.addConstituent(/** @type{string} */(rowData["RIC"]), this._dt);
-			if(childDef) {
-				childDefs.push(childDef);
-			} // else { // childDef has already been added
-		}
-	}
-	this._chainMembers = null; // Clear all waiting chain members
 
-	let childCount = childDefs.length;
-	if(childCount) {
-		for(i = childCount; --i >= 0;) {
-			this._connector.addRic(childDefs[i]); // TODO: JET/RTK should not re-subscribe this
+	for(i = 0; i < childCount; ++i) {
+		let childDef = validDefs[i];
+		let parentDef = childDef.getParent();
+		let parentRowId = parentDef.getRowId();
+		let maxCount = maxCountMap[parentRowId];
+
+		// TODO: Handle nested children
+		view.addSegmentChild(parentRowId, childDef.getRowId());
+
+		// Added order and child order can be different
+		// CHILD_ORDER value from real-time service indicates the order of constituents.
+		let destIndex = dt.getRowIndex(parentRowId) + 1; // WARNING: Not checking for negative index
+		let childOrder = childDef.getData("CHILD_ORDER"); // CHILD_ORDER starts from 0
+		if(childOrder != null && childOrder < maxCount) {
+			destIndex += childOrder;
+		} else {
+			destIndex += maxCount;
 		}
+		let destRowId = dt.getRowId(destIndex);
+		childDef.registerToView(view, destRowId);
+		maxCountMap[parentRowId] = maxCount + 1; // Since new child has been added to the view, maxCount has to be updated
 	}
-	if(len > 1) {
+	if(childCount > 1) {
 		this._dt.freeze(prevState);
 	}
 };
 
 /** @private
+* @param {Object} e
 */
-Grid.prototype._updateStreamingData = function() {
-	if(this._streamingConflator.conflate()) {
+Grid.prototype._onDataChanged = function(e) {
+	if(this._dt && e && e["rid"] && e["changes"]) {
+		let rowDef = this._getRowDefinitionById(e["rid"]);
+		if(rowDef) {
+			if(rowDef.addUpdate(e["changes"])) { // This is the only place that update array can grow. It is used for blinking data.
+				this._dt._hasNewUpdates = true; // Mark data table for cleaning it up later
+			}
+		}
+	}
+
+	if(this._dcConflator.conflate()) {
 		return;
 	}
 
@@ -3911,12 +3945,9 @@ Grid.prototype._onDataComposed = function(e) {
 		return; // Row could already be removed or global change event is sent
 	}
 
-	let rowDef = rowData[ROW_DEF];
+	let rowDef = this._getRowDefinitionById(e["rid"]);
 	if(!rowDef) {
-		return;
-	}
-	if(!rowDef.getDataSource()) {
-		return; // Somehow, rowDef is invalid and doesn't have data source
+		return; // Somehow the given row id is invalid
 	}
 
 	if(this._autoDateConversion) { // auto data conversion
@@ -3975,10 +4006,10 @@ Grid.prototype._onSubSegmentChanged = function(e) {
 		// let parentId = segment.getParentId();
 		let segmentId = segment.getId();
 		rowDef = new RowDefinition({
-			"segmentId": segmentId
+			"segmentId": segmentId // WARNING: This could cause row id duplication
 		});
-		rowDef.setDataSource(this._dc);
 		rowDef.registerToView(this._dv);
+		rowDef.setDataSource(this._dc); // auto generated row does not require a subscription
 	}
 };
 

package/lib/rt-grid/es6/RowDefinition.d.ts

@@ -1,4 +1,4 @@
-import { arrayToObject, cloneObject } from "../../tr-grid-util/es6/Util.js";
+import { arrayToObject } from "../../tr-grid-util/es6/Util.js";
 import { DataCache } from "../../core/es6/data/DataCache.js";
 import { DataTable } from "../../core/es6/data/DataTable.js";
 
@@ -48,7 +48,7 @@ declare class RowDefinition {
 
     public getType(): string;
 
-    public setDataSource(dataSource: DataCache|null): void;
+    public setDataSource(dataSource: DataCache|null, subs?: any): void;
 
     public getDataSource(): DataCache|null;
 
@@ -68,6 +68,8 @@ declare class RowDefinition {
 
     public setRowData(data: { [key: string]:  any }): void;
 
+    public resetRowData(): void;
+
     public setData(field: string, value: any): void;
 
     public getUserInput(): string;
@@ -86,6 +88,8 @@ declare class RowDefinition {
 
     public isChain(): boolean;
 
+    public isConstituent(): boolean;
+
     public static hasChain(rowDef: RowDefinition|null): boolean;
 
     public isChainCollapsed(): boolean;
@@ -96,21 +100,21 @@ declare class RowDefinition {
 
     public isRealTimeRow(): boolean;
 
-    public subscribeForUpdates(): boolean;
+    public subscribeForUpdates(subs?: any): boolean;
 
-    public unsubscribeForUpdates(): any;
+    public unsubscribeForUpdates(): null;
 
     public isSubscribing(): boolean;
 
-    public addUpdate(e: any): boolean;
+    public getSubId(): string;
+
+    public addUpdate(changes: any): boolean;
 
     public getUpdates(): { [key: string]:  number }|null;
 
     public resetUpdates(): void;
 
-    public registerToView(view: DataView|null, destRowId?: string|null): void;
-
-    public static deregisterFromView(rowIds: (string)[]|null, rowDef: RowDefinition|null): (string)[]|null;
+    public registerToView(view: DataView|null, destRowId?: string|null): boolean;
 
     public unlinkChain(): void;
 
@@ -128,6 +132,8 @@ declare class RowDefinition {
 
     public getChildCount(): number;
 
+    public countChildInView(): number;
+
     public getParent(): RowDefinition|null;
 
     public getDepthLevel(): number;