From 9491ab9a936fc21772ff84f75bce9d2fe291d0dc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Laura=20Fern=C3=A1ndez?= <laura.fernandez@grafana.com>
Date: Wed, 9 Oct 2024 10:43:01 +0200
Subject: [PATCH] Bookmarks: Create e2e tests (#90373)

---
 e2e/utils/flows/userPreferences.ts            |  5 +-
 e2e/various-suite/bookmarks.spec.ts           | 62 +++++++++++++++++++
 .../AppChrome/MegaMenu/MegaMenuItemText.tsx   |  4 +-
 3 files changed, 68 insertions(+), 3 deletions(-)
 create mode 100644 e2e/various-suite/bookmarks.spec.ts

diff --git a/e2e/utils/flows/userPreferences.ts b/e2e/utils/flows/userPreferences.ts
index 621bff04ce6..c69254ac623 100644
--- a/e2e/utils/flows/userPreferences.ts
+++ b/e2e/utils/flows/userPreferences.ts
@@ -5,7 +5,10 @@ import { fromBaseUrl } from '../support/url';
 
 const defaultUserPreferences = {
   timezone: '', // "Default" option
-} as const; // TODO: when we update typescript >4.9 change to `as const satisfies UserPreferencesDTO`
+  navbar: {
+    bookmarkUrls: [],
+  },
+} as const satisfies UserPreferencesDTO; // TODO: when we update typescript >4.9 change to `as const satisfies UserPreferencesDTO`
 
 // Only accept preferences we have defaults for as arguments. To allow a new preference to be set, add a default for it
 type UserPreferences = Pick<UserPreferencesDTO, keyof typeof defaultUserPreferences>;
diff --git a/e2e/various-suite/bookmarks.spec.ts b/e2e/various-suite/bookmarks.spec.ts
new file mode 100644
index 00000000000..6b607c414c4
--- /dev/null
+++ b/e2e/various-suite/bookmarks.spec.ts
@@ -0,0 +1,62 @@
+import { e2e } from '../utils';
+import { fromBaseUrl } from '../utils/support/url';
+
+describe('Pin nav items', () => {
+  beforeEach(() => {
+    cy.viewport(1280, 800);
+    e2e.flows.login(Cypress.env('USERNAME'), Cypress.env('PASSWORD'));
+    cy.visit(fromBaseUrl('/'));
+  });
+  afterEach(() => {
+    e2e.flows.setDefaultUserPreferences();
+  });
+
+  it('should pin the selected menu item and add it as a Bookmarks menu item child', () => {
+    // Open, dock and check if the mega menu is visible
+    cy.get('[aria-label="Open menu"]').click();
+    cy.get('[aria-label="Dock menu"]').click();
+    e2e.components.NavMenu.Menu().should('be.visible');
+
+    // Check if the Bookmark section is visible
+    const bookmarkSection = cy.get('[href="/bookmarks"]');
+    bookmarkSection.should('be.visible');
+
+    // Click on the pin icon to add Administration to the Bookmarks section
+    const adminItem = cy.contains('a', 'Administration');
+    const bookmarkPinIcon = adminItem.siblings('button').should('have.attr', 'aria-label', 'Add to Bookmarks');
+    bookmarkPinIcon.click({ force: true });
+
+    // Check if the Administration menu item is visible in the Bookmarks section
+    cy.get('[aria-label="Expand section Bookmarks"]').click();
+    const bookmarks = cy.get('[href="/bookmarks"]').parentsUntil('li').siblings('ul');
+    bookmarks.within(() => {
+      cy.get('a').should('contain.text', 'Administration');
+    });
+  });
+
+  it('should unpin the item and remove it from the Bookmarks section', () => {
+    // Set Administration as a pinned item and reload the page
+    e2e.flows.setUserPreferences({ navbar: { bookmarkUrls: ['/admin'] } });
+    cy.reload();
+
+    // Open, dock and check if the mega menu is visible
+    cy.get('[aria-label="Open menu"]').click();
+    cy.get('[aria-label="Dock menu"]').click();
+    e2e.components.NavMenu.Menu().should('be.visible');
+
+    // Check if the Bookmark section is visible and open it
+    cy.get('[href="/bookmarks"]').should('be.visible');
+    cy.get('[aria-label="Expand section Bookmarks"]').click();
+
+    // Check if the Administration menu item is visible in the Bookmarks section
+    const bookmarks = cy.get('[href="/bookmarks"]').parentsUntil('li').siblings('ul').children();
+    const administrationIsPinned = bookmarks.filter('li').children().should('contain.text', 'Administration');
+
+    // Click on the pin icon to remove Administration from the Bookmarks section and check if it is removed
+    administrationIsPinned.within(() => {
+      cy.get('[aria-label="Remove from Bookmarks"]').click({ force: true });
+    });
+    cy.wait(500);
+    administrationIsPinned.should('not.exist');
+  });
+});
diff --git a/public/app/core/components/AppChrome/MegaMenu/MegaMenuItemText.tsx b/public/app/core/components/AppChrome/MegaMenu/MegaMenuItemText.tsx
index 84d090d8584..bb34a6fe969 100644
--- a/public/app/core/components/AppChrome/MegaMenu/MegaMenuItemText.tsx
+++ b/public/app/core/components/AppChrome/MegaMenu/MegaMenuItemText.tsx
@@ -78,14 +78,14 @@ const getStyles = (theme: GrafanaTheme2, isActive: Props['isActive']) => ({
   }),
   wrapperBookmark: css({
     '.pin-icon': {
-      display: 'none',
+      visibility: 'hidden',
     },
     '&:hover, &:focus-within': {
       a: {
         width: 'calc(100% - 20px)',
       },
       '.pin-icon': {
-        display: 'inline-flex',
+        visibility: 'visible',
       },
     },
   }),