Separate internal-only APIs from public API by package (#83)

* Separate internal-only APIs from public API by package

* (fixup) move TaskMetadata, LoggingContext to the root package

benchmark/src/main/java/com/linecorp/decaton/benchmark/DecatonRunner.java

@@ -26,13 +26,13 @@
 
 import org.apache.kafka.clients.consumer.ConsumerConfig;
 
-import com.linecorp.decaton.processor.DecatonTask;
-import com.linecorp.decaton.processor.ProcessorProperties;
-import com.linecorp.decaton.processor.ProcessorsBuilder;
-import com.linecorp.decaton.processor.Property;
-import com.linecorp.decaton.processor.StaticPropertySupplier;
-import com.linecorp.decaton.processor.SubscriptionStateListener;
-import com.linecorp.decaton.processor.TaskExtractor;
+import com.linecorp.decaton.processor.runtime.DecatonTask;
+import com.linecorp.decaton.processor.runtime.ProcessorProperties;
+import com.linecorp.decaton.processor.runtime.ProcessorsBuilder;
+import com.linecorp.decaton.processor.runtime.Property;
+import com.linecorp.decaton.processor.runtime.StaticPropertySupplier;
+import com.linecorp.decaton.processor.runtime.SubscriptionStateListener;
+import com.linecorp.decaton.processor.runtime.TaskExtractor;
 import com.linecorp.decaton.processor.TaskMetadata;
 import com.linecorp.decaton.processor.runtime.ProcessorScope;
 import com.linecorp.decaton.processor.runtime.ProcessorSubscription;

brave/src/main/java/com/linecorp/decaton/processor/runtime/BraveProcessorTraceHandle.java

@@ -16,7 +16,7 @@
 
 package com.linecorp.decaton.processor.runtime;
 
-import com.linecorp.decaton.processor.TracingProvider.ProcessorTraceHandle;
+import com.linecorp.decaton.processor.tracing.TracingProvider.ProcessorTraceHandle;
 
 import brave.Span;
 import brave.messaging.MessagingTracing;

brave/src/main/java/com/linecorp/decaton/processor/runtime/BraveRecordTraceHandle.java

@@ -17,7 +17,7 @@
 package com.linecorp.decaton.processor.runtime;
 
 import com.linecorp.decaton.processor.DecatonProcessor;
-import com.linecorp.decaton.processor.TracingProvider.RecordTraceHandle;
+import com.linecorp.decaton.processor.tracing.TracingProvider.RecordTraceHandle;
 
 import brave.Span;
 import brave.messaging.MessagingTracing;

brave/src/main/java/com/linecorp/decaton/processor/runtime/BraveTraceHandle.java

@@ -16,7 +16,7 @@
 
 package com.linecorp.decaton.processor.runtime;
 
-import com.linecorp.decaton.processor.TracingProvider.TraceHandle;
+import com.linecorp.decaton.processor.tracing.TracingProvider.TraceHandle;
 
 import brave.Span;
 import brave.messaging.MessagingTracing;

brave/src/main/java/com/linecorp/decaton/processor/runtime/BraveTracingProvider.java

@@ -19,7 +19,7 @@
 
 import org.apache.kafka.clients.consumer.ConsumerRecord;
 
-import com.linecorp.decaton.processor.TracingProvider;
+import com.linecorp.decaton.processor.tracing.TracingProvider;
 
 import brave.kafka.clients.KafkaTracing;
 

centraldogma/src/main/java/com/linecorp/decaton/centraldogma/CentralDogmaPropertySupplier.java

@@ -39,11 +39,11 @@
 import com.linecorp.centraldogma.common.EntryType;
 import com.linecorp.centraldogma.common.Query;
 import com.linecorp.centraldogma.common.Revision;
-import com.linecorp.decaton.processor.DynamicProperty;
-import com.linecorp.decaton.processor.ProcessorProperties;
-import com.linecorp.decaton.processor.Property;
-import com.linecorp.decaton.processor.PropertyDefinition;
-import com.linecorp.decaton.processor.PropertySupplier;
+import com.linecorp.decaton.processor.runtime.DynamicProperty;
+import com.linecorp.decaton.processor.runtime.ProcessorProperties;
+import com.linecorp.decaton.processor.runtime.Property;
+import com.linecorp.decaton.processor.runtime.PropertyDefinition;
+import com.linecorp.decaton.processor.runtime.PropertySupplier;
 
 /**
  * A {@link PropertySupplier} implementation with Central Dogma backend.

centraldogma/src/test/java/com/linecorp/decaton/centraldogma/CentralDogmaPropertySupplierTest.java

@@ -62,9 +62,9 @@
 import com.linecorp.centraldogma.common.Revision;
 import com.linecorp.centraldogma.internal.Jackson;
 import com.linecorp.centraldogma.testing.CentralDogmaRule;
-import com.linecorp.decaton.processor.DynamicProperty;
-import com.linecorp.decaton.processor.Property;
-import com.linecorp.decaton.processor.PropertyDefinition;
+import com.linecorp.decaton.processor.runtime.DynamicProperty;
+import com.linecorp.decaton.processor.runtime.Property;
+import com.linecorp.decaton.processor.runtime.PropertyDefinition;
 
 public class CentralDogmaPropertySupplierTest {
     @Rule

client/src/main/java/com/linecorp/decaton/client/DecatonClientBuilder.java

@@ -25,6 +25,7 @@
 import org.apache.kafka.clients.producer.KafkaProducer;
 import org.apache.kafka.clients.producer.Producer;
 
+import com.linecorp.decaton.client.internal.DecatonClientImpl;
 import com.linecorp.decaton.client.kafka.PrintableAsciiStringSerializer;
 import com.linecorp.decaton.client.kafka.ProtocolBuffersKafkaSerializer;
 import com.linecorp.decaton.common.Serializer;

client/src/main/java/com/linecorp/decaton/client/KafkaProducerSupplier.java

@@ -20,6 +20,7 @@
 
 import org.apache.kafka.clients.producer.Producer;
 
+import com.linecorp.decaton.client.internal.DecatonClientImpl;
 import com.linecorp.decaton.protocol.Decaton.DecatonTaskRequest;
 
 /**

client/src/main/java/com/linecorp/decaton/client/PutTaskResult.java

@@ -28,7 +28,7 @@ public PutTaskResult(String id) {
         this.id = id;
     }
 
-    PutTaskResult(RecordMetadata metadata) {
+    public PutTaskResult(RecordMetadata metadata) {
         this(metadataToTaskId(metadata));
     }
 

client/src/main/java/com/linecorp/decaton/client/DecatonClientImpl.java → client/src/main/java/com/linecorp/decaton/client/internal/DecatonClientImpl.java

@@ -14,7 +14,7 @@
  * under the License.
  */
 
-package com.linecorp.decaton.client;
+package com.linecorp.decaton.client.internal;
 
 import java.util.Properties;
 import java.util.concurrent.CompletableFuture;
@@ -23,6 +23,9 @@
 
 import com.google.protobuf.ByteString;
 
+import com.linecorp.decaton.client.DecatonClient;
+import com.linecorp.decaton.client.KafkaProducerSupplier;
+import com.linecorp.decaton.client.PutTaskResult;
 import com.linecorp.decaton.common.Serializer;
 import com.linecorp.decaton.protocol.Decaton.DecatonTaskRequest;
 import com.linecorp.decaton.protocol.Decaton.TaskMetadataProto;

client/src/main/java/com/linecorp/decaton/client/DecatonTaskProducer.java → client/src/main/java/com/linecorp/decaton/client/internal/DecatonTaskProducer.java

@@ -14,7 +14,7 @@
  * under the License.
  */
 
-package com.linecorp.decaton.client;
+package com.linecorp.decaton.client.internal;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -26,6 +26,9 @@
 import org.apache.kafka.clients.producer.ProducerConfig;
 import org.apache.kafka.clients.producer.ProducerRecord;
 
+import com.linecorp.decaton.client.DecatonClient;
+import com.linecorp.decaton.client.KafkaProducerSupplier;
+import com.linecorp.decaton.client.PutTaskResult;
 import com.linecorp.decaton.protocol.Decaton.DecatonTaskRequest;
 import com.linecorp.decaton.protocol.Decaton.TaskMetadataProto;
 

client/src/test/java/com/linecorp/decaton/client/DecatonClientImplTest.java → client/src/test/java/com/linecorp/decaton/client/internal/DecatonClientImplTest.java

@@ -14,7 +14,7 @@
  * under the License.
  */
 
-package com.linecorp.decaton.client;
+package com.linecorp.decaton.client.internal;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
@@ -40,6 +40,7 @@
 import org.mockito.junit.MockitoRule;
 
 import com.linecorp.decaton.client.DecatonClient.TaskMetadata;
+import com.linecorp.decaton.client.internal.DecatonClientImpl;
 import com.linecorp.decaton.protobuf.ProtocolBuffersSerializer;
 import com.linecorp.decaton.protocol.Decaton.DecatonTaskRequest;
 import com.linecorp.decaton.protocol.Sample.HelloTask;

processor/src/it/java/com/linecorp/decaton/processor/CoreFunctionalityTest.java

@@ -30,7 +30,10 @@
 import org.junit.Rule;
 import org.junit.Test;
 
+import com.linecorp.decaton.processor.runtime.ProcessorProperties;
 import com.linecorp.decaton.processor.runtime.ProcessorScope;
+import com.linecorp.decaton.processor.runtime.Property;
+import com.linecorp.decaton.processor.runtime.StaticPropertySupplier;
 import com.linecorp.decaton.testing.KafkaClusterRule;
 import com.linecorp.decaton.testing.RandomRule;
 import com.linecorp.decaton.testing.processor.ProcessedRecord;

processor/src/it/java/com/linecorp/decaton/processor/RateLimiterTest.java

@@ -29,7 +29,11 @@
 import org.junit.Test;
 
 import com.linecorp.decaton.client.DecatonClient;
+import com.linecorp.decaton.processor.runtime.DynamicProperty;
+import com.linecorp.decaton.processor.runtime.ProcessorProperties;
 import com.linecorp.decaton.processor.runtime.ProcessorSubscription;
+import com.linecorp.decaton.processor.runtime.ProcessorsBuilder;
+import com.linecorp.decaton.processor.runtime.StaticPropertySupplier;
 import com.linecorp.decaton.protobuf.ProtocolBuffersDeserializer;
 import com.linecorp.decaton.protocol.Sample.HelloTask;
 import com.linecorp.decaton.testing.KafkaClusterRule;

processor/src/it/java/com/linecorp/decaton/processor/SubscriptionStateTest.java

@@ -30,7 +30,7 @@
 import org.junit.ClassRule;
 import org.junit.Test;
 
-import com.linecorp.decaton.processor.SubscriptionStateListener.State;
+import com.linecorp.decaton.processor.runtime.SubscriptionStateListener.State;
 import com.linecorp.decaton.testing.KafkaClusterRule;
 import com.linecorp.decaton.testing.processor.ProcessorTestSuite;
 

processor/src/it/java/com/linecorp/decaton/processor/TracingTest.java

@@ -32,6 +32,7 @@
 
 import com.linecorp.decaton.client.DecatonClientBuilder.DefaultKafkaProducerSupplier;
 import com.linecorp.decaton.processor.runtime.RetryConfig;
+import com.linecorp.decaton.processor.tracing.TestTracingProvider;
 import com.linecorp.decaton.testing.KafkaClusterRule;
 import com.linecorp.decaton.testing.processor.ProcessedRecord;
 import com.linecorp.decaton.testing.processor.ProcessingGuarantee;

processor/src/it/java/com/linecorp/decaton/processor/metrics/MetricsTest.java

@@ -36,10 +36,10 @@
 import com.linecorp.decaton.client.kafka.PrintableAsciiStringSerializer;
 import com.linecorp.decaton.client.kafka.ProtocolBuffersKafkaSerializer;
 import com.linecorp.decaton.processor.DecatonProcessor;
-import com.linecorp.decaton.processor.ProcessorProperties;
-import com.linecorp.decaton.processor.ProcessorsBuilder;
-import com.linecorp.decaton.processor.Property;
-import com.linecorp.decaton.processor.StaticPropertySupplier;
+import com.linecorp.decaton.processor.runtime.ProcessorProperties;
+import com.linecorp.decaton.processor.runtime.ProcessorsBuilder;
+import com.linecorp.decaton.processor.runtime.Property;
+import com.linecorp.decaton.processor.runtime.StaticPropertySupplier;
 import com.linecorp.decaton.processor.runtime.ProcessorSubscription;
 import com.linecorp.decaton.protobuf.ProtocolBuffersDeserializer;
 import com.linecorp.decaton.protocol.Decaton.DecatonTaskRequest;

processor/src/jmh/java/com/linecorp/decaton/processor/runtime/OutOfOrderCommitControlBenchmark.java

@@ -35,7 +35,7 @@
 import org.openjdk.jmh.annotations.Warmup;
 
 import com.linecorp.decaton.processor.DeferredCompletion;
-import com.linecorp.decaton.processor.ProcessorProperties;
+import com.linecorp.decaton.processor.runtime.internal.OutOfOrderCommitControl;
 
 /**
  * Benchmark performance of {@link OutOfOrderCommitControl}.

processor/src/main/java/com/linecorp/decaton/processor/runtime/LoggingContext.java → processor/src/main/java/com/linecorp/decaton/processor/LoggingContext.java

@@ -14,12 +14,11 @@
  * under the License.
  */
 
-package com.linecorp.decaton.processor.runtime;
+package com.linecorp.decaton.processor;
 
 import org.slf4j.MDC;
 
-import com.linecorp.decaton.processor.ProcessingContext;
-import com.linecorp.decaton.processor.TaskMetadata;
+import com.linecorp.decaton.processor.runtime.internal.TaskRequest;
 
 /**
  * The {@link LoggingContext} class allows users to write logs lines

processor/src/main/java/com/linecorp/decaton/processor/ProcessingContext.java

@@ -21,8 +21,6 @@
 import org.apache.kafka.clients.consumer.ConsumerRecord;
 import org.apache.kafka.common.header.Headers;
 
-import com.linecorp.decaton.processor.runtime.LoggingContext;
-
 public interface ProcessingContext<T> {
     /**
      * Returns a {@link TaskMetadata} which is associated with the task that is currently being processed.

processor/src/main/java/com/linecorp/decaton/processor/metrics/Metrics.java

@@ -25,6 +25,8 @@
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.function.Supplier;
 
+import com.linecorp.decaton.processor.metrics.internal.AvailableTags;
+
 import io.micrometer.core.instrument.Counter;
 import io.micrometer.core.instrument.Gauge;
 import io.micrometer.core.instrument.Meter;

processor/src/main/java/com/linecorp/decaton/processor/metrics/AvailableTags.java → processor/src/main/java/com/linecorp/decaton/processor/metrics/internal/AvailableTags.java

@@ -14,20 +14,22 @@
  * under the License.
  */
 
-package com.linecorp.decaton.processor.metrics;
+package com.linecorp.decaton.processor.metrics.internal;
 
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.stream.Collectors;
 
+import com.linecorp.decaton.processor.metrics.Metrics;
+
 import io.micrometer.core.instrument.Tag;
 import io.micrometer.core.instrument.Tags;
 
 /**
  * Holds all available key values in the context at the instantiation of {@link Metrics}.
  */
-class AvailableTags {
+public class AvailableTags {
     private final Map<String, String> tags;
 
     private AvailableTags(String[] keyValues) {

processor/src/main/java/com/linecorp/decaton/processor/runtime/CompactionProcessor.java → processor/src/main/java/com/linecorp/decaton/processor/processors/CompactionProcessor.java

@@ -14,7 +14,7 @@
  * under the License.
  */
 
-package com.linecorp.decaton.processor.runtime;
+package com.linecorp.decaton.processor.processors;
 
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;

processor/src/main/java/com/linecorp/decaton/processor/DecatonTask.java → processor/src/main/java/com/linecorp/decaton/processor/runtime/DecatonTask.java

@@ -14,7 +14,9 @@
  * under the License.
  */
 
-package com.linecorp.decaton.processor;
+package com.linecorp.decaton.processor.runtime;
+
+import com.linecorp.decaton.processor.TaskMetadata;
 
 import lombok.Value;
 import lombok.experimental.Accessors;

processor/src/main/java/com/linecorp/decaton/processor/DynamicProperty.java → processor/src/main/java/com/linecorp/decaton/processor/runtime/DynamicProperty.java

@@ -14,13 +14,15 @@
  * under the License.
  */
 
-package com.linecorp.decaton.processor;
+package com.linecorp.decaton.processor.runtime;
 
 import java.util.function.BiConsumer;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.linecorp.decaton.processor.runtime.internal.AbstractProperty;
+
 /**
  * A {@link Property} implementation which holds dynamically changeable value.
  * @param <T> type of the property value.