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

[4210] Add the ability to fork the studio used by a table representation #4212

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

[4210] Add the ability to fork the studio used by a table representation #4212

wants to merge 3 commits into from

Conversation

mcharfadi
Copy link
Contributor

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?

@mcharfadi mcharfadi added this to the 2025.1.0 milestone Nov 19, 2024
@mcharfadi mcharfadi linked an issue Nov 19, 2024 that may be closed by this pull request
Add the ability to fork the studio used by a table representation #4210
Open
@mcharfadi mcharfadi force-pushed the mch/enh/fork-table branch 2 times, most recently from 0133bfe to 74856b5 Compare November 19, 2024 08:39
sbegaudeau
sbegaudeau requested changes Nov 19, 2024
View reviewed changes
packages/tables/frontend/sirius-components-tables/package.json
@@ -41,7 +41,8 @@
"react": "18.3.1",
"react-dom": "18.3.1",
"tss-react": "4.9.7",
"xstate": "4.32.1"
"xstate": "4.32.1",
"react-router-dom": "6.26.0"
Copy link
Member

Choose a reason for hiding this comment

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

The table support should not depend on react-router

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes I need the extension point in order to remove this dependency.
#4179

packages/tables/frontend/sirius-components-tables/src/ForkViewMenuMenuAction.tsx Outdated
GQLErrorPayload,
} from './ForkViewMenuMenuAction.types';

const forkViewMutation = gql`
Copy link
Member

Choose a reason for hiding this comment

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

This action should be in a dedicated frontend module name something like sirius-web-table isolated from the table implementation. Only the sirius-web module should use it.

...a/org/eclipse/sirius/web/application/studio/fork/controllers/MutationCreateForkedStudio.java Outdated
* Contributors:
* Obeo - initial API and implementation
*******************************************************************************/
package org.eclipse.sirius.web.application.studio.fork.controllers;
Copy link
Member

Choose a reason for hiding this comment

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

All this backend code should be in a dedicated backend project, something like sirius-web-table and only the project sirius-web should use it.

packages/tables/frontend/sirius-components-tables/src/TableContent.tsx Outdated
</Button>
</Box>
<Box>
<ForkViewMenuMenuAction
Copy link
Member

Choose a reason for hiding this comment

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

This should be contributed thanks to the extension point

@mcharfadi mcharfadi force-pushed the mch/enh/fork-table branch 14 times, most recently from bc1fcf1 to c4bbc35 Compare November 25, 2024 09:18
@mcharfadi mcharfadi force-pushed the mch/enh/fork-table branch 5 times, most recently from 39d7226 to 202c1c7 Compare December 2, 2024 10:37
@mcharfadi
Copy link
Contributor Author

I'll add the commit that add the extension point on top to make it faster to integrate

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

@sbegaudeau sbegaudeau sbegaudeau requested changes

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

@AxelRICHARD AxelRICHARD Awaiting requested review from AxelRICHARD

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
pr: to review later priority: low
Projects
None yet
Milestone
2025.1.0
Development

Successfully merging this pull request may close these issues.

Add the ability to fork the studio used by a table representation
3 participants
@mcharfadi @sbegaudeau @frouene