Merge branch 'main' into remove_old_snapshot_repo

jzonthemtn · web-flow · commit bd3167a0dc87 · 2025-10-30T16:26:24.000-04:00
Signed-off-by: Jeff Zemerick &lt;13176962+jzonthemtn@users.noreply.github.com&gt;
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1 +1 @@
-* @epugh @jzonthemtn @msfroh
+* @epugh @jzonthemtn @msfroh @sstults
diff --git a/.github/workflows/backport.yml b/.github/workflows/backport.yml
@@ -0,0 +1,40 @@
+name: Backport
+on:
+  pull_request_target:
+    types:
+      - closed
+      - labeled
+
+jobs:
+  backport:
+    name: Backport
+    runs-on: ubuntu-latest
+    # Only react to merged PRs for security reasons.
+    # See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target.
+    if: >
+      github.event.pull_request.merged
+      && (
+        github.event.action == 'closed'
+        || (
+          github.event.action == 'labeled'
+          && contains(github.event.label.name, 'backport')
+        )
+      )
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: GitHub App token
+        id: github_app_token
+        uses: tibdex/github-app-token@v2.1.0
+        with:
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.APP_PRIVATE_KEY }}
+          installation_id: 22958780
+
+      - name: Backport
+        uses: VachaShah/backport@v2.2.0
+        with:
+          github_token: ${{ steps.github_app_token.outputs.token }}
+          head_template: backport/backport-<%= number %>-to-<%= base %>
+          failure_labels: backport-failed
diff --git a/.github/workflows/delete_backport_branch.yml b/.github/workflows/delete_backport_branch.yml
@@ -0,0 +1,22 @@
+name: Delete merged branch of the backport PRs
+on: 
+  pull_request:
+    types:
+      - closed
+  
+jobs:
+  delete-branch:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    if: github.repository == 'opensearch-project/user-behavior-insights' && startsWith(github.event.pull_request.head.ref,'backport/')
+    steps:
+    - name: Delete merged branch
+      uses: actions/github-script@v7
+      with:
+        script: |
+          github.rest.git.deleteRef({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            ref: `heads/${context.payload.pull_request.head.ref}`,
+          })
diff --git a/.github/workflows/maven-publish.yml b/.github/workflows/maven-publish.yml
@@ -31,8 +31,14 @@ jobs:
           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
+          MAVEN_SNAPSHOTS_S3_REPO: op://opensearch-infra-secrets/maven-snapshots-s3/repo
+          MAVEN_SNAPSHOTS_S3_ROLE: op://opensearch-infra-secrets/maven-snapshots-s3/role
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v5
+        with:
+          role-to-assume: ${{ env.MAVEN_SNAPSHOTS_S3_ROLE }}
+          aws-region: us-east-1
 
       - name: Publish snapshots to maven
         run: |
diff --git a/Dockerfile b/Dockerfile
@@ -1,10 +1,12 @@
-FROM opensearchstaging/opensearch:3.1.0-SNAPSHOT
+FROM opensearchstaging/opensearch:3.3.0
 
-ARG UBI_VERSION="3.1.0.0-SNAPSHOT"
+ARG UBI_VERSION="3.3.0.0-SNAPSHOT"
 
 COPY ./build/distributions/opensearch-ubi-${UBI_VERSION}.zip /tmp/
 
 # Required for OTel capabilities.
 #RUN /usr/share/opensearch/bin/opensearch-plugin install --batch telemetry-otel
 
-RUN /usr/share/opensearch/bin/opensearch-plugin install --batch file:/tmp/opensearch-ubi-${UBI_VERSION}.zip
+RUN /usr/share/opensearch/bin/opensearch-plugin remove opensearch-ubi
+
+RUN /usr/share/opensearch/bin/opensearch-plugin install --batch file:/tmp/opensearch-ubi-${UBI_VERSION}.zip
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -12,7 +12,8 @@ This document contains a list of maintainers in this repo. See [opensearch-proje
 | ------------------ | --------------------------------------------------------- | ----------- |
 | Eric Pugh | [epugh](https://github.com/epugh)                       | OpenSource Connections |
 | Jeff Zemerick | [jzonthemtn](https://github.com/jzonthemtn)                           | Mountain Fog |
-| Michael Froh | [msfroh](https://github.com/msfroh)                   | Amazon      |
+| Michael Froh | [msfroh](https://github.com/msfroh)                   | Uber      |
+| Scott Stults | [sstults](https://github.com/sstults)                   | OpenSource Connections      |
 
 ## Emeritus
 
diff --git a/README.md b/README.md
@@ -11,12 +11,14 @@ UBI and this plugin project was originally proposed in the [OpenSearch UBI RFC](
 Please note that this repository is the implementation of the UBI plugin for OpenSearch.
 
 > [!IMPORTANT] 
-> This release targets to the 1.0.0 version of the UBI Specification.
+> This release targets to the 1.3.0 version of the UBI Specification.
 
 For details on the JSON Schema used by UBI to send and receive queries and events please see the [UBI](https://github.com/o19s/ubi) repository and the links below.
-* [Query Request Schema](https://o19s.github.io/ubi/docs/html/query.request.schema.html)
-* [Query Response Schema](https://o19s.github.io/ubi/docs/html/query.response.schema.html)
-* [Event Schema](https://o19s.github.io/ubi/docs/html/event.schema.html)
+* [Query Request Schema](https://o19s.github.io/ubi/docs/html/latest/query.request.schema.html)
+* [Query Response Schema](https://o19s.github.io/ubi/docs/html/latest/query.response.schema.html)
+* [Event Schema](https://o19s.github.io/ubi/docs/html/latest/event.schema.html)
+
+Visit [https://ubisearch.dev](https://ubisearch.dev) to learn more about UBI.
 
 ## UBI, Data Prepper, and Open Telemetry
 
@@ -34,7 +36,7 @@ The UBI plugin can store UBI query data in one of three ways:
 
 ## Useful Commands
 
-The `scripts/` directory contains example UBI requests for common use cases.
+The `src/test/scripts/` directory contains example UBI requests for common use cases.
 
 ## User Quick Start
 
@@ -43,7 +45,7 @@ The `scripts/` directory contains example UBI requests for common use cases.
 To get started, download the plugin zip file from the [releases](https://github.com/opensearch-project/user-behavior-insights/releases). Next, install the plugin into OpenSearch with the following command:
 
 ```
-bin/opensearch-plugin install file:/opensearch-ubi-2.18.0.0.zip
+bin/opensearch-plugin install file:/opensearch-ubi-3.2.0.0.zip
 ```
 
 You will be prompted while installing the plugin because the plugin defines additional security permissions. These permissions allow the plugin to serialize query requests to JSON for storing and to allow the plugin to send query requests to Data Prepper. You can skip the prompt by adding the `--batch` argument to the above command.
diff --git a/build.gradle b/build.gradle
@@ -35,7 +35,7 @@ forbiddenApisTest.enabled = false
 
 buildscript {
     ext {
-        opensearch_version = System.getProperty("opensearch.version", "3.3.0-SNAPSHOT")
+        opensearch_version = System.getProperty("opensearch.version", "3.4.0-SNAPSHOT")
         buildVersionQualifier = System.getProperty("build.version_qualifier", "")
         isSnapshot = "true" == System.getProperty("build.snapshot", "true")
         version_tokens = opensearch_version.tokenize('-')
@@ -54,7 +54,7 @@ buildscript {
 
     repositories {
         mavenLocal()
-        maven { url "https://central.sonatype.com/repository/maven-snapshots/" }
+        maven { url "https://ci.opensearch.org/ci/dbc/snapshots/maven/" }
         mavenCentral()
         maven { url "https://plugins.gradle.org/m2/" }
         maven { url 'https://jitpack.io' }
@@ -68,8 +68,7 @@ buildscript {
 
 repositories {
     mavenLocal()
-    maven { url "https://central.sonatype.com/repository/maven-snapshots/" }
-    maven { url "https://aws.oss.sonatype.org/content/repositories/snapshots" }
+    maven { url "https://ci.opensearch.org/ci/dbc/snapshots/maven/" }
     mavenCentral()
     maven { url "https://plugins.gradle.org/m2/" }
 }
@@ -126,10 +125,11 @@ publishing {
     repositories {
         maven {
             name = "Snapshots"
-            url = "https://central.sonatype.com/repository/maven-snapshots/"
-            credentials {
-                username "$System.env.SONATYPE_USERNAME"
-                password "$System.env.SONATYPE_PASSWORD"
+            url = System.getenv("MAVEN_SNAPSHOTS_S3_REPO")
+            credentials(AwsCredentials) {
+                accessKey = System.getenv("AWS_ACCESS_KEY_ID")
+                secretKey = System.getenv("AWS_SECRET_ACCESS_KEY")
+                sessionToken = System.getenv("AWS_SESSION_TOKEN")
             }
         }
         maven {
@@ -305,6 +305,10 @@ diffCoverageReport {
     }
 }
 
+run {
+    useCluster testClusters.integTest
+}
+
 // updateVersion: Task to auto update version to the next development iteration
 task updateVersion {
     onlyIf { System.getProperty('newVersion') }
diff --git a/release-notes/opensearch-user-behavior-insights.release-notes-3.3.0.0.md b/release-notes/opensearch-user-behavior-insights.release-notes-3.3.0.0.md
@@ -0,0 +1,10 @@
+## Version 3.3.0 Release Notes
+
+Compatible with OpenSearch and OpenSearch Dashboards version 3.3.0
+
+### Maintenance
+* Increment version to 3.3.0-SNAPSHOT ([#127](https://github.com/opensearch-project/user-behavior-insights/pull/127))
+
+### Bug Fixes
+* fix dependencies ([#128](https://github.com/opensearch-project/user-behavior-insights/pull/128))
+* fix: Update System.env syntax for Gradle 9 compatibility ([#122](https://github.com/opensearch-project/user-behavior-insights/pull/122))
diff --git a/src/main/java/org/opensearch/ubi/QueryRequest.java b/src/main/java/org/opensearch/ubi/QueryRequest.java
@@ -40,6 +40,7 @@ public class QueryRequest {
      * @param userQuery The user-entered query.
      * @param clientId The ID of the client that initiated the query.
      * @param query The raw query.
+     * @param application The application that initiated the query.
      * @param queryAttributes An optional map of additional attributes for the query.
      * @param queryResponse The {@link QueryResponse} for this query request.
      */
diff --git a/src/main/java/org/opensearch/ubi/UbiActionFilter.java b/src/main/java/org/opensearch/ubi/UbiActionFilter.java
@@ -23,6 +23,7 @@
 import org.opensearch.action.search.SearchResponse;
 import org.opensearch.action.support.ActionFilter;
 import org.opensearch.action.support.ActionFilterChain;
+import org.opensearch.action.support.ActionRequestMetadata;
 import org.opensearch.common.xcontent.XContentType;
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.core.action.ActionResponse;
@@ -79,6 +80,7 @@ public <Request extends ActionRequest, Response extends ActionResponse> void app
         Task task,
         String action,
         Request request,
+        ActionRequestMetadata<Request, Response> actionRequestMetadata,
         ActionListener<Response> listener,
         ActionFilterChain<Request, Response> chain
     ) {
diff --git a/src/main/java/org/opensearch/ubi/UbiPlugin.java b/src/main/java/org/opensearch/ubi/UbiPlugin.java
@@ -49,10 +49,22 @@
  */
 public class UbiPlugin extends Plugin implements ActionPlugin, SearchPlugin, TelemetryAwarePlugin {
 
+    /**
+     * The index name used for storing User Behavior Insights queries data.
+     */
     public static final String UBI_QUERIES_INDEX = "ubi_queries";
+    /**
+     * The index name used for storing User Behavior Insights events data.
+     */
     public static final String UBI_EVENTS_INDEX = "ubi_events";
 
+    /**
+     * Path to the JSON file containing the mapping configuration for the events index.
+     */
     public static final String EVENTS_MAPPING_FILE = "/events-mapping.json";
+    /**
+     * Path to the JSON file containing the mapping configuration for the queries index.
+     */
     public static final String QUERIES_MAPPING_FILE = "/queries-mapping.json";
 
     private ActionFilter ubiActionFilter;
diff --git a/src/main/java/org/opensearch/ubi/UbiRestHandler.java b/src/main/java/org/opensearch/ubi/UbiRestHandler.java
@@ -35,6 +35,10 @@
 import static org.opensearch.ubi.UbiPlugin.UBI_EVENTS_INDEX;
 import static org.opensearch.ubi.UbiPlugin.UBI_QUERIES_INDEX;
 
+/**
+ * REST handler for User Behavior Insights Plugin operations.
+ * Provides endpoints for initializing UBI indices and mappings.
+ */
 public class UbiRestHandler extends BaseRestHandler {
 
     private static final Logger LOGGER = LogManager.getLogger(UbiRestHandler.class);
@@ -43,6 +47,13 @@ public class UbiRestHandler extends BaseRestHandler {
      * URL for initializing the plugin and the index mappings.
      */
     public static final String INITIALIZE_URL = "/_plugins/ubi/initialize";
+    
+    /**
+     * Creates a new instance of {@link UbiRestHandler}.
+     */
+    public UbiRestHandler() {
+        // Default constructor
+    }
 
     @Override
     public String getName() {
diff --git a/src/main/java/org/opensearch/ubi/UbiSettings.java b/src/main/java/org/opensearch/ubi/UbiSettings.java
@@ -14,10 +14,17 @@
 import java.util.List;
 
 /**
- * The UBI settings.
+ * Utility class for UBI settings.
  */
 public class UbiSettings {
 
+    /**
+     * Private constructor to prevent instantiation as this is a utility class with static methods.
+     */
+    private UbiSettings() {
+        // Private constructor to prevent instantiation
+    }
+
     /**
      * The name of the Data Prepper http_source URL for receiving queries.
      */
diff --git a/src/test/java/org/opensearch/ubi/UbiActionFilterTests.java b/src/test/java/org/opensearch/ubi/UbiActionFilterTests.java
@@ -14,6 +14,7 @@
 import org.opensearch.action.search.SearchRequest;
 import org.opensearch.action.search.SearchResponse;
 import org.opensearch.action.support.ActionFilterChain;
+import org.opensearch.action.support.ActionRequestMetadata;
 import org.opensearch.common.action.ActionFuture;
 import org.opensearch.common.settings.Settings;
 import org.opensearch.common.unit.TimeValue;
@@ -98,7 +99,7 @@ public void testApplyWithoutUbiBlock() {
 
         when(request.source()).thenReturn(searchSourceBuilder);
 
-        ubiActionFilter.apply(task, "ubi", request, listener, chain);
+        ubiActionFilter.apply(task, "ubi", request, ActionRequestMetadata.empty(), listener, chain);
 
         verify(client, never()).index(any(), any());
 
@@ -157,7 +158,7 @@ public void testApplyWithUbiBlockWithoutQueryId() {
 
         when(request.source()).thenReturn(searchSourceBuilder);
 
-        ubiActionFilter.apply(task, "ubi", request, listener, chain);
+        ubiActionFilter.apply(task, "ubi", request, ActionRequestMetadata.empty(), listener, chain);
 
         verify(client, atMostOnce()).index(any(), any());
 
diff --git a/src/yamlRestTest/resources/rest-api-spec/test/_plugins.ubi/40_msearch_queries_with_ubi.yml b/src/yamlRestTest/resources/rest-api-spec/test/_plugins.ubi/40_msearch_queries_with_ubi.yml
@@ -67,11 +67,11 @@
   - match:  { responses.0.hits.total: 1}
   - match:  { responses.1.hits.total: 1}
 
-  - do:
-      indices.refresh:
-        index: [ "ubi_queries" ]
-  - do:
-      count:
-        index: ubi_queries
-
-  - match: { count: 2 }
+#  - do:
+#      indices.refresh:
+#        index: [ "ubi_queries" ]
+#  - do:
+#      count:
+#        index: ubi_queries
+
+#  - match: { count: 2 }

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-* @epugh @jzonthemtn @msfroh`
	`1`	`+* @epugh @jzonthemtn @msfroh @sstults`