Skip to content

Conversation

@RobertGlobant20
Copy link
Contributor

Purpose

Fix for not showing weird characters in DocumentationBrowser in a CHS OS
When using a Windows 10 OS installed in Chinese Traditional if you open DocumentationBrowser several times for each node in the workspace, the DocumentationBrowser starts to show weird characters and the html layout seems different, this was happening due that the Md2Html.Convert and Md2Html.Sanitize methods were not executed, after my fix now they were executed but was still showing weird characters (due that Md2Html encoding was in Chinese Traditional). Then for fixing this problem I had to encode the info using base64 and decoded when is needed.
There was a freeze reported in the Jira task but I was not able to reproduce it after my fix.

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 for not showing weird characters in DocumentationBrowser in a CHS OS

Reviewers

@QilongTang

FYIs

When using a Windows 10 OS installed in Chinese Traditional if you open DocumentationBrowser several times for each node in the workspace, the DocumentationBrowser starts to show weird characters and the html layout seems different, this was happening due that the Md2Html.Convert and Md2Html.Sanitize methods were not executed, after my fix now they were executed but was still showing weird characters (due that Md2Html encoding was in Chinese Traditional). Then for fixing this problem I had to encode the info using base64 and decoded when is needed.
There was a freeze reported in the Jira task but I was not able to reproduce it after my fix.
fixing bug that was generating a infinite loop
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-7435

@RobertGlobant20
Copy link
Contributor Author

This is a GIF showing the behavior BEFORE my fix.
BeforeMyFix

@RobertGlobant20
Copy link
Contributor Author

This is a GIF showing the behavior AFTER my fix
AfterMyFix

@QilongTang QilongTang added this to the 3.5 milestone Dec 4, 2024
@QilongTang QilongTang requested a review from sm6srw December 5, 2024 02:36
@QilongTang
Copy link
Contributor

LGTM, Send this to @sm6srw to also review.
Also, @RobertGlobant20 would you take a look at the self serve job? I suspect there might be some regressions related to the sanitization process

@github-actions
Copy link

github-actions bot commented Dec 5, 2024

UI Smoke Tests

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

Due that FeatureFlags is using CLIWrapper as a Base Class my changes related to decoding base64 data were crashing the FeatureFlags.exe process and several tests were failing.
Then I've added a extra default parameter in the GetData method so it will know if the data needs to be decoded or not.
@QilongTang QilongTang merged commit f12fae8 into DynamoDS:master Dec 5, 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.

2 participants