[Refactor] CircuitBreaker foundation classes to core library (#9006) (#…

…9054)

This commit refactors the following CircuitBreaker foundation classes
from the server module to the core library:

* o.o.common.breaker.CircuitBreaker
* o.o.common.breaker.CircuitBreakingException
* o.o.common.breaker.NoopCircuitBreaker
* o.o.indices.breaker.AllCircuitBreakerStats
* o.o.indices.breaker.CircuitBreakerService
* o.o.indices.breaker.CircuitBreakerStats
* o.o.indices.breaker.NoneCircuitBreakerService

The following base support classes are also refactored from the server
to appropriate common or core libraries as a side effect:

* o.o.common.component.AbstractLifecycleComponent
* o.o.common.component.Lifecycle
* o.o.common.component.LifecycleComponent
* o.o.common.component.LifecycleListener
* o.o.common.unit.ByteSizeUnit
* o.o.common.unit.ByteSizeValue

Tests and documentation are updated.

Signed-off-by: Nicholas Walter Knize <[email protected]>
(cherry picked from commit 639d28a)

benchmarks/src/main/java/org/opensearch/benchmark/search/aggregations/TermsReduceBenchmark.java

@@ -40,14 +40,14 @@
 import org.opensearch.action.search.SearchPhaseController;
 import org.opensearch.action.search.SearchProgressListener;
 import org.opensearch.action.search.SearchRequest;
-import org.opensearch.common.breaker.CircuitBreaker;
-import org.opensearch.common.breaker.NoopCircuitBreaker;
+import org.opensearch.core.common.breaker.CircuitBreaker;
+import org.opensearch.core.common.breaker.NoopCircuitBreaker;
 import org.opensearch.core.common.io.stream.NamedWriteableRegistry;
 import org.opensearch.common.lucene.search.TopDocsAndMaxScore;
 import org.opensearch.common.settings.Settings;
 import org.opensearch.core.index.Index;
 import org.opensearch.core.index.shard.ShardId;
-import org.opensearch.indices.breaker.NoneCircuitBreakerService;
+import org.opensearch.core.indices.breaker.NoneCircuitBreakerService;
 import org.opensearch.search.DocValueFormat;
 import org.opensearch.search.SearchModule;
 import org.opensearch.search.SearchShardTarget;

benchmarks/src/main/java/org/opensearch/benchmark/store/remote/filecache/FileCacheBenchmark.java

@@ -27,8 +27,8 @@
 import org.openjdk.jmh.annotations.Threads;
 import org.openjdk.jmh.annotations.Warmup;
 import org.openjdk.jmh.infra.Blackhole;
-import org.opensearch.common.breaker.CircuitBreaker;
-import org.opensearch.common.breaker.NoopCircuitBreaker;
+import org.opensearch.core.common.breaker.CircuitBreaker;
+import org.opensearch.core.common.breaker.NoopCircuitBreaker;
 import org.opensearch.index.store.remote.filecache.CachedIndexInput;
 import org.opensearch.index.store.remote.filecache.FileCache;
 import org.opensearch.index.store.remote.filecache.FileCacheFactory;

client/rest-high-level/src/main/java/org/opensearch/client/indices/DataStreamsStatsResponse.java

@@ -34,7 +34,7 @@
 
 import org.opensearch.client.core.BroadcastResponse;
 import org.opensearch.core.ParseField;
-import org.opensearch.common.unit.ByteSizeValue;
+import org.opensearch.core.common.unit.ByteSizeValue;
 import org.opensearch.core.xcontent.ConstructingObjectParser;
 import org.opensearch.core.xcontent.ObjectParser;
 import org.opensearch.core.xcontent.XContentParser;

client/rest-high-level/src/main/java/org/opensearch/client/indices/ResizeRequest.java

@@ -39,7 +39,7 @@
 import org.opensearch.common.settings.Settings;
 import org.opensearch.core.xcontent.ToXContentObject;
 import org.opensearch.core.xcontent.XContentBuilder;
-import org.opensearch.common.unit.ByteSizeValue;
+import org.opensearch.core.common.unit.ByteSizeValue;
 
 import java.io.IOException;
 import java.util.Collections;

client/rest-high-level/src/main/java/org/opensearch/client/indices/rollover/RolloverRequest.java

@@ -37,7 +37,7 @@
 import org.opensearch.action.admin.indices.rollover.MaxSizeCondition;
 import org.opensearch.client.TimedRequest;
 import org.opensearch.client.indices.CreateIndexRequest;
-import org.opensearch.common.unit.ByteSizeValue;
+import org.opensearch.core.common.unit.ByteSizeValue;
 import org.opensearch.common.unit.TimeValue;
 import org.opensearch.core.xcontent.ToXContentObject;
 import org.opensearch.core.xcontent.XContentBuilder;

client/rest-high-level/src/test/java/org/opensearch/client/BulkProcessorIT.java

@@ -44,8 +44,8 @@
 import org.opensearch.action.search.SearchRequest;
 import org.opensearch.common.Strings;
 import org.opensearch.core.common.bytes.BytesArray;
-import org.opensearch.common.unit.ByteSizeUnit;
-import org.opensearch.common.unit.ByteSizeValue;
+import org.opensearch.core.common.unit.ByteSizeUnit;
+import org.opensearch.core.common.unit.ByteSizeValue;
 import org.opensearch.common.unit.TimeValue;
 import org.opensearch.core.xcontent.XContentBuilder;
 import org.opensearch.common.xcontent.XContentType;

client/rest-high-level/src/test/java/org/opensearch/client/ClusterClientIT.java

@@ -60,7 +60,7 @@
 import org.opensearch.cluster.routing.allocation.decider.EnableAllocationDecider;
 import org.opensearch.common.compress.CompressedXContent;
 import org.opensearch.common.settings.Settings;
-import org.opensearch.common.unit.ByteSizeUnit;
+import org.opensearch.core.common.unit.ByteSizeUnit;
 import org.opensearch.common.unit.TimeValue;
 import org.opensearch.common.xcontent.XContentType;
 import org.opensearch.common.xcontent.support.XContentMapValues;

client/rest-high-level/src/test/java/org/opensearch/client/CrudIT.java

@@ -60,8 +60,8 @@
 import org.opensearch.client.indices.GetIndexRequest;
 import org.opensearch.core.common.bytes.BytesReference;
 import org.opensearch.common.settings.Settings;
-import org.opensearch.common.unit.ByteSizeUnit;
-import org.opensearch.common.unit.ByteSizeValue;
+import org.opensearch.core.common.unit.ByteSizeUnit;
+import org.opensearch.core.common.unit.ByteSizeValue;
 import org.opensearch.core.common.Strings;
 import org.opensearch.core.xcontent.XContentBuilder;
 import org.opensearch.common.xcontent.XContentFactory;

client/rest-high-level/src/test/java/org/opensearch/client/IndicesClientIT.java

@@ -112,8 +112,8 @@
 import org.opensearch.common.compress.CompressedXContent;
 import org.opensearch.common.settings.Setting;
 import org.opensearch.common.settings.Settings;
-import org.opensearch.common.unit.ByteSizeUnit;
-import org.opensearch.common.unit.ByteSizeValue;
+import org.opensearch.core.common.unit.ByteSizeUnit;
+import org.opensearch.core.common.unit.ByteSizeValue;
 import org.opensearch.common.unit.TimeValue;
 import org.opensearch.core.common.Strings;
 import org.opensearch.core.xcontent.XContentBuilder;

client/rest-high-level/src/test/java/org/opensearch/client/IndicesRequestConvertersTests.java

@@ -79,7 +79,7 @@
 import org.opensearch.core.common.Strings;
 import org.opensearch.test.OpenSearchTestCase;
 import org.junit.Assert;
-import org.opensearch.common.unit.ByteSizeValue;
+import org.opensearch.core.common.unit.ByteSizeValue;
 
 import java.io.IOException;
 import java.util.Arrays;

client/rest-high-level/src/test/java/org/opensearch/client/SnapshotRequestConvertersTests.java

@@ -48,7 +48,7 @@
 import org.opensearch.action.support.master.AcknowledgedRequest;
 import org.opensearch.common.io.PathUtils;
 import org.opensearch.common.settings.Settings;
-import org.opensearch.common.unit.ByteSizeUnit;
+import org.opensearch.core.common.unit.ByteSizeUnit;
 import org.opensearch.repositories.fs.FsRepository;
 import org.opensearch.test.OpenSearchTestCase;
 

client/rest-high-level/src/test/java/org/opensearch/client/documentation/CRUDDocumentationIT.java

@@ -77,8 +77,8 @@
 import org.opensearch.common.Strings;
 import org.opensearch.core.common.bytes.BytesArray;
 import org.opensearch.common.settings.Settings;
-import org.opensearch.common.unit.ByteSizeUnit;
-import org.opensearch.common.unit.ByteSizeValue;
+import org.opensearch.core.common.unit.ByteSizeUnit;
+import org.opensearch.core.common.unit.ByteSizeValue;
 import org.opensearch.common.unit.TimeValue;
 import org.opensearch.core.xcontent.XContentBuilder;
 import org.opensearch.common.xcontent.XContentFactory;

client/rest-high-level/src/test/java/org/opensearch/client/documentation/ClusterClientDocumentationIT.java

@@ -63,7 +63,7 @@
 import org.opensearch.common.Priority;
 import org.opensearch.common.compress.CompressedXContent;
 import org.opensearch.common.settings.Settings;
-import org.opensearch.common.unit.ByteSizeUnit;
+import org.opensearch.core.common.unit.ByteSizeUnit;
 import org.opensearch.common.unit.TimeValue;
 import org.opensearch.common.xcontent.XContentType;
 import org.opensearch.indices.recovery.RecoverySettings;

client/rest-high-level/src/test/java/org/opensearch/client/documentation/IndicesClientDocumentationIT.java

@@ -104,8 +104,8 @@
 import org.opensearch.cluster.metadata.Template;
 import org.opensearch.common.compress.CompressedXContent;
 import org.opensearch.common.settings.Settings;
-import org.opensearch.common.unit.ByteSizeUnit;
-import org.opensearch.common.unit.ByteSizeValue;
+import org.opensearch.core.common.unit.ByteSizeUnit;
+import org.opensearch.core.common.unit.ByteSizeValue;
 import org.opensearch.common.unit.TimeValue;
 import org.opensearch.core.xcontent.XContentBuilder;
 import org.opensearch.common.xcontent.XContentFactory;

client/rest-high-level/src/test/java/org/opensearch/client/indices/DataStreamsStatsResponseTests.java

@@ -36,7 +36,7 @@
 import org.opensearch.action.admin.indices.datastream.DataStreamsStatsAction;
 import org.opensearch.core.action.support.DefaultShardOperationFailedException;
 import org.opensearch.client.AbstractResponseTestCase;
-import org.opensearch.common.unit.ByteSizeValue;
+import org.opensearch.core.common.unit.ByteSizeValue;
 import org.opensearch.core.xcontent.XContentParser;
 import org.opensearch.common.xcontent.XContentType;
 

client/rest-high-level/src/test/java/org/opensearch/client/indices/rollover/RolloverRequestTests.java

@@ -36,7 +36,7 @@
 import org.opensearch.action.admin.indices.rollover.MaxAgeCondition;
 import org.opensearch.action.admin.indices.rollover.MaxDocsCondition;
 import org.opensearch.action.admin.indices.rollover.MaxSizeCondition;
-import org.opensearch.common.unit.ByteSizeValue;
+import org.opensearch.core.common.unit.ByteSizeValue;
 import org.opensearch.common.unit.TimeValue;
 import org.opensearch.test.OpenSearchTestCase;
 

client/rest-high-level/src/test/java/org/opensearch/client/indices/rollover/RolloverResponseTests.java

@@ -36,7 +36,7 @@
 import org.opensearch.action.admin.indices.rollover.MaxAgeCondition;
 import org.opensearch.action.admin.indices.rollover.MaxDocsCondition;
 import org.opensearch.action.admin.indices.rollover.MaxSizeCondition;
-import org.opensearch.common.unit.ByteSizeValue;
+import org.opensearch.core.common.unit.ByteSizeValue;
 import org.opensearch.common.unit.TimeValue;
 import org.opensearch.core.xcontent.XContentBuilder;
 import org.opensearch.test.OpenSearchTestCase;

server/src/main/java/org/opensearch/common/component/AbstractLifecycleComponent.java → libs/common/src/main/java/org/opensearch/common/lifecycle/AbstractLifecycleComponent.java

@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.component;
+package org.opensearch.common.lifecycle;
 
 import java.io.IOException;
 import java.io.UncheckedIOException;

server/src/main/java/org/opensearch/common/component/Lifecycle.java → libs/common/src/main/java/org/opensearch/common/lifecycle/Lifecycle.java

@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.component;
+package org.opensearch.common.lifecycle;
 
 /**
  * Lifecycle state. Allows the following transitions:

server/src/main/java/org/opensearch/common/component/LifecycleComponent.java → libs/common/src/main/java/org/opensearch/common/lifecycle/LifecycleComponent.java

@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.component;
+package org.opensearch.common.lifecycle;
 
 import org.opensearch.common.lease.Releasable;
 

server/src/main/java/org/opensearch/common/component/LifecycleListener.java → libs/common/src/main/java/org/opensearch/common/lifecycle/LifecycleListener.java

@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.component;
+package org.opensearch.common.lifecycle;
 
 /**
  * Base lifecycle listener.

libs/common/src/main/java/org/opensearch/common/lifecycle/package-info.java

@@ -0,0 +1,16 @@
+/*
+ * 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.
+ */
+
+/**
+ * Foundation implementation for a object lifecycle.
+ *
+ * See {@link org.opensearch.common.lifecycle.Lifecycle} for example usage
+ *
+ * @opensearch.internal
+ */
+package org.opensearch.common.lifecycle;

libs/core/src/main/java/org/opensearch/OpenSearchException.java

@@ -118,6 +118,14 @@ public class OpenSearchException extends RuntimeException implements Writeable,
                 UNKNOWN_VERSION_ADDED
             )
         );
+        registerExceptionHandle(
+            new OpenSearchExceptionHandle(
+                org.opensearch.OpenSearchParseException.class,
+                org.opensearch.OpenSearchParseException::new,
+                35,
+                UNKNOWN_VERSION_ADDED
+            )
+        );
         registerExceptionHandle(
             new OpenSearchExceptionHandle(
                 org.opensearch.core.common.ParsingException.class,
@@ -134,6 +142,14 @@ public class OpenSearchException extends RuntimeException implements Writeable,
                 UNKNOWN_VERSION_ADDED
             )
         );
+        registerExceptionHandle(
+            new OpenSearchExceptionHandle(
+                org.opensearch.core.common.breaker.CircuitBreakingException.class,
+                org.opensearch.core.common.breaker.CircuitBreakingException::new,
+                133,
+                UNKNOWN_VERSION_ADDED
+            )
+        );
     }
 
     /**

libs/core/src/main/java/org/opensearch/core/common/Strings.java

@@ -515,4 +515,27 @@ private static String changeFirstCharacterCase(String str, boolean capitalize) {
         sb.append(str.substring(1));
         return sb.toString();
     }
+
+    /**
+     * Format the double value with a single decimal points, trimming trailing '.0'.
+     */
+    public static String format1Decimals(double value, String suffix) {
+        String p = String.valueOf(value);
+        int ix = p.indexOf('.') + 1;
+        int ex = p.indexOf('E');
+        char fraction = p.charAt(ix);
+        if (fraction == '0') {
+            if (ex != -1) {
+                return p.substring(0, ix - 1) + p.substring(ex) + suffix;
+            } else {
+                return p.substring(0, ix - 1) + suffix;
+            }
+        } else {
+            if (ex != -1) {
+                return p.substring(0, ix) + fraction + p.substring(ex) + suffix;
+            } else {
+                return p.substring(0, ix) + fraction + suffix;
+            }
+        }
+    }
 }

server/src/main/java/org/opensearch/common/breaker/CircuitBreaker.java → libs/core/src/main/java/org/opensearch/core/common/breaker/CircuitBreaker.java

@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.breaker;
+package org.opensearch.core.common.breaker;
 
 import java.util.Locale;
 

server/src/main/java/org/opensearch/common/breaker/CircuitBreakingException.java → libs/core/src/main/java/org/opensearch/core/common/breaker/CircuitBreakingException.java

@@ -29,7 +29,7 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.breaker;
+package org.opensearch.core.common.breaker;
 
 import org.opensearch.LegacyESVersion;
 import org.opensearch.OpenSearchException;

server/src/main/java/org/opensearch/common/breaker/NoopCircuitBreaker.java → libs/core/src/main/java/org/opensearch/core/common/breaker/NoopCircuitBreaker.java

@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.breaker;
+package org.opensearch.core.common.breaker;
 
 /**
  * A CircuitBreaker that doesn't increment or adjust, and all operations are

server/src/main/java/org/opensearch/common/component/package-info.java → libs/core/src/main/java/org/opensearch/core/common/breaker/package-info.java

@@ -6,5 +6,7 @@
  * compatible open source license.
  */
 
-/** Base Lifecycle Component package. */
-package org.opensearch.common.component;
+/**
+ * Foundation classes for the Circuit Breaker
+ */
+package org.opensearch.core.common.breaker;

server/src/main/java/org/opensearch/common/unit/ByteSizeUnit.java → libs/core/src/main/java/org/opensearch/core/common/unit/ByteSizeUnit.java

@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.unit;
+package org.opensearch.core.common.unit;
 
 import org.opensearch.core.common.io.stream.StreamInput;
 import org.opensearch.core.common.io.stream.StreamOutput;

server/src/main/java/org/opensearch/common/unit/ByteSizeValue.java → libs/core/src/main/java/org/opensearch/core/common/unit/ByteSizeValue.java

@@ -30,10 +30,10 @@
  * GitHub history for details.
  */
 
-package org.opensearch.common.unit;
+package org.opensearch.core.common.unit;
 
 import org.opensearch.OpenSearchParseException;
-import org.opensearch.common.Strings;
+import org.opensearch.core.common.Strings;
 import org.opensearch.core.common.io.stream.StreamInput;
 import org.opensearch.core.common.io.stream.StreamOutput;
 import org.opensearch.core.common.io.stream.Writeable;

libs/core/src/main/java/org/opensearch/core/common/unit/package-info.java

@@ -0,0 +1,16 @@
+/*
+ * 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 units of measurement used by the core library. These units of measurement classes exist
+ * in the core because they depend on core functionality beyond the common library (e.g., serializable).
+ *
+ * @opensearch.api
+ * @opensearch.experimental
+ */
+package org.opensearch.core.common.unit;

server/src/main/java/org/opensearch/indices/breaker/AllCircuitBreakerStats.java → libs/core/src/main/java/org/opensearch/core/indices/breaker/AllCircuitBreakerStats.java

@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-package org.opensearch.indices.breaker;
+package org.opensearch.core.indices.breaker;
 
 import org.opensearch.core.common.io.stream.StreamInput;
 import org.opensearch.core.common.io.stream.StreamOutput;

server/src/main/java/org/opensearch/indices/breaker/CircuitBreakerService.java → libs/core/src/main/java/org/opensearch/core/indices/breaker/CircuitBreakerService.java

@@ -30,12 +30,12 @@
  * GitHub history for details.
  */
 
-package org.opensearch.indices.breaker;
+package org.opensearch.core.indices.breaker;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
-import org.opensearch.common.breaker.CircuitBreaker;
-import org.opensearch.common.component.AbstractLifecycleComponent;
+import org.opensearch.common.lifecycle.AbstractLifecycleComponent;
+import org.opensearch.core.common.breaker.CircuitBreaker;
 
 /**
  * Interface for Circuit Breaker services, which provide breakers to classes