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

[doc] Add shape for border node initial positioning #4453

Merged
merged 2 commits into from
Jan 31, 2025

Conversation

lfasani
Copy link
Contributor

@lfasani lfasani commented Jan 22, 2025

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?

@lfasani lfasani added this to the 2025.2.0 milestone Jan 22, 2025
@lfasani lfasani self-assigned this Jan 22, 2025
@lfasani lfasani requested a review from sbegaudeau as a code owner January 22, 2025 10:29
@lfasani lfasani marked this pull request as draft January 22, 2025 11:01
Comment on lines 18 to 19
We need to create a new class `BorderNodeDescription` which is a sub class of `NodeDescription`.
`BorderNodeDescription` will hold the feature `initialPosition` of type enum `BorderNodePosition`.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, it is not the right way to do that.
We should put the information on a xxxLayoutStrategyDescription.
-> to rework

Copy link
Member

Choose a reason for hiding this comment

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

The proposed change would have a massive impact and would prevent some use cases that are currently possible. It would be way less impactful to just add the information on the layout strategy description of the parent node. Like in CSS a div can define where its children are using flexbox or grid for example.

Something like this:

class LayoutStrategyDescription {
    onRightAtCreationBorderNodes: List<NodeDescription>
    onLeftAtCreationBorderNodes: List<NodeDescription>
    onTopAtCreationBorderNodes: List<NodeDescription>
    onBottomAtCreationBorderNodes: List<NodeDescription>
}

We would just need to customize the EMF Edit code to only offer the current border node descriptions of the node description as potential references...

@lfasani lfasani force-pushed the lfa/enh/borderNode branch from 8e280a2 to 018a076 Compare January 31, 2025 08:28
@lfasani lfasani marked this pull request as ready for review January 31, 2025 08:28
@lfasani lfasani requested a review from frouene January 31, 2025 08:29
@lfasani lfasani force-pushed the lfa/enh/borderNode branch from 018a076 to 7208161 Compare January 31, 2025 08:46

== Problem

In a diagram, a `Border Node` is always created on the left of the `Node`(WEST position).
Copy link
Contributor

Choose a reason for hiding this comment

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

I thinik it's on the right side (EAST position)


== Rabbit Holes

Not identified.
Copy link
Contributor

Choose a reason for hiding this comment

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

You can remove this line

}
```

For those four features, we will make sure that the specifier is capable of selecting only the border nodes of the current NodeDescription.
Copy link
Contributor

Choose a reason for hiding this comment

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

What happen if a same NodeDescription is declared in several lists?

@lfasani lfasani force-pushed the lfa/enh/borderNode branch from 7208161 to 890e776 Compare January 31, 2025 13:39
lfasani and others added 2 commits January 31, 2025 16:14
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 merge it after the build

@sbegaudeau sbegaudeau dismissed frouene’s stale review January 31, 2025 15:40

I'll dismiss this since it's quite minor and I'll use this PR to perform the release :)

@sbegaudeau sbegaudeau merged commit dd382eb into master Jan 31, 2025
4 checks passed
@sbegaudeau sbegaudeau deleted the lfa/enh/borderNode branch January 31, 2025 15:40
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.

3 participants