LucasEby opened a new pull request, #24805:
URL: https://github.com/apache/pulsar/pull/24805
<!--
### 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 #24804
<!-- 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 ProtobufNativeSchemaTest.testSchema, the json's contents and the
FileDescriptorSet field's contents do not have a deterministic order but the
hardcoded string assertion assumes a deterministic order. The json serializer
did not guarantee attribute order and inside FileDescriptorSet the contents can
also be in different orders due to different generation paths or environments
producing the contents in different orders despite the logical content being
the same. Since the original test compared the raw strings/trees "as-is",
harmless re-ordering could flip the test from pass to fail without any real
schema change.
### Modifications
<!-- Describe the modifications you've done. -->
We no longer compare raw strings/trees "as-is". Instead we decode the
FileDescriptorSet and compare it semantically be converting both to JSON and
asserting equality using a mode that doesn't require array order to match but
forbids extra fields. Next, we remove FileDescriptorSet from the outer JSON and
compare the remainder with an order-agnostic (for keys) but non-extensible JSON
assertion. We implemented this two stage approach because JSON assertion does
not re-order the inner contents of the json values even if they can be
re-ordered.
This change keeps the spirit of the original test while eliminating failures
caused solely by allowed 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#testSchema`.
### 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/1
<!--
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]
