Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

feat: sort labels alphabetically (#1856)

Christopher Vestmanfa01b6edfb2f
diff --git a/apps/web/src/components/backlog-list-view/backlog-task-row.test.tsx b/apps/web/src/components/backlog-list-view/backlog-task-row.test.tsx
index 8281054cd..c0c171cd4 100644
--- a/apps/web/src/components/backlog-list-view/backlog-task-row.test.tsx
+++ b/apps/web/src/components/backlog-list-view/backlog-task-row.test.tsx
@@ -60,7 +60,10 @@ vi.mock("@/store/user-preferences", () => ({
useUserPreferencesStore: () => ({ showLabels: true, showTaskNumbers: true }),
}));
vi.mock("react-i18next", () => ({
- useTranslation: () => ({ t: (key: string) => key }),
+ useTranslation: () => ({
+ t: (key: string) => key,
+ i18n: { language: "en-US", resolvedLanguage: "en-US" },
+ }),
initReactI18next: { type: "3rdParty", init: vi.fn() },
}));
diff --git a/apps/web/src/components/kanban-board/task-labels.tsx b/apps/web/src/components/kanban-board/task-labels.tsx
index 76d7f5bda..6cf248b21 100644
--- a/apps/web/src/components/kanban-board/task-labels.tsx
+++ b/apps/web/src/components/kanban-board/task-labels.tsx
@@ -1,4 +1,6 @@
+import { useTranslation } from "react-i18next";
import { Badge } from "@/components/ui/badge";
+import { localeCompareSort } from "@/lib/format";
import { resolveLabelColor } from "@/lib/label-color";
import type Task from "@/types/task";
@@ -7,11 +9,18 @@ export function TaskLabels({
}: {
labels: NonNullable<Task["labels"]>;
}) {
+ const { i18n } = useTranslation();
+ const locale = i18n.resolvedLanguage || i18n.language;
+
if (!labels.length) return null;
+ const sortedLabels = [...labels].sort((a, b) =>
+ localeCompareSort(a.name, b.name, locale),
+ );
+
return (
<div className="flex min-w-0 flex-wrap gap-1">
- {labels.map((label) => (
+ {sortedLabels.map((label) => (
<Badge
key={label.id}
variant="outline"
diff --git a/apps/web/src/components/list-view/task-row.test.tsx b/apps/web/src/components/list-view/task-row.test.tsx
index c4d0006b1..2fbf9d93e 100644
--- a/apps/web/src/components/list-view/task-row.test.tsx
+++ b/apps/web/src/components/list-view/task-row.test.tsx
@@ -90,7 +90,10 @@ vi.mock("@/store/user-preferences", () => ({
}));
vi.mock("react-i18next", () => ({
- useTranslation: () => ({ t: (key: string) => key }),
+ useTranslation: () => ({
+ t: (key: string) => key,
+ i18n: { language: "en-US", resolvedLanguage: "en-US" },
+ }),
initReactI18next: { type: "3rdParty", init: vi.fn() },
}));
diff --git a/apps/web/src/hooks/queries/label/label-sorting.test.tsx b/apps/web/src/hooks/queries/label/label-sorting.test.tsx
new file mode 100644
index 000000000..8e05d0f38
--- /dev/null
+++ b/apps/web/src/hooks/queries/label/label-sorting.test.tsx
@@ -0,0 +1,163 @@
+import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
+import {
+ act,
+ cleanup,
+ render,
+ renderHook,
+ waitFor,
+} from "@testing-library/react";
+import type { ReactNode } from "react";
+import { I18nextProvider } from "react-i18next";
+import {
+ afterEach,
+ beforeEach,
+ describe,
+ expect,
+ it,
+ vi,
+} from "vite-plus/test";
+import { TaskLabels } from "@/components/kanban-board/task-labels";
+import { localeCompareSort } from "@/lib/format";
+import { i18n } from "@/lib/i18n";
+import useGetLabelsByTask from "./use-get-labels-by-task";
+import useGetLabelsByWorkspace from "./use-get-labels-by-workspace";
+
+const { getTaskLabels, getWorkspaceLabels } = vi.hoisted(() => ({
+ getTaskLabels: vi.fn(),
+ getWorkspaceLabels: vi.fn(),
+}));
+
+vi.mock("@/fetchers/label/get-labels-by-task", () => ({
+ default: getTaskLabels,
+}));
+vi.mock("@/fetchers/label/get-label-by-workspace", () => ({
+ default: getWorkspaceLabels,
+}));
+vi.mock("@/lib/i18n", async () => {
+ const { createInstance } = await import("i18next");
+ const { initReactI18next } = await import("react-i18next");
+ const instance = createInstance();
+ await instance.use(initReactI18next).init({
+ lng: "en-US",
+ fallbackLng: "en-US",
+ resources: {
+ "en-US": { translation: { label: "Label" } },
+ "sv-SE": { translation: { label: "Etikett" } },
+ },
+ });
+ return { i18n: instance };
+});
+
+const labels = Object.freeze([
+ { id: "accented", name: "Äpple", color: "red" },
+ { id: "last", name: "Zebra", color: "blue" },
+ { id: "first", name: "Apple", color: "green" },
+]);
+
+let queryClient: QueryClient;
+
+function Wrapper({ children }: { children: ReactNode }) {
+ return (
+ <I18nextProvider i18n={i18n}>
+ <QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
+ </I18nextProvider>
+ );
+}
+
+beforeEach(async () => {
+ queryClient = new QueryClient({
+ defaultOptions: { queries: { retry: false, staleTime: Infinity } },
+ });
+ vi.spyOn(navigator, "languages", "get").mockReturnValue(["en-US"]);
+ await i18n.changeLanguage("en-US");
+ getTaskLabels.mockResolvedValue(labels);
+ getWorkspaceLabels.mockResolvedValue(labels);
+});
+
+afterEach(() => {
+ cleanup();
+ queryClient.clear();
+ vi.restoreAllMocks();
+ vi.clearAllMocks();
+});
+
+describe("label sorting", () => {
+ it("uses the resolved app language over the browser language", async () => {
+ await i18n.changeLanguage("sv-SE");
+
+ expect(localeCompareSort("Äpple", "Zebra")).toBeGreaterThan(0);
+ expect(localeCompareSort("Äpple", "Zebra", "en-US")).toBeLessThan(0);
+ expect(localeCompareSort("Label 2", "Label 10")).toBeLessThan(0);
+ expect(localeCompareSort("apple", "Apple")).toBe(0);
+ });
+
+ it.each([
+ ["task", useGetLabelsByTask, getTaskLabels],
+ ["workspace", useGetLabelsByWorkspace, getWorkspaceLabels],
+ ] as const)(
+ "reorders cached %s labels when the app language changes",
+ async (_, useLabels, fetchLabels) => {
+ const { result } = renderHook(() => useLabels("test-id"), {
+ wrapper: Wrapper,
+ });
+ await waitFor(() =>
+ expect(result.current.data?.map((label) => label.name)).toEqual([
+ "Äpple",
+ "Apple",
+ "Zebra",
+ ]),
+ );
+
+ await act(async () => {
+ await i18n.changeLanguage("sv-SE");
+ });
+
+ await waitFor(() =>
+ expect(result.current.data?.map((label) => label.name)).toEqual([
+ "Apple",
+ "Zebra",
+ "Äpple",
+ ]),
+ );
+ expect(fetchLabels).toHaveBeenCalledTimes(1);
+ expect(queryClient.getQueryData(["labels", "test-id"])).toEqual(labels);
+
+ await act(async () => {
+ await i18n.changeLanguage("en-US");
+ });
+ await waitFor(() =>
+ expect(result.current.data?.map((label) => label.name)).toEqual([
+ "Äpple",
+ "Apple",
+ "Zebra",
+ ]),
+ );
+ },
+ );
+
+ it("reorders task badges when the app language changes with the same labels", async () => {
+ const { container } = render(<TaskLabels labels={[...labels]} />, {
+ wrapper: Wrapper,
+ });
+ const displayedNames = () =>
+ [...container.querySelectorAll("span[title]")].map(
+ (label) => label.textContent,
+ );
+ expect(displayedNames()).toEqual(["Äpple", "Apple", "Zebra"]);
+
+ await act(async () => {
+ await i18n.changeLanguage("sv-SE");
+ });
+ expect(displayedNames()).toEqual(["Apple", "Zebra", "Äpple"]);
+
+ await act(async () => {
+ await i18n.changeLanguage("en-US");
+ });
+ expect(displayedNames()).toEqual(["Äpple", "Apple", "Zebra"]);
+ expect(labels.map((label) => label.name)).toEqual([
+ "Äpple",
+ "Zebra",
+ "Apple",
+ ]);
+ });
+});
diff --git a/apps/web/src/hooks/queries/label/use-get-labels-by-task.ts b/apps/web/src/hooks/queries/label/use-get-labels-by-task.ts
index 92d43ddb5..c050885e1 100644
--- a/apps/web/src/hooks/queries/label/use-get-labels-by-task.ts
+++ b/apps/web/src/hooks/queries/label/use-get-labels-by-task.ts
@@ -1,10 +1,17 @@
import { useQuery } from "@tanstack/react-query";
+import { useTranslation } from "react-i18next";
import getLabelsByTask from "@/fetchers/label/get-labels-by-task";
+import { localeCompareSort } from "@/lib/format";
function useGetLabelsByTask(taskId: string) {
+ const { i18n } = useTranslation();
+ const locale = i18n.resolvedLanguage || i18n.language;
+
return useQuery({
queryKey: ["labels", taskId],
queryFn: () => getLabelsByTask({ taskId }),
+ select: (labels) =>
+ [...labels].sort((a, b) => localeCompareSort(a.name, b.name, locale)),
refetchOnMount: true,
});
}
diff --git a/apps/web/src/hooks/queries/label/use-get-labels-by-workspace.ts b/apps/web/src/hooks/queries/label/use-get-labels-by-workspace.ts
index dc80e91e0..c85e61dbb 100644
--- a/apps/web/src/hooks/queries/label/use-get-labels-by-workspace.ts
+++ b/apps/web/src/hooks/queries/label/use-get-labels-by-workspace.ts
@@ -1,11 +1,18 @@
import { useQuery } from "@tanstack/react-query";
+import { useTranslation } from "react-i18next";
import getLabelsByWorkspace from "@/fetchers/label/get-label-by-workspace";
+import { localeCompareSort } from "@/lib/format";
function useGetLabelsByWorkspace(workspaceId: string) {
+ const { i18n } = useTranslation();
+ const locale = i18n.resolvedLanguage || i18n.language;
+
return useQuery({
enabled: Boolean(workspaceId),
queryKey: ["labels", workspaceId],
queryFn: () => getLabelsByWorkspace({ workspaceId }),
+ select: (labels) =>
+ [...labels].sort((a, b) => localeCompareSort(a.name, b.name, locale)),
});
}
diff --git a/apps/web/src/lib/format.ts b/apps/web/src/lib/format.ts
index 8fd607a70..2706aeba3 100644
--- a/apps/web/src/lib/format.ts
+++ b/apps/web/src/lib/format.ts
@@ -10,6 +10,21 @@ function getLocale(locale?: string) {
return locale || i18n.resolvedLanguage || i18n.language || "en-US";
}
+const collators = new Map<string, Intl.Collator>();
+
+export function localeCompareSort(a: string, b: string, locale?: string) {
+ const key = getLocale(locale);
+ let collator = collators.get(key);
+ if (!collator) {
+ collator = new Intl.Collator(key, {
+ sensitivity: "base",
+ numeric: true,
+ });
+ collators.set(key, collator);
+ }
+ return collator.compare(a, b);
+}
+
export function formatDate(
value: DateInput,
options?: Intl.DateTimeFormatOptions,