Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[4335] Add support of column reordering in table representation #4340

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[4335] Add support of column reordering in table representation #4340

wants to merge 1 commit into from

Conversation

jerome-obeo
Copy link
Contributor

Bug: #4335

Pull request template

General purpose

What is the main goal of this pull request?

  • Bug fixes
  • New features
  • Documentation
  • Cleanup
  • Tests
  • Build / releng

Project management

  • Has the pull request been added to the relevant project and milestone? (Only if you know that your work is part of a specific iteration such as the current one)
  • Have the priority: and pr: labels been added to the pull request? (In case of doubt, start with the labels priority: low and pr: to review later)
  • Have the relevant issues been added to the pull request?
  • Have the relevant labels been added to the issues? (area:, difficulty:, type:)
  • Have the relevant issues been added to the same project and milestone as the pull request?
  • Has the CHANGELOG.adoc been updated to reference the relevant issues?
  • Have the relevant API breaks been described in the CHANGELOG.adoc? (Including changes in the GraphQL API)
  • In case of a change with a visual impact, are there any screenshots in the CHANGELOG.adoc? For example in doc/screenshots/2022.5.0-my-new-feature.png

Architectural decision records (ADR)

  • Does the title of the commit contributing the ADR start with [doc]?
  • Are the ADRs mentioned in the relevant section of the CHANGELOG.adoc?

Dependencies

  • Are the new / upgraded dependencies mentioned in the relevant section of the CHANGELOG.adoc?
  • Are the new dependencies justified in the CHANGELOG.adoc?

Frontend

This section is not relevant if your contribution does not come with changes to the frontend.

General purpose

  • Is the code properly tested? (Plain old JavaScript tests for business code and tests based on React Testing Library for the components)

Typing

We need to improve the typing of our code, as such, we require every contribution to come with proper TypeScript typing for both changes contributing new files and those modifying existing files.
Please ensure that the following statements are true for each file created or modified (this may require you to improve code outside of your contribution).

  • Variables have a proper type
  • Functions’ arguments have a proper type
  • Functions’ return type are specified
  • Hooks are properly typed:
    • useMutation<DATA_TYPE, VARIABLE_TYPE>(…)
    • useQuery<DATA_TYPE, VARIABLE_TYPE>(…)
    • useSubscription<DATA_TYPE, VARIABLE_TYPE>(…)
    • useMachine<CONTEXT_TYPE, EVENTS_TYPE>(…)
    • useState<STATE_TYPE>(…)
  • All components have a proper typing for their props
  • No useless optional chaining with ?. (if the GraphQL API specifies that a field cannot be null, do not treat it has potentially null for example)
  • Nullable values have a proper type (for example let diagram: Diagram | null = null;)

Backend

This section is not relevant if your contribution does not come with changes to the backend.

General purpose

  • Are all the event handlers tested?
  • Are the event processor tested?
  • Is the business code (services) tested?
  • Are diagram layout changes tested?

Architecture

  • Are data structure classes properly separated from behavioral classes?
  • Are all the relevant fields final?
  • Is any data structure mutable? If so, please write a comment indicating why
  • Are behavioral classes either stateless or side effect free?

Review

How to test this PR?

Please describe here the various use cases to test this pull request

  • Has the Kiwi TCMS test suite been updated with tests for this contribution?

@sbegaudeau sbegaudeau linked an issue Dec 22, 2024 that may be closed by this pull request
Add support of column reordering in Table representation #4335
Open
@sbegaudeau sbegaudeau added this to the 2025.2.0 milestone Dec 22, 2024
sbegaudeau
sbegaudeau reviewed Dec 22, 2024
View reviewed changes
...bles/backend/sirius-components-collaborative-tables/src/main/resources/schema/table.graphqls
@@ -54,6 +54,7 @@ type Column {
isResizable: Boolean!
hidden: Boolean!
filterVariant: String!
index: Int
Copy link
Member

@sbegaudeau sbegaudeau Dec 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why such an index and why should it be optional? The order of the column is already given by the order in Table#columns, why would we need a second piece of information for that?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MRT handles column order separately from the column definition, so following this separation made more sense. Without any specific order information, the column order is given by column definition but as soon as the user decides to change this definition order, his order takes priority.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that's exactly my point, why are you both managing the state of the order of the columns on the frontend and the backend and reconciling both? I don't see the need for a duplicate column order state. Just tell the backend what to do once a column is dropped.

As it stand today, the state gets instantaneously updated on the frontend because you are considering that your code KNOWS what the consequence of this change in the order of the column will be and it gets synchronized later with the backend. The frontend should NEVER make any hypothesis on the consequences of a change. Let's consider that we have three columns, "A", "B" and "C", just because a column "B" is now dropped before a column "A", it does not mean that we will have "B", "A", "C" after the next refresh.

The frontend should just ask the backend to do its job.

@jerome-obeo jerome-obeo force-pushed the jgo/enh/add_column_reordering branch from 6aebbd3 to 641673a Compare December 23, 2024 14:56
sbegaudeau
sbegaudeau requested changes Jan 2, 2025
View reviewed changes
packages/tables/frontend/sirius-components-tables/src/table/TableContent.tsx
@@ -162,7 +166,9 @@ export const TableContent = memo(
onColumnSizingChange: setColumnSizing,
onColumnVisibilityChange: setColumnVisibility,
onDensityChange: setDensity,
state: { columnSizing, columnVisibility, globalFilter, density, columnFilters },
enableColumnOrdering: true,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why would this be enabled when the option to enableColumnOrdering received as a prop could be false?

...bles/backend/sirius-components-collaborative-tables/src/main/resources/schema/table.graphqls
@@ -54,6 +54,7 @@ type Column {
isResizable: Boolean!
hidden: Boolean!
filterVariant: String!
index: Int
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that's exactly my point, why are you both managing the state of the order of the columns on the frontend and the backend and reconciling both? I don't see the need for a duplicate column order state. Just tell the backend what to do once a column is dropped.

As it stand today, the state gets instantaneously updated on the frontend because you are considering that your code KNOWS what the consequence of this change in the order of the column will be and it gets synchronized later with the backend. The frontend should NEVER make any hypothesis on the consequences of a change. Let's consider that we have three columns, "A", "B" and "C", just because a column "B" is now dropped before a column "A", it does not mean that we will have "B", "A", "C" after the next refresh.

The frontend should just ask the backend to do its job.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sbegaudeau sbegaudeau sbegaudeau requested changes

@AxelRICHARD AxelRICHARD Awaiting requested review from AxelRICHARD AxelRICHARD is a code owner

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
pr: to review soon priority: high
Projects
None yet
Milestone
2025.2.0
Development

Successfully merging this pull request may close these issues.

Add support of column reordering in Table representation
2 participants
@jerome-obeo @sbegaudeau