refactor: log missing param errors

Closes #16

Author: patriciagarcia

src/factor-extractor.js

@@ -3,9 +3,6 @@ import config from './config/config.json'
 import { find } from './utils.js'
 import calculateWeeklyLevels from './weekly-levels-calculator'
 
-// centralized for whenever we implement #16
-const somethingIsWrong = () => {}
-
 const isVersion = (date, version) => {
   const momentDate = moment().isoWeekYear(date.year).isoWeek(date.week).isoWeekday(1).startOf('day')
   const momentVersionStartDate = moment(version.date, config.versionDateFormat).startOf('isoWeek').startOf('day')
@@ -24,19 +21,26 @@ const getFactor = (versions, date) => {
 
 const getCoefficients = (productCoefficients, date) => {
   if (!(productCoefficients && productCoefficients.versions && productCoefficients.versions.length)) {
-    return somethingIsWrong()
+    throw new Error('missing productCoefficients or productCoefficients.versions')
   }
+
   const version = getFactor(productCoefficients.versions, date)
-  return version && version.coefficients
+  if (!(version && version.coefficients)) {
+    throw new Error(`cannot find version of coefficients for date ${date}`)
+  }
+  return version.coefficients
 }
 
 const getWeeksOfStock = (location, date) => {
   if (!(location.plans && location.plans.length)) {
-    return somethingIsWrong()
+    throw new Error(`missing plans on location ${location._id}`)
   }
 
   const plans = getFactor(location.plans, date)
-  return plans && plans.weeksOfStock
+  if (!(plans && plans.weeksOfStock)) {
+    throw new Error(`cannot find version of weeksOfStock for location ${location._id} and date ${date}`)
+  }
+  return plans.weeksOfStock
 }
 
 const getTargetPopulations = (location, date) => {
@@ -66,46 +70,33 @@ const getTargetPopulations = (location, date) => {
 
 const getWeeklyLevels = (location, date) => {
   if (!(location.allocations && location.allocations.length)) {
-    return somethingIsWrong()
+    throw new Error(`missing allocations on location ${location._id}`)
   }
 
   const allocations = getFactor(location.allocations, date)
-  return allocations && allocations.weeklyLevels
+  if (!(allocations && allocations.weeklyLevels)) {
+    throw new Error(`cannot find version of weeklyLevels for location ${location._id} and date ${date}`)
+  }
+  return allocations.weeklyLevels
 }
 
 export default (location, productCoefficients, date) => {
   const weeksOfStock = getWeeksOfStock(location, date)
-  if (!weeksOfStock) {
-    return somethingIsWrong()
-  }
-
   const { version, monthlyTargetPopulations } = getTargetPopulations(location, date)
 
   // For backwards compatibility to version before introducing `targetPopulations`,
   // since for that version `weeklyAllocations` were not always calculated
   // based on target population
   if (version === 1) {
-    const weeklyLevels = getWeeklyLevels(location, date)
-    if (!weeklyLevels) {
-      return somethingIsWrong()
-    }
-
     return {
-      weeklyLevels,
+      weeklyLevels: getWeeklyLevels(location, date),
       weeksOfStock,
       monthlyTargetPopulations
     }
   }
 
   const coefficients = getCoefficients(productCoefficients, date)
-  if (!(monthlyTargetPopulations && coefficients)) {
-    return somethingIsWrong()
-  }
-
   const weeklyLevels = calculateWeeklyLevels(monthlyTargetPopulations, coefficients)
-  if (!weeklyLevels) {
-    return somethingIsWrong()
-  }
 
   return {
     weeklyLevels,

src/thresholds.service.js

@@ -1,5 +1,5 @@
 import defaultCoefficients from './config/coefficients.json'
-import { find } from './utils.js'
+import { find, somethingIsWrong } from './utils.js'
 import getFactors from './factor-extractor.js'
 
 class ThresholdsService {
@@ -16,21 +16,31 @@ class ThresholdsService {
   //
   // Passing the coefficientVersions as a param so that it can be adapted later to use the database doc
   calculateThresholds (location, stockCount, products, requiredStateStoresAllocation = {}, productCoefficients = defaultCoefficients) {
-    if (!(stockCount && stockCount.date)) {
-      return
+    if (!stockCount) {
+      const locationId = location && location._id ? location._id : 'with unknown id'
+      return somethingIsWrong(`missing mandatory param stock count for location ${locationId}`)
+    }
+    if (!stockCount.date) {
+      return somethingIsWrong(`missing date on stock count ${stockCount._id}`)
     }
 
-    if (!(location && location.level)) {
-      return
+    if (!location) {
+      const stockCountId = stockCount && stockCount._id ? stockCount._id : 'with unknown id'
+      return somethingIsWrong(`missing mandatory param location for stock count ${stockCountId}`)
+    }
+    if (!location.level) {
+      return somethingIsWrong(`missing level on location ${location._id}`)
     }
 
     if (!(products && products.length)) {
-      return
+      return somethingIsWrong('missing mandatory param products')
     }
 
-    const locationFactors = getFactors(location, productCoefficients, stockCount.date)
-
-    if (!locationFactors) {
+    let locationFactors
+    try {
+      locationFactors = getFactors(location, productCoefficients, stockCount.date)
+    } catch (e) {
+      somethingIsWrong(e.message)
       return
     }
 

src/utils.js

@@ -7,3 +7,10 @@ export function find (list, match) {
   }
   return undefined
 }
+
+export function somethingIsWrong (msg) {
+  if (console) {
+    console.warn(`angular-nav-thresholds: ${msg}`)
+  }
+  // TODO: log it to Google Analytics (#28)
+}