DHFPROD-7302: Better messages for common write errors

Author: ryanjdew

marklogic-data-hub/src/main/resources/ml-modules/root/data-hub/5/impl/flow.sjs

@@ -482,6 +482,8 @@ class Flow {
     // see if we can determine a uri based off the operation in the stackFrames
     if (operation) {
       uri = flowInstance.globalContext.failedItems.find((uri) => operation.includes(`"${uri}"`));
+    } else if (error.message) {
+      uri = flowInstance.globalContext.failedItems.find((uri) => error.message.includes(`URI: ${uri}`));
     }
     flowInstance.addBatchError(flowInstance, error, uri);
   }

marklogic-data-hub/src/main/resources/ml-modules/root/data-hub/5/impl/hub-utils.sjs

@@ -44,18 +44,50 @@ class HubUtils {
    * @return An object consisting of two properties - "transaction" and "dateTime"
    */
   writeDocuments(writeQueue, permissions = xdmp.defaultPermissions(), collections = [], database = xdmp.databaseName(xdmp.database())){
-    return fn.head(xdmp.invoke('/data-hub/5/impl/hub-utils/invoke-queue-write.sjs',
-      {
-        writeQueue,
-        permissions,
-        baseCollections: collections || []
-      },
-      {
-        database: xdmp.database(database),
-        commit: 'auto',
-        update: 'true',
-        ignoreAmps: true
-      }));
+     try {
+        return fn.head(xdmp.invoke('/data-hub/5/impl/hub-utils/invoke-queue-write.sjs',
+          {
+            writeQueue,
+            permissions,
+            baseCollections: collections || []
+          },
+          {
+            database: xdmp.database(database),
+            commit: 'auto',
+            update: 'true',
+            ignoreAmps: true
+          }));
+    } catch (e) {
+        this.handleWriteErrors(e, writeQueue);
+    }
+  }
+
+
+  handleWriteErrors(error, contentArray) {
+    switch (error.name) {
+        case 'XDMP-CONFLICTINGUPDATES':
+            let data = error.data[0];
+            let parseUriRegex = /^xdmp\.documentInsert\("([^"]+)".*$/
+            let uri = parseUriRegex.test(data) ? data.replace(parseUriRegex, '$1'): null;
+            throw new Error(`Attempted to write to the same URI multiple times in the same transaction. ${ uri ? 'URI: ' + uri : ''}`);
+        case 'TDE-INDEX':
+            let isFailOnSubjectIRI = error.data.includes('$subject-iri');
+            if (isFailOnSubjectIRI) {
+                let failedContentObject = contentArray.find((contentObj) => error.data.includes(contentObj.uri));
+                if (failedContentObject) {
+                    let contentValue = failedContentObject.value;
+                    let entityTitle;
+                    if (contentValue instanceof Node) {
+                        entityTitle = fn.string(contentValue.xpath('/*:envelope/*:instance/*:info/*:title'));
+                    } else {
+                        entityTitle = contentValue.envelope.instance.info.title;
+                    }
+                    throw new Error(`Cannot write ${entityTitle} instance with multiple values for identifier property. URI: ${failedContentObject.uri}`);
+                }
+            }
+        default:
+            throw error;
+    }
   }
 
   updateNodePath(docURI, xpath, newNode, database = xdmp.databaseName(xdmp.database())){

marklogic-data-hub/src/test/ml-modules/root/test/suites/data-hub/5/impl/hub-utils/suite-setup.xqy

@@ -0,0 +1,8 @@
+xquery version "1.0-ml";
+import module namespace hub-test = "http://marklogic.com/data-hub/test" at "/test/data-hub-test-helper.xqy";
+hub-test:reset-hub();
+
+xquery version "1.0-ml";
+import module namespace hub-test = "http://marklogic.com/data-hub/test" at "/test/data-hub-test-helper.xqy";
+import module namespace test = "http://marklogic.com/test" at "/test/test-helper.xqy";
+hub-test:load-entities($test:__CALLER_FILE__);

marklogic-data-hub/src/test/ml-modules/root/test/suites/data-hub/5/impl/hub-utils/test-data/entities/Customer.entity.json

@@ -0,0 +1,17 @@
+{
+  "info": {
+    "title": "Customer",
+    "version": "0.0.1",
+    "baseUri": "http://example.org/"
+  },
+  "definitions": {
+    "Customer": {
+      "primaryKey": "customerId",
+      "properties": {
+        "customerId": {
+          "datatype": "integer"
+        }
+      }
+    }
+  }
+}

marklogic-data-hub/src/test/ml-modules/root/test/suites/data-hub/5/impl/hub-utils/writeDocuments.sjs

@@ -0,0 +1,29 @@
+'use strict';
+
+const HubUtils = require("/data-hub/5/impl/hub-utils.sjs");
+const hubUtils = new HubUtils();
+const test = require("/test/test-helper.xqy");
+
+const results = [];
+try {
+    hubUtils.writeDocuments([{uri: "/0.json", value: {}},{uri: "/1.json", value: {}},{uri: "/1.json", value: {}},{uri: "/2.json", value: {}}]);
+    test.assertTrue(false,'Should have thrown error for duplicate URIs!');
+} catch (e) {
+    results.push(test.assertEqual('Attempted to write to the same URI multiple times in the same transaction. URI: /1.json',e.message));
+}
+// Testing with JSON Object value
+try {
+    hubUtils.writeDocuments([{uri: "/customerObject.json", value: { envelope: { instance: { info: {version: '0.0.1', title: 'Customer'}, Customer: { customerId: [1,2]}}}}}]);
+    test.assertTrue(false,'Should have thrown error for multiple identifiers in an entity instance!');
+} catch (e) {
+    results.push(test.assertEqual('Cannot write Customer instance with multiple values for identifier property. URI: /customerObject.json',e.message));
+}
+// Testing with JSON Node value
+try {
+    hubUtils.writeDocuments([{uri: "/customerNode.json", value: xdmp.toJSON({ envelope: { instance: { info: {version: '0.0.1', title: 'Customer'}, Customer: { customerId: [1,2]}}}})}]);
+    test.assertTrue(false,'Should have thrown error for multiple identifiers in an entity instance!');
+} catch (e) {
+    results.push(test.assertEqual('Cannot write Customer instance with multiple values for identifier property. URI: /customerNode.json', e.message));
+}
+
+results;