Streamline InternalList properties used for mapping references
Open, Needs TriagePublic
Actions

Assigned To

None

Authored By

	WMDE-Fisch
	Thu, Feb 5, 9:31 AM

Description

Context

ve.dm.InternalList currently maintains at least two properties used to map indexes with listKeys. ve.dm.InternalList.keys and ve.dm.InternalList.keyIndexes. Since we want to introduce a new mechanism to map MWReferenceNodes with InternalItemNodes we're revisiting what's actually useful here.

Insights

ve.dm.InternalList.keys seems to be incomplete and thereby useless because it's only used with the listKey and not the listGroup and is therby not a useful map.
ve.dm.InternalList.keyIndexes seems only relevant in two places

when the Convert adds InternalItemNodes for references in ve.dm.InternalList.queueItemHtml
when two InternalLists are merged in ve.dm.InternalList.merge

Task

Deprecate ve.dm.InternalList.keys
Investigate if ve.dm.InternalList.keyIndexes is relevant in the merge case
Potentially deprecate keyIndexes

Details

Related Changes in Gerrit:

Subject	Repo	Branch	Lines +/-
Update VE core submodule to master (17a600756)	mediawiki/extensions/VisualEditor	master	+16 -10
Track if keyIndexes are used on InternaList.merge()	VisualEditor/VisualEditor	master	+5 -0
Remove unused InternalList.keys property	VisualEditor/VisualEditor	master	+1 -9
Document that NodeGroup.indexOrder does not relate to listIndex	VisualEditor/VisualEditor	master	+2 -0
Revert "VE: Change ve.dm.Transaction.test to cover input from copy and paste"	mediawiki/extensions/Cite	master	+1 -4
Stop reading duplicate InternalList.keys data structure	mediawiki/extensions/Cite	master	+11 -2

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
In Progress	None	T397501 [Epic] Use InternalItems only instead of synthetic LDRs to store content for sub-refs
Open	None	T415760 [Epic] Implement a new mechanism that connects MWReferenceNodes with InternalItemNodes
Open	None	T416558 Streamline InternalList properties used for mapping references

Event Timeline

WMDE-Fisch created this task.Thu, Feb 5, 9:31 AM

Change #1236757 had a related patch set uploaded (by WMDE-Fisch; author: WMDE-Fisch):

[VisualEditor/VisualEditor@master] Remove unused InternalList.keys property

https://gerrit.wikimedia.org/r/1236757

Change #1236790 had a related patch set uploaded (by WMDE-Fisch; author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@master] Stop reading duplicate InternalList.keys data structure

https://gerrit.wikimedia.org/r/1236790

Change #1237164 had a related patch set uploaded (by WMDE-Fisch; author: WMDE-Fisch):

[VisualEditor/VisualEditor@master] Track if keyIndexes are used on InternaList.merge()

https://gerrit.wikimedia.org/r/1237164

WMDE-Fisch moved this task from Sprint Backlog to Tech Review on the WMDE-TechWish-Sprint-2026-02-03-Tomatoes-of-many-colors board.Thu, Feb 5, 10:27 AM

Change #1236790 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Stop reading duplicate InternalList.keys data structure

https://gerrit.wikimedia.org/r/1236790

ReleaseTaggerBot added a project: MW-1.46-notes (1.46.0-wmf.15; 2026-02-10).Thu, Feb 5, 2:00 PM

Change #1237308 had a related patch set uploaded (by WMDE-Fisch; author: WMDE-Fisch):

[VisualEditor/VisualEditor@master] Document that NodeGroup.indexOrder not correlates with listIndex

https://gerrit.wikimedia.org/r/1237308

WMDE-Fisch updated the task description. (Show Details)Fri, Feb 6, 9:47 AM

WMDE-Fisch updated the task description. (Show Details)

Change #1237869 had a related patch set uploaded (by WMDE-Fisch; author: WMDE-Fisch):

[mediawiki/extensions/Cite@master] Revert "VE: Change ve.dm.Transaction.test to cover input from copy and paste"

https://gerrit.wikimedia.org/r/1237869

Change #1237869 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Revert "VE: Change ve.dm.Transaction.test to cover input from copy and paste"

https://gerrit.wikimedia.org/r/1237869

Lina_Farid_WMDE moved this task from Incoming to NOW on the Cite (Sub-referencing) board.Thu, Feb 12, 10:47 AM

Change #1237308 abandoned by WMDE-Fisch:

[VisualEditor/VisualEditor@master] Document that NodeGroup.indexOrder does not relate to listIndex

Reason:

A had a few more pokes here and I think it is actually usable to get the order if the first appearance of a "node using a listIndex". So my comment is invalid.

https://gerrit.wikimedia.org/r/1237308

Change #1236757 merged by jenkins-bot:

[VisualEditor/VisualEditor@master] Remove unused InternalList.keys property

https://gerrit.wikimedia.org/r/1236757

WMDE-Fisch mentioned this in T415770: Revert changes that made more use of keyIndexes.Fri, Feb 13, 10:38 AM

MareikeHeuerWMDE moved this task from Tech Review to Epics / Watching / Stalled on the WMDE-TechWish-Sprint-2026-02-03-Tomatoes-of-many-colors board.Fri, Feb 13, 11:16 AM

Change #1237164 merged by jenkins-bot:

[VisualEditor/VisualEditor@master] Track if keyIndexes are used on InternaList.merge()

https://gerrit.wikimedia.org/r/1237164

Maintenance_bot removed a project: Patch-For-Review.Fri, Feb 13, 11:30 AM

Change #1217218 had a related patch set uploaded (by DLynch; author: DLynch):

[mediawiki/extensions/VisualEditor@master] Update VE core submodule to master (17a600756)