Merge pull request #6 from hey-api/fix/resolve-json

fix: correctly resolve json input

Author: mrlubos

lib/__tests__/index.test.ts

@@ -0,0 +1,43 @@
+import path from 'node:path';
+
+import { describe, expect, it } from 'vitest';
+
+import { getResolvedInput } from '../index';
+
+describe('getResolvedInput', () => {
+  it('handles url', async () => {
+    const pathOrUrlOrSchema =  'https://foo.com';
+    const resolvedInput = await getResolvedInput({ pathOrUrlOrSchema });
+    expect(resolvedInput.type).toBe('url');
+    expect(resolvedInput.schema).toBeUndefined();
+    expect(resolvedInput.path).toBe('https://foo.com/');
+  });
+
+  it('handles file', async () => {
+    const pathOrUrlOrSchema =  './path/to/openapi.json';
+    const resolvedInput = await getResolvedInput({ pathOrUrlOrSchema });
+    expect(resolvedInput.type).toBe('file');
+    expect(resolvedInput.schema).toBeUndefined();
+    expect(resolvedInput.path).toBe(path.resolve('./path/to/openapi.json'));
+  });
+
+  it('handles raw spec', async () => {
+    const pathOrUrlOrSchema =  {
+      info: {
+        version: '1.0.0',
+      },
+      openapi: '3.1.0',
+      paths: {},
+    };
+    const resolvedInput = await getResolvedInput({ pathOrUrlOrSchema });
+    expect(resolvedInput.type).toBe('json');
+    expect(resolvedInput.schema).toEqual({
+      info: {
+        version: '1.0.0',
+      },
+      openapi: '3.1.0',
+      paths: {},
+    });
+    expect(resolvedInput.path).toBe('');
+  });
+});

lib/index.ts

@@ -38,7 +38,7 @@ export const getResolvedInput = ({
   // So we're being generous here and doing the conversion automatically.
   // This is not intended to be a 100% bulletproof solution.
   // If it doesn't work for your use-case, then use a URL instead.
-  if (url.isFileSystemPath(resolvedInput.path)) {
+  if (resolvedInput.path && url.isFileSystemPath(resolvedInput.path)) {
     resolvedInput.path = url.fromFileSystemPath(resolvedInput.path);
     resolvedInput.type = 'file';
   } else if (!resolvedInput.path && pathOrUrlOrSchema && typeof pathOrUrlOrSchema === 'object') {
@@ -54,8 +54,10 @@ export const getResolvedInput = ({
     }
   }
 
-  // resolve the absolute path of the schema
-  resolvedInput.path = url.resolve(url.cwd(), resolvedInput.path);
+  if (resolvedInput.type !== 'json') {
+    // resolve the absolute path of the schema
+    resolvedInput.path = url.resolve(url.cwd(), resolvedInput.path);
+  }
 
   return resolvedInput;
 }

lib/resolvers/url.ts

@@ -14,73 +14,73 @@ export const sendRequest = async ({
   timeout?: number;
   url: URL | string;
 }): Promise<{
+  init?: RequestInit;
   response: Response;
 }> => {
   url = new URL(url);
   redirects.push(url.href);
 
-  try {
-    const controller = new AbortController();
-    const timeoutId = setTimeout(() => {
-      controller.abort();
-    }, timeout);
-    const response = await fetch(url, {
-      signal: controller.signal,
-      ...init,
-    });
-    clearTimeout(timeoutId);
-
-    if (response.status >= 400) {
-      // gracefully handle HEAD method not allowed
-      if (response.status === 405 && init?.method === 'HEAD') {
-        return { response };
-      }
+  const controller = new AbortController();
+  const timeoutId = setTimeout(() => {
+    controller.abort();
+  }, timeout);
+  const response = await fetch(url, {
+    signal: controller.signal,
+    ...init,
+  });
+  clearTimeout(timeoutId);
 
-      throw ono({ status: response.status }, `HTTP ERROR ${response.status}`);
+  if (response.status >= 300 && response.status <= 399) {
+    if (redirects.length > 5) {
+      throw new ResolverError(
+        ono(
+          { status: response.status },
+          `Error requesting ${redirects[0]}. \nToo many redirects: \n  ${redirects.join(" \n  ")}`,
+        ),
+      );
     }
-    
-    if (response.status >= 300) {
-      if (redirects.length > 5) {
-        throw new ResolverError(
-          ono(
-            { status: response.status },
-            `Error requesting ${redirects[0]}. \nToo many redirects: \n  ${redirects.join(" \n  ")}`,
-          ),
-        );
-      }
-      
-      if (!("location" in response.headers) || !response.headers.location) {
-        throw ono({ status: response.status }, `HTTP ${response.status} redirect with no location header`);
-      }
-      
-      return sendRequest({
-        init,
-        redirects,
-        timeout,
-        url: resolve(url.href, response.headers.location as string),
-      });
+
+    if (!("location" in response.headers) || !response.headers.location) {
+      throw ono({ status: response.status }, `HTTP ${response.status} redirect with no location header`);
     }
 
-    return { response };
-  } catch (error: any) {
-    throw new ResolverError(ono(error, `Error requesting ${url.href}`), url.href);
+    return sendRequest({
+      init,
+      redirects,
+      timeout,
+      url: resolve(url.href, response.headers.location as string),
+    });
   }
+
+  return { init, response };
 }
 
 export const urlResolver = {
   handler: async (file: FileInfo, arrayBuffer?: ArrayBuffer): Promise<void> => {
     let data = arrayBuffer;
 
     if (!data) {
-      const { response } = await sendRequest({
-        init: {
-          method: 'GET',
-        },
-        url: file.url,
-      });
-      data = response.body ? await response.arrayBuffer() : new ArrayBuffer(0)
+      try {
+        const { init, response } = await sendRequest({
+          init: {
+            method: 'GET',
+          },
+          url: file.url,
+        });
+
+        if (response.status >= 400) {
+          // gracefully handle HEAD method not allowed
+          if (response.status !== 405 || init?.method !== 'HEAD') {
+            throw ono({ status: response.status }, `HTTP ERROR ${response.status}`);
+          }
+
+          data = response.body ? await response.arrayBuffer() : new ArrayBuffer(0)
+        }
+      } catch (error: any) {
+        throw new ResolverError(ono(error, `Error requesting ${file.url}`), file.url);
+      }
     }
 
-    file.data = Buffer.from(data);
+    file.data = Buffer.from(data!);
   },
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hey-api/json-schema-ref-parser",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Parse, Resolve, and Dereference JSON Schema $ref pointers",
   "homepage": "https://heyapi.dev/",
   "repository": {
@@ -48,8 +48,8 @@
     "test:browser": "cross-env BROWSER=\"true\" yarn test",
     "test:node": "yarn test",
     "test:update": "vitest -u",
-    "test:watch": "vitest -w",
-    "test": "vitest --coverage",
+    "test:watch": "vitest watch --config vitest.config.unit.ts",
+    "test": "vitest run --config vitest.config.unit.ts",
     "typecheck": "tsc --noEmit"
   },
   "devDependencies": {