LucasEby opened a new pull request, #24807:
URL: https://github.com/apache/pulsar/pull/24807
<!--
### Contribution Checklist
- PR title format should be *[type][component] summary*. For details, see
*[Guideline - Pulsar PR Naming
Convention](https://pulsar.apache.org/contribute/develop-semantic-title/)*.
- Fill out the template below to describe the changes contributed by the
pull request. That will give reviewers the context they need to do the review.
- Each pull request should address only one issue, not mix up code from
multiple issues.
- Each commit in the pull request has a meaningful commit message
- Once all items of the checklist are addressed, remove the above text and
this checklist, leaving only the filled out template below.
-->
<!-- Either this PR fixes an issue, -->
Fixes #24806
<!-- Details of when a PIP is required and how the PIP process work, please
see: https://github.com/apache/pulsar/blob/master/pip/README.md -->
### Motivation
<!-- Explain here the context, and why you're making that change. What is
the problem you're trying to solve. -->
In ProtobufSchemaTest.testParsingInfoProperty, the json's contents and the
__PARSING_INFO__ field's contents do not have a deterministic order but the
hardcoded string assertion assumes a deterministic order.
Serializing a map to a JSON with new
ObjectMapper().writeValueAsString(schema.getSchemaInfo().getProperties()) can
change the order of the keys since attribute order is not guaranteed in JSON.
Additionally the inner JSON string order in __PARSING_INFO__ can vary for the
same reason. The ordering in both cases can change due to different
environments producing the contents in different orders despite the logical
contents being the same. Since the test compares the raw strings/trees "as-is",
harmless re-ordering could flip the test from pass to fail despite the data
being semantically the same.
### Modifications
<!-- Describe the modifications you've done. -->
We no longer compare raw strings/trees "as-is". Instead, we compare a json
structure that we derive. When we normalize the properties, we copy every
key/value from the properties map so nothing at the top level is ignored. For
\_\_PARSING\_INFO\_\_ only we parse every string value into an ArrayNode, sort
the array deterministically by (number, name) to remove element-order
nondeterminism, and then store it back as a JSON array (instead of a string).
For all other keys we keep their string values as-is.
When performing the Assert.assertEquals assertion, it is performed with the
JsonNode equals method which is an important subtlety. This is because it
compares field names and values not memory addresses. Additionally field order
is not considered. This is the reason why we treated the \_\_PARSING\_INFO\_\_
field differently before because this assertion is sensitive to the order of
the contents of \_\_PARSING\_INFO\_\_ (it does an as-is comparison instead of
allowing different orders).
This change keeps the spirit of the original test while eliminating failures
caused solely by allowed (but previously unexpected) reordering.
### Verifying this change
- [ ] Make sure that the change passes the CI checks.
This change is already covered by existing tests, such as
`org.apache.pulsar.client.impl.schema.ProtobufSchemaTest#testParsingInfoProperty`.
### Does this pull request potentially affect one of the following parts:
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
*If the box was checked, please highlight the changes*
- [ ] Dependencies (add or upgrade a dependency)
- [ ] The public API
- [ ] The schema
- [ ] The default values of configurations
- [ ] The threading model
- [ ] The binary protocol
- [ ] The REST endpoints
- [ ] The admin CLI options
- [ ] The metrics
- [ ] Anything that affects deployment
### Documentation
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
- [ ] `doc` <!-- Your PR contains doc changes. -->
- [ ] `doc-required` <!-- Your PR changes impact docs and you will update
later -->
- [x] `doc-not-needed` <!-- Your PR changes do not impact docs -->
- [ ] `doc-complete` <!-- Docs have been already added -->
### Matching PR in forked repository
PR in forked repository: https://github.com/LucasEby/pulsar/pull/2
<!--
After opening this PR, the build in apache/pulsar will fail and instructions
will
be provided for opening a PR in the PR author's forked repository.
apache/pulsar pull requests should be first tested in your own fork since
the
apache/pulsar CI based on GitHub Actions has constrained resources and quota.
GitHub Actions provides separate quota for pull requests that are executed
in
a forked repository.
The tests will be run in the forked repository until all PR review comments
have
been handled, the tests pass and the PR is approved by a reviewer.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
