Add support for server-side feature flags

2026-04-22 23:28:04 +01:00 · 2020-08-26 20:27:33 -04:00
parent b9df028bfb
commit 1ef3546822
12 changed files with 511 additions and 2 deletions
--- a/service/src/test/java/org/whispersystems/textsecuregcm/controllers/FeatureFlagsControllerTest.java
+++ b/service/src/test/java/org/whispersystems/textsecuregcm/controllers/FeatureFlagsControllerTest.java
@@ -0,0 +1,116 @@
+package org.whispersystems.textsecuregcm.controllers;
+
+import com.google.common.collect.ImmutableSet;
+import io.dropwizard.auth.PolymorphicAuthValueFactoryProvider;
+import io.dropwizard.testing.junit.ResourceTestRule;
+import junitparams.JUnitParamsRunner;
+import junitparams.Parameters;
+import org.glassfish.jersey.test.grizzly.GrizzlyWebTestContainerFactory;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.whispersystems.textsecuregcm.auth.DisabledPermittedAccount;
+import org.whispersystems.textsecuregcm.mappers.DeviceLimitExceededExceptionMapper;
+import org.whispersystems.textsecuregcm.storage.Account;
+import org.whispersystems.textsecuregcm.storage.FeatureFlagsManager;
+import org.whispersystems.textsecuregcm.tests.util.AuthHelper;
+
+import javax.ws.rs.client.Entity;
+import javax.ws.rs.core.Form;
+import javax.ws.rs.core.Response;
+import java.util.List;
+
+import static org.junit.Assert.assertEquals;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.reset;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyNoMoreInteractions;
+
+@RunWith(JUnitParamsRunner.class)
+public class FeatureFlagsControllerTest {
+
+    private static final FeatureFlagsManager    FEATURE_FLAG_MANAGER    = mock(FeatureFlagsManager.class);
+    private static final FeatureFlagsController FEATURE_FLAG_CONTROLLER = new FeatureFlagsController(FEATURE_FLAG_MANAGER, List.of("first", "second"));
+
+    @Rule
+    public final ResourceTestRule resources = ResourceTestRule.builder()
+            .addProvider(AuthHelper.getAuthFilter())
+            .addProvider(new PolymorphicAuthValueFactoryProvider.Binder<>(ImmutableSet.of(Account.class, DisabledPermittedAccount.class)))
+            .setTestContainerFactory(new GrizzlyWebTestContainerFactory())
+            .addProvider(new DeviceLimitExceededExceptionMapper())
+            .addResource(FEATURE_FLAG_CONTROLLER)
+            .build();
+
+    @Before
+    public void setUp() {
+        reset(FEATURE_FLAG_MANAGER);
+    }
+
+    @Test
+    public void testSet() {
+        {
+            final Response response = resources.getJerseyTest()
+                    .target("/v1/featureflag/testFlag")
+                    .request()
+                    .header("Token", "first")
+                    .put(Entity.form(new Form().param("active", "true")));
+
+            assertEquals(204, response.getStatus());
+            verify(FEATURE_FLAG_MANAGER).setFeatureFlag("testFlag", true);
+        }
+
+        {
+            final Response response = resources.getJerseyTest()
+                    .target("/v1/featureflag/testFlag")
+                    .request()
+                    .header("Token", "bogus-token")
+                    .put(Entity.form(new Form().param("active", "true")));
+
+            assertEquals(401, response.getStatus());
+            verifyNoMoreInteractions(FEATURE_FLAG_MANAGER);
+        }
+    }
+
+    @Test
+    public void testDelete() {
+        {
+            final Response response = resources.getJerseyTest()
+                    .target("/v1/featureflag/testFlag")
+                    .request()
+                    .header("Token", "first")
+                    .delete();
+
+            assertEquals(204, response.getStatus());
+            verify(FEATURE_FLAG_MANAGER).deleteFeatureFlag("testFlag");
+        }
+
+        {
+            final Response response = resources.getJerseyTest()
+                    .target("/v1/featureflag/testFlag")
+                    .request()
+                    .header("Token", "bogus-token")
+                    .delete();
+
+            assertEquals(401, response.getStatus());
+            verifyNoMoreInteractions(FEATURE_FLAG_MANAGER);
+        }
+    }
+
+    @Test
+    @Parameters(method = "argumentsForTestIsAuthorized")
+    public void testIsAuthorized(final String token, final boolean expectAuthorized) {
+        assertEquals(expectAuthorized, FEATURE_FLAG_CONTROLLER.isAuthorized(token));
+    }
+
+    @SuppressWarnings("unused")
+    private Object argumentsForTestIsAuthorized() {
+        return new Object[] {
+                new Object[] { "first",           true },
+                new Object[] { "second",          true },
+                new Object[] { "third",           false },
+                new Object[] { "firstfirstfirst", false },
+                new Object[] { null,              false }
+        };
+    }
+}