Add gift badges device capability

2026-04-26 23:13:18 +01:00 · 2022-04-19 10:09:54 -05:00
parent 796fb3b4cd
commit 9e66f8ac11
11 changed files with 116 additions and 46 deletions
--- a/service/src/test/java/org/whispersystems/textsecuregcm/tests/controllers/DeviceControllerTest.java
+++ b/service/src/test/java/org/whispersystems/textsecuregcm/tests/controllers/DeviceControllerTest.java
@@ -129,6 +129,7 @@ class DeviceControllerTest {
    when(account.isAnnouncementGroupSupported()).thenReturn(true);
    when(account.isChangeNumberSupported()).thenReturn(true);
    when(account.isPniSupported()).thenReturn(true);
+    when(account.isGiftBadgesSupported()).thenReturn(true);

    when(pendingDevicesManager.getCodeForNumber(AuthHelper.VALID_NUMBER)).thenReturn(
        Optional.of(new StoredVerificationCode("5678901", System.currentTimeMillis(), null, null)));
@@ -305,7 +306,7 @@ class DeviceControllerTest {
  void deviceDowngradeCapabilitiesTest(final String userAgent, final boolean gv2, final boolean gv2_2,
      final boolean gv2_3, final int expectedStatus) {
    DeviceCapabilities deviceCapabilities = new DeviceCapabilities(gv2, gv2_2, gv2_3, true, false, true, true, true,
-        true, true, true);
+        true, true, true, true);
    AccountAttributes accountAttributes = new AccountAttributes(false, 1234, null, null, true, deviceCapabilities);
    Response response = resources.getJerseyTest()
        .target("/v1/devices/5678901")
@@ -346,7 +347,7 @@ class DeviceControllerTest {
  @Test
  void deviceDowngradeGv1MigrationTest() {
    DeviceCapabilities deviceCapabilities = new DeviceCapabilities(true, true, true, true, false, false, true, true,
-        true, true, true);
+        true, true, true, true);
    AccountAttributes accountAttributes = new AccountAttributes(false, 1234, null, null, true, deviceCapabilities);
    Response response = resources.getJerseyTest()
                                 .target("/v1/devices/5678901")
@@ -357,7 +358,7 @@ class DeviceControllerTest {

    assertThat(response.getStatus()).isEqualTo(409);

-    deviceCapabilities = new DeviceCapabilities(true, true, true, true, false, true, true, true, true, true, true);
+    deviceCapabilities = new DeviceCapabilities(true, true, true, true, false, true, true, true, true, true, true, true);
    accountAttributes = new AccountAttributes(false, 1234, null, null, true, deviceCapabilities);
    response = resources.getJerseyTest()
                        .target("/v1/devices/5678901")
@@ -372,7 +373,7 @@ class DeviceControllerTest {
  @Test
  void deviceDowngradeSenderKeyTest() {
    DeviceCapabilities deviceCapabilities = new DeviceCapabilities(true, true, true, true, true, true, false, true,
-        true, true, true);
+        true, true, true, true);
    AccountAttributes accountAttributes =
        new AccountAttributes(false, 1234, null, null, true, deviceCapabilities);
    Response response = resources
@@ -384,7 +385,7 @@ class DeviceControllerTest {
        .put(Entity.entity(accountAttributes, MediaType.APPLICATION_JSON_TYPE));
    assertThat(response.getStatus()).isEqualTo(409);

-    deviceCapabilities = new DeviceCapabilities(true, true, true, true, true, true, true, true, true, true, true);
+    deviceCapabilities = new DeviceCapabilities(true, true, true, true, true, true, true, true, true, true, true, true);
    accountAttributes = new AccountAttributes(false, 1234, null, null, true, deviceCapabilities);
    response = resources
        .getJerseyTest()
@@ -399,7 +400,7 @@ class DeviceControllerTest {
  @Test
  void deviceDowngradeAnnouncementGroupTest() {
    DeviceCapabilities deviceCapabilities = new DeviceCapabilities(true, true, true, true, true, true, true, false,
-        true, true, true);
+        true, true, true, true);
    AccountAttributes accountAttributes =
        new AccountAttributes(false, 1234, null, null, true, deviceCapabilities);
    Response response = resources
@@ -411,7 +412,7 @@ class DeviceControllerTest {
        .put(Entity.entity(accountAttributes, MediaType.APPLICATION_JSON_TYPE));
    assertThat(response.getStatus()).isEqualTo(409);

-    deviceCapabilities = new DeviceCapabilities(true, true, true, true, true, true, true, true, true, true, true);
+    deviceCapabilities = new DeviceCapabilities(true, true, true, true, true, true, true, true, true, true, true, true);
    accountAttributes = new AccountAttributes(false, 1234, null, null, true, deviceCapabilities);
    response = resources
        .getJerseyTest()
@@ -426,7 +427,7 @@ class DeviceControllerTest {
  @Test
  void deviceDowngradeChangeNumberTest() {
    DeviceCapabilities deviceCapabilities = new DeviceCapabilities(true, true, true, true, true, true, true, true,
-        false, true, true);
+        false, true, true, true);
    AccountAttributes accountAttributes =
        new AccountAttributes(false, 1234, null, null, true, deviceCapabilities);
    Response response = resources
@@ -439,7 +440,7 @@ class DeviceControllerTest {
        .put(Entity.entity(accountAttributes, MediaType.APPLICATION_JSON_TYPE));
    assertThat(response.getStatus()).isEqualTo(409);

-    deviceCapabilities = new DeviceCapabilities(true, true, true, true, true, true, true, true, true, true, true);
+    deviceCapabilities = new DeviceCapabilities(true, true, true, true, true, true, true, true, true, true, true, true);
    accountAttributes = new AccountAttributes(false, 1234, null, null, true, deviceCapabilities);
    response = resources
        .getJerseyTest()
@@ -455,7 +456,7 @@ class DeviceControllerTest {
  @Test
  void deviceDowngradePniTest() {
    DeviceCapabilities deviceCapabilities = new DeviceCapabilities(true, true, true, true, true, true, true, true, true,
-        false, true);
+        false, true, true);
    AccountAttributes accountAttributes =
        new AccountAttributes(false, 1234, null, null, true, deviceCapabilities);
    Response response = resources
@@ -467,7 +468,7 @@ class DeviceControllerTest {
        .put(Entity.entity(accountAttributes, MediaType.APPLICATION_JSON_TYPE));
    assertThat(response.getStatus()).isEqualTo(409);

-    deviceCapabilities = new DeviceCapabilities(true, true, true, true, true, true, true, true, true, true, true);
+    deviceCapabilities = new DeviceCapabilities(true, true, true, true, true, true, true, true, true, true, true, true);
    accountAttributes = new AccountAttributes(false, 1234, null, null, true, deviceCapabilities);
    response = resources
        .getJerseyTest()
@@ -483,7 +484,7 @@ class DeviceControllerTest {
  @Test
  void deviceDowngradeStoriesTest() {
    DeviceCapabilities deviceCapabilities = new DeviceCapabilities(true, true, true, true, true, true, true, true, true,
-        true, false);
+        true, false, true);
    AccountAttributes accountAttributes =
        new AccountAttributes(false, 1234, null, null, true, deviceCapabilities);
    Response response = resources
@@ -498,7 +499,33 @@ class DeviceControllerTest {
    // TODO stories capability
    // assertThat(response.getStatus()).isEqualTo(409);

-    deviceCapabilities = new DeviceCapabilities(true, true, true, true, true, true, true, true, true, true, true);
+    deviceCapabilities = new DeviceCapabilities(true, true, true, true, true, true, true, true, true, true, true, true);
+    accountAttributes = new AccountAttributes(false, 1234, null, null, true, deviceCapabilities);
+    response = resources
+        .getJerseyTest()
+        .target("/v1/devices/5678901")
+        .request()
+        .header("Authorization",
+            AuthHelper.getProvisioningAuthHeader(AuthHelper.VALID_NUMBER, AuthHelper.VALID_PASSWORD))
+        .header("User-Agent", "Signal-Android/5.42.8675309 Android/30")
+        .put(Entity.entity(accountAttributes, MediaType.APPLICATION_JSON_TYPE));
+    assertThat(response.getStatus()).isEqualTo(200);
+  }
+
+  @Test
+  void deviceDowngradeGiftBadgesTest() {
+    DeviceCapabilities deviceCapabilities = new DeviceCapabilities(true, true, true, true, true, true, true, true, true, true, true, false);
+    AccountAttributes accountAttributes = new AccountAttributes(false, 1234, null, null, true, deviceCapabilities);
+    Response response = resources
+        .getJerseyTest()
+        .target("/v1/devices/5678901")
+        .request()
+        .header("Authorization", AuthHelper.getProvisioningAuthHeader(AuthHelper.VALID_NUMBER, AuthHelper.VALID_PASSWORD))
+        .header("User-Agent", "Signal-Android/5.42.8675309 Android/30")
+        .put(Entity.entity(accountAttributes, MediaType.APPLICATION_JSON_TYPE));
+    assertThat(response.getStatus()).isEqualTo(409);
+
+    deviceCapabilities = new DeviceCapabilities(true, true, true, true, true, true, true, true, true, true, true, true);
    accountAttributes = new AccountAttributes(false, 1234, null, null, true, deviceCapabilities);
    response = resources
        .getJerseyTest()
--- a/service/src/test/java/org/whispersystems/textsecuregcm/tests/storage/AccountTest.java
+++ b/service/src/test/java/org/whispersystems/textsecuregcm/tests/storage/AccountTest.java
@@ -66,6 +66,10 @@ class AccountTest {
  private final Device storiesIncapableDevice = mock(Device.class);
  private final Device storiesIncapableExpiredDevice = mock(Device.class);

+  private final Device giftBadgesCapableDevice = mock(Device.class);
+  private final Device giftBadgesIncapableDevice = mock(Device.class);
+  private final Device giftBadgesIncapableExpiredDevice = mock(Device.class);
+
  @BeforeEach
  void setup() {
    when(oldMasterDevice.getLastSeen()).thenReturn(System.currentTimeMillis() - TimeUnit.DAYS.toMillis(366));
@@ -101,76 +105,86 @@ class AccountTest {
    when(gv2IncapableExpiredDevice.isEnabled()).thenReturn(false);

    when(gv1MigrationCapableDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, true, false, false, false, false, false));
+        new DeviceCapabilities(true, true, true, true, true, true, false, false, false, false, false, false));
    when(gv1MigrationCapableDevice.isEnabled()).thenReturn(true);

    when(gv1MigrationIncapableDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, false, false, false, false, false, false));
+        new DeviceCapabilities(true, true, true, true, true, false, false, false, false, false, false, false));
    when(gv1MigrationIncapableDevice.isEnabled()).thenReturn(true);

    when(gv1MigrationIncapableExpiredDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, false, false, false, false, false, false));
+        new DeviceCapabilities(true, true, true, true, true, false, false, false, false, false, false, false));
    when(gv1MigrationIncapableExpiredDevice.isEnabled()).thenReturn(false);

    when(senderKeyCapableDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false));
+        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false, false));
    when(senderKeyCapableDevice.isEnabled()).thenReturn(true);

    when(senderKeyIncapableDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, true, false, false, false, false, false));
+        new DeviceCapabilities(true, true, true, true, true, true, false, false, false, false, false, false));
    when(senderKeyIncapableDevice.isEnabled()).thenReturn(true);

    when(senderKeyIncapableExpiredDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, true, false, false, false, false, false));
+        new DeviceCapabilities(true, true, true, true, true, true, false, false, false, false, false, false));
    when(senderKeyIncapableExpiredDevice.isEnabled()).thenReturn(false);

    when(announcementGroupCapableDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, true, true, true, false, false, false));
+        new DeviceCapabilities(true, true, true, true, true, true, true, true, false, false, false, false));
    when(announcementGroupCapableDevice.isEnabled()).thenReturn(true);

    when(announcementGroupIncapableDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false));
+        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false, false));
    when(announcementGroupIncapableDevice.isEnabled()).thenReturn(true);

    when(announcementGroupIncapableExpiredDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false));
+        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false, false));
    when(announcementGroupIncapableExpiredDevice.isEnabled()).thenReturn(false);

    when(changeNumberCapableDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, true, true, false, true, false, false));
+        new DeviceCapabilities(true, true, true, true, true, true, true, false, true, false, false, false));
    when(changeNumberCapableDevice.isEnabled()).thenReturn(true);

    when(changeNumberIncapableDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false));
+        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false, false));
    when(changeNumberIncapableDevice.isEnabled()).thenReturn(true);

    when(changeNumberIncapableExpiredDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false));
+        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false, false));
    when(changeNumberIncapableExpiredDevice.isEnabled()).thenReturn(false);

    when(pniCapableDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, true, false));
+        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, true, false, false));
    when(pniCapableDevice.isEnabled()).thenReturn(true);

    when(pniIncapableDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false));
+        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false, false));
    when(pniIncapableDevice.isEnabled()).thenReturn(true);

    when(pniIncapableExpiredDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false));
+        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false, false));
    when(pniIncapableExpiredDevice.isEnabled()).thenReturn(false);

    when(storiesCapableDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, true));
+        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, true, false));
    when(storiesCapableDevice.isEnabled()).thenReturn(true);

    when(storiesIncapableDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false));
+        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false, false));
    when(storiesIncapableDevice.isEnabled()).thenReturn(true);

    when(storiesIncapableExpiredDevice.getCapabilities()).thenReturn(
-        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false));
+        new DeviceCapabilities(true, true, true, true, true, true, true, false, false, false, false, false));
    when(storiesIncapableExpiredDevice.isEnabled()).thenReturn(false);
+
+    when(giftBadgesCapableDevice.getCapabilities()).thenReturn(
+        new DeviceCapabilities(true, true, true, true, true, true, true, true, true, true, true, true));
+    when(giftBadgesCapableDevice.isEnabled()).thenReturn(true);
+    when(giftBadgesIncapableDevice.getCapabilities()).thenReturn(
+        new DeviceCapabilities(true, true, true, true, true, true, true, true, true, true, true, false));
+    when(giftBadgesIncapableDevice.isEnabled()).thenReturn(true);
+    when(giftBadgesIncapableExpiredDevice.getCapabilities()).thenReturn(
+        new DeviceCapabilities(true, true, true, true, true, true, true, true, true, true, true, false));
+    when(giftBadgesIncapableExpiredDevice.isEnabled()).thenReturn(false);
  }

  @Test
@@ -377,6 +391,19 @@ class AccountTest {
        "1234".getBytes(StandardCharsets.UTF_8)).isStoriesSupported()).isTrue();
  }

+  @Test
+  void isGiftBadgesSupported() {
+    assertThat(new Account("+18005551234", UUID.randomUUID(), UUID.randomUUID(),
+        Set.of(giftBadgesCapableDevice),
+        "1234".getBytes(StandardCharsets.UTF_8)).isGiftBadgesSupported()).isTrue();
+    assertThat(new Account("+18005551234", UUID.randomUUID(), UUID.randomUUID(),
+        Set.of(giftBadgesCapableDevice, giftBadgesIncapableDevice),
+        "1234".getBytes(StandardCharsets.UTF_8)).isGiftBadgesSupported()).isFalse();
+    assertThat(new Account("+18005551234", UUID.randomUUID(), UUID.randomUUID(),
+        Set.of(giftBadgesCapableDevice, giftBadgesIncapableExpiredDevice),
+        "1234".getBytes(StandardCharsets.UTF_8)).isGiftBadgesSupported()).isTrue();
+  }
+
  @Test
  void stale() {
    final Account account = new Account("+14151234567", UUID.randomUUID(), UUID.randomUUID(), Collections.emptySet(),
--- a/service/src/test/java/org/whispersystems/textsecuregcm/tests/util/AccountsHelper.java
+++ b/service/src/test/java/org/whispersystems/textsecuregcm/tests/util/AccountsHelper.java
@@ -161,6 +161,10 @@ public class AccountsHelper {
            when(updatedAccount.isStoriesSupported()).thenAnswer(stubbing);
            break;
          }
+          case "isGiftBadgesSupported": {
+            when(updatedAccount.isGiftBadgesSupported()).thenAnswer(stubbing);
+            break;
+          }
          case "getEnabledDeviceCount": {
            when(updatedAccount.getEnabledDeviceCount()).thenAnswer(stubbing);
            break;