platform-plugin-aspects 0.7.3__tar.gz → 0.8.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/CHANGELOG.rst +15 -1
  2. {platform_plugin_aspects-0.7.3/platform_plugin_aspects.egg-info → platform_plugin_aspects-0.8.0}/PKG-INFO +16 -2
  3. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/__init__.py +1 -1
  4. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/sinks/course_overview_sink.py +8 -1
  5. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/sinks/serializers.py +2 -1
  6. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/static/html/superset.html +1 -1
  7. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/static/js/embed_dashboard.js +14 -3
  8. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/static/js/superset.js +5 -3
  9. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/utils.py +53 -1
  10. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/views.py +3 -8
  11. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/xblock.py +8 -4
  12. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0/platform_plugin_aspects.egg-info}/PKG-INFO +16 -2
  13. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/LICENSE +0 -0
  14. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/MANIFEST.in +0 -0
  15. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/README.rst +0 -0
  16. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/apps.py +0 -0
  17. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/extensions/__init__.py +0 -0
  18. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/extensions/filters.py +0 -0
  19. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/management/__init__.py +0 -0
  20. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/management/commands/__init__.py +0 -0
  21. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/management/commands/dump_data_to_clickhouse.py +0 -0
  22. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/management/commands/load_test_tracking_events.py +0 -0
  23. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/management/commands/monitor_load_test_tracking.py +0 -0
  24. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/settings/__init__.py +0 -0
  25. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/settings/common.py +0 -0
  26. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/settings/production.py +0 -0
  27. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/signals.py +0 -0
  28. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/sinks/__init__.py +0 -0
  29. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/sinks/base_sink.py +0 -0
  30. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/sinks/external_id_sink.py +0 -0
  31. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/sinks/user_profile_sink.py +0 -0
  32. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/sinks/user_retire_sink.py +0 -0
  33. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/static/css/superset.css +0 -0
  34. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/static/html/superset_student.html +0 -0
  35. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/static/js/install_required.js +0 -0
  36. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/tasks.py +0 -0
  37. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/templates/instructor_dashboard/aspects.html +0 -0
  38. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/urls.py +0 -0
  39. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects/waffle.py +0 -0
  40. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects.egg-info/SOURCES.txt +0 -0
  41. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects.egg-info/dependency_links.txt +0 -0
  42. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects.egg-info/entry_points.txt +0 -0
  43. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects.egg-info/not-zip-safe +0 -0
  44. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects.egg-info/requires.txt +0 -0
  45. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/platform_plugin_aspects.egg-info/top_level.txt +0 -0
  46. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/requirements/base.in +0 -0
  47. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/requirements/constraints.txt +0 -0
  48. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/setup.cfg +0 -0
  49. {platform_plugin_aspects-0.7.3 → platform_plugin_aspects-0.8.0}/setup.py +0 -0
@@ -14,7 +14,21 @@ Change Log
14
14
  Unreleased
15
15
  **********
16
16
 
17
- *
17
+ 0.8.0 - 2024-05-06
18
+ ******************
19
+
20
+ Added
21
+ =====
22
+
23
+ * Added tags to xblocks in course dump
24
+
25
+
26
+ 0.7.4 - 2024-04-30
27
+ ******************
28
+
29
+ Fixed
30
+ =====
31
+ * Fixed Superset XBlock and default filters.
18
32
 
19
33
  0.7.3 - 2024-04-30
20
34
  ******************
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: platform-plugin-aspects
3
- Version: 0.7.3
3
+ Version: 0.8.0
4
4
  Summary: Aspects plugins for edx-platform
5
5
  Home-page: https://github.com/openedx/platform-plugin-aspects
6
6
  Author: Open edX Project
@@ -276,7 +276,21 @@ Change Log
276
276
  Unreleased
277
277
  **********
278
278
 
279
- *
279
+ 0.8.0 - 2024-05-06
280
+ ******************
281
+
282
+ Added
283
+ =====
284
+
285
+ * Added tags to xblocks in course dump
286
+
287
+
288
+ 0.7.4 - 2024-04-30
289
+ ******************
290
+
291
+ Fixed
292
+ =====
293
+ * Fixed Superset XBlock and default filters.
280
294
 
281
295
  0.7.3 - 2024-04-30
282
296
  ******************
@@ -5,6 +5,6 @@ Aspects plugins for edx-platform.
5
5
  import os
6
6
  from pathlib import Path
7
7
 
8
- __version__ = "0.7.3"
8
+ __version__ = "0.8.0"
9
9
 
10
10
  ROOT_DIRECTORY = Path(os.path.dirname(os.path.abspath(__file__)))
@@ -17,7 +17,11 @@ from opaque_keys.edx.keys import CourseKey
17
17
 
18
18
  from platform_plugin_aspects.sinks.base_sink import ModelBaseSink
19
19
  from platform_plugin_aspects.sinks.serializers import CourseOverviewSerializer
20
- from platform_plugin_aspects.utils import get_detached_xblock_types, get_modulestore
20
+ from platform_plugin_aspects.utils import (
21
+ get_detached_xblock_types,
22
+ get_modulestore,
23
+ get_tags_for_block,
24
+ )
21
25
 
22
26
  # Defaults we want to ensure we fail early on bulk inserts
23
27
  CLICKHOUSE_BULK_INSERT_PARAMS = {
@@ -86,6 +90,9 @@ class XBlockSink(ModelBaseSink):
86
90
  fields["xblock_data_json"]["section"] = section_idx
87
91
  fields["xblock_data_json"]["subsection"] = subsection_idx
88
92
  fields["xblock_data_json"]["unit"] = unit_idx
93
+ fields["xblock_data_json"]["tags"] = get_tags_for_block(
94
+ fields["location"],
95
+ )
89
96
 
90
97
  fields["xblock_data_json"] = json.dumps(fields["xblock_data_json"])
91
98
  location_to_node[XBlockSink.strip_branch_and_version(block.location)] = (
@@ -6,7 +6,7 @@ import uuid
6
6
  from django.utils import timezone
7
7
  from rest_framework import serializers
8
8
 
9
- from platform_plugin_aspects.utils import get_model
9
+ from platform_plugin_aspects.utils import get_model, get_tags_for_block
10
10
 
11
11
 
12
12
  class BaseSinkSerializer(serializers.Serializer): # pylint: disable=abstract-method
@@ -146,6 +146,7 @@ class CourseOverviewSerializer(BaseSinkSerializer, serializers.ModelSerializer):
146
146
  "entrance_exam_enabled": getattr(overview, "entrance_exam_enabled", ""),
147
147
  "external_id": getattr(overview, "external_id", ""),
148
148
  "language": getattr(overview, "language", ""),
149
+ "tags": get_tags_for_block(overview.id),
149
150
  }
150
151
  return json.dumps(json_fields)
151
152
 
@@ -10,7 +10,7 @@
10
10
  <p>{{exception}}</p>
11
11
  {% elif not superset_dashboards %}
12
12
  <p>Dashboard UUID is not set. Please set the dashboard UUID in the Studio.</p>
13
- {% elif superset_url and superset_guest_token_url %} {% if xblock_id %}
13
+ {% elif superset_url %} {% if xblock_id %}
14
14
  <div class="superset-embedded-container" id="superset-embedded-container-{{xblock_id}}"></div>
15
15
  {% else %}
16
16
  <div class="aspects-tabs">
@@ -15,11 +15,22 @@ function getCookie(name) {
15
15
  }
16
16
 
17
17
  async function fetchGuestToken() {
18
- const response = await fetch(superset_guest_token_url, {
19
- method: 'GET',
18
+ let response;
19
+ if (window.from_xblock){
20
+ // XBlock handler requires a POST request and a JSON body
21
+ body = JSON.stringify({});
22
+ method = 'POST';
23
+ }else {
24
+ body = null;
25
+ method = 'GET';
26
+ }
27
+
28
+ response = await fetch(window.superset_guest_token_url, {
29
+ method: method,
20
30
  headers: {
21
31
  "X-CSRFToken": getCookie("csrftoken"),
22
- }
32
+ },
33
+ body: body,
23
34
  });
24
35
 
25
36
  if (!response.ok) {
@@ -2,11 +2,13 @@
2
2
  function SupersetXBlock(runtime, element, context) {
3
3
  const dashboard_uuid = context.dashboard_uuid;
4
4
  const superset_url = context.superset_url;
5
- const superset_guest_token_url = runtime.handlerUrl(element, 'get_superset_guest_token');
6
- const xblock_id = context.xblock_id
5
+ const xblock_id = context.xblock_id;
6
+
7
+ window.superset_guest_token_url = runtime.handlerUrl(element, 'get_superset_guest_token');
8
+ window.from_xblock = true;
7
9
 
8
10
  function initSuperset(supersetEmbeddedSdk) {
9
- embedDashboard(dashboard_uuid, superset_url, superset_guest_token_url, xblock_id);
11
+ embedDashboard(dashboard_uuid, superset_url, xblock_id);
10
12
  }
11
13
 
12
14
  if (typeof require === "function") {
@@ -31,6 +31,12 @@ def _(text):
31
31
  return text
32
32
 
33
33
 
34
+ DEFAULT_FILTERS_FORMAT = [
35
+ "org = '{course_id.org}'",
36
+ "course_key = '{course_id}'",
37
+ ]
38
+
39
+
34
40
  def generate_superset_context(
35
41
  context,
36
42
  dashboards,
@@ -106,7 +112,9 @@ def generate_guest_token(user, course, dashboards, filters) -> str:
106
112
  superset_username = superset_config.get("username")
107
113
  superset_password = superset_config.get("password")
108
114
 
109
- formatted_filters = [filter.format(course=course, user=user) for filter in filters]
115
+ formatted_filters = [
116
+ filter.format(course_id=course, user=user) for filter in filters
117
+ ]
110
118
 
111
119
  resources = []
112
120
 
@@ -270,3 +278,47 @@ def get_localized_uuid(base_uuid, language):
270
278
  base_namespace = uuid.uuid5(base_uuid, "superset")
271
279
  normalized_language = language.lower().replace("-", "_")
272
280
  return str(uuid.uuid5(base_namespace, normalized_language))
281
+
282
+
283
+ def _get_object_tags(usage_key): # pragma: no cover
284
+ """
285
+ Wrap the Open edX tagging API method get_object_tags.
286
+ """
287
+ try:
288
+ # pylint: disable=import-outside-toplevel
289
+ from openedx.core.djangoapps.content_tagging.api import get_object_tags
290
+
291
+ return get_object_tags(object_id=str(usage_key))
292
+ # Pre-Redwood versions of Open edX don't have this API
293
+ except ImportError:
294
+ return {}
295
+
296
+
297
+ def get_tags_for_block(usage_key) -> dict:
298
+ """
299
+ Return all the tags (and their parent tags) applied to the given block.
300
+
301
+ Returns a dict of [taxonomy]: [tag, tag, tag]
302
+ """
303
+ tags = _get_object_tags(usage_key)
304
+ serialized_tags = {}
305
+
306
+ for explicit_tag in tags:
307
+ _add_tag(explicit_tag, serialized_tags)
308
+ implicit_tag = explicit_tag.tag.parent
309
+
310
+ while implicit_tag:
311
+ _add_tag(implicit_tag, serialized_tags)
312
+ implicit_tag = implicit_tag.parent
313
+
314
+ return serialized_tags
315
+
316
+
317
+ def _add_tag(tag, serialized_tags):
318
+ """
319
+ Add a tag to our serialized list of tags.
320
+ """
321
+ if tag.taxonomy.name not in serialized_tags:
322
+ serialized_tags[tag.taxonomy.name] = [tag.value]
323
+ else:
324
+ serialized_tags[tag.taxonomy.name].append(tag.value)
@@ -16,7 +16,7 @@ from rest_framework.exceptions import APIException, NotFound
16
16
  from rest_framework.generics import GenericAPIView
17
17
  from rest_framework.response import Response
18
18
 
19
- from .utils import _, generate_guest_token, get_model
19
+ from .utils import DEFAULT_FILTERS_FORMAT, _, generate_guest_token, get_model
20
20
 
21
21
  try:
22
22
  from openedx.core.lib.api.permissions import (
@@ -102,7 +102,7 @@ class SupersetView(GenericAPIView):
102
102
  # May raise a permission denied
103
103
  self.check_object_permissions(self.request, course)
104
104
 
105
- return course
105
+ return course_key
106
106
 
107
107
  @method_decorator(cache_page(60 * 5))
108
108
  def get(self, request, *args, **kwargs):
@@ -111,11 +111,6 @@ class SupersetView(GenericAPIView):
111
111
  """
112
112
  course = self.get_object()
113
113
 
114
- built_in_filters = [
115
- f"org = '{course.course_id.org}'",
116
- f"course_name = '{course.display_name}'",
117
- f"course_run = '{course.course_id.run}'",
118
- ]
119
114
  dashboards = settings.ASPECTS_INSTRUCTOR_DASHBOARDS
120
115
  extra_filters_format = settings.SUPERSET_EXTRA_FILTERS_FORMAT
121
116
 
@@ -124,7 +119,7 @@ class SupersetView(GenericAPIView):
124
119
  user=request.user,
125
120
  course=course,
126
121
  dashboards=dashboards,
127
- filters=built_in_filters + extra_filters_format,
122
+ filters=DEFAULT_FILTERS_FORMAT + extra_filters_format,
128
123
  )
129
124
  except ImproperlyConfigured as exc:
130
125
  raise APIException() from exc
@@ -16,7 +16,12 @@ from xblock.fields import List, Scope, String
16
16
  from xblock.utils.resources import ResourceLoader
17
17
  from xblock.utils.studio_editable import StudioEditableXBlockMixin
18
18
 
19
- from .utils import _, generate_guest_token, generate_superset_context
19
+ from .utils import (
20
+ DEFAULT_FILTERS_FORMAT,
21
+ _,
22
+ generate_guest_token,
23
+ generate_superset_context,
24
+ )
20
25
 
21
26
  log = logging.getLogger(__name__)
22
27
  loader = ResourceLoader(__name__)
@@ -142,7 +147,6 @@ class SupersetXBlock(StudioEditableXBlockMixin, XBlock):
142
147
  json_args={
143
148
  "dashboard_uuid": self.dashboard_uuid,
144
149
  "superset_url": context.get("superset_url"),
145
- "superset_token": context.get("superset_token"),
146
150
  "xblock_id": context.get("xblock_id"),
147
151
  },
148
152
  )
@@ -198,9 +202,9 @@ class SupersetXBlock(StudioEditableXBlockMixin, XBlock):
198
202
  try:
199
203
  guest_token = generate_guest_token(
200
204
  user=user,
201
- course=self.runtime.course_id,
205
+ course=self.scope_ids.usage_id.context_key,
202
206
  dashboards=self.dashboards(),
203
- filters=self.filters,
207
+ filters=DEFAULT_FILTERS_FORMAT + self.filters,
204
208
  )
205
209
  except ImproperlyConfigured as exc:
206
210
  raise JsonHandlerError(500, str(exc)) from exc
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: platform-plugin-aspects
3
- Version: 0.7.3
3
+ Version: 0.8.0
4
4
  Summary: Aspects plugins for edx-platform
5
5
  Home-page: https://github.com/openedx/platform-plugin-aspects
6
6
  Author: Open edX Project
@@ -276,7 +276,21 @@ Change Log
276
276
  Unreleased
277
277
  **********
278
278
 
279
- *
279
+ 0.8.0 - 2024-05-06
280
+ ******************
281
+
282
+ Added
283
+ =====
284
+
285
+ * Added tags to xblocks in course dump
286
+
287
+
288
+ 0.7.4 - 2024-04-30
289
+ ******************
290
+
291
+ Fixed
292
+ =====
293
+ * Fixed Superset XBlock and default filters.
280
294
 
281
295
  0.7.3 - 2024-04-30
282
296
  ******************