feat: improved error handling when extensions aren't found

readmeio · Nov 20, 2021 · c49b368 · c49b368
1 parent 8d2d624
commit c49b368
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 8 deletions.
diff --git a/__tests__/index.test.ts b/__tests__/index.test.ts
@@ -16,6 +16,17 @@ test.each([
 });
 
 describe('#getExtension', () => {
+  it("should not throw an exception if `Oas` doesn't have an API definition", () => {
+    const oas = Oas.init(undefined);
+    expect(extensions.getExtension(extensions.SAMPLES_LANGUAGES, oas)).toHaveLength(5);
+  });
+
+  it("should not throw an exception if `Operation` doesn't have an API definition", () => {
+    const oas = Oas.init(undefined);
+    const operation = oas.operation('/pet', 'post');
+    expect(extensions.getExtension(extensions.SAMPLES_LANGUAGES, oas, operation)).toHaveLength(5);
+  });
+
   describe('oas-level extensions', () => {
     it('should use the default extension value if the extension is not present', () => {
       const oas = Oas.init(petstore);
@@ -43,6 +54,15 @@ describe('#getExtension', () => {
       const oas = Oas.init({ ...petstore, [`x-${extensions.EXPLORER_ENABLED}`]: false });
       expect(extensions.getExtension(extensions.EXPLORER_ENABLED, oas)).toBe(false);
     });
+
+    it('should not throw if `x-readme` is not an object', () => {
+      const oas = Oas.init({
+        ...petstore,
+        'x-readme': true,
+      });
+
+      expect(extensions.getExtension(extensions.SAMPLES_LANGUAGES, oas)).toHaveLength(5);
+    });
   });
 
   describe('operation-level', () => {
@@ -75,6 +95,13 @@ describe('#getExtension', () => {
 
       expect(extensions.getExtension(extensions.EXPLORER_ENABLED, oas, operation)).toBe(false);
     });
+
+    it('should not throw if `x-readme` is not an object', () => {
+      const operation = oas.operation('/pet', 'post');
+      operation.schema['x-readme'] = true;
+
+      expect(extensions.getExtension(extensions.SAMPLES_LANGUAGES, oas)).toHaveLength(5);
+    });
   });
 });
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/src/index.ts b/src/index.ts
@@ -56,7 +56,7 @@ export function getExtension(extension: keyof Extensions, oas: Oas, operation?:
   if (operation) {
     if (operation.hasExtension('x-readme')) {
       const data = operation.getExtension('x-readme') as Extensions;
-      if (extension in data) {
+      if (data && typeof data === 'object' && extension in data) {
         return data[extension];
       }
     }
@@ -68,7 +68,7 @@ export function getExtension(extension: keyof Extensions, oas: Oas, operation?:
 
   if (oas.hasExtension('x-readme')) {
     const data = oas.getExtension('x-readme') as Extensions;
-    if (extension in data) {
+    if (data && typeof data === 'object' && extension in data) {
       return data[extension];
     }
   }