@vegan-friendly/strapi-plugin-elasticsearch 0.0.11-alpha.6 → 0.1.0-alpha.0

package/admin/src/pages/ConfigureCollectionList/index.js

@@ -0,0 +1,266 @@
+/*
+ *
+ * HomePage
+ *
+ */
+
+import React, { useState } from 'react';
+// import PropTypes from 'prop-types';
+import pluginId from '../../pluginId';
+import  { SubNavigation } from '../../components/SubNavigation';;
+import { Box, Flex } from '@strapi/design-system';
+import { useEffect } from 'react';
+import { Loader } from '@strapi/design-system';
+import { apiGetContentConfig, apiRequestCollectionIndexing,
+        apiImportContentConfig, apiExportContentConfig } from "../../utils/apiUrls";
+import axiosInstance  from '../../utils/axiosInstance';
+import { Alert } from '@strapi/design-system';
+import { Table, Thead, Tbody, Tr, Td, Th } from '@strapi/design-system';
+import { Typography } from '@strapi/design-system';
+import { Pencil, Server } from '@strapi/icons';
+import { IconButton } from '@strapi/design-system';
+import { useHistory } from "react-router-dom";
+import { Button } from '@strapi/design-system';
+import { ModalLayout, ModalBody, ModalHeader, ModalFooter } from '@strapi/design-system';
+import { Textarea, TwoColsLayout, Divider } from '@strapi/design-system';
+import {LoadingIndicatorPage, useNotification} from '@strapi/helper-plugin';
+
+const exportContentConfig = () => {
+  return axiosInstance.get(apiGetContentConfig,
+    {
+      responseType: 'blob'
+    })
+    .then((response) => {
+      const href = URL.createObjectURL(response.data);
+      const link = document.createElement('a');
+      link.href = href;
+      link.setAttribute('download', 'strapi-plugin-elasticsearch-contentconfig.json'); 
+      document.body.appendChild(link);
+      link.click();
+      document.body.removeChild(link);
+      URL.revokeObjectURL(href);
+  });
+}
+
+const importContentConfig = (conf) => {
+  return axiosInstance.post(apiImportContentConfig, {
+    data : conf
+  });
+}
+
+const loadContentConfig = () => {
+  return axiosInstance.get(apiGetContentConfig)
+      .then((resp) => resp.data);
+} 
+
+const scheduleCollectionIndexing = (collectionName) => {
+  return axiosInstance.get(apiRequestCollectionIndexing(collectionName))
+}
+
+const Configure = () => {
+  const [isInProgress, setIsInProgress] = useState(false);
+  const [displayImportModal, setDisplayImportModal] = useState(false);
+  const [isEnteredJsonValid, setIsEnteredJsonValid] = useState(true);
+  const [importJson, setImportJson] = useState(null);
+
+  const [config, setConfig] = useState(null);
+  const history = useHistory();
+  const toggleNotification = useNotification();
+
+  const performImport = () => {
+    const conf = importJson
+    console.log(conf && conf.length > 0)
+    if (conf && conf.length > 0) {
+      setIsInProgress(true);
+      importContentConfig(conf)
+      .then(() => {
+        toggleNotification({
+          type: "success", message: "Collections configuration imported. Please refresh this view.", timeout: 5000
+        });
+      })
+      .catch((err) => {
+        toggleNotification({
+          type: "warning", message: "Importing collections configuration failed. An error was encountered.", timeout: 5000
+        });
+        console.log(err);
+      })
+      .finally(() => setIsInProgress(false));
+    }
+  }
+  const performExport = () => {
+    setIsInProgress(true);
+    exportContentConfig()
+    .then(() => {
+      toggleNotification({
+        type: "success", message: "Collections configuration exported.", timeout: 5000
+      });
+    })
+    .catch((err) => {
+      toggleNotification({
+        type: "warning", message: "Exporting collections configuration failed. An error was encountered.", timeout: 5000
+      });
+      console.log(err);
+    })
+    .finally(() => setIsInProgress(false));
+  }
+
+  useEffect(() => {
+    if (importJson && importJson.length > 0)
+    {
+      try {
+        JSON.parse(importJson);
+        setIsEnteredJsonValid(true);
+      } catch (e) {
+          setIsEnteredJsonValid(false);
+      }
+    }
+  }, [importJson]);
+
+  useEffect(() => {
+    setIsInProgress(true);
+    loadContentConfig()
+    .then((resp) => {
+      const displayConfig = [];
+      for (let r=0; r < Object.keys(resp).length; r++)
+      {
+        const item = {collectionName: Object.keys(resp)[r], indexed: [], notIndexed: []};
+        const collectionName = item.collectionName;
+        for (let k=0; k < Object.keys(resp[collectionName]).length; k++)
+        {
+          const attribs = resp[collectionName];
+          for (let s=0; s < Object.keys(attribs).length; s++)
+          {
+            const attrName = Object.keys(attribs)[s]
+            const attr = attribs[attrName]
+            if (attr.index === false && !item.notIndexed.includes(attrName))
+              item.notIndexed.push(attrName)
+            else if (attr.index && !item.indexed.includes(attrName))
+              item.indexed.push(attrName)
+          }
+        }
+        displayConfig.push(item);
+      }
+      setConfig(displayConfig);
+    })
+    .catch((err) => {
+      toggleNotification({
+        type: "warning", message: "An error was encountered while fetching the configuration.", timeout: 5000
+      });
+      console.log(err);
+    })
+    .finally (() => {
+      setIsInProgress(false);
+    })
+  }, []);
+  if (config === null)
+    return <LoadingIndicatorPage />;
+  else
+  {
+    return (
+      <>
+      <Flex alignItems="stretch" gap={4}>
+        <SubNavigation activeUrl={'/configure-collections/'}/>
+          <Box padding={8} background="neutral100">
+            <Box paddingBottom={4}>
+              <Typography variant="alpha">Configure Collections</Typography>
+            </Box>
+            {
+              config && (
+                <TwoColsLayout startCol={
+                <Table colCount={4} rowCount={config.length}>
+                  <Thead>
+                    <Tr>
+                      <Th style={{width: "250px"}}>
+                        <Typography variant="sigma">Collection</Typography>
+                      </Th>
+                      <Th style={{width: "250px"}}>
+                        <Typography variant="sigma">Index</Typography>
+                      </Th>
+                      <Th style={{width: "250px"}}>
+                        <Typography variant="sigma">Do not Index</Typography>
+                      </Th> 
+                      <Th>
+                        <Typography variant="sigma">Actions</Typography>
+                      </Th>
+                    </Tr>
+                  </Thead>
+                  <Tbody>
+                    {
+                      config.map((collection, idx) => {
+                        return (
+                          <Tr key={idx}>
+                            <Td>
+                              <Typography textColor="neutral600">{collection.collectionName}
+                              </Typography>
+                            </Td>
+                            <Td>
+                              {collection.indexed.map((i) =>
+                                <Box paddingBottom={2}>
+                                  <Typography textColor="neutral600">{i}
+                                  </Typography></Box>
+                              )}
+                            </Td>
+                            <Td>
+                              {collection.notIndexed.map((i) =>
+                                <Box paddingBottom={2}>
+                                  <Typography textColor="neutral600">{i}
+                                </Typography></Box>
+                              )}
+                            </Td>    
+                            <Td>
+                              <IconButton onClick={() => history.push(`/plugins/${pluginId}/configure-collections/${collection.collectionName}`)} label="Edit collection configuration" noBorder icon={<Pencil />} />  
+                              <IconButton onClick={() => scheduleCollectionIndexing(collection.collectionName)} label="Schedule indexing for all items in this collection" noBorder icon={<Server />} />  
+                            </Td>                  
+                          </Tr>
+                        );
+                      })
+                    }
+                  </Tbody>
+                </Table>}
+                endCol={<>
+                  <Box paddingLeft={2} paddingRight={2} paddingTop={4} paddingBottom={4} >
+                      <Box paddingTop={4} paddingBottom={4}>
+                          <Typography variant="pi" fontWeight="bold" textColor="neutral600" >CONFIG ACTIONS</Typography>
+                      </Box>
+                      <Divider />
+                      <Box paddingTop={4} paddingBottom={4}>
+                          <Box paddingTop={2} paddingBottom={2}>
+                              <Button loading={isInProgress} fullWidth variant="secondary" onClick={performExport}>Export</Button>
+                          </Box>
+                          <Box paddingTop={2} paddingBottom={2}>
+                              <Button loading={isInProgress} fullWidth variant="secondary" onClick={() => setDisplayImportModal(true)}>Import</Button>
+                          </Box>
+                      </Box>
+                  </Box>
+                  </>
+                  } />
+              )
+            }          
+            {displayImportModal && 
+              <ModalLayout onClose={() => setDisplayImportModal(false)} labelledBy="title">
+              <ModalHeader>
+              <Typography fontWeight="bold" textColor="neutral800" as="h2" id="title">
+                Import Search Configuration
+              </Typography>
+            </ModalHeader>
+            <ModalBody>
+              <Textarea 
+              label="Configuration Json" 
+              error={!isEnteredJsonValid ? 'Invalid Json' : undefined}
+              onChange={e => setImportJson(e.target.value)}
+              >{importJson}</Textarea>
+            </ModalBody>
+            <ModalFooter startActions={<Button onClick={() => setDisplayImportModal(false)} variant="tertiary">
+                  Cancel
+                </Button>} endActions={<>
+                  <Button loading={isInProgress} onClick={performImport} disabled={!isEnteredJsonValid && !importJson.length>0}>Import</Button>
+                </>} />
+          </ModalLayout>}
+          </Box>
+          </Flex>
+      </>
+    );
+  }
+};
+
+export default Configure;

package/admin/src/pages/Homepage/index.js

@@ -0,0 +1,168 @@
+import React, { useState, useEffect } from 'react';
+import  { SubNavigation } from '../../components/SubNavigation';;
+import { Box, Flex, Tab } from '@strapi/design-system';
+import { Typography } from '@strapi/design-system';
+import { apiGetElasticsearchSetupInfo, apiRequestReIndexing,
+    apiTriggerIndexing } from '../../utils/apiUrls';
+import axiosInstance  from '../../utils/axiosInstance';
+import { IconButton } from '@strapi/design-system';
+import { Table, Tr, Td } from '@strapi/design-system';
+import { Refresh } from '@strapi/icons';
+import { TwoColsLayout, Button } from '@strapi/design-system';
+import { Grid, GridItem, Divider } from '@strapi/design-system';
+import {LoadingIndicatorPage, useNotification} from '@strapi/helper-plugin';
+
+const loadElasticsearchSetupInfo = () => {
+    return axiosInstance.get(apiGetElasticsearchSetupInfo)
+        .then((resp) => resp.data)
+        .then((data) => {
+          return data;
+        });
+}
+
+const Homepage = () => {
+    const [setupInfo, setSetupInfo] = useState(null);
+    const [isInProgress, setIsInProgress] = useState(false);
+    const toggleNotification = useNotification();
+
+    const displayLabels = {'connected' : 'Connected',
+        'elasticCertificate' : 'Certificate',
+        'elasticHost' : 'Elasticsearch host',
+        'elasticIndexAlias' : 'Elasticsearch index Alias name',
+        'elasticUserName' : 'Elasticsearch username',
+        'indexingCronSchedule' : 'Indexing cron schedule',
+        'initialized' : 'Elasticsearch configuration loaded'};
+
+    const reloadElasticsearchSetupInfo = ({showNotification}) => {
+        setIsInProgress(true);
+        loadElasticsearchSetupInfo()
+        .then(setSetupInfo)
+        .then(() => {
+            if (showNotification)
+                toggleNotification({
+                    type: "success", message: "Elasticsearch setup information reloaded.", timeout: 5000
+                });
+        })
+        .finally(() => setIsInProgress(false));
+    }
+
+    const requestFullSiteReindexing = () => {
+        setIsInProgress(true);
+        return axiosInstance.get(apiRequestReIndexing)
+            .then(() => {
+                toggleNotification({
+                    type: "success", message: "Rebuilding the index is triggered.", timeout: 5000
+                });
+            })
+            .catch(() => {
+                toggleNotification({
+                    type: "warning", message: "An error was encountered.", timeout: 5000
+                });
+            })
+            .finally(() => setIsInProgress(false));
+    }
+
+    const triggerIndexingRun = () => {
+        setIsInProgress(true);
+        return axiosInstance.get(apiTriggerIndexing)
+        .then(() => {
+            toggleNotification({
+                type: "success", message: "The indexing job to process the pending tasks is started.", timeout: 5000
+            });
+        })
+        .catch(() => {
+            toggleNotification({
+                type: "warning", message: "An error was encountered.", timeout: 5000
+            });
+        })
+        .finally(() => setIsInProgress(false));
+    }
+    useEffect(() => {
+        reloadElasticsearchSetupInfo({showNotification: false});
+    }, []);
+
+    if (setupInfo === null)
+        return <LoadingIndicatorPage />
+    else
+        return (
+        <Flex alignItems="stretch" gap={4}>
+        <SubNavigation />
+        <Box padding={8} background="neutral100" width="100%">
+        <Box paddingBottom={4}>
+            <Typography variant="alpha">Setup Information</Typography>
+        </Box>   
+        <Box  width="100%" paddingBottom={4}>
+            <TwoColsLayout startCol={
+                <>
+            <Table>
+            {
+                setupInfo && (
+                    Object.keys(setupInfo).map((k, idx) => {
+                        return (
+                            <Tr key={idx}>
+                                <Td><Box padding={2}>
+                                    <Typography textColor="neutral600">{displayLabels[k]} :</Typography>
+                                </Box></Td>
+                                <Td>
+                                    <Box padding={2}>
+                                    <Grid>
+                                        <GridItem padding={2}>
+                                            { 
+                                                k === 'connected' && setupInfo[k] === true && 
+                                                (
+                                                    <Typography fontWeight="bold" textColor="success500">Yes</Typography>
+                                                )
+                                            }
+                                            { 
+                                                k === 'connected' && setupInfo[k] === false && 
+                                                (
+                                                    <Typography fontWeight="bold" textColor="danger500">No</Typography>
+                                                )
+                                            }
+                                            {
+                                                k !== 'connected' && 
+                                                (
+                                                    <Typography textColor="neutral600">{String(setupInfo[k])}</Typography>
+                                                )
+                                            }
+                                        </GridItem>
+                                        <GridItem padding={1}>
+                                            {
+                                                k === 'connected' ?
+                                                <IconButton disabled={isInProgress} onClick={() => reloadElasticsearchSetupInfo({showNotification: true})} label="Refresh" icon={<Refresh />} /> : null                                            
+                                            }
+                                        </GridItem>
+                                    </Grid>
+                                    </Box>
+                                </Td>
+                            </Tr>
+                        );
+                    })
+                )
+            }
+            </Table></>}
+            endCol={<>
+            <Box paddingLeft={2} paddingRight={2} paddingTop={4} paddingBottom={4} >
+                <Box paddingTop={4} paddingBottom={4}>
+                    <Typography variant="pi" fontWeight="bold" textColor="neutral600" >ACTIONS</Typography>
+                </Box>
+                <Divider />
+                <Box paddingTop={4} paddingBottom={4}>
+                    <Box paddingTop={2} paddingBottom={2}>
+                        <Button loading={isInProgress} fullWidth variant="secondary" onClick={requestFullSiteReindexing}>Rebuild Index</Button>
+                    </Box>
+                    <Box paddingTop={2} paddingBottom={2}>
+                        <Button loading={isInProgress} fullWidth variant="secondary" onClick={triggerIndexingRun}>Trigger Indexing</Button>
+                    </Box>
+                </Box>
+            </Box>
+            </>
+            } />
+        </Box>
+        </Box>
+        </Flex>
+        );
+};
+
+
+export default Homepage;

package/admin/src/pages/ViewIndexingRunLog/index.js

@@ -0,0 +1,124 @@
+/*
+ *
+ * HomePage
+ *
+ */
+
+import React, { useState, useEffect } from 'react';
+// import PropTypes from 'prop-types';
+import pluginId from '../../pluginId';
+import  { SubNavigation } from '../../components/SubNavigation';;
+import { Box, Flex } from '@strapi/design-system';
+import { apiFetchRecentIndexingRunLog } from "../../utils/apiUrls";
+import axiosInstance  from '../../utils/axiosInstance';
+import { Table, Thead, Tbody, Tr, Td, Th } from '@strapi/design-system';
+import { Typography } from '@strapi/design-system';
+import {LoadingIndicatorPage} from '@strapi/helper-plugin';
+
+const loadRecentIndexingRuns = () => {
+  return axiosInstance.get(apiFetchRecentIndexingRunLog)
+      .then((resp) => resp.data)
+      .then((data) => {
+        return data;
+      });
+} 
+
+const formattedDate = (dateString) => {
+  const date = new Date(dateString);
+  const options = {
+    weekday: 'long',
+    year: 'numeric',
+    month: 'numeric',
+    day: 'numeric',
+    hour: 'numeric',
+    minute: 'numeric',
+  };
+  
+  const dateTimeFormat = new Intl.DateTimeFormat('en-US', options);
+  const parts = dateTimeFormat.formatToParts(date);
+  
+  let formattedDate = '';
+  parts.forEach((part) => {
+      if (part.type === "weekday") 
+          formattedDate+= `${part.value}, `;
+       if (part.type === "day") 
+          formattedDate+= `${part.value}/`;   
+       if (part.type === "month") 
+          formattedDate+= `${part.value}/`;  
+       if (part.type === "year") 
+          formattedDate+= `${part.value}  `;
+       if (part.type === "hour") 
+          formattedDate+= `${part.value}:`;
+       if (part.type === "minute") 
+          formattedDate+= `${part.value}`;         
+  });
+
+  return formattedDate;
+}
+
+const ViewIndexingRunLog = () => {
+  const [logTable, setLogTable] = useState(null);
+  useEffect(() => {
+    loadRecentIndexingRuns()
+    .then(setLogTable)
+    }, []);
+  
+  if (logTable === null)
+        return <LoadingIndicatorPage />
+  else
+    return (
+        <Flex alignItems="stretch" gap={4}>
+            <SubNavigation />
+            <Box padding={8} background="neutral100" width="100%">
+              <Box paddingBottom={4}>
+                <Typography variant="alpha">Recent Indexing Run Logs</Typography>
+              </Box>
+              {
+                logTable && logTable.length > 0 && (
+                  <>
+                    <Table colCount={3} rowCount={logTable.length}>
+                      <Thead>
+                        <Tr>
+                          <Th>
+                            <Typography variant="sigma">Date</Typography>
+                          </Th>
+                          <Th>
+                            <Typography variant="sigma">Status</Typography>
+                          </Th>
+                          <Th>
+                            <Typography variant="sigma">Details</Typography>
+                          </Th>
+                        </Tr>
+                      </Thead>
+                      <Tbody>
+                      {
+                        logTable.map((data, index) => {
+                          return (
+                            <Tr key={index}>
+                              <Td>
+                                <Typography textColor="neutral600">{formattedDate(data.createdAt)}</Typography>
+                              </Td>
+                              <Td>
+                                <Typography textColor="neutral600">{data.status}</Typography>
+                              </Td>
+                              <Td>
+                                <Typography textColor="neutral600">{data.details}</Typography>
+                              </Td>                                 
+                            </Tr>
+                          );
+                        })
+                      }
+                      </Tbody>
+                    </Table>
+                    <Box paddingTop={2} paddingBottom={2}>
+                      <Typography textColor="neutral600">This view lists the details of the 50 recent-most indexing runs.</Typography>
+                    </Box>
+                  </>
+                )
+              }
+            </Box>    
+        </Flex>
+  );
+};
+
+export default ViewIndexingRunLog;

package/admin/src/pluginId.js

@@ -0,0 +1,5 @@
+import pluginPkg from '../../package.json';
+
+const pluginId = pluginPkg.strapi.name;
+
+export default pluginId;

package/admin/src/translations/en.json

@@ -0,0 +1 @@
+{}

package/admin/src/translations/fr.json

@@ -0,0 +1 @@
+{}

package/admin/src/utils/apiUrls.js

@@ -0,0 +1,14 @@
+import { collectionName } from "../../../server/content-types/tasks";
+import pluginId from "../pluginId";
+export const apiGetContentConfig = `/${pluginId}/content-config/`
+export const apiGetCollectionConfig = (collectionName) => `/${pluginId}/collection-config/${collectionName}`
+export const apiSaveCollectionConfig = (collectionName) => `/${pluginId}/collection-config/${collectionName}`
+export const apiGetElasticsearchSetupInfo = `/${pluginId}/setup-info`
+export const apiFetchRecentIndexingRunLog = `/${pluginId}/indexing-run-log`
+export const apiRequestReIndexing = `/${pluginId}/reindex`
+export const apiRequestCollectionIndexing = (collectionName) => `/${pluginId}/collection-reindex/${collectionName}`
+export const apiTriggerIndexing = `/${pluginId}/trigger-indexing/`
+
+export const apiExportContentConfig = `/${pluginId}/export-content-config/`
+export const apiImportContentConfig = `/${pluginId}/import-content-config/`
+

package/admin/src/utils/axiosInstance.js

@@ -0,0 +1,40 @@
+/**
+ * axios with a custom config.
+ */
+
+import axios from 'axios';
+import { auth } from '@strapi/helper-plugin';
+
+const instance = axios.create({
+  baseURL: process.env.STRAPI_ADMIN_BACKEND_URL,
+});
+
+instance.interceptors.request.use(
+  async config => {
+    config.headers = {
+      Authorization: `Bearer ${auth.getToken()}`,
+      Accept: 'application/json',
+      'Content-Type': 'application/json',
+    };
+
+    return config;
+  },
+  error => {
+    Promise.reject(error);
+  }
+);
+
+instance.interceptors.response.use(
+  response => response,
+  error => {
+    // whatever you want to do with the error
+    if (error.response?.status === 401) {
+      auth.clearAppStorage();
+      window.location.reload();
+    }
+
+    throw error;
+  }
+);
+
+export default instance;

package/admin/src/utils/getTrad.js

@@ -0,0 +1,5 @@
+import pluginId from '../pluginId';
+
+const getTrad = (id) => `${pluginId}.${id}`;
+
+export default getTrad;