Merge pull request #222 from TNRIS/dpp_suggestions_check

Improved dpp_suggestions check in jobs.py

Will make minor tweaks after merging

Author: jqnatividad

ckanext/datapusher_plus/jobs.py

@@ -1215,21 +1215,58 @@ def _push_to_datastore(
         package_id, scheming_yaml_type="dataset"
     )
 
-    # check if package dpp_suggestions field does not exist
-    # and there are "suggestion_formula" keys in the scheming_yaml
-    if "dpp_suggestions" not in package:
-        # Check for suggestion_formula in dataset_fields
-        has_suggestion_formula = any(
+    # Check for suggestion_formula in dataset_fields
+    has_suggestion_formula = any(
+        isinstance(field, dict)
+        and any(key.startswith("suggestion_formula") for key in field.keys())
+        for field in scheming_yaml["dataset_fields"]
+    )
+
+    if has_suggestion_formula:
+
+        logger.info(
+            'Found suggestion formulae in schema'
+        )
+
+        # Check for "dpp_suggestions" in scheming_yaml
+        schema_has_dpp_suggestions = any(
             isinstance(field, dict)
-            and any(key.startswith("suggestion_formula") for key in field.keys())
+            and field.get("field_name") == "dpp_suggestions"
             for field in scheming_yaml["dataset_fields"]
         )
-
-        if not has_suggestion_formula:
+        if not schema_has_dpp_suggestions:
             logger.error(
-                '"dpp_suggestions" field required but not found in package to process Suggestion Formulae. Ensure that your scheming.yaml file contains the "dpp_suggestions" field as a json_object.'
+                '"dpp_suggestions" field required but not found in your schema. Ensure that your scheming.yaml file contains the "dpp_suggestions" field as a json_object.'
             )
             return
+        else:
+            logger.info(
+                'Found "dpp_suggestions" field in schema'
+            )
+
+        # add "dpp_suggestions" to package if it does not exist
+        if "dpp_suggestions" not in package:
+
+            logger.warning(
+                'Warning: "dpp_suggestions" field required to process Suggestion Formulae is not found in this package . Adding "dpp_suggestions" to package'
+            )
+
+            try:
+                package["dpp_suggestions"] = {}
+                dsu.patch_package(package)
+                logger.error(
+                    '"dpp_suggestions" field added to package'
+                )
+                
+            except Exception as e:
+                logger.error(
+                    'Error adding "dpp_suggestions" field {}'.format( e )
+                )
+                return
+    else:
+        logger.info(
+            'No suggestion formulae found'
+        )
 
     logger.trace(f"package: {package}")