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-2655]: Fix crash for badly formatted xml docs on ZT node #10674

Merged
merged 4 commits into from
May 21, 2020

Conversation

aparajit-pratap
Copy link
Contributor

@aparajit-pratap aparajit-pratap commented May 19, 2020

Purpose

DYN-2655
Take the following example of XML documentation on a zero touch method. Strictly speaking it isn't a badly formatted XML as there is no XML exception that is thrown, however it does result in a different unhandled exception from our own code that parses the XML and converts it into node tooltips. Notice that here the <returns> tag following the <params> tag was missing that led to the exception and consequently the crash.

/// <summary> 
/// Create a T-Spline Surface from the string in T-Spline Mesh format. 
/// </summary> 
/// <param name="content">String representation of T-Spline Mesh file</param> 
/// <param name="inSmoothMode">Show T-Spline Surface in box or smooth visualization</param> 
/// Newly loaded T-Spline surface in list 
/// <search>tspline,import,serialize</search> 
[AllowRankReduction] 
public static TSplineSurface[] DeserializeFromTSM(string content, bool inSmoothMode = false) {...}

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.

Reviewers

@DynamoDS/dynamo

@aparajit-pratap aparajit-pratap added the PTAL Please Take A Look 👀 label May 20, 2020
@QilongTang
Copy link
Contributor

LGTM

@QilongTang QilongTang added LGTM Looks good to me and removed PTAL Please Take A Look 👀 labels May 21, 2020
@aparajit-pratap aparajit-pratap merged commit e389108 into DynamoDS:master May 21, 2020
@aparajit-pratap aparajit-pratap deleted the fixXml branch May 21, 2020 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
LGTM Looks good to me
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants