[72005] New Administration for User Custom Fields and Custom Field Sections

[dfriquet]

Ticket

https://community.openproject.org/wp/72005

What are you trying to accomplish?

• For this, Administrators need to manage the layout of the user form
  • The user custom field management is moved as a menu item in the Users & Permissions section in the administration
  • "User custom fields" are renamed "User attributes" to match project attributes
  • User attributes are grouped into sections
  • Additionally to the custom fields, the built-in fields (first name, last name, email, department, etc) are listed there as well and can be re-arranged in the form.
• When editing or showing the user profile, the data/form is displayed as configured by the admin
• A user custom field also gets a boolean if that info should be shown in the user information card. If this is checked, the custom field is also shown whenever user details are displayed (see Figma for details)
• Hierarchy custom fields are also available for user custom fields
• Primerized.

Screenshots

What approach did you choose and why?

• The first commit made the move from the flat-list user custom fields administration to user attributes within sections:
  • For the most parts a copy-paste from "Project attributes";
  • New admin area — dedicated UserCustomFieldsController + UserCustomFieldSectionsController with a new "User attributes" entry in the "Users & Permissions" menu;
  • UserCustomFieldSection model — new STI subclass of CustomFieldSection with full Create/Update/Delete service and contract layer;
  • Data migration: creates one untitled default UserCustomFieldSection and bulk-assigns all existing orphaned UserCustomField records to it;
  • Shared code: three small targeted edit to handle UserCustomField alongside ProjectCustomField.
• The second commit fixes a bug in the "Project attributes" found while working on the "User attributes";
• The third commit groups the input fields by section in the user form and profile.
• The fourth commit introduces the visible_on_user_card flag on custom fields and renders those flagged fields in the user hover card;
• The sixth commit enables hierarchy-type custom fields for users and adds the item management controller, routes, and views for them;
• The eighth commit includes the five built-in user fields alongside custom fields in the admin sections, making all fields uniformly draggable and reorderable:
  • New attribute_order text[] column on custom_field_sections as the single ordering mechanism;
  • BuiltInAttributeRowComponent in the section admin UI — drag handle, "Built-in" badge, move actions only (no edit or delete), and companion BuiltInAttributesController for move/drop of built-in fields within and across sections.
• The ninth commit backports Users’ attribute_order into Projects so that all the subclasses uses the same vector, slimming down the STI a bit.

Merge checklist

• Added/updated tests
• Added/updated documentation in Lookbook (patterns, previews, etc)
• Tested major browsers (Chrome, Firefox, Edge, ...)

[mrmir]

This is not an exhaustive review, but it seems to work well and matches the mock ups/AC.

I don't know how many of these will change with the upcoming UI/primerisation work, but they're here nonetheless:

1. Why does a new section in user attributes default to the top?
2. Can there be a button in the section header to add a new attribute to it directly?
3. It makes sense to me to return to the user attributes list after saving a new one
4. There is no search bar to filter user attributes

There are also some inline code remarks.

Additionally, I would like it if the upcoming primerisation work can be done in a separate PR as at 4.5k+ lines this is already rather difficult to review properly in detail, imo.

[dfriquet]

Thank you for your first comments @mrmir

Additionally, I would like it if the upcoming primerisation work can be done in a separate PR as at 4.5k+ lines this is already rather difficult to review properly in detail, imo.

That is indeed my intention too, I really do agree with you. I will even try to make it a separate WP so that we can ship the feature first and the embellishment later.

[klaustopher]

Great. Thank you. About the open point... Let's see what will be said during review. But I have no hard opinion there.

[github-actions]

Warning

Flaky specs

• rspec ./modules/wikis/spec/features/admin/internal_provider_spec.rb[1:1]