refactor(fetch): readmeAPIFetch, consolidate base URL (#742)

* refactor: rename fetch to `readmeAPIFetch` * refactor: move API base URL into fetch function itself
readmeio · Feb 1, 2023 · 452be3a · 452be3a
1 parent 7574752
commit 452be3a
Show file tree

Hide file tree

Showing 18 changed files with 64 additions and 76 deletions.
diff --git a/__tests__/helpers/get-api-mock.ts b/__tests__/helpers/get-api-mock.ts
@@ -1,7 +1,7 @@
 import config from 'config';
 import nock from 'nock';
 
-import { getUserAgent } from '../../src/lib/fetch';
+import { getUserAgent } from '../../src/lib/readmeAPIFetch';
 
 /**
  * Nock wrapper that adds required `user-agent` request header

diff --git a/__tests__/lib/fetch.test.ts b/__tests__/lib/fetch.test.ts
@@ -1,9 +1,8 @@
 /* eslint-disable @typescript-eslint/ban-ts-comment, no-console */
-import config from 'config';
 import { Headers } from 'node-fetch';
 
 import pkg from '../../package.json';
-import fetch, { cleanHeaders, handleRes } from '../../src/lib/fetch';
+import readmeAPIFetch, { cleanHeaders, handleRes } from '../../src/lib/readmeAPIFetch';
 import getAPIMock from '../helpers/get-api-mock';
 import { after, before } from '../helpers/setup-gha-env';
 
@@ -23,7 +22,7 @@ describe('#fetch()', () => {
           return this.req.headers;
         });
 
-      const headers = await fetch(`${config.get('host')}/api/v1`, {
+      const headers = await readmeAPIFetch('/api/v1', {
         method: 'get',
         headers: cleanHeaders(key),
       }).then(handleRes);
@@ -50,8 +49,8 @@ describe('#fetch()', () => {
             return this.req.headers;
           });
 
-        const headers = await fetch(
-          `${config.get('host')}/api/v1`,
+        const headers = await readmeAPIFetch(
+          '/api/v1',
           {
             method: 'get',
             headers: cleanHeaders(key),
@@ -75,8 +74,8 @@ describe('#fetch()', () => {
             return this.req.headers;
           });
 
-        const headers = await fetch(
-          `${config.get('host')}/api/v1`,
+        const headers = await readmeAPIFetch(
+          '/api/v1',
           {
             method: 'get',
             headers: cleanHeaders(key),
@@ -101,8 +100,8 @@ describe('#fetch()', () => {
             return this.req.headers;
           });
 
-        const headers = await fetch(
-          `${config.get('host')}/api/v1`,
+        const headers = await readmeAPIFetch(
+          '/api/v1',
           {
             method: 'get',
             headers: cleanHeaders(key),
@@ -126,7 +125,7 @@ describe('#fetch()', () => {
         return this.req.headers;
       });
 
-    const headers = await fetch(`${config.get('host')}/api/v1`, {
+    const headers = await readmeAPIFetch('/api/v1', {
       method: 'get',
       headers: cleanHeaders(key),
     }).then(handleRes);
@@ -148,7 +147,7 @@ describe('#fetch()', () => {
         return this.req.headers;
       });
 
-    const headers = await fetch(`${config.get('host')}/api/v1/doesnt-need-auth`).then(handleRes);
+    const headers = await readmeAPIFetch('/api/v1/doesnt-need-auth').then(handleRes);
 
     expect(headers['user-agent'].shift()).toBe(`rdme/${pkg.version}`);
     expect(headers['x-readme-source'].shift()).toBe('cli');
@@ -180,7 +179,7 @@ describe('#fetch()', () => {
         Warning: '',
       });
 
-      await fetch(`${config.get('host')}/api/v1/some-warning`);
+      await readmeAPIFetch('/api/v1/some-warning');
 
       expect(console.warn).toHaveBeenCalledTimes(0);
       expect(getWarningCommandOutput()).toBe('');
@@ -193,7 +192,7 @@ describe('#fetch()', () => {
         Warning: '199 - "some error"',
       });
 
-      await fetch(`${config.get('host')}/api/v1/some-warning`);
+      await readmeAPIFetch('/api/v1/some-warning');
 
       expect(console.warn).toHaveBeenCalledTimes(1);
       expect(getWarningCommandOutput()).toBe('⚠️  ReadMe API Warning: some error');
@@ -206,7 +205,7 @@ describe('#fetch()', () => {
         Warning: '199 - "some error" 199 - "another error"',
       });
 
-      await fetch(`${config.get('host')}/api/v1/some-warning`);
+      await readmeAPIFetch('/api/v1/some-warning');
 
       expect(console.warn).toHaveBeenCalledTimes(2);
       expect(getWarningCommandOutput()).toBe(
@@ -221,7 +220,7 @@ describe('#fetch()', () => {
         Warning: 'some garbage error',
       });
 
-      await fetch(`${config.get('host')}/api/v1/some-warning`);
+      await readmeAPIFetch('/api/v1/some-warning');
 
       expect(console.warn).toHaveBeenCalledTimes(1);
       expect(getWarningCommandOutput()).toBe('⚠️  ReadMe API Warning: some garbage error');
@@ -243,7 +242,7 @@ describe('#fetch()', () => {
 
       const mock = getAPIMock({}, `${proxy}/`).get('/api/v1/proxy').reply(200);
 
-      await fetch(`${config.get('host')}/api/v1/proxy`);
+      await readmeAPIFetch('/api/v1/proxy');
 
       expect(mock.isDone()).toBe(true);
     });
@@ -255,7 +254,7 @@ describe('#fetch()', () => {
 
       const mock = getAPIMock({}, `${proxy}/`).get('/api/v1/proxy').reply(200);
 
-      await fetch(`${config.get('host')}/api/v1/proxy`);
+      await readmeAPIFetch('/api/v1/proxy');
 
       expect(mock.isDone()).toBe(true);
     });
@@ -267,7 +266,7 @@ describe('#fetch()', () => {
 
       const mock = getAPIMock({}, proxy).get('/api/v1/proxy').reply(200);
 
-      await fetch(`${config.get('host')}/api/v1/proxy`);
+      await readmeAPIFetch('/api/v1/proxy');
 
       expect(mock.isDone()).toBe(true);
     });

diff --git a/src/cmds/categories/create.ts b/src/cmds/categories/create.ts
@@ -5,8 +5,8 @@ import config from 'config';
 import { Headers } from 'node-fetch';
 
 import Command, { CommandCategories } from '../../lib/baseCommand';
-import fetch, { cleanHeaders, handleRes } from '../../lib/fetch';
 import getCategories from '../../lib/getCategories';
+import readmeAPIFetch, { cleanHeaders, handleRes } from '../../lib/readmeAPIFetch';
 import { getProjectVersion } from '../../lib/versionSelect';
 
 interface Category {
@@ -88,7 +88,7 @@ export default class CategoriesCreateCommand extends Command {
           );
         }
       }
-      return fetch(`${config.get('host')}/api/v1/categories`, {
+      return readmeAPIFetch('/api/v1/categories', {
         method: 'post',
         headers: cleanHeaders(
           key,

diff --git a/src/cmds/docs/edit.ts b/src/cmds/docs/edit.ts
@@ -11,7 +11,7 @@ import editor from 'editor';
 import APIError from '../../lib/apiError';
 import Command, { CommandCategories } from '../../lib/baseCommand';
 import isHidden from '../../lib/decorators/isHidden';
-import fetch, { cleanHeaders, handleRes } from '../../lib/fetch';
+import readmeAPIFetch, { cleanHeaders, handleRes } from '../../lib/readmeAPIFetch';
 import { getProjectVersion } from '../../lib/versionSelect';
 
 const writeFile = promisify(fs.writeFile);
@@ -61,7 +61,7 @@ export default class DocsEditCommand extends Command {
 
     const filename = `${slug}.md`;
 
-    const existingDoc = await fetch(`${config.get('host')}/api/v1/docs/${slug}`, {
+    const existingDoc = await readmeAPIFetch(`/api/v1/docs/${slug}`, {
       method: 'get',
       headers: cleanHeaders(
         key,
@@ -84,7 +84,7 @@ export default class DocsEditCommand extends Command {
 
         Command.debug(`read edited contents of ${filename}, sending to ReadMe`);
 
-        return fetch(`${config.get('host')}/api/v1/docs/${slug}`, {
+        return readmeAPIFetch(`/api/v1/docs/${slug}`, {
           method: 'put',
           headers: cleanHeaders(
             key,

diff --git a/src/cmds/openapi/index.ts b/src/cmds/openapi/index.ts
@@ -2,18 +2,17 @@ import type { CommandOptions } from '../../lib/baseCommand';
 import type { RequestInit, Response } from 'node-fetch';
 
 import chalk from 'chalk';
-import config from 'config';
 import { Headers } from 'node-fetch';
 import ora from 'ora';
 import parse from 'parse-link-header';
 
 import Command, { CommandCategories } from '../../lib/baseCommand';
 import createGHA from '../../lib/createGHA';
-import fetch, { cleanHeaders, handleRes } from '../../lib/fetch';
 import { oraOptions } from '../../lib/logger';
 import prepareOas from '../../lib/prepareOas';
 import * as promptHandler from '../../lib/prompts';
 import promptTerminal from '../../lib/promptWrapper';
+import readmeAPIFetch, { cleanHeaders, handleRes } from '../../lib/readmeAPIFetch';
 import streamSpecToRegistry from '../../lib/streamSpecToRegistry';
 import { getProjectVersion } from '../../lib/versionSelect';
 
@@ -237,7 +236,7 @@ export default class OpenAPICommand extends Command {
 
       options.method = 'post';
       spinner.start('Creating your API docs in ReadMe...');
-      return fetch(`${config.get('host')}/api/v1/api-specification`, options, {
+      return readmeAPIFetch('/api/v1/api-specification', options, {
         filePath: specPath,
         fileType: specFileType,
       }).then(res => {
@@ -258,7 +257,7 @@ export default class OpenAPICommand extends Command {
       isUpdate = true;
       options.method = 'put';
       spinner.start('Updating your API docs in ReadMe...');
-      return fetch(`${config.get('host')}/api/v1/api-specification/${specId}`, options, {
+      return readmeAPIFetch(`/api/v1/api-specification/${specId}`, options, {
         filePath: specPath,
         fileType: specFileType,
       }).then(res => {
@@ -280,7 +279,7 @@ export default class OpenAPICommand extends Command {
       */
 
     function getSpecs(url: string) {
-      return fetch(`${config.get('host')}${url}`, {
+      return readmeAPIFetch(url, {
         method: 'get',
         headers: cleanHeaders(
           key,

diff --git a/src/cmds/versions/create.ts b/src/cmds/versions/create.ts
@@ -6,9 +6,9 @@ import { Headers } from 'node-fetch';
 import semver from 'semver';
 
 import Command, { CommandCategories } from '../../lib/baseCommand';
-import fetch, { cleanHeaders, handleRes } from '../../lib/fetch';
 import * as promptHandler from '../../lib/prompts';
 import promptTerminal from '../../lib/promptWrapper';
+import readmeAPIFetch, { cleanHeaders, handleRes } from '../../lib/readmeAPIFetch';
 
 export interface Options extends CommonOptions {
   fork?: string;
@@ -60,7 +60,7 @@ export default class CreateVersionCommand extends Command {
     }
 
     if (!fork) {
-      versionList = await fetch(`${config.get('host')}/api/v1/version`, {
+      versionList = await readmeAPIFetch('/api/v1/version', {
         method: 'get',
         headers: cleanHeaders(key),
       }).then(handleRes);
@@ -82,7 +82,7 @@ export default class CreateVersionCommand extends Command {
       is_hidden: promptResponse.is_stable ? false : !(isPublic === 'true' || promptResponse.is_hidden),
     };
 
-    return fetch(`${config.get('host')}/api/v1/version`, {
+    return readmeAPIFetch('/api/v1/version', {
       method: 'post',
       headers: cleanHeaders(
         key,

diff --git a/src/cmds/versions/delete.ts b/src/cmds/versions/delete.ts
@@ -1,9 +1,7 @@
 import type { CommandOptions } from '../../lib/baseCommand';
 
-import config from 'config';
-
 import Command, { CommandCategories } from '../../lib/baseCommand';
-import fetch, { cleanHeaders, handleRes } from '../../lib/fetch';
+import readmeAPIFetch, { cleanHeaders, handleRes } from '../../lib/readmeAPIFetch';
 import { getProjectVersion } from '../../lib/versionSelect';
 
 export default class DeleteVersionCommand extends Command {
@@ -35,7 +33,7 @@ export default class DeleteVersionCommand extends Command {
 
     Command.debug(`selectedVersion: ${selectedVersion}`);
 
-    return fetch(`${config.get('host')}/api/v1/version/${selectedVersion}`, {
+    return readmeAPIFetch(`/api/v1/version/${selectedVersion}`, {
       method: 'delete',
       headers: cleanHeaders(key),
     })

diff --git a/src/cmds/versions/index.ts b/src/cmds/versions/index.ts
@@ -1,9 +1,7 @@
 import type { CommandOptions } from '../../lib/baseCommand';
 
-import config from 'config';
-
 import Command, { CommandCategories } from '../../lib/baseCommand';
-import fetch, { cleanHeaders, handleRes } from '../../lib/fetch';
+import readmeAPIFetch, { cleanHeaders, handleRes } from '../../lib/readmeAPIFetch';
 
 export interface Version {
   codename?: string;
@@ -40,9 +38,9 @@ export default class VersionsCommand extends Command {
 
     const { key, version } = opts;
 
-    const uri = version ? `${config.get('host')}/api/v1/version/${version}` : `${config.get('host')}/api/v1/version`;
+    const uri = version ? `/api/v1/version/${version}` : '/api/v1/version';
 
-    return fetch(uri, {
+    return readmeAPIFetch(uri, {
       method: 'get',
       headers: cleanHeaders(key),
     })

diff --git a/src/cmds/versions/update.ts b/src/cmds/versions/update.ts
@@ -2,13 +2,12 @@ import type { Version } from '.';
 import type { CommonOptions } from './create';
 import type { CommandOptions } from '../../lib/baseCommand';
 
-import config from 'config';
 import { Headers } from 'node-fetch';
 
 import Command, { CommandCategories } from '../../lib/baseCommand';
-import fetch, { cleanHeaders, handleRes } from '../../lib/fetch';
 import * as promptHandler from '../../lib/prompts';
 import promptTerminal from '../../lib/promptWrapper';
+import readmeAPIFetch, { cleanHeaders, handleRes } from '../../lib/readmeAPIFetch';
 import { getProjectVersion } from '../../lib/versionSelect';
 
 export interface Options extends CommonOptions {
@@ -56,7 +55,7 @@ export default class UpdateVersionCommand extends Command {
 
     Command.debug(`selectedVersion: ${selectedVersion}`);
 
-    const foundVersion = await fetch(`${config.get('host')}/api/v1/version/${selectedVersion}`, {
+    const foundVersion = await readmeAPIFetch(`/api/v1/version/${selectedVersion}`, {
       method: 'get',
       headers: cleanHeaders(key),
     }).then(handleRes);
@@ -72,7 +71,7 @@ export default class UpdateVersionCommand extends Command {
       is_hidden: promptResponse.is_stable ? false : !(isPublic === 'true' || promptResponse.is_hidden),
     };
 
-    return fetch(`${config.get('host')}/api/v1/version/${selectedVersion}`, {
+    return readmeAPIFetch(`/api/v1/version/${selectedVersion}`, {
       method: 'put',
       headers: cleanHeaders(
         key,

diff --git a/src/lib/deleteDoc.ts b/src/lib/deleteDoc.ts
@@ -1,9 +1,8 @@
 import type { CommandCategories } from './baseCommand';
 
-import config from 'config';
 import { Headers } from 'node-fetch';
 
-import fetch, { cleanHeaders, handleRes } from './fetch';
+import readmeAPIFetch, { cleanHeaders, handleRes } from './readmeAPIFetch';
 
 /**
  * Delete a document from ReadMe
@@ -25,7 +24,7 @@ export default async function deleteDoc(
   if (dryRun) {
     return Promise.resolve(`🎭 dry run! This will delete \`${slug}\`.`);
   }
-  return fetch(`${config.get('host')}/api/v1/${type}/${slug}`, {
+  return readmeAPIFetch(`/api/v1/${type}/${slug}`, {
     method: 'delete',
     headers: cleanHeaders(
       key,

diff --git a/src/lib/getCategories.ts b/src/lib/getCategories.ts
@@ -1,7 +1,6 @@
-import config from 'config';
 import { Headers } from 'node-fetch';
 
-import fetch, { cleanHeaders, handleRes } from './fetch';
+import readmeAPIFetch, { cleanHeaders, handleRes } from './readmeAPIFetch';
 
 /**
  * Returns all categories for a given project and version
@@ -13,7 +12,7 @@ import fetch, { cleanHeaders, handleRes } from './fetch';
 export default async function getCategories(key: string, selectedVersion: string) {
   function getNumberOfPages() {
     let totalCount = 0;
-    return fetch(`${config.get('host')}/api/v1/categories?perPage=20&page=1`, {
+    return readmeAPIFetch('/api/v1/categories?perPage=20&page=1', {
       method: 'get',
       headers: cleanHeaders(
         key,
@@ -38,7 +37,7 @@ export default async function getCategories(key: string, selectedVersion: string
     ...(await Promise.all(
       // retrieves all categories beyond first page
       [...new Array(totalCount + 1).keys()].slice(2).map(async page => {
-        return fetch(`${config.get('host')}/api/v1/categories?perPage=20&page=${page}`, {
+        return readmeAPIFetch(`/api/v1/categories?perPage=20&page=${page}`, {
           method: 'get',
           headers: cleanHeaders(
             key,