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

[3664] Fix missing default images #3665

Merged
merged 1 commit into from
Jun 28, 2024
Merged

[3664] Fix missing default images #3665

merged 1 commit into from
Jun 28, 2024

Conversation

florianbarbin
Copy link
Contributor

Bug: #3664

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?

@florianbarbin florianbarbin added this to the 2024.7.0 milestone Jun 26, 2024
@florianbarbin florianbarbin linked an issue Jun 26, 2024 that may be closed by this pull request
The Default.svg image is no longer displayed with the new architecture #3664
Closed
4 tasks
pcdavid referenced this pull request Jun 27, 2024
@sbegaudeau
[3649] Restore support for Related elements view icons
0f86ef8 
Bug: #3649
Signed-off-by: Stéphane Bégaudeau <[email protected]>
gcoutable
gcoutable reviewed Jun 27, 2024
View reviewed changes
...-core/src/main/java/org/eclipse/sirius/components/core/services/DefaultImagePathService.java Outdated
* @author fbarbin
*/
@Service
public class DefaultImagePathService implements IImagePathService {
Copy link
Member

Choose a reason for hiding this comment

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

Why is this named Default...?
Is it because of the Default image or, because /icons/svg is a default path?

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 did not find a better name.
CoreImagePathService ?

Copy link
Member

@gcoutable gcoutable Jun 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

IMO:

  • If you want to name it CoreImagePathService, "core" should be added to the path ("/icons/core").
  • You also may keep default but add "default" to the path ("icons/svg/default").
  • A third solution would be to register the image in sirius-web-application and add "/icons/svg" in the existing ImagePathService

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok for the third one !

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Finally I would suggest CoreImagePathService since we already use CoreImageConstants.IMAGES_ROOT_FOLDER and CoreImageConstants.DEFAULT_SVG to reference the default.svg multiple time in the sirius-web-application module

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@gcoutable what do you think ?

Copy link
Member

Choose a reason for hiding this comment

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

CoreImagePathService using CoreImageConstants would do it.

@florianbarbin florianbarbin requested a review from gcoutable June 28, 2024 07:24
@florianbarbin
[3664] Fix missing default images
8bbd7b0 
Bug: #3664
Signed-off-by: Florian Barbin <[email protected]>
@gcoutable gcoutable merged commit e9a515e into master Jun 28, 2024
4 checks passed
@gcoutable gcoutable deleted the fba/fix/defaultSvg branch June 28, 2024 08:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gcoutable gcoutable gcoutable approved these changes

@pcdavid pcdavid pcdavid approved these changes

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

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

Successfully merging this pull request may close these issues.

The Default.svg image is no longer displayed with the new architecture
3 participants
@florianbarbin @pcdavid @gcoutable