Deprecate one-way boolean settings on builders #1750
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Motivation: Some builder APIs allow disabling some feature without the option to enable it. To keep the builders' APIs consistent all boolean settings should accept a flag that can trigger the feature to on or off configuration. This change deprecates the undesired methods and adds methods that accept a boolean. Modifications: - Deprecated `GrpcClientBuilder.disableHostHeaderFallback` in favor of `GrpcClientBuilder.hostHeaderFallback(boolean)`, - Deprecated `GrpcClientBuilder.disableDrainingRequestPayloadBody` in favor of `GrpcClientBuilder.drainRequestPayloadBody(boolean)`, - Deprecated `HttpReporter.Builder.disableSpanBatching` in favor of `HttpReporter.Builder.spansBatchingEnabled(boolean)`, - Deprecated `HttpServerBuilder.disableDrainingRequestPayloadBody` in favor of `HttpServerBuilder.drainRequestPayloadBody(boolean)`, - Deprecated `SingleAddressHttpClientBuilder.disableHostHeaderFallback` in favor of `SingleAddressHttpClientBuilder.hostHeaderFallback(boolean)`. Result: More consistent builders' APIs.
Scottmitch
reviewed
Aug 25, 2021
...blisher/src/main/java/io/servicetalk/opentracing/zipkin/publisher/reporter/HttpReporter.java
Outdated
Show resolved
Hide resolved
Scottmitch
approved these changes
Sep 3, 2021
servicetalk-grpc-api/src/main/java/io/servicetalk/grpc/api/GrpcClientBuilder.java
Outdated
Show resolved
Hide resolved
idelpivnitskiy
requested changes
Sep 3, 2021
servicetalk-grpc-api/src/main/java/io/servicetalk/grpc/api/GrpcClientBuilder.java
Outdated
Show resolved
Hide resolved
servicetalk-grpc-api/src/main/java/io/servicetalk/grpc/api/GrpcClientBuilder.java
Outdated
Show resolved
Hide resolved
idelpivnitskiy
approved these changes
Sep 9, 2021
| */ | ||
| public GrpcClientBuilder<U, R> hostHeaderFallback(boolean enable) { | ||
| throw new UnsupportedOperationException("Setting automatic host header fallback using this method" + | ||
| " is not yet supported."); |
There was a problem hiding this comment.
In the other PR @bondolo used getClass().getSimpleName(): https://github.com/apple/servicetalk/pull/1781/files#diff-fa20d1d978b59de34bb9649cc6cc21ba5321886ccaa29636bbc285eea14eb07aR332
Consider using getClass().getName() moving forward. It will help users understand who they should contact if this method is not implemented.
...ttp-netty/src/main/java/io/servicetalk/http/netty/DefaultSingleAddressHttpClientBuilder.java
Outdated
Show resolved
Hide resolved
chemicL
force-pushed
the
builders-api-consistency
branch
from
527af0a to
4598764
Compare
chemicL
pushed a commit
to chemicL/servicetalk
that referenced
this pull request
Sep 10, 2021
Deprecate one-way boolean settings on builders Motivation: Some builder APIs allow disabling some feature without the option to enable it. To keep the builders' APIs consistent all boolean settings should accept a flag that can trigger the feature to on or off configuration. This change deprecates the undesired methods and adds methods that accept a boolean. Modifications: - Deprecated `GrpcClientBuilder.disableHostHeaderFallback` in favor of `GrpcClientBuilder.hostHeaderFallback(boolean)`, - Deprecated `GrpcClientBuilder.disableDrainingRequestPayloadBody` in favor of `GrpcClientBuilder.drainRequestPayloadBody(boolean)`, - Deprecated `HttpReporter.Builder.disableSpanBatching` in favor of `HttpReporter.Builder.spansBatchingEnabled(boolean)`, - Deprecated `HttpServerBuilder.disableDrainingRequestPayloadBody` in favor of `HttpServerBuilder.drainRequestPayloadBody(boolean)`, - Deprecated `SingleAddressHttpClientBuilder.disableHostHeaderFallback` in favor of `SingleAddressHttpClientBuilder.hostHeaderFallback(boolean)`. Result: More consistent builders' APIs.
chemicL
pushed a commit
that referenced
this pull request
Sep 13, 2021
Deprecate one-way boolean settings on builders Motivation: Some builder APIs allow disabling some feature without the option to enable it. To keep the builders' APIs consistent all boolean settings should accept a flag that can trigger the feature to on or off configuration. This change deprecates the undesired methods and adds methods that accept a boolean. Modifications: - Deprecated `GrpcClientBuilder.disableHostHeaderFallback` in favor of `GrpcClientBuilder.hostHeaderFallback(boolean)`, - Deprecated `GrpcClientBuilder.disableDrainingRequestPayloadBody` in favor of `GrpcClientBuilder.drainRequestPayloadBody(boolean)`, - Deprecated `HttpReporter.Builder.disableSpanBatching` in favor of `HttpReporter.Builder.spansBatchingEnabled(boolean)`, - Deprecated `HttpServerBuilder.disableDrainingRequestPayloadBody` in favor of `HttpServerBuilder.drainRequestPayloadBody(boolean)`, - Deprecated `SingleAddressHttpClientBuilder.disableHostHeaderFallback` in favor of `SingleAddressHttpClientBuilder.hostHeaderFallback(boolean)`. Result: More consistent builders' APIs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
Some builder APIs allow disabling some feature without the option to
enable it. To keep the builders' APIs consistent all boolean settings
should accept a flag that can trigger the feature to on or off
configuration. This change deprecates the undesired methods and adds
methods that accept a boolean.
Modifications:
GrpcClientBuilder.disableHostHeaderFallbackin favor ofGrpcClientBuilder.hostHeaderFallback(boolean),GrpcClientBuilder.disableDrainingRequestPayloadBodyinfavor of
GrpcClientBuilder.drainRequestPayloadBody(boolean),HttpReporter.Builder.disableSpanBatchingin favor ofHttpReporter.Builder.spansBatchingEnabled(boolean),HttpServerBuilder.disableDrainingRequestPayloadBodyinfavor of
HttpServerBuilder.drainRequestPayloadBody(boolean),SingleAddressHttpClientBuilder.disableHostHeaderFallbackin favor of
SingleAddressHttpClientBuilder.hostHeaderFallback(boolean).Result:
More consistent builders' APIs.