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

[KED-2266] Fix error when changing pipeline and hovering nodes in Safari #306

Merged
merged 2 commits into from
Nov 16, 2020

Conversation

studioswong
Copy link
Contributor

@studioswong studioswong commented Nov 16, 2020

Description

This PR is a quick patch fix for KED-2266 (https://jira.quantumblack.com/browse/KED-2266), which is a bug in loading node data when changing pipelines on safari.

Development notes

The problem is caused by a series of undefined values within the allNodes array ( see below ).
image

While the cause of the issue might be related to the wider setup of the new multiple pipeline feature, a simple patch fix of applying a filter to filter out any undefined nodes to the list of aggregated nodes is applied in defining allNodes within the draw feature of flowchart.

I have not included a test given this is just a quick patch fix while we currently don't have any test set up for testing D3 rendering within the draw feature, however it might be worth to look into setting up further tests to test D3 rendering function to capture cases such as this.

Thank you @bru5 for your help and context on this bug!

QA notes

The bug can be reproduced via changing pipelines and hovering on the nodes in the flowchart diagram. I have performed a quick regression test on testing the rendering of the chart on switching between pipelines, but it would be good for ay extra pair of eyes to capture any potential error as well.

Checklist

  • Read the contributing guidelines
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added new entries to the RELEASE.md file
  • Added tests to cover my changes

Legal notice

  • I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

  • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.

  • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorised to submit this contribution on behalf of the original creator(s) or their licensees.

  • I certify that the use of this contribution as authorised by the Apache 2.0 license does not violate the intellectual property rights of anyone else.

@studioswong
Copy link
Contributor Author

Please note currently the e2e python tests are failing on the CI until the fix from core team is merged into main

@richardwestenra richardwestenra requested a review from bru5 November 16, 2020 15:57
Copy link
Contributor

@richardwestenra richardwestenra left a comment

Choose a reason for hiding this comment

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

I'm happy with this, thanks for the quick fix. @bru5 do you have any thoughts about perf vs alternatives? I guess we can address that later?

@richardwestenra richardwestenra merged commit 897feb1 into main Nov 16, 2020
@richardwestenra richardwestenra deleted the fix/KED-2166-fix-changing-pipeline-error-safari branch November 16, 2020 16:53
@richardwestenra richardwestenra mentioned this pull request Nov 16, 2020
1 task
@richardwestenra richardwestenra changed the title KED-2266: Error when changing pipeline and hovering nodes in Safari [KED-2266] Fix error when changing pipeline and hovering nodes in Safari Nov 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants