Merge branch 'main' into OmarAlJarrah/add-sdk-core-performance-tests

ExpediaGroup · Nov 27, 2024 · 5bc7f02 · 5bc7f02
2 parents 4dfe4d2 + b36b9e6
commit 5bc7f02
Show file tree

Hide file tree

Showing 31 changed files with 488 additions and 266 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,137 @@
-# Expedia Group<sup>TM</sup> SDK for Java
+# Expedia Group Java SDK Foundations
 
-The Expedia Group SDK for Java allows Expedia Group partners to easily build Java applications that leverage the Expedia Group<sup>TM</sup> platform.
+The **Expedia Group Java SDK Foundations** provides the core components and tools for building and maintaining our SDK libraries.
+These foundations enable developers to create consistent, high-quality Java SDKs that interact with the Expedia Group platform.
+
+---
+
+## Product SDKs
+
+The following SDKs are built using the Expedia Group Java SDK Foundations, and are available for public use:
+
+| SDK                                                         | Maven                                                                                                                                                                                                                                                                       | Documentation                                                                                  |
+|-------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
+| [Rapid SDK](https://github.com/ExpediaGroup/rapid-java-sdk) | [![Maven Central Version](https://img.shields.io/maven-central/v/com.expediagroup/rapid-sdk?style=for-the-badge&logo=expedia&logoColor=%23fddb32&label=Rapid%20SDK&labelColor=%23181e3b&color=%23fddb32)](https://central.sonatype.com/artifact/com.expediagroup/rapid-sdk) | [Rapid SDK on Developer Hub](https://developers.expediagroup.com/docs/products/rapid/sdk/java) |
+| [EWS XAP SDK](https://github.com/ExpediaGroup/xap-java-sdk) | [![Maven Central Version](https://img.shields.io/maven-central/v/com.expediagroup/xap-sdk?style=for-the-badge&logo=expedia&logoColor=%23fddb32&label=Xap%20SDK&labelColor=%23181e3b&color=%23fddb32)](https://central.sonatype.com/artifact/com.expediagroup/xap-sdk)     | [Developer Hub for XAP](https://developers.expediagroup.com/xap/sdk)                           |
+
+
+More SDKs will be added to this list as they are developed and released.
+
+---
+
+## Components
+
+The foundations includes the following components:
+
+- **SDK Core**: Core libraries and utilities shared across all Java SDKs
+- **SDK Generators**: Tools for generating SDK code based on OpenAPI specifications (OAS3).
+- **SDK Tests**: Shared testing frameworks and utilities for validating SDK functionality.
+- **GitHub Actions**: Reusable workflows for SDK repositories to automate common tasks like building, testing, releasing, and publishing SDKs.
+
+---
+
+## Getting Started
+
+### Prerequisites
+
+To generate a new SDK, ensure you have the following:
+
+1. **OpenAPI Specification** for the API you wish to generate an SDK for.
+2. Use the [Spec Transformer](https://github.com/ExpediaGroup/spec-transformer) if transformation is required. Learn more about
+   the [Spec Transformation process](https://github.com/ExpediaGroup/spec-transformer).
+3. **Java Development Kit (JDK)** version 8 or later.
+4. **Maven** version 3.8.0 or later. It's recommended to use the embedded Maven wrapper located in [/.mvn/wrapper](.mvn/wrapper).
+
+### Generating SDKs
+
+Follow these steps to generate an SDK:
+
+1. Clone this repository:
+   ```bash
+   git clone https://github.com/ExpediaGroup/expediagroup-java-sdk.git
+   cd expediagroup-java-sdk
+   ```
+
+2. Build the SDK Generator:
+   ```bash
+   cd generator/openapi
+   mvn clean install
+   ```
+
+3. Run the SDK Generator:
+   ```bash
+   ../../mvnw exec:java
+   ```
+   This will generate a sample SDK in the `target/sdk` directory.
+
+4. Build the generated SDK:
+   ```bash
+   cd target/sdk
+   ../../../mvnw clean install
+   ```
+
+Refer to the [SDK Generator documentation](generator/README.md) for more details on how to generate an SDK, customize the generation process, and generate SDK documentation.
+
+---
+
+### Using Generated SDKs
+
+The generated SDKs will be placed in the specified output directory. You can integrate them into your Java application by adding the SDK as a dependency.
+
+#### Maven Dependency
+
+Add the following to your `pom.xml`:
+
+```xml
+
+<dependency>
+    <groupId>com.expediagroup</groupId>
+    <artifactId>your-sdk-name</artifactId>
+    <version>x.y.z</version>
+</dependency>
+```
+
+#### Gradle Dependency
+
+Add the following to your `build.gradle` file:
+
+```groovy
+implementation 'com.expediagroup:your-sdk-name:x.y.z'
+```
+
+Replace `your-sdk-name` and `x.y.z` with the appropriate SDK name and version.
+
+--- 
+
+### Publishing SDKs
+
+Leverage the provided self-serve [GitHub Actions workflows](.github/workflows) to automate the process of generating, releasing, and publishing SDKs to:
+
+- A GitHub repository
+- Maven Central for public availability
+
+---
+
+## Language Support
+
+The toolkit currently supports generating SDKs targeting **Java 8** and later versions.
+
+---
+
+## Getting Help
+
+- **Toolkit Issues**: For problems specific to the SDK toolkit, please open an issue in this repository.
+- **SDK-Specific Questions**: For issues related to specific SDKs, refer to the respective repository for support and documentation.
+
+---
 
 ## Contributing
 
-Please refer to [CONTRIBUTING](CONTRIBUTING.md) for details.
+We welcome contributions to improve this toolkit!
+Please review our [CONTRIBUTING guidelines](CONTRIBUTING.md) before submitting issues or pull requests.
+
+---
 
 ## License
 
-This project is licensed under the Apache License v2.0 - see the [LICENSE](LICENSE) for details.
+This project is licensed under the Apache License 2.0. For more details, see the [LICENSE](LICENSE) file.
diff --git a/core/pom.xml b/core/pom.xml
@@ -54,7 +54,7 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 
         <kotlin.version>2.0.21</kotlin.version>
-        <ktor.version>2.3.12</ktor.version>
+        <ktor.version>2.3.13</ktor.version>
 
         <ktlint-plugin.version>3.3.0</ktlint-plugin.version>
         <build-helper-maven-plugin.version>3.6.0</build-helper-maven-plugin.version>

diff --git a/core/src/main/kotlin/com/expediagroup/sdk/core/client/BaseRapidClient.kt b/core/src/main/kotlin/com/expediagroup/sdk/core/client/BaseRapidClient.kt
@@ -22,6 +22,7 @@ import com.expediagroup.sdk.core.configuration.provider.RapidConfigurationProvid
 import com.expediagroup.sdk.core.plugin.authentication.strategy.AuthenticationStrategy
 import io.ktor.client.HttpClient
 import io.ktor.client.engine.HttpClientEngine
+import io.ktor.client.engine.okhttp.OkHttp
 
 /**
  * The integration point between the SDK Core and the product SDKs.
@@ -39,7 +40,14 @@ abstract class BaseRapidClient(
             clientConfiguration.toProvider(),
             RapidConfigurationProvider
         )
-    private val _httpClient: HttpClient = buildHttpClient(_configurationProvider, AuthenticationStrategy.AuthenticationType.SIGNATURE, httpClientEngine)
+
+    private val engine: HttpClientEngine = _configurationProvider.okHttpClient?.let {
+        OkHttp.create {
+            preconfigured = it
+        }
+    } ?: httpClientEngine
+
+    private val _httpClient: HttpClient = buildHttpClient(_configurationProvider, AuthenticationStrategy.AuthenticationType.SIGNATURE, engine)
 
     init {
         finalize()
@@ -53,5 +61,9 @@ abstract class BaseRapidClient(
 
     /** A [BaseRapidClient] builder. */
     @Suppress("unused", "UnnecessaryAbstractClass") // This is used by the generated SDK clients.
-    abstract class Builder<SELF : Builder<SELF>> : Client.Builder<SELF>()
+    abstract class Builder<SELF : Builder<SELF>> : HttpConfigurableBuilder<SELF>()
+
+    /** A [BaseRapidClient] builder with ability to pass a custom okhttp client. */
+    @Suppress("unused", "UnnecessaryAbstractClass") // This is used by the generated SDK clients.
+    abstract class BuilderWithHttpClient<SELF : Client.BuilderWithHttpClient<SELF>> : Client.BuilderWithHttpClient<SELF>()
 }
diff --git a/core/src/main/kotlin/com/expediagroup/sdk/core/client/BaseXapClient.kt b/core/src/main/kotlin/com/expediagroup/sdk/core/client/BaseXapClient.kt
@@ -22,6 +22,7 @@ import com.expediagroup.sdk.core.configuration.provider.XapConfigurationProvider
 import com.expediagroup.sdk.core.plugin.authentication.strategy.AuthenticationStrategy
 import io.ktor.client.HttpClient
 import io.ktor.client.engine.HttpClientEngine
+import io.ktor.client.engine.okhttp.OkHttp
 
 /**
  * The integration point between the SDK Core and the product SDKs.
@@ -39,7 +40,14 @@ abstract class BaseXapClient(
             clientConfiguration.toProvider(),
             XapConfigurationProvider
         )
-    private val _httpClient: HttpClient = buildHttpClient(_configurationProvider, AuthenticationStrategy.AuthenticationType.BASIC, httpClientEngine)
+
+    private val engine: HttpClientEngine = _configurationProvider.okHttpClient?.let {
+        OkHttp.create {
+            preconfigured = it
+        }
+    } ?: httpClientEngine
+
+    private val _httpClient: HttpClient = buildHttpClient(_configurationProvider, AuthenticationStrategy.AuthenticationType.BASIC, engine)
 
     init {
         finalize()
@@ -53,5 +61,9 @@ abstract class BaseXapClient(
 
     /** A [BaseXapClient] builder. */
     @Suppress("unused", "UnnecessaryAbstractClass") // This is used by the generated SDK clients.
-    abstract class Builder<SELF : Builder<SELF>> : Client.Builder<SELF>()
+    abstract class Builder<SELF : Builder<SELF>> : HttpConfigurableBuilder<SELF>()
+
+    /** A [BaseXapClient] builder with ability to pass a custom okhttp client. */
+    @Suppress("unused", "UnnecessaryAbstractClass") // This is used by the generated SDK clients.
+    abstract class BuilderWithHttpClient<SELF : Client.BuilderWithHttpClient<SELF>> : Client.BuilderWithHttpClient<SELF>()
 }