@plone/volto 14.0.0 → 14.0.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 14.0.1 (2021-12-21)
+
+### Bugfix
+
+- Construct request with list parameters as separate querystring key value pairs according Zope convention @ksuess
+
 ## 14.0.0 (2021-12-20)
 
 ### Breaking

package/package.json

@@ -9,7 +9,7 @@
     }
   ],
   "license": "MIT",
-  "version": "14.0.0",
+  "version": "14.0.1",
   "repository": {
     "type": "git",
     "url": "git@github.com:plone/volto.git"

package/src/middleware/Api.test.js

@@ -14,7 +14,7 @@ describe('api middleware helpers', () => {
     const result = addExpandersToPath('/de/mypage', GET_CONTENT);
     expect(result).toEqual('/de/mypage?expand=mycustomexpander');
   });
-  it('addExpandersToPath with expanders already present (multilingual)', () => {
+  it('addExpandersToPath - Custom expander from settings, with expander (translation) already present (multilingual) in query', () => {
     config.settings.apiExpanders = [
       {
         match: '/',
@@ -28,7 +28,7 @@ describe('api middleware helpers', () => {
     );
     expect(result).toEqual('/de/mypage?expand=translations,mycustomexpander');
   });
-  it('addExpandersToPath not matching', () => {
+  it('addExpandersToPath - Path not matching', () => {
     config.settings.apiExpanders = [
       {
         match: '/de/otherpath',
@@ -39,7 +39,7 @@ describe('api middleware helpers', () => {
     const result = addExpandersToPath('/de/mypage', GET_CONTENT);
     expect(result).toEqual('/de/mypage');
   });
-  it('addExpandersToPath not matching, preserve query', () => {
+  it('addExpandersToPath - Path not matching, preserve query', () => {
     config.settings.apiExpanders = [
       {
         match: '/de/otherpath',
@@ -53,7 +53,7 @@ describe('api middleware helpers', () => {
     );
     expect(result).toEqual('/de/mypage/@navigation?expand.navigation.depth=3');
   });
-  it('addExpandersToPath should work as expected, several', () => {
+  it('addExpandersToPath - Two custom expanders from settings', () => {
     config.settings.apiExpanders = [
       {
         match: '/',
@@ -67,7 +67,7 @@ describe('api middleware helpers', () => {
       '/de/mypage?expand=mycustomexpander,mycustomexpander2',
     );
   });
-  it('addExpandersToPath should work as expected, already query present', () => {
+  it('addExpandersToPath - Two custom expanders from settings, expansion nested (with dots notation) present', () => {
     config.settings.apiExpanders = [
       {
         match: '/',
@@ -84,7 +84,7 @@ describe('api middleware helpers', () => {
       '/de/mypage/@navigation?expand=mycustomexpander,mycustomexpander2&expand.navigation.depth=3',
     );
   });
-  it('addExpandersToPath should work as expected, already query present', () => {
+  it('addExpandersToPath - Two custom expanders from settings, query present ', () => {
     config.settings.apiExpanders = [
       {
         match: '/',
@@ -101,4 +101,55 @@ describe('api middleware helpers', () => {
       '/de/mypage/@navigation?expand=mycustomexpander,mycustomexpander2&expand.navigation.depth=3&someotherquery=1',
     );
   });
+  it('addExpandersToPath - Two custom expanders from settings, a list parameter present', () => {
+    config.settings.apiExpanders = [
+      {
+        match: '/',
+        GET_CONTENT: ['mycustomexpander', 'mycustomexpander2'],
+      },
+    ];
+
+    const result = addExpandersToPath(
+      '/de/mypage/@navigation?expand.navigation.depth=3&someotherquery=1&someotherquery=2',
+      GET_CONTENT,
+    );
+    // No need to stringify
+    expect(result).toEqual(
+      '/de/mypage/@navigation?expand=mycustomexpander,mycustomexpander2&expand.navigation.depth=3&someotherquery=1&someotherquery=2',
+    );
+  });
+  it('addExpandersToPath - Two custom expanders from settings, a list parameter present, and a translation expand already in query', () => {
+    config.settings.apiExpanders = [
+      {
+        match: '/',
+        GET_CONTENT: ['mycustomexpander', 'mycustomexpander2'],
+      },
+    ];
+
+    const result = addExpandersToPath(
+      '/de/mypage/@navigation?expand=translations&expand.navigation.depth=3&someotherquery=1&someotherquery=2',
+      GET_CONTENT,
+    );
+    // No need to stringify
+    expect(result).toEqual(
+      '/de/mypage/@navigation?expand=translations,mycustomexpander,mycustomexpander2&expand.navigation.depth=3&someotherquery=1&someotherquery=2',
+    );
+  });
+  it('addExpandersToPath - Two custom expanders from settings, a list parameter present, and a two expand present already in query', () => {
+    config.settings.apiExpanders = [
+      {
+        match: '/',
+        GET_CONTENT: ['mycustomexpander', 'mycustomexpander2'],
+      },
+    ];
+
+    const result = addExpandersToPath(
+      '/de/mypage/@navigation?expand=translations,secondexpand&expand.navigation.depth=3&someotherquery=1&someotherquery=2',
+      GET_CONTENT,
+    );
+    // No need to stringify
+    expect(result).toEqual(
+      '/de/mypage/@navigation?expand=translations,secondexpand,mycustomexpander,mycustomexpander2&expand.navigation.depth=3&someotherquery=1&someotherquery=2',
+    );
+  });
 });

package/src/middleware/api.js

@@ -22,6 +22,13 @@ let socket = null;
 /**
  *
  * Add configured expanders to an api call for an action
+ * Requirements:
+ *
+ * - It should add the expanders set in the config settings
+ * - It should preserve any query if present
+ * - It should preserve (and add) any expand parameter (if present) e.g. translations
+ * - It should take use the correct codification for arrays in querystring (repeated parameter for each member of the array)
+ *
  * @function addExpandersToPath
  * @param {string} path The url/path including the querystring
  * @param {*} type The action type
@@ -31,24 +38,38 @@ export function addExpandersToPath(path, type) {
   const { settings } = config;
   const { apiExpanders = [] } = settings;
 
-  const pathPart = path.split('?')[0] || '';
-  const expanders = apiExpanders
-    .filter((expand) => matchPath(pathPart, expand.match) && expand[type])
+  const {
+    url,
+    query: { expand, ...query },
+  } = qs.parseUrl(path);
+
+  const expandersFromConfig = apiExpanders
+    .filter((expand) => matchPath(url, expand.match) && expand[type])
     .map((expand) => expand[type]);
-  const query = qs.parse(qs.extract(path));
-  const expand = compact(union([query.expand, ...flatten(expanders)]));
-  if (expand) {
-    query.expand = expand;
-  }
+
+  const expandMerge = compact(union([expand, ...flatten(expandersFromConfig)]));
+
+  const stringifiedExpand = qs.stringify(
+    { expand: expandMerge },
+    {
+      arrayFormat: 'comma',
+      encode: false,
+    },
+  );
+
   const stringifiedQuery = qs.stringify(query, {
-    arrayFormat: 'comma',
     encode: false,
   });
-  if (!stringifiedQuery) {
-    return pathPart;
-  }
 
-  return `${pathPart}?${stringifiedQuery}`;
+  if (stringifiedQuery && stringifiedExpand) {
+    return `${url}?${stringifiedExpand}&${stringifiedQuery}`;
+  } else if (!stringifiedQuery && stringifiedExpand) {
+    return `${url}?${stringifiedExpand}`;
+  } else if (stringifiedQuery && !stringifiedExpand) {
+    return `${url}?${stringifiedQuery}`;
+  } else {
+    return url;
+  }
 }
 
 /**