kolibri-sentry-plugin 0.0.1__tar.gz → 0.2.0__tar.gz

{kolibri_sentry_plugin-0.0.1 → kolibri_sentry_plugin-0.2.0}/MANIFEST.in

@@ -9,4 +9,3 @@ recursive-include kolibri_sentry_plugin/static *.*
 
 recursive-include kolibri_sentry_plugin/build *.json
 recursive-exclude kolibri_sentry_plugin/assets *
-

kolibri_sentry_plugin-0.2.0/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.1
+Name: kolibri_sentry_plugin
+Version: 0.2.0
+Summary: A plugin to provide sentry integration for Kolibri
+Home-page: https://github.com/learningequality/kolibri-sentry-plugin
+Author: Learning Equality
+Author-email: info@learningequality.org
+License: MIT
+Keywords: kolibri
+Platform: UNKNOWN
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Provides-Extra: dev
+License-File: LICENSE
+License-File: AUTHORS.rst
+
+
+A plugin that provides Sentry SDK integration for the frontend and backend
+of Kolibri. See the `Github repo <https://github.com/learningequality/kolibri-sentry-plugin>`_ for more details.
+
+

{kolibri_sentry_plugin-0.0.1 → kolibri_sentry_plugin-0.2.0}/README.rst

@@ -11,7 +11,7 @@ How can I install this plugin?
 
 2. Activate the plugin:
 
-    ``kolibri plugin kolibri_sentry_plugin enable``
+    ``kolibri plugin enable kolibri_sentry_plugin``
 
 3. Restart Kolibri.
 
@@ -26,7 +26,7 @@ How can I install this plugin for development?
 
     ``pip install -e <LOCAL-PATH-TO-REPO>``
 
-    ``kolibri plugin kolibri_sentry_plugin enable``
+    ``kolibri plugin enable kolibri_sentry_plugin``
 
 
 4. Then run the commands to install frontend packages in Kolibri, this plugin will have its dependencies recursively installed.
@@ -46,4 +46,3 @@ How to publish to PyPi?
 4. In the terminal move to the root level of repo dir and run the following command to publish to PyPi:
 
     ``make release``
-

kolibri_sentry_plugin-0.2.0/kolibri_sentry_plugin/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.0"

kolibri_sentry_plugin-0.2.0/kolibri_sentry_plugin/build/kolibri_sentry_plugin.main_stats.json

@@ -0,0 +1,25 @@
+{
+  "status": "done",
+  "assets": {
+    "kolibri_sentry_plugin.main-0.2.0.js": {
+      "name": "kolibri_sentry_plugin.main-0.2.0.js",
+      "path": "/home/runner/work/kolibri-sentry-plugin/kolibri-sentry-plugin/kolibri_sentry_plugin/static/kolibri_sentry_plugin.main/kolibri_sentry_plugin.main-0.2.0.js",
+      "publicPath": "autokolibri_sentry_plugin.main-0.2.0.js"
+    },
+    "kolibri_sentry_plugin.main-0.2.0.js.map": {
+      "name": "kolibri_sentry_plugin.main-0.2.0.js.map",
+      "path": "/home/runner/work/kolibri-sentry-plugin/kolibri-sentry-plugin/kolibri_sentry_plugin/static/kolibri_sentry_plugin.main/kolibri_sentry_plugin.main-0.2.0.js.map",
+      "publicPath": "autokolibri_sentry_plugin.main-0.2.0.js.map"
+    }
+  },
+  "chunks": {
+    "kolibri_sentry_plugin.main": [
+      {
+        "name": "kolibri_sentry_plugin.main-0.2.0.js",
+        "path": "/home/runner/work/kolibri-sentry-plugin/kolibri-sentry-plugin/kolibri_sentry_plugin/static/kolibri_sentry_plugin.main/kolibri_sentry_plugin.main-0.2.0.js",
+        "publicPath": "autokolibri_sentry_plugin.main-0.2.0.js"
+      }
+    ]
+  },
+  "publicPath": "auto"
+}

kolibri_sentry_plugin-0.2.0/kolibri_sentry_plugin/kolibri_plugin.py

@@ -0,0 +1,28 @@
+from kolibri.core.hooks import FrontEndBaseSyncHook
+from kolibri.core.webpack.hooks import WebpackBundleHook
+from kolibri.plugins import KolibriPluginBase
+from kolibri.plugins.hooks import register_hook
+from kolibri.utils import conf
+
+
+class SentryPlugin(KolibriPluginBase):
+    django_settings = "settings"
+    kolibri_options = "options"
+
+
+@register_hook
+class SentryPluginAsset(WebpackBundleHook):
+    bundle_id = "main"
+
+    @property
+    def plugin_data(self):
+        return {
+            "sentryDSN": conf.OPTIONS["Debug"]["SENTRY_FRONTEND_DSN"],
+            "sentryEnv": conf.OPTIONS["Debug"]["SENTRY_ENVIRONMENT"],
+            "sentryReplayEnabled": conf.OPTIONS["Debug"]["SENTRY_REPLAY_ENABLED"],
+        }
+
+
+@register_hook
+class SentryPluginInclusionHook(FrontEndBaseSyncHook):
+    bundle_class = SentryPluginAsset

{kolibri_sentry_plugin-0.0.1 → kolibri_sentry_plugin-0.2.0}/kolibri_sentry_plugin/options.py

@@ -12,5 +12,10 @@ option_spec = {
             "type": "string",
             "envvars": ("KOLIBRI_DEBUG_SENTRY_ENVIRONMENT",),
         },
+        "SENTRY_REPLAY_ENABLED": {
+            "type": "boolean",
+            "default": False,
+            "envvars": ("KOLIBRI_DEBUG_SENTRY_REPLAY_ENABLED",),
+        },
     },
 }

{kolibri_sentry_plugin-0.0.1 → kolibri_sentry_plugin-0.2.0}/kolibri_sentry_plugin/settings.py

@@ -1,9 +1,8 @@
-import sentry_sdk
 import kolibri
-
-from sentry_sdk.integrations.django import DjangoIntegration
+import sentry_sdk
 from kolibri.utils import conf
 from kolibri.utils.server import installation_type
+from sentry_sdk.integrations.django import DjangoIntegration
 
 
 sentry_sdk.init(
@@ -17,4 +16,8 @@ with sentry_sdk.configure_scope() as scope:
     scope.set_tag("mode", conf.OPTIONS["Deployment"]["RUN_MODE"])
     scope.set_tag("installer", installation_type())
 
-print("Sentry backend error logging is enabled")
+
+# Copy of the Kolibri default src directive plus sentry.io for sending error reports.
+CSP_CONNECT_SRC = ("'self'", "data:", "blob:", "*.sentry.io") + tuple(
+    conf.OPTIONS["Deployment"]["CSP_HOST_SOURCES"]
+)