From 1fc79b6e17c695bada3985f67af69e58e37ab12d Mon Sep 17 00:00:00 2001
From: Alexandre Rousseau <alexandre@rsseau.fr>
Date: Wed, 14 Aug 2024 00:03:58 +0200
Subject: [PATCH] feat(ui): add filter to `BuilderSidebarToolbar`. WF-42

I introduced a component named `BuilderSidebarTitleSearch` which extract the existing search logic of `BuilderSidebarTree` and use it for `BuilderSidebarToolbar`.

I also took the opportunity to improve the accessibility since we use `<i>` elements as button, but they're not focusable and clickable with the keyboard.

And finally, I introduced an E2E test which cover the new feature.
---
 .../src/builder/BuilderSidebarTitleSearch.vue | 99 +++++++++++++++++++
 src/ui/src/builder/BuilderSidebarToolbar.vue  | 74 +++++++++-----
 src/ui/src/builder/BuilderSidebarTree.vue     | 79 +++------------
 tests/e2e/tests/sidebar.spec.ts               | 80 +++++++++++++++
 4 files changed, 240 insertions(+), 92 deletions(-)
 create mode 100644 src/ui/src/builder/BuilderSidebarTitleSearch.vue
 create mode 100644 tests/e2e/tests/sidebar.spec.ts

diff --git a/src/ui/src/builder/BuilderSidebarTitleSearch.vue b/src/ui/src/builder/BuilderSidebarTitleSearch.vue
new file mode 100644
index 000000000..c82230646
--- /dev/null
+++ b/src/ui/src/builder/BuilderSidebarTitleSearch.vue
@@ -0,0 +1,99 @@
+<template>
+	<div v-if="isSearchActive" class="BuilderSidebarTitleSearch">
+		<input
+			ref="searchInput"
+			v-model="searchQuery"
+			type="text"
+			placeholder="Search..."
+		/>
+		<slot />
+		<i
+			:class="{ disabled: disabled }"
+			class="searchIcon material-symbols-outlined"
+			title="Close"
+			tabindex="0"
+			@keydown.enter="toggleSearch"
+			@click="toggleSearch"
+		>
+			close
+		</i>
+	</div>
+	<div v-else class="BuilderSidebarTitleSearch">
+		<i class="material-symbols-outlined">{{ icon }}</i>
+		<h3>{{ title }}</h3>
+		<i
+			title="Search"
+			class="searchIcon material-symbols-outlined"
+			tabindex="0"
+			@keydown.enter="toggleSearch"
+			@click="toggleSearch"
+		>
+			search
+		</i>
+	</div>
+</template>
+
+<script setup lang="ts">
+import { nextTick, ref, Ref } from "vue";
+
+defineProps({
+	icon: { type: String, required: true },
+	title: { type: String, required: true },
+	disabled: { type: Boolean, required: false },
+});
+
+const searchQuery = defineModel({ type: String, default: "" });
+
+defineEmits({});
+
+const searchInput: Ref<HTMLInputElement> = ref(null);
+const isSearchActive: Ref<boolean> = ref(false);
+
+async function toggleSearch() {
+	isSearchActive.value = !isSearchActive.value;
+	if (isSearchActive.value) {
+		await nextTick();
+		searchInput.value.focus();
+	} else {
+		searchQuery.value = "";
+	}
+}
+</script>
+
+<style scoped>
+@import "./sharedStyles.css";
+
+.BuilderSidebarTitleSearch {
+	display: flex;
+	gap: 8px;
+	align-items: center;
+	font-size: 1rem;
+
+	background: var(--builderBackgroundColor);
+	padding: 16px;
+	top: 0;
+	position: sticky;
+	font-size: 1rem;
+}
+
+.BuilderSidebarTitleSearch h3 {
+	font-weight: 500;
+	font-size: 0.875rem;
+	flex-grow: 1;
+}
+
+.BuilderSidebarTitleSearch .searchIcon {
+	cursor: pointer;
+}
+
+.BuilderSidebarTitleSearch .searchIcon.disabled {
+	color: var(--builderDisabledColor);
+}
+
+.BuilderSidebarTitleSearch input {
+	outline: 0;
+	border: 0;
+	flex-grow: 1;
+	width: 50%;
+}
+</style>
diff --git a/src/ui/src/builder/BuilderSidebarToolbar.vue b/src/ui/src/builder/BuilderSidebarToolbar.vue
index deb50f3aa..1c369f994 100644
--- a/src/ui/src/builder/BuilderSidebarToolbar.vue
+++ b/src/ui/src/builder/BuilderSidebarToolbar.vue
@@ -1,22 +1,23 @@
 <template>
 	<div class="BuilderSidebarToolbar">
-		<div class="sectionTitle">
-			<i class="material-symbols-outlined"> handyman </i>
-			<h3>Toolkit</h3>
-		</div>
+		<BuilderSidebarTitleSearch
+			v-model="searchQuery"
+			title="Toolkit"
+			icon="handyman"
+		/>
 		<div class="categories">
 			<template
 				v-for="(categoryData, category) in categoriesData"
 				:key="category"
 			>
-				<div v-if="categoryData.isVisible !== false" class="category">
+				<div v-if="shouldDisplayCategory(category)" class="category">
 					<div class="title">
 						<i class="material-symbols-outlined">{{
 							categoryData.icon ?? "question_mark"
 						}}</i>
 						<h4>{{ category }}</h4>
 
-						<div
+						<button
 							class="drop-arrow"
 							@click="toggleCollapseCategory(category)"
 						>
@@ -27,10 +28,14 @@
 										: "expand_less"
 								}}
 							</i>
-						</div>
+						</button>
 					</div>
 
-					<div v-show="!categoryData.isCollapsed" class="components">
+					<div
+						v-show="!categoryData.isCollapsed"
+						class="components"
+						:aria-expanded="!categoryData.isCollapsed"
+					>
 						<div
 							v-for="(
 								definition, type
@@ -63,18 +68,23 @@ import { Ref, computed, inject, ref } from "vue";
 import { useDragDropComponent } from "./useDragDropComponent";
 import injectionKeys from "../injectionKeys";
 import { Component, WriterComponentDefinition } from "../writerTypes";
+import BuilderSidebarTitleSearch from "./BuilderSidebarTitleSearch.vue";
 
 const wf = inject(injectionKeys.core);
 const ssbm = inject(injectionKeys.builderManager);
 const { removeInsertionCandidacy } = useDragDropComponent(wf);
 
+type CategoryId = "Root" | "Layout" | "Content" | "Input" | "Embed" | "Other";
+
 type CategoryData = {
 	isVisible?: boolean;
 	isCollapsed?: boolean;
 	icon?: string;
 };
 
-const categoriesData: Ref<Record<string, CategoryData>> = ref({
+const searchQuery = ref("");
+
+const categoriesData: Ref<Record<CategoryId, CategoryData>> = ref({
 	Root: {
 		isVisible: false,
 	},
@@ -100,6 +110,15 @@ const categoriesData: Ref<Record<string, CategoryData>> = ref({
 	},
 });
 
+function shouldDisplayCategory(categoryId: CategoryId): boolean {
+	if (categoriesData.value[categoryId]?.isVisible === false) return false;
+
+	return (
+		Object.keys(definitionsByDisplayCategory.value[categoryId] ?? {})
+			.length > 0
+	);
+}
+
 function toggleCollapseCategory(categoryId: string) {
 	const categoryData = categoriesData.value[categoryId];
 	categoryData.isCollapsed = !categoryData.isCollapsed;
@@ -107,13 +126,21 @@ function toggleCollapseCategory(categoryId: string) {
 
 const definitionsByDisplayCategory = computed(() => {
 	const types = wf.getSupportedComponentTypes();
-	const result: Record<
-		string,
-		Record<string, WriterComponentDefinition>
+	const result: Partial<
+		Record<CategoryId, Record<string, WriterComponentDefinition>>
 	> = {};
 
 	types.map((type) => {
 		const definition = wf.getComponentDefinition(type);
+
+		const matchingSearch =
+			searchQuery.value === "" ||
+			definition.name
+				.toLocaleLowerCase()
+				.includes(searchQuery.value.toLocaleLowerCase());
+
+		if (!matchingSearch) return;
+
 		const isMatch = Object.keys(categoriesData.value).includes(
 			definition.category,
 		);
@@ -149,20 +176,6 @@ const handleDragEnd = (ev: DragEvent) => {
 	font-size: 0.7rem;
 }
 
-.BuilderSidebarToolbar > .sectionTitle {
-	padding: 16px;
-	position: sticky;
-	top: 0;
-	background: var(--builderBackgroundColor);
-	font-size: 0.875rem;
-	height: 40px;
-}
-
-h3 {
-	font-weight: 500;
-	font-size: 0.875rem;
-}
-
 .categories {
 	padding: 0 12px 12px 12px;
 	flex: 1 1 auto;
@@ -201,6 +214,14 @@ h3 {
 }
 
 .drop-arrow {
+	/* reset button default */
+	border: none;
+	background-color: unset;
+	padding: 0;
+	margin: 0;
+	height: auto;
+	width: auto;
+
 	border-radius: 50%;
 	min-width: 24px;
 	min-height: 24px;
@@ -212,5 +233,6 @@ h3 {
 
 .drop-arrow:hover {
 	background: var(--builderSubtleSeparatorColor);
+	color: unset;
 }
 </style>
diff --git a/src/ui/src/builder/BuilderSidebarTree.vue b/src/ui/src/builder/BuilderSidebarTree.vue
index b3cb18341..c6678fe65 100644
--- a/src/ui/src/builder/BuilderSidebarTree.vue
+++ b/src/ui/src/builder/BuilderSidebarTree.vue
@@ -1,23 +1,11 @@
 <template>
 	<div class="BuilderSidebarTree">
-		<div v-if="!isSearchActive" class="sectionTitle">
-			<i class="material-symbols-outlined"> account_tree </i>
-			<h3>Component Tree</h3>
-			<i
-				title="Search"
-				class="searchIcon material-symbols-outlined"
-				@click="toggleSearch"
-			>
-				search
-			</i>
-		</div>
-		<div v-if="isSearchActive" class="sectionTitle">
-			<input
-				ref="searchInput"
-				v-model="searchQuery"
-				type="text"
-				placeholder="Search..."
-			/>
+		<BuilderSidebarTitleSearch
+			v-model="searchQuery"
+			title="Component Tree"
+			icon="account_tree"
+			:disabled="!matchAvailable"
+		>
 			<i
 				:class="{ disabled: !matchAvailable }"
 				class="searchIcon material-symbols-outlined"
@@ -26,6 +14,8 @@
 						? `Go to match ${previousMatchIndex + 1} of ${matchingComponents.length}`
 						: `Previous match`
 				"
+				tabindex="0"
+				@keydown.enter="goToPreviousMatch"
 				@click="goToPreviousMatch"
 			>
 				navigate_before
@@ -38,19 +28,13 @@
 						? `Go to match ${nextMatchIndex + 1} of ${matchingComponents.length}`
 						: `Next match`
 				"
+				tabindex="0"
+				@keydown.enter="goToNextMatch"
 				@click="goToNextMatch"
 			>
 				navigate_next
 			</i>
-			<i
-				:class="{ disabled: !matchAvailable }"
-				class="searchIcon material-symbols-outlined"
-				title="Close"
-				@click="toggleSearch"
-			>
-				close
-			</i>
-		</div>
+		</BuilderSidebarTitleSearch>
 		<div ref="componentTree" class="components">
 			<div
 				v-for="component in rootComponents"
@@ -79,6 +63,7 @@ import BuilderTreeBranch from "./BuilderTreeBranch.vue";
 import injectionKeys from "../injectionKeys";
 import { Component } from "../writerTypes";
 import { watch } from "vue";
+import BuilderSidebarTitleSearch from "./BuilderSidebarTitleSearch.vue";
 
 const wf = inject(injectionKeys.core);
 const ssbm = inject(injectionKeys.builderManager);
@@ -86,24 +71,12 @@ const ssbm = inject(injectionKeys.builderManager);
 const { createAndInsertComponent, goToComponentParentPage } =
 	useComponentActions(wf, ssbm);
 
-const searchInput: Ref<HTMLInputElement> = ref(null);
-const isSearchActive: Ref<boolean> = ref(false);
 const searchQuery: Ref<string> = ref(null);
 const matchIndex: Ref<number> = ref(-1);
 const rootComponents = computed(() => {
 	return wf.getComponents(null, { sortedByPosition: true });
 });
 
-async function toggleSearch() {
-	isSearchActive.value = !isSearchActive.value;
-	if (isSearchActive.value) {
-		await nextTick();
-		searchInput.value.focus();
-	} else {
-		searchQuery.value = null;
-	}
-}
-
 function determineMatch(component: Component, query: string): boolean {
 	if (component.id.toLocaleLowerCase().includes(query)) return true;
 	if (component.type.toLocaleLowerCase().includes(query)) return true;
@@ -158,7 +131,6 @@ function goToNextMatch() {
 }
 
 const matchingComponents: ComputedRef<Component[]> = computed(() => {
-	if (!isSearchActive.value) return;
 	if (!searchQuery.value) return;
 	const query = searchQuery.value.toLocaleLowerCase();
 	const components = wf.getComponents();
@@ -192,35 +164,10 @@ async function addPage() {
 	flex-direction: column;
 }
 
-.sectionTitle {
-	background: var(--builderBackgroundColor);
-	padding: 16px;
-	top: 0;
-	position: sticky;
-	font-size: 1rem;
-}
-
-.sectionTitle h3 {
-	font-weight: 500;
-	font-size: 0.875rem;
-	flex-grow: 1;
-}
-
-.sectionTitle .searchIcon {
-	cursor: pointer;
-}
-
-.sectionTitle .searchIcon.disabled {
+.searchIcon.disabled {
 	color: var(--builderDisabledColor);
 }
 
-.sectionTitle input {
-	outline: 0;
-	border: 0;
-	flex-grow: 1;
-	width: 50%;
-}
-
 .components {
 	padding: 0 12px 12px 12px;
 }
diff --git a/tests/e2e/tests/sidebar.spec.ts b/tests/e2e/tests/sidebar.spec.ts
new file mode 100644
index 000000000..afc268100
--- /dev/null
+++ b/tests/e2e/tests/sidebar.spec.ts
@@ -0,0 +1,80 @@
+import { test, expect } from "@playwright/test";
+
+test.describe("sidebar", () => {
+	let url: string;
+
+	test.beforeAll(async ({ request }) => {
+		const response = await request.post(`/preset/empty_page`);
+		expect(response.ok()).toBeTruthy();
+		({ url } = await response.json());
+	});
+
+	test.afterAll(async ({ request }) => {
+		await request.delete(url);
+	});
+
+	test.beforeEach(async ({ page }) => {
+		await page.goto(url);
+		test.setTimeout(5000);
+	});
+
+	test.describe("Toolkit", () => {
+		test("should filter", async ({ page }) => {
+			// click on icon to begin search
+			await page
+				.locator(
+					`.BuilderSidebarToolbar .BuilderSidebarTitleSearch i[title="Search"]`,
+				)
+				.click();
+
+			// search a button
+			await page
+				.locator(`.BuilderSidebarToolbar .BuilderSidebarTitleSearch input`)
+				.fill("button");
+
+			// should have only one result
+			expect(
+				await page.locator(`.BuilderSidebarToolbar .component`).count(),
+			).toBe(1);
+
+			// close search
+			await page
+				.locator(
+					`.BuilderSidebarToolbar .BuilderSidebarTitleSearch i[title="Close"]`,
+				)
+				.click();
+
+			// should reset the search
+			expect(
+				await page.locator(`.BuilderSidebarToolbar .component`).count(),
+			).not.toBe(1);
+		});
+
+		test("should be compatible with keyboard navigation", async ({ page }) => {
+			// click on icon to begin search
+			await page
+				.locator(
+					`.BuilderSidebarToolbar .BuilderSidebarTitleSearch i[title="Search"]`,
+				)
+				.click();
+
+			// search a button
+			await page
+				.locator(`.BuilderSidebarToolbar .BuilderSidebarTitleSearch input`)
+				.fill("button");
+
+			// should have only one result
+			expect(
+				await page.locator(`.BuilderSidebarToolbar .component`).count(),
+			).toBe(1);
+
+			await page.keyboard.press("Tab");
+			await page.keyboard.press("Enter");
+
+			// should reset the search
+			expect(
+				await page.locator(`.BuilderSidebarToolbar .component`).count(),
+			).not.toBe(1);
+		});
+	});
+});