From 78ed4abc724d8f5e406e84c72802b5058c2d37d8 Mon Sep 17 00:00:00 2001
From: ahmadabuwardeh <ahm.abuwardeh@gmail.com>
Date: Sat, 20 Jan 2024 07:04:15 -0800
Subject: [PATCH] feat: use XBlockI18NService js translations

---
 CHANGELOG.rst              |  5 +++++
 lti_consumer/__init__.py   |  2 +-
 lti_consumer/lti_xblock.py | 23 ++++++++++++++++++++---
 3 files changed, 26 insertions(+), 4 deletions(-)

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index 57c0e1bc..29e4dfb9 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -16,6 +16,11 @@ Please See the `releases tab <https://github.com/openedx/xblock-lti-consumer/rel
 Unreleased
 ~~~~~~~~~~
 
+Version 9.9.0 (2024-01-20)
+---------------------------
+
+* XBlockI18NService js translations support
+
 9.8.1 - 2023-11-17
 ------------------
 * Fix custom_parameters xblock field validation.
diff --git a/lti_consumer/__init__.py b/lti_consumer/__init__.py
index 2d5f2787..0ba711e2 100644
--- a/lti_consumer/__init__.py
+++ b/lti_consumer/__init__.py
@@ -4,4 +4,4 @@
 from .apps import LTIConsumerApp
 from .lti_xblock import LtiConsumerXBlock
 
-__version__ = '9.8.1'
+__version__ = '9.9.0'
diff --git a/lti_consumer/lti_xblock.py b/lti_consumer/lti_xblock.py
index bf18b4b2..f9122c5f 100644
--- a/lti_consumer/lti_xblock.py
+++ b/lti_consumer/lti_xblock.py
@@ -257,6 +257,7 @@ class LtiConsumerXBlock(StudioEditableXBlockMixin, XBlock):
     """
 
     block_settings_key = 'lti_consumer'
+    i18n_js_namespace = 'LtiI18N'
 
     display_name = String(
         display_name=_("Display Name"),
@@ -663,10 +664,13 @@ def workbench_scenarios():
         return scenarios
 
     @staticmethod
-    def _get_statici18n_js_url(loader):  # pragma: no cover
+    def _get_deprecated_i18n_js_url(loader):
         """
-        Returns the Javascript translation file for the currently selected language, if any found by
+        Returns the deprecated JavaScript translation file for the currently selected language, if any found by
         `pkg_resources`
+
+        This method returns pre-OEP-58 i18n files and is deprecated in favor
+        of `get_javascript_i18n_catalog_url`.
         """
         lang_code = translation.get_language()
         if not lang_code:
@@ -678,6 +682,19 @@ def _get_statici18n_js_url(loader):  # pragma: no cover
                 return text_js.format(lang_code=code)
         return None
 
+    def _get_statici18n_js_url(self, loader):
+        """
+        Return the JavaScript translation file provided by the XBlockI18NService.
+        """
+        if url_getter_func := getattr(self.i18n_service, 'get_javascript_i18n_catalog_url', None):
+            if javascript_url := url_getter_func(self):
+                return javascript_url
+
+        if deprecated_url := self._get_deprecated_i18n_js_url(loader):
+            return self.runtime.local_resource_url(self, deprecated_url)
+
+        return None
+
     def validate_field_data(self, validation, data):
         # Validate custom parameters is a list.
         if not isinstance(data.custom_parameters, list):
@@ -1226,7 +1243,7 @@ def student_view(self, context):
         fragment.add_javascript(loader.load_unicode('static/js/xblock_lti_consumer.js'))
         statici18n_js_url = self._get_statici18n_js_url(loader)
         if statici18n_js_url:
-            fragment.add_javascript_url(self.runtime.local_resource_url(self, statici18n_js_url))
+            fragment.add_javascript_url(statici18n_js_url)
         fragment.initialize_js('LtiConsumerXBlock')
         return fragment