@eeacms/volto-tableau 8.0.5 → 8.0.7

package/CHANGELOG.md

@@ -4,11 +4,43 @@ 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).
 
-### [8.0.5](https://github.com/eea/volto-tableau/compare/8.0.4...8.0.5) - 23 July 2024
+### [8.0.7](https://github.com/eea/volto-tableau/compare/8.0.6...8.0.7) - 9 September 2024
 
-#### :hammer_and_wrench: Others
+#### :house: Internal changes
+
+- style: Automated code fix [eea-jenkins - [`ef00271`](https://github.com/eea/volto-tableau/commit/ef00271928ae63ba0d22485f9343fc304e090b03)]
+
+#### :hammer_and_wrench: Others
+
+- Update View.test.jsx [dobri1408 - [`984f762`](https://github.com/eea/volto-tableau/commit/984f76249550287ef297526d3962a61fd498a0be)]
+- increase code coverage [dobri1408 - [`4a0b444`](https://github.com/eea/volto-tableau/commit/4a0b4449f244c4deacc4015b0d2373d0baa49e2f)]
+- increase code coverage [dobri1408 - [`0a036f4`](https://github.com/eea/volto-tableau/commit/0a036f4d45401da63e71104cae57f7378a4d3624)]
+- increase code coverage [dobri1408 - [`0438558`](https://github.com/eea/volto-tableau/commit/0438558970650d3a01d74802e622cd9d27ebda81)]
+- double check preview [dobri1408 - [`85e0689`](https://github.com/eea/volto-tableau/commit/85e0689f800064e98937be6f74bfdd9959ccd1da)]
+- double check preview [dobri1408 - [`1671a45`](https://github.com/eea/volto-tableau/commit/1671a45608c765f832b48789721dbe7b06b65ed4)]
+- Update preview_image.js [dobri1408 - [`87925c5`](https://github.com/eea/volto-tableau/commit/87925c5c45d8395c9c5b956ead2a7d988823233a)]
+- double check preview [dobri1408 - [`1579659`](https://github.com/eea/volto-tableau/commit/1579659822d56993dd147a6256013b0e7c12bbb5)]
+- Create preview_image.test.js [dobri1408 - [`c562940`](https://github.com/eea/volto-tableau/commit/c562940a2f0bb7ae34ef98a62d2c95f4fe2506c0)]
+- Update preview_image.js [dobri1408 - [`aa3b15e`](https://github.com/eea/volto-tableau/commit/aa3b15edd95d64c8ca969a8252f7d9371e142a6d)]
+- merge [dobri1408 - [`ba63a8f`](https://github.com/eea/volto-tableau/commit/ba63a8f95349d00e5782ebff31870e96891362ca)]
+- manage redux and action right [dobri1408 - [`85be516`](https://github.com/eea/volto-tableau/commit/85be51613a3789adbebd3a517f6b87f600ed3e92)]
+- Update preview_image.js [dobri1408 - [`bb20a02`](https://github.com/eea/volto-tableau/commit/bb20a0204292ef9f94734b343eea9f2fd3e5a96a)]
+- Update VisualizationWidget.jsx [dobri1408 - [`e5ee11c`](https://github.com/eea/volto-tableau/commit/e5ee11ca4f5ee10a42f28e7087582744628aa144)]
+- Update VisualizationWidget.jsx [dobri1408 - [`f0d3bdf`](https://github.com/eea/volto-tableau/commit/f0d3bdf6edff339a037a64453eea714496c39d92)]
+- fix multiple rerenders [dobri1408 - [`6cc0ef0`](https://github.com/eea/volto-tableau/commit/6cc0ef0b8d1bb7f3a0770666c6e60bb3c28df0d4)]
+- Update VisualizationWidget.jsx [dobri1408 - [`56d94fd`](https://github.com/eea/volto-tableau/commit/56d94fdf9bd26db1512d2ae5ee5f65e743b795b5)]
+- fix eslint [dobri1408 - [`d7d754e`](https://github.com/eea/volto-tableau/commit/d7d754e9d89b60951ac7da27b14db93389832216)]
+- fix eslint [dobri1408 - [`58b50d9`](https://github.com/eea/volto-tableau/commit/58b50d995059eea0cc31a0bb6e8e80b48ace99ea)]
+- middleware to save preview image [dobri1408 - [`4b9d1b3`](https://github.com/eea/volto-tableau/commit/4b9d1b3efc5c1cc04d273ce91ccc0621cb60b324)]
+- Update package.json [dobri1408 - [`12a1c94`](https://github.com/eea/volto-tableau/commit/12a1c9478591ba4729f00a55932858b5ef616ff2)]
+- middleware to save preview image [dobri1408 - [`9fe3dd7`](https://github.com/eea/volto-tableau/commit/9fe3dd795842f40e2f0d91475df04b7b97de922e)]
+### [8.0.6](https://github.com/eea/volto-tableau/compare/8.0.5...8.0.6) - 25 July 2024
+
+#### :hammer_and_wrench: Others
+
+- Update Jenkinsfile [Alexandru Ghica - [`d5e7d48`](https://github.com/eea/volto-tableau/commit/d5e7d48a52e494ebf139b14ea06d0cac8cce82f3)]
+### [8.0.5](https://github.com/eea/volto-tableau/compare/8.0.4...8.0.5) - 23 July 2024
 
-- remove default height value on tableau, ref #272831 [Miu Razvan - [`e3fbe96`](https://github.com/eea/volto-tableau/commit/e3fbe9665bec14204694db1968746fb565a2cdc8)]
 ### [8.0.4](https://github.com/eea/volto-tableau/compare/8.0.3...8.0.4) - 22 July 2024
 
 #### :hammer_and_wrench: Others

package/Jenkinsfile

@@ -14,7 +14,7 @@ pipeline {
     BACKEND_PROFILES = "eea.kitkat:testing"
     BACKEND_ADDONS = ""
     VOLTO = "17"
-    VOLTO16_BREAKING_CHANGES = "no"
+    VOLTO16_BREAKING_CHANGES = "yes"
     IMAGE_NAME = BUILD_TAG.toLowerCase()
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-tableau",
-  "version": "8.0.5",
+  "version": "8.0.7",
   "description": "@eeacms/volto-tableau: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",

package/src/Blocks/TableauBlock/View.test.jsx

@@ -0,0 +1,144 @@
+import React from 'react';
+import { render, screen } from '@testing-library/react';
+import { Provider } from 'react-redux';
+import configureStore from 'redux-mock-store';
+import View from './View';
+import '@testing-library/jest-dom/extend-expect';
+import Tableau from '@eeacms/volto-tableau/Tableau/Tableau';
+
+jest.mock('@eeacms/volto-tableau/Tableau/Tableau', () =>
+  jest.fn(() => <div>Mocked Tableau</div>),
+);
+
+jest.mock('@plone/volto/registry', () => ({
+  blocks: {
+    blocksConfig: {
+      tableau_block: {
+        breakpoints: {},
+      },
+    },
+  },
+}));
+
+const mockStore = configureStore([]);
+
+describe('View component', () => {
+  let store;
+
+  beforeEach(() => {
+    store = mockStore({
+      router: {
+        location: {
+          search: '?param1=value1',
+        },
+      },
+      discodata_query: {
+        search: {},
+      },
+      screen: {},
+    });
+  });
+
+  it('renders correctly with title and description when loaded', () => {
+    const mockProps = {
+      block: '1234',
+      data: {
+        title: 'Test Title',
+        description: 'Test Description',
+        staticParameters: [],
+        urlParameters: [],
+      },
+      mode: 'view',
+      query: {},
+    };
+
+    render(
+      <Provider store={store}>
+        <View {...mockProps} />
+      </Provider>,
+    );
+
+    // Simulăm vizualizarea încărcată
+    const tableauBlock = screen.getByText('Mocked Tableau');
+    expect(tableauBlock).toBeInTheDocument();
+
+    // Verificăm titlul și descrierea
+    expect(screen.queryByText('Test Title')).not.toBeInTheDocument();
+    expect(screen.queryByText('Test Description')).not.toBeInTheDocument();
+
+    // Aici simulăm setVizState pentru a actualiza starea vizualizării ca fiind "loaded"
+    mockProps.setVizState = jest.fn((state) => {
+      state.loaded = true;
+    });
+
+    // Re-render după schimbarea stării
+    render(
+      <Provider store={store}>
+        <View {...mockProps} />
+      </Provider>,
+    );
+
+    expect(screen.getByText('Test Title')).toBeInTheDocument();
+    expect(screen.getByText('Test Description')).toBeInTheDocument();
+  });
+
+  it('sets extraFilters correctly based on query parameters', () => {
+    const mockProps = {
+      block: '1234',
+      data: {
+        staticParameters: [],
+        urlParameters: [{ field: 'filter1', urlParam: 'param1' }],
+      },
+      mode: 'view',
+      query: { param1: 'value1' },
+    };
+
+    render(
+      <Provider store={store}>
+        <View {...mockProps} />
+      </Provider>,
+    );
+
+    expect(Tableau).toHaveBeenCalledWith(
+      expect.objectContaining({
+        extraFilters: { filter1: 'value1' },
+      }),
+      {},
+    );
+  });
+
+  it('renders Tableau with correct props', () => {
+    const mockProps = {
+      block: '1234',
+      data: {
+        title: 'Test Title',
+        description: 'Test Description',
+        staticParameters: [{ field: 'static1', value: 'staticValue' }],
+        urlParameters: [],
+      },
+      mode: 'view',
+      query: {},
+    };
+
+    render(
+      <Provider store={store}>
+        <View {...mockProps} />
+      </Provider>,
+    );
+
+    expect(Tableau).toHaveBeenCalledWith(
+      expect.objectContaining({
+        data: expect.objectContaining({
+          title: 'Test Title',
+          description: 'Test Description',
+          with_sources: true,
+          with_download: true,
+          with_share: true,
+          with_enlarge: true,
+        }),
+        extraOptions: { static1: 'staticValue' },
+      }),
+      {},
+    );
+  });
+});

package/src/Widgets/VisualizationWidget.jsx

@@ -16,9 +16,21 @@ import {
 } from '@eeacms/volto-tableau/Tableau/helpers';
 
 import '@eeacms/volto-tableau/less/tableau.less';
+import { getBaseUrl } from '@plone/volto/helpers';
+
+function blobToBase64(blob) {
+  return new Promise((resolve, reject) => {
+    const reader = new FileReader();
+    reader.onloadend = () => {
+      resolve(reader.result);
+    };
+    reader.onerror = reject;
+    reader.readAsDataURL(blob);
+  });
+}
 
 const VisualizationWidget = (props) => {
-  const { location, content } = props;
+  const { location, content, onChange, id } = props;
   const ogValue = props.value || {};
   const inAddForm = props.location.pathname.split('/').pop() === 'add';
   const viz = React.useRef();
@@ -120,6 +132,29 @@ const VisualizationWidget = (props) => {
     );
   }, [vizState, value]);
 
+  React.useEffect(() => {
+    if (value && value.url && value.preview_url_loaded !== value.url) {
+      fetch(
+        `${getBaseUrl(
+          '',
+        )}/cors-proxy/https://screenshot.eea.europa.eu/api/v1/retrieve_image_for_url?url=${encodeURIComponent(
+          value.url,
+        )}&w=1920&h=1000&waitfor=4000`,
+      )
+        .then((e) => e.blob())
+        .then((myBlob) => {
+          blobToBase64(myBlob).then((base64String) => {
+            onChange(id, {
+              ...value,
+              preview: base64String,
+              preview_url_loaded: value.url,
+            });
+          });
+        })
+        .catch(() => {});
+    }
+  }, [value, onChange, id]);
+
   return (
     <FormFieldWrapper {...props}>
       <Modal id="tableau-editor-modal" open={open}>

package/src/Widgets/schema.js

@@ -41,7 +41,9 @@ async function getUrlParametersSchema({ viz, vizState, data }) {
 
 async function getStaticParametersSchema({ viz, vizState, data }) {
   const tableauParameters =
-    vizState.loaded && viz ? await viz.getWorkbook().getParametersAsync() : [];
+    vizState.loaded && viz
+      ? (await viz.getWorkbook?.().getParametersAsync?.()) || []
+      : [];
 
   const currentFields = (data.staticParameters || [])
     .map((p) => p.field)
@@ -75,7 +77,7 @@ async function getStaticParametersSchema({ viz, vizState, data }) {
 async function getDynamicFiltersSchema({ viz, vizState, data }) {
   const tableauFilters =
     vizState.loaded && viz
-      ? await viz.getWorkbook().getActiveSheet().getFiltersAsync()
+      ? (await viz.getWorkbook?.().getActiveSheet?.().getFiltersAsync?.()) || []
       : [];
 
   const currentFields = (data.staticFilters || [])
@@ -112,7 +114,7 @@ async function getDynamicFiltersSchema({ viz, vizState, data }) {
 async function getStaticFiltersSchema({ viz, vizState, data }) {
   const tableauFilters =
     vizState.loaded && viz
-      ? await viz.getWorkbook().getActiveSheet().getFiltersAsync()
+      ? (await viz.getWorkbook?.().getActiveSheet?.().getFiltersAsync?.()) || []
       : [];
 
   const currentFields = (data.staticFilters || [])

package/src/index.js

@@ -5,6 +5,7 @@ import {
   VisualizationViewWidget,
   CreatableSelectWidget,
 } from './Widgets';
+import { preview_image } from './middlewares/preview_image';
 
 const applyConfig = (config) => {
   config.settings.allowed_cors_destinations = [
@@ -12,7 +13,10 @@ const applyConfig = (config) => {
     'public.tableau.com',
   ];
 
-  config.settings.storeExtenders = [...(config.settings.storeExtenders || [])];
+  config.settings.storeExtenders = [
+    ...(config.settings.storeExtenders || []),
+    preview_image,
+  ];
 
   config.views.contentTypesViews.tableau_visualization = VisualizationView;
   config.widgets.id.tableau_visualization = VisualizationWidget;

package/src/middlewares/preview_image.js

@@ -0,0 +1,108 @@
+import {
+  CREATE_CONTENT,
+  UPDATE_CONTENT,
+} from '@plone/volto/constants/ActionTypes';
+
+export const preview_image = (middlewares) => [
+  (store) => (next) => (action) => {
+    if (![CREATE_CONTENT, UPDATE_CONTENT].includes(action.type)) {
+      return next(action);
+    }
+    const state = store.getState();
+    const contentData = state.content.data;
+    const lastPreviewImage = Object.keys(action?.request?.data).includes(
+      'preview_image',
+    )
+      ? action?.request?.data.preview_image
+      : contentData?.preview_image;
+    const type = action?.request?.data?.['@type'] || contentData['@type'];
+    if (
+      !contentData ||
+      type !== 'tableau_visualization' ||
+      contentData.preview_image_saved ||
+      !action?.request?.data?.tableau_visualization?.preview
+    ) {
+      return next(action);
+    }
+
+    if (
+      lastPreviewImage &&
+      lastPreviewImage !== 'preview_image_generated_tableau_visualization.png'
+    ) {
+      if (action?.request?.data?.tableau_visualization) {
+        const tableauVisualizationData = {
+          ...action.request.data.tableau_visualization,
+        };
+
+        if (
+          tableauVisualizationData.preview &&
+          tableauVisualizationData.preview_url_loaded
+        )
+          delete tableauVisualizationData.preview;
+        delete tableauVisualizationData.preview_url_loaded;
+
+        return next({
+          ...action,
+          request: {
+            ...action.request,
+            data: {
+              ...action.request.data,
+
+              tableau_visualization: tableauVisualizationData,
+            },
+          },
+        });
+      } else return next(action);
+    }
+
+    try {
+      const previewImage = {
+        preview_image: {
+          data: action.request.data.tableau_visualization.preview.split(',')[1],
+          encoding: 'base64',
+          'content-type': 'image/png',
+          filename: 'preview_image_generated_tableau_visualization.png',
+        },
+        preview_image_saved: true,
+      };
+
+      const tableauVisualizationData = {
+        ...action.request.data.tableau_visualization,
+      };
+      delete tableauVisualizationData.preview;
+      delete tableauVisualizationData.preview_url_loaded;
+
+      return next({
+        ...action,
+        request: {
+          ...action.request,
+          data: {
+            ...action.request.data,
+            ...previewImage,
+            tableau_visualization: tableauVisualizationData,
+          },
+        },
+      });
+    } catch (error) {
+      if (action.request.data.tableau_visualization.preview) {
+        const tableauVisualizationData = {
+          ...action.request.data.tableau_visualization,
+        };
+        delete tableauVisualizationData.preview;
+        delete tableauVisualizationData.preview_url_loaded;
+
+        return next({
+          ...action,
+          request: {
+            ...action.request,
+            data: {
+              ...action.request.data,
+              tableau_visualization: tableauVisualizationData,
+            },
+          },
+        });
+      } else return next(action);
+    }
+  },
+  ...middlewares,
+];

package/src/middlewares/preview_image.test.js

@@ -0,0 +1,30 @@
+import { preview_image } from './preview_image';
+describe('preview_image middleware', () => {
+  let store;
+  let next;
+  let action;
+  let middlewares;
+
+  beforeEach(() => {
+    store = {
+      getState: jest.fn(() => ({
+        content: {
+          data: {
+            '@type': 'tableau_visualization',
+            preview_image: 'existing_image.png',
+            preview_image_saved: false,
+          },
+        },
+      })),
+    };
+    next = jest.fn();
+    middlewares = [];
+  });
+
+  it('should pass through if action type is not CREATE_CONTENT or UPDATE_CONTENT', () => {
+    action = { type: 'UPDATE_CONTENT', request: { data: {} } };
+    const middleware = preview_image(middlewares)[0]; // Accesăm prima funcție din array
+    middleware(store)(next)(action); // Executăm funcția de middleware
+    expect(next).toHaveBeenCalledWith(action); // Verificăm că funcția next a fost apelată cu acțiunea originală
+  });
+});