Better options

datocms · Oct 22, 2021 · 7c179b2 · 7c179b2
1 parent b1d55fe
commit 7c179b2
Show file tree

Hide file tree

Showing 16 changed files with 118 additions and 75 deletions.
diff --git a/src/Client.js b/src/Client.js
@@ -89,6 +89,23 @@ export default class Client {
   }
 
   request(fetchRequest, preCallStack = new Error().stack, retryCount = 1) {
+    if (fetchRequest.options.logApiCalls) {
+      console.log('>>>>>>>>>>>>');
+      console.log(`${fetchRequest.options.method} ${fetchRequest.url}`);
+      if (fetchRequest.options.logApiCalls >= 2) {
+        for (const [key, value] of Object.entries(
+          fetchRequest.options.headers || {},
+        )) {
+          console.log(`${key}: ${value}`);
+        }
+      }
+      if (fetchRequest.options.logApiCalls >= 3 && fetchRequest.options.body) {
+        console.log();
+        console.log(fetchRequest.options.body);
+      }
+      console.log('>>>>>>>>>>>>');
+    }
+
     return fetch(fetchRequest.url, fetchRequest.options)
       .then(res => {
         if (res.status === 429) {
@@ -104,8 +121,35 @@ export default class Client {
           });
         }
 
+        if (fetchRequest.options.logApiCalls) {
+          console.log('<<<<<<<<<<<<');
+          console.log(`Status: ${res.status}`);
+          if (fetchRequest.options.logApiCalls >= 2) {
+            [
+              'content-type',
+              'x-api-version',
+              'x-environment',
+              'x-queue-time',
+              'x-ratelimit-remaining',
+            ].forEach(key => {
+              const value = res.headers.get(key);
+              if (value) {
+                console.log(`${key}: ${value}`);
+              }
+            });
+          }
+        }
+
         return (res.status !== 204 ? res.json() : Promise.resolve(null))
           .then(body => {
+            if (fetchRequest.options.logApiCalls >= 3 && body) {
+              console.log();
+              console.log(JSON.stringify(body));
+            }
+            if (fetchRequest.options.logApiCalls) {
+              console.log('<<<<<<<<<<<<');
+              console.log();
+            }
             if (res.status >= 200 && res.status < 300) {
               return Promise.resolve(body);
             }

diff --git a/src/contentfulImport/appClient.js b/src/contentfulImport/appClient.js
@@ -14,11 +14,10 @@ export default async (
   try {
     const contentfulClient = createClient({ accessToken: contentfulToken });
 
-    const dato = new SiteClient(
-      datoCmsToken,
-      { environment: datoCmsEnvironment },
-      datoCmsCmaBaseUrl,
-    );
+    const dato = new SiteClient(datoCmsToken, {
+      environment: datoCmsEnvironment,
+      baseUrl: datoCmsCmaBaseUrl,
+    });
 
     const contentful = await contentfulClient.getSpace(contentfulSpaceId);
     spinner.succeed();

diff --git a/src/dump/command.js b/src/dump/command.js
@@ -34,11 +34,11 @@ export default async function(options) {
     'X-SSG': detectSsg(process.cwd()),
   };
 
-  if (environment) {
-    headers['X-Environment'] = environment;
-  }
-
-  const client = new SiteClient(token, headers, cmaBaseUrl);
+  const client = new SiteClient(token, {
+    environment,
+    headers,
+    baseUrl: cmaBaseUrl,
+  });
 
   const loader = new Loader(client, previewMode, environment, { pageSize });
 

diff --git a/src/environment/destroy/command.js b/src/environment/destroy/command.js
@@ -10,7 +10,7 @@ export default async function command({
     `Destroying environment \`${environmentId}\`...\n`,
   ).start();
   const token = tokenByArg || process.env.DATO_MANAGEMENT_API_TOKEN;
-  const client = new SiteClient(token, {}, cmaBaseUrl);
+  const client = new SiteClient(token, { baseUrl: cmaBaseUrl });
 
   try {
     await client.environments.destroy(environmentId);

diff --git a/src/environment/getPrimary/command.js b/src/environment/getPrimary/command.js
@@ -2,7 +2,7 @@ import SiteClient from '../../site/SiteClient';
 
 export default async function command({ token: tokenByArg, cmaBaseUrl }) {
   const token = tokenByArg || process.env.DATO_MANAGEMENT_API_TOKEN;
-  const client = new SiteClient(token, {}, cmaBaseUrl);
+  const client = new SiteClient(token, { baseUrl: cmaBaseUrl });
 
   const allEnvs = await client.environments.all();
   const primaryEnv = allEnvs.find(({ meta: { primary } }) => primary);

diff --git a/src/environment/promote/command.js b/src/environment/promote/command.js
@@ -11,7 +11,7 @@ export default async function command({
   ).start();
 
   const token = tokenByArg || process.env.DATO_MANAGEMENT_API_TOKEN;
-  const client = new SiteClient(token, {}, cmaBaseUrl);
+  const client = new SiteClient(token, { baseUrl: cmaBaseUrl });
 
   try {
     await client.environments.promote(environmentId);

diff --git a/src/forkEnvironment/command.js b/src/forkEnvironment/command.js
@@ -9,7 +9,7 @@ export default async function runPendingMigrations({
 }) {
   const token = tokenByArg || process.env.DATO_MANAGEMENT_API_TOKEN;
 
-  const client = new SiteClient(token, {}, cmaBaseUrl);
+  const client = new SiteClient(token, { baseUrl: cmaBaseUrl });
   const allEnvironments = await client.environments.all();
   const sourceEnv = await client.environments.find(sourceEnvId);
 

diff --git a/src/runPendingMigrations/command.js b/src/runPendingMigrations/command.js
@@ -28,7 +28,7 @@ export default async function runPendingMigrations({
 
   const token = tokenByArg || process.env.DATO_MANAGEMENT_API_TOKEN;
 
-  const globalClient = new SiteClient(token, {}, cmaBaseUrl);
+  const globalClient = new SiteClient(token, { baseUrl: cmaBaseUrl });
 
   const allEnvironments = await globalClient.environments.all();
 
@@ -83,11 +83,10 @@ export default async function runPendingMigrations({
     forkSpinner.succeed();
   }
 
-  const client = new SiteClient(
-    token,
-    { environment: destinationEnvId },
-    cmaBaseUrl,
-  );
+  const client = new SiteClient(token, {
+    environment: destinationEnvId,
+    baseUrl: cmaBaseUrl,
+  });
 
   const migrationModel = await upsertMigrationModel(
     client,

diff --git a/src/toggleMaintenanceMode/command.js b/src/toggleMaintenanceMode/command.js
@@ -8,7 +8,7 @@ export default async function toggleMaintenanceMode({
   cmaBaseUrl,
 }) {
   const token = tokenByArg || process.env.DATO_MANAGEMENT_API_TOKEN;
-  const client = new SiteClient(token, {}, cmaBaseUrl);
+  const client = new SiteClient(token, { baseUrl: cmaBaseUrl });
 
   const { active } = await client.maintenanceMode.find();
 

diff --git a/src/utils/generateClient.js b/src/utils/generateClient.js
@@ -1,6 +1,7 @@
 import jsonref from 'json-schema-ref-parser';
 import { singular } from 'pluralize';
 import { decamelize, camelize } from 'humps';
+import omit from 'object.omit';
 import fetch from './fetch';
 import deserializeJsonApi from './deserializeJsonApi';
 import serializeJsonApi from './serializeJsonApi';
@@ -47,21 +48,34 @@ const findLinkFor = (schema, namespace, apiCall) => {
 };
 
 export default function generateClient(subdomain, cache, extraMethods = {}) {
-  return function Client(token, extraHeaders = {}, baseUrl) {
+  return function Client(
+    token,
+    rawLegacyHeadersArgOrOptions,
+    legacyBaseUrlArg,
+  ) {
     let schemaPromise;
 
-    const headers = { ...extraHeaders };
+    const legacyHeadersArgOrOptions = rawLegacyHeadersArgOrOptions || {};
 
-    if (extraHeaders && extraHeaders.environment) {
-      headers['X-Environment'] = extraHeaders.environment;
-      delete headers.environment;
+    const validOptions = ['environment', 'baseUrl', 'headers', 'logApiCalls'];
+
+    const headers = {
+      ...omit(legacyHeadersArgOrOptions, validOptions),
+      ...(legacyHeadersArgOrOptions.headers || {}),
+    };
+
+    if (legacyHeadersArgOrOptions.environment) {
+      headers['x-environment'] = legacyHeadersArgOrOptions.environment;
     }
 
-    const rawClient = new RawClient(
-      token,
-      headers,
-      baseUrl || `https://${subdomain}.datocms.com`,
-    );
+    const globalOptions = legacyHeadersArgOrOptions;
+
+    const baseUrl =
+      legacyBaseUrlArg ||
+      legacyHeadersArgOrOptions.baseUrl ||
+      `https://${subdomain}.datocms.com`;
+
+    const rawClient = new RawClient(token, headers, baseUrl);
 
     const extraProps = getProps(extraMethods);
     const rawClientProps = getProps(rawClient);
@@ -129,7 +143,7 @@ export default function generateClient(subdomain, cache, extraMethods = {}) {
                 }
 
                 const queryString = args.shift() || {};
-                const options = args.shift() || {};
+                const options = { ...globalOptions, ...(args.shift() || {}) };
 
                 const deserializeResponse = Object.prototype.hasOwnProperty.call(
                   options,
@@ -225,6 +239,7 @@ export default function generateClient(subdomain, cache, extraMethods = {}) {
                     url,
                     body,
                     queryString,
+                    options,
                   );
 
                   return rawClient
@@ -236,6 +251,7 @@ export default function generateClient(subdomain, cache, extraMethods = {}) {
                     url,
                     body,
                     queryString,
+                    options,
                   );
 
                   return rawClient
@@ -246,6 +262,7 @@ export default function generateClient(subdomain, cache, extraMethods = {}) {
                   const fetchRequest = rawClient.buildDeleteRequest(
                     url,
                     queryString,
+                    options,
                   );
 
                   return rawClient
@@ -274,6 +291,7 @@ export default function generateClient(subdomain, cache, extraMethods = {}) {
                 const fetchRequest = rawClient.buildGetRequest(
                   url,
                   queryString,
+                  options,
                 );
 
                 return rawClient

diff --git a/src/wpImport/command.js b/src/wpImport/command.js
@@ -21,7 +21,7 @@ export default async function command(
   cmaBaseUrl,
   wpApiEndpointUrl,
 ) {
-  const dato = new SiteClient(token, { environment }, cmaBaseUrl);
+  const dato = new SiteClient(token, { environment, baseUrl: cmaBaseUrl });
 
   let wp;
 

diff --git a/test/src/SiteClientPro_test.js b/test/src/SiteClientPro_test.js
@@ -30,11 +30,9 @@ const shouldRunTest = () => {
       const accountClient = await generateNewAccountClient();
       site = await accountClient.sites.create({ name: 'Blog' });
 
-      client = new SiteClient(
-        site.readwriteToken,
-        null,
-        process.env.SITE_API_BASE_URL,
-      );
+      client = new SiteClient(site.readwriteToken, {
+        baseUrl: process.env.SITE_API_BASE_URL,
+      });
     }),
   );
 

diff --git a/test/src/SiteClient_test.js b/test/src/SiteClient_test.js
@@ -16,11 +16,9 @@ describe('Site API', () => {
       const accountClient = await generateNewAccountClient();
       site = await accountClient.sites.create({ name: 'Blog' });
 
-      client = new SiteClient(
-        site.readwriteToken,
-        null,
-        process.env.SITE_API_BASE_URL,
-      );
+      client = new SiteClient(site.readwriteToken, {
+        baseUrl: process.env.SITE_API_BASE_URL,
+      });
     }),
   );
 

diff --git a/test/src/cli_test.js b/test/src/cli_test.js
@@ -89,13 +89,10 @@ describe('CLI tool', () => {
           `migrate --destination=foobar --token=${site.readwriteToken} --cmaBaseUrl=${process.env.SITE_API_BASE_URL}`,
         );
 
-        const client = new SiteClient(
-          site.readwriteToken,
-          {
-            environment: 'foobar',
-          },
-          process.env.SITE_API_BASE_URL,
-        );
+        const client = new SiteClient(site.readwriteToken, {
+          environment: 'foobar',
+          baseUrl: process.env.SITE_API_BASE_URL,
+        });
 
         const model = await client.itemTypes.find('article');
         expect(model.apiKey).to.eq('article');
@@ -118,11 +115,9 @@ describe('CLI tool', () => {
             `maintenance on --token=${site.readwriteToken} --cmaBaseUrl=${process.env.SITE_API_BASE_URL}`,
           );
 
-          const client = new SiteClient(
-            site.readwriteToken,
-            {},
-            process.env.SITE_API_BASE_URL,
-          );
+          const client = new SiteClient(site.readwriteToken, {
+            baseUrl: process.env.SITE_API_BASE_URL,
+          });
 
           const { active } = await client.maintenanceMode.find();
           expect(active).to.eq(true);
@@ -149,11 +144,9 @@ describe('CLI tool', () => {
             name: 'Integration new test site',
           });
 
-          const client = new SiteClient(
-            site.readwriteToken,
-            {},
-            process.env.SITE_API_BASE_URL,
-          );
+          const client = new SiteClient(site.readwriteToken, {
+            baseUrl: process.env.SITE_API_BASE_URL,
+          });
 
           await client.environments.fork('main', {
             id: 'my-sandbox-env',
@@ -184,11 +177,9 @@ describe('CLI tool', () => {
             name: 'Integration new test site',
           });
 
-          const client = new SiteClient(
-            site.readwriteToken,
-            {},
-            process.env.SITE_API_BASE_URL,
-          );
+          const client = new SiteClient(site.readwriteToken, {
+            baseUrl: process.env.SITE_API_BASE_URL,
+          });
 
           const newSandboxName = 'my-sandbox-env';
 

diff --git a/test/src/dump_test.js b/test/src/dump_test.js
@@ -61,11 +61,9 @@ describe('dump', () => {
         name: 'Integration new test site',
       });
 
-      const client = new SiteClient(
-        site.readwriteToken,
-        {},
-        process.env.SITE_API_BASE_URL,
-      );
+      const client = new SiteClient(site.readwriteToken, {
+        baseUrl: process.env.SITE_API_BASE_URL,
+      });
 
       const newSite = await client.site.find();
       const faviconFilePath = path.resolve('test/fixtures/favicon.ico');

diff --git a/test/src/uploadFile_test.js b/test/src/uploadFile_test.js
@@ -11,11 +11,9 @@ describe('Upload file from', async () => {
     vcr('before', async () => {
       const accountClient = await generateNewAccountClient();
       site = await accountClient.sites.create({ name: 'Blog' });
-      client = new SiteClient(
-        site.readwriteToken,
-        null,
-        process.env.SITE_API_BASE_URL,
-      );
+      client = new SiteClient(site.readwriteToken, {
+        baseUrl: process.env.SITE_API_BASE_URL,
+      });
     }),
   );