Implement parse-native-query-error and parse-native-query-result. Get rid of notUnique exit.

Author: mikermcneil

README.md

@@ -27,4 +27,3 @@ Learn more at <a href="http://node-machine.org/implementing/FAQ" title="Machine
 ## License
 
 MIT &copy; 2015 contributors
-

machines/parse-native-query-error.js

@@ -0,0 +1,86 @@
+module.exports = {
+
+
+  friendlyName: 'Parse native query error',
+
+
+  description: 'Attempt to identify and parse a raw error from sending a native query and normalize it to a standard error footprint.',
+
+
+  cacheable: true,
+
+
+  sync: true,
+
+
+  inputs: {
+
+    queryType: {
+      description: 'The type of query operation this raw error came from.',
+      extendedDescription: 'Either "select", "insert", "delete", or "update".  This determines how the provided raw error will be parsed/coerced.',
+      moreInfoUrl: 'https://github.com/particlebanana/waterline-query-builder/blob/master/docs/syntax.md',
+      required: true,
+      example: 'select',// (select|insert|delete|update)
+    },
+
+    nativeQueryError: {
+      description: 'The error sent back from the database as a result of a native query.',
+      extendedDescription: 'This is referring to e.g. the output (`err`) returned through the `error` exit of `sendNativeQuery()` in this driver.',
+      required: true,
+      example: '==='
+    },
+
+    meta:
+      require('../constants/meta.input')
+
+  },
+
+
+  exits: {
+
+    success: {
+      description: 'The normalization is complete.  If the error cannot be normalized into any other more specific footprint, then the catchall footprint will be returned.',
+      outputVariableName: 'report',
+      outputDescription: 'The `footprint` property is the normalized "footprint" representing the provided raw error.  Conforms to one of a handful of standardized footprint types expected by the Waterline driver interface.   The `meta` property is reserved for custom adapter-specific extensions.',
+      example: {
+        footprint: {},
+        meta: '==='
+      }
+    },
+
+  },
+
+
+  fn: function (inputs, exits) {
+
+    var footprint = { identity: 'catchall' };
+    switch (inputs.queryType){
+      case 'select':
+        break;
+
+      case 'insert':
+      case 'update':
+        // TODO: negotiate `notUnique` error.
+        //
+        // For implementation help w/ building `columns`, see:
+        //  • https://github.com/balderdashy/sails-postgresql/blob/a51b3643777dcf1af5517acbf76e09612d36b301/lib/adapter.js#L1308
+        // if (inputs.nativeQueryError.??????) {
+        //   footprint.identity = 'notUnique';
+        //   footprint.columns = [ 'email_address' ];
+        // }
+        break;
+
+      case 'delete':
+        break;
+
+      default:
+
+    }
+
+    return exits.success({
+      footprint: footprint
+    });
+  }
+
+
+};

machines/parse-native-query-result.js

@@ -0,0 +1,91 @@
+module.exports = {
+
+
+  friendlyName: 'Parse native query result',
+
+
+  description: 'Parse a raw result from a native query and normalize it for the specified query type.',
+
+
+  cacheable: true,
+
+
+  sync: true,
+
+
+  inputs: {
+
+    queryType: {
+      description: 'The type of query operation this raw result came from.',
+      extendedDescription: 'Either "select", "insert", "delete", or "update".  This determines how the provided raw result will be parsed/coerced.',
+      moreInfoUrl: 'https://github.com/particlebanana/waterline-query-builder/blob/master/docs/syntax.md',
+      required: true,
+      example: 'select',// (select|insert|delete|update)
+    },
+
+    nativeQueryResult: {
+      description: 'The result data sent back from the the database as a result of a native query.',
+      extendedDescription: 'The provided data will be coerced to a JSON-serializable value if it isn\'t one already (see [rttc.dehydrate()](https://github.com/node-machine/rttc#dehydratevalue-allownullfalse-dontstringifyfunctionsfalse)). That means any Date instances therein will be converted to timezone-agnostic ISO timestamp strings (i.e. JSON timestamps).',
+      required: true,
+      example: '*'
+    },
+
+    meta:
+      require('../constants/meta.input')
+
+  },
+
+
+  exits: {
+
+    success: {
+      description: 'The result was successfully normalized.',
+      outputVariableName: 'report',
+      outputDescription: 'The `result` property is the normalized version of the raw result originally provided.   The `meta` property is reserved for custom adapter-specific extensions.',
+      example: {
+        result: '*',
+        meta: '==='
+      }
+    },
+
+  },
+
+
+  fn: function (inputs, exits) {
+
+    var normalizedResult;
+    switch (inputs.queryType){
+      case 'select':
+        normalizedResult = inputs.nativeQueryResult.rows;
+        break;
+
+      case 'insert':
+        normalizedResult = {
+          inserted: inputs.nativeQueryResult.oid
+          // TODO ^validate that this actually works
+        };
+        break;
+
+      case 'update':
+        normalizedResult = {
+          numRecordsUpdated: inputs.nativeQueryResult.rowCount
+        };
+        break;
+
+      case 'delete':
+        normalizedResult = {
+          numRecordsDeleted: inputs.nativeQueryResult.rowCount
+        };
+        break;
+
+      default:
+
+    }
+
+    return exits.success({
+      result: normalizedResult
+    });
+  }
+
+
+};

machines/send-native-query.js

@@ -40,19 +40,7 @@ module.exports = {
     },
 
     badConnection:
-      require('../constants/badConnection.exit'),
-
-    notUnique: {
-      friendlyName: 'Not unique',
-      description: 'The provided query failed because it would violate one or more uniqueness constraints.',
-      outputVariableName: 'report',
-      outputDescription: 'The `columns` property is an array containing the names of columns with uniquness constraint violations. The `error` property is a JavaScript Error instance containing the raw error from the database.  The `meta` property is reserved for custom adapter-specific extensions.',
-      example: {
-        columns: [ 'email_address' ],
-        error: '===',
-        meta: '==='
-      }
-    }
+      require('../constants/badConnection.exit')
 
   },
 
@@ -84,10 +72,6 @@ module.exports = {
     // Send native query
     inputs.connection.client.query(sql, bindings, function query(err, result) {
       if (err) {
-        // TODO: negotiate `notUnique` error.
-        //
-        // For implementation help w/ building `columns`, see:
-        //  • https://github.com/balderdashy/sails-postgresql/blob/a51b3643777dcf1af5517acbf76e09612d36b301/lib/adapter.js#L1308
         return exits.error(err);
       }
 

package.json

@@ -32,6 +32,8 @@
       "get-connection",
       "release-connection",
       "send-native-query",
+      "parse-native-query-result",
+      "parse-native-query-error",
       "begin-transaction",
       "commit-transaction",
       "rollback-transaction",