Merge pull request #36 from Eroxl/search

[Feature] Searching a users note rack

Author: Eroxl

backend/package.json

@@ -7,7 +7,6 @@
   "devDependencies": {
     "@types/cors": "^2.8.12",
     "@types/express": "^4.17.13",
-    "@types/express-ws": "^3.0.1",
     "@types/redis": "^4.0.11",
     "@types/swagger-jsdoc": "^6.0.1",
     "@types/swagger-ui-express": "^4.1.3",
@@ -32,6 +31,7 @@
   "author": "",
   "license": "gpl-3.0",
   "dependencies": {
+    "@elastic/elasticsearch": "^8.6.0",
     "@types/bcrypt": "^5.0.0",
     "@types/cookie-parser": "^1.4.2",
     "@types/ioredis": "^4.28.8",
@@ -43,7 +43,6 @@
     "cors": "^2.8.5",
     "dotenv": "^14.2.0",
     "express": "^4.17.2",
-    "express-ws": "^5.0.2",
     "ioredis": "^4.28.5",
     "jsonwebtoken": "^8.5.1",
     "mongoose": "^6.1.7",

backend/src/helpers/deletePage.ts

@@ -3,6 +3,7 @@ import PageMapModel from '../models/pageMap';
 import PageModel from '../models/pageModel';
 import PageTreeModel from '../models/pageTreeModel';
 import mongoose from 'mongoose';
+import ElasticSearchClient from './search/ElasticSearchClient';
 
 interface pageTreeType {
   _id: string,
@@ -43,8 +44,8 @@ const deletePage = async (
     return subPages;
   };
 
-  const pagesToDelete = getSubPages(pageTree, pageMap.pathToPage, pageID)
-    .map((id) => new mongoose.Types.ObjectId(id));
+  const pagesToDelete = getSubPages(pageTree, pageMap.pathToPage, pageID);
+  const objectIDsToDelete = pagesToDelete.map((id) => new mongoose.Types.ObjectId(id));
 
   // -=- Delete Sub Pages -=-
   // ~ Delete the top level page from the page tree
@@ -90,14 +91,33 @@ const deletePage = async (
   // ~ Delete the sub pages maps
   await PageMapModel.deleteMany({
     _id: {
-      $in: pagesToDelete,
+      $in: objectIDsToDelete,
     },
   });
 
   // ~ Delete the sub pages
   await PageModel.deleteMany({
     _id: {
-      $in: pagesToDelete,
+      $in: objectIDsToDelete,
+    },
+  });
+
+
+  // ~ Delete the sub pages from ElasticSearch
+  await ElasticSearchClient.deleteByQuery({
+    index: 'blocks',
+    body: {
+      query: {
+        bool: {
+          filter: [
+            {
+              terms: {
+                pageId: pagesToDelete,
+              },
+            },
+          ],
+        },
+      },
     },
   });
 };

backend/src/helpers/search/ElasticSearchClient.ts

@@ -0,0 +1,60 @@
+import { Client } from '@elastic/elasticsearch';
+
+if (!process.env.ELASTICSEARCH_URL) {
+  throw new Error('ELASTICSEARCH_URL is not defined');
+}
+
+if (!process.env.ELASTICSEARCH_PASSWORD) {
+  throw new Error('ELASTICSEARCH_PASSWORD is not defined');
+}
+
+if (!process.env.ELASTICSEARCH_USERNAME) {
+  throw new Error('ELASTICSEARCH_USERNAME is not defined');
+}
+
+const client = new Client({
+  node: process.env.ELASTICSEARCH_URL,
+  auth: {
+    password: process.env.ELASTICSEARCH_PASSWORD,
+    username: process.env.ELASTICSEARCH_USERNAME,
+  },
+});
+
+client.indices.exists({
+  index: 'blocks',
+})
+  .then((exists) => {
+    if (exists) return;
+
+    return client.indices.create({
+      index: 'blocks',
+    });
+  })
+  .then(() => {
+    return client.indices.putMapping({
+      index: 'blocks',
+      body: {
+        properties: {
+          blockId: {
+            type: 'keyword',
+          },
+          content: {
+            type: 'text',
+          },
+          pageId: {
+            type: 'keyword',
+          },
+          userID: {
+            type: 'keyword',
+          },
+        },
+      },
+    });
+  })
+  .catch((err) => {
+    if (err?.meta?.body?.error?.type !== 'resource_already_exists_exception') {
+      console.error(err);
+    }
+  });
+
+export default client;

backend/src/index.ts

@@ -3,7 +3,6 @@ import supertokens from 'supertokens-node';
 import swaggerJSDoc from 'swagger-jsdoc';
 import swaggerUI from 'swagger-ui-express';
 import express from 'express';
-import expressWs from 'express-ws';
 import bodyParser from 'body-parser';
 import mongoose from 'mongoose';
 import dotenv from 'dotenv';
@@ -44,9 +43,6 @@ app.use(cors({
 // -=- Add Super Tokens Middleware -=-
 app.use(middleware());
 
-// -=- Add Websocket Support -=-
-expressWs(app);
-
 import routes from './routes/index';
 
 // -=- Add API Routes -=-
@@ -78,5 +74,7 @@ app.use(
 // -=- Setup Super Tokens Error Handling -=-
 app.use(errorHandler());
 
+console.log(`Server running on port ${port}`);
+
 // -=- Start The Express Server -=-
 app.listen(port);

backend/src/middleware/verifyPermissions.ts

@@ -27,7 +27,7 @@ const verifyPermissions = (permissions: ValidPermissions[]) => {
 
     const username = req.session?.getUserId() || '';
 
-    const pageData = await PageModel.findOne({ _id: page }).lean();
+    const pageData = await PageModel.findOne({ _id: page });
 
     if (!pageData) {
       res.statusCode = 404;

backend/src/models/pageModel.ts

@@ -1,6 +1,12 @@
-import mongoose, { Schema } from 'mongoose';
+import mongoose, { Schema, Document } from 'mongoose';
 
-export interface IPage {
+interface Block {
+  blockType: string;
+  properties: {};
+  children: Block[];
+}
+
+export interface IPage extends Document {
   user: string;
   permissions: {
     [key: string]: {
@@ -11,11 +17,7 @@ export interface IPage {
     };
   };
   style: {};
-  data: {
-    blockType: string;
-    properties: {};
-    children: [];
-  }[];
+  data: Block[];
 }
 
 const PageSchema = new Schema<IPage>({
@@ -31,6 +33,6 @@ const PageSchema = new Schema<IPage>({
   ],
 });
 
-const PageModel = mongoose.models.page as mongoose.Model<IPage> || mongoose.model<IPage>('page', PageSchema);
+const PageModel = mongoose.models.page as mongoose.Model<IPage> || mongoose.model('page', PageSchema);
 
 export default PageModel;

backend/src/routes/account/index.ts

@@ -2,6 +2,7 @@ import express from 'express';
 
 import editPageTreeExpansion from './editPageTreeExpansion';
 import getPageTree from './getPageTree';
+import search from './search';
 
 const router = express.Router();
 
@@ -17,4 +18,10 @@ router.use(
   editPageTreeExpansion,
 );
 
+// -=- Create Search API -=-
+router.use(
+  '/',
+  search,
+);
+
 export default router;

backend/src/routes/account/search.ts

@@ -0,0 +1,82 @@
+import express from 'express';
+import { SessionRequest } from 'supertokens-node/framework/express';
+import { verifySession } from 'supertokens-node/recipe/session/framework/express';
+import ElasticSearchClient from '../../helpers/search/ElasticSearchClient';
+
+const router = express.Router();
+
+router.get(
+  '/search',
+  verifySession(),
+  async (req: SessionRequest, res) => {
+    const username = req.session!.getUserId();
+    const filter = req.query.filter;
+
+    if (typeof filter !== 'string') {
+      res.statusCode = 401;
+      res.json({
+        status: 'error',
+        message: 'Please enter a search term!',
+      });
+      return;
+    }
+
+    // const results = await ElasticSearchClient.search({
+    //   index: 'blocks',
+    //   query: {
+    //     bool: {
+    //       must: {
+    //         match: {
+    //           content: filter,
+    //         }
+    //       },
+    //       filter: {
+    //         term: {
+    //           userID: username,
+    //         }
+    //       }
+    //     }
+    //   },
+    // });
+
+    // console.log(JSON.stringify(
+    //   results,
+    //   null,
+    //   2,
+    // ))
+
+    const results = await ElasticSearchClient.search({
+      index: 'blocks',
+      query: {
+        bool: {
+          must: {
+            match: {
+              content: filter,
+            },
+          },
+          filter: {
+            term: {
+              userID: username,
+            },
+          },
+        }
+      },
+    });
+
+    res.statusCode = 200;
+    res.json({
+      status: 'success',
+      message: results.hits.hits.map((hit) => {
+        const sources = (hit?._source as Record<string, unknown>) ?? {};
+
+        return ({
+          content: sources?.content || '',
+          blockID: sources?.blockId || '',
+          pageID: sources?.pageId || '',
+        })
+      })
+    });
+  },
+);
+
+export default router;