fix: Fixes missing API Key and Secret failing Fetch builds (#81)

# Description

<!-- Include a summary of the change made and also list the dependencies
that are required if any -->

## Issue Ticket Number

<!-- Specifiy which issue this fixes by referencing the issue number
(`#11`) or issue URL. -->
<!-- Example: Fixes
#1 -->

Fixes #80 

## Type of change

<!-- Please select all options that are applicable. -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] This change requires a documentation update


# Checklist

<!-- These must all be followed and checked. -->

- [ ] I have followed the contributing guidelines of this project as
mentioned in [CONTRIBUTING.md](/CONTRIBUTING.md)
- [ ] I have created an
[issue](https://github.com/colbyfayock/netlify-plugin-cloudinary/issues)
ticket for this PR
- [ ] I have checked to ensure there aren't other open [Pull
Requests](https://github.com/colbyfayock/netlify-plugin-cloudinary/pulls)
for the same update/change?
- [ ] I have performed a self-review of my own code
- [ ] I have run tests locally to ensure they all pass
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes needed to the documentation

Author: colbyfayock

demo/tsconfig.json

@@ -1,6 +1,10 @@
 {
   "compilerOptions": {
-    "lib": ["dom", "dom.iterable", "esnext"],
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
     "allowJs": true,
     "skipLibCheck": true,
     "strict": false,
@@ -17,7 +21,8 @@
         "name": "next"
       }
     ],
-    "strictNullChecks": true
+    "strictNullChecks": true,
+    "forceConsistentCasingInFileNames": true
   },
   "include": [
     "next-env.d.ts",
@@ -26,5 +31,7 @@
     "**/*.tsx",
     "**/*.json"
   ],
-  "exclude": ["node_modules"]
+  "exclude": [
+    "node_modules"
+  ]
 }

netlify-plugin-cloudinary/src/data/errors.ts

@@ -1,8 +1,10 @@
+export const ERROR_API_CREDENTIALS_REQUIRED =
+    'Both your Cloudinary API Key and API Secret are required when using a Delivery Type of Upload. Please confirm the environment variables CLOUDINARY_API_KEY and CLOUDINARY_API_SECRET are configured.';
 export const ERROR_CLOUD_NAME_REQUIRED =
-    'A Cloudinary Cloud Name is required. Please set cloudName input or use the environment variable CLOUDINARY_CLOUD_NAME'
-export const ERROR_INVALID_IMAGES_PATH = 'Invalid asset path. Please make sure your imagesPath is defined.'
+    'A Cloudinary Cloud Name is required. Please set cloudName input or use the environment variable CLOUDINARY_CLOUD_NAME';
+export const ERROR_INVALID_IMAGES_PATH = 'Invalid asset path. Please make sure your imagesPath is defined.';
 export const ERROR_NETLIFY_HOST_CLI_SUPPORT =
-    'Note: The Netlify CLI does not currently support the ability to determine the host locally, try deploying on Netlify.'
+    'Note: The Netlify CLI does not currently support the ability to determine the host locally, try deploying on Netlify.';
 export const ERROR_NETLIFY_HOST_UNKNOWN =
-    'Cannot determine Netlify host, can not proceed with plugin.'
-export const ERROR_SITE_NAME_REQUIRED =  'Cannot determine the site name, can not proceed with plugin'
+    'Cannot determine Netlify host, can not proceed with plugin.';
+export const ERROR_SITE_NAME_REQUIRED =  'Cannot determine the site name, can not proceed with plugin';

netlify-plugin-cloudinary/src/index.ts

@@ -12,6 +12,7 @@ import { findAssetsByPath } from './lib/util';
 
 import { PUBLIC_ASSET_PATH } from './data/cloudinary';
 import {
+  ERROR_API_CREDENTIALS_REQUIRED,
   ERROR_CLOUD_NAME_REQUIRED,
   ERROR_INVALID_IMAGES_PATH,
   ERROR_NETLIFY_HOST_CLI_SUPPORT,
@@ -160,11 +161,18 @@ export async function onBuild({
   const apiKey = process.env.CLOUDINARY_API_KEY;
   const apiSecret = process.env.CLOUDINARY_API_SECRET;
 
-  if (!cloudName || !apiKey || !apiSecret) {
+  if (!cloudName) {
+    console.error(`[Cloudinary] ${ERROR_CLOUD_NAME_REQUIRED}`);
     utils.build.failBuild(ERROR_CLOUD_NAME_REQUIRED);
     return;
   }
 
+  if (deliveryType === 'upload' && (!apiKey || !apiSecret)) {
+    console.error(`[Cloudinary] ${ERROR_API_CREDENTIALS_REQUIRED}`);
+    utils.build.failBuild(ERROR_API_CREDENTIALS_REQUIRED);
+    return;
+  }
+
   configureCloudinary({
     // Base credentials
     cloudName,
@@ -176,19 +184,17 @@ export async function onBuild({
     privateCdn,
   });
 
-  
-
   // Look for any available images in the provided imagesPath to collect
   // asset details and to grab a Cloudinary URL to use later
 
-  if ( typeof imagesPath === 'undefined' ) {
+  if (typeof imagesPath === 'undefined') {
     throw new Error(ERROR_INVALID_IMAGES_PATH);
   }
 
   const imagesFiles = findAssetsByPath({
     baseDir: PUBLISH_DIR,
-    path: imagesPath
-  })
+    path: imagesPath,
+  });
 
   if (imagesFiles.length === 0) {
     console.warn(`[Cloudinary] No image files found in ${imagesPath}`);
@@ -260,9 +266,10 @@ export async function onBuild({
 
           // Unsure how to type the above so that Inputs['privateCdn'] doesnt mess up types here
 
-          if ( !Array.isArray(mediaPaths) && typeof mediaPaths !== 'string' ) return;
+          if (!Array.isArray(mediaPaths) && typeof mediaPaths !== 'string')
+            return;
 
-          if ( !Array.isArray(mediaPaths) ) {
+          if (!Array.isArray(mediaPaths)) {
             mediaPaths = [mediaPaths];
           }
 
@@ -290,7 +297,7 @@ export async function onBuild({
               status: 302,
               force: true,
             });
-          })
+          });
         },
       ),
     );
@@ -334,11 +341,18 @@ export async function onPostBuild({
   const apiKey = process.env.CLOUDINARY_API_KEY;
   const apiSecret = process.env.CLOUDINARY_API_SECRET;
 
-  if (!cloudName || !apiKey || !apiSecret) {
+  if (!cloudName) {
+    console.error(`[Cloudinary] ${ERROR_CLOUD_NAME_REQUIRED}`);
     utils.build.failBuild(ERROR_CLOUD_NAME_REQUIRED);
     return;
   }
 
+  if (deliveryType === 'upload' && (!apiKey || !apiSecret)) {
+    console.error(`[Cloudinary] ${ERROR_API_CREDENTIALS_REQUIRED}`);
+    utils.build.failBuild(ERROR_API_CREDENTIALS_REQUIRED);
+    return;
+  }
+
   configureCloudinary({
     // Base credentials
     cloudName,

netlify-plugin-cloudinary/tests/on-build.test.js

@@ -1,16 +1,64 @@
 const fs = require('fs').promises;
 const { onBuild } = require('../src/');
+const { ERROR_API_CREDENTIALS_REQUIRED } = require('../src/data/errors');
 
 describe('onBuild', () => {
+  const ENV_ORIGINAL = process.env;
   const readdir = fs.readdir;
 
   beforeEach(() => {
     fs.readdir = jest.fn();
+    jest.resetModules();
+
+    process.env = { ...ENV_ORIGINAL };
+
+    process.env.SITE_NAME = 'cool-site';
+    process.env.CLOUDINARY_CLOUD_NAME = 'testcloud';
+    process.env.CLOUDINARY_API_KEY = '123456789012345';
+    process.env.CLOUDINARY_API_SECRET = 'abcd1234';
   });
 
   afterEach(() => {
     fs.readdir = readdir;
-  })
+    process.env = ENV_ORIGINAL;
+  });
+
+  describe('Config', () => {
+
+    test('should error when using delivery type of upload without API Key and Secret', async () => {
+      // Test that verifies that delivery of type of fetch works without API Key and Secret can be found
+      // below under test: should create redirects with defaut fetch-based configuration in production context
+      // We don't need a "special" test for this as it's default functionality that should work with
+      // any valid test, so we can isntead ensure the keys don't exist and delete them
+
+      jest.spyOn(global.console, 'error').mockImplementation();
+
+      delete process.env.CLOUDINARY_API_KEY;
+      delete process.env.CLOUDINARY_API_SECRET;
+
+      process.env.DEPLOY_PRIME_URL = 'https://deploy-preview-1234--netlify-plugin-cloudinary.netlify.app';
+
+      const deliveryType = 'upload';
+      const imagesPath = '/images';
+
+      await onBuild({
+        constants: {
+          PUBLISH_DIR: `.next/out${imagesPath}`
+        },
+        inputs: {
+          deliveryType
+        },
+        utils: {
+          build: {
+            failBuild: () => {}
+          }
+        }
+      });
+
+      expect(console.error).toBeCalledWith(`[Cloudinary] ${ERROR_API_CREDENTIALS_REQUIRED}`);
+    });
+
+  });
 
   describe('Redirects', () => {
 
@@ -19,11 +67,14 @@ describe('onBuild', () => {
 
       fs.readdir.mockResolvedValue([imagesFunctionName]);
 
-      process.env.SITE_NAME = 'cool-site';
-      process.env.CLOUDINARY_CLOUD_NAME = 'testcloud';
       process.env.CONTEXT = 'production';
       process.env.NETLIFY_HOST = 'https://netlify-plugin-cloudinary.netlify.app';
 
+      // Tests to ensure that delivery type of fetch works without API Key and Secret as it should
+
+      delete process.env.CLOUDINARY_API_KEY;
+      delete process.env.CLOUDINARY_API_SECRET;
+
       const deliveryType = 'fetch';
       const imagesPath = '/images';
 
@@ -70,8 +121,6 @@ describe('onBuild', () => {
 
       fs.readdir.mockResolvedValue([imagesFunctionName]);
 
-      process.env.SITE_NAME = 'cool-site';
-      process.env.CLOUDINARY_CLOUD_NAME = 'testcloud';
       process.env.CONTEXT = 'deploy-preview';
       process.env.DEPLOY_PRIME_URL = 'https://deploy-preview-1234--netlify-plugin-cloudinary.netlify.app';
 
@@ -122,8 +171,6 @@ describe('onBuild', () => {
 
       fs.readdir.mockResolvedValue([imagesFunctionName]);
 
-      process.env.SITE_NAME = 'cool-site';
-      process.env.CLOUDINARY_CLOUD_NAME = 'testcloud';
       process.env.CONTEXT = 'deploy-preview';
       process.env.DEPLOY_PRIME_URL = 'https://deploy-preview-1234--netlify-plugin-cloudinary.netlify.app';