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.

Sign up for GitHub

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

Jump to bottom

HPCC-29963 Correct XSD type conversion for TpQueryType in WsTopology Service #17612

Merged
merged 1 commit into from
Jul 27, 2023
Merged

HPCC-29963 Correct XSD type conversion for TpQueryType in WsTopology Service #17612

merged 1 commit into from
Jul 27, 2023

Conversation

kenrowland
Copy link
Contributor

@kenrowland kenrowland commented Jul 21, 2023 •
edited
Loading

Added exception for type TpQueryType in XSLT to ensure generated XSD has proper type of xsd:string

Signed-Off-By: Kenneth Rowland [email protected]

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

@github-actions
Copy link

https://track.hpccsystems.com/browse/HPCC-29963
Jira updated

afishbeck
afishbeck reviewed Jul 21, 2023
View reviewed changes
esp/xslt/esp_service_xml2xsd.xslt Outdated
@@ -153,6 +153,8 @@
</xsl:when>
<xsl:when test="@type='int64'">xsd:<xsl:value-of select="'long'"/>
</xsl:when>
<xsl:when test="@type='TpQueryType'">xsd:<xsl:value-of select="'string'"/>
Copy link
Member

@afishbeck afishbeck Jul 21, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

@kenrowland This is actually covering up a bug in ws_topology.ecm. TpQueryType was meant to be defined as an enumerated string. But it was incorrectly defined and incorrectly used.

You could change the definition of TpQueryType from ESPstruct to ESPenum and then make use of it, BUT that may cause backward compatibility issues.
The alternative for maximum backward compatibility would be just to change it to a string.

@wangkx when you were changing strings to enums how did we handle backward compatibility?

Anyway I wouldn't make this change, one way or the other I would fix the bad item in the ecm.

Copy link
Member

Choose a reason for hiding this comment

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

In ecm file, add a new variable and 'depr_ver' the old one. If the variables are in a request, make sure that the new variable is read first. If not found, read the old one for backward compatibility.

Copy link
Member

Choose a reason for hiding this comment

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

@kenrowland for now I would just declare it as a string but add a comment about the two expected values (from the struct definition). It's no worse or less informative than what is there now.

afishbeck
afishbeck requested changes Jul 21, 2023
View reviewed changes
Copy link
Member

@afishbeck afishbeck left a comment

Choose a reason for hiding this comment

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

Shouldn't hard code this change, rather fix the errors in the ecm.

@afishbeck
Copy link
Member

@kenrowland the PR and commit titles and comments are no longer correct.

@GordonSmith
Copy link
Member

@kenrowland can you squash and double check the commit message?

@kenrowland
HPCC-29963 Incorrect XSD type output for TpQueryType in WsTopology se…
95e4c94 
…rvice

Changed TpQueryType to string to produce correct type in XSD

Signed-Off-By: Kenneth Rowland [email protected]
@kenrowland
Copy link
Contributor Author

@GordonSmith Please merge

@GordonSmith GordonSmith merged commit d2f29c6 into hpcc-systems:master Jul 27, 2023
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wangkx wangkx wangkx approved these changes

@afishbeck afishbeck afishbeck approved these changes

@asselitx asselitx asselitx approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@kenrowland @afishbeck @GordonSmith @wangkx @asselitx