Refactor serializer to allow for before/after hooks

Author: digitalsadhu

lib/serialize.js

@@ -20,7 +20,6 @@ module.exports = function (app, defaults) {
       modelNamePlural,
       relatedModelPlural,
       relations,
-      res,
       model,
       requestedIncludes;
 
@@ -84,6 +83,7 @@ module.exports = function (app, defaults) {
       requestedIncludes = ctx.req.remotingContext.args.filter.include;
     }
     options = {
+      model: model,
       primaryKeyField: primaryKeyField,
       requestedIncludes: requestedIncludes,
       host: utils.hostFromContext(ctx),
@@ -111,14 +111,11 @@ module.exports = function (app, defaults) {
     relations = utils.getRelationsFromContext(ctx, app);
 
     // Serialize our request
-    try {
-      res = serializer(type, data, relations, options);
-    } catch (e) {
-      next(e);
-    }
-
-    ctx.result = res;
+    serializer(type, data, relations, options, function (err, results) {
+      if (err) return next(err);
 
-    next();
+      ctx.result = results;
+      next();
+    });
   });
 };

lib/serializer.js

@@ -2,39 +2,82 @@ var _ = require('lodash');
 var RelUtils = require('./utilities/relationship-utils');
 var utils = require('./utils');
 
-module.exports = function serializer (type, data, relations, options) {
+function defaultBeforeSerialize (options, cb) {
+  cb(null, options);
+}
 
+function defaultSerialize (options, cb) {
   var result = null;
   var resultData = {};
-  options.attributes = options.attributes || {};
-
-  options.isRelationshipRequest = false;
-
-  if (options.topLevelLinks.self.match(/\/relationships\//)) {
-    options.topLevelLinks.related = options.topLevelLinks.self.replace('/relationships/', '/');
-    options.isRelationshipRequest = true;
-  }
 
-  if (_.isArray(data)) {
-    result = parseCollection(type, data, relations, options);
-  } else if (_.isPlainObject(data)) {
-    result = parseResource(type, data, relations, options);
+  if (_.isArray(options.results)) {
+    result = parseCollection(options.type, options.results, options.relationships, options);
+  } else if (_.isPlainObject(options.results)) {
+    result = parseResource(options.type, options.results, options.relationships, options);
   }
 
-  resultData.data = result;
-
   if (options.topLevelLinks) {
     resultData.links = makeLinks(options.topLevelLinks);
   }
 
+  resultData.data = result;
+
   /**
    * If we're requesting to sideload relationships...
    */
   if (options.requestedIncludes) {
-    handleIncludes(resultData, options.requestedIncludes, relations);
+    try {
+      handleIncludes(resultData, options.requestedIncludes, options.relationships);
+    } catch (err) {
+      cb(err);
+    }
+  }
+
+  options.results = resultData;
+  cb(null, options);
+}
+
+function defaultAfterSerialize (options, cb) {
+  cb(null, options);
+}
+
+module.exports = function serializer (type, data, relations, options, cb) {
+  options = _.clone(options);
+  options.attributes = options.attributes || {};
+
+  options.isRelationshipRequest = false;
+
+  if (options.topLevelLinks.self.match(/\/relationships\//)) {
+    options.topLevelLinks.related = options.topLevelLinks.self.replace('/relationships/', '/');
+    options.isRelationshipRequest = true;
   }
+  var serializeOptions;
+  var model = options.model;
+
+  var beforeSerialize = (typeof model.beforeJsonApiSerialize === 'function') ?
+    model.beforeJsonApiSerialize : defaultBeforeSerialize;
+
+  var serialize = (typeof model.jsonApiSerialize === 'function') ?
+    model.jsonApiSerialize : defaultSerialize;
+
+  var afterSerialize = (typeof model.afterJsonApiSerialize === 'function') ?
+    model.afterJsonApiSerialize : defaultAfterSerialize;
 
-  return resultData;
+  serializeOptions = _.defaults(options, {
+    type: type,
+    results: data,
+    relationships: relations
+  });
+  beforeSerialize(serializeOptions, function (err, serializeOptions) {
+    if (err) return cb(err);
+    serialize(serializeOptions, function (err, serializeOptions) {
+      if (err) return cb(err);
+      afterSerialize(serializeOptions, function (err, serializeOptions) {
+        if (err) return cb(err);
+        return cb(null, serializeOptions.results);
+      });
+    });
+  });
 };
 
 /**