Use @grafana/runtime instead of grafanaBootData (#50)

grafana · Jul 13, 2023 · cd94e70 · cd94e70
1 parent 3b2a509
commit cd94e70
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 74 deletions.
diff --git a/rollup.config.ts b/rollup.config.ts
@@ -13,7 +13,7 @@ export default [
     plugins: [
       externals({
         deps: true,
-        include: ['react', '@grafana/data', '@grafana/ui', 'lodash'],
+        include: ['react', '@grafana/data', '@grafana/ui', '@grafana/runtime', 'lodash'],
         packagePath,
       }),
       resolve(),

diff --git a/src/ConnectionConfig.test.tsx b/src/ConnectionConfig.test.tsx
@@ -3,6 +3,7 @@ import React from 'react';
 import { render, screen, waitFor } from '@testing-library/react';
 import { AwsAuthDataSourceJsonData, AwsAuthDataSourceSecureJsonData, AwsAuthType } from './types';
 import { ConnectionConfig, ConnectionConfigProps } from './ConnectionConfig';
+import { config } from '@grafana/runtime';
 
 const getProps = (propOverrides?: object) => {
   const props: ConnectionConfigProps<AwsAuthDataSourceJsonData, AwsAuthDataSourceSecureJsonData> = {
@@ -51,19 +52,19 @@ const getProps = (propOverrides?: object) => {
   return props;
 };
 
-const resetWindow = () => {
-  (window as any).grafanaBootData = {
-    settings: {
-      awsAllowedAuthProviders: [AwsAuthType.EC2IAMRole, AwsAuthType.Keys],
-      awsAssumeRoleEnabled: false,
-    },
-  };
-};
+jest.mock('@grafana/runtime', () => ({
+  ...jest.requireActual('@grafana/runtime'),
+  config: {
+    awsAllowedAuthProviders: [AwsAuthType.EC2IAMRole, AwsAuthType.Keys],
+    awsAssumeRoleEnabled: false
+  },
+}));
 
 describe('ConnectionConfig', () => {
-  beforeEach(() => resetWindow());
-  afterEach(() => resetWindow());
-
+  beforeEach(() => {
+    config.awsAllowedAuthProviders = [AwsAuthType.EC2IAMRole, AwsAuthType.Keys];
+    config.awsAssumeRoleEnabled = false;
+  });
   it('should use auth type from props if its set', async () => {
     const onOptionsChange = jest.fn();
     const props = getProps({ onOptionsChange, options: { jsonData: { authType: AwsAuthType.Keys } } });
@@ -79,11 +80,11 @@ describe('ConnectionConfig', () => {
     render(<ConnectionConfig {...props} />);
     await waitFor(() => expect(screen.getByTestId('connection-config')).toBeInTheDocument());
 
-    const config = props.options;
+    const optionsConfig = props.options;
     expect(onOptionsChange).toHaveBeenCalledWith({
-      ...config,
+      ...optionsConfig,
       jsonData: {
-        ...config.jsonData,
+        ...optionsConfig.jsonData,
         authType: AwsAuthType.EC2IAMRole,
       },
     });
@@ -140,53 +141,16 @@ describe('ConnectionConfig', () => {
     expect(screen.queryByText('Connection Details')).not.toBeInTheDocument();
   });
 
-  it('should use default auth if awsAllowedAuthProviders was not found on window obj', async () => {
-    (window as any).grafanaBootData = {
-      settings: {},
-    };
-    const onOptionsChange = jest.fn();
-    const props = getProps({ onOptionsChange });
-    render(<ConnectionConfig {...props} />);
-    await waitFor(() => expect(screen.getByTestId('connection-config')).toBeInTheDocument());
-
-    const config = props.options;
-    expect(onOptionsChange).toHaveBeenCalledWith({
-      ...config,
-      jsonData: {
-        ...config.jsonData,
-        authType: AwsAuthType.Default,
-      },
-    });
-  });
-
-  it('should render assume role if awsAssumeRoleEnabled was not found on window obj', async () => {
-    (window as any).grafanaBootData = {
-      settings: {},
-    };
-    const props = getProps();
-    render(<ConnectionConfig {...props} />);
-    await waitFor(() => expect(screen.getByTestId('connection-config')).toBeInTheDocument());
-    expect(screen.queryByText('Assume Role ARN')).toBeInTheDocument();
-  });
-
   it('should not render assume role if awsAssumeRoleEnabled was set to false', async () => {
-    (window as any).grafanaBootData = {
-      settings: {
-        awsAssumeRoleEnabled: false,
-      },
-    };
+    config.awsAssumeRoleEnabled = false;
     const props = getProps();
     render(<ConnectionConfig {...props} />);
     await waitFor(() => expect(screen.getByTestId('connection-config')).toBeInTheDocument());
     expect(screen.queryByText('Assume Role ARN')).not.toBeInTheDocument();
   });
 
   it('should render assume role if awsAssumeRoleEnabled was set to true', async () => {
-    (window as any).grafanaBootData = {
-      settings: {
-        awsAssumeRoleEnabled: true,
-      },
-    };
+    config.awsAssumeRoleEnabled = true;
     const props = getProps();
     render(<ConnectionConfig {...props} />);
     await waitFor(() => expect(screen.getByTestId('connection-config')).toBeInTheDocument());

diff --git a/src/ConnectionConfig.tsx b/src/ConnectionConfig.tsx
@@ -7,14 +7,16 @@ import {
   onUpdateDatasourceJsonDataOption,
   onUpdateDatasourceSecureJsonDataOption,
 } from '@grafana/data';
-
+import { config } from '@grafana/runtime';
 import { standardRegions } from './regions';
 import { AwsAuthDataSourceJsonData, AwsAuthDataSourceSecureJsonData, AwsAuthType } from './types';
 import { awsAuthProviderOptions } from './providers';
 
 export const DEFAULT_LABEL_WIDTH = 28;
 const toOption = (value: string) => ({ value, label: value });
-
+const isAwsAuthType = (value: any): value is AwsAuthType => {
+  return typeof value === 'string' && awsAuthProviderOptions.some((opt) => opt.value === value);
+}
 export interface ConnectionConfigProps<
   J extends AwsAuthDataSourceJsonData = AwsAuthDataSourceJsonData,
   S = AwsAuthDataSourceSecureJsonData
@@ -36,13 +38,12 @@ export const ConnectionConfig: FC<ConnectionConfigProps> = (props: ConnectionCon
   if (profile === undefined) {
     profile = options.database;
   }
-
-  const settings = (window as any).grafanaBootData.settings;
+  
+  const awsAssumeRoleEnabled = config.awsAssumeRoleEnabled
   const awsAllowedAuthProviders = useMemo(
-    () => settings.awsAllowedAuthProviders ?? [AwsAuthType.Default, AwsAuthType.Keys, AwsAuthType.Credentials],
-    [settings.awsAllowedAuthProviders]
+    () => config.awsAllowedAuthProviders.filter(isAwsAuthType),
+    []
   );
-  const awsAssumeRoleEnabled = settings.awsAssumeRoleEnabled ?? true;
 
   const currentProvider = awsAuthProviderOptions.find((p) => p.value === options.jsonData.authType);
 

diff --git a/src/SIGV4ConnectionConfig.test.tsx b/src/SIGV4ConnectionConfig.test.tsx
@@ -1,19 +1,23 @@
 import { DataSourcePluginOptionsEditorProps } from '@grafana/data';
 import React from 'react';
 import { fireEvent, render, screen } from '@testing-library/react';
-import { SIGV4ConnectionConfig } from 'SIGV4ConnectionConfig';
-import { AwsAuthType } from 'types';
+import { AwsAuthType } from './types';
+import { SIGV4ConnectionConfig } from './SIGV4ConnectionConfig';
+import {config} from '@grafana/runtime'
 
-const resetWindow = () => {
-  (window as any).grafanaBootData = {
-    settings: {
-      awsAllowedAuthProviders: [AwsAuthType.Credentials, AwsAuthType.Keys],
-      awsAssumeRoleEnabled: true,
-    },
-  };
-};
+jest.mock('@grafana/runtime', () => ({
+  ...jest.requireActual('@grafana/runtime'),
+  config: {
+    awsAllowedAuthProviders: [AwsAuthType.Credentials, AwsAuthType.Keys],
+    awsAssumeRoleEnabled: true,
+  },
+}));
 
 describe('SIGV4ConnectionConfig', () => {
+  beforeEach(() => {
+    config.awsAllowedAuthProviders = [AwsAuthType.Credentials, AwsAuthType.Keys];
+    config.awsAssumeRoleEnabled = true;
+  });
   const setup = (onOptionsChange?: () => {}) => {
     const props: DataSourcePluginOptionsEditorProps<any, any> = {
       options: {
@@ -56,9 +60,6 @@ describe('SIGV4ConnectionConfig', () => {
     render(<SIGV4ConnectionConfig {...props} />);
   };
 
-  beforeEach(() => resetWindow());
-  afterEach(() => resetWindow());
-
   it('should map incoming props correctly', () => {
     setup();
     expect(screen.getByText('Credentials file')).toBeInTheDocument();