From 975d5c659ab99193bb94a194c3b8de834a94c0b6 Mon Sep 17 00:00:00 2001
From: edleeks87 <edward.leeks@sage.com>
Date: Mon, 14 Oct 2024 11:39:13 +0100
Subject: [PATCH] fix(menu-item): ensure that it does not render children when
 `submenu` is an empty string

Adds invariant to ensure that the component does not render when `children` are passed but `submenu`
is an empty string

fix #7010
---
 .../menu/menu-item/menu-item.component.tsx     |  7 +++++++
 .../menu/menu-item/menu-item.test.tsx          | 18 ++++++++++++++++++
 2 files changed, 25 insertions(+)

diff --git a/src/components/menu/menu-item/menu-item.component.tsx b/src/components/menu/menu-item/menu-item.component.tsx
index 85de143857..82e0f54734 100644
--- a/src/components/menu/menu-item/menu-item.component.tsx
+++ b/src/components/menu/menu-item/menu-item.component.tsx
@@ -131,6 +131,13 @@ export const MenuItem = ({
     "If no text is provided an `ariaLabel` should be given to facilitate accessibility."
   );
 
+  invariant(
+    typeof submenu === "boolean" ||
+      submenu === undefined ||
+      (children && typeof submenu === "string" && submenu.length),
+    "You should not pass `children` when `submenu` is an empty string"
+  );
+
   const {
     inFullscreenView,
     registerItem,
diff --git a/src/components/menu/menu-item/menu-item.test.tsx b/src/components/menu/menu-item/menu-item.test.tsx
index 335b0dc196..807e3a453f 100644
--- a/src/components/menu/menu-item/menu-item.test.tsx
+++ b/src/components/menu/menu-item/menu-item.test.tsx
@@ -1058,3 +1058,21 @@ describe("when MenuItem has a submenu", () => {
     });
   });
 });
+
+test("should throw when `children` passed and `submenu` is an empty string", () => {
+  const consoleSpy = jest
+    .spyOn(global.console, "error")
+    .mockImplementation(() => {});
+
+  expect(() => {
+    render(
+      <MenuContext.Provider value={{ ...menuContextValues }}>
+        <MenuItem submenu="">Item One</MenuItem>
+      </MenuContext.Provider>
+    );
+  }).toThrow(
+    "You should not pass `children` when `submenu` is an empty string"
+  );
+
+  consoleSpy.mockRestore();
+});