Updated README and MIGRATION files

- Documented removal of the opentracing-flowid-starter requirement - Removed everything related to AsynRestTemplate and friends - Updated the dependencies to the correct versions - Link to different sections of the migration guide for different versions - Removed explicitly mentioning the Java version requirement when Riptide :: Core is a dependency - Fixed link to the Riptide issue tracker - Fixed spelling and grammatical mistakes
zalando · Jun 26, 2023 · 597e27e · 597e27e
1 parent c884e4e
commit 597e27e
Show file tree

Hide file tree

Showing 18 changed files with 27 additions and 75 deletions.
diff --git a/MIGRATION.md b/MIGRATION.md
@@ -2,8 +2,8 @@
 
 ## Before you start
 
-**Riptide 4** requires java 17 or or up.
-**Riptide 4** requires Spring 6 or or up.
+**Riptide 4** requires Java 17 or up.
+**Riptide 4** requires Spring 6 or up.
 
 ## Failsafe
 
@@ -40,6 +40,10 @@ The `SpanDecorators` obtained by `ServiceLoaderSpanDecorator`
 (via the [`ServiceLoader`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ServiceLoader.html) facility) 
 are loaded eagerly and only once.
 
+## OpenTracing FlowId Starter
+
+As the project is in maintenance mode and no changes are planned anymore including support for newer Spring versions,
+it was decided to include an adapted copy into Riptide itself, so the dependency is not needed anymore.
 
 # Riptide 3.0 Migration Guide
 

diff --git a/README.md b/README.md
@@ -20,7 +20,9 @@ protocol and Java. Riptide allows users to leverage the power of HTTP with its u
 - **Status**:  Actively maintained and used in production.
 - Riptide is unique in the way that it doesn't abstract HTTP away, but rather embraces it!
 
-:rotating_light: **Upgrading from 2.x to 3.x?** Please refer to the [Migration Guide](MIGRATION.md).
+:rotating_light: If you want to upgrade from an older version to the latest one, consult the following migration guides:
+ - **Upgrading from 3.x to 4.x?** Please refer to the [Migration Guide](MIGRATION.md#riptide-40-migration-guide).
+ - **Upgrading from 2.x to 3.x?** Please refer to the [Migration Guide](MIGRATION.md#riptide-30-migration-guide).
 
 ## Example
 
@@ -71,8 +73,8 @@ Go checkout the [concept document](docs/concepts.md) for more details.
 
 ## Dependencies
 
-- Spring 4.1 or higher
-  - :warning: Spring Boot integration requires Spring 5
+- Java 17
+- Spring 6
 
 ## Installation
 
@@ -224,32 +226,21 @@ You can read more about *scale-first* here:
 In order to configure the thread pool correctly, please refer to
 [How to set an ideal thread pool size](https://jobs.zalando.com/tech/blog/how-to-set-an-ideal-thread-pool-size).
 
-### Non-blocking IO
+### Non-blocking Ihttps://docs.oracle.com/javase/8/docs/api/java/net/HttpURLConnection.htmlO
 
-Riptide supports two kinds of request factories:
-
-**[`ClientHttpRequestFactory`](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/client/ClientHttpRequestFactory.html)**
-
-The following implementations offer blocking IO:
+:rotating_light: While the previous versions of Riptide supported both, blocking and non-blocking request factories,
+due to the removal of `AsyncClientHttpRequestFactory` in Spring 6, Riptide 4 only supports blocking request factories:
 
 - [`ApacheClientHttpRequestFactory`](riptide-httpclient), using the [Apache HTTP Client](https://hc.apache.org/httpcomponents-client-ga/)
-- ~[`HttpComponentsClientHttpRequestFactory`](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/client/HttpComponentsClientHttpRequestFactory.html)~, please use the none above
-- [`SimpleClientHttpRequestFactory`](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/client/SimpleClientHttpRequestFactory.html), using [`HttpURLConnection`](https://docs.oracle.com/javase/8/docs/api/java/net/HttpURLConnection.html)
-
-**[`AsyncClientHttpRequestFactory`](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/client/AsyncClientHttpRequestFactory.html)**
-
-The following implementations offer non-blocking IO:
-
+- ~[`HttpComponentsClientHttpRequestFactory`](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/client/HttpComponentsClientHttpRequestFactory.html)~, please use the one above
+- [`SimpleClientHttpRequestFactory`](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/client/SimpleClientHttpRequestFactory.html), using [`HttpURLConnection`](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/HttpURLConnection.html)
 - [`OkHttp3ClientHttpRequestFactory`](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/client/OkHttp3ClientHttpRequestFactory.html), using [OkHttp](https://square.github.io/okhttp/)
-- [`Netty4ClientHttpRequestFactory`](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/client/Netty4ClientHttpRequestFactory.html), using [Netty](https://netty.io/)
-- [`HttpComponentsAsyncClientHttpRequestFactory`](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/client/HttpComponentsAsyncClientHttpRequestFactory.html), using [Apache HTTP Async Client](https://hc.apache.org/httpcomponents-asyncclient-4.1.x/index.html)
 
-Non-blocking IO is asynchronous by nature. In order to provide asynchrony for blocking IO you need to register an executor. Not passing an executor will make all network communication synchronous, i.e. all futures returned by Riptide will already be completed.
+In order to provide asynchrony for blocking IO you need to register an executor. Not passing an executor will make all network communication synchronous, i.e. all futures returned by Riptide will already be completed.
 
-|                 | Synchronous                | Asynchronous                            |
-|-----------------|----------------------------|-----------------------------------------|
-| Blocking IO     | `ClientHttpRequestFactory` | `Executor` + `ClientHttpRequestFactory` |
-| Non-blocking IO | n/a                        | `AsyncClientHttpRequestFactory`         |
+| Synchronous                | Asynchronous                            |
+|----------------------------|-----------------------------------------|
+| `ClientHttpRequestFactory` | `Executor` + `ClientHttpRequestFactory` |
 
 ## Usage
 
@@ -355,7 +346,7 @@ Please consult the [Plugin documentation](riptide-core/src/main/java/org/zalando
 
 ### Testing
 
-Riptide is built on the same foundation as Spring's `RestTemplate` and `AsyncRestTemplate`. That allows us, with a small
+Riptide is built on the same foundation as Spring's `RestTemplate`. That allows us, with a small
 trick, to use the same testing facilities, the [`MockRestServiceServer`](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/test/web/client/MockRestServiceServer.html):
 
 ```java
@@ -376,7 +367,7 @@ See [here](riptide-spring-boot-starter#testing).
 
 ## Getting help
 
-If you have questions, concerns, bug reports, etc., please file an issue in this repository's [Issue Tracker](../../../issues).
+If you have questions, concerns, bug reports, etc., please file an issue in this repository's [Issue Tracker](issues).
 
 ## Getting involved/Contributing
 

diff --git a/riptide-auth/README.md b/riptide-auth/README.md
@@ -34,7 +34,6 @@ Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
 
 ## Dependencies
 
-- Java 8
 - Riptide: Core
 
 ## Installation

diff --git a/riptide-capture/README.md b/riptide-capture/README.md
@@ -26,7 +26,6 @@ Order order = http.get("/sales-orders/{id}", id)
 
 ## Dependencies
 
-- Java 8
 - Riptide: Core
 
 ## Installation

diff --git a/riptide-chaos/README.md b/riptide-chaos/README.md
@@ -28,7 +28,6 @@ Http.builder()
 
 ## Dependencies
 
-- Java 8
 - Riptide: Core
 
 ## Installation

diff --git a/riptide-compatibility/README.md b/riptide-compatibility/README.md
@@ -17,11 +17,10 @@ User user = http.getForObject("/user/{id}", User.class, 1);
 
 - Compatibility adapters for
   - [RestOperations (**RestTemplate** API)](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/client/RestOperations.html)
-  - [AsyncRestOperations (**AsyncRestTemplate** API)](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/client/AsyncRestOperations.html)
 
 ## Dependencies
 
-- Java 8
+- Java 17
 - Riptide: Core
 - Riptide: Capture
 - Riptide: Problem
@@ -46,12 +45,6 @@ RestOperations http = new HttpOperations(Http.builder()
         .build());
 ```
 
-```java
-AsyncRestOperations http = new AsyncHttpOperations(Http.builder()
-        // ...
-        .build());
-```
-
 ### Default Routing Tree
 
 The default routing tree can be overridden:
@@ -88,8 +81,7 @@ ResponseEntity<User> response = http.getForEntity("/users/{id}", User.class, 1);
 ```
 
 Any operation within [RestOperations](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/client/RestOperations.html)
-and [AsyncRestOperations](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/client/AsyncRestOperations.html)
-are supported.
+is supported.
 
 ## Getting Help
 

diff --git a/riptide-compression/README.md b/riptide-compression/README.md
@@ -14,7 +14,6 @@
 
 ## Dependencies
 
-- Java 8
 - Riptide: Core
 
 ## Installation

diff --git a/riptide-concurrent/README.md b/riptide-concurrent/README.md
@@ -29,7 +29,7 @@ var pool = ThreadPoolExecutors.builder()
 
 ## Dependencies
 
-- Java 8
+- Java 17
 
 ## Installation
 

diff --git a/riptide-failsafe/README.md b/riptide-failsafe/README.md
@@ -24,7 +24,6 @@ Http.builder().requestFactory(new HttpComponentsClientHttpRequestFactory())
 
 ## Dependencies
 
-- Java 8
 - Riptide Core
 - Failsafe
 

diff --git a/riptide-faults/README.md b/riptide-faults/README.md
@@ -17,7 +17,6 @@
 
 ## Dependencies
 
-- Java 8
 - Riptide: Core
 
 ## Installation

diff --git a/riptide-httpclient/README.md b/riptide-httpclient/README.md
@@ -25,7 +25,7 @@ final Http http = Http.builder()
 
 ## Dependencies
 
-- Java 8
+- Java 17
 
 ## Installation
 
@@ -74,16 +74,6 @@ new ApacheClientHttpRequestFactory(client, Mode.BUFFERING)
   </dd>
 </dl>
 
-The `RestAsyncClientHttpRequestFactory` implements `ClientHttpRequestFactory` **as well as** 
-`AsyncClientHttpRequestFactory` and can therefore be used with both: `RestTemplate` and `AsyncRestTemplate`.
-
-```java
-RestAsyncClientHttpRequestFactory factory = ...;
-
-RestTemplate sync = new RestTemplate(factory);
-AsyncRestTemplate async = new AsyncRestTemplate(factory);
-```
-
 ## Getting Help
 
 If you have questions, concerns, bug reports, etc., please file an issue in this repository's [Issue Tracker](../../../../issues).

diff --git a/riptide-logbook/README.md b/riptide-logbook/README.md
@@ -21,7 +21,6 @@ Http.builder()
 
 ## Dependencies
 
-- Java 8
 - Riptide: Core
 
 ## Installation

diff --git a/riptide-micrometer/README.md b/riptide-micrometer/README.md
@@ -21,7 +21,6 @@ Http.builder()
 
 ## Dependencies
 
-- Java 8
 - Riptide Core
 - [Micrometer](https://micrometer.io/)
 

diff --git a/riptide-opentelemetry/README.md b/riptide-opentelemetry/README.md
@@ -24,7 +24,6 @@ Http.builder()
 
 ## Dependencies
 
-- Java 8
 - Riptide Core
 - [OpenTelemetry Java API](https://opentelemetry.io/docs/instrumentation/java/)
 - [Riptide: Failsafe](../riptide-failsafe) (optional)

diff --git a/riptide-opentracing/README.md b/riptide-opentracing/README.md
@@ -25,7 +25,6 @@ Http.builder()
 
 ## Dependencies
 
-- Java 8
 - Riptide Core
 - [OpenTracing Java API](https://opentracing.io/guides/java/)
 - [Riptide: Failsafe](../riptide-failsafe) (optional)

diff --git a/riptide-problem/README.md b/riptide-problem/README.md
@@ -24,7 +24,6 @@ http.post("/").dispatch(series(),
 
 ## Dependencies
 
-- Java 8
 - Riptide: Core
 - Problem
 

diff --git a/riptide-soap/README.md b/riptide-soap/README.md
@@ -21,7 +21,6 @@ http.post()
 
 ## Dependencies
 
-- Java 8
 - JAXB
 - Riptide Core
 

diff --git a/riptide-spring-boot-autoconfigure/README.md b/riptide-spring-boot-autoconfigure/README.md
@@ -70,8 +70,7 @@ private Http example;
 
 ## Dependencies
 
-- Java 8
-- Spring Boot 2
+- Spring Boot 3
 - Riptide
   - Core
   - (Apache) HTTP Client
@@ -224,18 +223,6 @@ Required when `tracing` is enabled.
 </dependency>
 ```
 
-#### X-Flow-ID
-
-Required when `propagate-flow-id` is enabled.
-
-```xml
-<dependency>
-    <groupId>org.zalando</groupId>
-    <artifactId>opentracing-flowid-starter</artifactId>
-    <version>${opentracing-toolbox.version}</version>
-</dependency>
-```
-
 #### OpenTelemetry
 
 Required when `telemetry` is enabled.