save_event_feedback renaming and commenting for upcoming pr

Author: aliu39

src/sentry/feedback/usecases/save_feedback_event.py renamed to src/sentry/feedback/usecases/save_event_feedback.py

@@ -13,12 +13,12 @@
 logger = logging.getLogger(__name__)
 
 
-def save_feedback_event(event_data: Mapping[str, Any], project_id: int):
-    """Saves a feedback from a feedback event envelope.
+def save_event_feedback(event_data: Mapping[str, Any], project_id: int):
+    """Saves feedback given data in an event format. This function should only be called by the new feedback consumer's ingest strategy, to process feedback envelopes (feedback v2).
+    It is currently instrumented as a task in sentry.tasks.store.
 
     If the save is successful and the `associated_event_id` field is present, this will
-    also save a UserReport in Postgres. This is to ensure the feedback can be queried by
-    group_id, which is hard to associate in clickhouse.
+    also save a UserReport in Postgres (shim to v1). This is to allow queries by the group_id relation, which we don't have in clickhouse.
     """
     if not isinstance(event_data, dict):
         event_data = dict(event_data)
@@ -32,6 +32,7 @@ def save_feedback_event(event_data: Mapping[str, Any], project_id: int):
 
     try:
         # Shim to UserReport
+        # TODO: this logic should be extracted to a shim_to_userreport function which returns a report dict. After that this function can be removed and the store task can directly call feedback ingest functions.
         feedback_context = fixed_event_data["contexts"]["feedback"]
         associated_event_id = feedback_context.get("associated_event_id")
 

src/sentry/tasks/store.py

@@ -16,7 +16,9 @@
 from sentry.constants import DEFAULT_STORE_NORMALIZER_ARGS
 from sentry.datascrubbing import scrub_data
 from sentry.eventstore import processing
-from sentry.feedback.usecases.save_feedback_event import save_feedback_event
+from sentry.feedback.usecases.save_event_feedback import (
+    save_event_feedback as save_event_feedback_impl,
+)
 from sentry.ingest.types import ConsumerType
 from sentry.killswitches import killswitch_matches_context
 from sentry.lang.native.symbolicator import SymbolicatorTaskKind
@@ -703,7 +705,7 @@ def save_event_feedback(
     project_id: int,
     **kwargs: Any,
 ) -> None:
-    save_feedback_event(data, project_id)
+    save_event_feedback_impl(data, project_id)
 
 
 @instrumented_task(

tests/sentry/feedback/test_save_feedback_event.py renamed to tests/sentry/feedback/test_save_event_feedback.py

@@ -5,7 +5,7 @@
 
 from sentry.eventstore.models import Event
 from sentry.feedback.lib.utils import FeedbackCreationSource
-from sentry.feedback.usecases.save_feedback_event import save_feedback_event
+from sentry.feedback.usecases.save_event_feedback import save_event_feedback
 from sentry.models.environment import Environment
 from sentry.models.userreport import UserReport
 from sentry.testutils.factories import Factories
@@ -15,7 +15,7 @@
 
 @pytest.fixture
 def mock_create_feedback_issue():
-    with mock.patch("sentry.feedback.usecases.save_feedback_event.create_feedback_issue") as m:
+    with mock.patch("sentry.feedback.usecases.save_event_feedback.create_feedback_issue") as m:
         yield m
 
 
@@ -30,11 +30,11 @@ def create_test_event(project_id: int, environment: Environment) -> Event:
 
 
 @django_db_all
-def test_save_feedback_event_no_associated_event(default_project, mock_create_feedback_issue):
+def test_save_event_feedback_no_associated_event(default_project, mock_create_feedback_issue):
     event_data = mock_feedback_event(default_project.id)
     mock_create_feedback_issue.return_value = None
 
-    save_feedback_event(event_data, default_project.id)
+    save_event_feedback(event_data, default_project.id)
 
     mock_create_feedback_issue.assert_called_once_with(
         event_data, default_project.id, FeedbackCreationSource.NEW_FEEDBACK_ENVELOPE
@@ -47,7 +47,7 @@ def test_save_feedback_event_no_associated_event(default_project, mock_create_fe
     "timestamp_format",
     ["number", "iso"],
 )
-def test_save_feedback_event_with_associated_event(
+def test_save_event_feedback_with_associated_event(
     default_project, mock_create_feedback_issue, timestamp_format
 ):
     environment = Factories.create_environment(default_project, name="production")
@@ -63,7 +63,7 @@ def test_save_feedback_event_with_associated_event(
     event_data["environment"] = "production"
     mock_create_feedback_issue.return_value = event_data
 
-    save_feedback_event(event_data, default_project.id)
+    save_event_feedback(event_data, default_project.id)
 
     mock_create_feedback_issue.assert_called_once_with(
         event_data, default_project.id, FeedbackCreationSource.NEW_FEEDBACK_ENVELOPE
@@ -83,7 +83,7 @@ def test_save_feedback_event_with_associated_event(
 
 
 @django_db_all
-def test_save_feedback_event_with_unprocessed_associated_event(
+def test_save_event_feedback_with_unprocessed_associated_event(
     default_project,
     mock_create_feedback_issue,
 ):
@@ -95,7 +95,7 @@ def test_save_feedback_event_with_unprocessed_associated_event(
     event_data["environment"] = "production"
     mock_create_feedback_issue.return_value = event_data
 
-    save_feedback_event(event_data, default_project.id)
+    save_event_feedback(event_data, default_project.id)
 
     mock_create_feedback_issue.assert_called_once_with(
         event_data, default_project.id, FeedbackCreationSource.NEW_FEEDBACK_ENVELOPE
@@ -116,7 +116,7 @@ def test_save_feedback_event_with_unprocessed_associated_event(
 
 
 @django_db_all
-def test_save_feedback_event_with_missing_fields(default_project, mock_create_feedback_issue):
+def test_save_event_feedback_with_missing_fields(default_project, mock_create_feedback_issue):
     environment = Factories.create_environment(default_project, name="production")
 
     event_data = mock_feedback_event(default_project.id)
@@ -130,7 +130,7 @@ def test_save_feedback_event_with_missing_fields(default_project, mock_create_fe
 
     mock_create_feedback_issue.return_value = event_data
 
-    save_feedback_event(event_data, default_project.id)
+    save_event_feedback(event_data, default_project.id)
 
     mock_create_feedback_issue.assert_called_once_with(
         event_data, default_project.id, FeedbackCreationSource.NEW_FEEDBACK_ENVELOPE