Merge pull request #15 from configcat/fix-useragent-cache

Fix user agent / cache

Author: z4kn4fein

DEPLOY.md

@@ -1,7 +1,7 @@
 # Steps to deploy
 ## Preparation
 1. Run tests
-3. Increase the version in the gradle.properties file.
+3. Increase the version in the `gradle.properties` and `src/main/java/com.configcat/ConfigFetcher.java` file.
 4. Commit & Push
 ## Publish
 Use the **same version** for the git tag as in the properties file.
@@ -20,9 +20,11 @@ Use the **same version** for the git tag as in the properties file.
   Create a new [Github release](https://github.com/configcat/android-sdk/releases) with a new version tag and release notes.
 
 ## Sync
-1. Make sure the new version is available on [jcenter](https://bintray.com/configcat/releases/configcat-android-client).
-2. Log in to bintray.com and sync the new package to Maven Central. (https://bintray.com/configcat/releases/configcat-android-client#central)
-3. Make sure the new version is available on [Maven Central](https://search.maven.org/artifact/com.configcat/configcat-android-client).
+1. Log in to [Maven Repository](https://oss.sonatype.org/) and follow these steps:
+    1. Select `Staging Repositories` and select the version you published.
+    2. Click `Close`. The process might take some time, click `Refresh` to get the latest state.
+    3. When the repo is closed click `Release`, tick the `Automatically drop when released` option.
+2. Make sure the new version is available on [Maven Central](https://search.maven.org/artifact/com.configcat/configcat-android-client).
 
 ## Update import examples in local README.md
 

gradle.properties

@@ -1 +1 @@
-version=7.0.0
+version=7.0.1

src/main/java/com/configcat/ConfigFetcher.java

@@ -14,7 +14,7 @@ class ConfigFetcher implements Closeable {
     private final ConfigCatLogger logger;
     private final OkHttpClient httpClient;
     private final String mode;
-    private final String version;
+    private final String version = "7.0.1";
     private final ConfigJsonCache configJsonCache;
     private final String sdkKey;
     private final boolean urlIsCustom;
@@ -41,7 +41,6 @@ enum RedirectMode {
         this.urlIsCustom = urlIsCustom;
         this.url = url;
         this.httpClient = httpClient;
-        this.version = this.getClass().getPackage().getImplementationVersion();
         this.mode = pollingIdentifier;
     }
 
@@ -169,7 +168,7 @@ public void close() throws IOException {
     Request getRequest(String etag) {
         String url = this.url + "/configuration-files/" + this.sdkKey + "/" + CONFIG_JSON_NAME + ".json";
         Request.Builder builder = new Request.Builder()
-                .addHeader("X-ConfigCat-UserAgent", "ConfigCat-Java/" + this.mode + "-" + this.version);
+                .addHeader("X-ConfigCat-UserAgent", "ConfigCat-Droid/" + this.mode + "-" + this.version);
 
         if (etag != null && !etag.isEmpty())
             builder.addHeader("If-None-Match", etag);

src/main/java/com/configcat/ConfigJsonCache.java

@@ -5,8 +5,6 @@
 import org.apache.commons.codec.binary.Hex;
 import org.apache.commons.codec.digest.DigestUtils;
 
-import java.time.Instant;
-
 class ConfigJsonCache {
     private static final String CACHE_BASE = "java_" + ConfigFetcher.CONFIG_JSON_NAME + "_%s";
     private Config inMemoryConfig = Config.empty;
@@ -45,9 +43,6 @@ public Config readFromCache() {
 
         try {
             Config config = this.deserialize(fromCache);
-            if (this.inMemoryConfig.timeStamp >= config.timeStamp) {
-                return this.inMemoryConfig;
-            }
             this.inMemoryConfig = config;
             this.inMemoryConfigString = fromCache;
             return config;
@@ -59,7 +54,6 @@ public Config readFromCache() {
 
     public void writeToCache(Config config) {
         try {
-            config.timeStamp = Instant.now().getEpochSecond();
             String configToCache = this.gson.toJson(config);
             this.inMemoryConfig = config;
             this.inMemoryConfigString = configToCache;

src/main/java/com/configcat/ConfigModels.java

@@ -20,8 +20,6 @@ class Config {
     public Map<String, Setting> entries = new HashMap<>();
     @SerializedName(value = "e")
     public String eTag = "";
-    @SerializedName(value = "t")
-    public long timeStamp = -1;
 
     public static Config empty = new Config();
 }

src/test/java/com/configcat/ConfigCatClientIntegrationTest.java

@@ -6,6 +6,7 @@
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
 import java.util.Collection;
@@ -217,4 +218,27 @@ public void getAllKeys() {
         assertEquals(16, keys.size());
         assertTrue(keys.contains("stringDefaultCat"));
     }
+
+    @Test
+    public void ensureFailingCacheWriteDoesNotPreventFurtherWrites() {
+        FailingWriteCache cache = new FailingWriteCache();
+        ConfigJsonCache memoryCache = new ConfigJsonCache(
+                new ConfigCatLogger(LoggerFactory.getLogger(ConfigCatClientIntegrationTest.class)), cache, "");
+
+        Config initialConfig = memoryCache.readFromJson(String.format(TEST_JSON, "initial"), "etag1");
+        memoryCache.writeToCache(initialConfig);
+
+        Config updated = memoryCache.readFromJson(String.format(TEST_JSON, "updated"), "etag2");
+        memoryCache.writeToCache(updated); // this will fail
+
+        Config fromCache1 = memoryCache.readFromCache();
+        assertEquals(initialConfig.eTag, fromCache1.eTag);
+
+        memoryCache.writeToCache(updated);
+
+        Config fromCache2 = memoryCache.readFromCache();
+        assertEquals(updated.eTag, fromCache2.eTag);
+
+        assertEquals(2, cache.successCounter.get());
+    }
 }

src/test/java/com/configcat/ConfigFetcherTest.java

@@ -140,38 +140,13 @@ public void getCacheFails() throws Exception {
         fetcher.close();
     }
 
-    @Test
-    public void cacheWriteFails() throws Exception {
-        this.server.enqueue(new MockResponse().setResponseCode(200).setBody(TEST_JSON2));
-        ConfigCache cache = mock(ConfigCache.class);
-
-        Gson gson = new GsonBuilder().create();
-        Config config = gson.fromJson(TEST_JSON, Config.class);
-        config.timeStamp = Instant.now().getEpochSecond();
-
-        when(cache.read(anyString())).thenReturn(gson.toJson(config));
-        doThrow(new Exception()).when(cache).write(anyString(), anyString());
-
-        ConfigJsonCache configJsonCache = new ConfigJsonCache(logger, cache, "");
-        ConfigFetcher fetcher = new ConfigFetcher(new OkHttpClient.Builder().build(), logger, configJsonCache,
-                "", this.server.url("/").toString(), false, PollingModes.manualPoll().getPollingIdentifier());
-
-        FetchResponse result = fetcher.fetchAsync().get();
-        configJsonCache.writeToCache(result.config());
-
-        assertEquals("fakeValue2", configJsonCache.readFromCache().entries.get("fakeKey").value.getAsString());
-
-        fetcher.close();
-    }
-
     @Test
     public void cacheWriteFailsCachedTakesPrecedence() throws Exception {
         this.server.enqueue(new MockResponse().setResponseCode(200).setBody(TEST_JSON2));
         ConfigCache cache = mock(ConfigCache.class);
 
         Gson gson = new GsonBuilder().create();
         Config config = gson.fromJson(TEST_JSON, Config.class);
-        config.timeStamp = Instant.now().getEpochSecond() + 50;
 
         when(cache.read(anyString())).thenReturn(gson.toJson(config));
         doThrow(new Exception()).when(cache).write(anyString(), anyString());

src/test/java/com/configcat/FailingWriteCache.java

@@ -0,0 +1,26 @@
+package com.configcat;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.concurrent.atomic.AtomicInteger;
+
+public class FailingWriteCache extends ConfigCache {
+    Map<String, String> map = new HashMap<>();
+    AtomicInteger counter = new AtomicInteger(1);
+    public AtomicInteger successCounter = new AtomicInteger(0);
+
+    @Override
+    protected String read(String key) {
+        return map.get(key);
+    }
+
+    @Override
+    protected void write(String key, String value) throws Exception {
+        if(counter.getAndIncrement() % 2 == 0){
+            throw new Exception();
+        }
+
+        successCounter.incrementAndGet();
+        map.put(key, value);
+    }
+}