remove appconfig in favor of S3ObjectMonitor

service/src/test/java/org/whispersystems/textsecuregcm/configuration/LocalDynamicConfigurationManagerFactory.java

@@ -1,108 +0,0 @@
-/*
- * Copyright 2024 Signal Messenger, LLC
- * SPDX-License-Identifier: AGPL-3.0-only
- */
-
-package org.whispersystems.textsecuregcm.configuration;
-
-import com.fasterxml.jackson.annotation.JsonProperty;
-import com.fasterxml.jackson.annotation.JsonTypeName;
-import com.fasterxml.jackson.core.JsonProcessingException;
-
-import java.io.File;
-import java.io.IOException;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.nio.file.attribute.BasicFileAttributes;
-import java.time.Instant;
-import java.util.concurrent.ScheduledExecutorService;
-import javax.validation.constraints.NotBlank;
-import javax.validation.constraints.NotEmpty;
-
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.whispersystems.textsecuregcm.storage.DynamicConfigurationManager;
-
-import io.dropwizard.util.Resources;
-import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider;
-
-@JsonTypeName("local")
-public class LocalDynamicConfigurationManagerFactory implements DynamicConfigurationManagerFactory {
-
-  @JsonProperty
-  @NotEmpty
-  private String application;
-
-  @JsonProperty
-  @NotEmpty
-  private String environment;
-
-  @JsonProperty
-  @NotEmpty
-  private String configuration;
-
-  @JsonProperty
-  @NotBlank
-  private String configPath;
-
-  @Override
-  public <T> DynamicConfigurationManager<T> build(final Class<T> klazz,
-      final ScheduledExecutorService scheduledExecutorService, final AwsCredentialsProvider awsCredentialsProvider) {
-
-    return new LocalDynamicConfigurationManager<>(configPath, application, environment, configuration,
-        awsCredentialsProvider, klazz, scheduledExecutorService);
-  }
-
-  private static class LocalDynamicConfigurationManager<T> extends DynamicConfigurationManager<T> {
-
-    private static final Logger logger = LoggerFactory.getLogger(DynamicConfigurationManager.class);
-
-    private final Path configPath;
-    private final Class<T> configurationClass;
-    private T cachedConfig;
-    private final Instant lastConfigLoadedTime;
-
-    public LocalDynamicConfigurationManager(final String configPath, final String application, final String environment,
-        final String configurationName, final AwsCredentialsProvider awsCredentialsProvider,
-        final Class<T> configurationClass, final ScheduledExecutorService scheduledExecutorService) {
-
-      super(application, environment, configurationName, awsCredentialsProvider, configurationClass,
-          scheduledExecutorService);
-
-      this.configPath = Path.of(Resources.getResource("config").getPath()).resolve(configPath);
-      this.configurationClass = configurationClass;
-      this.cachedConfig = null;
-      this.lastConfigLoadedTime = null;
-      maybeUpdateConfig();
-      if (cachedConfig == null) {
-        throw new IllegalArgumentException("failed to load initial config");
-      }
-    }
-
-    @Override
-    public T getConfiguration() {
-      maybeUpdateConfig();
-      return cachedConfig;
-    }
-
-    @Override
-    public void start() {
-      // do nothing
-    }
-
-    private synchronized void maybeUpdateConfig() {
-      try {
-        if (lastConfigLoadedTime != null &&
-            !lastConfigLoadedTime.isBefore(Files.readAttributes(configPath, BasicFileAttributes.class).lastModifiedTime().toInstant())) {
-          return;
-        }
-        String configContents = Files.readString(configPath);
-        parseConfiguration(configContents, configurationClass).ifPresent(config -> cachedConfig = config);
-      } catch (Exception e) {
-        logger.warn("Failed to update configuration", e);
-      }
-    }
-
-  }
-
-}

service/src/test/java/org/whispersystems/textsecuregcm/configuration/StaticS3ObjectMonitorFactory.java

@@ -18,7 +18,7 @@ import java.util.function.Consumer;
 public class StaticS3ObjectMonitorFactory implements S3ObjectMonitorFactory {
 
   @JsonProperty
-  private byte[] object = new byte[0];
+  private String object = "";
 
   @Override
   public S3ObjectMonitor build(final AwsCredentialsProvider awsCredentialsProvider,
@@ -28,9 +28,9 @@ public class StaticS3ObjectMonitorFactory implements S3ObjectMonitorFactory {
 
   private static class StaticS3ObjectMonitor extends S3ObjectMonitor {
 
-    private final byte[] object;
+    private final String object;
 
-    public StaticS3ObjectMonitor(final byte[] object, final AwsCredentialsProvider awsCredentialsProvider) {
+    public StaticS3ObjectMonitor(final String object, final AwsCredentialsProvider awsCredentialsProvider) {
       super(awsCredentialsProvider, "local-test-region", "test-bucket", null, 0L, null, null);
 
       this.object = object;
@@ -38,7 +38,7 @@ public class StaticS3ObjectMonitorFactory implements S3ObjectMonitorFactory {
 
     @Override
     public synchronized void start(final Consumer<InputStream> changeListener) {
-      changeListener.accept(new ByteArrayInputStream(object));
+      changeListener.accept(new ByteArrayInputStream(object.getBytes()));
     }
   }
 }

service/src/test/java/org/whispersystems/textsecuregcm/storage/DynamicConfigurationManagerTest.java

@@ -2,75 +2,51 @@ package org.whispersystems.textsecuregcm.storage;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertTimeoutPreemptively;
+import static org.mockito.Mockito.any;
+import static org.mockito.Mockito.doAnswer;
 import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.when;
 
+import java.io.ByteArrayInputStream;
+import java.io.InputStream;
 import java.time.Duration;
-import java.util.concurrent.ScheduledExecutorService;
-import java.util.concurrent.ScheduledThreadPoolExecutor;
-import org.junit.jupiter.api.AfterEach;
+import java.util.concurrent.BrokenBarrierException;
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.CyclicBarrier;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.function.Consumer;
+
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.mockito.AdditionalAnswers;
 import org.whispersystems.textsecuregcm.configuration.dynamic.DynamicConfiguration;
-import software.amazon.awssdk.core.SdkBytes;
-import software.amazon.awssdk.services.appconfigdata.AppConfigDataClient;
-import software.amazon.awssdk.services.appconfigdata.model.GetLatestConfigurationRequest;
-import software.amazon.awssdk.services.appconfigdata.model.GetLatestConfigurationResponse;
-import software.amazon.awssdk.services.appconfigdata.model.StartConfigurationSessionRequest;
-import software.amazon.awssdk.services.appconfigdata.model.StartConfigurationSessionResponse;
+import org.whispersystems.textsecuregcm.s3.S3ObjectMonitor;
 
 class DynamicConfigurationManagerTest {
 
-  private static final SdkBytes VALID_CONFIG = SdkBytes.fromUtf8String("""
-      test: true
-      captcha:
-        scoreFloor: 1.0
-      """);
+  private static final byte[] VALID_CONFIG = """
+    test: true
+    captcha:
+      scoreFloor: 1.0
+    """.getBytes();
+  private static final ExecutorService BACKGROUND_THREAD = Executors.newSingleThreadExecutor();
 
   private DynamicConfigurationManager<DynamicConfiguration> dynamicConfigurationManager;
-  private AppConfigDataClient appConfig;
-  private StartConfigurationSessionRequest startConfigurationSession;
-  private final ScheduledExecutorService scheduledExecutorService = new ScheduledThreadPoolExecutor(1);
+  private S3ObjectMonitor configMonitor;
 
   @BeforeEach
   void setup() {
-    this.appConfig = mock(AppConfigDataClient.class);
-    this.dynamicConfigurationManager = new DynamicConfigurationManager<>(
-        appConfig, "foo", "bar", "baz", DynamicConfiguration.class, scheduledExecutorService);
-    this.startConfigurationSession = StartConfigurationSessionRequest.builder()
-        .applicationIdentifier("foo")
-        .environmentIdentifier("bar")
-        .configurationProfileIdentifier("baz")
-        .build();
-  }
-
-  @AfterEach
-  void teardown() {
-    scheduledExecutorService.shutdown();
+    this.configMonitor = mock(S3ObjectMonitor.class);
+    this.dynamicConfigurationManager = new DynamicConfigurationManager<>(configMonitor, DynamicConfiguration.class);
   }
 
   @Test
   void testGetInitialConfig() {
-    when(appConfig.startConfigurationSession(startConfigurationSession))
-        .thenReturn(StartConfigurationSessionResponse.builder()
-            .initialConfigurationToken("initial")
-            .build());
+    // supply real config on start, then never send updates
+    doAnswer(AdditionalAnswers.<Consumer<InputStream>>answerVoid(cb -> cb.accept(new ByteArrayInputStream(VALID_CONFIG))))
+        .when(configMonitor).start(any());
 
-    // call with initial token will return a real config
-    when(appConfig.getLatestConfiguration(GetLatestConfigurationRequest.builder()
-        .configurationToken("initial").build()))
-        .thenReturn(GetLatestConfigurationResponse.builder()
-            .configuration(VALID_CONFIG)
-            .nextPollConfigurationToken("next").build());
-
-    // subsequent config calls will return empty (no update)
-    when(appConfig.getLatestConfiguration(GetLatestConfigurationRequest.builder().
-        configurationToken("next").build()))
-        .thenReturn(GetLatestConfigurationResponse.builder()
-            .configuration(SdkBytes.fromUtf8String(""))
-            .nextPollConfigurationToken("next").build());
-
-    assertTimeoutPreemptively(Duration.ofSeconds(5), () -> {
+    assertTimeoutPreemptively(Duration.ofSeconds(1), () -> {
       dynamicConfigurationManager.start();
       assertThat(dynamicConfigurationManager.getConfiguration()).isNotNull();
     });
@@ -78,84 +54,55 @@ class DynamicConfigurationManagerTest {
 
   @Test
   void testBadConfig() {
-    when(appConfig.startConfigurationSession(startConfigurationSession))
-        .thenReturn(StartConfigurationSessionResponse.builder()
-            .initialConfigurationToken("initial")
-            .build());
+    // supply a bad config, then wait for the test to signal, then supply a good config
+    doAnswer(AdditionalAnswers.<Consumer<InputStream>>answerVoid(cb -> {
+              cb.accept(new ByteArrayInputStream("zzz".getBytes()));
+              BACKGROUND_THREAD.submit(() -> cb.accept(new ByteArrayInputStream(VALID_CONFIG)));
+            })).when(configMonitor).start(any());
 
-    // call with initial token will return a bad config
-    when(appConfig.getLatestConfiguration(GetLatestConfigurationRequest.builder()
-        .configurationToken("initial").build()))
-        .thenReturn(GetLatestConfigurationResponse.builder()
-            .configuration(SdkBytes.fromUtf8String("zzz"))
-            .nextPollConfigurationToken("goodconfig").build());
-
-    // next config call will return a good config
-    when(appConfig.getLatestConfiguration(GetLatestConfigurationRequest.builder().
-        configurationToken("goodconfig").build()))
-        .thenReturn(GetLatestConfigurationResponse.builder()
-            .configuration(VALID_CONFIG)
-            .nextPollConfigurationToken("next").build());
-
-    // all subsequent config calls will return an empty config (no update)
-    when(appConfig.getLatestConfiguration(GetLatestConfigurationRequest.builder().
-        configurationToken("next").build()))
-        .thenReturn(GetLatestConfigurationResponse.builder()
-            .configuration(SdkBytes.fromUtf8String(""))
-            .nextPollConfigurationToken("next").build());
-
-    assertTimeoutPreemptively(Duration.ofSeconds(5), () -> {
-      dynamicConfigurationManager.start();
-      assertThat(dynamicConfigurationManager.getConfiguration()).isNotNull();
+    assertTimeoutPreemptively(Duration.ofSeconds(1), () -> {
+          dynamicConfigurationManager.start();
+          assertThat(dynamicConfigurationManager.getConfiguration()).isNotNull();
     });
   }
 
   @Test
   void testGetConfigMultiple() {
-    when(appConfig.startConfigurationSession(startConfigurationSession))
-        .thenReturn(StartConfigurationSessionResponse.builder()
-            .initialConfigurationToken("0")
-            .build());
-
-    // initial config
-    when(appConfig.getLatestConfiguration(GetLatestConfigurationRequest.builder().
-        configurationToken("0").build()))
-        .thenReturn(GetLatestConfigurationResponse.builder()
-            .configuration(VALID_CONFIG)
-            .nextPollConfigurationToken("1").build());
-
-    // config update with a real config
-    when(appConfig.getLatestConfiguration(GetLatestConfigurationRequest.builder().
-        configurationToken("1").build()))
-        .thenReturn(GetLatestConfigurationResponse.builder()
-            .configuration(SdkBytes.fromUtf8String("""
-                experiments:
-                  test:
-                    enrollmentPercentage: 50
-                captcha:
-                  scoreFloor: 1.0
-                """))
-            .nextPollConfigurationToken("2").build());
-
-    // all subsequent are no update
-    when(appConfig.getLatestConfiguration(GetLatestConfigurationRequest.builder().
-        configurationToken("2").build()))
-        .thenReturn(GetLatestConfigurationResponse.builder()
-            .configuration(SdkBytes.fromUtf8String(""))
-            .nextPollConfigurationToken("2").build());
+    final CyclicBarrier barrier = new CyclicBarrier(2);
+    // supply an initial config, wait for the test to signal, then supply a distinct good config
+    doAnswer(AdditionalAnswers.<Consumer<InputStream>>answerVoid(cb -> {
+              cb.accept(new ByteArrayInputStream(VALID_CONFIG));
+              BACKGROUND_THREAD.submit(() -> {
+                    try {
+                      barrier.await(); // wait for initial config to be consumed
+                      cb.accept(
+                          new ByteArrayInputStream("""
+                              experiments:
+                                test:
+                                  enrollmentPercentage: 50
+                              captcha:
+                                scoreFloor: 1.0
+                              """.getBytes()));
+                      barrier.await(); // signal availability of new config
+                    } catch (InterruptedException | BrokenBarrierException e) {}
+                  });
+            })).when(configMonitor).start(any());
 
     // the internal waiting done by dynamic configuration manager catches the InterruptedException used
     // by JUnit’s @Timeout, so we use assertTimeoutPreemptively
-    assertTimeoutPreemptively(Duration.ofSeconds(5), () -> {
-      // we should eventually get the updated config (or the test will timeout)
+    assertTimeoutPreemptively(Duration.ofSeconds(1), () -> {
       dynamicConfigurationManager.start();
-      while (dynamicConfigurationManager.getConfiguration().getExperimentEnrollmentConfiguration("test").isEmpty()) {
-        Thread.sleep(100);
-      }
-      assertThat(
-          dynamicConfigurationManager.getConfiguration().getExperimentEnrollmentConfiguration("test").get()
-              .getEnrollmentPercentage()).isEqualTo(50);
+      DynamicConfiguration config = dynamicConfigurationManager.getConfiguration();
+      assertThat(config).isNotNull();
+      assertThat(config.getExperimentEnrollmentConfiguration("test")).isEmpty();
+      barrier.await();          // signal consumption of initial config
+      barrier.await();          // wait for availability of new config
+      config = dynamicConfigurationManager.getConfiguration();
+      assertThat(config).isNotNull();
+      assertThat(config.getExperimentEnrollmentConfiguration("test")).isNotEmpty();
+      assertThat(config.getExperimentEnrollmentConfiguration("test").get().getEnrollmentPercentage())
+          .isEqualTo(50);
     });
-
   }
+
 }