Merge pull request #26 from openedx/iahmad/ENT-8117-2

fix: Updated logging to log all aborted cases
openedx · Jan 25, 2024 · 43228d9 · 43228d9
2 parents cdd89a9 + c7cf439
commit 43228d9
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 17 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -16,6 +16,15 @@ Unreleased
 
 *
 
+[0.1.5] - 2024-01-25
+************************************************
+
+Changed
+=======
+
+* Logging aborted runs of the filter
+
+
 [0.1.4] - 2024-01-22
 ************************************************
 

diff --git a/skill_tagging/__init__.py b/skill_tagging/__init__.py
@@ -2,7 +2,7 @@
 Django app plugin for fetching and verifying tags for xblock skills.
 """
 
-__version__ = '0.1.4'
+__version__ = '0.1.5'
 
 # pylint: disable=invalid-name
 default_app_config = 'skill_tagging.apps.SkillTaggingConfig'
diff --git a/skill_tagging/pipeline.py b/skill_tagging/pipeline.py
@@ -84,18 +84,18 @@ def run_filter(self, block, fragment, context, view):  # pylint: disable=argumen
 
         # Check whether we need to run this filter and only call the API.
         if not self.should_run_filter():
+            logger.info(
+                "[Xblock-Skill-Tagging] Filter aborted for vertical block. Block-ID: %s",
+                str(block.scope_ids.usage_id.block_id)
+            )
             return {"block": block, "fragment": fragment, "context": context, "view": view}
-        logger.info(
-            "[Xblock-Skill-Tagging] Filter run for AddVerticalBlockSkillVerificationSection. Block-ID: %s",
-            str(block.scope_ids.usage_id.block_id)
-        )
         skills = self.fetch_related_skills(block)
         if not skills:
+            logger.info(
+                "[Xblock-Skill-Tagging] Skills missing for vertical block. Block-ID: %s",
+                str(block.scope_ids.usage_id.block_id)
+            )
             return {"block": block, "fragment": fragment, "context": context, "view": view}
-        logger.info(
-            "[Xblock-Skill-Tagging] Skills found for AddVerticalBlockSkillVerificationSection. Block-ID: %s",
-            str(block.scope_ids.usage_id.block_id)
-        )
         usage_id = block.scope_ids.usage_id
         data = self.get_skill_context(usage_id, block, skills)
         html = resource_string("static/tagging.html")
@@ -128,19 +128,19 @@ def run_filter(self, block, context):  # pylint: disable=arguments-differ
         """Pipeline Step implementing the Filter"""
         usage_id = block.scope_ids.usage_id
         if usage_id.block_type != "video" or not self.should_run_filter():
+            logger.info(
+                "[Xblock-Skill-Tagging] Filter aborted for block. Block-ID: %s",
+                str(block.scope_ids.usage_id.block_id)
+            )
             # avoid fetching skills for other xblocks
             return {"block": block, "context": context}
-        logger.info(
-            "[Xblock-Skill-Tagging] Filter run for AddVideoBlockSkillVerificationComponent. Block-ID: %s",
-            str(block.scope_ids.usage_id.block_id)
-        )
         skills = self.fetch_related_skills(block)
         if not skills:
+            logger.info(
+                "[Xblock-Skill-Tagging] Skills missing for video. Block-ID: %s",
+                str(block.scope_ids.usage_id.block_id)
+            )
             return {"block": block, "context": context}
-        logger.info(
-            "[Xblock-Skill-Tagging] Skills found for AddVideoBlockSkillVerificationComponent. Block-ID: %s",
-            str(block.scope_ids.usage_id.block_id)
-        )
         data = self.get_skill_context(usage_id, block, skills)
 
         def wrapper(fn):