From d428fb6cb5426e0da2a986cbabf601c1a9479141 Mon Sep 17 00:00:00 2001
From: Cristhian Zanforlin Lousa <cristhian.lousa@gmail.com>
Date: Thu, 16 Jan 2025 13:05:04 -0300
Subject: [PATCH] feat: Add data-testid and id attributes to app header
 components for testing (#5724)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* 📝 (AccountMenu/index.tsx): Add span elements with data-testid and id attributes for menu buttons for better testing and accessibility
📝 (FlowMenu/index.tsx): Add data-testid and id attributes to div elements for menu buttons for better testing and accessibility
📝 (HeaderMenu/index.tsx): Add data-testid and id attributes to DropdownMenuTrigger for user menu button for better testing and accessibility
📝 (ThemeButtons/index.tsx): Add data-testid and id attributes to Button elements for theme change buttons for better testing and accessibility
📝 (flowToolbarComponent/index.tsx): Add data-testid and id attributes to div element for API button modal for better testing and accessibility

* ✨ (FlowMenu/index.tsx): add data-testid attributes to elements for easier testing and debugging
✨ (AppHeaderComponent/index.tsx): add data-testid attributes to header sections for easier testing and debugging
---
 .../components/AccountMenu/index.tsx          | 44 ++++++++++++++---
 .../components/FlowMenu/index.tsx             | 49 ++++++++++++++++---
 .../components/HeaderMenu/index.tsx           |  6 ++-
 .../components/ThemeButtons/index.tsx         |  6 +++
 .../core/appHeaderComponent/index.tsx         | 10 +++-
 .../core/flowToolbarComponent/index.tsx       |  6 ++-
 6 files changed, 103 insertions(+), 18 deletions(-)

diff --git a/src/frontend/src/components/core/appHeaderComponent/components/AccountMenu/index.tsx b/src/frontend/src/components/core/appHeaderComponent/components/AccountMenu/index.tsx
index bb18866b2..28063e3a1 100644
--- a/src/frontend/src/components/core/appHeaderComponent/components/AccountMenu/index.tsx
+++ b/src/frontend/src/components/core/appHeaderComponent/components/AccountMenu/index.tsx
@@ -57,7 +57,12 @@ export const AccountMenu = () => {
           <HeaderMenuItemsSection>
             <div className="flex h-[46px] w-full items-center justify-between px-3">
               <div className="pl-1 text-xs text-zinc-500">
-                Version {version}
+                <span
+                  data-testid="menu_version_button"
+                  id="menu_version_button"
+                >
+                  Version {version}
+                </span>
               </div>
               {!ENABLE_DATASTAX_LANGFLOW && <ThemeButtons />}
             </div>
@@ -72,25 +77,42 @@ export const AccountMenu = () => {
                   navigate("/settings");
                 }}
               >
-                Settings
+                <span
+                  data-testid="menu_settings_button"
+                  id="menu_settings_button"
+                >
+                  Settings
+                </span>
               </HeaderMenuItemButton>
             )}
             {!ENABLE_DATASTAX_LANGFLOW && (
               <>
                 {isAdmin && !autoLogin && (
                   <HeaderMenuItemButton onClick={() => navigate("/admin")}>
-                    Admin Page
+                    <span
+                      data-testid="menu_admin_button"
+                      id="menu_admin_button"
+                    >
+                      Admin Page
+                    </span>
                   </HeaderMenuItemButton>
                 )}
               </>
             )}
             {ENABLE_DATASTAX_LANGFLOW ? (
               <HeaderMenuItemButton onClick={() => setIsFeedbackOpen(true)}>
-                Feedback
+                <span
+                  data-testid="menu_feedback_button"
+                  id="menu_feedback_button"
+                >
+                  Feedback
+                </span>
               </HeaderMenuItemButton>
             ) : (
               <HeaderMenuItemLink newPage href="https://docs.langflow.org">
-                Docs
+                <span data-testid="menu_docs_button" id="menu_docs_button">
+                  Docs
+                </span>
               </HeaderMenuItemLink>
             )}
           </HeaderMenuItemsSection>
@@ -110,14 +132,20 @@ export const AccountMenu = () => {
                 newPage
                 href="https://github.com/langflow-ai/langflow/discussions"
               >
-                Share Feedback on Github
+                <span data-testid="menu_github_button" id="menu_github_button">
+                  Share Feedback on Github
+                </span>
               </HeaderMenuItemLink>
             )}
             <HeaderMenuItemLink newPage href="https://twitter.com/langflow_ai">
-              Follow Langflow on X
+              <span data-testid="menu_twitter_button" id="menu_twitter_button">
+                Follow Langflow on X
+              </span>
             </HeaderMenuItemLink>
             <HeaderMenuItemLink newPage href="https://discord.gg/EqksyE2EX9">
-              Join the Langflow Discord
+              <span data-testid="menu_discord_button" id="menu_discord_button">
+                Join the Langflow Discord
+              </span>
             </HeaderMenuItemLink>
           </HeaderMenuItemsSection>
           {ENABLE_DATASTAX_LANGFLOW ? (
diff --git a/src/frontend/src/components/core/appHeaderComponent/components/FlowMenu/index.tsx b/src/frontend/src/components/core/appHeaderComponent/components/FlowMenu/index.tsx
index 5db3d6896..3b8da45c5 100644
--- a/src/frontend/src/components/core/appHeaderComponent/components/FlowMenu/index.tsx
+++ b/src/frontend/src/components/core/appHeaderComponent/components/FlowMenu/index.tsx
@@ -123,7 +123,11 @@ export const MenuBar = ({}: {}): JSX.Element => {
     }
     // return savedText;
     return (
-      <div className="shrink-0 text-xs font-medium text-accent-emerald-foreground">
+      <div
+        data-testid="menu_status_saved_flow_button"
+        id="menu_status_saved_flow_button"
+        className="shrink-0 text-xs font-medium text-accent-emerald-foreground"
+      >
         Saved
       </div>
     );
@@ -213,8 +217,15 @@ export const MenuBar = ({}: {}): JSX.Element => {
   ]);
 
   return currentFlow && onFlowPage ? (
-    <div className="flex items-center justify-center gap-2 truncate">
-      <div className="header-menu-bar hidden w-20 max-w-fit grow justify-end truncate md:flex">
+    <div
+      className="flex items-center justify-center gap-2 truncate"
+      data-testid="menu_bar_wrapper"
+    >
+      <div
+        className="header-menu-bar hidden w-20 max-w-fit grow justify-end truncate md:flex"
+        data-testid="menu_flow_bar"
+        id="menu_flow_bar_navigation"
+      >
         {currentFolder?.name && (
           <div className="hidden truncate md:flex">
             <div
@@ -232,12 +243,21 @@ export const MenuBar = ({}: {}): JSX.Element => {
           </div>
         )}
       </div>
-      <div className="hidden w-fit shrink-0 select-none font-normal text-muted-foreground md:flex">
+      <div
+        className="hidden w-fit shrink-0 select-none font-normal text-muted-foreground md:flex"
+        data-testid="menu_bar_separator"
+      >
         /
       </div>
 
-      <div className="overflow-hidden truncate text-sm sm:whitespace-normal">
-        <div className="header-menu-bar-display-2 truncate">
+      <div
+        className="overflow-hidden truncate text-sm sm:whitespace-normal"
+        data-testid="menu_bar_display"
+      >
+        <div
+          className="header-menu-bar-display-2 truncate"
+          data-testid="menu_bar_display_wrapper"
+        >
           <div
             className="header-menu-flow-name-2 truncate"
             data-testid="flow-configuration-button"
@@ -273,6 +293,7 @@ export const MenuBar = ({}: {}): JSX.Element => {
               <div
                 className="truncate font-semibold text-primary"
                 data-testid="flow_name"
+                id="flow_name"
                 onClick={() => {
                   setEditingName(true);
                   setFlowName(currentFlow.name);
@@ -299,6 +320,8 @@ export const MenuBar = ({}: {}): JSX.Element => {
                   handleAddFlow();
                 }}
                 className="cursor-pointer"
+                data-testid="menu_new_flow_button"
+                id="menu_new_flow_button"
               >
                 <IconComponent name="Plus" className="header-menu-options" />
                 New
@@ -309,6 +332,8 @@ export const MenuBar = ({}: {}): JSX.Element => {
                   setOpenSettings(true);
                 }}
                 className="cursor-pointer"
+                data-testid="menu_edit_flow_button"
+                id="menu_edit_flow_button"
               >
                 <IconComponent
                   name="SquarePen"
@@ -320,6 +345,8 @@ export const MenuBar = ({}: {}): JSX.Element => {
                 <DropdownMenuItem
                   onClick={handleSave}
                   className="cursor-pointer"
+                  data-testid="menu_save_flow_button"
+                  id="menu_save_flow_button"
                 >
                   <ToolbarSelectItem
                     value="Save"
@@ -338,6 +365,8 @@ export const MenuBar = ({}: {}): JSX.Element => {
                   setOpenLogs(true);
                 }}
                 className="cursor-pointer"
+                data-testid="menu_logs_flow_button"
+                id="menu_logs_flow_button"
               >
                 <IconComponent
                   name="ScrollText"
@@ -361,6 +390,8 @@ export const MenuBar = ({}: {}): JSX.Element => {
                       });
                     });
                 }}
+                data-testid="menu_import_flow_button"
+                id="menu_import_flow_button"
               >
                 <IconComponent name="FileUp" className="header-menu-options" />
                 Import
@@ -379,6 +410,8 @@ export const MenuBar = ({}: {}): JSX.Element => {
                   undo();
                 }}
                 className="cursor-pointer"
+                data-testid="menu_undo_flow_button"
+                id="menu_undo_flow_button"
               >
                 <ToolbarSelectItem
                   value="Undo"
@@ -395,6 +428,8 @@ export const MenuBar = ({}: {}): JSX.Element => {
                   redo();
                 }}
                 className="cursor-pointer"
+                data-testid="menu_redo_flow_button"
+                id="menu_redo_flow_button"
               >
                 <ToolbarSelectItem
                   value="Redo"
@@ -411,6 +446,8 @@ export const MenuBar = ({}: {}): JSX.Element => {
                   handleReloadComponents();
                 }}
                 className="cursor-pointer"
+                data-testid="menu_refresh_flow_button"
+                id="menu_refresh_flow_button"
               >
                 <IconComponent
                   name="RefreshCcw"
diff --git a/src/frontend/src/components/core/appHeaderComponent/components/HeaderMenu/index.tsx b/src/frontend/src/components/core/appHeaderComponent/components/HeaderMenu/index.tsx
index 48a7d42e6..414e687bf 100644
--- a/src/frontend/src/components/core/appHeaderComponent/components/HeaderMenu/index.tsx
+++ b/src/frontend/src/components/core/appHeaderComponent/components/HeaderMenu/index.tsx
@@ -15,7 +15,11 @@ export const HeaderMenu = ({ children }) => (
 );
 
 export const HeaderMenuToggle = ({ children }) => (
-  <DropdownMenuTrigger className="group inline-flex w-full items-center justify-center gap-1 rounded-md pr-0">
+  <DropdownMenuTrigger
+    className="group inline-flex w-full items-center justify-center gap-1 rounded-md pr-0"
+    data-testid="user_menu_button"
+    id="user_menu_button"
+  >
     <div className="flex items-center gap-1 rounded-lg px-2 py-1.5 group-hover:bg-muted">
       {children}
       <ChevronsUpDown
diff --git a/src/frontend/src/components/core/appHeaderComponent/components/ThemeButtons/index.tsx b/src/frontend/src/components/core/appHeaderComponent/components/ThemeButtons/index.tsx
index 697b78468..92c8c223d 100644
--- a/src/frontend/src/components/core/appHeaderComponent/components/ThemeButtons/index.tsx
+++ b/src/frontend/src/components/core/appHeaderComponent/components/ThemeButtons/index.tsx
@@ -57,6 +57,8 @@ export const ThemeButtons = () => {
             : "text-foreground hover:bg-amber-400 hover:text-background"
         }`}
         onClick={() => handleThemeChange("light")}
+        data-testid="menu_light_button"
+        id="menu_light_button"
       >
         <ForwardedIconComponent name="Sun" className="w-4" />
       </Button>
@@ -70,6 +72,8 @@ export const ThemeButtons = () => {
             : "text-foreground hover:bg-purple-400 hover:text-background"
         }`}
         onClick={() => handleThemeChange("dark")}
+        data-testid="menu_dark_button"
+        id="menu_dark_button"
       >
         <ForwardedIconComponent name="Moon" className="w-4" />
       </Button>
@@ -83,6 +87,8 @@ export const ThemeButtons = () => {
             : "hover:bg-foreground hover:text-background"
         }`}
         onClick={() => handleThemeChange("system")}
+        data-testid="menu_system_button"
+        id="menu_system_button"
       >
         <ForwardedIconComponent name="Monitor" className="w-4" />
       </Button>
diff --git a/src/frontend/src/components/core/appHeaderComponent/index.tsx b/src/frontend/src/components/core/appHeaderComponent/index.tsx
index 7529302eb..d72fa9136 100644
--- a/src/frontend/src/components/core/appHeaderComponent/index.tsx
+++ b/src/frontend/src/components/core/appHeaderComponent/index.tsx
@@ -49,7 +49,10 @@ export default function AppHeader(): JSX.Element {
   return (
     <div className="flex h-[62px] w-full items-center justify-between gap-2 border-b px-5 py-2.5 dark:bg-background">
       {/* Left Section */}
-      <div className={`flex items-center gap-2`}>
+      <div
+        className={`flex items-center gap-2`}
+        data-testid="header_left_section_wrapper"
+      >
         <Button
           unstyled
           onClick={() => navigate("/")}
@@ -78,7 +81,10 @@ export default function AppHeader(): JSX.Element {
       </div>
 
       {/* Right Section */}
-      <div className={`flex items-center gap-2`}>
+      <div
+        className={`flex items-center gap-2`}
+        data-testid="header_right_section_wrapper"
+      >
         {!ENABLE_DATASTAX_LANGFLOW && (
           <>
             <Button
diff --git a/src/frontend/src/components/core/flowToolbarComponent/index.tsx b/src/frontend/src/components/core/flowToolbarComponent/index.tsx
index cc96c5881..2bafd8b79 100644
--- a/src/frontend/src/components/core/flowToolbarComponent/index.tsx
+++ b/src/frontend/src/components/core/flowToolbarComponent/index.tsx
@@ -134,7 +134,11 @@ export default function FlowToolbar(): JSX.Element {
             </div>
             {ENABLE_API && (
               <>
-                <div className="flex cursor-pointer items-center gap-2">
+                <div
+                  className="flex cursor-pointer items-center gap-2"
+                  data-testid="api_button_modal"
+                  id="api_button_modal"
+                >
                   {currentFlow && currentFlow.data && (
                     <ApiModal
                       flow={currentFlow}