feat(app): add filtering questions (#407)

AdiPol1359 · web-flow · commit 03b6dd46b7ad · 2022-12-13T16:43:16.000+01:00
* feat(app): add filtering questions

* refactor(app): change parameter type

* refactor(app): remove select state

* feat(app): add devFAQ router hook

* refactor(app): change hook extension

* refactor(app): move logic into hook

* feat(app): add dark mode to default select variant

* feat(app): add orderBy select value

* refactor(app): move logic into hook

* refactor(app): change parameters type

* feat(app): add query order validation

* refactor(app): rename some variables

* chore(app): add .env.local to gitignore

* refactor(app): change NEXT_PUBLIC_API_URL
diff --git a/apps/app/.env.local-example b/apps/app/.env.local-example
diff --git a/apps/app/.gitignore b/apps/app/.gitignore
@@ -1,3 +1,4 @@
 .vscode
 .vercel
 storybook-static
+.env*.local
diff --git a/apps/app/public/select.svg b/apps/app/public/select.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="14" height="6" version="1"><path fill="none" stroke="#9C9C9C" stroke-linecap="square" d="M1 0l6 6m6-6L7 6"/></svg>
diff --git a/apps/app/src/app/(main-layout)/questions/[technology]/[page]/page.tsx b/apps/app/src/app/(main-layout)/questions/[technology]/[page]/page.tsx
@@ -1,16 +1,21 @@
 import { redirect } from "next/navigation";
 import { QuestionItem } from "../../../../../components/QuestionItem/QuestionItem";
+import { QuestionsHeader } from "../../../../../components/QuestionsHeader/QuestionsHeader";
 import { QuestionsPagination } from "../../../../../components/QuestionsPagination";
 import { PAGE_SIZE } from "../../../../../lib/constants";
+import { getQuerySortBy, DEFAULT_SORT_BY_QUERY } from "../../../../../lib/order";
 import { technologies } from "../../../../../lib/technologies";
 import { getAllQuestions } from "../../../../../services/questions.service";
 
 export default async function QuestionsPage({
 	params,
+	searchParams,
 }: {
 	params: { technology: string; page: string };
+	searchParams?: { sortBy?: string };
 }) {
 	const page = parseInt(params.page);
+	const querySortBy = getQuerySortBy(searchParams?.sortBy || DEFAULT_SORT_BY_QUERY);
 
 	if (!technologies.includes(params.technology) || isNaN(page)) {
 		return redirect("/");
@@ -20,10 +25,13 @@ export default async function QuestionsPage({
 		category: params.technology,
 		limit: PAGE_SIZE,
 		offset: (page - 1) * PAGE_SIZE,
+		orderBy: querySortBy?.orderBy,
+		order: querySortBy?.order,
 	});
 
 	return (
 		<div className="flex flex-col gap-y-10">
+			<QuestionsHeader technology={params.technology} total={data.meta.total} />
 			{data.data.map(({ id, question, _levelId, acceptedAt, votesCount }) => (
 				<QuestionItem
 					key={id}
diff --git a/apps/app/src/components/AddQuestionModal.tsx b/apps/app/src/components/AddQuestionModal.tsx
@@ -21,12 +21,12 @@ export const AddQuestionModal = (props: ComponentProps<typeof BaseModal>) => {
 			</h2>
 			<form onSubmit={handleFormSubmit}>
 				<div className="mt-10 flex flex-col gap-y-3 px-5 sm:flex-row sm:justify-evenly sm:gap-x-5">
-					<Select className="w-full" aria-label="Wybierz technologię">
+					<Select variant="purple" className="w-full" aria-label="Wybierz technologię">
 						<option>Wybierz Technologię</option>
 						<option>HTML5</option>
 						<option>JavaScript</option>
 					</Select>
-					<Select className="w-full" aria-label="Wybierz poziom">
+					<Select variant="purple" className="w-full" aria-label="Wybierz poziom">
 						<option>Wybierz Poziom</option>
 						<option value="junior">Junior</option>
 						<option value="mid">Mid</option>
diff --git a/apps/app/src/components/QuestionsHeader/QuestionsHeader.tsx b/apps/app/src/components/QuestionsHeader/QuestionsHeader.tsx
@@ -0,0 +1,41 @@
+"use client";
+
+import { ChangeEvent } from "react";
+import { technologiesLabel, Technology } from "../../lib/technologies";
+import { pluralize } from "../../utils/intl";
+import { Select } from "../Select/Select";
+import { useQuestionsOrderBy } from "../../hooks/useQuestionsOrderBy";
+
+const questionsPluralize = pluralize("pytanie", "pytania", "pytań");
+
+type QuestionsHeaderProps = Readonly<{
+	technology: Technology;
+	total: number;
+}>;
+
+export const QuestionsHeader = ({ technology, total }: QuestionsHeaderProps) => {
+	const { sortBy, setSortByFromString } = useQuestionsOrderBy();
+
+	const handleSelectChange = (event: ChangeEvent<HTMLSelectElement>) => {
+		event.preventDefault();
+		setSortByFromString(event.target.value);
+	};
+
+	return (
+		<header className="flex justify-between text-neutral-400">
+			<output>
+				<strong>{technologiesLabel[technology]}: </strong>
+				{total} {questionsPluralize(total)}
+			</output>
+			<label>
+				Sortuj według:
+				<Select variant="default" value={sortBy} onChange={handleSelectChange} className="ml-3">
+					<option value="acceptedAt*desc">od najnowszych</option>
+					<option value="acceptedAt*asc">od najstarszych</option>
+					<option value="votesCount*asc">od najmniej popularnych</option>
+					<option value="votesCount*desc">od najpopularniejszych</option>
+				</Select>
+			</label>
+		</header>
+	);
+};
diff --git a/apps/app/src/components/Select/Select.stories.tsx b/apps/app/src/components/Select/Select.stories.tsx
@@ -19,4 +19,14 @@ export default meta;
 
 type Story = StoryObj<typeof Select>;
 
-export const Default: Story = {};
+export const Default: Story = {
+	args: {
+		variant: "default",
+	},
+};
+
+export const Purple: Story = {
+	args: {
+		variant: "purple",
+	},
+};
diff --git a/apps/app/src/components/Select/Select.tsx b/apps/app/src/components/Select/Select.tsx
@@ -1,10 +1,23 @@
 import { twMerge } from "tailwind-merge";
 import type { SelectHTMLAttributes } from "react";
 
-export const Select = ({ className, ...props }: SelectHTMLAttributes<HTMLSelectElement>) => (
+const variants = {
+	default:
+		"select bg-white py-1 pl-1 pr-6 text-neutral-700 dark:bg-white-dark dark:text-neutral-200",
+	purple:
+		"select-purple border-b border-primary bg-transparent py-2 pr-6 pl-1 capitalize text-primary transition-shadow duration-100 focus:shadow-[0_0_10px] focus:shadow-primary dark:border-neutral-200 dark:text-neutral-200 dark:focus:shadow-white",
+};
+
+type SelectProps = Readonly<{
+	variant: keyof typeof variants;
+}> &
+	SelectHTMLAttributes<HTMLSelectElement>;
+
+export const Select = ({ variant, className, ...props }: SelectProps) => (
 	<select
 		className={twMerge(
-			"select-purple cursor-pointer appearance-none rounded-none border-b border-primary bg-transparent py-2 pr-6 pl-1 text-base capitalize text-primary transition-shadow duration-100 focus:shadow-[0_0_10px] focus:shadow-primary focus:outline-0 dark:border-neutral-200 dark:text-neutral-200 dark:focus:shadow-white",
+			"cursor-pointer appearance-none rounded-none text-base focus:outline-0",
+			variants[variant],
 			className,
 		)}
 		{...props}
diff --git a/apps/app/src/hooks/useDevFAQRouter.ts b/apps/app/src/hooks/useDevFAQRouter.ts
@@ -0,0 +1,18 @@
+import { usePathname, useSearchParams, useRouter } from "next/navigation";
+
+export const useDevFAQRouter = () => {
+	const router = useRouter();
+	const searchParams = useSearchParams();
+	const pathname = usePathname();
+
+	const mergeQueryParams = (data: Record<string, string>) => {
+		const params = { ...Object.fromEntries(searchParams.entries()), ...data };
+		const query = new URLSearchParams(params).toString();
+
+		if (pathname) {
+			router.push(`${pathname}?${query}`);
+		}
+	};
+
+	return { mergeQueryParams };
+};
diff --git a/apps/app/src/hooks/useQuestionsOrderBy.ts b/apps/app/src/hooks/useQuestionsOrderBy.ts
@@ -0,0 +1,18 @@
+import { useSearchParams } from "next/navigation";
+import { validateSortByQuery, DEFAULT_SORT_BY_QUERY } from "../lib/order";
+import { useDevFAQRouter } from "./useDevFAQRouter";
+
+export const useQuestionsOrderBy = () => {
+	const searchParams = useSearchParams();
+	const { mergeQueryParams } = useDevFAQRouter();
+
+	const sortBy = searchParams.get("sortBy") || DEFAULT_SORT_BY_QUERY;
+
+	const setSortByFromString = (sortBy: string) => {
+		if (validateSortByQuery(sortBy)) {
+			mergeQueryParams({ sortBy });
+		}
+	};
+
+	return { sortBy, setSortByFromString };
+};
diff --git a/apps/app/src/lib/order.ts b/apps/app/src/lib/order.ts
@@ -0,0 +1,31 @@
+const orderBy = ["acceptedAt", "level", "votesCount"] as const;
+const order = ["asc", "desc"] as const;
+
+type OrderBy = typeof orderBy[number];
+type Order = typeof order[number];
+
+export const DEFAULT_SORT_BY_QUERY = "acceptedAt*desc";
+
+export const validateOrderBy = (data: string): data is OrderBy => {
+	return orderBy.includes(data);
+};
+
+export const validateOrder = (data: string): data is Order => {
+	return order.includes(data);
+};
+
+export const validateSortByQuery = (query?: string): query is `${OrderBy}*${Order}` => {
+	const [orderBy, order] = query?.split("*") || [];
+
+	return Boolean(orderBy && order && validateOrderBy(orderBy) && validateOrder(order));
+};
+
+export const getQuerySortBy = (query?: string) => {
+	if (!validateSortByQuery(query)) {
+		return null;
+	}
+
+	const [orderBy, order] = query.split("*") as [OrderBy, Order];
+
+	return { orderBy, order };
+};
diff --git a/apps/app/src/lib/technologies.ts b/apps/app/src/lib/technologies.ts
@@ -1,2 +1,12 @@
 export const technologies = ["html", "css", "js", "angular", "react", "git", "other"] as const;
 export type Technology = typeof technologies[number];
+
+export const technologiesLabel: Record<Technology, string> = {
+	html: "HTML5",
+	css: "CSS3",
+	js: "JS",
+	angular: "Angular",
+	react: "React",
+	git: "Git",
+	other: "Inne",
+};
diff --git a/apps/app/src/styles/tailwind.css b/apps/app/src/styles/tailwind.css
@@ -10,6 +10,13 @@
 		background-repeat: no-repeat;
 	}
 
+	.select {
+		background-image: url("/select.svg");
+		background-size: 12px 6px;
+		background-repeat: no-repeat;
+		background-position: calc(100% - 5px) 50%;
+	}
+
 	.dark .level-button {
 		background-color: theme("colors.white-dark");
 	}

-Original file line number
+Diff line change
@@ @@ -1,3 +1,4 @@ @@
 .vscode
 .vercel
 storybook-static
 +.env*.local