v1.1.0

Author: jacopocarlini

README.md

@@ -1,11 +1,14 @@
 # Fast Feature-Flags Provider
+
 An [open feature](https://openfeature.dev/) provider to operate with MongoDB
 
 ---
 
 # Pre-requisites
+
 - MongoDB running (see for an example in `examples/docker-compose.yml`) )
 - import the dependency in your `pom.xml` and add the GitHub repository. You need a PAT token with read packages scope.
+
 ``` xml
     <dependency>
         <groupId>com.github.jacopocarlini</groupId>
@@ -24,7 +27,13 @@ An [open feature](https://openfeature.dev/) provider to operate with MongoDB
 
 # How To Use
 
+There are two versions of this provider: the `MongoDBFeatureFlagProvider`, which implements only the basic openFeature
+methods to evaluate flags,
+and the `MongoDBFeatureFlagProviderExtended`, which includes additional methods for retrieving, creating, deleting, and
+updating flags.
+
 In your Java class:
+
 ``` java
   import it.jacopocarlini.fffp.providers.MongoDBFeatureFlagProvider;
   ...
@@ -33,8 +42,8 @@ In your Java class:
     OpenFeatureAPI openFeatureAPI = OpenFeatureAPI.getInstance();
 
     // set the connection string
-    MongoDBFeatureFlagProvider provider =
-        new MongoDBFeatureFlagProvider(
+    MongoDBFeatureFlagProviderExtended provider =
+        new MongoDBFeatureFlagProviderExtended(
             "mongodb://user:adminpassword@localhost:27017/openfeature?authSource=admin");
     openFeatureAPI.setProvider(provider);
 
@@ -65,11 +74,23 @@ In your Java class:
 }
 ```
 
-If the flag is not enabled the value will be the `defaultValue` passed in `client.getStringValue("font", "10")`. 
+If the flag is not enabled the value will be the `defaultValue` passed in `client.getStringValue("font", "10")`.
+
+| Parameter      | Required | Description            |
+|----------------|----------|------------------------|
+| flagKey        | yes      | the flag key           |
+| enabled        | yes      | if the flag is enabled |
+| variants       | yes      | a map of variants      | 
+| defaultVariant | yes      | the default variant    |
+| timeWindow     | no       | the time window        |
+| target         | no       | the target             |
+| rollout        | no       | the rollout percentage |
 
 ## Set a Time Window
-You can set a time window to evaluate the flag. 
-If the current time is outside the time window the flag will always be  disabled.
+
+You can set a time window to evaluate the flag.
+If the current time is outside the time window the flag will always be disabled.
+
 ``` java
 Flag.builder()
     ...
@@ -101,6 +122,7 @@ Flag.builder()
 ```
 
 ## Set a Rollout Percentage
+
 You can set a rollout percentage foreach variant.
 
 ``` java
@@ -117,6 +139,6 @@ Flag.builder()
     .build();
 ```
 
-> **_NOTE:_** When a target key is provided in the context, 
+> **_NOTE:_** When a target key is provided in the context,
 > the random assigned variant is persisted and used on subsequent evaluations, overriding the rollout percentage.
 > When the rollout percentage is modified or deleted, the assigned variant is also removed.

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.github.jacopocarlini</groupId>
     <artifactId>fast-feature-flags-provider</artifactId>
-    <version>1.0.7</version>
+    <version>1.1.0</version>
     <packaging>jar</packaging>
 
 
@@ -33,12 +33,7 @@
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-data-mongodb</artifactId>
-        </dependency>
-
-        <dependency>
-            <groupId>org.projectlombok</groupId>
-            <artifactId>lombok</artifactId>
-            <optional>true</optional>
+            <version>3.4.2</version>
         </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
@@ -50,6 +45,22 @@
             <artifactId>sdk</artifactId>
             <version>1.14.0</version>
         </dependency>
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <version>1.18.36</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>2.17.2</version>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-validation</artifactId>
+        </dependency>
+
     </dependencies>
     <repositories>
         <repository>

src/main/java/com/github/jacopocarlini/fffp/config/MongoClientManager.java

@@ -9,22 +9,22 @@
 import org.springframework.data.mongodb.core.MongoTemplate;
 
 /**
- * Manages the MongoDB client and provides a MongoTemplate for database interactions.
- * Ensures thread-safe operations when updating the connection settings.
+ * Manages the MongoDB client and provides a MongoTemplate for database interactions. Ensures
+ * thread-safe operations when updating the connection settings.
  */
 public class MongoClientManager {
   private final Lock lock = new ReentrantLock();
   private MongoClient mongoClient;
   private MongoTemplate mongoTemplate;
   private String currentConnectionString = null;
 
-
   /**
-   * Updates the MongoDB connection. Closes the current connection if it exists and establishes a new one
-   * with the provided connection string.
+   * Updates the MongoDB connection. Closes the current connection if it exists and establishes a
+   * new one with the provided connection string.
    *
    * @param newConnectionString the new MongoDB connection string
-   * @throws IllegalStateException if the MongoDB database name is not specified in the connection string
+   * @throws IllegalStateException if the MongoDB database name is not specified in the connection
+   *     string
    */
   public void updateConnection(String newConnectionString) {
     lock.lock();
@@ -53,9 +53,7 @@ public void updateConnection(String newConnectionString) {
     }
   }
 
-  /**
-   * Shuts down the MongoClient, closing any open connections.
-   */
+  /** Shuts down the MongoClient, closing any open connections. */
   public void shutdown() {
     if (mongoClient != null) {
       mongoClient.close();

src/main/java/com/github/jacopocarlini/fffp/entity/AssignedTarget.java

@@ -1,16 +1,13 @@
 package com.github.jacopocarlini.fffp.entity;
 
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.ToString;
+import lombok.*;
 import org.springframework.data.mongodb.core.index.Indexed;
 import org.springframework.data.mongodb.core.mapping.Document;
 
-@Builder
+@Builder(toBuilder = true)
 @Data
-@ToString
-@AllArgsConstructor
+@AllArgsConstructor(access = AccessLevel.PUBLIC)
+@NoArgsConstructor(access = AccessLevel.PUBLIC)
 @Document(collection = "assignedTarget")
 public class AssignedTarget {
 

src/main/java/com/github/jacopocarlini/fffp/entity/Flag.java

@@ -3,30 +3,34 @@
 import java.time.LocalDateTime;
 import java.util.List;
 import java.util.Map;
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.ToString;
+
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Size;
+import lombok.*;
 import org.springframework.data.annotation.Id;
 import org.springframework.data.mongodb.core.index.Indexed;
 import org.springframework.data.mongodb.core.mapping.Document;
 
 @Builder(toBuilder = true)
 @Data
-@AllArgsConstructor
-@ToString
+@AllArgsConstructor(access = AccessLevel.PUBLIC)
+@NoArgsConstructor(access = AccessLevel.PUBLIC)
 @Document(collection = "flags")
 public class Flag {
 
-  @Id
-  private String id;
+  @Id private String id;
 
   @Indexed(unique = true)
+  @NotBlank
   private String flagKey;
 
+  @NotNull
   private Boolean enabled;
 
+  @Size(min = 1)
   private Map<String, Object> variants;
+  @NotBlank
   private String defaultVariant;
 
   private List<Target> target;

src/main/java/com/github/jacopocarlini/fffp/entity/Target.java

@@ -1,16 +1,16 @@
 package com.github.jacopocarlini.fffp.entity;
 
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.ToString;
+import jakarta.validation.constraints.NotBlank;
+import lombok.*;
 
+@Builder(toBuilder = true)
 @Data
-@Builder
-@ToString
-@AllArgsConstructor
+@AllArgsConstructor(access = AccessLevel.PUBLIC)
+@NoArgsConstructor(access = AccessLevel.PUBLIC)
 public class Target {
 
+  @NotBlank
   private String filter;
+  @NotBlank
   private String variant;
 }

src/main/java/com/github/jacopocarlini/fffp/exceptions/FeatureFlagEvaluationException.java

@@ -1,6 +1,6 @@
-package it.jacopocarlini.fffp.exceptions;
+package com.github.jacopocarlini.fffp.exceptions;
 
-public class FeatureFlagEvaluationException extends RuntimeException {
+public class FeatureFlagEvaluationException extends Exception {
   public FeatureFlagEvaluationException(String message, Throwable cause) {
     super(message, cause);
   }

src/main/java/com/github/jacopocarlini/fffp/exceptions/InvalidFeatureFlagException.java

@@ -1,6 +1,6 @@
-package it.jacopocarlini.fffp.exceptions;
+package com.github.jacopocarlini.fffp.exceptions;
 
-public class InvalidFeatureFlagException extends RuntimeException {
+public class InvalidFeatureFlagException extends Exception {
   public InvalidFeatureFlagException(String message) {
     super(message);
   }

src/main/java/com/github/jacopocarlini/fffp/providers/MongoDBFeatureFlagProvider.java

@@ -1,23 +1,22 @@
 package com.github.jacopocarlini.fffp.providers;
 
+import static com.github.jacopocarlini.fffp.util.ProviderUtility.*;
+import static com.github.jacopocarlini.fffp.util.Reason.*;
 
 import com.github.jacopocarlini.fffp.config.MongoClientManager;
 import com.github.jacopocarlini.fffp.entity.AssignedTarget;
 import com.github.jacopocarlini.fffp.entity.Flag;
+import com.github.jacopocarlini.fffp.exceptions.InvalidFeatureFlagException;
 import com.github.jacopocarlini.fffp.repository.AssignedTargetRepository;
 import com.github.jacopocarlini.fffp.repository.FlagRepository;
 import dev.openfeature.sdk.*;
-import java.util.List;
 import java.util.Optional;
 
-import static com.github.jacopocarlini.fffp.util.ProviderUtility.*;
-import static com.github.jacopocarlini.fffp.util.Reason.*;
-
 public class MongoDBFeatureFlagProvider extends EventProvider {
 
-  private final FlagRepository flagRepository;
+  protected final FlagRepository flagRepository;
 
-  private final AssignedTargetRepository assignedTargetRepository;
+  protected final AssignedTargetRepository assignedTargetRepository;
 
   private final MongoClientManager mongoClientManager;
 
@@ -69,51 +68,6 @@ public ProviderEvaluation<Value> getObjectEvaluation(
     return evaluation(flagKey, defaultValue, ctx, Value.class);
   }
 
-  public List<Flag> getFlags() {
-    return flagRepository.findAll();
-  }
-
-  public Flag getFlag(String flagKey) {
-    return getFlagIfIsPresent(flagKey);
-  }
-
-  public void crateFlag(Flag flag) {
-    var isPresent = flagRepository.findFirstByFlagKey(flag.getFlagKey()).isPresent();
-    if (isPresent) {
-      throw new it.jacopocarlini.fffp.exceptions.InvalidFeatureFlagException("Conflict. Flag already present");
-    }
-
-    checkRolloutPercentage(flag);
-    checkVariant(flag);
-
-    flagRepository.save(flag);
-  }
-
-  public void updateFlag(String flagKey, Flag newFlag) {
-    var flag = getFlagIfIsPresent(flagKey);
-
-    checkRolloutPercentage(newFlag);
-    checkVariant(newFlag);
-
-    newFlag.setId(flag.getId());
-
-    if (newFlag.getRolloutPercentage() == null
-        || newFlag.getRolloutPercentage().equals(flag.getRolloutPercentage())) {
-      assignedTargetRepository.deleteAllByFlagKey(flagKey);
-    }
-
-    flagRepository.save(newFlag);
-  }
-
-  public void deleteFlag(String flagKey) {
-    var flag = flagRepository.findFirstByFlagKey(flagKey);
-    if (flag.isEmpty()) {
-      throw new it.jacopocarlini.fffp.exceptions.InvalidFeatureFlagException("Flag not found");
-    }
-    assignedTargetRepository.deleteAllByFlagKey(flagKey);
-    flagRepository.deleteByFlagKey(flagKey);
-  }
-
   private <T> ProviderEvaluation<T> evaluation(
       String flagKey, T defaultValue, EvaluationContext ctx, Class<T> valueType) {
     try {
@@ -153,10 +107,8 @@ private <T> ProviderEvaluation<T> evaluation(
           .reason("default variant")
           .build();
 
-    } catch (ClassCastException e) {
-      throw new it.jacopocarlini.fffp.exceptions.FeatureFlagEvaluationException("Value type mismatch for flag: " + flagKey, e);
     } catch (Exception e) {
-      throw new it.jacopocarlini.fffp.exceptions.FeatureFlagEvaluationException("Error evaluating flag: " + flagKey, e);
+      return createDefaultEvaluation(defaultValue, INVALID_FLAG_DATA.name());
     }
   }
 
@@ -169,7 +121,7 @@ private <T> ProviderEvaluation<T> createDefaultEvaluation(T defaultValue, String
   }
 
   private <T> ProviderEvaluation<T> handleRollout(
-      Flag flag, EvaluationContext ctx, Class<T> valueType) {
+      Flag flag, EvaluationContext ctx, Class<T> valueType) throws InvalidFeatureFlagException {
     String targetKey = ctx.getTargetingKey();
     String variant = determineVariantForRollout(flag);
     if (targetKey != null) {
@@ -195,12 +147,4 @@ private <T> ProviderEvaluation<T> handleRollout(
         .variant(variant)
         .build();
   }
-
-  private Flag getFlagIfIsPresent(String flagKey) {
-    var flag = flagRepository.findFirstByFlagKey(flagKey);
-    if (flag.isEmpty()) {
-      throw new it.jacopocarlini.fffp.exceptions.InvalidFeatureFlagException("Flag not found");
-    }
-    return flag.get();
-  }
 }