fixup: javadoc, naming, and log improvements

Signed-off-by: Simon Schrottner <[email protected]>

Author: aepfli

providers/flagd/src/main/java/dev/openfeature/contrib/providers/flagd/FlagdProvider.java

@@ -43,17 +43,19 @@ public class FlagdProvider extends EventProvider {
     private volatile ProviderEvent previousEvent = null;
 
     /**
-     * An executor service responsible for scheduling reconnection attempts.
+     * An executor service responsible for emitting {@link ProviderEvent#PROVIDER_ERROR} after the provider went
+     * {@link ProviderEvent#PROVIDER_STALE} for {@link #gracePeriod} seconds.
      */
-    private final ScheduledExecutorService reconnectExecutor;
+    private final ScheduledExecutorService errorExecutor;
 
     /**
-     * A scheduled task for managing reconnection attempts.
+     * A scheduled task for emitting {@link ProviderEvent#PROVIDER_ERROR}.
      */
     private ScheduledFuture<?> reconnectTask;
 
     /**
-     * The grace period in milliseconds to wait for reconnection before emitting an error event.
+     * The grace period in milliseconds to wait after {@link ProviderEvent#PROVIDER_STALE} before emitting a
+     * {@link ProviderEvent#PROVIDER_ERROR}.
      */
     private final long gracePeriod;
     /**
@@ -92,7 +94,7 @@ public FlagdProvider(final FlagdOptions options) {
         }
         hooks.add(new SyncMetadataHook(this::getEnrichedContext));
         contextEnricher = options.getContextEnricher();
-        this.reconnectExecutor = Executors.newSingleThreadScheduledExecutor();
+        this.errorExecutor = Executors.newSingleThreadScheduledExecutor();
         this.gracePeriod = options.getRetryGracePeriod();
         this.deadline = options.getDeadline();
     }
@@ -122,9 +124,9 @@ public synchronized void shutdown() {
         }
         try {
             this.flagResolver.shutdown();
-            if (reconnectExecutor != null) {
-                reconnectExecutor.shutdownNow();
-                reconnectExecutor.awaitTermination(deadline, TimeUnit.MILLISECONDS);
+            if (errorExecutor != null) {
+                errorExecutor.shutdownNow();
+                errorExecutor.awaitTermination(deadline, TimeUnit.MILLISECONDS);
             }
         } catch (Exception e) {
             log.error("Error during shutdown {}", FLAGD_PROVIDER, e);
@@ -242,8 +244,8 @@ private void onError() {
             reconnectTask.cancel(false);
         }
 
-        if (!reconnectExecutor.isShutdown()) {
-            reconnectTask = reconnectExecutor.schedule(
+        if (!errorExecutor.isShutdown()) {
+            reconnectTask = errorExecutor.schedule(
                     () -> {
                         log.debug(
                                 "Provider did not reconnect successfully within {}s. Emit ERROR event...", gracePeriod);

providers/flagd/src/main/java/dev/openfeature/contrib/providers/flagd/resolver/common/ChannelMonitor.java

@@ -32,7 +32,7 @@ public static void monitorChannelState(
             Runnable onConnectionLost) {
         channel.notifyWhenStateChanged(expectedState, () -> {
             ConnectivityState currentState = channel.getState(true);
-            // log.info("Channel state changed to: {}", currentState);
+            log.debug("Channel state changed to: {}", currentState);
             if (currentState == ConnectivityState.READY) {
                 if (onConnectionReady != null) {
                     onConnectionReady.run();

providers/flagd/src/test/java/dev/openfeature/contrib/providers/flagd/e2e/steps/ProviderSteps.java

@@ -2,7 +2,6 @@
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.ObjectReader;
-import com.google.gson.JsonObject;
 import dev.openfeature.contrib.providers.flagd.Config;
 import dev.openfeature.contrib.providers.flagd.FlagdProvider;
 import dev.openfeature.contrib.providers.flagd.e2e.FlagdContainer;