@eeacms/volto-eea-kitkat 6.2.3 → 7.0.0

package/CHANGELOG.md

@@ -4,9 +4,24 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [7.0.0](https://github.com/eea/volto-eea-kitkat/compare/6.2.3...7.0.0)
+
+- feat(VersionOverview): Use config.settings.frontendVersion - refs #153334 [`2143cc6`](https://github.com/eea/volto-eea-kitkat/commit/2143cc65dfd45ab7cafea691368088a0c58090b4)
+- Release @eeacms/volto-group-block@4.3.8 [`17629a0`](https://github.com/eea/volto-eea-kitkat/commit/17629a0097f740e1f871f3b84df76ecae23c58d9)
+- Release @eeacms/volto-tabs-block@2.2.0 [`206bd93`](https://github.com/eea/volto-eea-kitkat/commit/206bd93dfc6dba92d4425e1d8f30e9cc502de5b1)
+- Release volto-slate@6.3.0 [`a9a8bf8`](https://github.com/eea/volto-eea-kitkat/commit/a9a8bf8ba1ba8b711cf8949cd864e94d87f2f1e7)
+- feat(VersionOverview): Persist FRONTEND_VERSION on backend on startup [`ec095b1`](https://github.com/eea/volto-eea-kitkat/commit/ec095b16d910fce231c4fe1de180ffb905dad8df)
+- feat(VersionOverview): Better discover frontend / backend version [`aaec299`](https://github.com/eea/volto-eea-kitkat/commit/aaec299f285f82f999b13b6518c94802b1df14d4)
+- feat(VersionOverview): Show history changelog if version - refs #153334 [`6c6a170`](https://github.com/eea/volto-eea-kitkat/commit/6c6a170d2fc3507fce7b59f8ea9f4e007483eef2)
+- feat(VersionOverview): Add links to changelogs - refs #153334 [`15867e4`](https://github.com/eea/volto-eea-kitkat/commit/15867e4b81bbcefa2c492e118725d9add9bd6de5)
+- feat(VersionOverview): Update Controlpanels VersionOverview - refs #153089 [`9856935`](https://github.com/eea/volto-eea-kitkat/commit/9856935f9d64e9ed442b883a639717901ec28ae0)
+- feat(VersionOverview): Copy unchanged from @plone/volto 16 alpha 12 [`4dd2c23`](https://github.com/eea/volto-eea-kitkat/commit/4dd2c23c7440fa12845d15831d2b645152997af0)
+
 #### [6.2.3](https://github.com/eea/volto-eea-kitkat/compare/6.2.2...6.2.3)
 
-- Release @eeacms/volto-columns-block@4.5.3 [`0de16e7`](https://github.com/eea/volto-eea-kitkat/commit/0de16e768736b90ff52b854f0f156379f64d4b14)
+> 17 August 2022
+
+- Release @eeacms/volto-columns-block@4.5.3 [`#61`](https://github.com/eea/volto-eea-kitkat/pull/61)
 
 #### [6.2.2](https://github.com/eea/volto-eea-kitkat/compare/6.2.1...6.2.2)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-eea-kitkat",
-  "version": "6.2.3",
+  "version": "7.0.0",
   "description": "@eeacms/volto-eea-kitkat: Volto Add-ons bundle - A known good set of Volto addons to be used within all EEA projects and beyond",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",
@@ -59,7 +59,7 @@
     "@eeacms/volto-columns-block": "4.5.3",
     "@eeacms/volto-corsproxy": "2.1.6",
     "@eeacms/volto-depiction": "0.1.6",
-    "@eeacms/volto-group-block": "4.3.6",
+    "@eeacms/volto-group-block": "4.3.8",
     "@eeacms/volto-listing-block": "0.4.4",
     "@eeacms/volto-matomo": "2.0.9",
     "@eeacms/volto-metadata-block": "4.0.8",
@@ -69,14 +69,14 @@
     "@eeacms/volto-slate-footnote": "5.0.1",
     "@eeacms/volto-slate-metadata-mentions": "5.0.1",
     "@eeacms/volto-slate-zotero": "4.0.5",
-    "@eeacms/volto-tabs-block": "2.1.0",
+    "@eeacms/volto-tabs-block": "2.2.0",
     "@eeacms/volto-taxonomy": "2.0.6",
     "@eeacms/volto-widget-dataprovenance": "0.1.4",
     "@eeacms/volto-widget-geolocation": "4.0.6",
     "@eeacms/volto-widget-temporal-coverage": "4.0.6",
     "@eeacms/volto-widget-toggle": "2.2.7",
     "@eeacms/volto-widgets-view": "3.0.5",
-    "volto-slate": "6.2.2"
+    "volto-slate": "6.3.0"
   },
   "resolutions": {
     "@eeacms/volto-accordion-block": "3.5.0",
@@ -88,7 +88,7 @@
     "@eeacms/volto-columns-block": "4.5.3",
     "@eeacms/volto-corsproxy": "2.1.6",
     "@eeacms/volto-depiction": "0.1.6",
-    "@eeacms/volto-group-block": "4.3.6",
+    "@eeacms/volto-group-block": "4.3.8",
     "@eeacms/volto-listing-block": "0.4.4",
     "@eeacms/volto-matomo": "2.0.9",
     "@eeacms/volto-metadata-block": "4.0.8",
@@ -98,14 +98,14 @@
     "@eeacms/volto-slate-footnote": "5.0.1",
     "@eeacms/volto-slate-metadata-mentions": "5.0.1",
     "@eeacms/volto-slate-zotero": "4.0.5",
-    "@eeacms/volto-tabs-block": "2.1.0",
+    "@eeacms/volto-tabs-block": "2.2.0",
     "@eeacms/volto-taxonomy": "2.0.6",
     "@eeacms/volto-widget-geolocation": "4.0.6",
     "@eeacms/volto-widget-dataprovenance": "0.1.4",
     "@eeacms/volto-widget-temporal-coverage": "4.0.6",
     "@eeacms/volto-widget-toggle": "2.2.7",
     "@eeacms/volto-widgets-view": "3.0.5",
-    "volto-slate": "6.2.2"
+    "volto-slate": "6.3.0"
   },
   "devDependencies": {
     "@cypress/code-coverage": "^3.9.5",

package/src/customizations/volto/components/manage/Controlpanels/VersionOverview.jsx

@@ -0,0 +1,136 @@
+/**
+ * Version Overview component.
+ * @module components/manage/Controlpanels/VersionOverview
+ */
+
+import React from 'react';
+import { FormattedMessage } from 'react-intl';
+import { Grid, Label, Header } from 'semantic-ui-react';
+import { formatDate } from '@plone/volto/helpers/Utils/Date';
+import { version as voltoVersion } from '@plone/volto/../package.json';
+
+import config from '@plone/volto/registry';
+
+const VersionOverview = ({
+  cmf_version,
+  debug_mode,
+  pil_version,
+  plone_version,
+  plone_restapi_version,
+  python_version,
+  zope_version,
+  eggs = {},
+  frontend = {},
+  backend = {},
+}) => {
+  const { addonsInfo } = config.settings;
+  const locale = config.settings.dateLocale || 'en-gb';
+  const frontendVersion = frontend.version || config.settings.frontendVersion;
+  const backendVersion = backend.version || config.settings.backendVersion;
+
+  return (
+    <Grid columns={2} stackable>
+      <Grid.Row>
+        <Grid.Column>
+          {frontend.date && (
+            <Label className="highlight" ribbon>
+              Updated:{' '}
+              {formatDate({
+                date: frontend.date,
+                format: {
+                  dateStyle: 'medium',
+                  timeStyle: 'short',
+                },
+                locale: locale,
+              })}{' '}
+            </Label>
+          )}
+          <Header as="h3">
+            <span>Frontend {frontendVersion ? frontendVersion : ''}</span>
+          </Header>
+          {frontendVersion && (
+            <a
+              href={[
+                config.settings.changelogUrlPrefix,
+                config.settings.frontendName,
+                config.settings.changelogUrlSuffix,
+              ].join('/')}
+              target="_blank"
+              rel="noreferrer"
+            >
+              History: {frontend.old_version} ⇢ {frontendVersion}
+            </a>
+          )}
+          <ul style={{ fontSize: '16px', fontFamily: 'Monospace' }}>
+            {voltoVersion && <li>Volto {voltoVersion}</li>}
+            {addonsInfo.map((addon) => (
+              <li key={addon.name}>{`${addon.name} ${addon.version || ''}`}</li>
+            ))}
+          </ul>
+        </Grid.Column>
+        <Grid.Column>
+          {backend.date && (
+            <Label className="high" ribbon="right">
+              Updated:{' '}
+              {formatDate({
+                date: backend.date,
+                format: {
+                  dateStyle: 'medium',
+                  timeStyle: 'short',
+                },
+                locale: locale,
+              })}
+            </Label>
+          )}
+          <Header as="h3" textAlign="right">
+            Backend {backendVersion ? backendVersion : ''}
+          </Header>
+          <a
+            className="ui right aligned container"
+            href={[
+              config.settings.changelogUrlPrefix,
+              config.settings.backendName,
+              config.settings.changelogUrlSuffix,
+            ].join('/')}
+            target="_blank"
+            rel="noreferrer"
+          >
+            History: {backend.old_version} ⇢ {backendVersion}
+          </a>
+          <ul
+            style={{
+              fontSize: '16px',
+              fontFamily: 'Monospace',
+            }}
+          >
+            <li>Plone {plone_version}</li>
+            <li>plone.restapi {plone_restapi_version}</li>
+            <li>CMF {cmf_version}</li>
+            <li>Zope {zope_version}</li>
+            <li>Python {python_version}</li>
+            <li>PIL {pil_version}</li>
+            {Object.keys(eggs).map((k) => (
+              <li>
+                {k} {eggs[k]}
+              </li>
+            ))}
+          </ul>
+        </Grid.Column>
+      </Grid.Row>
+      <Grid.Row columns={1}>
+        <Grid.Column>
+          {debug_mode !== 'No' && (
+            <p>
+              <FormattedMessage
+                id="Warning Regarding debug mode"
+                defaultMessage="You are running in 'debug mode'. This mode is intended for sites that are under development. This allows many configuration changes to be immediately visible, but will make your site run more slowly. To turn off debug mode, stop the server, set 'debug-mode=off' in your buildout.cfg, re-run bin/buildout and then restart the server process."
+              />
+            </p>
+          )}
+        </Grid.Column>
+      </Grid.Row>
+    </Grid>
+  );
+};
+
+export default VersionOverview;

package/src/index.js

@@ -1,8 +1,43 @@
+import { version as frontendVersion } from '../../../../package.json';
+import { name as frontendName } from '../../../../package.json';
+import { updateSystemInfo } from '@eeacms/volto-eea-kitkat/system';
+
 const applyConfig = (config) => {
   if (process.env.NODE_ENV !== 'production') {
     // Enable description block for cypress
     config.blocks.blocksConfig.description.restricted = false;
   }
+
+  // Changelogs
+  config.settings.changelogUrlPrefix =
+    config.settings.changelogPrefix ||
+    process.env.RAZZLE_CHANGELOG_PREFIX ||
+    'https://github.com/eea';
+
+  config.settings.changelogUrlSuffix =
+    config.settings.changelogSuffix ||
+    process.env.RAZZLE_CHANGELOG_PREFIX ||
+    'releases';
+
+  config.settings.frontendVersion =
+    config.settings.frontendVersion ||
+    process.env.FRONTEND_VERSION ||
+    frontendVersion;
+
+  config.settings.frontendName =
+    config.settings.frontendName || process.env.FRONTEND_NAME || frontendName;
+
+  config.settings.backendVersion =
+    config.settings.backendVersion || process.env.BACKEND_VERSION || '';
+
+  config.settings.backendName =
+    config.settings.backendName || process.env.BACKEND_NAME || 'plone-backend';
+
+  // Persist FRONTEND_VERSION on backend registry
+  if (__SERVER__) {
+    updateSystemInfo(config);
+  }
+
   return config;
 };
 

package/src/system.js

@@ -0,0 +1,49 @@
+/* eslint no-console: ["error", { allow: ["warn", "log"] }] */
+export const updateSystemInfo = (config) => {
+  var fetch = require('node-fetch');
+  const internalApi =
+    config.settings.internalApiPath || config.settings.devProxyToApiPath;
+  const version = config.settings.frontendVersion;
+
+  // Nothing to do
+  if (!version || !internalApi) {
+    return config;
+  }
+
+  // Backend @system update via PATCH is allowed only via internal API
+  if (
+    !(
+      internalApi.startsWith('http://localhost') ||
+      internalApi.startsWith('http://backend')
+    )
+  ) {
+    return config;
+  }
+
+  // Persist FRONTEND_VERSION on backend registry
+  const url = `${internalApi}/@system`;
+  fetch(url, {
+    method: 'PATCH',
+    body: JSON.stringify({
+      'eea.kitkat.interfaces.IEEAVersionsFrontend.version': version,
+    }),
+    headers: {
+      Accept: 'application/json',
+    },
+  })
+    .then((response) => response.text())
+    .then((text) => {
+      if (text) {
+        console.log(`Updating FRONTEND_VERSION on backend registry: ${text}`);
+      } else {
+        console.log(
+          `FRONTEND_VERSION already up-to-date on backend registry: ${version}`,
+        );
+      }
+    })
+    .catch((err) =>
+      console.warn(`Could NOT update FRONTEND_VERSION on backend: ${err}`),
+    );
+
+  return config;
+};