Handle the HTTP errors coming from scripts and show a different messa…

…ge if initial configuration for Splunk Enterprise
Flared · Jan 15, 2025 · 128bd95 · 128bd95
1 parent 5728ccd
commit 128bd95
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 19 deletions.
diff --git a/packages/react-components/src/components/ConfigurationInitialStep.css b/packages/react-components/src/components/ConfigurationInitialStep.css
@@ -5,6 +5,7 @@
     gap: 0.5rem;
     align-items: center;
     color: var(--error);
+    text-align: start;
 }
 
 .error-container[hidden] {

diff --git a/packages/react-components/src/components/ConfigurationInitialStep.tsx b/packages/react-components/src/components/ConfigurationInitialStep.tsx
@@ -38,13 +38,13 @@ const ConfigurationInitialStep: FC<{
                     setIsLoading(false);
                     onApiKeyValidated();
                 })
-                .catch((error: any) => {
-                    setErrorMessage(error.data);
+                .catch((error: Error) => {
+                    setErrorMessage(error.message);
                     setIsLoading(false);
                     toastManager.show({
                         id: ToastKeys.ERROR,
                         isError: true,
-                        content: 'Something went wrong. Please review your form.',
+                        content: `Something went wrong. ${error.message}`,
                     });
                 });
         }

diff --git a/packages/react-components/src/components/Toast.css b/packages/react-components/src/components/Toast.css
@@ -30,6 +30,7 @@
 .toast-text {
     color: var(--text-color);
     overflow-wrap: anywhere;
+    text-align: start;
 }
 
 @keyframes toast-animation-in {

diff --git a/packages/react-components/src/models/constants.ts b/packages/react-components/src/models/constants.ts
@@ -12,6 +12,7 @@ export const SEVERITY_SAVED_SEARCH_NAME = 'Severity';
 export const KV_COLLECTION_NAME = 'event_ingestion_collection';
 export const KV_COLLECTION_KEY = '_key';
 export const KV_COLLECTION_VALUE = 'value';
+export const SPLUNK_CLOUD_TYPE = 'cloud';
 
 export enum PasswordKeys {
     API_KEY = 'api_key',

diff --git a/packages/react-components/src/models/splunk.ts b/packages/react-components/src/models/splunk.ts
@@ -98,6 +98,7 @@ export interface SplunkService {
     storagePasswords: () => SplunkStoragePasswordAccessors;
     indexes: () => SplunkIndexesAccessor;
     savedSearches: () => SplunkSavedSearchAccessor;
+    serverInfo: () => any;
     get: (splunkUrlPath: string, data: any) => SplunkRequestResponse;
     post: (splunkUrlPath: string, data: any) => SplunkRequestResponse;
 }
diff --git a/packages/react-components/src/utils/setupConfiguration.ts b/packages/react-components/src/utils/setupConfiguration.ts
@@ -7,6 +7,7 @@ import {
     KV_COLLECTION_VALUE,
     PasswordKeys,
     SEVERITY_SAVED_SEARCH_NAME,
+    SPLUNK_CLOUD_TYPE,
     STORAGE_REALM,
 } from '../models/constants';
 import { Severity, SourceType, SourceTypeCategory, Tenant } from '../models/flare';
@@ -58,44 +59,68 @@ function createService(): SplunkService {
     return service;
 }
 
+function handleHTTPScriptError(error: any): Promise<boolean> {
+    if (error.status === 400) {
+        return Promise.all([fetchIsFirstConfiguration(), fetchIsSplunkCloud()]).then(
+            ([isFirstConfiguration, isSplunkCloud]) => {
+                if (isFirstConfiguration && !isSplunkCloud) {
+                    throw Error(
+                        'The Splunk instance needs to be restarted to recognize the scripts of this application.'
+                    );
+                } else if (error.data.messages !== undefined && error.data.messages.length > 0) {
+                    throw Error(error.data.messages[0].text);
+                }
+                throw Error(error.data);
+            }
+        );
+    }
+    throw Error(error.data);
+}
+
 function fetchApiKeyValidation(apiKey: string): Promise<boolean> {
     const service = createService();
     const data = { apiKey };
-    return promisify(service.post)('/services/fetch_api_key_validation', data).then(
-        (response: SplunkRequestResponse) => {
+    return promisify(service.post)('/services/fetch_api_key_validation', data)
+        .then((response: SplunkRequestResponse) => {
             return response.status === 200;
-        }
-    );
+        })
+        .catch(handleHTTPScriptError);
 }
 
 function fetchUserTenants(apiKey: string): Promise<Array<Tenant>> {
     const service = createService();
     const data = { apiKey };
-    return promisify(service.post)('/services/fetch_user_tenants', data).then(
-        (response: SplunkRequestResponse) => {
+    return promisify(service.post)('/services/fetch_user_tenants', data)
+        .then((response: SplunkRequestResponse) => {
             return response.data.tenants;
-        }
-    );
+        })
+        .catch(handleHTTPScriptError);
 }
 
 function fetchSeverityFilters(apiKey: string): Promise<Array<Severity>> {
     const service = createService();
     const data = { apiKey };
-    return promisify(service.post)('/services/fetch_severity_filters', data).then(
-        (response: SplunkRequestResponse) => {
+    return promisify(service.post)('/services/fetch_severity_filters', data)
+        .then((response: SplunkRequestResponse) => {
             return response.data.severities;
-        }
-    );
+        })
+        .catch(handleHTTPScriptError);
 }
 
 function fetchSourceTypeFilters(apiKey: string): Promise<Array<SourceTypeCategory>> {
     const service = createService();
     const data = { apiKey };
-    return promisify(service.post)('/services/fetch_source_type_filters', data).then(
-        (response: SplunkRequestResponse) => {
+    return promisify(service.post)('/services/fetch_source_type_filters', data)
+        .then((response: SplunkRequestResponse) => {
             return response.data.categories;
-        }
-    );
+        })
+        .catch(handleHTTPScriptError);
+}
+
+async function fetchIsSplunkCloud(): Promise<boolean> {
+    const service = createService();
+    const info = await service.serverInfo();
+    return info?.entry?.[0]?.content?.instance_type === SPLUNK_CLOUD_TYPE;
 }
 
 function doesPasswordExist(storage: SplunkStoragePasswordAccessors, key: string): boolean {