cleanup logging

Author: valentijnscholten

dojo/api_v2/serializers.py

@@ -208,7 +208,7 @@ def __init__(self, **kwargs):
         self.pretty_print = pretty_print
 
     def to_internal_value(self, data):
-        logger.debug(f"to_internal_value called with data: {data}")
+        # logger.debug(f"to_internal_value called with data: {data}")
         # logger.debug("Stacktrace:\n%s", "".join(traceback.format_stack()))
         if isinstance(data, list) and data == [""] and self.allow_empty:
             return []
@@ -239,15 +239,11 @@ def to_internal_value(self, data):
                 tag_validator(sub, exception_class=RestFrameworkValidationError)
             data_safe.extend(substrings)
 
-        logger.debug(f"data_safe after processing: {data_safe}")
-        # result = tagulous.utils.render_tags(data_safe)
         logger.debug(f"result after rendering tags: {data_safe}")
         return data_safe
-        # logger.debug(f"result after rendering tags: {result}")
-        # return result
 
     def to_representation(self, value):
-        logger.debug(f"to_representation called with value: {value}")
+        # logger.debug(f"to_representation called with value: {value}")
         if not isinstance(value, list):
             # we can't use isinstance because TagRelatedManager is non-existing class
             # it cannot be imported or referenced, so we fallback to string
@@ -1741,12 +1737,7 @@ def process_risk_acceptance(self, data):
 
     # Overriding this to push add Push to JIRA functionality
     def update(self, instance, validated_data):
-        # remove tags from validated data and store them seperately
-        # to_be_tagged, validated_data = self._pop_tags(validated_data)
-
-        # pop push_to_jira so it won't get send to the model as a field
-        # TODO: JIRA can we remove this is_push_all_issues, already checked in
-        # apiv2 viewset?
+        # push_all_issues already checked in api views.py
         push_to_jira = validated_data.pop("push_to_jira")
 
         # Save vulnerability ids and pop them
@@ -1764,17 +1755,9 @@ def update(self, instance, validated_data):
             instance, validated_data,
         )
 
-        # If we need to push to JIRA, an extra save call is needed.
-        # Also if we need to update the mitigation date of the finding.
-        # TODO: try to combine create and save, but for now I'm just fixing a
-        # bug and don't want to change to much
         if push_to_jira:
-            logger.debug(f"Pushing updated finding {instance.id} to JIRA")
             jira_helper.push_to_jira(instance)
 
-        # not sure why we are returning a tag_object, but don't want to change
-        # too much now as we're just fixing a bug
-        # return self._save_tags(instance, to_be_tagged)
         return instance
 
     def validate(self, data):
@@ -1878,8 +1861,6 @@ class Meta:
 
     # Overriding this to push add Push to JIRA functionality
     def create(self, validated_data):
-        # Pop off of some fields that should not be sent to the model at this time
-        # to_be_tagged, validated_data = self._pop_tags(validated_data)
         logger.debug(f"Creating finding with validated data: {validated_data}")
         push_to_jira = validated_data.pop("push_to_jira", False)
         notes = validated_data.pop("notes", None)
@@ -1894,8 +1875,6 @@ def create(self, validated_data):
         new_finding = super().create(
             validated_data)
 
-        # Create a findings in memory so that we have access to unsaved_vulnerability_ids
-        # new_finding = Finding(**validated_data)
         new_finding.unsaved_vulnerability_ids = parsed_vulnerability_ids
 
         # Deal with all of the many to many things
@@ -1908,13 +1887,9 @@ def create(self, validated_data):
         if parsed_vulnerability_ids:
             save_vulnerability_ids(new_finding, parsed_vulnerability_ids)
 
-        # If we need to push to JIRA, an extra save call is needed.
-        # TODO: try to combine create and save, but for now I'm just fixing a
-        # bug and don't want to change to much
         if push_to_jira:
             jira_helper.push_to_jira(new_finding)
-        # This final call will save the finding again and return it
-        # return self._save_tags(new_finding, to_be_tagged)
+
         return new_finding
 
     def validate(self, data):

dojo/api_v2/views.py

@@ -986,20 +986,15 @@ def tags(self, request, pk=None):
             new_tags = serializers.TagSerializer(data=request.data)
             if new_tags.is_valid():
                 all_tags = finding.tags
-                logger.debug("Current tags: %s", all_tags)
                 all_tags = serializers.TagSerializer({"tags": all_tags}).data[
                     "tags"
                 ]
-                logger.debug("Current tags serialized: %s", all_tags)
-                logger.debug("New tags raw: %s", new_tags.validated_data["tags"])
                 for tag in new_tags.validated_data["tags"]:
                     for sub_tag in tagulous.utils.parse_tags(tag):
                         if sub_tag not in all_tags:
-                            logger.debug("Adding tag: %s", sub_tag)
                             all_tags.append(sub_tag)
-                logger.debug("All tags: %s", all_tags)
+
                 new_tags = tagulous.utils.render_tags(all_tags)
-                logger.debug("All tags rendered: %s", new_tags)
 
                 finding.tags = new_tags
                 finding.save()
@@ -1242,18 +1237,15 @@ def remove_tags(self, request, pk=None):
                 "tags"
             ]
 
-            logger.debug("Current tags serialized: %s", all_tags)
             # serializer turns it into a string, but we need a list
             del_tags = delete_tags.validated_data["tags"]
             if len(del_tags) < 1:
                 return Response(
                     {"error": "Empty Tag List Not Allowed"},
                     status=status.HTTP_400_BAD_REQUEST,
                 )
-            logger.debug("Tags to delete: %s", del_tags)
+
             for tag in del_tags:
-                # sub_tag = tagulous.utils.parse_tags(tag)
-                logger.debug("Sub tag: %s", tag)
                 if tag not in all_tags:
                     return Response(
                         {
@@ -2515,7 +2507,7 @@ def perform_create(self, serializer):
             jira_driver = engagement or (product or None)
             if jira_project := (jira_helper.get_jira_project(jira_driver) if jira_driver else None):
                 push_to_jira = push_to_jira or jira_project.push_all_issues
-        logger.debug(f"push_to_jira: {push_to_jira}")
+        # logger.debug(f"push_to_jira: {push_to_jira}")
         serializer.save(push_to_jira=push_to_jira)
 
     def get_queryset(self):