Resolve comment related to revert of ServerVersion Class

Author: Varun Rathore

src/main/java/com/google/firebase/remoteconfig/ServerTemplateData.java

@@ -40,7 +40,7 @@ final class ServerTemplateData {
   private Map<String, Parameter> parameters;
   private List<ServerCondition> serverConditions;
   private Map<String, ParameterGroup> parameterGroups;
-  private ServerVersion serverVersion;
+  private Version version;
 
 
   ServerTemplateData(String etag) {
@@ -78,7 +78,7 @@ final class ServerTemplateData {
       }
     }
     if (serverTemplateResponse.getVersion() != null) {
-      this.serverVersion = new ServerVersion(serverTemplateResponse.getVersion());
+      this.version = new Version(serverTemplateResponse.getVersion());
     }
     this.etag = serverTemplateResponse.getEtag();
   }
@@ -120,8 +120,8 @@ Map<String, ParameterGroup> getParameterGroups() {
     return parameterGroups;
   }
 
-  ServerVersion getVersion() {
-    return serverVersion;
+  Version getVersion() {
+    return version;
   }
 
   ServerTemplateData setParameters(@NonNull Map<String, Parameter> parameters) {
@@ -144,8 +144,8 @@ ServerTemplateData setParameterGroups(
     return this;
   }
 
-  ServerTemplateData setVersion(ServerVersion serverVersion) {
-    this.serverVersion = serverVersion;
+  ServerTemplateData setVersion(Version serverVersion) {
+    this.version = serverVersion;
     return this;
   }
 
@@ -178,7 +178,7 @@ ServerTemplateResponse toServerTemplateResponse(boolean includeAll) {
       parameterGroupResponse.put(entry.getKey(), entry.getValue().toParameterGroupResponse());
     }
     TemplateResponse.VersionResponse versionResponse =
-        (this.serverVersion == null) ? null : this.serverVersion.toVersionResponse(includeAll);
+        (this.version == null) ? null : this.version.toVersionResponse(includeAll);
     ServerTemplateResponse serverTemplateResponse =
         new ServerTemplateResponse()
             .setParameters(parameterResponses)
@@ -204,12 +204,12 @@ public boolean equals(Object o) {
         && Objects.equals(parameters, template.parameters)
         && Objects.equals(serverConditions, template.serverConditions)
         && Objects.equals(parameterGroups, template.parameterGroups)
-        && Objects.equals(serverVersion, template.serverVersion);
+        && Objects.equals(version, template.version);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(etag, parameters, serverConditions, parameterGroups, serverVersion);
+    return Objects.hash(etag, parameters, serverConditions, parameterGroups, version);
   }
 }
 

src/main/java/com/google/firebase/remoteconfig/ServerTemplateImpl.java

@@ -22,8 +22,6 @@
 import com.google.firebase.ErrorCode;
 import com.google.firebase.internal.Nullable;
 import com.google.firebase.remoteconfig.internal.TemplateResponse.ParameterValueResponse;
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -130,8 +128,7 @@ public String getCachedTemplate() {
 
   @Override
   public String toJson() {
-    Gson gson = new GsonBuilder().setPrettyPrinting().create();
-    return gson.toJson(this.cache);
+    return this.cache.toJSON();
   }
 
   private void mergeDerivedConfigValues(ImmutableMap<String, Boolean> evaluatedCondition,

src/test/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigClientImplTest.java

@@ -1446,7 +1446,7 @@ public void testGetServerTemplate() throws Exception {
     assertEquals(
         convertObjectToString(EXPECTED_SERVER_CONDITIONS),
         convertObjectToString(serverTemplateData.getServerConditions()));
-    assertEquals("2020-11-15T06:57:26.342763941Z", serverTemplateData.getVersion().getUpdateTime());
+    assertEquals(1605423446000L, serverTemplateData.getVersion().getUpdateTime());
     checkGetRequestHeaderForServer(interceptor.getLastRequest());
   }
 
@@ -1470,10 +1470,9 @@ public void testGetServerTemplateWithTimestampUpToNanosecondPrecision() throws E
 
       String receivedTemplate = client.getServerTemplate();
       ServerTemplateData serverTemplateData = ServerTemplateData.fromJSON(receivedTemplate);
-
       assertEquals(TEST_ETAG, serverTemplateData.getETag());
       assertEquals("17", serverTemplateData.getVersion().getVersionNumber());
-      assertEquals(timestamp, serverTemplateData.getVersion().getUpdateTime());
+      assertEquals(1605423446000L, serverTemplateData.getVersion().getUpdateTime());
       checkGetRequestHeaderForServer(interceptor.getLastRequest());
     }
   }

src/test/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigTest.java

@@ -28,6 +28,8 @@
 import com.google.firebase.TestOnlyImplFirebaseTrampolines;
 import com.google.firebase.auth.MockGoogleCredentials;
 import com.google.firebase.remoteconfig.internal.TemplateResponse;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonParser;
 import java.util.concurrent.ExecutionException;
 import org.junit.After;
 import org.junit.Test;
@@ -42,13 +44,6 @@ public class FirebaseRemoteConfigTest {
           .setCredentials(new MockGoogleCredentials("test-token"))
           .setProjectId("test-project")
           .build();
-  private static final String TEST_SERVER_TEMPLATE =
-      "{\n"
-          + "  \"etag\": \"etag-123456789012-1\",\n"
-          + "  \"parameters\": {},\n"
-          + "  \"serverConditions\": [],\n"
-          + "  \"parameterGroups\": {}\n"
-          + "}";
   private static final FirebaseRemoteConfigException TEST_EXCEPTION =
       new FirebaseRemoteConfigException(ErrorCode.INTERNAL, "Test error message");
 
@@ -629,14 +624,16 @@ private FirebaseRemoteConfig getRemoteConfig(FirebaseRemoteConfigClient client)
 
   @Test
   public void testGetServerTemplate() throws FirebaseRemoteConfigException {
-    MockRemoteConfigClient client =
-        MockRemoteConfigClient.fromServerTemplate(
-            new ServerTemplateData().setETag(TEST_ETAG).toJSON());
+    MockRemoteConfigClient client = MockRemoteConfigClient.fromServerTemplate(
+        new ServerTemplateData().setETag(TEST_ETAG).toJSON());
     FirebaseRemoteConfig remoteConfig = getRemoteConfig(client);
 
     ServerTemplate template = remoteConfig.getServerTemplate();
     String templateData = template.toJson();
-    assertEquals(TEST_SERVER_TEMPLATE, templateData);
+    JsonElement expectedJson = JsonParser.parseString(new ServerTemplateData().setETag(TEST_ETAG).toJSON());
+    JsonElement actualJson = JsonParser.parseString(templateData);
+
+    assertEquals(expectedJson, actualJson);
   }
 
   @Test
@@ -653,14 +650,16 @@ public void testGetServerTemplateFailure() {
 
   @Test
   public void testGetServerTemplateAsync() throws Exception {
-    MockRemoteConfigClient client =
-        MockRemoteConfigClient.fromServerTemplate(
-            new ServerTemplateData().setETag(TEST_ETAG).toJSON());
+    MockRemoteConfigClient client = MockRemoteConfigClient.fromServerTemplate(
+        new ServerTemplateData().setETag(TEST_ETAG).toJSON());
     FirebaseRemoteConfig remoteConfig = getRemoteConfig(client);
 
     ServerTemplate template = remoteConfig.getServerTemplateAsync().get();
     String templateData = template.toJson();
-    assertEquals(TEST_SERVER_TEMPLATE, templateData);
+    JsonElement expectedJson = JsonParser.parseString(new ServerTemplateData().setETag(TEST_ETAG).toJSON());
+    JsonElement actualJson = JsonParser.parseString(templateData);
+
+    assertEquals(expectedJson, actualJson);
   }
 
   @Test

src/test/java/com/google/firebase/remoteconfig/ServerTemplateImplTest.java

@@ -26,6 +26,8 @@
 import com.google.firebase.testing.TestUtils;
 import org.junit.BeforeClass;
 import org.junit.Test;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonParser;
 
 /**
 * Tests for {@link ServerTemplateImpl}.
@@ -37,13 +39,6 @@ public class ServerTemplateImplTest {
           .setCredentials(new MockGoogleCredentials("test-token"))
           .setProjectId("test-project")
           .build();
-  private static final String TEST_SERVER_TEMPLATE =
-        "{\n"
-            + "  \"etag\": \"etag-123456789012-1\",\n"
-            + "  \"parameters\": {},\n"
-            + "  \"serverConditions\": [],\n"
-            + "  \"parameterGroups\": {}\n"
-            + "}";
 
   private static String cacheTemplate;
 
@@ -354,27 +349,66 @@ private FirebaseRemoteConfig getRemoteConfig(FirebaseRemoteConfigClient client)
     return new FirebaseRemoteConfig(app, client);
   }
 
-  @Test
-  public void testLoad() throws Exception {
-    KeysAndValues defaultConfig =
-        new KeysAndValues.Builder().put("Unset default config", "abc").build();
+@Test
+public void testLoad() throws Exception {
+    // 1. Define the template data that the mock client will return.
+    // This is the EXPECTED state after `load()` is called.
+    final String expectedTemplateJsonAfterLoad = new ServerTemplateData().setETag(TEST_ETAG).toJSON();
 
-    // Mock the HTTP client to return a predefined response
+    // 2. Mock the HTTP client to return the predefined response.
     MockRemoteConfigClient client =
-        MockRemoteConfigClient.fromServerTemplate(
-            new ServerTemplateData().setETag(TEST_ETAG).toJSON());
+        MockRemoteConfigClient.fromServerTemplate(expectedTemplateJsonAfterLoad);
     FirebaseRemoteConfig remoteConfig = getRemoteConfig(client);
-    ServerTemplate template1 =
+
+    // 3. Build the template instance.
+    // It's initialized with a complex `cacheTemplate` to ensure `load()` properly overwrites it.
+    KeysAndValues defaultConfig =
+        new KeysAndValues.Builder().put("Unset default config", "abc").build();
+    ServerTemplate template =
         remoteConfig
             .serverTemplateBuilder()
             .defaultConfig(defaultConfig)
+            .cachedTemplate(cacheTemplate) // This is the initial state before `load()`
+            .build();
+
+    // 4. Call the load method, which fetches the new template from the mock client.
+    ApiFuture<Void> loadFuture = template.load();
+    loadFuture.get(); // Wait for the async operation to complete.
+
+    // 5. Get the ACTUAL state of the template after `load()` has executed.
+    String actualJsonAfterLoad = template.toJson();
+
+    // 6. Assert that the template's state has been updated to match what the mock client returned.
+    // Parsing to JsonElement performs a deep, order-insensitive comparison.
+    JsonElement expectedJson = JsonParser.parseString(expectedTemplateJsonAfterLoad);
+    JsonElement actualJson = JsonParser.parseString(actualJsonAfterLoad);
+
+    assertEquals(expectedJson, actualJson);
+}
+
+@Test
+public void testBuilderParsesCachedTemplateCorrectly() throws FirebaseRemoteConfigException {
+    // Arrange: 
+    // 1. Create a canonical JSON string by parsing the input file and then
+    // re-serializing it. This gives us the precise expected output format,
+    // accounting for any formatting or default value differences.
+    ServerTemplateData canonicalData = ServerTemplateData.fromJSON(cacheTemplate);
+    String expectedJsonString = canonicalData.toJSON();
+
+    // Act: 
+    // 2. Build a ServerTemplate instance from the original cached JSON string,
+    // which triggers the parsing logic we want to test.
+    ServerTemplate template = new ServerTemplateImpl.Builder(null)
             .cachedTemplate(cacheTemplate)
             .build();
 
-    // Call the load method
-    ApiFuture<Void> loadFuture = template1.load();
-    loadFuture.get();
-    String cachedTemplate = template1.toJson();
-    assertEquals(TEST_SERVER_TEMPLATE, cachedTemplate);
-  }
+    // Assert: 
+    // 3. Compare the JSON from the newly built template against the canonical version.
+    // This verifies that the internal state was parsed and stored correctly.
+    // Using JsonElement ensures the comparison is not affected by key order.
+    JsonElement expectedJsonTree = JsonParser.parseString(expectedJsonString);
+    JsonElement actualJsonTree = JsonParser.parseString(template.toJson());
+
+    assertEquals(expectedJsonTree, actualJsonTree);
+}
 }

src/test/resources/getServerTemplateData.json

@@ -167,7 +167,15 @@
     }
   },
   "version": {
-    "versionNumber": "27",
-    "isLegacy": true
+    "versionNumber": "17",
+    "updateOrigin": "ADMIN_SDK_NODE",
+    "updateType": "INCREMENTAL_UPDATE",
+    "updateUser": {
+      "email": "firebase-user@account.com",
+      "name": "dev-admin",
+      "imageUrl": "http://image.jpg"
+    },
+    "updateTime": "2020-11-15T06:57:26.342763941Z",
+    "description": "promo config"
   }
 }