NavTree: Make it possible to configure where in nav tree plugins live (#55484)

* NewIA: Plugin nav config

* progress

* Progress

* Things are working

* Add monitoring node

* Add alerts and incidents

* added experiment with standalone page

* Refactoring by adding a type for navtree root

* First test working

* More tests

* more tests

* Progress on richer config and sorting

* Sort weight working

* Path config

* Improving logic for not including admin or cfg nodes, making it the last step so that enterprise can add admin nodes without having to worry about the section not existing

* fixed index routes

* removed file

* Fixes

* Fixing tests

* Fixing more tests and adding support for weight config

* Updates

* Remove unused fake

* More fixes

* Minor tweak

* Minor fix

* Can now control position using sortweight even when existing items have no sortweight

* Added tests for frontend standalone page logic

* more tests

* Remove unused fake and fixed lint issue

* Moving reading settings to navtree impl package

* remove nav_id setting prefix

* Remove old test file

* Fix trailing newline

* Fixed bug with adding nil node

* fixing lint issue

* remove some code we have to rethink

* move read settings to PrivideService and switch to util.SplitString

public/app/features/plugins/utils.test.ts

@@ -1,41 +1,64 @@
 import { Location as HistoryLocation } from 'history';
 
+import { NavIndex, NavModelItem } from '@grafana/data';
 import { config } from '@grafana/runtime';
 
 import { buildPluginSectionNav } from './utils';
 
 describe('buildPluginSectionNav', () => {
   const pluginNav = { main: { text: 'Plugin nav' }, node: { text: 'Plugin nav' } };
-  const appsSection = {
-    text: 'apps',
-    id: 'apps',
+  const app1: NavModelItem = {
+    text: 'App1',
+    id: 'plugin-page-app1',
     children: [
       {
-        text: 'App1',
-        children: [
-          {
-            text: 'page1',
-            url: '/a/plugin1/page1',
-          },
-          {
-            text: 'page2',
-            url: '/a/plugin1/page2',
-          },
-        ],
+        text: 'page1',
+        url: '/a/plugin1/page1',
+      },
+      {
+        text: 'page2',
+        url: '/a/plugin1/page2',
       },
     ],
   };
-  const navIndex = { apps: appsSection };
+
+  const appsSection = {
+    text: 'apps',
+    id: 'apps',
+    children: [app1],
+  };
+
+  const adminSection: NavModelItem = {
+    text: 'Admin',
+    id: 'admin',
+    children: [],
+  };
+
+  const standalonePluginPage = {
+    id: 'standalone-plugin-page-/a/app2/config',
+    text: 'Standalone page',
+    parentItem: adminSection,
+  };
+
+  adminSection.children = [standalonePluginPage];
+
+  app1.parentItem = appsSection;
+
+  const navIndex: NavIndex = {
+    apps: appsSection,
+    [app1.id!]: appsSection.children[0],
+    [standalonePluginPage.id]: standalonePluginPage,
+  };
 
   it('Should return pluginNav if topnav is disabled', () => {
     config.featureToggles.topnav = false;
-    const result = buildPluginSectionNav({} as HistoryLocation, pluginNav, {});
+    const result = buildPluginSectionNav({} as HistoryLocation, pluginNav, {}, 'app1');
     expect(result).toBe(pluginNav);
   });
 
   it('Should return return section nav if topnav is enabled', () => {
     config.featureToggles.topnav = true;
-    const result = buildPluginSectionNav({} as HistoryLocation, pluginNav, navIndex);
+    const result = buildPluginSectionNav({} as HistoryLocation, pluginNav, navIndex, 'app1');
     expect(result?.main.text).toBe('apps');
   });
 
@@ -44,9 +67,39 @@ describe('buildPluginSectionNav', () => {
     const result = buildPluginSectionNav(
       { pathname: '/a/plugin1/page2', search: '' } as HistoryLocation,
       null,
-      navIndex
+      navIndex,
+      'app1'
     );
     expect(result?.main.children![0].children![1].active).toBe(true);
     expect(result?.node.text).toBe('page2');
   });
+
+  it('Should handle standalone page', () => {
+    config.featureToggles.topnav = true;
+    const result = buildPluginSectionNav(
+      { pathname: '/a/app2/config', search: '' } as HistoryLocation,
+      pluginNav,
+      navIndex,
+      'app2'
+    );
+    expect(result?.main.text).toBe('Admin');
+    expect(result?.node.text).toBe('Standalone page');
+  });
+
+  it('Should throw error if app not found in navtree', () => {
+    config.featureToggles.topnav = true;
+    const action = () => {
+      buildPluginSectionNav({} as HistoryLocation, pluginNav, navIndex, 'app3');
+    };
+    expect(action).toThrowError();
+  });
+
+  it('Should throw error if app has no section', () => {
+    config.featureToggles.topnav = true;
+    app1.parentItem = undefined;
+    const action = () => {
+      buildPluginSectionNav({} as HistoryLocation, pluginNav, navIndex, 'app1');
+    };
+    expect(action).toThrowError();
+  });
 });