Returning meaningful error on missing worksheet

Siemienik · Oct 3, 2023 · 46a4336 · 46a4336
1 parent 6be12e3
commit 46a4336
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 8 deletions.
diff --git a/packages/xlsx-import/package-lock.json b/packages/xlsx-import/package-lock.json
diff --git a/packages/xlsx-import/package.json b/packages/xlsx-import/package.json
@@ -44,6 +44,7 @@
   "devDependencies": {
     "@types/chai": "^4.2.14",
     "@types/mocha": "^5.2.7",
+    "@types/node": "^20.8.2",
     "chai": "^4.2.0",
     "markdownlint-cli": "^0.31.0",
     "mocha": "^9.2.0",

diff --git a/packages/xlsx-import/src/Importer.ts b/packages/xlsx-import/src/Importer.ts
@@ -12,7 +12,9 @@ export class Importer implements IImporter {
         const { worksheet } = config;
         const type = (config.type as ImportType) || IMPORT_TYPE_DEFAULT;
         const ws = this.wb.getWorksheet(worksheet);
-
+        if (!ws) {
+            throw new Error(`Worksheet "${worksheet}" not found in workbook.`);
+        }
         return getStrategyByType(type)(config, ws);
     }
 

diff --git a/packages/xlsx-import/tests/integration/vertical-lists.test.ts b/packages/xlsx-import/tests/integration/vertical-lists.test.ts
@@ -26,6 +26,9 @@ describe('testing vertical list - on file "marsjanie-db"', () => {
             ],
             rowOffset: 1,
         },
+        not_existing_wroksheet: {
+            worksheet: 'dummy'
+        }
     };
 
     it('worksheet "szit1"', async () => {
@@ -180,4 +183,11 @@ describe('testing vertical list - on file "marsjanie-db"', () => {
 
         chai.expect(result).eql(expected);
     });
+
+    it(`should return a meaningful error when the worksheet is not found`, async() => {
+        const factory = new ImporterFactory();
+        const importer = await factory.from('tests/data/marsjanie-db.xlsx');
+        const result = () => importer.getAllItems(configs.not_existing_wroksheet);
+        chai.expect(result).to.throw('Worksheet "dummy" not found in workbook.');
+    });
 });
diff --git a/packages/xlsx-import/tsconfig.json b/packages/xlsx-import/tsconfig.json
@@ -6,7 +6,8 @@
         "outDir": "./lib",
         "strict": true,
         "esModuleInterop": true,
-        "sourceMap": true
+        "sourceMap": true,
+        "lib": ["ES2015", "DOM", "ES2017", "ES2017.Object", "ESNext", "DOM.Iterable"]
     },
     "include": ["src"],
     "exclude": [