feat: add targeting schema, improve def. schema

Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
open-feature · Jan 3, 2024 · 98d7c3f · 98d7c3f
1 parent 2552247
commit 98d7c3f
Show file tree

Hide file tree

Showing 4 changed files with 798 additions and 50 deletions.
diff --git a/json/examples/full.json b/json/examples/full.json
@@ -1,4 +1,5 @@
 {
+  "$schema": "../flagd-definitions.json",
   "flags": {
     "myBoolFlag": {
       "state": "ENABLED",
@@ -35,6 +36,244 @@
         }
       },
       "defaultVariant": "object1"
+    },
+    "fractional-flag": {
+      "state": "ENABLED",
+      "variants": {
+        "clubs": "clubs",
+        "diamonds": "diamonds",
+        "hearts": "hearts",
+        "spades": "spades",
+        "wild": "wild"
+      },
+      "defaultVariant": "wild",
+      "targeting": {
+        "fractional": [
+          { "var": "user.name" },
+          ["clubs", 25],
+          ["diamonds", 25],
+          ["hearts", 25],
+          ["spades", 25]
+        ]
+      }
+    },
+    "shorthand-fractional-flag": {
+      "state": "ENABLED",
+      "variants": {
+        "clubs": "clubs",
+        "diamonds": "diamonds",
+        "hearts": "hearts",
+        "spades": "spades",
+        "wild": "wild"
+      },
+      "defaultVariant": "wild",
+      "targeting": {
+        "fractional": [
+          ["clubs", 25],
+          ["diamonds", 25],
+          ["hearts", 25],
+          ["spades", 25]
+        ]
+      }
+    },
+    "starts-ends-flag": {
+      "state": "ENABLED",
+      "variants": {
+        "prefix": "prefix",
+        "postfix": "postfix",
+        "none": "none"
+      },
+      "defaultVariant": "none",
+      "targeting": {
+        "if": [
+          {
+            "starts_with": [{ "var": "id" }, "abc"]
+          },
+          "prefix",
+          {
+            "if": [
+              {
+                "ends_with": [{ "var": "id" }, "xyz"]
+              },
+              "postfix",
+              {
+                "if": [
+                  {
+                    "ends_with": [{ "var": "id" }, 3]
+                  },
+                  "fail",
+                  "none"
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    },
+    "equal-greater-lesser-version-flag": {
+      "state": "ENABLED",
+      "variants": {
+        "equal": "equal",
+        "greater": "greater",
+        "lesser": "lesser",
+        "none": "none"
+      },
+      "defaultVariant": "none",
+      "targeting": {
+        "if": [
+          {
+            "sem_ver": [{ "var": "version" }, "=", "2.0.0"]
+          },
+          "equal",
+          {
+            "if": [
+              {
+                "sem_ver": [{ "var": "version" }, ">", "2.0.0"]
+              },
+              "greater",
+              {
+                "if": [
+                  {
+                    "sem_ver": [{ "var": "version" }, "<", "2.0.0"]
+                  },
+                  "lesser",
+                  {
+                    "if": [
+                      {
+                        "sem_ver": [{ "var": "version" }, "=", "2.0.0.0"]
+                      },
+                      "fail",
+                      null
+                    ]
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    },
+    "major-minor-version-flag": {
+      "state": "ENABLED",
+      "variants": {
+        "minor": "minor",
+        "major": "major",
+        "none": "none"
+      },
+      "defaultVariant": "none",
+      "targeting": {
+        "if": [
+          {
+            "sem_ver": [{ "var": "version" }, "~", "3.0.0"]
+          },
+          "minor",
+          {
+            "if": [
+              {
+                "sem_ver": [{ "var": "version" }, "^", "3.0.0"]
+              },
+              "major",
+              "none"
+            ]
+          }
+        ]
+      }
+    },
+    "test-cat": {
+      "state": "ENABLED",
+      "variants": {
+        "minor": "minor",
+        "major": "major",
+        "none": "none"
+      },
+      "defaultVariant": "none",
+      "targeting": {
+        "cat": ["1", "@"]
+      }
+    },
+    "context-aware": {
+      "state": "ENABLED",
+      "variants": {
+        "internal": "INTERNAL",
+        "external": "EXTERNAL"
+      },
+      "defaultVariant": "external",
+      "targeting": {
+        "if": [
+          {
+            "and": [
+              {
+                "==": [
+                  {
+                    "var": ["fn"]
+                  },
+                  "Sulisław"
+                ]
+              },
+              {
+                "==": [
+                  {
+                    "var": ["ln"]
+                  },
+                  "Świętopełk"
+                ]
+              },
+              {
+                "==": [
+                  {
+                    "var": ["age"]
+                  },
+                  29
+                ]
+              },
+              {
+                "==": [
+                  {
+                    "var": ["customer"]
+                  },
+                  false
+                ]
+              }
+            ]
+          },
+          "internal",
+          "external"
+        ]
+      }
+    },
+    "timestamp-flag": {
+      "state": "ENABLED",
+      "variants": {
+        "past": -1,
+        "future": 1,
+        "none": 0
+      },
+      "defaultVariant": "none",
+      "targeting": {
+        "if": [
+          {
+            ">": [{ "var": "$flagd.timestamp" }, { "var": "time" }]
+          },
+          "past",
+          {
+            "if": [
+              {
+                "<": [{ "var": "$flagd.timestamp" }, { "var": "time" }]
+              },
+              "future",
+              "none"
+            ]
+          }
+        ]
+      }
+    },
+    "wrong-flag": {
+      "state": "ENABLED",
+      "variants": {
+        "one": "uno",
+        "two": "dos"
+      },
+      "defaultVariant": "one"
     }
   }
-}
+}
diff --git a/json/flagd-definitions.json b/json/flagd-definitions.json
@@ -5,64 +5,74 @@
   "type": "object",
   "properties": {
     "flags": {
+      "title": "Flags",
+      "description": "Top-level flags object. All flags are defined here.",
       "type": "object",
       "$comment": "flag objects are one of the 4 flag types defined in $defs",
       "additionalProperties": false,
       "patternProperties": {
         "^.{1,}$": {
+          "$comment": "'unevaluatedProperties': 'false' prevents additional props on a flag (ie: targetting)",
+          "unevaluatedProperties": false,
           "oneOf": [
             {
               "title": "Boolean flag",
-              "description": "A flag associated with boolean values",
+              "description": "A flag having boolean values.",
               "$ref": "#/$defs/booleanFlag"
             },
             {
               "title": "String flag",
-              "description": "A flag associated with string values",
+              "description": "A flag having string values.",
               "$ref": "#/$defs/stringFlag"
             },
             {
               "title": "Numeric flag",
-              "description": "A flag associated with numeric values",
+              "description": "A flag having numeric values.",
               "$ref": "#/$defs/numberFlag"
             },
             {
               "title": "Object flag",
-              "description": "A flag associated with arbitrary object values",
+              "description": "A flag having arbitrary object values.",
               "$ref": "#/$defs/objectFlag"
             }
           ]
         }
       }
+    },
+    "$evaluators": {
+      "title": "Evaluators",
+      "description": "Reusable targeting rules that can be referenced with \"$ref\": \"myRule\" in multiple flags.",
+      "type": "object",
+      "additionalProperties": false,
+      "patternProperties": {
+        "^.{1,}$": {
+          "$comment": "this relative ref means that targeting.json MUST be in the same dir, or available on the same HTTP path",
+          "$ref": "./targeting.json#/$defs/targeting"
+        }
+      }
     }
   },
   "$defs": {
     "flag": {
-      "title": "Flag Base",
-      "description": "Base object for all flags",
+      "$comment": "base flag object; no title/description here, allows for better UX, keep it in the overrides",
       "type": "object",
       "properties": {
         "state": {
-          "description": "Indicates whether the flag is functional. Disabled flags are treated as if they don't exist",
+          "title": "Flag State",
+          "description": "Indicates whether the flag is functional. Disabled flags are treated as if they don't exist.",
           "type": "string",
-          "enum": [
-            "ENABLED",
-            "DISABLED"
-          ]
+          "enum": ["ENABLED", "DISABLED"]
         },
         "defaultVariant": {
-          "description": "The variant to serve if no dynamic targeting applies",
+          "title": "Default Variant",
+          "description": "The variant to serve if no dynamic targeting applies (including if the targeting returns null).",
           "type": "string"
         },
         "targeting": {
-          "type": "object",
-          "description": "JsonLogic expressions to be used for dynamic evaluation. The \"context\" is passed as the data. Rules must resolve one of the defined variants, or the \"defaultVariant\" will be used."
+          "$ref": "./targeting.json#/$defs/targeting"
         }
       },
-      "required": [
-        "state",
-        "defaultVariant"
-      ]
+      "required": ["state", "defaultVariant"]
     },
     "booleanVariants": {
       "type": "object",
@@ -124,7 +134,7 @@
         }
       }
     },
-    "$comment": "Merge the variants with the base flag to build our typed flags",
+    "$comment": "merge the variants with the base flag to build our typed flags",
     "booleanFlag": {
       "allOf": [
         {