Update assertions (#309)

* Update assertions in backend to include more info

* Update assertions in config test

Author: rossjones

lib/importer/src/config.test.js

@@ -152,8 +152,8 @@ describe("Configuration tests", () => {
 //          * the new json object post-cbFunction
 //          * the pluginConfig that was modified by cbFunction
 function withCurrent(rootFolder, pluginConfig, cbFunction, assertionsFunc) {
-    assert(typeof (cbFunction) === 'function')
-    assert(typeof (assertionsFunc) === 'function')
+    assert(typeof (cbFunction) === 'function', "cbFunction must be a function");
+    assert(typeof (assertionsFunc) === 'function', "assertionsFunc must be a function");
     process.env.KIT_PROJECT_DIR = rootFolder
     const original = JSON.parse(fs.readFileSync(pluginConfig.configPath, 'utf8'));
     cbFunction(pluginConfig)

lib/importer/src/dudk/backend.js

@@ -76,8 +76,8 @@ exports.SessionGetSheets = (sid) => {
 };
 
 exports.SessionSetHeaderRange = (sid, range) => {
-  assert(range != null)
-  assert(range.sheet != null)
+  assert(range != null, "Null range passed to SessionSetHeaderRange");
+  assert(range.sheet != null, "Range with null sheet passed to SessionSetHeaderRange");
 
   sessionStore.apply(sid, (s) => { s.headerRanges[range.sheet] = range; })
 };
@@ -88,6 +88,8 @@ exports.SessionGetHeaderRange = (sid, sheetName) => {
 };
 
 exports.SessionSetFooterRange = (sid, range) => {
+  assert(range != null, "Null range passed to SessionSetFooterRange");
+  assert(range.sheet != null, "Range with null sheet passed to SessionSetFooterRange");
   sessionStore.apply(sid, (s) => { s.footerRanges[range.sheet] = range })
 };
 
@@ -153,7 +155,7 @@ function getDimensions(sid) {
 // "sheetDimensions" mapping sheet names to objects with "rows" and "columns"
 // properties listing how many rows and columns there are.
 exports.SessionGetInputDimensions = (sid) => {
-  assert(sessionStore.has(sid));
+  assert(sessionStore.has(sid), `No such session ${sid} when getting input dimensions`);
   return getDimensions(sid);
 };
 
@@ -222,7 +224,7 @@ exports.SessionGetSheetDimensions = (sid, sheetName) => {
 // footer range is also specified, it will stop the data range at the row above
 // the footer range.
 exports.SessionSuggestDataRange = (sid, headerRange, footerRange) => {
-  assert(sessionStore.has(sid));
+  assert(sessionStore.has(sid), `No such session ${sid} when suggesting data range`);
   const dimensions = getDimensions(sid);
 
   if (headerRange) {
@@ -381,9 +383,9 @@ function cellsToSamples(row) {
 
 // This function reserves the right to return fewer than requested rows.
 exports.SessionGetInputSampleRows = (sid, range, startCount, middleCount, endCount) => {
-  assert(range != null)
-  assert(sessionStore.has(sid));
-  assert(sessionStore.get(sid).wb.Sheets[range.sheet]);
+  assert(range != null, "Null range passed to SessionGetInputSampleRows");
+  assert(sessionStore.has(sid), `No such session ${sid} when getting input sample rows`);
+  assert(sessionStore.get(sid).wb.Sheets[range.sheet], `No such sheet ${range.sheet} in session ${sid} when getting input sample rows`);
   if (range.end.row < range.start.row || range.end.column < range.start.column) {
     // Range is empty
     return [[], [], []];
@@ -450,8 +452,8 @@ exports.SessionGetInputSampleRows = (sid, range, startCount, middleCount, endCou
 // formats, or an Array of possible formats for that type; and a field "full"
 // indicating if the column has no missing values.
 exports.SessionGuessTypes = (sid, range) => {
-  assert(sessionStore.has(sid));
-  assert(sessionStore.get(sid).wb.Sheets[range.sheet]);
+  assert(sessionStore.has(sid), `No such session ${sid} when guessing types`);
+  assert(sessionStore.get(sid).wb.Sheets[range.sheet], `No such sheet ${range.sheet} in session ${sid} when guessing types`);
   if(range.end.column < range.start.column) {
     // No columns in range
     return [];
@@ -569,10 +571,10 @@ exports.SessionSuggestFields = (sid, typeGuesses, domainModelFields) => {
 // and a .hasMore property that's a boolean set if the values array was
 // truncated to maxValues.
 exports.SessionGetInputValues = (sid, range, maxValues) => {
-  assert(sessionStore.get(sid));
-  assert(sessionStore.get(sid).wb.Sheets[range.sheet]);
+  assert(sessionStore.get(sid), `No such session ${sid} when getting input values`);
+  assert(sessionStore.get(sid).wb.Sheets[range.sheet], `No such sheet ${range.sheet} in session ${sid} when getting input values`);
   assert(range.end.row >= range.start.row, `End row (${range.end.row}) must be >= start row (${range.start.row}) to get input values`);
-  assert(range.end.column >= range.start.column);
+  assert(range.end.column >= range.start.column, `End column (${range.end.column}) must be >= start column (${range.start.column}) to get input values`);
 
   const sheet = sessionStore.get(sid).wb.Sheets[range.sheet];
   const data = sheet["!data"];
@@ -630,8 +632,8 @@ exports.SessionGetInputValues = (sid, range, maxValues) => {
 }
 
 exports.SessionDelete = (sid) => {
-  assert(sessionStore.get(sid));
-  sessionStore.delete(sid)
+  assert(sessionStore.get(sid), `No such session ${sid} when deleting session`);
+  sessionStore.delete(sid);
   dimensionsCache.delete(sid);
 }
 
@@ -649,28 +651,28 @@ function validateMapping(range, mapping) {
 
   // For now, mappings are just integer column indexes
 
-  assert(mapping.attributeMappings);
+  assert(mapping.attributeMappings, "Mapping must include attributeMappings");
 
   for (const attrSource of Object.values(mapping.attributeMappings)) {
-    assert(Number.isInteger(attrSource));
-    assert(attrSource >= 0);
-    assert(attrSource < columnsInRange);
+    assert(Number.isInteger(attrSource), "Attribute mapping must be an integer");
+    assert(attrSource >= 0, "Attribute mapping must be >= 0");
+    assert(attrSource < columnsInRange, "Attribute mapping must be < columnsInRange");
   }
 
   // Output types are optional, we fall back to basicStringType if not specified
   if (mapping.attributeTypes) {
     // eslint-disable-next-line no-unused-vars
     for (const [attribute, attrType] of Object.entries(mapping.attributeTypes)) {
-      assert(attrType instanceof Function);
+      assert(attrType instanceof Function, "Attribute type must be a function");
     }
   }
 }
 
 exports.SessionPerformMappingJob = (sid, range, mapping, includeErrorRow = false) => {
-  assert(sessionStore.get(sid));
-  assert(sessionStore.get(sid).wb.Sheets[range.sheet]);
+  assert(sessionStore.get(sid), `No such session ${sid} when performing mapping job`);
+  assert(sessionStore.get(sid).wb.Sheets[range.sheet], `No such sheet ${range.sheet} in session ${sid} when performing mapping job`);
   assert(range.end.row >= range.start.row, `End row (${range.end.row}) must be >= start row (${range.start.row}) when performing mapping`);
-  assert(range.end.column >= range.start.column);
+  assert(range.end.column >= range.start.column, `End column (${range.end.column}) must be >= start column (${range.start.column}) when performing mapping`);
 
   const footerRange = this.SessionGetFooterRange(sid, range.sheet); // Ensure the footer range is loaded
 
@@ -789,9 +791,9 @@ exports.SessionPerformMappingJob = (sid, range, mapping, includeErrorRow = false
 
 // Returns number of records, number of rows with errors, number of rows with warnings
 exports.JobGetSummary = (sid, jid) => {
-  assert(sessionStore.has(sid))
+  assert(sessionStore.has(sid), `No such session ${sid} when getting job summary`);
   const session = sessionStore.get(sid)
-  assert(session.jobs.has(jid));
+  assert(session.jobs.has(jid), `No such job ${jid} when getting job summary`);
 
   let job = session.jobs.get(jid);
 
@@ -803,28 +805,28 @@ exports.JobGetSummary = (sid, jid) => {
 };
 
 exports.JobGetWarnings = (sid, jid) => {
-  assert(sessionStore.has(sid))
+  assert(sessionStore.has(sid), `No such session ${sid} when getting job warnings`);
   const session = sessionStore.get(sid)
-  assert(session.jobs.has(jid));
+  assert(session.jobs.has(jid), `No such job ${jid} when getting job warnings`);
 
   let job = session.jobs.get(jid);
 
   return job.warnings;
 }
 
 exports.JobGetErrors = (sid, jid) => {
-  assert(sessionStore.has(sid))
+  assert(sessionStore.has(sid), `No such session ${sid} when getting job errors`);
   const session = sessionStore.get(sid)
-  assert(session.jobs.has(jid));
+  assert(session.jobs.has(jid), `No such job ${jid} when getting job errors`);
 
   let job = session.jobs.get(jid);
   return job.errors;
 }
 
 exports.JobGetSampleRecords = (sid, jid, startCount, middleCount, endCount) => {
-  assert(sessionStore.has(sid))
+  assert(sessionStore.has(sid), `No such session ${sid} when getting job sample records`);
   const session = sessionStore.get(sid)
-  assert(session.jobs.has(jid));
+  assert(session.jobs.has(jid), `No such job ${jid} when getting job sample records`);
 
   let records = session.jobs.get(jid).records;
 
@@ -855,9 +857,9 @@ exports.JobGetSampleRecords = (sid, jid, startCount, middleCount, endCount) => {
 }
 
 exports.JobGetRecords = (sid, jid, start, count) => {
-  assert(sessionStore.has(sid))
+  assert(sessionStore.has(sid), `No such session ${sid} when getting job records`);
   const session = sessionStore.get(sid)
-  assert(session.jobs.has(jid));
+  assert(session.jobs.has(jid), `No such job ${jid} when getting job records`);
 
   const allRecords = session.jobs.get(jid).records;
 
@@ -872,9 +874,9 @@ exports.JobGetRecords = (sid, jid, start, count) => {
 }
 
 exports.JobDelete = (sid, jid) => {
-  assert(sessionStore.has(sid))
+  assert(sessionStore.has(sid), `No such session ${sid} when deleting job ${jid}`);
   const session = sessionStore.get(sid)
-  assert(session.jobs.has(jid));
+  assert(session.jobs.has(jid), `No such job ${jid} when deleting job`);
 
   sessionStore.apply(sid, (s) => { s.jobs.delete(jid) })
 }