fix(flags): Update relative date op names (#113)

Co-authored-by: Neil Kakkar <neilkakkar@gmail.com>

CHANGELOG.md

@@ -1,3 +1,12 @@
+## 3.3.3 - 2024-01-26
+
+1. Remove new relative date operators, combine into regular date operators
+
+## 3.3.2 - 2024-01-19
+
+1. Return success/failure with all capture calls from module functions
+
+
 ## 3.3.1 - 2024-01-10
 
 1. Make sure we don't override any existing feature flag properties when adding locally evaluated feature flag properties.

posthog/__init__.py

@@ -1,5 +1,5 @@
 import datetime  # noqa: F401
-from typing import Callable, Dict, Optional  # noqa: F401
+from typing import Callable, Dict, Optional, Tuple  # noqa: F401
 
 from posthog.client import Client
 from posthog.version import VERSION
@@ -33,7 +33,7 @@ def capture(
     send_feature_flags=False,
     disable_geoip=None,  # type: Optional[bool]
 ):
-    # type: (...) -> None
+    # type: (...) -> Tuple[bool, dict]
     """
     Capture allows you to capture anything a user does within your system, which you can later use in PostHog to find patterns in usage, work out which features to improve or where people are giving up.
 
@@ -54,7 +54,7 @@ def capture(
     posthog.capture('distinct id', 'purchase', groups={'company': 'id:5'})
     ```
     """
-    _proxy(
+    return _proxy(
         "capture",
         distinct_id=distinct_id,
         event=event,
@@ -76,7 +76,7 @@ def identify(
     uuid=None,  # type: Optional[str]
     disable_geoip=None,  # type: Optional[bool]
 ):
-    # type: (...) -> None
+    # type: (...) -> Tuple[bool, dict]
     """
     Identify lets you add metadata on your users so you can more easily identify who they are in PostHog, and even do things like segment users by these properties.
 
@@ -92,7 +92,7 @@ def identify(
     })
     ```
     """
-    _proxy(
+    return _proxy(
         "identify",
         distinct_id=distinct_id,
         properties=properties,
@@ -111,7 +111,7 @@ def set(
     uuid=None,  # type: Optional[str]
     disable_geoip=None,  # type: Optional[bool]
 ):
-    # type: (...) -> None
+    # type: (...) -> Tuple[bool, dict]
     """
     Set properties on a user record.
     This will overwrite previous people property values, just like `identify`.
@@ -127,7 +127,7 @@ def set(
      })
      ```
     """
-    _proxy(
+    return _proxy(
         "set",
         distinct_id=distinct_id,
         properties=properties,
@@ -146,7 +146,7 @@ def set_once(
     uuid=None,  # type: Optional[str]
     disable_geoip=None,  # type: Optional[bool]
 ):
-    # type: (...) -> None
+    # type: (...) -> Tuple[bool, dict]
     """
     Set properties on a user record, only if they do not yet exist.
     This will not overwrite previous people property values, unlike `identify`.
@@ -162,7 +162,7 @@ def set_once(
      })
      ```
     """
-    _proxy(
+    return _proxy(
         "set_once",
         distinct_id=distinct_id,
         properties=properties,
@@ -182,7 +182,7 @@ def group_identify(
     uuid=None,  # type: Optional[str]
     disable_geoip=None,  # type: Optional[bool]
 ):
-    # type: (...) -> None
+    # type: (...) -> Tuple[bool, dict]
     """
     Set properties on a group
 
@@ -198,7 +198,7 @@ def group_identify(
      })
      ```
     """
-    _proxy(
+    return _proxy(
         "group_identify",
         group_type=group_type,
         group_key=group_key,
@@ -218,7 +218,7 @@ def alias(
     uuid=None,  # type: Optional[str]
     disable_geoip=None,  # type: Optional[bool]
 ):
-    # type: (...) -> None
+    # type: (...) -> Tuple[bool, dict]
     """
     To marry up whatever a user does before they sign up or log in with what they do after you need to make an alias call. This will allow you to answer questions like "Which marketing channels leads to users churning after a month?" or "What do users do on our website before signing up?"
 
@@ -235,7 +235,7 @@ def alias(
     posthog.alias('anonymous session id', 'distinct id')
     ```
     """
-    _proxy(
+    return _proxy(
         "alias",
         previous_id=previous_id,
         distinct_id=distinct_id,

posthog/client.py

@@ -464,7 +464,16 @@ class Client(object):
             self.poller = Poller(interval=timedelta(seconds=self.poll_interval), execute=self._load_feature_flags)
             self.poller.start()
 
-    def _compute_flag_locally(self, feature_flag, distinct_id, *, groups={}, person_properties={}, group_properties={}):
+    def _compute_flag_locally(
+        self,
+        feature_flag,
+        distinct_id,
+        *,
+        groups={},
+        person_properties={},
+        group_properties={},
+        warn_on_unknown_groups=True,
+    ):
         if feature_flag.get("ensure_experience_continuity", False):
             raise InconclusiveMatchError("Flag has experience continuity enabled")
 
@@ -486,9 +495,14 @@ class Client(object):
             if group_name not in groups:
                 # Group flags are never enabled in `groups` aren't passed in
                 # don't failover to `/decide/`, since response will be the same
-                self.log.warning(
-                    f"[FEATURE FLAGS] Can't compute group feature flag: {feature_flag['key']} without group names passed in"
-                )
+                if warn_on_unknown_groups:
+                    self.log.warning(
+                        f"[FEATURE FLAGS] Can't compute group feature flag: {feature_flag['key']} without group names passed in"
+                    )
+                else:
+                    self.log.debug(
+                        f"[FEATURE FLAGS] Can't compute group feature flag: {feature_flag['key']} without group names passed in"
+                    )
                 return False
 
             focused_group_properties = group_properties[group_name]
@@ -717,7 +731,9 @@ class Client(object):
 
         return response
 
-    def _get_all_flags_and_payloads_locally(self, distinct_id, *, groups={}, person_properties={}, group_properties={}):
+    def _get_all_flags_and_payloads_locally(
+        self, distinct_id, *, groups={}, person_properties={}, group_properties={}, warn_on_unknown_groups=False
+    ):
         require("distinct_id", distinct_id, ID_TYPES)
         require("groups", groups, dict)
 
@@ -737,6 +753,7 @@ class Client(object):
                         groups=groups,
                         person_properties=person_properties,
                         group_properties=group_properties,
+                        warn_on_unknown_groups=warn_on_unknown_groups,
                     )
                     matched_payload = self._compute_payload_locally(flag["key"], flags[flag["key"]])
                     if matched_payload:
@@ -756,7 +773,7 @@ class Client(object):
         return self.feature_flags
 
     def _add_local_person_and_group_properties(self, distinct_id, groups, person_properties, group_properties):
-        all_person_properties = {"$current_distinct_id": distinct_id, **(person_properties or {})}
+        all_person_properties = {"distinct_id": distinct_id, **(person_properties or {})}
 
         all_group_properties = {}
         if groups:

posthog/feature_flags.py

@@ -175,11 +175,11 @@ def match_property(property, property_values) -> bool:
         else:
             return compare(str(override_value), str(value), operator)
 
-    if operator in ["is_date_before", "is_date_after", "is_relative_date_before", "is_relative_date_after"]:
+    if operator in ["is_date_before", "is_date_after"]:
         try:
-            if operator in ["is_relative_date_before", "is_relative_date_after"]:
-                parsed_date = relative_date_parse_for_feature_flag_matching(str(value))
-            else:
+            parsed_date = relative_date_parse_for_feature_flag_matching(str(value))
+
+            if not parsed_date:
                 parsed_date = parser.parse(str(value))
                 parsed_date = convert_to_datetime_aware(parsed_date)
         except Exception as e:
@@ -190,12 +190,12 @@ def match_property(property, property_values) -> bool:
 
         if isinstance(override_value, datetime.datetime):
             override_date = convert_to_datetime_aware(override_value)
-            if operator in ("is_date_before", "is_relative_date_before"):
+            if operator == "is_date_before":
                 return override_date < parsed_date
             else:
                 return override_date > parsed_date
         elif isinstance(override_value, datetime.date):
-            if operator in ("is_date_before", "is_relative_date_before"):
+            if operator == "is_date_before":
                 return override_value < parsed_date.date()
             else:
                 return override_value > parsed_date.date()
@@ -203,7 +203,7 @@ def match_property(property, property_values) -> bool:
             try:
                 override_date = parser.parse(override_value)
                 override_date = convert_to_datetime_aware(override_date)
-                if operator in ("is_date_before", "is_relative_date_before"):
+                if operator == "is_date_before":
                     return override_date < parsed_date
                 else:
                     return override_date > parsed_date
@@ -302,7 +302,7 @@ def match_property_group(property_group, property_values, cohort_properties) ->
 
 
 def relative_date_parse_for_feature_flag_matching(value: str) -> Optional[datetime.datetime]:
-    regex = r"^(?P<number>[0-9]+)(?P<interval>[a-z])$"
+    regex = r"^-?(?P<number>[0-9]+)(?P<interval>[a-z])$"
     match = re.search(regex, value)
     parsed_dt = datetime.datetime.now(datetime.timezone.utc)
     if match:

posthog/sentry/posthog_integration.py

@@ -43,9 +43,9 @@ class PostHogIntegration(Integration):
                             not not Hub.current.client.dsn and Dsn(Hub.current.client.dsn).project_id
                         )
                         if project_id:
-                            properties[
-                                "$sentry_url"
-                            ] = f"{PostHogIntegration.prefix}{PostHogIntegration.organization}/issues/?project={project_id}&query={event['event_id']}"
+                            properties["$sentry_url"] = (
+                                f"{PostHogIntegration.prefix}{PostHogIntegration.organization}/issues/?project={project_id}&query={event['event_id']}"
+                            )
 
                     posthog.capture(posthog_distinct_id, "$exception", properties)
 

posthog/test/test_client.py

@@ -783,7 +783,7 @@ class TestClient(unittest.TestCase):
             timeout=10,
             distinct_id="some_id",
             groups={},
-            person_properties={"$current_distinct_id": "some_id"},
+            person_properties={"distinct_id": "some_id"},
             group_properties={},
             disable_geoip=True,
         )
@@ -795,7 +795,7 @@ class TestClient(unittest.TestCase):
             timeout=10,
             distinct_id="feature_enabled_distinct_id",
             groups={},
-            person_properties={"$current_distinct_id": "feature_enabled_distinct_id"},
+            person_properties={"distinct_id": "feature_enabled_distinct_id"},
             group_properties={},
             disable_geoip=True,
         )
@@ -807,7 +807,7 @@ class TestClient(unittest.TestCase):
             timeout=10,
             distinct_id="all_flags_payloads_id",
             groups={},
-            person_properties={"$current_distinct_id": "all_flags_payloads_id"},
+            person_properties={"distinct_id": "all_flags_payloads_id"},
             group_properties={},
             disable_geoip=False,
         )
@@ -843,7 +843,7 @@ class TestClient(unittest.TestCase):
             timeout=10,
             distinct_id="some_id",
             groups={"company": "id:5", "instance": "app.posthog.com"},
-            person_properties={"$current_distinct_id": "some_id", "x1": "y1"},
+            person_properties={"distinct_id": "some_id", "x1": "y1"},
             group_properties={
                 "company": {"$group_key": "id:5", "x": "y"},
                 "instance": {"$group_key": "app.posthog.com"},
@@ -856,7 +856,7 @@ class TestClient(unittest.TestCase):
             "random_key",
             "some_id",
             groups={"company": "id:5", "instance": "app.posthog.com"},
-            person_properties={"$current_distinct_id": "override"},
+            person_properties={"distinct_id": "override"},
             group_properties={
                 "company": {
                     "$group_key": "group_override",
@@ -869,7 +869,7 @@ class TestClient(unittest.TestCase):
             timeout=10,
             distinct_id="some_id",
             groups={"company": "id:5", "instance": "app.posthog.com"},
-            person_properties={"$current_distinct_id": "override"},
+            person_properties={"distinct_id": "override"},
             group_properties={
                 "company": {"$group_key": "group_override"},
                 "instance": {"$group_key": "app.posthog.com"},
@@ -886,7 +886,7 @@ class TestClient(unittest.TestCase):
             timeout=10,
             distinct_id="some_id",
             groups={},
-            person_properties={"$current_distinct_id": "some_id"},
+            person_properties={"distinct_id": "some_id"},
             group_properties={},
             disable_geoip=False,
         )

posthog/test/test_feature_flags.py

@@ -1873,7 +1873,7 @@ class TestMatchProperties(unittest.TestCase):
 
     @freeze_time("2022-05-01")
     def test_match_property_relative_date_operators(self):
-        property_a = self.property(key="key", value="6h", operator="is_relative_date_before")
+        property_a = self.property(key="key", value="-6h", operator="is_date_before")
         self.assertTrue(match_property(property_a, {"key": "2022-03-01"}))
         self.assertTrue(match_property(property_a, {"key": "2022-04-30"}))
         self.assertTrue(match_property(property_a, {"key": datetime.datetime(2022, 4, 30, 1, 2, 3)}))
@@ -1898,7 +1898,7 @@ class TestMatchProperties(unittest.TestCase):
         with self.assertRaises(InconclusiveMatchError):
             match_property(property_a, {"key": "abcdef"})
 
-        property_b = self.property(key="key", value="1h", operator="is_relative_date_after")
+        property_b = self.property(key="key", value="1h", operator="is_date_after")
         self.assertTrue(match_property(property_b, {"key": "2022-05-02"}))
         self.assertTrue(match_property(property_b, {"key": "2022-05-30"}))
         self.assertTrue(match_property(property_b, {"key": datetime.datetime(2022, 5, 30)}))
@@ -1910,16 +1910,16 @@ class TestMatchProperties(unittest.TestCase):
             self.assertFalse(match_property(property_b, {"key": "abcdef"}))
 
         # Invalid flag property
-        property_c = self.property(key="key", value=1234, operator="is_relative_date_after")
+        property_c = self.property(key="key", value=1234, operator="is_date_after")
 
         with self.assertRaises(InconclusiveMatchError):
             self.assertFalse(match_property(property_c, {"key": 1}))
 
-        with self.assertRaises(InconclusiveMatchError):
-            self.assertFalse(match_property(property_c, {"key": "2022-05-30"}))
+        # parsed as 1234-05-01 for some reason?
+        self.assertTrue(match_property(property_c, {"key": "2022-05-30"}))
 
         # # Timezone aware property
-        property_d = self.property(key="key", value="12d", operator="is_relative_date_before")
+        property_d = self.property(key="key", value="12d", operator="is_date_before")
         self.assertFalse(match_property(property_d, {"key": "2022-05-30"}))
 
         self.assertTrue(match_property(property_d, {"key": "2022-03-30"}))
@@ -1929,45 +1929,45 @@ class TestMatchProperties(unittest.TestCase):
         self.assertFalse(match_property(property_d, {"key": "2022-04-19 02:00:01+02:00"}))
 
         # Try all possible relative dates
-        property_e = self.property(key="key", value="1h", operator="is_relative_date_before")
+        property_e = self.property(key="key", value="1h", operator="is_date_before")
         self.assertFalse(match_property(property_e, {"key": "2022-05-01 00:00:00"}))
         self.assertTrue(match_property(property_e, {"key": "2022-04-30 22:00:00"}))
 
-        property_f = self.property(key="key", value="1d", operator="is_relative_date_before")
+        property_f = self.property(key="key", value="-1d", operator="is_date_before")
         self.assertTrue(match_property(property_f, {"key": "2022-04-29 23:59:00"}))
         self.assertFalse(match_property(property_f, {"key": "2022-04-30 00:00:01"}))
 
-        property_g = self.property(key="key", value="1w", operator="is_relative_date_before")
+        property_g = self.property(key="key", value="1w", operator="is_date_before")
         self.assertTrue(match_property(property_g, {"key": "2022-04-23 00:00:00"}))
         self.assertFalse(match_property(property_g, {"key": "2022-04-24 00:00:00"}))
         self.assertFalse(match_property(property_g, {"key": "2022-04-24 00:00:01"}))
 
-        property_h = self.property(key="key", value="1m", operator="is_relative_date_before")
+        property_h = self.property(key="key", value="1m", operator="is_date_before")
         self.assertTrue(match_property(property_h, {"key": "2022-03-01 00:00:00"}))
         self.assertFalse(match_property(property_h, {"key": "2022-04-05 00:00:00"}))
 
-        property_i = self.property(key="key", value="1y", operator="is_relative_date_before")
+        property_i = self.property(key="key", value="1y", operator="is_date_before")
         self.assertTrue(match_property(property_i, {"key": "2021-04-28 00:00:00"}))
         self.assertFalse(match_property(property_i, {"key": "2021-05-01 00:00:01"}))
 
-        property_j = self.property(key="key", value="122h", operator="is_relative_date_after")
+        property_j = self.property(key="key", value="122h", operator="is_date_after")
         self.assertTrue(match_property(property_j, {"key": "2022-05-01 00:00:00"}))
         self.assertFalse(match_property(property_j, {"key": "2022-04-23 01:00:00"}))
 
-        property_k = self.property(key="key", value="2d", operator="is_relative_date_after")
+        property_k = self.property(key="key", value="2d", operator="is_date_after")
         self.assertTrue(match_property(property_k, {"key": "2022-05-01 00:00:00"}))
         self.assertTrue(match_property(property_k, {"key": "2022-04-29 00:00:01"}))
         self.assertFalse(match_property(property_k, {"key": "2022-04-29 00:00:00"}))
 
-        property_l = self.property(key="key", value="02w", operator="is_relative_date_after")
+        property_l = self.property(key="key", value="-02w", operator="is_date_after")
         self.assertTrue(match_property(property_l, {"key": "2022-05-01 00:00:00"}))
         self.assertFalse(match_property(property_l, {"key": "2022-04-16 00:00:00"}))
 
-        property_m = self.property(key="key", value="1m", operator="is_relative_date_after")
+        property_m = self.property(key="key", value="1m", operator="is_date_after")
         self.assertTrue(match_property(property_m, {"key": "2022-04-01 00:00:01"}))
         self.assertFalse(match_property(property_m, {"key": "2022-04-01 00:00:00"}))
 
-        property_n = self.property(key="key", value="1y", operator="is_relative_date_after")
+        property_n = self.property(key="key", value="1y", operator="is_date_after")
         self.assertTrue(match_property(property_n, {"key": "2022-05-01 00:00:00"}))
         self.assertTrue(match_property(property_n, {"key": "2021-05-01 00:00:01"}))
         self.assertFalse(match_property(property_n, {"key": "2021-05-01 00:00:00"}))

posthog/test/test_module.py

@@ -6,6 +6,10 @@ from posthog import Posthog
 class TestModule(unittest.TestCase):
     posthog = None
 
+    def _assert_enqueue_result(self, result):
+        self.assertEqual(type(result[0]), bool)
+        self.assertEqual(type(result[1]), dict)
+
     def failed(self):
         self.failed = True
 
@@ -22,15 +26,18 @@ class TestModule(unittest.TestCase):
         self.assertRaises(Exception, self.posthog.capture)
 
     def test_track(self):
-        self.posthog.capture("distinct_id", "python module event")
+        res = self.posthog.capture("distinct_id", "python module event")
+        self._assert_enqueue_result(res)
         self.posthog.flush()
 
     def test_identify(self):
-        self.posthog.identify("distinct_id", {"email": "user@email.com"})
+        res = self.posthog.identify("distinct_id", {"email": "user@email.com"})
+        self._assert_enqueue_result(res)
         self.posthog.flush()
 
     def test_alias(self):
-        self.posthog.alias("previousId", "distinct_id")
+        res = self.posthog.alias("previousId", "distinct_id")
+        self._assert_enqueue_result(res)
         self.posthog.flush()
 
     def test_page(self):

posthog/version.py

@@ -1,4 +1,4 @@
-VERSION = "3.3.1"
+VERSION = "3.3.3"
 
 if __name__ == "__main__":
     print(VERSION, end="")  # noqa: T201

sentry_django_example/sentry_django_example/urls.py

@@ -13,6 +13,7 @@ Including another URLconf
     1. Import the include() function: from django.urls import include, path
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
+
 from django.contrib import admin
 from django.urls import path