Add fix for data source disabled plugin should work (#1916)

* Add fix for data source disabled plugin should work Signed-off-by: Derek Ho <[email protected]> * Remove unused function Signed-off-by: Derek Ho <[email protected]> * Update snapshot Signed-off-by: Derek Ho <[email protected]> * Update the name of the disabled test Signed-off-by: Derek Ho <[email protected]> * Udpate codecov to v4 Signed-off-by: Derek Ho <[email protected]> * Update the check and the tests Signed-off-by: Derek Ho <[email protected]> * Add test to ensure it is not called when MDS is disabled Signed-off-by: Derek Ho <[email protected]> --------- Signed-off-by: Derek Ho <[email protected]>
opensearch-project · Apr 30, 2024 · 1a261d9 · 1a261d9
1 parent 67397ec
commit 1a261d9
Show file tree

Hide file tree

Showing 7 changed files with 71 additions and 24 deletions.
diff --git a/.github/workflows/unit-test.yml b/.github/workflows/unit-test.yml
@@ -33,6 +33,6 @@ jobs:
         working-directory: ${{ steps.install-dashboards.outputs.plugin-directory }}
 
       - name: Uploads coverage
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/public/apps/configuration/app-router.tsx b/public/apps/configuration/app-router.tsx
@@ -155,8 +155,9 @@ export const LocalCluster = { label: 'Local cluster', id: '' };
 export const DataSourceContext = createContext<DataSourceContextType | null>(null);
 
 export function AppRouter(props: AppDependencies) {
+  const dataSourceEnabled = !!props.depsStart.dataSource?.dataSourceEnabled;
   const setGlobalBreadcrumbs = flow(getBreadcrumbs, props.coreStart.chrome.setBreadcrumbs);
-  const dataSourceFromUrl = getDataSourceFromUrl();
+  const dataSourceFromUrl = dataSourceEnabled ? getDataSourceFromUrl() : LocalCluster;
 
   const [dataSource, setDataSource] = useState<DataSourceOption>(dataSourceFromUrl);
 

diff --git a/public/apps/configuration/test/__snapshots__/app-router.test.tsx.snap b/public/apps/configuration/test/__snapshots__/app-router.test.tsx.snap
@@ -4,7 +4,10 @@ exports[`SecurityPluginTopNavMenu renders DataSourceMenu when dataSource is enab
 <ContextProvider
   value={
     Object {
-      "dataSource": Object {},
+      "dataSource": Object {
+        "id": "",
+        "label": "Local cluster",
+      },
       "setDataSource": [Function],
     }
   }

diff --git a/public/apps/configuration/test/app-router.test.tsx b/public/apps/configuration/test/app-router.test.tsx
@@ -16,6 +16,11 @@
 import React from 'react';
 import { shallow } from 'enzyme';
 import { AppRouter } from '../app-router';
+import { getDataSourceFromUrl } from '../../../utils/datasource-utils';
+
+jest.mock('../../../utils/datasource-utils', () => ({
+  getDataSourceFromUrl: jest.fn(),
+}));
 
 describe('SecurityPluginTopNavMenu', () => {
   const coreStartMock = {
@@ -43,8 +48,46 @@ describe('SecurityPluginTopNavMenu', () => {
       },
     };
 
-    const wrapper = shallow(<AppRouter coreStart={coreStartMock} params={{ appBasePath: '' }} />);
+    const wrapper = shallow(
+      <AppRouter coreStart={coreStartMock} depsStart={{}} params={{ appBasePath: '' }} />
+    );
 
     expect(wrapper).toMatchSnapshot();
   });
+
+  it('getDataSourceFromUrl not called when MDS is disabled', () => {
+    const securityPluginStartDepsMock = {
+      dataSource: {
+        dataSourceEnabled: false,
+      },
+    };
+
+    shallow(
+      <AppRouter
+        coreStart={coreStartMock}
+        depsStart={securityPluginStartDepsMock}
+        params={{ appBasePath: '' }}
+      />
+    );
+
+    expect(getDataSourceFromUrl).not.toHaveBeenCalled();
+  });
+
+  it('getDataSourceFromUrl called when MDS is enabled', () => {
+    const securityPluginStartDepsMock = {
+      dataSource: {
+        dataSourceEnabled: true,
+      },
+    };
+
+    shallow(
+      <AppRouter
+        coreStart={coreStartMock}
+        depsStart={securityPluginStartDepsMock}
+        params={{ appBasePath: '' }}
+      />
+    );
+
+    expect(getDataSourceFromUrl).toHaveBeenCalled();
+  });
 });
diff --git a/public/utils/datasource-utils.ts b/public/utils/datasource-utils.ts
@@ -15,10 +15,6 @@
 
 import { DataSourceOption } from 'src/plugins/data_source_management/public/components/data_source_menu/types';
 
-export function createDataSourceQuery(dataSourceId: string) {
-  return { dataSourceId };
-}
-
 const DATASOURCEURLKEY = 'dataSource';
 
 export function getClusterInfo(dataSourceEnabled: boolean, cluster: DataSourceOption) {

diff --git a/public/utils/test/datasource-utils.test.ts b/public/utils/test/datasource-utils.test.ts
@@ -13,12 +13,7 @@
  *   permissions and limitations under the License.
  */
 
-import {
-  createDataSourceQuery,
-  getClusterInfo,
-  getDataSourceFromUrl,
-  setDataSourceInUrl,
-} from '../datasource-utils';
+import { getClusterInfo, getDataSourceFromUrl, setDataSourceInUrl } from '../datasource-utils';
 
 describe('Tests datasource utils', () => {
   it('Tests the GetClusterDescription helper function', () => {
@@ -27,10 +22,6 @@ describe('Tests datasource utils', () => {
     expect(getClusterInfo(true, { id: 'test', label: 'test' })).toBe('for test');
   });
 
-  it('Tests the create DataSource query helper function', () => {
-    expect(createDataSourceQuery('test')).toStrictEqual({ dataSourceId: 'test' });
-  });
-
   it('Tests getting the datasource from the url', () => {
     const mockSearchNoDataSourceId = '?foo=bar&baz=qux';
     Object.defineProperty(window, 'location', {

diff --git a/test/cypress/e2e/multi-datasources/multi_datasources_disabled.spec.js b/test/cypress/e2e/multi-datasources/multi_datasources_disabled.spec.js
@@ -13,15 +13,28 @@
  *   permissions and limitations under the License.
  */
 
-describe('Multi-datasources enabled', () => {
-  it('Sanity checks the cluster selector is not visible when multi datasources is disabled', () => {
+describe('Multi-datasources disabled', () => {
+  beforeEach(() => {
     localStorage.setItem('opendistro::security::tenant::saved', '""');
     localStorage.setItem('home:newThemeModal:show', 'false');
+  });
+
+  afterEach(() => {
+    cy.clearCookies();
+    cy.clearAllLocalStorage();
+    cy.clearAllSessionStorage();
+  });
+
+  it('Checks Get Started Tab', () => {
+    // Remote cluster purge cache
+    cy.visit(`http://localhost:5601/app/security-dashboards-plugin#/getstarted`);
 
-    cy.visit('http://localhost:5601/app/security-dashboards-plugin#/getstarted', {
-      failOnStatusCode: false,
-    });
+    cy.contains('h1', 'Get started');
+    cy.get('[data-test-subj="dataSourceSelectableButton"]').should('not.exist');
 
-    cy.get('[data-test-subj="dataSourceSelectableContextMenuHeaderLink"]').should('not.exist');
+    cy.get('[data-test-subj="purge-cache"]').click();
+    cy.get('[class="euiToast euiToast--success euiGlobalToastListItem"]')
+      .get('.euiToastHeader__title')
+      .should('contain', 'Cache purge successful');
   });
 });