Implement fuse #91

suxls · 2024-11-07T19:48:12Z

Description

Incorporated Fuse.js to the searching process.

Motivation and Context

Added fuse.js at the endpoint of the project.
Currently, the fuse is using the review fields such as "reviewHeadline", "textReview", "location", this can be modified later base on what we want to prioritize. With that said, I'm working on abstracting out fuse as an util object where different search bar will use fuse that prioritize different fields.

A bug on the side, an useEffect is added to fix the bug where if the page don't refresh, the displayed review is not updated to the first one of the resulted search list.

Closes #76
Closes #75

How has this been tested?

haha testing

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

My code follows the code style of this project.
I have moved the ticket to "In Review"
I have added reviewers to this PR
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.

implemented with useEffect, looking for alternative solution

vercel · 2024-11-07T19:48:16Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
cooper	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 23, 2024 0:33am
cooper-auth	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 23, 2024 0:33am
cooper-docs	❌ Failed (Inspect)			Nov 23, 2024 0:33am

banushi-a

onika burgers

banushi-a · 2024-11-07T20:03:08Z

apps/web/src/app/(pages)/(dashboard)/roles/page.tsx

@@ -22,6 +22,9 @@ export default function Roles({
  searchParams,
 }: {
  searchParams?: {
+    workTerm?: WorkTermType;
+    workEnvironment?: WorkEnvironmentType;
+    search?: string;
    cycle?: WorkTermType;


it looks like we want to get rid of cycle and term now since you renamed them in the new search params.

Yeah I think we got rid of workTerm and workEnvironment in favor of cycle and term but I might be wrong. This might an artifact of a merge. @suxls would recommend removing workTerm and workEnvironment from the searchParams object and testing.

banushi-a · 2024-11-07T20:06:23Z

apps/web/src/app/(pages)/(dashboard)/roles/page.tsx

    options: validationResult.success ? validationResult.data : {},
  });

  const [selectedReview, setSelectedReview] = useState<ReviewType | undefined>(
    reviews.data ? reviews.data[0] : undefined,
  );

+  useEffect(() => {


in general we want to avoid this kind of useEffect, but I'm assuming there was some kind of bug due to the fact that reviews are updated based on the child SearchFilter component?

banushi-a · 2024-11-07T20:10:43Z

apps/web/src/app/_components/search/search-filter.tsx

@@ -16,11 +16,15 @@ const formSchema = z.object({

 export type SearchFilterFormType = typeof formSchema;

-export default function SearchFilter() {
+interface SearchFilterProps {


i know this is so my inner fundies 1 ta but what are our thoughts on starting to us js doc to lightly document the functions. Espesh since dev turnover may be on the rise (oml we are getting old). Up to rishi hes TL i'm just throwing this out there ❤️ 🙈

i agree with this to make it easier for everyone to read

YES pls document with JSDoc 🙏🏻 I remember we were doing it for a bit at the start of Spring but that fizzled out lol.

RishikeshNK

we're almost there 📣

RishikeshNK · 2024-11-10T21:29:15Z

apps/web/src/app/(pages)/(dashboard)/roles/page.tsx

@@ -22,6 +22,9 @@ export default function Roles({
  searchParams,
 }: {
  searchParams?: {
+    workTerm?: WorkTermType;
+    workEnvironment?: WorkEnvironmentType;
+    search?: string;
    cycle?: WorkTermType;


Yeah I think we got rid of workTerm and workEnvironment in favor of cycle and term but I might be wrong. This might an artifact of a merge. @suxls would recommend removing workTerm and workEnvironment from the searchParams object and testing.

RishikeshNK · 2024-11-10T21:31:16Z

apps/web/src/app/(pages)/(dashboard)/roles/page.tsx

@@ -63,16 +66,23 @@ export default function Roles({
  }, [toast, mounted]);


You'll have to update the dependency array to include the validationResult based on that warning.

RishikeshNK · 2024-11-10T21:35:06Z

apps/web/src/app/_components/search/search-filter.tsx

@@ -16,11 +16,15 @@ const formSchema = z.object({

 export type SearchFilterFormType = typeof formSchema;

-export default function SearchFilter() {
+interface SearchFilterProps {


YES pls document with JSDoc 🙏🏻 I remember we were doing it for a bit at the start of Spring but that fizzled out lol.

RishikeshNK · 2024-11-10T21:37:18Z

packages/api/src/router/review.ts

+        return reviews;
+      }
+
+      const fuseOptions = {


Can we maybe abstract the fuzzy searching out to a helper? I might implement a custom linting rule that makes sure that every function should be 4 or less lines of code 😡 /s

will implement that on a separate branch

gpalmer27

Comments left in the files - I agree with Rishi's note that the workTerm and workEnvironment should be removed

gpalmer27

LGTM

RishikeshNK

blind approve

suxls and others added 14 commits September 22, 2024 16:07

initial commit with comments

cc2b7e3

installed fuse.js

715d121

YIPPEE

eef2133

h

65d72fd

Merge branch 'main' into implement-fuse

7f4ba53

feat: add fuzzy searching to reviews

dcfaa20

fix: add fuzzy search integration on roles page

7d32730

fix: return early if no search

7f8a54b

fix: remove unnecessary check

4ac1a9a

chore: merge main

447904f

feat: set search bar contents to search param

127f49a

fixed bug with updated selected view

f206a25

implemented with useEffect, looking for alternative solution

Merge branch 'main' into implement-fuse

7967c9b

functional fuse

39d99ba

suxls requested review from RishikeshNK and banushi-a November 7, 2024 19:56

banushi-a reviewed Nov 7, 2024

View reviewed changes

RishikeshNK requested review from gpalmer27 and joshw2048 November 10, 2024 21:24

RishikeshNK requested changes Nov 10, 2024

View reviewed changes

gpalmer27 requested changes Nov 11, 2024

View reviewed changes

remove unnecessary params

b0dd465

vercel bot temporarily deployed to Preview – cooper-docs November 21, 2024 02:38 Inactive

vercel bot temporarily deployed to Preview – cooper-auth November 21, 2024 02:38 Inactive

vercel bot temporarily deployed to Preview – cooper November 21, 2024 02:39 Inactive

suxls requested review from gpalmer27 and RishikeshNK November 21, 2024 02:40

reformatted

61f0e80

vercel bot temporarily deployed to Preview – cooper-docs November 21, 2024 02:41 Inactive

vercel bot temporarily deployed to Preview – cooper-auth November 21, 2024 02:41 Inactive

vercel bot temporarily deployed to Preview – cooper November 21, 2024 02:42 Inactive

gpalmer27 approved these changes Nov 21, 2024

View reviewed changes

Merge branch 'main' into implement-fuse

31668f4

RishikeshNK approved these changes Nov 23, 2024

View reviewed changes

vercel bot temporarily deployed to Preview – cooper November 23, 2024 00:32 Inactive

vercel bot had a problem deploying to Preview – cooper-docs November 23, 2024 00:32 Failure

vercel bot deployed to Preview – cooper-auth November 23, 2024 00:33 View deployment

suxls merged commit 65750da into main Nov 23, 2024
7 of 8 checks passed

suxls deleted the implement-fuse branch November 23, 2024 00:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement fuse #91

Implement fuse #91

suxls commented Nov 7, 2024 •

edited

Loading

vercel bot commented Nov 7, 2024 •

edited

Loading

banushi-a left a comment

banushi-a Nov 7, 2024

RishikeshNK Nov 10, 2024

banushi-a Nov 7, 2024

banushi-a Nov 7, 2024

gpalmer27 Nov 10, 2024

RishikeshNK Nov 10, 2024

suxls Nov 17, 2024

RishikeshNK left a comment

RishikeshNK Nov 10, 2024

RishikeshNK Nov 10, 2024

suxls Nov 17, 2024

RishikeshNK Nov 10, 2024

RishikeshNK Nov 10, 2024

suxls Nov 17, 2024

gpalmer27 left a comment

gpalmer27 left a comment

RishikeshNK left a comment

		@@ -63,16 +66,23 @@ export default function Roles({
		}, [toast, mounted]);

Implement fuse #91

Implement fuse #91

Conversation

suxls commented Nov 7, 2024 • edited Loading

Description

Motivation and Context

How has this been tested?

Screenshots (if appropriate):

Types of changes

Checklist:

vercel bot commented Nov 7, 2024 • edited Loading

banushi-a left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RishikeshNK left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gpalmer27 left a comment

Choose a reason for hiding this comment

gpalmer27 left a comment

Choose a reason for hiding this comment

RishikeshNK left a comment

Choose a reason for hiding this comment

suxls commented Nov 7, 2024 •

edited

Loading

vercel bot commented Nov 7, 2024 •

edited

Loading