Allow the ability to re-order designs (#34382) · Issues · GitLab.org / GitLab

Allow the ability to re-order designs

Problem to solve

Currently, designs are presented ordered by their created date. This prevents users from ordering the designs in a way that makes sense (e.g. to show flows or progressions through the UI).

Further details

The manual sort order can be re-ordered by anyone with edit access to the issue (just like anyone can edit a description on an issue) but the order is saved and not altered until manually changed again.

Prototype by @jareko

https://codepen.io/jareko999/full/BaaRYog

Documentation

Design management documentation should be updated

Proposal

We would like to allow certain users to be able to re-order the designs, manually. This new order would be preserved when another user views the designs.

When new designs are uploaded, they will be inserted at the end of the list, not the beginning.

Backend Planning Comments

MR Breakdown

@toupeira:

1 MR to add the new DB column
1 MR to add a new GraphQL endpoint to reorder a design

@.luke:

GraphQL mutation to update order of single design or multiple designs in collection
GraphQL changes to DesignType

Migration:

Database migration of new column on tables

Either a data migration to backfill these values based on current ordering OR we do a kind of lazy-setting of this. I.e., don't set anything for a collection until we update it.

Database migration
Service for setting order
Change to DesignsFinder to return by ordering
Expose order in GraphQL DesignType
GraphQL mutation for setting order

Possible data migration to backfill, but we could try making this lazily-set within the service in step 2

Testing Activity

@toupeira :

If a custom order is present:

Order should be kept if designs in the beginning/middle/end are deleted
Newly added designs should be inserted at the end (or at the beginning?)

If a custom order is not present:

Adding/deleting designs should behave as before

@.luke: Unit tests:

Service
DesignFinder changes
GraphQL Type changes
GraphQL mutation(s)

Request spec:

GraphQL mutation(s)

All tests including permissions, handling bad data

Security Testing

@.luke:

re-use an existing permission.

### Problem to solve

Currently, designs are presented ordered by their created date. This prevents users from ordering the designs in a way that makes sense (e.g. to show flows or progressions through the UI).

### Further details

The manual sort order can be re-ordered by **anyone** with edit access to the issue (just like anyone can edit a description on an issue) but the order is saved and not altered until manually changed again.

### Prototype by @jareko

https://codepen.io/jareko999/full/BaaRYog

### Documentation

- Design management documentation should be updated

### Proposal

We would like to allow certain users to be able to re-order the designs, manually. This new order would be preserved when another user views the designs.

When new designs are uploaded, they will be inserted at the end of the list, not the beginning.

## Backend Planning Comments

### MR Breakdown

@toupeira:
* 1 MR to add the new DB column
* 1 MR to add a new GraphQL endpoint to reorder a design

@.Luke:
- GraphQL mutation to update order of single design or multiple designs in collection
- GraphQL changes to DesignType

Migration:
- Database migration of new column on tables

Either a data migration to backfill these values based on current ordering OR we do a kind of lazy-setting of this. I.e., don't set anything for a collection until we update it.

* Database migration
* Service for setting order
* Change to DesignsFinder to return by ordering
* Expose order in GraphQL DesignType
* GraphQL mutation for setting order

Possible data migration to backfill, but we could try making this lazily-set within the service in step 2

### Testing Activity

@toupeira :

If a custom order is present:
- Order should be kept if designs in the beginning/middle/end are deleted
- Newly added designs should be inserted at the end (or at the beginning?)

If a custom order is not present:
- Adding/deleting designs should behave as before

@.Luke:
Unit tests:

- Service
- DesignFinder changes
- GraphQL Type changes
- GraphQL mutation(s)