Targeting Update (#26)

* telemetry support

* updating from feedback

* Changes from design meeting

* formatting, updating samples

* fixing merge issue

* typing issue

* fixing test validations from changes

* Update test_json_validations.py

* Apply suggestions from code review

Co-authored-by: Zhiyuan Liang <[email protected]>

* Updating doc strings

* Spelling

* Updating async name.

* Adding missing eval reason. Fixed formatting.

* targeting changes

* Updating Readme and Samples

* Update feature_flag_with_azure_app_configuration_sample.py

* Updating return

* Comments + Async

* Updating passing around evaluation event

* formatting

* Adding more code comments

---------

Co-authored-by: Zhiyuan Liang <[email protected]>

Author: mrm9084

README.md

@@ -220,14 +220,16 @@ The Targeting Filter provides the capability to enable a feature for a target au
 You can provide the current user info through `kwargs` when calling `isEnabled`.
 
 ```python
+from featuremanagement import FeatureManager, TargetingContext
+
 # Returns true, because user1 is in the Users list
-feature_manager.is_enabled("Beta", user="user1", groups=["group1"])
+feature_manager.is_enabled("Beta", TargetingContext(user_id="user1", groups=["group1"]))
 
 # Returns false, because group2 is in the Exclusion.Groups list
-feature_manager.is_enabled("Beta", user="user1", groups=["group2"])
+feature_manager.is_enabled("Beta", TargetingContext(user_id="user1", groups=["group2"]))
 
 # Has a 50% chance of returning true, but will be conisistent for the same user
-feature_manager.is_enabled("Beta", user="user4")
+feature_manager.is_enabled("Beta", TargetingContext(user_id="user4"))
 ```
 
 #### Custom Filters

featuremanagement/__init__.py

@@ -6,9 +6,17 @@
 from ._featuremanager import FeatureManager
 from ._featurefilters import FeatureFilter
 from ._defaultfilters import TimeWindowFilter, TargetingFilter
-from ._models._variant import Variant
+from ._models import FeatureFlag, Variant, TargetingContext
 
 from ._version import VERSION
 
 __version__ = VERSION
-__all__ = ["FeatureManager", "TimeWindowFilter", "TargetingFilter", "FeatureFilter", "Variant"]
+__all__ = [
+    "FeatureManager",
+    "TimeWindowFilter",
+    "TargetingFilter",
+    "FeatureFilter",
+    "FeatureFlag",
+    "Variant",
+    "TargetingContext",
+]

featuremanagement/_defaultfilters.py

@@ -35,23 +35,22 @@
 
 class TargetingException(Exception):
     """
-    Exception raised when the targeting filter is not configured correctly
+    Exception raised when the targeting filter is not configured correctly.
     """
 
 
 @FeatureFilter.alias("Microsoft.TimeWindow")
 class TimeWindowFilter(FeatureFilter):
     """
-    Feature Filter that determines if the current time is within the time window
+    Feature Filter that determines if the current time is within the time window.
     """
 
     def evaluate(self, context, **kwargs):
         """
-        Determine if the feature flag is enabled for the given context
+        Determine if the feature flag is enabled for the given context.
 
-        :keyword Mapping context: Mapping with the Start and End time for the feature flag
-        :paramtype context: Mapping
-        :return: True if the current time is within the time window
+        :keyword Mapping context: Mapping with the Start and End time for the feature flag.
+        :return: True if the current time is within the time window.
         :rtype: bool
         """
         start = context.get(PARAMETERS_KEY, {}).get(START_KEY)
@@ -72,7 +71,7 @@ def evaluate(self, context, **kwargs):
 @FeatureFilter.alias("Microsoft.Targeting")
 class TargetingFilter(FeatureFilter):
     """
-    Feature Filter that determines if the user is targeted for the feature flag
+    Feature Filter that determines if the user is targeted for the feature flag.
     """
 
     @staticmethod
@@ -98,11 +97,10 @@ def _target_group(self, target_user, target_group, group, feature_flag_name):
 
     def evaluate(self, context, **kwargs):
         """
-        Determine if the feature flag is enabled for the given context
+        Determine if the feature flag is enabled for the given context.
 
-        :keyword Mapping context: Context for evaluating the user/group
-        :paramtype context: Mapping
-        :return: True if the user is targeted for the feature flag
+        :keyword Mapping context: Context for evaluating the user/group.
+        :return: True if the user is targeted for the feature flag.
         :rtype: bool
         """
         target_user = kwargs.get(TARGETED_USER_KEY, None)

featuremanagement/_featurefilters.py

@@ -8,24 +8,23 @@
 
 class FeatureFilter(ABC):
     """
-    Parent class for all feature filters
+    Parent class for all feature filters.
     """
 
     @abstractmethod
     def evaluate(self, context, **kwargs):
         """
-        Determine if the feature flag is enabled for the given context
+        Determine if the feature flag is enabled for the given context.
 
-        :param Mapping context: Context for the feature flag
-        :paramtype context: Mapping
+        :param Mapping context: Context for the feature flag.
         """
 
     @property
     def name(self):
         """
-        Get the name of the filter
+        Get the name of the filter.
 
-        :return: Name of the filter, or alias if it exists
+        :return: Name of the filter, or alias if it exists.
         :rtype: str
         """
         if hasattr(self, "_alias"):
@@ -35,10 +34,10 @@ def name(self):
     @staticmethod
     def alias(alias):
         """
-        Decorator to set the alias for the filter
+        Decorator to set the alias for the filter.
 
-        :param str alias: Alias for the filter
-        :return: Decorator
+        :param str alias: Alias for the filter.
+        :return: Decorator.
         :rtype: callable
         """