Merge pull request #16 from colbyfayock/feat/14-error-reporting

using Netlify build utils to report plugin errors

Author: colbyfayock

src/data/errors.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ERROR_CLOUD_NAME_REQUIRED: 'A Cloudinary Cloud Name is required. Please set cloudName input or use the environment variable CLOUDINARY_CLOUD_NAME'
+}

src/index.js

@@ -4,6 +4,7 @@ const glob = require('glob');
 
 const { configureCloudinary, updateHtmlImagesToCloudinary, getCloudinaryUrl } = require('./lib/cloudinary');
 const { PUBLIC_ASSET_PATH } = require('./data/cloudinary');
+const { ERROR_CLOUD_NAME_REQUIRED } = require('./data/errors');
 
 const CLOUDINARY_ASSET_DIRECTORIES = [
   {
@@ -19,7 +20,7 @@ const CLOUDINARY_ASSET_DIRECTORIES = [
  */
 
 module.exports = {
-  async onPreBuild({ netlifyConfig, constants, inputs }) {
+  async onPreBuild({ netlifyConfig, constants, inputs, utils }) {
     const host = process.env.DEPLOY_PRIME_URL || process.env.NETLIFY_HOST;
 
     if ( !host ) {
@@ -50,7 +51,8 @@ module.exports = {
     const apiSecret = process.env.CLOUDINARY_API_SECRET;
 
     if ( !cloudName ) {
-      throw new Error('A Cloudinary Cloud Name is required. Please set cloudName input or use the environment variable CLOUDINARY_CLOUD_NAME');
+      utils.build.failBuild(ERROR_CLOUD_NAME_REQUIRED);
+      return;
     }
 
     configureCloudinary({
@@ -62,34 +64,41 @@ module.exports = {
     const imagesDirectory = glob.sync(`${PUBLISH_DIR}/images/**/*`);
     const imagesFiles = imagesDirectory.filter(file => !!path.extname(file));
 
-    const images = await Promise.all(imagesFiles.map(async image => {
-      const publishPath = image.replace(PUBLISH_DIR, '');
-      const publishUrl = `${host}${publishPath}`;
-      const cldAssetPath = `/${path.join(PUBLIC_ASSET_PATH, publishPath)}`;
-      const cldAssetUrl = `${host}${cldAssetPath}`;
+    let images;
 
-      const cloudinary = await getCloudinaryUrl({
-        deliveryType,
-        folder,
-        path: publishPath,
-        localDir: PUBLISH_DIR,
-        uploadPreset,
-        remoteHost: host,
-      });
+    try {
+      await Promise.all(imagesFiles.map(async image => {
+        const publishPath = image.replace(PUBLISH_DIR, '');
+        const publishUrl = `${host}${publishPath}`;
+        const cldAssetPath = `/${path.join(PUBLIC_ASSET_PATH, publishPath)}`;
+        const cldAssetUrl = `${host}${cldAssetPath}`;
 
-      return {
-        publishPath,
-        publishUrl,
-        ...cloudinary
-      }
-    }));
+        const cloudinary = await getCloudinaryUrl({
+          deliveryType,
+          folder,
+          path: publishPath,
+          localDir: PUBLISH_DIR,
+          uploadPreset,
+          remoteHost: host,
+        });
+
+        return {
+          publishPath,
+          publishUrl,
+          ...cloudinary
+        }
+      }));
+    } catch(e) {
+      utils.build.failBuild(e.message);
+      return;
+    }
 
     netlifyConfig.build.environment.CLOUDINARY_ASSETS = {
       images
     }
   },
 
-  async onBuild({ netlifyConfig, constants, inputs }) {
+  async onBuild({ netlifyConfig, constants, inputs, utils }) {
     const host = process.env.DEPLOY_PRIME_URL || process.env.NETLIFY_HOST;
 
     if ( !host ) {
@@ -111,7 +120,8 @@ module.exports = {
     const apiSecret = process.env.CLOUDINARY_API_SECRET;
 
     if ( !cloudName ) {
-      throw new Error('A Cloudinary Cloud Name is required. Please set cloudName input or use the environment variable CLOUDINARY_CLOUD_NAME');
+      utils.build.failBuild(ERROR_CLOUD_NAME_REQUIRED);
+      return;
     }
 
     configureCloudinary({
@@ -177,7 +187,7 @@ module.exports = {
   // Post build looks through all of the output HTML and rewrites any src attributes to use a cloudinary URL
   // This only solves on-page references until any JS refreshes the DOM
 
-  async onPostBuild({ netlifyConfig, constants, inputs }) {
+  async onPostBuild({ netlifyConfig, constants, inputs, utils }) {
     const host = process.env.DEPLOY_PRIME_URL || process.env.NETLIFY_HOST;
 
     if ( !host ) {
@@ -198,7 +208,8 @@ module.exports = {
     const apiSecret = process.env.CLOUDINARY_API_SECRET;
 
     if ( !cloudName ) {
-      throw new Error('A Cloudinary Cloud Name is required. Please set cloudName input or use the environment variable CLOUDINARY_CLOUD_NAME');
+      utils.build.failBuild(ERROR_CLOUD_NAME_REQUIRED);
+      return;
     }
 
     configureCloudinary({

src/lib/cloudinary.js

@@ -5,6 +5,7 @@ const { JSDOM } = require('jsdom');
 const cloudinary = require('cloudinary').v2;
 
 const { isRemoteUrl, determineRemoteUrl } = require('./util');
+const { ERROR_CLOUD_NAME } = require('../data/errors');
 
 /**
  * getCloudinary
@@ -74,7 +75,7 @@ async function getCloudinaryUrl(options = {}) {
   const canSignUpload = apiKey && apiSecret;
 
   if ( !cloudName ) {
-    throw new Error('Cloudinary Cloud Name required.');
+    throw new Error(ERROR_CLOUD_NAME);
   }
 
   if ( deliveryType === 'upload' && !canSignUpload && !uploadPreset ) {