keystonejs/keystone-classic

Sort by relationship always sorts by _id of related field even though name is rendered in admin UI

Open

#4251 opened on May 1, 2017

View on GitHub
 (3 comments) (4 reactions) (0 assignees)JavaScript (14,656 stars) (2,288 forks)batch import
bughelp wanted

Description

Expected behavior

When sorting by a relationship field, the sort should be alphabetical by the string that is actually rendered in the admin UI.

Actual/Current behavior

Currently the support appears to be alphabetical by the ObjectId.toString() value of the related document's _id property.

Steps to reproduce the actual/current behavior

  1. Create two Lists and include a String name property on each.
  2. Create relationship between one List and the other (many: false) and set defaultSort on the relationship owner to the property name of the relationship.
  3. Create a number of documents for the related List with various name values.
  4. Access the admin ui for that List and observe the sort.

Environment

Software Version
Keystone 4.0.0-beta.5
Node 7.6.0

Contributor guide

Tech stack
javascriptnodejsmongodb
Domain
full stack
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with KeystoneJSMongoDB basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the sorting logic for relationship fields in the admin UI. Look at the List controller and field type implementation, particularly the 'sort' method in the relationship field (likely in fields/types/relationship/). The issue is that sorting uses the ObjectId instead of the rendered display string. Check if there is a way to sort by the referenced document's display field (e.g., 'name') rather than the id. Review the defaultSort configuration and how it is applied to relationships. Consider using a virtual or populate to sort by the actual label field.