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

[3651] Improve isDescendantOf used in diagram #3652

Merged
merged 1 commit into from
Jun 20, 2024

Conversation

mcharfadi
Copy link
Contributor

Bug: #3651

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.7.0 milestone Jun 20, 2024
@mcharfadi mcharfadi requested a review from pcdavid June 20, 2024 07:30
@mcharfadi mcharfadi requested a review from gcoutable as a code owner June 20, 2024 07:30
@mcharfadi mcharfadi linked an issue Jun 20, 2024 that may be closed by this pull request
@mcharfadi mcharfadi marked this pull request as draft June 20, 2024 07:35
@mcharfadi mcharfadi force-pushed the mch/enh/isDescendantOf branch from 7258fe4 to 4966935 Compare June 20, 2024 07:42
@mcharfadi mcharfadi marked this pull request as ready for review June 20, 2024 07:42
@pcdavid pcdavid self-assigned this Jun 20, 2024
Copy link
Member

@pcdavid pcdavid left a comment

Choose a reason for hiding this comment

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

Not sure if there is a possible regression with hidden nodes, but otherwise I confirm the performance improvements:

Before:

Capture.video.du.2024-06-20.10-00-01.mp4

After:

Capture.video.du.2024-06-20.10-00-39.mp4

}
const horizontalDifference = Math.abs(centerA.x - centerB.x);
const verticalDifference = Math.abs(centerA.y - centerB.y);
const isDescendant = isDescendantOf(nodeB, nodeA, (nodeId) => visiblesNodes.find((node) => node.id === nodeId));
const isDescendant = isDescendantOf(nodeB, nodeA, nodeInternals);
Copy link
Member

Choose a reason for hiding this comment

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

nodeInternals contains all the nodes, including hidden ones, right?
If that's the case, doesn't this change the behavior? Before, we only looked into visible nodes. It doesn't seem like isDescendantOf tests for visiblity.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you, I missed that indeed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It seems that the variable was called visiblesNodes but we were passing all nodes when calling it

@mcharfadi mcharfadi force-pushed the mch/enh/isDescendantOf branch from 4966935 to 244d3b0 Compare June 20, 2024 08:55
@sbegaudeau sbegaudeau force-pushed the mch/enh/isDescendantOf branch from 244d3b0 to f4e4755 Compare June 20, 2024 15:03
@sbegaudeau
Copy link
Member

I've not read a single line of this code, but since the PR has been approved, I've just resolved the conflict in the CHANGELOG since new commits have been merged on master and I'll merge it.

@sbegaudeau sbegaudeau merged commit 1eab033 into master Jun 20, 2024
4 checks passed
@sbegaudeau sbegaudeau deleted the mch/enh/isDescendantOf branch June 20, 2024 15:05
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.

Improve isDescendantOf method
3 participants