feat: make cname, secureDestination and privateCdn configurable

cloudinary-community · Oct 6, 2023 · 9f62f92 · 9f62f92
1 parent f10ce2a
commit 9f62f92
Show file tree

Hide file tree

Showing 5 changed files with 143 additions and 18 deletions.
diff --git a/demo/gatsby-config.js b/demo/gatsby-config.js
@@ -20,7 +20,6 @@ module.exports = {
         context: true,
         maxResults: 10,
         prefix: process.env.CLOUDINARY_SOURCE_PREFIX,
-        secure: false,
       },
     },
     {

diff --git a/plugin/gatsby-node.js b/plugin/gatsby-node.js
@@ -23,14 +23,28 @@ exports.pluginOptionsSchema = ({ Joi }) => {
     prefix: Joi.string(),
     context: Joi.boolean(),
     secure: Joi.boolean().default(true),
+    cname: Joi.string(),
+    secureDistribution: Joi.string(),
+    privateCdn: Joi.boolean().default(false),
   });
 };
 
-const getNodeData = (gatsbyUtils, media, cloudName, secure) => {
+const getNodeData = (
+  gatsbyUtils,
+  media,
+  cloudName,
+  secure,
+  cname,
+  secureDistribution,
+  privateCdn,
+) => {
   const { createNodeId, createContentDigest } = gatsbyUtils;
 
   const url = generateCloudinaryUrl(media, {
     secure: secure,
+    cname: cname,
+    secure_distribution: secureDistribution,
+    private_cdn: privateCdn,
   });
 
   return {
@@ -66,6 +80,9 @@ const createCloudinaryNodes = async (
   resourceOptions,
   cloudName,
   secure,
+  cname,
+  secureDistribution,
+  privateCdn,
 ) => {
   const { actions, reporter } = gatsbyUtils;
   const { max_results, results_per_page } = resourceOptions;
@@ -83,7 +100,15 @@ const createCloudinaryNodes = async (
       });
 
       result.resources.forEach((resource) => {
-        const nodeData = getNodeData(gatsbyUtils, resource, cloudName, secure);
+        const nodeData = getNodeData(
+          gatsbyUtils,
+          resource,
+          cloudName,
+          secure,
+          cname,
+          secureDistribution,
+          privateCdn,
+        );
         actions.createNode(nodeData);
       });
 
@@ -109,7 +134,8 @@ const createCloudinaryNodes = async (
 };
 
 exports.sourceNodes = async (gatsbyUtils, pluginOptions) => {
-  const { cloudName, secure } = pluginOptions;
+  const { cloudName, secure, cname, secureDistribution, privateCdn } =
+    pluginOptions;
   const cloudinary = newCloudinary(pluginOptions);
   const resourceOptions = getResourceOptions(pluginOptions);
 
@@ -119,5 +145,8 @@ exports.sourceNodes = async (gatsbyUtils, pluginOptions) => {
     resourceOptions,
     cloudName,
     secure,
+    cname,
+    secureDistribution,
+    privateCdn,
   );
 };
diff --git a/plugin/gatsby-node.test.js b/plugin/gatsby-node.test.js
@@ -30,6 +30,9 @@ describe('pluginOptionsSchema', () => {
       prefix: 800,
       context: '',
       secure: 'not a boolean',
+      cname: 2,
+      secureDistribution: 3,
+      privateCdn: 'not a boolean',
     };
 
     const { isValid, errors } = await testPluginOptionsSchema(
@@ -50,6 +53,9 @@ describe('pluginOptionsSchema', () => {
       `"prefix" must be a string`,
       `"context" must be a boolean`,
       `"secure" must be a boolean`,
+      `"cname" must be a string`,
+      `"secureDistribution" must be a string`,
+      `"privateCdn" must be a boolean`,
     ]);
   });
 
@@ -69,6 +75,7 @@ describe('pluginOptionsSchema', () => {
       resultsPerPage: 10,
       tags: false,
       secure: true,
+      privateCdn: false,
     });
   });
 });
diff --git a/plugin/utils.js b/plugin/utils.js
@@ -47,7 +47,7 @@ const getResourceOptions = (options) => {
 
 const generateCloudinaryUrl = (
   { cloud_name, public_id, resource_type },
-  { secure },
+  { secure, cname, secure_distribution, private_cdn },
 ) => {
   const url = cloudinary.url(public_id, {
     resource_type: resource_type,
@@ -58,6 +58,9 @@ const generateCloudinaryUrl = (
     sdkCode: SDK_CODE,
     sdkSemver: SDK_SEMVER,
     techVersion: TECH_VERSION,
+    cname: cname,
+    secure_distribution: secure_distribution,
+    private_cdn: private_cdn,
   });
 
   return url;

diff --git a/plugin/utils.test.js b/plugin/utils.test.js
@@ -29,23 +29,110 @@ describe('getResourceOptions', () => {
 
 describe('generateCloudinaryUrl', () => {
   const ANALYTICS_CODE = 'AXOrEGQ0';
+  describe('generates correct url for image', () => {
+    it('for secure is true', () => {
+      const asset = {
+        public_id: 'public-id',
+        cloud_name: 'cloud-name',
+      };
 
-  it('generates correct url for image (default)', () => {
-    const asset = {
-      public_id: 'public-id',
-      cloud_name: 'cloud-name',
-    };
+      const secureUrl = generateCloudinaryUrl(asset, { secure: true });
+      expect(secureUrl).toBe(
+        `https://res.cloudinary.com/cloud-name/image/upload/f_auto,q_auto/public-id?_a=${ANALYTICS_CODE}`,
+      );
+    });
 
-    const secureUrl = generateCloudinaryUrl(asset, { secure: true });
-    expect(secureUrl).toBe(
-      `https://res.cloudinary.com/cloud-name/image/upload/f_auto,q_auto/public-id?_a=${ANALYTICS_CODE}`,
-    );
-    const url = generateCloudinaryUrl(asset, { secure: false });
-    expect(url).toBe(
-      `http://res.cloudinary.com/cloud-name/image/upload/f_auto,q_auto/public-id?_a=${ANALYTICS_CODE}`,
-    );
+    it('for secure is false', () => {
+      const asset = {
+        public_id: 'public-id',
+        cloud_name: 'cloud-name',
+      };
+
+      const url = generateCloudinaryUrl(asset, { secure: false });
+      expect(url).toBe(
+        `http://res.cloudinary.com/cloud-name/image/upload/f_auto,q_auto/public-id?_a=${ANALYTICS_CODE}`,
+      );
+    });
+
+    it('for custom cname and secure is false', () => {
+      const asset = {
+        public_id: 'public-id',
+        cloud_name: 'cloud-name',
+      };
+
+      const url = generateCloudinaryUrl(asset, {
+        secure: false,
+        cname: 'example.com',
+      });
+      expect(url).toBe(
+        `http://example.com/cloud-name/image/upload/f_auto,q_auto/public-id?_a=${ANALYTICS_CODE}`,
+      );
+    });
+
+    it('for custom cname and secure is true', () => {
+      const asset = {
+        public_id: 'public-id',
+        cloud_name: 'cloud-name',
+      };
+
+      const url = generateCloudinaryUrl(asset, {
+        secure: true,
+        secure_distribution: 'example.com',
+      });
+      expect(url).toBe(
+        `https://example.com/cloud-name/image/upload/f_auto,q_auto/public-id?_a=${ANALYTICS_CODE}`,
+      );
+    });
+
+    it('for custom secure_distribution (cname) and secure is true', () => {
+      const asset = {
+        public_id: 'public-id',
+        cloud_name: 'cloud-name',
+      };
+
+      const url = generateCloudinaryUrl(asset, {
+        secure: true,
+        secure_distribution: 'example.com',
+      });
+      expect(url).toBe(
+        `https://example.com/cloud-name/image/upload/f_auto,q_auto/public-id?_a=${ANALYTICS_CODE}`,
+      );
+    });
+
+    it('for private_cdn and secure is true', () => {
+      const asset = {
+        public_id: 'public-id',
+        cloud_name: 'cloud-name',
+      };
+
+      const url = generateCloudinaryUrl(asset, {
+        secure: true,
+        private_cdn: true,
+      });
+      expect(url).toBe(
+        `https://cloud-name-res.cloudinary.com/image/upload/f_auto,q_auto/public-id?_a=${ANALYTICS_CODE}`,
+      );
+    });
+
+    it('for private_cdn and secure is false', () => {
+      const asset = {
+        public_id: 'public-id',
+        cloud_name: 'cloud-name',
+      };
+
+      const url = generateCloudinaryUrl(asset, {
+        secure: false,
+        private_cdn: true,
+      });
+      expect(url).toBe(
+        `http://cloud-name-res.cloudinary.com/image/upload/f_auto,q_auto/public-id?_a=${ANALYTICS_CODE}`,
+      );
+    });
   });
 
+  // cname: ,
+  //   secure_destination,
+  //   private_cdn
   it('generates correct url for video', () => {
     const asset = {
       public_id: 'public-id',