Scheduling infrastructure for absolutely everyone.
fix: Make it easier to manage group options and also improve attribute options performance with 100s of options (#18486)
Hariom Balhara2e9beb8513fb
diff --git a/apps/web/public/static/locales/en/common.json b/apps/web/public/static/locales/en/common.jsonindex 42b54203a93..7a1877a9f5b 100644--- a/apps/web/public/static/locales/en/common.json+++ b/apps/web/public/static/locales/en/common.json@@ -2917,5 +2917,8 @@"dry_run_mode_active": "You are doing a test booking.","icon_showcase": "Icon showcase","icons_showcase": "Icons showcase",+ "choose_an_option": "Choose an option",+ "enter_option_value": "Enter option value",+ "remove_option": "Remove option","ADD_NEW_STRINGS_ABOVE_THIS_LINE_TO_PREVENT_MERGE_CONFLICTS": "↑↑↑↑↑↑↑↑↑↑↑↑↑ Add your new strings above here ↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑"}\ No newline at end of filediff --git a/packages/features/ee/organizations/pages/settings/attributes/AttributesForm.tsx b/packages/features/ee/organizations/pages/settings/attributes/AttributesForm.tsxindex 96abe8d37cc..f4332c50c0e 100644--- a/packages/features/ee/organizations/pages/settings/attributes/AttributesForm.tsx+++ b/packages/features/ee/organizations/pages/settings/attributes/AttributesForm.tsx@@ -1,11 +1,10 @@-import { useAutoAnimate } from "@formkit/auto-animate/react";import { zodResolver } from "@hookform/resolvers/zod";import React, { useState } from "react";+import type { UseFormReturn, FieldArrayWithId } from "react-hook-form";import { Controller, useForm, useFieldArray } from "react-hook-form";import { z } from "zod";import { useLocale } from "@calcom/lib/hooks/useLocale";-import { entries } from "@calcom/prisma/zod-utils";import {Button,Form,@@ -18,7 +17,7 @@ import {SettingsToggle,} from "@calcom/ui";-const AttributeFormSchema = z.object({+const attributeFormSchema = z.object({attrName: z.string().min(1),isLocked: z.boolean().optional(),isWeightsEnabled: z.boolean().optional(),@@ -35,7 +34,7 @@ const AttributeFormSchema = z.object({),});-type FormValues = z.infer<typeof AttributeFormSchema>;+type AttributeFormValues = z.infer<typeof attributeFormSchema>;const AttributeTypeOptions = [{ value: "TEXT", label: "Text" },@@ -45,8 +44,8 @@ const AttributeTypeOptions = [];interface AttributeFormProps {- initialValues?: FormValues;- onSubmit: (values: FormValues) => void;+ initialValues?: AttributeFormValues;+ onSubmit: (values: AttributeFormValues) => void;header: React.ReactNode;}@@ -119,6 +118,177 @@ export function getGroupOptionUpdate({}}+type AttributeOption = {+ value: string;+ id?: string;+ assignedUsers?: number;+ isGroup?: boolean;+ contains?: string[];+ attributeOptionId?: string;+};++const NonGroupOption = ({+ option,+ index,+ form,+ removeOption,+ setDeleteOptionDialog,+}: {+ option: AttributeOption;+ index: number;+ form: UseFormReturn<AttributeFormValues>;+ removeOption: (index: number) => void;+ setDeleteOptionDialog: (value: { id: number; open: boolean }) => void;+}) => {+ const { t } = useLocale();+ return (+ <div key={option.id}>+ <div className="flex items-center gap-2" key={option.id}>+ <div className="flex w-full">+ <Input {...form.register(`options.${index}.value`)} placeholder={t("enter_option_value")} />+ </div>+ <Button+ type="button"+ variant="icon"+ StartIcon="x"+ color="minimal"+ className="mb-2"+ disabled={index === 0 && form.getValues("options").length === 1}+ onClick={() => {+ if (option.assignedUsers && option.assignedUsers > 0) {+ setDeleteOptionDialog({ id: index, open: true });+ } else {+ removeOption(index);+ }+ }}+ title={t("remove_option")}+ />+ </div>+ <Input {...form.register(`options.${index}.id`)} className="hidden" />+ </div>+ );+};++const getNonGroupOptionsForSelect = (nonGroupOptions: AttributeOption[]) => {+ return nonGroupOptions+ .map((f) => ({+ label: f.value,+ value: f.attributeOptionId,+ }))+ .filter((option): option is { label: string; value: string } => !!option.value);+};++const getSelectedNonGroupOptions = (option: AttributeOption, nonGroupOptions: AttributeOption[]) => {+ return option.contains+ ?.map((containedId: string) => {+ const nonGroupOption = nonGroupOptions.find((opt) => opt.attributeOptionId === containedId);+ if (!nonGroupOption?.value || !nonGroupOption?.attributeOptionId) return null;+ return {+ label: nonGroupOption.value,+ value: nonGroupOption.attributeOptionId,+ };+ })+ .filter((val): val is { label: string; value: string } => val !== null);+};++const GroupOption = ({+ option,+ index,+ form,+ removeOption,+ setDeleteOptionDialog,+}: {+ option: AttributeOption;+ index: number;+ form: UseFormReturn<AttributeFormValues>;+ removeOption: (index: number) => void;+ setDeleteOptionDialog: (value: { id: number; open: boolean }) => void;+}) => {+ const { t } = useLocale();+ const watchedOptions = form.getValues("options") as AttributeOption[];+ if (!watchedOptions) return null;++ const watchedNonGroupOptions = watchedOptions.filter((field): field is AttributeOption => !field.isGroup);+ if (!watchedNonGroupOptions.length) return null;++ const nonGroupOptionsSelectFieldOptions = getNonGroupOptionsForSelect(watchedNonGroupOptions);+ const nonGroupOptionsSelectFieldSelectedValue = getSelectedNonGroupOptions(option, watchedNonGroupOptions);++ return (+ <div key={option.id}>+ <div className="mb-2 flex items-center gap-2" key={option.id}>+ <div className="flex w-full items-center justify-between gap-2">+ <Input {...form.register(`options.${index}.value`)} className="!mb-0 w-36" />+ <SelectField+ isMulti+ placeholder={t("choose_an_option")}+ options={nonGroupOptionsSelectFieldOptions}+ value={nonGroupOptionsSelectFieldSelectedValue}+ onChange={(chosenNonGroupOptions) => {+ const newContains = chosenNonGroupOptions.map((opt) => opt.value);+ form.setValue(`options.${index}.contains`, newContains);+ }}+ containerClassName="w-full"+ />+ </div>+ <Button+ type="button"+ variant="icon"+ StartIcon="x"+ color="minimal"+ className="mb-2"+ disabled={index === 0 && form.getValues("options").length === 1}+ onClick={() => {+ if (option.assignedUsers && option.assignedUsers > 0) {+ setDeleteOptionDialog({ id: index, open: true });+ } else {+ removeOption(index);+ }+ }}+ />+ </div>+ <Input {...form.register(`options.${index}.id`)} className="hidden" />+ </div>+ );+};++const GroupOptions = ({+ fields,+ watchedOptions,+ form,+ removeOption,+ setDeleteOptionDialog,+}: {+ fields: FieldArrayWithId<AttributeFormValues, "options", "id">[];+ watchedOptions: AttributeOption[];+ form: UseFormReturn<AttributeFormValues>;+ removeOption: (index: number) => void;+ setDeleteOptionDialog: (value: { id: number; open: boolean }) => void;+}) => {+ const { t } = useLocale();+ return (+ <>+ <Label>{t("Group Options")}</Label>+ <div>+ {fields.map((option, index) => {+ const isAGroupOption = option.isGroup;+ if (!isAGroupOption) return null;+ return (+ <GroupOption+ key={option.id}+ option={watchedOptions[index]}+ index={index}+ form={form}+ removeOption={removeOption}+ setDeleteOptionDialog={setDeleteOptionDialog}+ />+ );+ })}+ </div>+ </>+ );+};+export function AttributeForm({ initialValues, onSubmit, header }: AttributeFormProps) {const { t } = useLocale();const [deleteOptionDialog, setDeleteOptionDialog] = useState<{@@ -128,12 +298,8 @@ export function AttributeForm({ initialValues, onSubmit, header }: AttributeFormid: undefined,open: false,});- const [listRef] = useAutoAnimate<HTMLDivElement>({- duration: 300,- easing: "ease-in-out",- });- // Needed because useFieldArray overrides the id field+ // Needed because fields returned by useFieldArray have their own id field overriding the id field of the option object.const initialValuesEnsuringThatOptionIdIsNotInId = initialValues? {...initialValues,@@ -147,8 +313,8 @@ export function AttributeForm({ initialValues, onSubmit, header }: AttributeForm}: undefined;- const form = useForm<FormValues>({- resolver: zodResolver(AttributeFormSchema),+ const form = useForm<AttributeFormValues>({+ resolver: zodResolver(attributeFormSchema),defaultValues: initialValuesEnsuringThatOptionIdIsNotInId || {attrName: "",options: [{ value: "", isGroup: false }],@@ -161,8 +327,40 @@ export function AttributeForm({ initialValues, onSubmit, header }: AttributeFormname: "options",});- const watchedOptions = form.watch("options");- const watchedGroupOptions = watchedOptions.filter((field) => field.isGroup);+ const removeOption = (index: number) => {+ // Update contains array of any group that has this option+ const optionToRemove = watchedOptions[index];+ if (!optionToRemove.isGroup && optionToRemove.attributeOptionId) {+ const updatedOptions = getUpdatedOptionsAfterRemovingNonGroupOption({+ optionToRemove,+ watchedOptions,+ });+ form.setValue("options", updatedOptions);+ }+ remove(index);+ };++ const getUpdatedOptionsAfterRemovingNonGroupOption = ({+ optionToRemove,+ watchedOptions,+ }: {+ optionToRemove: AttributeOption;+ watchedOptions: AttributeOption[];+ }) => {+ const attributeOptionIdToRemove = optionToRemove.attributeOptionId;+ if (!attributeOptionIdToRemove) return watchedOptions;+ return watchedOptions.map((option) => {+ if (option.isGroup && option.contains) {+ return {+ ...option,+ contains: option.contains.filter((id) => id !== attributeOptionIdToRemove),+ };+ }+ return option;+ });+ };++ const watchedOptions = form.watch("options") as AttributeOption[];const watchedType = form.watch("type");return (<Form@@ -232,74 +430,19 @@ export function AttributeForm({ initialValues, onSubmit, header }: AttributeForm<div className="flex flex-col gap-2"><div><Label>{t("options")}</Label>- <div ref={listRef}>- {watchedOptions.map((nonGroupOption, index) => {- const isAGroupOption = nonGroupOption.isGroup;+ <div>+ {fields.map((option, index) => {+ const isAGroupOption = option.isGroup;if (isAGroupOption) return null;- const groupOptionsSelectFieldSelectedValue = watchedGroupOptions- ?.filter(- ({ contains }) =>- nonGroupOption.attributeOptionId &&- contains?.includes(nonGroupOption.attributeOptionId)- )- .map((groupOption) => ({- label: groupOption.value,- value: groupOption.attributeOptionId,- }));-- const groupOptionsSelectFieldOptions = watchedGroupOptions- .map((f) => ({- label: f.value,- value: f.attributeOptionId,- }))- .filter((option): option is { label: string; value: string } => !!option.value);-return (- <>- <div className="flex items-center gap-2" key={nonGroupOption.id}>- <div className="flex w-full justify-between gap-2">- <Input {...form.register(`options.${index}.value`)} />- <SelectField- isMulti- isDisabled={!nonGroupOption.attributeOptionId}- placeholder="Add to group"- options={groupOptionsSelectFieldOptions}- value={groupOptionsSelectFieldSelectedValue}- onChange={(chosenGroupOptions) => {- // subOption is the option that is being added to groups- const subOption = nonGroupOption;- const optionsUpdate = getGroupOptionUpdate({- // Spread makes it non-readonly- newGroupOptions: [...chosenGroupOptions],- previousGroupOptions: groupOptionsSelectFieldSelectedValue,- subOption,- allOptions: watchedOptions,- });- entries(optionsUpdate).forEach(([index, value]) => {- form.setValue(`options.${index}.contains`, value);- });- }}- className="min-w-64"- />- </div>- <Button- type="button"- variant="icon"- StartIcon="x"- color="minimal"- className="mb-2"- disabled={index === 0 && fields.length === 1}- onClick={() => {- if (nonGroupOption.assignedUsers && nonGroupOption.assignedUsers > 0) {- setDeleteOptionDialog({ id: index, open: true });- } else {- remove(index);- }- }}- />- </div>- <Input {...form.register(`options.${index}.id`)} className="hidden" />- </>+ <NonGroupOption+ key={option.id}+ option={watchedOptions[index]}+ index={index}+ form={form}+ removeOption={removeOption}+ setDeleteOptionDialog={setDeleteOptionDialog}+ />);})}</div>@@ -308,38 +451,13 @@ export function AttributeForm({ initialValues, onSubmit, header }: AttributeForm</Button></div><div className="mt-6">- <Label>{t("Group Options")}</Label>- <div ref={listRef}>- {watchedOptions.map((watchedOption, index) => {- const isAGroupOption = watchedOption.isGroup;- if (!isAGroupOption) return null;- return (- <>- <div className="flex items-center gap-2" key={watchedOption.id}>- <div className="flex w-full">- <Input {...form.register(`options.${index}.value`)} className="w-full" />- </div>- <Button- type="button"- variant="icon"- StartIcon="x"- color="minimal"- className="mb-2"- disabled={index === 0 && fields.length === 1}- onClick={() => {- if (watchedOption.assignedUsers && watchedOption.assignedUsers > 0) {- setDeleteOptionDialog({ id: index, open: true });- } else {- remove(index);- }- }}- />- </div>- <Input {...form.register(`options.${index}.id`)} className="hidden" />- </>- );- })}- </div>+ <GroupOptions+ fields={fields}+ watchedOptions={watchedOptions}+ form={form}+ removeOption={removeOption}+ setDeleteOptionDialog={setDeleteOptionDialog}+ /><Buttontype="button"StartIcon="plus"@@ -358,7 +476,7 @@ export function AttributeForm({ initialValues, onSubmit, header }: AttributeFormtitle={t("delete_attribute")}confirmBtnText={t("delete")}onConfirm={() => {- remove(deleteOptionDialog.id as number);+ removeOption(deleteOptionDialog.id as number);setDeleteOptionDialog({ id: undefined, open: false });}}loadingText={t("deleting_attribute")}>diff --git a/packages/features/ee/organizations/pages/settings/attributes/__tests__/AttributeForm.test.tsx b/packages/features/ee/organizations/pages/settings/attributes/__tests__/AttributeForm.test.tsxnew file mode 100644index 00000000000..48d655641dd--- /dev/null+++ b/packages/features/ee/organizations/pages/settings/attributes/__tests__/AttributeForm.test.tsx@@ -0,0 +1,184 @@+import { render, screen, waitFor } from "@testing-library/react";+import userEvent from "@testing-library/user-event";+import React from "react";+import type { Mock } from "vitest";+import { vi } from "vitest";++import { Button } from "@calcom/ui";++import { AttributeForm } from "../AttributesForm";++vi.mock("@calcom/lib/hooks/useLocale", () => ({+ useLocale: vi.fn(() => ({+ t: (key: string) => key,+ })),+}));++type InitialOption = {+ id?: string;+ value: string;+ isGroup?: boolean;+ contains?: string[];+ attributeOptionId?: string;+ assignedUsers?: number;+};++// Page Object Functions+const AttributeFormActions = {+ setup: () => {+ const user = userEvent.setup();+ const mockOnSubmit = vi.fn();+ return { user, mockOnSubmit };+ },++ render: (initialOptions: InitialOption[], mockOnSubmit: Mock) => {+ return render(+ <AttributeForm+ onSubmit={mockOnSubmit}+ initialValues={{+ attrName: "Teams",+ type: "MULTI_SELECT",+ options: initialOptions,+ }}+ header={<Button type="submit">Save</Button>}+ />+ );+ },++ addOptionToGroup: async (user: ReturnType<typeof userEvent.setup>) => {+ const selects = await screen.findAllByText("choose_an_option");+ await user.click(selects[0]);+ },++ selectOption: async (user: ReturnType<typeof userEvent.setup>, optionText: string) => {+ const option = await screen.findByText(optionText);+ await user.click(option);+ },++ submitForm: async (user: ReturnType<typeof userEvent.setup>) => {+ const submitButton = screen.getByRole("button", { name: "Save" });+ await user.click(submitButton);+ },++ deleteOption: async (user: ReturnType<typeof userEvent.setup>, index: number) => {+ const deleteButtons = screen.getAllByTitle("remove_option");+ await user.click(deleteButtons[index]);+ },++ expectGroupContainsOptions: async (mockOnSubmit: Mock, groupValue: string, containsIds: string[]) => {+ await waitFor(() => {+ expect(mockOnSubmit).toHaveBeenCalledWith(+ expect.objectContaining({+ options: expect.arrayContaining([+ expect.objectContaining({+ value: groupValue,+ isGroup: true,+ contains: expect.arrayContaining(containsIds),+ }),+ ]),+ })+ );+ });+ },++ expectGroupNotContainsOptions: async (mockOnSubmit: Mock, groupValue: string, notContainsIds: string[]) => {+ await waitFor(() => {+ expect(mockOnSubmit).toHaveBeenCalledWith(+ expect.objectContaining({+ options: expect.arrayContaining([+ expect.objectContaining({+ value: groupValue,+ isGroup: true,+ contains: expect.not.arrayContaining(notContainsIds),+ }),+ ]),+ })+ );+ });+ },++ expectDeleteConfirmationDialog: () => {+ expect(screen.getByText("delete_attribute")).toBeInTheDocument();+ expect(screen.getByText("delete_attribute_description")).toBeInTheDocument();+ },++ expectOptionToBeDeleted: async (mockOnSubmit: Mock, optionValue: string) => {+ await waitFor(() => {+ expect(mockOnSubmit).toHaveBeenCalledWith(+ expect.objectContaining({+ options: expect.not.arrayContaining([+ expect.objectContaining({+ value: optionValue,+ }),+ ]),+ })+ );+ });+ },+};++const initialOptionsWithAGroupHavingOptions: InitialOption[] = [+ { id: "1", value: "Engineering", isGroup: false, attributeOptionId: "1" },+ { id: "2", value: "Design", isGroup: false, attributeOptionId: "2" },+ { id: "3", value: "Product", isGroup: false, attributeOptionId: "3" },+ {+ id: "4",+ value: "Tech Teams",+ isGroup: true,+ contains: ["1", "3"],+ attributeOptionId: "4",+ },+];++const initialOptionsWithAGroupHavingNoOptions: InitialOption[] = [+ { id: "1", value: "Engineering", isGroup: false, attributeOptionId: "1" },+ { id: "2", value: "Design", isGroup: false, attributeOptionId: "2" },+ { id: "3", value: "Product", isGroup: false, attributeOptionId: "3" },+ {+ id: "4",+ value: "Tech Teams",+ isGroup: true,+ contains: [],+ attributeOptionId: "4",+ },+];++describe("AttributeForm", () => {+ describe("Group Options Handling", () => {+ it("should handle adding non-group options to existing group", async () => {+ const { user, mockOnSubmit } = AttributeFormActions.setup();+ AttributeFormActions.render(initialOptionsWithAGroupHavingNoOptions, mockOnSubmit);++ await AttributeFormActions.addOptionToGroup(user);+ await AttributeFormActions.selectOption(user, "Design");+ await AttributeFormActions.submitForm(user);++ await AttributeFormActions.expectGroupContainsOptions(mockOnSubmit, "Tech Teams", ["2"]);+ });++ it("should handle removing options from group when the option is deleted", async () => {+ const { user, mockOnSubmit } = AttributeFormActions.setup();+ AttributeFormActions.render(initialOptionsWithAGroupHavingOptions, mockOnSubmit);++ await AttributeFormActions.deleteOption(user, 0);+ await AttributeFormActions.submitForm(user);+ await AttributeFormActions.expectGroupNotContainsOptions(mockOnSubmit, "Tech Teams", ["1"]);+ await AttributeFormActions.expectOptionToBeDeleted(mockOnSubmit, "Engineering");+ });++ it("should take confirmation before deleting option with assigned users", async () => {+ const { user, mockOnSubmit } = AttributeFormActions.setup();+ const optionsWithAssignedUsers = initialOptionsWithAGroupHavingOptions.map((opt) =>+ opt.value === "Engineering" ? { ...opt, assignedUsers: 5 } : opt+ );++ AttributeFormActions.render(optionsWithAssignedUsers, mockOnSubmit);+ await AttributeFormActions.deleteOption(user, 0);+ AttributeFormActions.expectDeleteConfirmationDialog();+ const confirmationButton = screen.getByTestId("dialog-confirmation");+ await user.click(confirmationButton);+ await AttributeFormActions.submitForm(user);+ await AttributeFormActions.expectGroupNotContainsOptions(mockOnSubmit, "Tech Teams", ["1"]);+ });+ });+});