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.

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

[3424] Fix document migration data during creation #3427

Merged
merged 1 commit into from
May 6, 2024

Conversation

mcharfadi
Copy link
Contributor

@mcharfadi mcharfadi commented Apr 29, 2024

Bug: #3424

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?

@@ -35,7 +35,7 @@
@Service
public class NodeDescriptionLabelExpressionMigrationParticipant implements IMigrationParticipant {

private static final String PARTICIPANT_VERSION = "2024.4.0";
private static final String PARTICIPANT_VERSION = "2024.3.2.22.0.0";
Copy link
Member

Choose a reason for hiding this comment

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

I somehow missed that but we discussed in details about the shape that was expected for the migration participant version and I don't understand what this is supposed to be (what is this 22 for example?). I don't know what this is supposed to be. I need an iteration, a date and some time, something like this 2024.8.0-202407121400. It needs to be more specific in the ADR.

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 updated the ADR in order to be more precise about the version of participants

@@ -37,6 +41,12 @@ public class DefaultDomainResourceProvider implements IDefaultDomainResourceProv

private static final String DOMAIN_DOCUMENT_NAME = "DomainNewModel";

private final List<IMigrationParticipant> migrationParticipants;
Copy link
Member

Choose a reason for hiding this comment

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

It will not be viable in the long run to ask everybody to get injected with this every time they want to create a new resource.

Copy link
Contributor Author

@mcharfadi mcharfadi Apr 29, 2024

Choose a reason for hiding this comment

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

Would setting the correct migrationData in StudioProjectTemplateInitializer be more acceptable then ?

@mcharfadi mcharfadi force-pushed the mch/fix/documentMigrationData branch 3 times, most recently from f344515 to 91d1e45 Compare April 29, 2024 09:51
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 update this tiny detail and merge it

@sbegaudeau sbegaudeau force-pushed the mch/fix/documentMigrationData branch from 91d1e45 to 180c976 Compare May 6, 2024 08:44
@sbegaudeau
Copy link
Member

I'll wait for the build and merge it just after

Bug: #3424
Signed-off-by: Michaël Charfadi <michael.charfadi@obeosoft.com>
@sbegaudeau sbegaudeau force-pushed the mch/fix/documentMigrationData branch from 180c976 to c9c69ec Compare May 6, 2024 09:20
@sbegaudeau sbegaudeau merged commit 0c2dd4a into master May 6, 2024
3 of 4 checks passed
@sbegaudeau sbegaudeau deleted the mch/fix/documentMigrationData branch May 6, 2024 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Wrong migration version for newly created model
2 participants