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

DYN-7919: Fix stray helpdoc filenames in infobubbles, remove dangling reference to inexistent helpdocs. #15688

Merged
merged 4 commits into from
Nov 27, 2024

Conversation

chubakueno
Copy link
Contributor

Purpose

#14514 Introduced a bug in which the linked helpdoc file appears concatenated at the end of the message info bubbles (See DereferencingNonPointer.html in the PR screenshots). This PR fixes that issue by properly sanitizing the message content and it also removes dangling references to a testing.html helpdoc that never existed.

Message with bug:
image

Message without bug in case of several warnings:
image

Message without bug in case of a single warning:

image

Declarations

Check these if you believe they are true

  • The codebase is in a better state after this PR
  • Is documented according to the standards
  • The level of testing this PR includes is appropriate
  • User facing strings, if any, are extracted into *.resx files
  • All tests pass using the self-service CI.
  • Snapshot of UI changes, if any.
  • Changes to the API follow Semantic Versioning and are documented in the API Changes document.
  • This PR modifies some build requirements and the readme is updated
  • This PR contains no files larger than 50 MB

Release Notes

Fix stray helpdoc filename at the end of infobubble messages, remove dangling reference to inexistent helpdocs.

Reviewers

@QilongTang
@RobertGlobant20

FYIs

@avidit

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

See the ticket for this pull request: https://jira.autodesk.com/browse/DYN-7919

Copy link

github-actions bot commented Nov 27, 2024

UI Smoke Tests

Test: success. 11 passed, 0 failed.
TestComplete Test Result
Workflow Run: UI Smoke Tests
Check: UI Smoke Tests

@avidit avidit requested a review from QilongTang November 27, 2024 01:02
@QilongTang QilongTang added this to the 3.5 milestone Nov 27, 2024
@QilongTang
Copy link
Contributor

@chubakueno Would you test after sanitizing the warning message, if clicking on learn more would still pop up the warning help content in the right side panel?

@chubakueno
Copy link
Contributor Author

chubakueno commented Nov 27, 2024

@chubakueno Would you test after sanitizing the warning message, if clicking on learn more would still pop up the warning help content in the right side panel?

Sure. Some warnings will no longer have the Learn more button because the testing.html link was removed, but others shouldn't be affected by the message sanitization (InfoBubbleDataPacket.ParseLinkFromText and InfoBubbleDataPacket.RemoveLinkFromText are not dependent on each other).
image

Duplicate warning after removal of the dangling testing.html link.
image

@chubakueno
Copy link
Contributor Author

@chubakueno Would you test after sanitizing the warning message, if clicking on learn more would still pop up the warning help content in the right side panel?

Added tests to verify links are properly sanitized and extended the sanitizer to be more lenient (it will now accept everything until a space, newline, or end of string).

@QilongTang
Copy link
Contributor

@chubakueno Thank you, we will have a follow up task to add back the content missed

@QilongTang QilongTang merged commit 02b2f0e into DynamoDS:master Nov 27, 2024
24 checks passed
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