Merge pull request #127 from splunk/v2-endpoint

Add automatic support for V2 search endpoints
splunk · Oct 2, 2024 · 0ae5673 · 0ae5673
2 parents 204d8cd + ae7ef12
commit 0ae5673
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 10 deletions.
diff --git a/out/searchProvider.js b/out/searchProvider.js
@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const vscode = require("vscode");
 const axios = require("axios");
+const { getClient } = require('./notebooks/splunk');
 
 class SearchProvider {
     constructor() {
@@ -32,10 +33,15 @@ class SearchProvider {
         }
 
         let searchResults = "No results";
+
+        const exportUrl = await shouldUseDeprecatedSearchAPIs()
+            ? `${this.splunkUrl}/services/search/jobs/export?output_mode=${this.outputMode}`
+            : `${this.splunkUrl}/services/search/v2/jobs/export?output_mode=${this.outputMode}`;
+
         await axios(
             {
                 method: "POST",
-                url: `${this.splunkUrl}/services/search/jobs/export?output_mode=${this.outputMode}`,
+                url: exportUrl,
                 data: "search=" + encodeURIComponent(`search ${search}`)
             })
             .then(response => {
@@ -117,10 +123,15 @@ class SavedSearchProvider {
         }
 
         let searchResults = "No results";
+
+        const exportUrl = await shouldUseDeprecatedSearchAPIs()
+            ? `${this.splunkUrl}/servicesNS/${savedSearchItem.owner}/${savedSearchItem.app}/search/jobs/export?output_mode=${this.outputMode}`
+            : `${this.splunkUrl}/servicesNS/${savedSearchItem.owner}/${savedSearchItem.app}/search/v2/jobs/export?output_mode=${this.outputMode}`;
+
         await axios(
             {
                 method: "POST",
-                url: `${this.splunkUrl}/servicesNS/${savedSearchItem.owner}/${savedSearchItem.app}/search/jobs/export?output_mode=${this.outputMode}`,
+                url: exportUrl,
                 data: "search=" + encodeURIComponent(`| savedsearch "${savedSearchItem.label}"`)
             })
             .then(response => {
@@ -147,4 +158,23 @@ class SavedSearch extends vscode.TreeItem {
         this.contextValue = 'savedSearch';
     }
 }
-exports.SavedSearch = SavedSearch;
+exports.SavedSearch = SavedSearch;
+
+let cachedDisableV2SearchApi = null; // avoid multiple calls
+async function shouldUseDeprecatedSearchAPIs() {
+    if (cachedDisableV2SearchApi !== null) {
+        console.log(`shouldUseDeprecatedSearchAPIs found cachedDisableV2SearchApi=${cachedDisableV2SearchApi}`);
+        return cachedDisableV2SearchApi;
+    }
+    // retrieve Splunk version and deployment info for disableV2SearchApi()
+    const service = getClient();
+    try {
+        await service.getInfo();
+    } catch (error) {
+        console.warn("error retrieving Splunk version with service.getInfo():");
+        console.warn(error);
+    };
+    cachedDisableV2SearchApi = service.disableV2SearchApi();
+    console.log(`shouldUseDeprecatedSearchAPIs service.disableV2SearchApi()=${cachedDisableV2SearchApi}`);
+    return cachedDisableV2SearchApi;
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -460,7 +460,7 @@
         "querystring-es3": "^0.2.1",
         "react": "^16.14.0",
         "react-dom": "^16.14.0",
-        "splunk-sdk": "^1.12.1",
+        "splunk-sdk": "^2.0.0",
         "styled-components": "^5.1.1",
         "tar-fs": "^2.1.1",
         "ts-loader": "^9.4.2",