feat: Add sorting to role assigned users table (workspaces asc, users asc) #5486
Conversation
Summary of ChangesHello @naaa760, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the usability of the role assigned users table by introducing comprehensive sorting capabilities. Users can now easily organize the displayed data by workspace or user, both with a default sort order and interactive column headers. Additionally, a critical bug related to the drawer's state management has been addressed, ensuring correct behavior. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces sorting capabilities to the 'Assigned Users' table, allowing users to sort by either 'User' or 'Workspace'. This is a great usability enhancement. The implementation also includes a fix for a bug where an incorrect variable was used in a useEffect hook. The code is well-structured, but I've identified a couple of areas for improvement regarding the sorting logic's implementation for better maintainability and a potential bug related to React's list rendering.
| </TableHead> | ||
| <TableBody> | ||
| {assignedUsers.map((item, index) => ( | ||
| {sortedAssignedUsers.map((item, index) => ( |
There was a problem hiding this comment.
Using the array index as a key for list items (as seen on the next line: <TableRow key={index}>) is an anti-pattern in React, especially for a list that can be re-ordered by sorting. This can lead to incorrect component state and rendering issues. It's recommended to use a stable, unique identifier from the data itself.
For example, if item has a unique id, you could use key={item.id}. If not, a composite key like key={${item.user.id}-${item.workspace.id}} would be a robust alternative, assuming user and workspace objects have unique ids.
| const sortedAssignedUsers = [...assignedUsers].sort((a, b) => { | ||
| let comparison = 0 | ||
|
|
||
| if (orderBy === 'workspace') { | ||
| const workspaceA = (a.workspace?.name || '').toLowerCase() | ||
| const workspaceB = (b.workspace?.name || '').toLowerCase() | ||
| comparison = workspaceA.localeCompare(workspaceB) | ||
| if (comparison === 0) { | ||
| const userA = (a.user?.name || a.user?.email || '').toLowerCase() | ||
| const userB = (b.user?.name || b.user?.email || '').toLowerCase() | ||
| comparison = userA.localeCompare(userB) | ||
| } | ||
| } else if (orderBy === 'user') { | ||
| const userA = (a.user?.name || a.user?.email || '').toLowerCase() | ||
| const userB = (b.user?.name || b.user?.email || '').toLowerCase() | ||
| comparison = userA.localeCompare(userB) | ||
| if (comparison === 0) { | ||
| const workspaceA = (a.workspace?.name || '').toLowerCase() | ||
| const workspaceB = (b.workspace?.name || '').toLowerCase() | ||
| comparison = workspaceA.localeCompare(workspaceB) | ||
| } | ||
| } | ||
|
|
||
| return order === 'asc' ? comparison : -comparison | ||
| }) |
There was a problem hiding this comment.
The sorting logic is a bit repetitive. You can simplify it to be more concise and adhere to the DRY (Don't Repeat Yourself) principle. By determining the primary and secondary sorting properties based on orderBy first, you can avoid the duplicated if (comparison === 0) blocks and make the code easier to maintain.
const sortedAssignedUsers = [...assignedUsers].sort((a, b) => {
const primaryPropA = orderBy === 'workspace' ? a.workspace?.name || '' : a.user?.name || a.user?.email || '';
const primaryPropB = orderBy === 'workspace' ? b.workspace?.name || '' : b.user?.name || b.user?.email || '';
const secondaryPropA = orderBy === 'workspace' ? a.user?.name || a.user?.email || '' : a.workspace?.name || '';
const secondaryPropB = orderBy === 'workspace' ? b.user?.name || b.user?.email || '' : b.workspace?.name || '';
let comparison = primaryPropA.toLowerCase().localeCompare(primaryPropB.toLowerCase());
if (comparison === 0) {
comparison = secondaryPropA.toLowerCase().localeCompare(secondaryPropB.toLowerCase());
}
return order === 'asc' ? comparison : -comparison;
})1 participant
fix: #5462
add sorting to role assigned users table
Implements default sorting: workspaces ascending, users ascending
Adds clickable column headers for dynamic sorting (workspace/user)
Fixes bug: replaced undefined
openvariable withopenAssignedUsersDrawerin useEffectUsers can now easily find role assignments without using Ctrl+F or scrolling.