add current state and state transition matching

src/bitdrift_public/protobuf/matcher/v1/log_matcher.proto

@@ -9,6 +9,9 @@ syntax = "proto3";
 
 package bitdrift_public.protobuf.matcher.v1;
 
+import "bitdrift_public/protobuf/state/v1/matcher.proto";
+import "bitdrift_public/protobuf/state/v1/scope.proto";
+import "bitdrift_public/protobuf/value_matcher/v1/value_matcher.proto";
 import "validate/validate.proto";
 
 // A LogMatcher is used to declare a boolean expression which evaluates a log on various facets for matching.
@@ -19,66 +22,12 @@ message LogMatcher {
   // A base log matcher evaluates a log a specified facet using "oneof" the sub matcher types (String, Int, SemVer, etc).
   // These are required at a leaf level. A LogMatcher could consist of just a single BaseLogMatcher.
   message BaseLogMatcher {
-    // Used to compare values both numeric and string (lexicographically).
-    enum Operator {
-      reserved 8, 9;
-      OPERATOR_UNSPECIFIED = 0;
-      OPERATOR_LESS_THAN = 1;
-      OPERATOR_LESS_THAN_OR_EQUAL = 2;
-      // For double matching this is an epsilon comparison.
-      OPERATOR_EQUALS = 3;
-      OPERATOR_GREATER_THAN = 4;
-      OPERATOR_GREATER_THAN_OR_EQUAL = 5;
-      OPERATOR_NOT_EQUALS = 6;
-      // Only supported for values of type string, otherwise uses EQUALS.
-      OPERATOR_REGEX = 7;
-    }
-
-    // Used to define a match rule for a string value.
-    message StringValueMatch {
-      Operator operator = 1 [(validate.rules).enum.defined_only = true];
-      oneof string_value_match_type {
-        string match_value = 2 [(validate.rules).string = {min_len: 1}];
-        // Corresponds to a field saved from a previous match via the SaveField extension.
-        string save_field_id = 3;
-      }
-    }
-
-    // Used to define a match rule for a numeric value of type int32.
-    message IntValueMatch {
-      Operator operator = 1 [(validate.rules).enum.defined_only = true];
-      oneof int_value_match_type {
-        int32 match_value = 2;
-        // Corresponds to a field saved from a previous match via the SaveField extension.
-        string save_field_id = 3;
-      }
-    }
-
-    // Used to define a match rule for a numeric value of type double.
-    message DoubleValueMatch {
-      Operator operator = 1 [(validate.rules).enum.defined_only = true];
-      oneof double_value_match_type {
-        double match_value = 2;
-        // Corresponds to a field saved from a previous match via the SaveField extension.
-        string save_field_id = 3;
-      }
-    }
-
-    // Used to define a match rule for semantic versioning (e.g. 1.02.43).
-    message SemVerValueMatch {
-      Operator operator = 1 [(validate.rules).enum.defined_only = true];
-      string match_value = 2 [(validate.rules).string = {min_len: 1}];
-    }
-
     // Base matcher for evaluating the value of a log message.
     // Currently it only supports String matching but that could be extended in the future.
     message MessageMatch {
-      StringValueMatch string_value_match = 1;
+      value_matcher.v1.StringValueMatch string_value_match = 1;
     }
 
-    // Matcher to evaluate whether a value is set.
-    message IsSetMatch {}
-
     // Base matcher for evaluating the value in a tag _value_ on a specified key.
     message TagMatch {
       string tag_key = 1 [(validate.rules).string = {
@@ -87,39 +36,32 @@ message LogMatcher {
       }];
       oneof value_match {
         option (validate.required) = true;
-        StringValueMatch string_value_match = 2;
-        IntValueMatch int_value_match = 3;
-        SemVerValueMatch sem_ver_value_match = 4;
-        IsSetMatch is_set_match = 5;
-        DoubleValueMatch double_value_match = 6;
+        value_matcher.v1.StringValueMatch string_value_match = 2;
+        value_matcher.v1.IntValueMatch int_value_match = 3;
+        value_matcher.v1.SemVerValueMatch sem_ver_value_match = 4;
+        value_matcher.v1.IsSetMatch is_set_match = 5;
+        value_matcher.v1.DoubleValueMatch double_value_match = 6;
       }
     }
 
-    // Base matcher for evaluating the value of a feature flag.
-    message FeatureFlagMatch {
-      string flag_name = 1 [(validate.rules).string = {
-        min_len: 1
-        max_len: 64
-      }];
+    message StateMatch {
+      // The scope in which to look for the state key.
+      state.v1.StateScope scope = 1 [(validate.rules).enum.defined_only = true];
+      // The key of the state value to match against.
+      string state_key = 2 [(validate.rules).string = {min_len: 1}];
 
-      oneof value_match {
-        option (validate.required) = true;
-
-        // Matches against the string value of the feature flag variant. If the variant
-        // is not set we'll match against the empty string.
-        StringValueMatch string_value_match = 2;
-
-        // Matches if the feature flag is set (regardless of variant).
-        IsSetMatch is_set_match = 3;
-      }
+      // The matcher to use against the state value.
+      state.v1.StateValueMatch state_value_match = 3 [(validate.rules).message.required = true];
     }
 
     oneof match_type {
       option (validate.required) = true;
       MessageMatch message_match = 1;
       TagMatch tag_match = 2;
-      FeatureFlagMatch feature_flag_match = 3;
+      StateMatch state_match = 4;
     }
+
+    reserved 3;
   }
 
   // A list of two or more matchers. Used to allow using a list within a oneof for and/or matching.

src/bitdrift_public/protobuf/state/v1/matcher.proto

@@ -0,0 +1,25 @@
+// api - bitdrift's client/server API definitions
+// Copyright Bitdrift, Inc. All rights reserved.
+//
+// Use of this source code and APIs are governed by a source available license that can be found in
+// the LICENSE file or at:
+// https://polyformproject.org/wp-content/uploads/2020/06/PolyForm-Shield-1.0.0.txt
+
+syntax = "proto3";
+
+package bitdrift_public.protobuf.state.v1;
+
+import "bitdrift_public/protobuf/value_matcher/v1/value_matcher.proto";
+import "validate/validate.proto";
+
+// The matcher used to evaluate a state value. This is reused between log matching and state transition matching.
+message StateValueMatch {
+  oneof value_match {
+    option (validate.required) = true;
+
+    value_matcher.v1.StringValueMatch string_value_match = 3;
+    value_matcher.v1.IntValueMatch int_value_match = 4;
+    value_matcher.v1.DoubleValueMatch double_value_match = 5;
+    value_matcher.v1.IsSetMatch is_set_match = 6;
+  }
+}

src/bitdrift_public/protobuf/state/v1/payload.proto

@@ -21,9 +21,3 @@ message StateValue {
     bool bool_value = 4;
   }
 }
-
-// A key/value pair representing a state entry.
-message StateKeyValuePair {
-  string key = 1;
-  StateValue value = 2;
-}

src/bitdrift_public/protobuf/state/v1/scope.proto

@@ -0,0 +1,16 @@
+// api - bitdrift's client/server API definitions
+// Copyright Bitdrift, Inc. All rights reserved.
+//
+// Use of this source code and APIs are governed by a source available license that can be found in
+// the LICENSE file or at:
+// https://polyformproject.org/wp-content/uploads/2020/06/PolyForm-Shield-1.0.0.txt
+
+syntax = "proto3";
+
+package bitdrift_public.protobuf.state.v1;
+
+enum StateScope {
+  UNSPECIFIED = 0;
+  FEATURE_FLAG = 1;
+  GLOBAL_STATE = 2;
+}

src/bitdrift_public/protobuf/value_matcher/v1/value_matcher.proto

@@ -0,0 +1,66 @@
+// api - bitdrift's client/server API definitions
+// Copyright Bitdrift, Inc. All rights reserved.
+//
+// Use of this source code and APIs are governed by a source available license that can be found in
+// the LICENSE file or at:
+// https://polyformproject.org/wp-content/uploads/2020/06/PolyForm-Shield-1.0.0.txt
+
+syntax = "proto3";
+
+package bitdrift_public.protobuf.value_matcher.v1;
+
+import "validate/validate.proto";
+
+// Used to compare values both numeric and string (lexicographically).
+enum Operator {
+  reserved 8, 9;
+  OPERATOR_UNSPECIFIED = 0;
+  OPERATOR_LESS_THAN = 1;
+  OPERATOR_LESS_THAN_OR_EQUAL = 2;
+  // For double matching this is an epsilon comparison.
+  OPERATOR_EQUALS = 3;
+  OPERATOR_GREATER_THAN = 4;
+  OPERATOR_GREATER_THAN_OR_EQUAL = 5;
+  OPERATOR_NOT_EQUALS = 6;
+  // Only supported for values of type string, otherwise uses EQUALS.
+  OPERATOR_REGEX = 7;
+}
+
+// Used to define a match rule for a string value.
+message StringValueMatch {
+  Operator operator = 1 [(validate.rules).enum.defined_only = true];
+  oneof string_value_match_type {
+    string match_value = 2 [(validate.rules).string = {min_len: 1}];
+    // Corresponds to a field saved from a previous match via the SaveField extension.
+    string save_field_id = 3;
+  }
+}
+
+// Used to define a match rule for a numeric value of type int32.
+message IntValueMatch {
+  Operator operator = 1 [(validate.rules).enum.defined_only = true];
+  oneof int_value_match_type {
+    int32 match_value = 2;
+    // Corresponds to a field saved from a previous match via the SaveField extension.
+    string save_field_id = 3;
+  }
+}
+
+// Used to define a match rule for a numeric value of type double.
+message DoubleValueMatch {
+  Operator operator = 1 [(validate.rules).enum.defined_only = true];
+  oneof double_value_match_type {
+    double match_value = 2;
+    // Corresponds to a field saved from a previous match via the SaveField extension.
+    string save_field_id = 3;
+  }
+}
+
+// Used to define a match rule for semantic versioning (e.g. 1.02.43).
+message SemVerValueMatch {
+  Operator operator = 1 [(validate.rules).enum.defined_only = true];
+  string match_value = 2 [(validate.rules).string = {min_len: 1}];
+}
+
+// Matcher to evaluate whether a value is set.
+message IsSetMatch {}

src/bitdrift_public/protobuf/workflow/v1/workflow.proto

@@ -10,6 +10,8 @@ syntax = "proto3";
 package bitdrift_public.protobuf.workflow.v1;
 
 import "bitdrift_public/protobuf/matcher/v1/log_matcher.proto";
+import "bitdrift_public/protobuf/state/v1/matcher.proto";
+import "bitdrift_public/protobuf/state/v1/scope.proto";
 import "validate/validate.proto";
 
 // The wrapper for the list of workflows. Top-level item used to send information
@@ -86,6 +88,7 @@ message Workflow {
     oneof rule_type {
       option (validate.required) = true;
       RuleLogMatch rule_log_match = 1;
+      RuleStateChangeMatch rule_state_change_match = 3;
     }
 
     reserved 2;
@@ -144,6 +147,22 @@ message Workflow {
     uint32 count = 2 [(validate.rules).uint32.gt = 0];
   }
 
+  // Matches against a state change. Every time the value of a scoped key changes (new value is different from previous value),
+  // the rule evaluates whether the previous and new values match the specified conditions.
+  message RuleStateChangeMatch {
+    // The scope of the state to watch for.
+    state.v1.StateScope scope = 1 [(validate.rules).enum.defined_only = true];
+
+    // The key of the state to watch for.
+    string key = 2 [(validate.rules).string = {min_len: 1}];
+
+    // The match condition which is applied to the previous value of the state during a state change.
+    state.v1.StateValueMatch previous_value = 3;
+
+    // The match condition which is applied to the new value of the state during a state change.
+    state.v1.StateValueMatch new_value = 4 [(validate.rules).message = {required: true}];
+  }
+
   // An action to be taken when moving to a new state.
   message Action {
     oneof action_type {