@vegan-friendly/strapi-plugin-elasticsearch 0.0.8

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;

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@vegan-friendly/strapi-plugin-elasticsearch",
+  "version": "0.0.8",
+  "description": "A Strapi plugin to enable using Elasticsearch with Strapi CMS.",
+  "homepage": "https://github.com/vegan-friendly/strapi-plugin-elasticsearch",
+  "strapi": {
+    "name": "elasticsearch",
+    "description": "A plugin to enable using Elasticsearch with Strapi CMS.",
+    "kind": "plugin",
+    "displayName": "Strapi <-> Elasticsearch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/vegan-friendly/strapi-plugin-elasticsearch.git"
+  },
+  "author": {
+    "name": "Punit Sethi",
+    "email": "punit@tezify.com",
+    "url": "https://punits.dev"
+  },
+  "dependencies": {
+    "@elastic/elasticsearch": "^8.9.0",
+    "markdown-to-txt": "^2.0.1"
+  },
+  "peerDependencies": {
+    "@strapi/strapi": "^4.0.0"
+  },
+  "maintainers": [
+    {
+      "name": "Punit Sethi",
+      "email": "punit@tezify.com",
+      "url": "https://punits.dev"
+    }
+  ],
+  "engines": {
+    "node": ">=16.0.0 <=20.x.x",
+    "npm": ">=6.0.0"
+  },
+  "license": "MIT"
+}

package/server/bootstrap.js

@@ -0,0 +1,142 @@
+'use strict';
+
+module.exports = async ({ strapi }) => {
+    const pluginConfig = await strapi.config.get('plugin.elasticsearch');
+    const configureIndexingService = strapi.plugins['elasticsearch'].services.configureIndexing;
+    const scheduleIndexingService = strapi.plugins['elasticsearch'].services.scheduleIndexing;
+    const esInterface = strapi.plugins['elasticsearch'].services.esInterface;
+    const indexer = strapi.plugins['elasticsearch'].services.indexer;
+    const helper = strapi.plugins['elasticsearch'].services.helper; 
+    try
+    {
+      await configureIndexingService.initializeStrapiElasticsearch();
+    
+      if (!Object.keys(pluginConfig).includes('indexingCronSchedule'))
+        console.warn("The plugin strapi-plugin-elasticsearch is enabled but the indexingCronSchedule is not configured.");
+      else if (!Object.keys(pluginConfig).includes('searchConnector'))
+        console.warn("The plugin strapi-plugin-elasticsearch is enabled but the searchConnector is not configured.");
+      else
+      {
+        const connector = pluginConfig['searchConnector'];
+        await esInterface.initializeSearchEngine({host : connector.host, uname: connector.username, 
+              password: connector.password, cert: connector.certificate});
+        strapi.cron.add({
+          elasticsearchIndexing: {
+            task: async ({ strapi }) => {
+              await indexer.indexPendingData();
+            },
+            options: {
+              rule: pluginConfig['indexingCronSchedule'],
+            },
+          },
+        });   
+        
+        if (await esInterface.checkESConnection())
+        {
+          //Attach the alias to the current index:
+          const idxName = await helper.getCurrentIndexName();
+          await esInterface.attachAliasToIndex(idxName);
+        }
+          
+      }
+  
+      strapi.db.lifecycles.subscribe(async (event) => {
+        if (event.action === 'afterCreate' || event.action === 'afterUpdate') {
+          if (strapi.elasticsearch.collections.includes(event.model.uid))
+          {
+            //collection without draft-publish
+            if (typeof event.model.attributes.publishedAt === "undefined")
+            {
+              await scheduleIndexingService.addItemToIndex({
+                collectionUid: event.model.uid,
+                recordId: event.result.id
+              });  
+            }
+            else if (event.model.attributes.publishedAt)
+            {
+              if (event.result.publishedAt)
+              {
+                await scheduleIndexingService.addItemToIndex({
+                  collectionUid: event.model.uid,
+                  recordId: event.result.id
+                });    
+              }
+              else
+              {
+                //unpublish
+                await scheduleIndexingService.removeItemFromIndex({
+                  collectionUid: event.model.uid,
+                  recordId: event.result.id
+                });    
+              }
+            }
+          }
+        }
+        //bulk publish-unpublish from list view
+        if (event.action === 'afterCreateMany' || event.action === 'afterUpdateMany') {
+          if (strapi.elasticsearch.collections.includes(event.model.uid))
+          {
+            if (Object.keys(event.params.where.id).includes('$in'))
+            {
+              const updatedItemIds = event.params.where.id['$in']
+              //bulk unpublish
+              if (typeof event.params.data.publishedAt === "undefined" || 
+                event.params.data.publishedAt === null)
+                {
+                  for (let k = 0; k< updatedItemIds.length; k++)
+                  {
+                    await scheduleIndexingService.removeItemFromIndex({
+                      collectionUid: event.model.uid,
+                      recordId: updatedItemIds[k]
+                    });            
+                  }    
+                }
+              else
+              {
+                for (let k = 0; k< updatedItemIds.length; k++)
+                {
+                  await scheduleIndexingService.addItemToIndex({
+                    collectionUid: event.model.uid,
+                    recordId: updatedItemIds[k]
+                  });   
+                }
+              }
+            }
+          }
+        }    
+        if (event.action === 'afterDelete') {
+          if (strapi.elasticsearch.collections.includes(event.model.uid))
+          {
+            await scheduleIndexingService.removeItemFromIndex({
+              collectionUid: event.model.uid,
+              recordId: event.result.id
+            });  
+          }
+        }
+        if (event.action === 'afterDeleteMany') {
+          if (strapi.elasticsearch.collections.includes(event.model.uid))
+          {
+            if (Object.keys(event.params.where).includes('$and') &&
+            Array.isArray(event.params.where['$and']) &&
+            Object.keys(event.params.where['$and'][0]).includes('id') && 
+            Object.keys(event.params.where['$and'][0]['id']).includes('$in'))
+            {
+              const deletedItemIds = event.params.where['$and'][0]['id']['$in']
+              for (let k = 0; k< deletedItemIds.length; k++)
+              {
+                await scheduleIndexingService.removeItemFromIndex({
+                  collectionUid: event.model.uid,
+                  recordId: deletedItemIds[k]
+                });            
+              }
+            }        
+          }
+        }
+      });   
+      configureIndexingService.markInitialized(); 
+    }
+    catch(err) {
+      console.error('An error was encountered while initializing the strapi-plugin-elasticsearch plugin.')
+      console.error(err);
+    }  
+};

package/server/config/index.js

@@ -0,0 +1,6 @@
+'use strict';
+
+module.exports = {
+  default: {},
+  validator() {},
+};

package/server/content-types/index.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const task = require('./tasks');
+const indexingLog = require('./indexing-logs');
+
+module.exports = {
+    'task' : {schema : task},
+    'indexing-log' : {schema: indexingLog}
+};

package/server/content-types/indexing-logs.js

@@ -0,0 +1,35 @@
+module.exports = {
+    "kind": "collectionType",
+    "collectionName": "indexing-log",
+    "info": {
+      "singularName": "indexing-log",
+      "pluralName": "indexing-logs",
+      "displayName": "Indexing Logs",
+      "description": "Logged runs of the indexing cron job"
+    },
+    "options": {
+      "draftAndPublish": false
+    },
+    "pluginOptions": {
+      'content-manager': {
+        visible: false,
+      },
+      'content-type-builder': {
+        visible: false,
+      }        
+    },
+    "attributes": {
+      "status": {
+        "type": "enumeration",
+        "enum": [
+          "pass",
+          "fail"
+        ],
+        "required": true
+      },
+      "details": {
+        "type": "text"
+      }  
+    }
+  }
+  

package/server/content-types/tasks.js

@@ -0,0 +1,52 @@
+module.exports = {
+    "kind": "collectionType",
+    "collectionName": "task",
+    "info": {
+      "singularName": "task",
+      "pluralName": "tasks",
+      "displayName": "Task",
+      "description": "Search indexing tasks"
+    },
+    "options": {
+      "draftAndPublish": false
+    },
+    "pluginOptions": {
+        'content-manager': {
+            visible: false,
+          },
+          'content-type-builder': {
+            visible: false,
+          }        
+    },
+    "attributes": {
+      "collection_name": {
+        "type": "string",
+        "required": true
+      },
+      "item_id": {
+        "type": "integer"
+      },
+      "indexing_status": {
+        "type": "enumeration",
+        "enum": [
+          "to-be-done",
+          "done"
+        ],
+        "required": true,
+        "default": "to-be-done"
+      },
+      "full_site_indexing": {
+        "type": "boolean"
+      },
+      "indexing_type": {
+        "type": "enumeration",
+        "enum": [
+          "add-to-index",
+          "remove-from-index"
+        ],
+        "default": "add-to-index",
+        "required": true
+      }
+    }
+  }
+  

package/server/controllers/configure-indexing.js

@@ -0,0 +1,66 @@
+'use strict';
+
+
+
+module.exports = ({ strapi }) => {
+  const configureIndexingService = strapi.plugins['elasticsearch'].services.configureIndexing;
+
+  const getContentConfig = async (ctx) => {
+    return configureIndexingService.getContentConfig();
+  };
+
+  const saveCollectionConfig = async (ctx) => {
+    const { body } = ctx.request;
+    try {
+      const updatedConfig = await configureIndexingService.setContentConfig({collection: ctx.params.collectionname, config : body.data});
+      return updatedConfig;
+    } catch (err) {
+      ctx.throw(500, err);
+    }
+  };
+  
+  const importContentConfig = async (ctx) => {
+    const { body } = ctx.request;
+    try {
+      if (body['data'])
+      {
+        const updatedConfig = await configureIndexingService.importContentConfig({config : body['data']});
+        return updatedConfig;  
+      }
+      else
+        ctx.throw(400, 'Invalid parameters')
+    } catch (err) {
+      ctx.throw(500, err);
+    }    
+  }
+
+  const exportContentConfig = async (ctx) => {
+    return configureIndexingService.getContentConfig();
+  }
+
+  const setContentConfig = async (ctx) => {
+    const { body } = ctx.request;
+    try {
+        const updatedConfig = await configureIndexingService.setContentConfig({config : body});
+        return updatedConfig;
+      } catch (err) {
+        ctx.throw(500, err);
+      }    
+  }
+
+  const getCollectionConfig = async (ctx) => {
+    if (ctx.params.collectionname)
+      return configureIndexingService.getCollectionConfig({collectionName: ctx.params.collectionname})
+    else
+      return null;
+  }
+
+  return {
+    getContentConfig,
+    setContentConfig,
+    getCollectionConfig,
+    saveCollectionConfig,
+    exportContentConfig, 
+    importContentConfig
+  };  
+};

package/server/controllers/index.js

@@ -0,0 +1,15 @@
+'use strict';
+
+const configureIndexing = require('./configure-indexing');
+const performSearch = require('./perform-search');
+const logIndexing = require('./log-indexing');
+const setupInfo = require('./setup-info');
+const performIndexing = require('./perform-indexing');
+
+module.exports = {
+  configureIndexing,
+  performSearch,
+  logIndexing,
+  setupInfo,
+  performIndexing
+};

package/server/controllers/log-indexing.js

@@ -0,0 +1,11 @@
+
+module.exports = ({ strapi }) => {
+    const logIndexingService = strapi.plugins['elasticsearch'].services.logIndexing;
+    const fetchRecentRunsLog = async (ctx) => {
+        return await logIndexingService.fetchIndexingLogs();
+    }
+
+    return {
+        fetchRecentRunsLog
+    };
+}

package/server/controllers/perform-indexing.js

@@ -0,0 +1,28 @@
+'use strict';
+
+
+
+module.exports = ({ strapi }) => {
+    const indexer = strapi.plugins['elasticsearch'].services.indexer;
+    const scheduleIndexingService = strapi.plugins['elasticsearch'].services.scheduleIndexing;
+    const rebuildIndex = async (ctx) => {
+        return await indexer.rebuildIndex();
+    }
+
+    const indexCollection = async (ctx) => {
+        if (ctx.params.collectionname)
+            return await scheduleIndexingService.addCollectionToIndex({collectionUid: ctx.params.collectionname})
+        else
+            return null;
+    }
+
+    const triggerIndexingTask = async (ctx) => {
+        return await indexer.indexPendingData()
+    }
+
+    return {
+        rebuildIndex,
+        indexCollection,
+        triggerIndexingTask
+    };     
+}

package/server/controllers/perform-search.js

@@ -0,0 +1,31 @@
+'use strict';
+
+const qs = require('qs');
+
+module.exports =  {
+  search : async (ctx) => {
+    try {
+        const esInterface = strapi.plugins['elasticsearch'].services.esInterface;
+        if (ctx.query.query)
+        {
+          const query = qs.parse(ctx.query.query);
+          const resp = await esInterface.searchData(query);
+          if (resp?.hits?.hits)
+          {
+            const filteredData = resp.hits.hits.filter(dt => dt._source !== null);
+            const filteredMatches = filteredData.map((dt) => dt['_source']);
+            ctx.body = filteredMatches;
+          }
+          else
+            ctx.body = {}
+        }
+        else
+          ctx.body = {}
+      } catch (err) {
+        ctx.response.status = 500;
+        ctx.body = "An error was encountered while processing the search request."
+        console.log('An error was encountered while processing the search request.')
+        console.log(err);
+      }
+  }  
+};

package/server/controllers/setup-info.js

@@ -0,0 +1,14 @@
+'use strict';
+
+
+
+module.exports = ({ strapi }) => {
+    const helperService = strapi.plugins['elasticsearch'].services.helper;
+    const getElasticsearchInfo = async (ctx) => {
+        return helperService.getElasticsearchInfo();
+    }
+
+    return {
+        getElasticsearchInfo,
+    };     
+}

package/server/destroy.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = ({ strapi }) => {
+  // destroy phase
+};