handle search filtering with underscore

Author: nemanjam

README.md

@@ -56,9 +56,9 @@ https://user-images.githubusercontent.com/9990165/177367837-a2692e5d-b694-454e-8
     <img width="150px" src="docs/readme-assets/mobile-screens/Screenshot15.png">
 </p>
 
-## How you can use this
+## Usage
 
-- build your own projects on top of this (blog, social network, e-commerce, Saas...), suitable for any small to medium size web app that can run in a single Linux box, not every start up has billion users from first day
+- build your own projects on top of this (blog, social network, e-commerce, SaaS...), suitable for any small to medium size web app that can run in a single Linux box, not every start up has billion users from first day
 - if you want to go serverless route you can still reuse a lot of code and implementation decisions from this project, few notes: 1. you need to remove custom http server and let Next.js app run natively, 2. you can't run production app in a single Docker container, 3. you must use different Multer storage type for uploads
 - reuse any specific design decision, feature or configuration (i.e. VS Code devcontainer can be reused for any Node.js project, theming plugin, email/password login with `next-auth`, etc...)
 - use it for learning or as a collection of working examples for reference
@@ -665,7 +665,7 @@ Here is the brief overview of what you can find in it:
 - [Github Actions](docs/github-actions.md) - building Docker container, running tests, handling environment variables, handling `NODE_ENV` and `APP_ENV` variables, VPS deployment using SSH action
 - [Traefik](docs/traefik.md) - setting up live production environment based on Docker, renewing Let's Encrypt certificate
 - [VS Code](docs/vs-code.md) - ESLint and Prettier setup, running Jest tests, devcontainers setup
-- [todo](docs/todo.md) - my personal simple task tracker
+- [todo](docs/todo.md) - my simple personal task tracker
 
 ## Contributing
 

docs/prisma.md

@@ -60,3 +60,9 @@ import { User } from '.prisma/client';
 - [docs](https://www.prisma.io/docs/guides/upgrade-guides/upgrading-versions/upgrading-to-prisma-4#breaking-changes)
 - validate schema `npx prisma validate`
 - nothing changed, all works
+
+### Full text search with Postgres
+
+- `_` matches space literally, I need that and not `&` to match phrase with space `cat dog`
+- `cat & dog` matches those two words **anywhere in same content**, in any order, `cat some text dog`
+- Github [issue](https://github.com/prisma/prisma/issues/8939)

lib-server/services/posts.ts

@@ -7,6 +7,7 @@ import {
   PostWithAuthor,
 } from 'types/models/Post';
 import { PaginatedResponse, SortDirection } from 'types';
+import { filterSearchTerm } from 'utils';
 
 // -------- pages/api/posts/[id].ts
 
@@ -121,51 +122,22 @@ export const getPosts = async (
   } = postsGetData;
 
   const byAuthor = userId || email || username;
+  const search = filterSearchTerm(searchTerm);
 
   const where = {
     where: {
       published,
       ...(byAuthor && {
         author: {
-          OR: [
-            {
-              id: userId,
-            },
-            {
-              email,
-            },
-            {
-              username,
-            },
-          ],
+          OR: [{ id: userId }, { email }, { username }],
         },
       }),
-      ...(searchTerm && {
+      ...(search && {
         OR: [
-          {
-            title: {
-              search: searchTerm,
-            },
-          },
-          {
-            content: {
-              search: searchTerm,
-            },
-          },
-          {
-            author: {
-              username: {
-                search: searchTerm,
-              },
-            },
-          },
-          {
-            author: {
-              name: {
-                search: searchTerm,
-              },
-            },
-          },
+          { title: { search } },
+          { content: { search } },
+          { author: { username: { search } } },
+          { author: { name: { search } } },
         ],
       }),
     },

lib-server/services/users.ts

@@ -10,6 +10,7 @@ import {
   UsersGetData,
   UserUpdateServiceData,
 } from 'types/models/User';
+import { filterSearchTerm } from 'utils';
 
 /**
  *
@@ -133,26 +134,12 @@ export const getUsers = async (
     sortDirection = 'desc',
   } = usersGetData;
 
+  const search = filterSearchTerm(searchTerm, 'or');
+
   const where = {
     where: {
-      ...(searchTerm && {
-        OR: [
-          {
-            name: {
-              search: searchTerm,
-            },
-          },
-          {
-            username: {
-              search: searchTerm,
-            },
-          },
-          {
-            email: {
-              search: searchTerm,
-            },
-          },
-        ],
+      ...(search && {
+        OR: [{ name: { search } }, { username: { search } }, { email: { search } }],
       }),
     },
   };

utils/index.ts

@@ -38,3 +38,23 @@ export const isGithubActionsAppEnv = (): boolean => {
  * Note: this might give wrong path in tests
  */
 export const rootDirAbsolutePath = process.cwd();
+
+/**
+ * filter special chars and replace spaces with '_'
+ */
+export const filterSearchTerm = (
+  searchTerm: string | undefined,
+  operator: 'space' | 'or' = 'space'
+): string | undefined => {
+  // 'cat_dog' matches 'cat dog'
+  const joinBy = operator === 'space' ? '_' : ' | ';
+
+  return (
+    searchTerm &&
+    searchTerm
+      .trim()
+      .replace(/[^a-z0-9\s]+/gi, '') // remove special chars
+      .split(/\s+/)
+      .join(joinBy)
+  );
+};