@plone/volto 16.31.6 → 16.31.7

package/.changelog.draft

@@ -1,7 +1,7 @@
-## 16.31.6 (2024-05-09)
+## 16.31.7 (2024-05-21)
 
 ### Bugfix
 
-- Revert "Fix 301 and 302 redirects" which was not working correctly. @davisagli [#6009](https://github.com/plone/volto/issues/6009)
+- Return a redirect response from Volto server-side rendering if the API request was redirected. @JeffersonBledsoe @mamico [#4834](https://github.com/plone/volto/issues/4834)
 
 

package/.readthedocs.yaml

@@ -0,0 +1,10 @@
+version: 2
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.12"
+  jobs:
+    post_checkout:
+      # Cancel the Read the Docs build
+      # https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition
+      - exit 183;

package/CHANGELOG.md

@@ -8,6 +8,12 @@
 
 <!-- towncrier release notes start -->
 
+## 16.31.7 (2024-05-21)
+
+### Bugfix
+
+- Return a redirect response from Volto server-side rendering if the API request was redirected. @JeffersonBledsoe @mamico [#4834](https://github.com/plone/volto/issues/4834)
+
 ## 16.31.6 (2024-05-09)
 
 ### Bugfix

package/package.json

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

package/packages/volto-slate/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plone/volto-slate",
-  "version": "16.31.6",
+  "version": "16.31.7",
   "description": "Slate.js integration with Volto",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",

package/src/components/theme/View/View.jsx

@@ -203,8 +203,10 @@ class View extends Component {
    */
   render() {
     const { views } = config;
-    if (this.props.error && this.props.error.code === 301) {
-      const redirect = flattenToAppURL(this.props.error.url).split('?')[0];
+    if ([301, 302].includes(this.props.error?.code)) {
+      const redirect = flattenToAppURL(this.props.error.url)
+        .split('?')[0]
+        .replace('/++api++', '');
       return <Redirect to={`${redirect}${this.props.location.search}`} />;
     } else if (this.props.error && !this.props.connectionRefused) {
       let FoundView;

package/src/components/theme/View/View.test.jsx

@@ -22,6 +22,7 @@ beforeAll(() => {
   });
   config.settings.publicURL = 'https://plone.org';
 });
+global.__SERVER__ = true; // eslint-disable-line no-underscore-dangle
 
 const mockStore = configureStore();
 

package/packages/README.md

@@ -1,7 +0,0 @@
-# Packages
-
-This directory is intended to contain packages related to Volto ecosystem.
-
-It was never intended to convert this repo in a monorepo.
-
-Main Volto package is still located in the root, and it's intended to continue doing so.

package/src/helpers/Api/APIResourceWithAuth.js

@@ -1,39 +0,0 @@
-/**
- * Sitemap helper.
- * @module helpers/Sitemap
- */
-
-import superagent from 'superagent';
-import config from '@plone/volto/registry';
-import { addHeadersFactory } from '@plone/volto/helpers/Proxy/Proxy';
-
-/**
- * Get a resource image/file with authenticated (if token exist) API headers
- * @function getAPIResourceWithAuth
- * @param {Object} req Request object
- * @return {string} The response with the image
- */
-export const getAPIResourceWithAuth = (req) =>
-  new Promise((resolve, reject) => {
-    const { settings } = config;
-    const APISUFIX = settings.legacyTraverse ? '' : '/++api++';
-
-    let apiPath = '';
-    if (settings.internalApiPath && __SERVER__) {
-      apiPath = settings.internalApiPath;
-    } else if (__DEVELOPMENT__ && settings.devProxyToApiPath) {
-      apiPath = settings.devProxyToApiPath;
-    } else {
-      apiPath = settings.apiPath;
-    }
-    const request = superagent
-      .get(`${apiPath}${APISUFIX}${req.path}`)
-      .maxResponseSize(settings.maxResponseSize)
-      .responseType('blob');
-    const authToken = req.universalCookies.get('auth_token');
-    if (authToken) {
-      request.set('Authorization', `Bearer ${authToken}`);
-    }
-    request.use(addHeadersFactory(req));
-    request.then(resolve).catch(reject);
-  });

package/src/helpers/Api/Api.js

@@ -1,117 +0,0 @@
-/**
- * Api helper.
- * @module helpers/Api
- */
-
-import superagent from 'superagent';
-import Cookies from 'universal-cookie';
-import config from '@plone/volto/registry';
-import { addHeadersFactory } from '@plone/volto/helpers/Proxy/Proxy';
-import { stripQuerystring } from '@plone/volto/helpers';
-
-const methods = ['get', 'post', 'put', 'patch', 'del'];
-
-/**
- * Format the url.
- * @function formatUrl
- * @param {string} path Path (or URL) to be formatted.
- * @returns {string} Formatted path.
- */
-function formatUrl(path) {
-  const { settings } = config;
-  const APISUFIX = settings.legacyTraverse ? '' : '/++api++';
-
-  if (path.startsWith('http://') || path.startsWith('https://')) return path;
-
-  const adjustedPath = path[0] !== '/' ? `/${path}` : path;
-  let apiPath = '';
-  if (settings.internalApiPath && __SERVER__) {
-    apiPath = settings.internalApiPath;
-  } else if (settings.apiPath) {
-    apiPath = settings.apiPath;
-  }
-
-  return `${apiPath}${APISUFIX}${adjustedPath}`;
-}
-
-/**
- * Api class.
- * @class Api
- */
-class Api {
-  /**
-   * Constructor
-   * @method constructor
-   * @constructs Api
-   */
-  constructor(req) {
-    const cookies = new Cookies();
-
-    methods.forEach((method) => {
-      this[method] = (
-        path,
-        { params, data, type, headers = {}, checkUrl = false } = {},
-      ) => {
-        let request;
-        let promise = new Promise((resolve, reject) => {
-          request = superagent[method](formatUrl(path));
-
-          if (params) {
-            request.query(params);
-          }
-
-          let authToken;
-          if (req) {
-            // We are in SSR
-            authToken = req.universalCookies.get('auth_token');
-            request.use(addHeadersFactory(req));
-          } else {
-            authToken = cookies.get('auth_token');
-          }
-          if (authToken) {
-            request.set('Authorization', `Bearer ${authToken}`);
-          }
-
-          request.set('Accept', 'application/json');
-
-          if (type) {
-            request.type(type);
-          }
-
-          Object.keys(headers).forEach((key) => request.set(key, headers[key]));
-
-          if (data) {
-            request.send(data);
-          }
-
-          request.end((err, response) => {
-            if (
-              checkUrl &&
-              request.url &&
-              request.xhr &&
-              encodeURI(stripQuerystring(request.url)) !==
-                stripQuerystring(request.xhr.responseURL)
-            ) {
-              if (request.xhr.responseURL?.length === 0) {
-                return reject({
-                  code: 408,
-                  status: 408,
-                  url: request.xhr.responseURL,
-                });
-              }
-              return reject({
-                code: 301,
-                url: request.xhr.responseURL,
-              });
-            }
-            return err ? reject(err) : resolve(response.body || response.text);
-          });
-        });
-        promise.request = request;
-        return promise;
-      };
-    });
-  }
-}
-
-export default Api;

package/src/helpers/Api/Api.plone.rest.test.js

@@ -1,41 +0,0 @@
-import config from '@plone/volto/registry';
-import Api from './Api';
-
-jest.mock('superagent', () => ({
-  get: jest.fn((url) => ({
-    url,
-    query: jest.fn(),
-    set: jest.fn(),
-    type: jest.fn(),
-    send: jest.fn(),
-    end: jest.fn(),
-  })),
-}));
-
-beforeAll(() => {
-  config.settings.legacyTraverse = false;
-});
-
-const api = new Api();
-const { settings } = config;
-
-test('get request', () => {});
-
-describe('Api', () => {
-  it('prefixes relative path', () => {
-    const promise = api.get('');
-    expect(promise.request.url).toBe(`${settings.apiPath}/++api++/`);
-  });
-  it('does not prefix absolute path', () => {
-    const promise = api.get('/test');
-    expect(promise.request.url).toBe(`${settings.apiPath}/++api++/test`);
-  });
-  it('does not change http URL provided as path', () => {
-    const promise = api.get('http://example.com');
-    expect(promise.request.url).toBe('http://example.com');
-  });
-  it('does not change https URL provided as path', () => {
-    const promise = api.get('https://example.com');
-    expect(promise.request.url).toBe('https://example.com');
-  });
-});

package/src/helpers/Api/Api.test.js

@@ -1,47 +0,0 @@
-// import superagent from 'superagent';
-import config from '@plone/volto/registry';
-import Api from './Api';
-
-// jest.mock('react-cookie', () => ({
-//   load: jest.fn(() => 'token'),
-// }));
-//
-
-jest.mock('superagent', () => ({
-  get: jest.fn((url) => ({
-    url,
-    query: jest.fn(),
-    set: jest.fn(),
-    type: jest.fn(),
-    send: jest.fn(),
-    end: jest.fn(),
-  })),
-}));
-
-beforeAll(() => {
-  config.settings.legacyTraverse = true;
-});
-
-const api = new Api();
-const { settings } = config;
-
-test('get request', () => {});
-
-describe('Api', () => {
-  it('prefixes relative path', () => {
-    const promise = api.get('');
-    expect(promise.request.url).toBe(`${settings.apiPath}/`);
-  });
-  it('does not prefix absolute path', () => {
-    const promise = api.get('/test');
-    expect(promise.request.url).toBe(`${settings.apiPath}/test`);
-  });
-  it('does not change http URL provided as path', () => {
-    const promise = api.get('http://example.com');
-    expect(promise.request.url).toBe('http://example.com');
-  });
-  it('does not change https URL provided as path', () => {
-    const promise = api.get('https://example.com');
-    expect(promise.request.url).toBe('https://example.com');
-  });
-});