feat: support per collection public_folder (#3069)

* feat: support per collection public_folder

* test: improve tests readability

packages/netlify-cms-core/src/actions/__tests__/config.spec.js

@@ -3,6 +3,7 @@ import { applyDefaults } from '../config';
 
 describe('config', () => {
   describe('applyDefaults', () => {
+    describe('publish_mode', () => {
       it('should set publish_mode if not set', () => {
         const config = fromJS({
           foo: 'bar',
@@ -23,7 +24,9 @@ describe('config', () => {
         });
         expect(applyDefaults(config).get('publish_mode')).toEqual('complex');
       });
+    });
 
+    describe('public_folder', () => {
       it('should set public_folder based on media_folder if not set', () => {
         expect(
           applyDefaults(
@@ -48,7 +51,9 @@ describe('config', () => {
           ).get('public_folder'),
         ).toEqual('/publib/path');
       });
+    });
 
+    describe('collections', () => {
       it('should strip leading slashes from collection folder', () => {
         expect(
           applyDefaults(
@@ -69,13 +74,14 @@ describe('config', () => {
         ).toEqual(fromJS([{ files: [{ file: 'foo' }] }]));
       });
 
-    it('should set default slug config', () => {
+      describe('slug', () => {
+        it('should set default slug config if not set', () => {
           expect(applyDefaults(fromJS({ collections: [] })).get('slug')).toEqual(
             fromJS({ encoding: 'unicode', clean_accents: false, sanitize_replacement: '-' }),
           );
         });
 
-    it('should not override slug encoding', () => {
+        it('should not overwrite slug encoding if set', () => {
           expect(
             applyDefaults(fromJS({ collections: [], slug: { encoding: 'ascii' } })).getIn([
               'slug',
@@ -84,7 +90,7 @@ describe('config', () => {
           ).toEqual('ascii');
         });
 
-    it('should not override slug clean_accents', () => {
+        it('should not overwrite slug clean_accents if set', () => {
           expect(
             applyDefaults(fromJS({ collections: [], slug: { clean_accents: true } })).getIn([
               'slug',
@@ -93,7 +99,7 @@ describe('config', () => {
           ).toEqual(true);
         });
 
-    it('should not override slug sanitize_replacement', () => {
+        it('should not overwrite slug sanitize_replacement if set', () => {
           expect(
             applyDefaults(fromJS({ collections: [], slug: { sanitize_replacement: '_' } })).getIn([
               'slug',
@@ -102,4 +108,64 @@ describe('config', () => {
           ).toEqual('_');
         });
       });
+
+      describe('public_folder and media_folder', () => {
+        it('should set collection public_folder collection based on media_folder if not set', () => {
+          expect(
+            applyDefaults(
+              fromJS({
+                collections: [{ folder: 'foo', media_folder: 'static/images/docs' }],
+              }),
+            ).get('collections'),
+          ).toEqual(
+            fromJS([
+              {
+                folder: 'foo',
+                media_folder: 'static/images/docs',
+                public_folder: 'static/images/docs',
+              },
+            ]),
+          );
+        });
+
+        it('should not overwrite collection public_folder if set', () => {
+          expect(
+            applyDefaults(
+              fromJS({
+                collections: [
+                  {
+                    folder: 'foo',
+                    media_folder: 'static/images/docs',
+                    public_folder: 'images/docs',
+                  },
+                ],
+              }),
+            ).get('collections'),
+          ).toEqual(
+            fromJS([
+              {
+                folder: 'foo',
+                media_folder: 'static/images/docs',
+                public_folder: 'images/docs',
+              },
+            ]),
+          );
+        });
+
+        it("should set collection media_folder and public_folder to an empty string when collection path exists, but collection media_folder doesn't", () => {
+          expect(
+            applyDefaults(
+              fromJS({
+                collections: [{ folder: 'foo', path: '{{slug}}/index' }],
+              }),
+            ).get('collections'),
+          ).toEqual(
+            fromJS([
+              { folder: 'foo', path: '{{slug}}/index', media_folder: '', public_folder: '' },
+            ]),
+          );
+        });
+      });
+    });
+  });
 });

packages/netlify-cms-core/src/actions/config.js

@@ -64,6 +64,9 @@ export function applyDefaults(config) {
               // default value for media folder when using the path config
               collection = collection.set('media_folder', '');
             }
+            if (collection.has('media_folder') && !collection.has('public_folder')) {
+              collection = collection.set('public_folder', collection.get('media_folder'));
+            }
             return collection.set('folder', trimStart(folder, '/'));
           }
 

packages/netlify-cms-core/src/reducers/__tests__/entries.spec.js

@@ -182,7 +182,7 @@ describe('entries', () => {
       ).toBe('/media/image.png');
     });
 
-    it('should resolve path from public folder when in editorial workflow for collection with no media folder', () => {
+    it('should resolve path from public folder when in editorial workflow for collection with no public folder', () => {
       expect(
         selectMediaFilePublicPath(
           Map({ public_folder: '/media', publish_mode: EDITORIAL_WORKFLOW }),
@@ -192,21 +192,21 @@ describe('entries', () => {
       ).toBe('/media/image.png');
     });
 
-    it('should resolve path from collection media folder when in editorial workflow for collection with media folder', () => {
+    it('should resolve path from collection media folder when in editorial workflow for collection with public folder', () => {
       expect(
         selectMediaFilePublicPath(
           Map({ public_folder: '/media', publish_mode: EDITORIAL_WORKFLOW }),
-          Map({ name: 'posts', folder: 'posts', media_folder: '' }),
+          Map({ name: 'posts', folder: 'posts', public_folder: '' }),
           'image.png',
         ),
       ).toBe('image.png');
     });
 
-    it('should handle relative media_folder', () => {
+    it('should handle relative public_folder', () => {
       expect(
         selectMediaFilePublicPath(
           Map({ public_folder: '/media', publish_mode: EDITORIAL_WORKFLOW }),
-          Map({ name: 'posts', folder: 'posts', media_folder: '../../static/media/' }),
+          Map({ name: 'posts', folder: 'posts', public_folder: '../../static/media/' }),
           'image.png',
         ),
       ).toBe('../../static/media/image.png');

packages/netlify-cms-core/src/reducers/entries.ts

@@ -190,8 +190,8 @@ export const selectMediaFilePublicPath = (
   let publicFolder = config.get('public_folder');
 
   const useWorkflow = config.get('publish_mode') === EDITORIAL_WORKFLOW;
-  if (useWorkflow && collection && collection.has('media_folder')) {
+  if (useWorkflow && collection && collection.has('public_folder')) {
-    publicFolder = collection.get('media_folder') as string;
+    publicFolder = collection.get('public_folder') as string;
   }
 
   return join(publicFolder, basename(mediaPath));

packages/netlify-cms-core/src/types/redux.ts

@@ -100,6 +100,7 @@ type CollectionObject = {
   fields: EntryFields;
   isFetching: boolean;
   media_folder?: string;
+  public_folder?: string;
   preview_path?: string;
   preview_path_date_field?: string;
   summary?: string;