feat(numericalInput): endpoint to validate numerical input refactored

Author: jesusbalderramawgu

cms/djangoapps/contentstore/api/urls.py

@@ -4,7 +4,7 @@
 from django.conf import settings
 from django.urls import re_path
 
-from cms.djangoapps.contentstore.api.views import course_import, course_quality, course_validation, utils
+from cms.djangoapps.contentstore.api.views import course_import, course_quality, course_validation
 
 
 app_name = 'contentstore'
@@ -16,7 +16,5 @@
             course_validation.CourseValidationView.as_view(), name='course_validation'),
     re_path(fr'^v1/quality/{settings.COURSE_ID_PATTERN}/$',
             course_quality.CourseQualityView.as_view(), name='course_quality'),
-    re_path(r'^v1/validate/numerical-input/$',
-            utils.NumericalInputValidationView.as_view(), name='numerical_input_validation'),
 
 ]

cms/djangoapps/contentstore/api/views/utils.py

@@ -7,16 +7,12 @@
 
 from opaque_keys.edx.keys import CourseKey
 from rest_framework import status
-from rest_framework.response import Response
 from rest_framework.generics import GenericAPIView
-
 from common.djangoapps.student.auth import has_course_author_access
 from openedx.core.djangoapps.util.forms import to_bool
 from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, view_auth_classes
 from openedx.core.lib.cache_utils import request_cached
 from xmodule.modulestore.django import modulestore  # lint-amnesty, pylint: disable=wrong-import-order
-from calc.preview import latex_preview
-import pyparsing
 
 
 @view_auth_classes()
@@ -138,19 +134,3 @@ def _wrapper_view(self, request, course_id, *args, **kwargs):
             )
         return view(self, request, course_key, *args, **kwargs)
     return _wrapper_view
-
-
-class NumericalInputValidationView(GenericAPIView):
-    """Class in charge of NumericalInputValidations"""
-    def post(self, request):
-        """function to validate a math expression (formula) and return of the numeric input is valid or not"""
-        result = {'preview': '',
-                  'is_valid': True,
-                  'error': ''}
-        try:
-            result['preview'] = latex_preview(request.data.get('formula'))
-        except pyparsing.ParseException:
-            result["error"] = "Sorry, couldn't parse formula"
-            result['is_valid'] = False
-            return Response(result, status=400)
-        return Response(result)

cms/djangoapps/contentstore/rest_api/v2/serializers/utils.py

@@ -0,0 +1,17 @@
+"""
+Serializers for the contentstore v2 utils views module.
+
+This module contains DRF serializers for different utils like validations.
+"""
+
+from rest_framework import serializers
+
+
+class NumericalInputValidationRequestSerializer(serializers.Serializer):
+    formula = serializers.CharField()
+
+
+class NumericalInputValidationReponseSerializer(serializers.Serializer):
+    preview = serializers.CharField()
+    is_valid = serializers.BooleanField()
+    error = serializers.CharField(allow_null=True)

cms/djangoapps/contentstore/rest_api/v2/urls.py

@@ -3,7 +3,7 @@
 from django.conf import settings
 from django.urls import path, re_path
 
-from cms.djangoapps.contentstore.rest_api.v2.views import downstreams, home
+from cms.djangoapps.contentstore.rest_api.v2.views import downstreams, home, utils
 
 app_name = "v2"
 
@@ -33,4 +33,8 @@
         downstreams.SyncFromUpstreamView.as_view(),
         name="sync_from_upstream"
     ),
+    re_path(
+        '^validate/numerical-input/$',
+        utils.NumericalInputValidationView.as_view(),
+        name='numerical_input_validation'),
 ]

cms/djangoapps/contentstore/rest_api/v2/views/utils.py

@@ -0,0 +1,22 @@
+"""
+Common utilities for V2 APIs.
+"""
+from rest_framework.response import Response
+from rest_framework.generics import GenericAPIView
+from rest_framework import permissions
+from cms.djangoapps.contentstore.rest_api.v2.serializers.utils import NumericalInputValidationRequestSerializer
+from xmodule.capa_block import ProblemBlock
+
+
+class NumericalInputValidationView(GenericAPIView):
+    """Class in charge of NumericalInputValidations"""
+    permission_classes = (permissions.IsAuthenticated,)
+    serializer_class = NumericalInputValidationRequestSerializer
+
+    def post(self, request):
+        """function to validate a math expression (formula) and return of the numeric input is valid or not"""
+        serializer = self.get_serializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+        formula = serializer.validated_data['formula']
+        result = ProblemBlock.preview_numeric_input(formula)
+        return Response(result, status=200)

xmodule/capa/inputtypes.py

@@ -51,7 +51,6 @@
 import nh3
 import pyparsing
 import six
-from calc.preview import latex_preview
 from chem import chemcalc
 from lxml import etree
 
@@ -1300,18 +1299,18 @@ def preview_formcalc(self, get):
 
         result["request_start"] = int(get.get("request_start", 0))
 
-        try:
-            # TODO add references to valid variables and functions
-            # At some point, we might want to mark invalid variables as red
-            # or something, and this is where we would need to pass those in.
-            result["preview"] = latex_preview(formula)
-        except pyparsing.ParseException:
-            result["error"] = _("Sorry, couldn't parse formula")
+        # TODO add references to valid variables and functions
+        # At some point, we might want to mark invalid variables as red
+        # or something, and this is where we would need to pass those in.
+        from xmodule.capa_block import ProblemBlock
+        numeric_result = ProblemBlock.preview_numeric_input(formula)
+        # Map results into the correct format
+        result["preview"] = numeric_result["preview"]
+        if numeric_result["error"]:
+            result["error"] = numeric_result["error"]
+        # if formula is invalid retrn formula
+        if not numeric_result["is_valid"]:
             result["formula"] = formula
-        except Exception:  # lint-amnesty, pylint: disable=broad-except
-            # this is unexpected, so log
-            log.warning("Error while previewing formula", exc_info=True)
-            result["error"] = _("Error while rendering preview")
 
         return result
 

xmodule/capa_block.py

@@ -53,6 +53,8 @@
 from .capa.xqueue_interface import XQueueService
 from .fields import Date, ListScoreField, ScoreField, Timedelta
 from .progress import Progress
+from calc.preview import latex_preview
+import pyparsing
 
 log = logging.getLogger("edx.courseware")
 
@@ -2390,6 +2392,27 @@ def score_from_lcp(self, lcp):
         lcp_score = lcp.calculate_score()
         return Score(raw_earned=lcp_score["score"], raw_possible=lcp_score["total"])
 
+    @classmethod
+    def preview_numeric_input(cls, formula):
+        """
+       A class method for handling numeric validations, in this case
+       validates that the formula provided is a valid formula.
+       """
+        result = {'preview': '',
+                  'is_valid': True,
+                  'error': ''}
+        try:
+            result['preview'] = latex_preview(formula)
+        except pyparsing.ParseException:
+            result["error"] = "Sorry, couldn't parse formula"
+            result['is_valid'] = False
+            return result
+        except Exception:
+            log.warning("Error while previewing formula", exc_info=True)
+            result['error'] = "Error while rendering preview"
+            result['is_valid'] = False
+        return result
+
 
 class GradingMethodHandler:
     """