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

[3307] Added IRepresentationMigrationParticipant #3419

Merged
merged 1 commit into from May 14, 2024
Merged

[3307] Added IRepresentationMigrationParticipant #3419

merged 1 commit into from May 14, 2024

Conversation

mcharfadi
Copy link
Contributor

@mcharfadi mcharfadi commented Apr 25, 2024 •
edited

Bug: #3307

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 2024.5.0 milestone Apr 25, 2024
@mcharfadi mcharfadi linked an issue Apr 25, 2024 that may be closed by this pull request
Add support for the migration of representation data #3307
Closed
@mcharfadi mcharfadi force-pushed the mch/enh/representationMigration branch 7 times, most recently from 89b4ff4 to e5746f7 Compare April 26, 2024 08:48
@mcharfadi mcharfadi marked this pull request as ready for review April 26, 2024 08:56
@mcharfadi mcharfadi force-pushed the mch/enh/representationMigration branch 7 times, most recently from a356462 to 15e00cf Compare April 29, 2024 11:27
sbegaudeau
sbegaudeau requested changes May 6, 2024
View reviewed changes
.../components/collaborative/representations/migration/IRepresentationMigrationParticipant.java Outdated Show resolved Hide resolved
CHANGELOG.adoc Show resolved Hide resolved
...ava/org/eclipse/sirius/components/collaborative/representations/migration/MigrationData.java Outdated Show resolved Hide resolved
...ditingcontext/migration/participants/representation/HierarchyChildrenAttributeMigration.java Outdated
public class HierarchyChildrenAttributeMigration implements IRepresentationMigrationParticipant {
@Override
public String getVersion() {
return "2024.3.3.26.4.9";
Copy link
Member

Choose a reason for hiding this comment

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

This version number will have to change to be up to date

.../org/eclipse/sirius/web/application/representation/services/RepresentationSearchService.java Outdated Show resolved Hide resolved
.../org/eclipse/sirius/web/application/representation/services/RepresentationSearchService.java Outdated Show resolved Hide resolved
...ava/org/eclipse/sirius/web/domain/boundedcontexts/representationdata/RepresentationData.java Outdated Show resolved Hide resolved
...s-web/src/test/java/org/eclipse/sirius/web/services/migration/MigrationParticipantTests.java Outdated
assertThat(optionalRepresentationData).isPresent();

var representationData = optionalRepresentationData.get();
assertThat(representationData.getMigrationVersion()).isEqualTo("2024.3.3.26.4.9");
Copy link
Member

Choose a reason for hiding this comment

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

The version should be updated

packages/sirius-web/backend/sirius-web/src/test/resources/scripts/migration.sql Outdated
}',
'2024-01-01 9:42:0.000',
'2024-01-02 9:42:0.000',
'',
Copy link
Member

Choose a reason for hiding this comment

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

We should probably have a default value for the last migration performed a bit more explicit than an empty string, something like 'no migration ever performed' would make it more easy to see non updated representation data.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I put "none" like for the migration of models

packages/sirius-web/backend/sirius-web/src/test/resources/scripts/initialize.sql
@@ -139,7 +139,9 @@ INSERT INTO representation_data (
kind,
content,
created_on,
last_modified_on
last_modified_on,
Copy link
Member

Choose a reason for hiding this comment

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

On master there will be more sql file to update

@mcharfadi mcharfadi changed the title [3307] Added IMigrationParticipant for the migration of representations [3307] Added IRepresentationMigrationParticipant May 7, 2024
@mcharfadi mcharfadi force-pushed the mch/enh/representationMigration branch 7 times, most recently from b973f42 to 5a0286f Compare May 7, 2024 08:26
@mcharfadi mcharfadi force-pushed the mch/enh/representationMigration branch 7 times, most recently from 461dbad to 69f2b7f Compare May 13, 2024 09:19
sbegaudeau
sbegaudeau reviewed May 14, 2024
View reviewed changes
Copy link
Member

@sbegaudeau sbegaudeau left a comment

Choose a reason for hiding this comment

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

I'll fix a small issue or two, rebase it and merge it. Please use the present instead of the past for your commit message "Added" -> "Add".

...ava/org/eclipse/sirius/web/domain/boundedcontexts/representationdata/RepresentationData.java Outdated Show resolved Hide resolved
.../java/org/eclipse/sirius/web/services/migration/RepresentationMigrationParticipantTests.java Outdated
private IRepresentationPersistenceService representationPersistenceService;

@Test
@DisplayName("Given a project with an old representation, HierarchyChildrenAttributeMigration migrates the representation correctly")
Copy link
Member

Choose a reason for hiding this comment

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

Given INITIAL STATE, when BEHAVIOR TO TEST, then EXPECTED RESULT

Copy link
Member

Choose a reason for hiding this comment

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

And use the same naming convention in the name of the method please :)

@mcharfadi @sbegaudeau
[3307] Add support for the migration of representations
0fbe7a4 
Bug: #3307
Signed-off-by: Michaël Charfadi <michael.charfadi@obeosoft.com>
@sbegaudeau sbegaudeau force-pushed the mch/enh/representationMigration branch from 69f2b7f to 0fbe7a4 Compare May 14, 2024 08:14
@sbegaudeau sbegaudeau merged commit 7aabab4 into master May 14, 2024
4 checks passed
@sbegaudeau sbegaudeau deleted the mch/enh/representationMigration branch May 14, 2024 09:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sbegaudeau sbegaudeau sbegaudeau approved these changes

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

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

Successfully merging this pull request may close these issues.

Add support for the migration of representation data
2 participants
@mcharfadi @sbegaudeau