feat: Add event for LTI Launches

Author: xitij2000

openedx_events/event_bus/avro/tests/schemas/org+openedx+learning+lti_provider+launch+success+v1_schema.avsc

@@ -0,0 +1,91 @@
+{
+  "name": "CloudEvent",
+  "type": "record",
+  "doc": "Avro Event Format for CloudEvents created with openedx_events/schema",
+  "fields": [
+    {
+      "name": "launch_data",
+      "type": {
+        "name": "LtiLaunchData",
+        "type": "record",
+        "fields": [
+          {
+            "name": "user",
+            "type": {
+              "name": "UserData",
+              "type": "record",
+              "fields": [
+                {
+                  "name": "id",
+                  "type": "long"
+                },
+                {
+                  "name": "is_active",
+                  "type": "boolean"
+                },
+                {
+                  "name": "pii",
+                  "type": {
+                    "name": "UserPersonalData",
+                    "type": "record",
+                    "fields": [
+                      {
+                        "name": "username",
+                        "type": "string"
+                      },
+                      {
+                        "name": "email",
+                        "type": "string"
+                      },
+                      {
+                        "name": "name",
+                        "type": "string"
+                      }
+                    ]
+                  }
+                }
+              ]
+            }
+          },
+          {
+            "name": "course_key",
+            "type": "string"
+          },
+          {
+            "name": "usage_key",
+            "type": "string"
+          },
+          {
+            "name": "launch_params",
+            "type": {
+              "name": "LtiLaunchParamsData",
+              "type": "record",
+              "fields": [
+                {
+                  "name": "roles",
+                  "type": "string"
+                },
+                {
+                  "name": "context_id",
+                  "type": "string"
+                },
+                {
+                  "name": "user_id",
+                  "type": "string"
+                },
+                {
+                  "name": "extra_data",
+                  "type": {
+                    "type": "map",
+                    "values": "string"
+                  }
+                }
+              ]
+            }
+          }
+        ]
+      }
+    }
+  ],
+  "namespace": "org.openedx.learning.lti_provider.launch.success.v1"
+}

openedx_events/learning/data.py

@@ -656,3 +656,30 @@ class ExternalGraderScoreData:
     module_id = attr.ib(type=str)
     queue_key = attr.ib(type=str)
     queue_name = attr.ib(type=str)
+
+
+@attr.s(frozen=True)
+class LtiLaunchParamsData:
+    """
+    Data required for a successful LTI launch.
+
+    Attributes:
+        roles (str): The roles (as per LTI Spec) of the User.
+        context_id (str): An ID for the launch context of LTI content.
+        user_id (str): User ID of user performing the launch.
+    """
+    roles = attr.ib(type=str)
+    context_id = attr.ib(type=str)
+    user_id = attr.ib(type=str)
+    extra_data = attr.ib(type=dict[str, str], factory=dict)
+
+
+@attr.s(frozen=True)
+class LtiLaunchData:
+    """
+    Class that encapsulates LTI data for an LTI launch event.
+    """
+    user = attr.ib(type=UserData)
+    course_key = attr.ib(type=CourseKey)
+    usage_key = attr.ib(type=UsageKey)
+    launch_params = attr.ib(type=LtiLaunchParamsData)

openedx_events/learning/signals.py

@@ -21,6 +21,7 @@
     DiscussionThreadData,
     ExamAttemptData,
     ExternalGraderScoreData,
+    LtiLaunchData,
     ORASubmissionData,
     PersistentCourseGradeData,
     ProgramCertificateData,
@@ -504,3 +505,17 @@
         "score": ExternalGraderScoreData,
     }
 )
+
+
+# .. event_type: org.openedx.learning.lti_provider.launch.success.v1
+# .. event_name: LTI_PROVIDER_LAUNCH_SUCCESS
+# .. event_description: emitted when a student accesses learning content via LTI
+# .. event_warning: This event is currently incompatible with the event bus, list with complex types
+#      like ``List[DiscussionTopicContext]`` cannot be serialized yet.
+# .. event_data: LtiLaunchData
+LTI_PROVIDER_LAUNCH_SUCCESS = OpenEdxPublicSignal(
+    event_type="org.openedx.learning.lti_provider.launch.success.v1",
+    data={
+        "launch_data": LtiLaunchData,
+    }
+)