@plone/volto 19.0.0-alpha.3 → 19.0.0-alpha.4

package/src/config/index.js

@@ -141,7 +141,7 @@ let config = {
     serverConfig,
     storeExtenders: [],
     showTags: true,
-    showRelatedItems: false,
+    showRelatedItems: true,
     controlpanels: [],
     controlPanelsIcons,
     filterControlPanels,

package/src/express-middleware/devproxy.js

@@ -10,8 +10,13 @@ import querystring from 'querystring';
 import { parse as parseUrl } from 'url';
 
 const filter = function (pathname, req) {
-  // This is the proxy to the API in case the accept header is 'application/json'
-  return config.settings.devProxyToApiPath && pathname.startsWith('/++api++');
+  // Check if pathname is defined, there are some corner cases that pathname is null
+  if (pathname) {
+    // This is the proxy to the API in case the accept header is 'application/json'
+    return config.settings.devProxyToApiPath && pathname.startsWith('/++api++');
+  } else {
+    return false;
+  }
 };
 
 let _env = null;

package/src/helpers/Html/Html.jsx

@@ -11,6 +11,7 @@ import join from 'lodash/join';
 import BodyClass from '@plone/volto/helpers/BodyClass/BodyClass';
 import { runtimeConfig } from '@plone/volto/runtime_config';
 import config from '@plone/volto/registry';
+import { bulkFlattenToAppURL } from '../Url/bulkFlattenToAppURL';
 
 const CRITICAL_CSS_TEMPLATE = `function alter() {
   document.querySelectorAll("head link[rel='prefetch']").forEach(function(el) { el.rel = 'stylesheet'});
@@ -189,7 +190,14 @@ class Html extends Component {
           <script
             dangerouslySetInnerHTML={{
               __html: `window.__data=${serialize(
-                loadReducers(store.getState()),
+                loadReducers({
+                  ...store.getState(),
+                  // Flatten the content URLs in initial request in SSR
+                  // it normalizes the URLs in case the INTERNAL_API_PATH is set
+                  // and prevents unwanted leaks of INTERNAL_API_PATH in the client
+                  // (only in the first request)
+                  content: bulkFlattenToAppURL(store.getState().content),
+                }),
               )};`,
             }}
             charSet="UTF-8"

package/src/helpers/Url/bulkFlattenToAppURL.test.ts

@@ -0,0 +1,122 @@
+import { describe, it, expect, afterEach } from 'vitest';
+import config from '@plone/registry';
+import { bulkFlattenToAppURL } from './bulkFlattenToAppURL';
+
+const API_PATH = 'http://example.com/api';
+const INTERNAL_API_PATH = 'http://backend/api';
+
+describe('bulkFlattenToAppURL', () => {
+  afterEach(() => {
+    config.settings = {};
+  });
+
+  it('should flatten URLs correctly with API_PATH', () => {
+    config.settings.apiPath = API_PATH;
+
+    const input = {
+      '@id': `${API_PATH}/path/to/resource`,
+      anotherField: `${API_PATH}/another/path`,
+      nested: {
+        '@id': `${API_PATH}/nested/resource`,
+        anotherNestedField: `${API_PATH}/nested/another/path`,
+      },
+      arrayField: [
+        {
+          '@id': `${API_PATH}/array/resource/1`,
+          anotherArrayField: `${API_PATH}/array/another/path/1`,
+        },
+        {
+          '@id': `${API_PATH}/array/resource/2`,
+          anotherArrayField: `${API_PATH}/array/another/path/2`,
+        },
+      ],
+      stringField: 'This is a string',
+      numberField: 42,
+      booleanField: true,
+      nullField: null,
+      undefinedField: undefined,
+    };
+
+    const expectedOutput = {
+      '@id': '/path/to/resource',
+      anotherField: '/another/path',
+      nested: {
+        '@id': '/nested/resource',
+        anotherNestedField: '/nested/another/path',
+      },
+      arrayField: [
+        {
+          '@id': '/array/resource/1',
+          anotherArrayField: '/array/another/path/1',
+        },
+        {
+          '@id': '/array/resource/2',
+          anotherArrayField: '/array/another/path/2',
+        },
+      ],
+      stringField: 'This is a string',
+      numberField: 42,
+      booleanField: true,
+      nullField: null,
+      undefinedField: undefined,
+    };
+
+    const result = bulkFlattenToAppURL(input as any);
+    expect(result).toEqual(expectedOutput);
+  });
+
+  it('should flatten URLs correctly with INTERNAL_API_PATH', () => {
+    config.settings.internalApiPath = INTERNAL_API_PATH;
+
+    const input = {
+      '@id': `${INTERNAL_API_PATH}/path/to/resource`,
+      anotherField: `${INTERNAL_API_PATH}/another/path`,
+      nested: {
+        '@id': `${INTERNAL_API_PATH}/nested/resource`,
+        anotherNestedField: `${INTERNAL_API_PATH}/nested/another/path`,
+      },
+      arrayField: [
+        {
+          '@id': `${INTERNAL_API_PATH}/array/resource/1`,
+          anotherArrayField: `${INTERNAL_API_PATH}/array/another/path/1`,
+        },
+        {
+          '@id': `${INTERNAL_API_PATH}/array/resource/2`,
+          anotherArrayField: `${INTERNAL_API_PATH}/array/another/path/2`,
+        },
+      ],
+      stringField: 'This is a string',
+      numberField: 42,
+      booleanField: true,
+      nullField: null,
+      undefinedField: undefined,
+    };
+
+    const expectedOutput = {
+      '@id': '/path/to/resource',
+      anotherField: '/another/path',
+      nested: {
+        '@id': '/nested/resource',
+        anotherNestedField: '/nested/another/path',
+      },
+      arrayField: [
+        {
+          '@id': '/array/resource/1',
+          anotherArrayField: '/array/another/path/1',
+        },
+        {
+          '@id': '/array/resource/2',
+          anotherArrayField: '/array/another/path/2',
+        },
+      ],
+      stringField: 'This is a string',
+      numberField: 42,
+      booleanField: true,
+      nullField: null,
+      undefinedField: undefined,
+    };
+
+    const result = bulkFlattenToAppURL(input as any);
+    expect(result).toEqual(expectedOutput);
+  });
+});

package/src/helpers/Url/bulkFlattenToAppURL.ts

@@ -0,0 +1,24 @@
+import config from '@plone/registry';
+
+/**
+ * The definitive flattenToAppURL function
+ * Flattens all the URLs in the response to the current app URL (or internalApiPath if set).
+ */
+export function bulkFlattenToAppURL<T>(data: T) {
+  // Convert data to string to perform replacements
+  let stringData = JSON.stringify(data);
+
+  // Replace all occurrences of backend URLs
+  stringData = stringData.replaceAll(`${config.settings.apiPath}/`, '/');
+  stringData = stringData.replaceAll(config.settings.apiPath, '/');
+  if (config.settings.internalApiPath) {
+    stringData = stringData.replaceAll(
+      `${config.settings.internalApiPath}/`,
+      '/',
+    );
+    stringData = stringData.replaceAll(config.settings.internalApiPath, '/');
+  }
+
+  // Parse back to object
+  return JSON.parse(stringData) as T;
+}

package/types/helpers/Url/bulkFlattenToAppURL.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The definitive flattenToAppURL function
+ * Flattens all the URLs in the response to the current app URL (or internalApiPath if set).
+ */
+export declare function bulkFlattenToAppURL<T>(data: T): T;