Tool list editing and display has unexpected/non-deterministic ordering for tools in list
Closed, ResolvedPublicBUG REPORT
Actions

Assigned To

Authored By

	bd808
	Jan 11 2022, 12:34 AM

Description

Our toolhub.apps.lists.models.ToolList model uses a ManyToManyField with a through relation to store and retrieve the tools associated with a list. The through relation is handled by the toolhub.apps.lists.models.ToolListItem model which adds "order", "added_by", and "added_date" attributes to the M2M relation between a ToolList and a Tool.

The bug is that the "order" field on ToolListItem is not used by the DRF view layer when it outputs a list. Playing with manual Django object queries, it seems that if the toollistitem_set reverse manager is used to query for the tools in a list then the ToolListItem default ordering is used (what we want), but if the tools manager is used then ordering is left up to the db engine.

Details

	Subject	Repo	Branch	Lines +/-
	toolhub: Bump container version to 2022-03-15-002555-production	operations/deployment-charts	master	+1 -1
	lists: order tools in toollist	wikimedia/toolhub	main	+9 -1

Customize query in gerrit

Event Timeline

bd808 created this task.Jan 11 2022, 12:34 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJan 11 2022, 12:34 AM

The existing behavior is functional (meaning that lists can be created, edited, and viewed), but confusing. The confusion it gets worse when doing certain edits and then looking at the diffs. This is actually how the issue came to our attention as @Slst2020 was working on adding a UI for viewing list edit diffs.

Raymond_Ndibe claimed this task.Jan 19 2022, 11:55 PM

Raymond_Ndibe added a project: User-Raymond_Ndibe.

Change 755518 had a related patch set uploaded (by Raymond Ndibe; author: Raymond Ndibe):

[wikimedia/toolhub@main] lists: order tools in toollist

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

gerritbot added a project: Patch-For-Review.Jan 20 2022, 1:01 AM

Raymond_Ndibe moved this task from Backlog to In Progress on the Toolhub board.Jan 20 2022, 1:10 AM

Raymond_Ndibe moved this task from In Progress to Review on the Toolhub board.

Raymond_Ndibe moved this task from Backlog to In Review on the User-Raymond_Ndibe board.

Change 755518 merged by jenkins-bot:

[wikimedia/toolhub@main] lists: order tools in toollist

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

Maintenance_bot removed a project: Patch-For-Review.Jan 21 2022, 8:10 PM

Raymond_Ndibe closed this task as Resolved.Jan 24 2022, 10:26 PM

Change 770638 had a related patch set uploaded (by BryanDavis; author: Bryan Davis):

[operations/deployment-charts@master] toolhub: Bump container version to 2022-03-15-002555-production

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

gerritbot added a project: Patch-For-Review.Mar 15 2022, 12:34 AM

Change 770638 merged by jenkins-bot: