Merge branch 'main' into fix/connectTimeout

Author: Leo

.github/workflows/dependabot_pr.yml

@@ -28,6 +28,8 @@ jobs:
         uses: actions/checkout@v4
         with:
           token: ${{ steps.github_app_token.outputs.token }}
+          ref: ${{ github.event.pull_request.head.ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
 
       - id: version
         run: |

.github/workflows/publish-snapshots.yml

@@ -20,15 +20,15 @@ jobs:
           java-version: '21'
           distribution: 'temurin'
           cache: 'gradle'
-      - name: Configure AWS credentials
-        uses: aws-actions/configure-aws-credentials@v4
+      - name: Load secret
+        uses: 1password/load-secrets-action@v2
         with:
-          role-to-assume: ${{ secrets.PUBLISH_SNAPSHOTS_ROLE }}
-          aws-region: us-east-1
+          # Export loaded secrets as environment variables
+          export-env: true
+        env:
+          OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+          SONATYPE_USERNAME: op://opensearch-infra-secrets/maven-central-portal-credentials/username
+          SONATYPE_PASSWORD: op://opensearch-infra-secrets/maven-central-portal-credentials/password
       - name: publish snapshots to maven
         run: |
-          export SONATYPE_USERNAME=$(aws secretsmanager get-secret-value --secret-id maven-snapshots-username --query SecretString --output text)
-          export SONATYPE_PASSWORD=$(aws secretsmanager get-secret-value --secret-id maven-snapshots-password --query SecretString --output text)
-          echo "::add-mask::$SONATYPE_USERNAME"
-          echo "::add-mask::$SONATYPE_PASSWORD"
           ./gradlew --no-daemon publishPublishMavenPublicationToSnapshotsRepository

CHANGELOG.md

@@ -1,17 +1,26 @@
 # CHANGELOG
 Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
+## [Unreleased 4.x]
+
+### Dependencies
+- Bump `org.junit:junit-bom` from 5.13.1 to 5.13.2 ([#1650](https://github.com/opensearch-project/opensearch-java/pull/1650))
+- Bump `io.github.classgraph:classgraph` from 4.8.179 to 4.8.180 ([#1651](https://github.com/opensearch-project/opensearch-java/pull/1651))
+
 ## [Unreleased 3.x]
 ### Added
 - Added support for Index Management plugin APIs ([#1604](https://github.com/opensearch-project/opensearch-java/pull/1604))
 - Added support for the security plugin APIs ([#1601](https://github.com/opensearch-project/opensearch-java/pull/1601))
+- Jackson `ObjectMapper` modules are now being auto-detected ([#1643](https://github.com/opensearch-project/opensearch-java/pull/1643))
 
 ### Dependencies
 - Bump `org.owasp.dependencycheck` from 12.1.1 to 12.1.3 ([#1608](https://github.com/opensearch-project/opensearch-java/pull/1608), [#1607](https://github.com/opensearch-project/opensearch-java/pull/1607), [#1623](https://github.com/opensearch-project/opensearch-java/pull/1623))
 - Bump `org.junit:junit-bom` from 5.13.0 to 5.13.1 ([#1606](https://github.com/opensearch-project/opensearch-java/pull/1606))
 - Bump `org.ajoberstar.grgit:grgit-gradle` from 5.3.0 to 5.3.2 ([#1621](https://github.com/opensearch-project/opensearch-java/pull/1621))
+- Bump `org.opensearch.gradle:build-tools` from 3.1.0-SNAPSHOT to 3.2.0-SNAPSHOT ([#1642](https://github.com/opensearch-project/opensearch-java/pull/1642))
 
 ### Changed
+- Changed the type of the properties in DocStatus from integer to Long to resolve the integer overflow issue ([#1644](https://github.com/opensearch-project/opensearch-java/pull/1644))
 
 ### Deprecated
 

README.md

@@ -53,7 +53,7 @@ This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUC
 See [User Guide](USER_GUIDE.md).
 
 ## Snapshot Builds
-The [snapshots builds](https://aws.oss.sonatype.org/content/repositories/snapshots/org/opensearch/client/opensearch-java/) are published to sonatype using [publish-snapshots.yml](./.github/workflows/publish-snapshots.yml) workflow. Each `push` event to the main branch triggers this workflow.
+The [snapshots builds](https://central.sonatype.com/service/rest/repository/browse/maven-snapshots/org/opensearch/client/opensearch-java/) are published to sonatype using [publish-snapshots.yml](./.github/workflows/publish-snapshots.yml) workflow. Each `push` event to the main branch triggers this workflow.
 
 ## Compatibility with OpenSearch
 

UPGRADING.md

@@ -1,6 +1,10 @@
+* [UPGRADING](#upgrading)
+  * [Upgrading from 2.x to 3.0](#upgrading-from-2x-to-30)
+  * [Upgrading from 3.x to UNRELEASED](#upgrading-from-3x-to-unreleased)
+
 # UPGRADING
 
-## Upgrading 2.x to 3.0
+## Upgrading from 2.x to 3.0
 ### URL Path Encoding
 - The default URL path encoding has been changed to be more conservative. Previously the `!`, `$`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `;`, `=`, `@` and `:` characters were left un-encoded, they will now be percent-encoded. If you require the previous behavior you can specify the `org.opensearch.path.encoding=HTTP_CLIENT_V4_EQUIV` system property.
 
@@ -704,4 +708,73 @@ After:
 - The `tBucketSerializer` property has been removed as it is unused.
 
 ### ExplainResponse
-- The `explanation` property is now of type `Explanation` instead of `ExplanationDetail`.
+- The `explanation` property is now of type `Explanation` instead of `ExplanationDetail`.
+
+## Upgrading from 3.x to UNRELEASED
+### ExplainRequest
+- The `routing` property is now of type `List<String>` instead of `String`.
+
+### ExplainResponse
+- The `tDocumentSerializer` property has been removed as it is unused.
+
+### GetRequest
+- The `refresh` property has been corrected to be of type `Refresh` instead of `Boolean`.
+- The `routing` property is now of type `List<String>` instead of `String`.
+
+### GetResponse
+- The `GetResponse` class now extends a `GetResultBase` class instead of `GetResult`.
+
+### GetSourceRequest
+- The `refresh` property has been corrected to be of type `Refresh` instead of `Boolean`.
+- The `routing` property is now of type `List<String>` instead of `String`.
+- The `storedFields` property has been removed as it is not supported by OpenSearch.
+
+### ScrollResponse
+- The `ScrollResponse` class now extends `SearchResult` directly instead of via `SearchResponse`.
+
+### SearchResult
+- The `documents` property has been removed as it is not supported by OpenSearch.
+- The `maxScore` property has been removed as it is not supported by OpenSearch.
+- The `numReducePhases` property has been corrected to be of type `Integer` instead of `Long`.
+- The `tDocumentSerializer` property has been removed as it is unused.
+
+### CompletionSuggestOption
+- The `score` property has been corrected to be of type `Float` instead of `Double`.
+
+### SuggestVariant
+- The `_suggestionKind` method's naming has been corrected to `_suggestKind`.
+- The `_toSuggestion` method's naming has been corrected to `toSuggest`.
+
+### SuggestOptionBuilders
+- The `SuggestOptionBuilders` class has been removed.
+
+### SearchRequest
+- The `batchedReduceSize` property has been corrected to be of type `Integer` instead of `Long`.
+- The `indicesBoost` property is now of type `List<Map<String, Float>>` instead of `List<Map<String, Double>>`.
+- The `maxConcurrentShardRequests` property has been corrected to be of type `Integer` instead of `Long`.
+- The `minCompatibleShardNode` property has been removed as it is not supported by OpenSearch.
+- The `minScore` property has been corrected to be of type `Float` instead of `Double`.
+- The `preFilterShardSize` property has been corrected to be of type `Integer` instead of `Long`.
+- The `routing` property is now of type `List<String>` instead of `String`.
+- The `runtimeMappings` property has been removed as it is not supported by OpenSearch.
+- The `terminateAfter` property has been corrected to be of type `Integer` instead of `Long`.
+
+### core.search.Pit renamed to PointInTimeReference
+- The `Pit` class has been renamed to `PointInTimeReference`, this affects:
+  - `SearchRequest`'s `pit` field.
+- The `keepAlive` property has been corrected to be of type `Time` instead of `String`.
+
+### SearchTemplateRequest
+- The `routing` property is now of type `List<String>` instead of `String`.
+
+### LifecycleOperationMode
+- The `LifecycleOperationMode` enum has been removed as it is no longer used.
+
+### RuntimeField
+- The `RuntimeField` class has been removed as it is not supported by OpenSearch.
+
+### RuntimeFieldType
+- The `RuntimeFieldType` class has been removed as it is not supported by OpenSearch.
+
+### MultiSearchItem
+- The `MultiSearchItem` class now extends `SearchResult` directly instead of via `SearchResponse`.

USER_GUIDE.md

@@ -99,11 +99,12 @@ OpenSearchTransport transport = new RestClientTransport(restClient, new JacksonJ
 OpenSearchClient client = new OpenSearchClient(transport);
 ```
 
-The `JacksonJsonpMapper` class (2.x versions) only supports Java 7 objects by default. [Java 8 modules](https://github.com/FasterXML/jackson-modules-java8) to support JDK8 classes such as the Date and Time API (JSR-310), `Optional`, and more can be used by including [the additional datatype dependency](https://github.com/FasterXML/jackson-modules-java8#usage) and adding the module.  For example, to include JSR-310 classes:
+The `JacksonJsonpMapper` class (2.x versions) only supports Java 7 objects by default. [Java 8 modules](https://github.com/FasterXML/jackson-modules-java8) to support JDK8 classes such as the Date and Time API (JSR-310), `Optional`, and more can be used by including [the additional datatype dependency](https://github.com/FasterXML/jackson-modules-java8#usage) and adding the module. Auto-detection for these modules is enabled, adding them to the classpath is enough.
+You can also provide your own `ObjectMapper` instance if you need to pre-configure it differently, for example:
 
 ```java
 OpenSearchTransport transport = new RestClientTransport(restClient,
-    new JacksonJsonpMapper(new ObjectMapper().registerModule(new JavaTimeModule()))); 
+    new JacksonJsonpMapper(new ObjectMapper().findAndRegisterModules().configure(SerializationFeature.INDENT_OUTPUT, true))); 
 OpenSearchClient client = new OpenSearchClient(transport);
 ```
 

build.gradle.kts

@@ -38,6 +38,7 @@ allprojects {
 
     repositories {
         mavenLocal()
+        maven(url = "https://central.sonatype.com/repository/maven-snapshots/")
         maven(url = "https://aws.oss.sonatype.org/content/repositories/snapshots")
         mavenCentral()
         gradlePluginPortal()

buildSrc/build.gradle.kts

@@ -36,6 +36,7 @@ plugins {
 
 repositories {
     mavenLocal()
+    maven(url = "https://central.sonatype.com/repository/maven-snapshots/")
     maven(url = "https://aws.oss.sonatype.org/content/repositories/snapshots")
     mavenCentral()
     gradlePluginPortal()

java-client/build.gradle.kts

@@ -38,12 +38,13 @@ import java.io.FileWriter
 buildscript {
     repositories {
         mavenLocal()
+        maven(url = "https://central.sonatype.com/repository/maven-snapshots/")
         maven(url = "https://aws.oss.sonatype.org/content/repositories/snapshots")
         mavenCentral()
         gradlePluginPortal()
     }
     dependencies {
-        "classpath"(group = "org.opensearch.gradle", name = "build-tools", version = "3.1.0-SNAPSHOT")
+        "classpath"(group = "org.opensearch.gradle", name = "build-tools", version = "3.2.0-SNAPSHOT")
     }
 }
 
@@ -244,7 +245,7 @@ dependencies {
     implementation("org.eclipse", "yasson", "2.0.2")
 
     // https://github.com/classgraph/classgraph
-    testImplementation("io.github.classgraph:classgraph:4.8.179")
+    testImplementation("io.github.classgraph:classgraph:4.8.180")
 
     // Eclipse 1.0
     testImplementation("junit", "junit" , "4.13.2") {
@@ -317,7 +318,7 @@ tasks.withType<Jar> {
 publishing {
     repositories{
         if (version.toString().endsWith("SNAPSHOT")) {
-            maven("https://aws.oss.sonatype.org/content/repositories/snapshots/") {
+            maven("https://central.sonatype.com/repository/maven-snapshots/") {
                 name = "Snapshots"
                 credentials {
                     username = System.getenv("SONATYPE_USERNAME")