From a209c9b5cf877f9943e938977b5c90d7e0c0075c Mon Sep 17 00:00:00 2001
From: "opensearch-trigger-bot[bot]"
 <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com>
Date: Wed, 2 Aug 2023 11:13:12 -0400
Subject: [PATCH] [Refactor] Recyclers to Common Library (#9028) (#9064)

This commit refactors the common recylers logic from the server module
to the core library to make the base functionality available to concrete
implementations across the codebase. This is done to support cloud
native or serverless implementations. Until JPM is enabled, the classes
remain marked for internal use only. Determining which classes will be
exported will dictate if/when these doc labels are switched to API.


(cherry picked from commit 22893b12add9f12717f42aa9e718ee16ea442114)

Signed-off-by: Nicholas Walter Knize <nknize@apache.org>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
---
 .../opensearch/common/recycler/AbstractRecycler.java   |  0
 .../opensearch/common/recycler/AbstractRecyclerC.java  |  0
 .../common/recycler/ConcurrentDequeRecycler.java       |  0
 .../org/opensearch/common/recycler/DequeRecycler.java  |  0
 .../org/opensearch/common/recycler/FilterRecycler.java |  0
 .../org/opensearch/common/recycler/NoneRecycler.java   |  0
 .../java/org/opensearch/common/recycler/Recycler.java  |  0
 .../java/org/opensearch/common/recycler/Recyclers.java |  4 +++-
 .../org/opensearch/common/recycler/package-info.java   | 10 ++++++++++
 .../common/util/concurrent/ConcurrentCollections.java  |  0
 .../common/util/concurrent/ConcurrentHashMapLong.java  |  0
 .../common/util/concurrent/ConcurrentMapLong.java      |  0
 .../common/recycler/AbstractRecyclerTestCase.java      |  0
 .../common/recycler/ConcurrentRecyclerTests.java       |  0
 .../common/recycler/LockedRecyclerTests.java           |  0
 .../opensearch/common/recycler/NoneRecyclerTests.java  |  0
 .../opensearch/common/recycler/QueueRecyclerTests.java |  0
 17 files changed, 13 insertions(+), 1 deletion(-)
 rename {server => libs/common}/src/main/java/org/opensearch/common/recycler/AbstractRecycler.java (100%)
 rename {server => libs/common}/src/main/java/org/opensearch/common/recycler/AbstractRecyclerC.java (100%)
 rename {server => libs/common}/src/main/java/org/opensearch/common/recycler/ConcurrentDequeRecycler.java (100%)
 rename {server => libs/common}/src/main/java/org/opensearch/common/recycler/DequeRecycler.java (100%)
 rename {server => libs/common}/src/main/java/org/opensearch/common/recycler/FilterRecycler.java (100%)
 rename {server => libs/common}/src/main/java/org/opensearch/common/recycler/NoneRecycler.java (100%)
 rename {server => libs/common}/src/main/java/org/opensearch/common/recycler/Recycler.java (100%)
 rename {server => libs/common}/src/main/java/org/opensearch/common/recycler/Recyclers.java (98%)
 create mode 100644 libs/common/src/main/java/org/opensearch/common/recycler/package-info.java
 rename {server => libs/common}/src/main/java/org/opensearch/common/util/concurrent/ConcurrentCollections.java (100%)
 rename {server => libs/common}/src/main/java/org/opensearch/common/util/concurrent/ConcurrentHashMapLong.java (100%)
 rename {server => libs/common}/src/main/java/org/opensearch/common/util/concurrent/ConcurrentMapLong.java (100%)
 rename {server => libs/common}/src/test/java/org/opensearch/common/recycler/AbstractRecyclerTestCase.java (100%)
 rename {server => libs/common}/src/test/java/org/opensearch/common/recycler/ConcurrentRecyclerTests.java (100%)
 rename {server => libs/common}/src/test/java/org/opensearch/common/recycler/LockedRecyclerTests.java (100%)
 rename {server => libs/common}/src/test/java/org/opensearch/common/recycler/NoneRecyclerTests.java (100%)
 rename {server => libs/common}/src/test/java/org/opensearch/common/recycler/QueueRecyclerTests.java (100%)

diff --git a/server/src/main/java/org/opensearch/common/recycler/AbstractRecycler.java b/libs/common/src/main/java/org/opensearch/common/recycler/AbstractRecycler.java
similarity index 100%
rename from server/src/main/java/org/opensearch/common/recycler/AbstractRecycler.java
rename to libs/common/src/main/java/org/opensearch/common/recycler/AbstractRecycler.java
diff --git a/server/src/main/java/org/opensearch/common/recycler/AbstractRecyclerC.java b/libs/common/src/main/java/org/opensearch/common/recycler/AbstractRecyclerC.java
similarity index 100%
rename from server/src/main/java/org/opensearch/common/recycler/AbstractRecyclerC.java
rename to libs/common/src/main/java/org/opensearch/common/recycler/AbstractRecyclerC.java
diff --git a/server/src/main/java/org/opensearch/common/recycler/ConcurrentDequeRecycler.java b/libs/common/src/main/java/org/opensearch/common/recycler/ConcurrentDequeRecycler.java
similarity index 100%
rename from server/src/main/java/org/opensearch/common/recycler/ConcurrentDequeRecycler.java
rename to libs/common/src/main/java/org/opensearch/common/recycler/ConcurrentDequeRecycler.java
diff --git a/server/src/main/java/org/opensearch/common/recycler/DequeRecycler.java b/libs/common/src/main/java/org/opensearch/common/recycler/DequeRecycler.java
similarity index 100%
rename from server/src/main/java/org/opensearch/common/recycler/DequeRecycler.java
rename to libs/common/src/main/java/org/opensearch/common/recycler/DequeRecycler.java
diff --git a/server/src/main/java/org/opensearch/common/recycler/FilterRecycler.java b/libs/common/src/main/java/org/opensearch/common/recycler/FilterRecycler.java
similarity index 100%
rename from server/src/main/java/org/opensearch/common/recycler/FilterRecycler.java
rename to libs/common/src/main/java/org/opensearch/common/recycler/FilterRecycler.java
diff --git a/server/src/main/java/org/opensearch/common/recycler/NoneRecycler.java b/libs/common/src/main/java/org/opensearch/common/recycler/NoneRecycler.java
similarity index 100%
rename from server/src/main/java/org/opensearch/common/recycler/NoneRecycler.java
rename to libs/common/src/main/java/org/opensearch/common/recycler/NoneRecycler.java
diff --git a/server/src/main/java/org/opensearch/common/recycler/Recycler.java b/libs/common/src/main/java/org/opensearch/common/recycler/Recycler.java
similarity index 100%
rename from server/src/main/java/org/opensearch/common/recycler/Recycler.java
rename to libs/common/src/main/java/org/opensearch/common/recycler/Recycler.java
diff --git a/server/src/main/java/org/opensearch/common/recycler/Recyclers.java b/libs/common/src/main/java/org/opensearch/common/recycler/Recyclers.java
similarity index 98%
rename from server/src/main/java/org/opensearch/common/recycler/Recyclers.java
rename to libs/common/src/main/java/org/opensearch/common/recycler/Recyclers.java
index 4cbb80509d6a1..52587144369f1 100644
--- a/server/src/main/java/org/opensearch/common/recycler/Recyclers.java
+++ b/libs/common/src/main/java/org/opensearch/common/recycler/Recyclers.java
@@ -75,6 +75,8 @@ public static <T> Recycler.Factory<T> dequeFactory(final Recycler.C<T> c, final
     /**
      * Wrap the provided recycler so that calls to {@link Recycler#obtain()} and {@link Recycler.V#close()} are protected by
      * a lock.
+     *
+     * @opensearch.internal
      */
     public static <T> Recycler<T> locked(final Recycler<T> recycler) {
         return new FilterRecycler<T>() {
@@ -140,7 +142,7 @@ public static <T> Recycler<T> concurrent(final Recycler.Factory<T> factory, fina
             private final Recycler<T>[] recyclers;
 
             {
-                @SuppressWarnings("unchecked")
+                @SuppressWarnings({ "rawtypes", "unchecked" })
                 final Recycler<T>[] recyclers = new Recycler[concurrencyLevel];
                 this.recyclers = recyclers;
                 for (int i = 0; i < concurrencyLevel; ++i) {
diff --git a/libs/common/src/main/java/org/opensearch/common/recycler/package-info.java b/libs/common/src/main/java/org/opensearch/common/recycler/package-info.java
new file mode 100644
index 0000000000000..fec3c5d5e52d3
--- /dev/null
+++ b/libs/common/src/main/java/org/opensearch/common/recycler/package-info.java
@@ -0,0 +1,10 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+/** Common Recycler functionality for recycling objects */
+package org.opensearch.common.recycler;
diff --git a/server/src/main/java/org/opensearch/common/util/concurrent/ConcurrentCollections.java b/libs/common/src/main/java/org/opensearch/common/util/concurrent/ConcurrentCollections.java
similarity index 100%
rename from server/src/main/java/org/opensearch/common/util/concurrent/ConcurrentCollections.java
rename to libs/common/src/main/java/org/opensearch/common/util/concurrent/ConcurrentCollections.java
diff --git a/server/src/main/java/org/opensearch/common/util/concurrent/ConcurrentHashMapLong.java b/libs/common/src/main/java/org/opensearch/common/util/concurrent/ConcurrentHashMapLong.java
similarity index 100%
rename from server/src/main/java/org/opensearch/common/util/concurrent/ConcurrentHashMapLong.java
rename to libs/common/src/main/java/org/opensearch/common/util/concurrent/ConcurrentHashMapLong.java
diff --git a/server/src/main/java/org/opensearch/common/util/concurrent/ConcurrentMapLong.java b/libs/common/src/main/java/org/opensearch/common/util/concurrent/ConcurrentMapLong.java
similarity index 100%
rename from server/src/main/java/org/opensearch/common/util/concurrent/ConcurrentMapLong.java
rename to libs/common/src/main/java/org/opensearch/common/util/concurrent/ConcurrentMapLong.java
diff --git a/server/src/test/java/org/opensearch/common/recycler/AbstractRecyclerTestCase.java b/libs/common/src/test/java/org/opensearch/common/recycler/AbstractRecyclerTestCase.java
similarity index 100%
rename from server/src/test/java/org/opensearch/common/recycler/AbstractRecyclerTestCase.java
rename to libs/common/src/test/java/org/opensearch/common/recycler/AbstractRecyclerTestCase.java
diff --git a/server/src/test/java/org/opensearch/common/recycler/ConcurrentRecyclerTests.java b/libs/common/src/test/java/org/opensearch/common/recycler/ConcurrentRecyclerTests.java
similarity index 100%
rename from server/src/test/java/org/opensearch/common/recycler/ConcurrentRecyclerTests.java
rename to libs/common/src/test/java/org/opensearch/common/recycler/ConcurrentRecyclerTests.java
diff --git a/server/src/test/java/org/opensearch/common/recycler/LockedRecyclerTests.java b/libs/common/src/test/java/org/opensearch/common/recycler/LockedRecyclerTests.java
similarity index 100%
rename from server/src/test/java/org/opensearch/common/recycler/LockedRecyclerTests.java
rename to libs/common/src/test/java/org/opensearch/common/recycler/LockedRecyclerTests.java
diff --git a/server/src/test/java/org/opensearch/common/recycler/NoneRecyclerTests.java b/libs/common/src/test/java/org/opensearch/common/recycler/NoneRecyclerTests.java
similarity index 100%
rename from server/src/test/java/org/opensearch/common/recycler/NoneRecyclerTests.java
rename to libs/common/src/test/java/org/opensearch/common/recycler/NoneRecyclerTests.java
diff --git a/server/src/test/java/org/opensearch/common/recycler/QueueRecyclerTests.java b/libs/common/src/test/java/org/opensearch/common/recycler/QueueRecyclerTests.java
similarity index 100%
rename from server/src/test/java/org/opensearch/common/recycler/QueueRecyclerTests.java
rename to libs/common/src/test/java/org/opensearch/common/recycler/QueueRecyclerTests.java