Release version 1.0.2 (#29)

Author: Vignesh Raja

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.2
+
+- Gracefully handle datafile that doesn't contain required fields
+
 ## 1.0.1
 
 - Allow for configurability of `clientEngine` and `clientVersion` through `Optimizely.Builder`

core-api/src/main/java/com/optimizely/ab/config/parser/GsonConfigParser.java

@@ -18,7 +18,6 @@
 
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
-import com.google.gson.JsonParseException;
 
 import com.optimizely.ab.config.Experiment;
 import com.optimizely.ab.config.Group;
@@ -43,7 +42,7 @@ public ProjectConfig parseProjectConfig(@Nonnull String json) throws ConfigParse
 
         try {
             return gson.fromJson(json, ProjectConfig.class);
-        } catch (JsonParseException e) {
+        } catch (Exception e) {
             throw new ConfigParseException("Unable to parse datafile: " + json, e);
         }
     }

core-api/src/main/java/com/optimizely/ab/config/parser/JacksonConfigParser.java

@@ -21,8 +21,6 @@
 
 import com.optimizely.ab.config.ProjectConfig;
 
-import java.io.IOException;
-
 import javax.annotation.Nonnull;
 
 /**
@@ -39,7 +37,7 @@ public ProjectConfig parseProjectConfig(@Nonnull String json) throws ConfigParse
 
         try {
             return mapper.readValue(json, ProjectConfig.class);
-        } catch (IOException e) {
+        } catch (Exception e) {
             throw new ConfigParseException("Unable to parse datafile: " + json, e);
         }
     }

core-api/src/main/java/com/optimizely/ab/config/parser/JsonConfigParser.java

@@ -32,7 +32,6 @@
 import com.optimizely.ab.config.Variation;
 
 import org.json.JSONArray;
-import org.json.JSONException;
 import org.json.JSONObject;
 
 import java.util.ArrayList;
@@ -73,7 +72,7 @@ public ProjectConfig parseProjectConfig(@Nonnull String json) throws ConfigParse
 
             return new ProjectConfig(accountId, projectId, version, revision, groups, experiments, attributes, events,
                                      audiences);
-        } catch (JSONException e) {
+        } catch (Exception e) {
             throw new ConfigParseException("Unable to parse datafile: " + json, e);
         }
     }

core-api/src/main/java/com/optimizely/ab/config/parser/JsonSimpleConfigParser.java

@@ -40,7 +40,6 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Set;
 
 import javax.annotation.Nonnull;
 
@@ -75,7 +74,7 @@ public ProjectConfig parseProjectConfig(@Nonnull String json) throws ConfigParse
 
             return new ProjectConfig(accountId, projectId, version, revision, groups, experiments, attributes, events,
                                      audiences);
-        } catch (ParseException e) {
+        } catch (Exception e) {
             throw new ConfigParseException("Unable to parse datafile: " + json, e);
         }
     }

core-api/src/test/java/com/optimizely/ab/config/parser/GsonConfigParserTest.java

@@ -55,13 +55,24 @@ public void parseProjectConfigV2() throws Exception {
     }
 
     /**
-     * Verify that internal parser exceptions are wrapped and rethrown as a {@link ConfigParseException}.
+     * Verify that invalid JSON results in a {@link ConfigParseException} being thrown.
      */
     @Test
-    public void exceptionWrapping() throws Exception {
+    public void invalidJsonExceptionWrapping() throws Exception {
         thrown.expect(ConfigParseException.class);
 
         GsonConfigParser parser = new GsonConfigParser();
         parser.parseProjectConfig("invalid config");
     }
+
+    /**
+     * Verify that valid JSON without a required field results in a {@link ConfigParseException} being thrown.
+     */
+    @Test
+    public void validJsonRequiredFieldMissingExceptionWrapping() throws Exception {
+        thrown.expect(ConfigParseException.class);
+
+        GsonConfigParser parser = new GsonConfigParser();
+        parser.parseProjectConfig("{\"valid\": \"json\"}");
+    }
 }

core-api/src/test/java/com/optimizely/ab/config/parser/JacksonConfigParserTest.java

@@ -55,13 +55,24 @@ public void parseProjectConfigV2() throws Exception {
     }
 
     /**
-     * Verify that internal parser exceptions are wrapped and rethrown as a {@link ConfigParseException}.
+     * Verify that invalid JSON results in a {@link ConfigParseException} being thrown.
      */
     @Test
-    public void exceptionWrapping() throws Exception {
+    public void invalidJsonExceptionWrapping() throws Exception {
         thrown.expect(ConfigParseException.class);
 
         JacksonConfigParser parser = new JacksonConfigParser();
         parser.parseProjectConfig("invalid config");
     }
+
+    /**
+     * Verify that valid JSON without a required field results in a {@link ConfigParseException} being thrown.
+     */
+    @Test
+    public void validJsonRequiredFieldMissingExceptionWrapping() throws Exception {
+        thrown.expect(ConfigParseException.class);
+
+        JacksonConfigParser parser = new JacksonConfigParser();
+        parser.parseProjectConfig("{\"valid\": \"json\"}");
+    }
 }

core-api/src/test/java/com/optimizely/ab/config/parser/JsonConfigParserTest.java

@@ -55,13 +55,24 @@ public void parseProjectConfigV2() throws Exception {
     }
 
     /**
-     * Verify that internal parser exceptions are wrapped and rethrown as a {@link ConfigParseException}.
+     * Verify that invalid JSON results in a {@link ConfigParseException} being thrown.
      */
     @Test
-    public void exceptionWrapping() throws Exception {
+    public void invalidJsonExceptionWrapping() throws Exception {
         thrown.expect(ConfigParseException.class);
 
         JsonConfigParser parser = new JsonConfigParser();
         parser.parseProjectConfig("invalid config");
     }
+
+    /**
+     * Verify that valid JSON without a required field results in a {@link ConfigParseException} being thrown.
+     */
+    @Test
+    public void validJsonRequiredFieldMissingExceptionWrapping() throws Exception {
+        thrown.expect(ConfigParseException.class);
+
+        JsonConfigParser parser = new JsonConfigParser();
+        parser.parseProjectConfig("{\"valid\": \"json\"}");
+    }
 }

core-api/src/test/java/com/optimizely/ab/config/parser/JsonSimpleConfigParserTest.java

@@ -55,13 +55,24 @@ public void parseProjectConfigV2() throws Exception {
     }
 
     /**
-     * Verify that internal parser exceptions are wrapped and rethrown as a {@link ConfigParseException}.
+     * Verify that invalid JSON results in a {@link ConfigParseException} being thrown.
      */
     @Test
-    public void exceptionWrapping() throws Exception {
+    public void invalidJsonExceptionWrapping() throws Exception {
         thrown.expect(ConfigParseException.class);
 
         JsonSimpleConfigParser parser = new JsonSimpleConfigParser();
         parser.parseProjectConfig("invalid config");
     }
+
+    /**
+     * Verify that valid JSON without a required field results in a {@link ConfigParseException} being thrown.
+     */
+    @Test
+    public void validJsonRequiredFieldMissingExceptionWrapping() throws Exception {
+        thrown.expect(ConfigParseException.class);
+
+        JsonSimpleConfigParser parser = new JsonSimpleConfigParser();
+        parser.parseProjectConfig("{\"valid\": \"json\"}");
+    }
 }

gradle.properties

@@ -1,5 +1,5 @@
 # Maven version
-version = 1.0.1-SNAPSHOT
+version = 1.0.2-SNAPSHOT
 
 # Artifact paths
 mavenS3Bucket = optimizely-maven