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

[1966] Add Selection Description in the View DSL #1974

Merged

Conversation

mcharfadi
Copy link
Contributor

Bug : #1966
Signed-off-by: Michaël Charfadi michael.charfadi@obeosoft.com

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 force-pushed the mch/enh/view-description-dialog branch 4 times, most recently from 82a7a28 to 09a2b45 Compare May 17, 2023 07:26
@sbegaudeau sbegaudeau added this to the 2023.6.0 milestone May 22, 2023
@sbegaudeau sbegaudeau linked an issue May 22, 2023 that may be closed by this pull request
@mcharfadi mcharfadi force-pushed the mch/enh/view-description-dialog branch 3 times, most recently from 27428bb to 24e1bcd Compare May 30, 2023 15:12
@@ -50,6 +50,8 @@
@Service
public class ObjectService implements IObjectService {

public static final String DEFAULT_ICON_PATH = "/icons/svg/Default.svg";
Copy link
Member

Choose a reason for hiding this comment

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

This icon is not related to sirius-components-core, some of our users do not have sirius-components-compatibility in their final application. I don't mind sirius-components-core having a default image but in that case, it should be in sirius-components-core

Copy link
Member

Choose a reason for hiding this comment

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

I'll move the image by myself but I'll open an issue to be fixed to take into account that a default icon is now available in ObjectService#getImagePath

@sbegaudeau
Copy link
Member

I did not test the review for now, I have only looked at the code quickly

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've moved the icon by myself, I'll wait for the build to merge the PR

@sbegaudeau sbegaudeau force-pushed the mch/enh/view-description-dialog branch from 24e1bcd to 390de6d Compare June 1, 2023 07:27
Bug: eclipse-sirius#1966
Signed-off-by: Michaël Charfadi <michael.charfadi@obeosoft.com>
@gcoutable gcoutable force-pushed the mch/enh/view-description-dialog branch from 390de6d to deede6f Compare June 1, 2023 08:28
@sbegaudeau sbegaudeau dismissed pcdavid’s stale review June 1, 2023 09:27

The comments have been taken into account

@sbegaudeau sbegaudeau merged commit 542d1b9 into eclipse-sirius:master Jun 1, 2023
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.

Add Selection Description in the View DSL
4 participants