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

encoding/xml: allow mismatched XMLName / field metadata tag names #48450

Closed
wants to merge 1 commit into from
Closed

encoding/xml: allow mismatched XMLName / field metadata tag names #48450

wants to merge 1 commit into from

Conversation

ieure
Copy link

@ieure ieure commented Sep 17, 2021

Currently, if you have nested structs, where the inner struct’s
XMLName doesn’t match the outer struct’s field name metadata, such as:

type InnerStruct struct {
	XMLName Name   `xml:"innerStruct"`
	Name	string `xml:"name"`
}

type Outer struct {
	XMLName Name		 `xml:"outer"`
	Inner	*InnerStruct `xml:"inner"`
}

Then decoding XML produces an error:

xml: name "inner" in tag of xml.Outer.Inner conflicts with name "innerStruct" in *xml.InnerStruct.XMLName

This causes issues when interacting with SOAP web services, whose
WSDLs are expressed with XSD. XSD allows defining reusable types;
each of those types has a unique name. That name MAY be the name of
the tag containing the struct’s data, but isn’t ALWAYS. An
xsd:element may specify a different tag name to contain an XSD type’s
values. An illustration of a real-world case where this happens is
hooklift/gowsdl#219.

This PR uses the big hammer of removing the tests and errors which
cause the issue. I’m reasonably certain that the structFieldInfo()
changes are fine, but I feel less good about Decoder.unmarshal().
Ideally, that code would look at the field metadata of the containing
struct, then the XMLName of the destination struct. I’m not familiar
with this code, but it looks like the parent element isn’t accessible
at the time when this check would need to happen, so I opted to remove
it instead.

fixes hooklift/gowsdl#219

Currently, if you have nested structs, where the inner struct’s
XMLName doesn’t match the outer struct’s field name metadata, such as:

	type InnerStruct struct {
		XMLName Name   `xml:"innerStruct"`
		Name	string `xml:"name"`
	}

	type Outer struct {
		XMLName Name		 `xml:"outer"`
		Inner	*InnerStruct `xml:"inner"`
	}

Then decoding XML produces an error:

    xml: name "inner" in tag of xml.Outer.Inner conflicts with name "innerStruct" in *xml.InnerStruct.XMLName

This causes issues when interacting with SOAP web services, whose
WSDLs are expressed with XSD.  XSD allows defining reusable types;
each of those types has a unique name.  That name MAY be the name of
the tag containing the struct’s data, but isn’t ALWAYS.  An
xsd:element may specify a different tag name to contain an XSD type’s
values.  An illustration of a real-world case where this happens is
hooklift/gowsdl#219.

This PR uses the big hammer of removing the tests and errors which
cause the issue.  I’m reasonably certain that the structFieldInfo()
changes are fine, but I feel less good about Decoder.unmarshal().
Ideally, that code would look at the field metadata of the containing
struct, then the XMLName of the destination struct.  I’m not familiar
with this code, but it looks like the parent element isn’t accessible
at the time when this check would need to happen, so I opted to remove
it instead.

fixes hooklift/gowsdl#219
@google-cla
Copy link

google-cla bot commented Sep 17, 2021

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@google-cla google-cla bot added the cla: no Used by googlebot to label PRs as having an invalid CLA. The text of this label should not change. label Sep 17, 2021
@ieure
Copy link
Author

ieure commented Sep 30, 2021

@googlebot I signed it!

@google-cla google-cla bot added cla: yes Used by googlebot to label PRs as having a valid CLA. The text of this label should not change. and removed cla: no Used by googlebot to label PRs as having an invalid CLA. The text of this label should not change. labels Sep 30, 2021
@gopherbot
Copy link
Contributor

This PR (HEAD: 22d97c4) has been imported to Gerrit for code review.

Please visit https://go-review.googlesource.com/c/go/+/353394 to see it.

Tip: You can toggle comments from me using the comments slash command (e.g. /comments off)
See the Wiki page for more info

@gopherbot
Copy link
Contributor

Message from Go Bot:

Patch Set 1:

Congratulations on opening your first change. Thank you for your contribution!

Next steps:
A maintainer will review your change and provide feedback. See
https://golang.org/doc/contribute.html#review for more info and tips to get your
patch through code review.

Most changes in the Go project go through a few rounds of revision. This can be
surprising to people new to the project. The careful, iterative review process
is our way of helping mentor contributors and ensuring that their contributions
have a lasting impact.

During May-July and Nov-Jan the Go project is in a code freeze, during which
little code gets reviewed or merged. If a reviewer responds with a comment like
R=go1.11 or adds a tag like "wait-release", it means that this CL will be
reviewed as part of the next development cycle. See https://golang.org/s/release
for more details.


Please don’t reply on this GitHub thread. Visit golang.org/cl/353394.
After addressing review feedback, remember to publish your drafts!

@ieure
Copy link
Author

ieure commented Jul 27, 2022

welp

@ieure ieure closed this Jul 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Used by googlebot to label PRs as having a valid CLA. The text of this label should not change.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

encoding/xml error when field metadata doesn't match XMLName
2 participants