@northscaler/service-support
Version:
Artifacts that assist in writing service layers effectively
135 lines (123 loc) • 12.8 kB
JavaScript
;
const ResponseStatus = require('../enums/ResponseStatus');
const defaultErrorFormatter = require('../formatters/error-formatter');
const defaultDateFormatter = require('../formatters/date-formatter');
const DateFormat = require('../enums/DateFormat');
function formatValuesIn({
value,
formatters
} = {}) {
if (!value) return value;
if (Array.isArray(value)) return value.map(it => formatValuesIn({
value: it,
formatters
}));
for (const formatter of formatters) {
if (value instanceof formatter.type) return formatter.formatter(value);
}
if (typeof value === 'object') {
return Object.keys(value).reduce((accum, next) => {
value[next] = formatValuesIn({
value: value[next],
formatters
});
return accum;
}, value);
}
return value;
}
/**
* Function used to execute the given function in a `try`/`catch` block.
* If the function returns normally, the return value is wrapped in a service response object with the following shape:
* ```
* {
* data: <function return value>,
* meta: {
* status: ResponseStatus.SUCCESS,
* elapsedMillis: n
* }
* }
* ```
* If the function throws, the `Error` is caught, and formatted as a service response object with the following shape:
* ```
* {
* error: {
* name: ...,
* message: ...,
* code: ...,
* info: ...,
* cause: ...,
* stack: ...,
* },
* meta: {
* status: ResponseStatus.FAILURE,
* elapsedMillis: n
* }
* }
* ```
*
* @private
* @param {object} arg0 The argument to be deconstructed.
* @param {function} arg0.fn The function to be called.
* @param {Formatter[]} [arg0.formatters] Formatters to be used when formatting values in returned objects or thrown `Error`s.
* Shape is `{ type, formatter }`, where `type` is a type like `Date`, `Error`, etc and `formatter` is the formatting function.
* Example: `{ type: Date, formatter: date => date.toString() }`.
* Appropriate defaults are provided.
* @param {boolean} [arg0.includeErrorStacks=true] Whether to include the `Error` `stack` property if one is thrown or there are `Error`s in the return value.
* Ignored if `formatters` is given.
* @param {boolean} [arg0.includeErrorCauses=true] Whether to include the `Error` `cause` property if one is thrown or there are `Error`s in the return value.
* Ignored if `formatters` is given.
* @param {DateFormat} [arg0.dateFormat=DateFormat.ISO_8601] The date format to use.
* Ignored if `formatters` is given.
* @return {Promise<{meta: {elapsedMillis: number, status: *}, error: *}|{data: *, meta: {elapsedMillis: number, status: *}}>}
*/
async function servicifyOutcomeOf({
fn,
formatters,
includeErrorStacks = true,
includeErrorCauses = true,
dateFormat = DateFormat.ISO_8601
} = {}) {
formatters = formatters || [{
type: Error,
formatter: error => defaultErrorFormatter({
error,
includeStack: includeErrorStacks,
includeCause: includeErrorCauses
})
}, {
type: Date,
formatter: date => defaultDateFormatter({
date,
format: dateFormat
})
}];
formatters = Array.isArray(formatters) ? formatters : [formatters];
const begin = Date.now();
try {
const value = await fn();
return {
data: formatValuesIn({
value,
formatters
}),
meta: {
status: ResponseStatus.SUCCESS.name,
elapsedMillis: Date.now() - begin
}
};
} catch (e) {
return {
error: formatValuesIn({
value: e,
formatters
}),
meta: {
status: ResponseStatus.FAILURE.name,
elapsedMillis: Date.now() - begin
}
};
}
}
module.exports = servicifyOutcomeOf;
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"sources":["../../../src/main/service/servicifyOutcomeOf.js"],"names":["ResponseStatus","require","defaultErrorFormatter","defaultDateFormatter","DateFormat","formatValuesIn","value","formatters","Array","isArray","map","it","formatter","type","Object","keys","reduce","accum","next","servicifyOutcomeOf","fn","includeErrorStacks","includeErrorCauses","dateFormat","ISO_8601","Error","error","includeStack","includeCause","Date","date","format","begin","now","data","meta","status","SUCCESS","name","elapsedMillis","e","FAILURE","module","exports"],"mappings":"AAAA;;AAEA,MAAMA,cAAc,GAAGC,OAAO,CAAC,yBAAD,CAA9B;;AACA,MAAMC,qBAAqB,GAAGD,OAAO,CAAC,+BAAD,CAArC;;AACA,MAAME,oBAAoB,GAAGF,OAAO,CAAC,8BAAD,CAApC;;AACA,MAAMG,UAAU,GAAGH,OAAO,CAAC,qBAAD,CAA1B;;AAEA,SAASI,cAAT,CAAyB;AACvBC,EAAAA,KADuB;AAEvBC,EAAAA;AAFuB,IAGrB,EAHJ,EAGQ;AACN,MAAI,CAACD,KAAL,EAAY,OAAOA,KAAP;AAEZ,MAAIE,KAAK,CAACC,OAAN,CAAcH,KAAd,CAAJ,EAA0B,OAAOA,KAAK,CAACI,GAAN,CAAUC,EAAE,IAAIN,cAAc,CAAC;AAAEC,IAAAA,KAAK,EAAEK,EAAT;AAAaJ,IAAAA;AAAb,GAAD,CAA9B,CAAP;;AAE1B,OAAK,MAAMK,SAAX,IAAwBL,UAAxB,EAAoC;AAClC,QAAID,KAAK,YAAYM,SAAS,CAACC,IAA/B,EAAqC,OAAOD,SAAS,CAACA,SAAV,CAAoBN,KAApB,CAAP;AACtC;;AAED,MAAI,OAAOA,KAAP,KAAiB,QAArB,EAA+B;AAC7B,WAAOQ,MAAM,CAACC,IAAP,CAAYT,KAAZ,EAAmBU,MAAnB,CAA0B,CAACC,KAAD,EAAQC,IAAR,KAAiB;AAChDZ,MAAAA,KAAK,CAACY,IAAD,CAAL,GAAcb,cAAc,CAAC;AAAEC,QAAAA,KAAK,EAAEA,KAAK,CAACY,IAAD,CAAd;AAAsBX,QAAAA;AAAtB,OAAD,CAA5B;AACA,aAAOU,KAAP;AACD,KAHM,EAGJX,KAHI,CAAP;AAID;;AAED,SAAOA,KAAP;AACD;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;AACA,eAAea,kBAAf,CAAmC;AACjCC,EAAAA,EADiC;AAEjCb,EAAAA,UAFiC;AAGjCc,EAAAA,kBAAkB,GAAG,IAHY;AAIjCC,EAAAA,kBAAkB,GAAG,IAJY;AAKjCC,EAAAA,UAAU,GAAGnB,UAAU,CAACoB;AALS,IAM/B,EANJ,EAMQ;AACNjB,EAAAA,UAAU,GAAGA,UAAU,IAAI,CAAC;AAC1BM,IAAAA,IAAI,EAAEY,KADoB;AAE1Bb,IAAAA,SAAS,EAAEc,KAAK,IAAIxB,qBAAqB,CAAC;AACxCwB,MAAAA,KADwC;AAExCC,MAAAA,YAAY,EAAEN,kBAF0B;AAGxCO,MAAAA,YAAY,EAAEN;AAH0B,KAAD;AAFf,GAAD,EAOxB;AACDT,IAAAA,IAAI,EAAEgB,IADL;AAEDjB,IAAAA,SAAS,EAAEkB,IAAI,IAAI3B,oBAAoB,CAAC;AACtC2B,MAAAA,IADsC;AAEtCC,MAAAA,MAAM,EAAER;AAF8B,KAAD;AAFtC,GAPwB,CAA3B;AAcAhB,EAAAA,UAAU,GAAGC,KAAK,CAACC,OAAN,CAAcF,UAAd,IAA4BA,UAA5B,GAAyC,CAACA,UAAD,CAAtD;AAEA,QAAMyB,KAAK,GAAGH,IAAI,CAACI,GAAL,EAAd;;AAEA,MAAI;AACF,UAAM3B,KAAK,GAAG,MAAMc,EAAE,EAAtB;AACA,WAAO;AACLc,MAAAA,IAAI,EAAE7B,cAAc,CAAC;AAAEC,QAAAA,KAAF;AAASC,QAAAA;AAAT,OAAD,CADf;AAEL4B,MAAAA,IAAI,EAAE;AACJC,QAAAA,MAAM,EAAEpC,cAAc,CAACqC,OAAf,CAAuBC,IAD3B;AAEJC,QAAAA,aAAa,EAAEV,IAAI,CAACI,GAAL,KAAaD;AAFxB;AAFD,KAAP;AAOD,GATD,CASE,OAAOQ,CAAP,EAAU;AACV,WAAO;AACLd,MAAAA,KAAK,EAAErB,cAAc,CAAC;AAAEC,QAAAA,KAAK,EAAEkC,CAAT;AAAYjC,QAAAA;AAAZ,OAAD,CADhB;AAEL4B,MAAAA,IAAI,EAAE;AACJC,QAAAA,MAAM,EAAEpC,cAAc,CAACyC,OAAf,CAAuBH,IAD3B;AAEJC,QAAAA,aAAa,EAAEV,IAAI,CAACI,GAAL,KAAaD;AAFxB;AAFD,KAAP;AAOD;AACF;;AAEDU,MAAM,CAACC,OAAP,GAAiBxB,kBAAjB","sourcesContent":["'use strict'\n\nconst ResponseStatus = require('../enums/ResponseStatus')\nconst defaultErrorFormatter = require('../formatters/error-formatter')\nconst defaultDateFormatter = require('../formatters/date-formatter')\nconst DateFormat = require('../enums/DateFormat')\n\nfunction formatValuesIn ({\n  value,\n  formatters\n} = {}) {\n  if (!value) return value\n\n  if (Array.isArray(value)) return value.map(it => formatValuesIn({ value: it, formatters }))\n\n  for (const formatter of formatters) {\n    if (value instanceof formatter.type) return formatter.formatter(value)\n  }\n\n  if (typeof value === 'object') {\n    return Object.keys(value).reduce((accum, next) => {\n      value[next] = formatValuesIn({ value: value[next], formatters })\n      return accum\n    }, value)\n  }\n\n  return value\n}\n\n/**\n * Function used to execute the given function in a `try`/`catch` block.\n * If the function returns normally, the return value is wrapped in a service response object with the following shape:\n * ```\n * {\n *   data: <function return value>,\n *   meta: {\n *     status: ResponseStatus.SUCCESS,\n *     elapsedMillis: n\n *   }\n * }\n * ```\n * If the function throws, the `Error` is caught, and formatted as a service response object with the following shape:\n * ```\n * {\n *   error: {\n *     name: ...,\n *     message: ...,\n *     code: ...,\n *     info: ...,\n *     cause: ...,\n *     stack: ...,\n *   },\n *   meta: {\n *     status: ResponseStatus.FAILURE,\n *     elapsedMillis: n\n *   }\n * }\n * ```\n *\n * @private\n * @param {object} arg0 The argument to be deconstructed.\n * @param {function} arg0.fn The function to be called.\n * @param {Formatter[]} [arg0.formatters] Formatters to be used when formatting values in returned objects or thrown `Error`s.\n * Shape is `{ type, formatter }`, where `type` is a type like `Date`, `Error`, etc and `formatter` is the formatting function.\n * Example: `{ type: Date, formatter: date => date.toString() }`.\n * Appropriate defaults are provided.\n * @param {boolean} [arg0.includeErrorStacks=true] Whether to include the `Error` `stack` property if one is thrown or there are `Error`s in the return value.\n * Ignored if `formatters` is given.\n * @param {boolean} [arg0.includeErrorCauses=true] Whether to include the `Error` `cause` property if one is thrown or there are `Error`s in the return value.\n * Ignored if `formatters` is given.\n * @param {DateFormat} [arg0.dateFormat=DateFormat.ISO_8601] The date format to use.\n * Ignored if `formatters` is given.\n * @return {Promise<{meta: {elapsedMillis: number, status: *}, error: *}|{data: *, meta: {elapsedMillis: number, status: *}}>}\n */\nasync function servicifyOutcomeOf ({\n  fn,\n  formatters,\n  includeErrorStacks = true,\n  includeErrorCauses = true,\n  dateFormat = DateFormat.ISO_8601\n} = {}) {\n  formatters = formatters || [{\n    type: Error,\n    formatter: error => defaultErrorFormatter({\n      error,\n      includeStack: includeErrorStacks,\n      includeCause: includeErrorCauses\n    })\n  }, {\n    type: Date,\n    formatter: date => defaultDateFormatter({\n      date,\n      format: dateFormat\n    })\n  }]\n  formatters = Array.isArray(formatters) ? formatters : [formatters]\n\n  const begin = Date.now()\n\n  try {\n    const value = await fn()\n    return {\n      data: formatValuesIn({ value, formatters }),\n      meta: {\n        status: ResponseStatus.SUCCESS.name,\n        elapsedMillis: Date.now() - begin\n      }\n    }\n  } catch (e) {\n    return {\n      error: formatValuesIn({ value: e, formatters }),\n      meta: {\n        status: ResponseStatus.FAILURE.name,\n        elapsedMillis: Date.now() - begin\n      }\n    }\n  }\n}\n\nmodule.exports = servicifyOutcomeOf\n"]}