SPL2 Notebooks

.github/workflows/ci.yaml

@@ -4,6 +4,7 @@ on:
       - main
       - master
       - develop
+      - spl2
 
 jobs:
   build:

out/extension.js

@@ -14,19 +14,25 @@ const splunkCustomRESTHandler = require('./customRESTHandler.js')
 const splunkSpec = require("./spec.js");
 const reload = require("./commands/reload.js");
 
-const notebookSerializers = require('./notebooks/serializers');
-const notebookControllers = require('./notebooks/controller');
+const { SplunkNotebookSerializer } = require('./notebooks/serializers');
+const { SplunkController } = require('./notebooks/controller');
+const { Spl2NotebookSerializer } = require('./notebooks/spl2/serializer');
+const { Spl2Controller } = require('./notebooks/spl2/controller');
+const { installMissingSpl2Requirements, getLatestSpl2Release } = require('./notebooks/spl2/installer');
+const { startSpl2ClientAndServer } = require('./notebooks/spl2/initializer');
 const notebookCommands = require('./notebooks/commands');
-const notebookProviders = require('./notebooks/provider');
+const { CellResultCountStatusBarProvider } = require('./notebooks/provider');
 
 //const { transpileModule } = require("typescript");
 //const { AsyncLocalStorage } = require("async_hooks");
 const PLACEHOLDER_REGEX = /\<([^\>]+)\>/g
 let specConfigs = {};
-let timeout = undefined;
-let diagnosticCollection = undefined;
-let specConfig = undefined;
+let timeout;
+let diagnosticCollection;
+let specConfig;
 let snippets = {};
+let spl2Client;
+let spl2PortToAttempt = 59143; // 59143 ~ SPLNK if you squint really hard :)
 
 function getParentStanza(document, line) {
     // Start at the passed in line and go backwards
@@ -63,7 +69,7 @@ function getDocumentItems(document, PATTERN) {
     return items
 }
 
-function activate(context) {
+async function activate(context) {
 
     let splunkOutputChannel = vscode.window.createOutputChannel("Splunk");
 
@@ -196,8 +202,12 @@ function activate(context) {
 
     }));
 
-    // Register Utility Commands
+    // Setup progress bar for install
+    const progressBar = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, 100);
+    context.subscriptions.push(progressBar);
+    progressBar.hide();
 
+    // Register Utility Commands
     context.subscriptions.push(vscode.commands.registerCommand('splunk.fullDebugRefresh', async () => {reload.fullDebugRefresh(splunkOutputChannel)}))
 
     // Set up stanza folding
@@ -206,8 +216,23 @@ function activate(context) {
     ], new splunkFoldingRangeProvider.confFoldingRangeProvider()));
 
     // If vscode was opened with an active Splunk file, handle it.
-    if(vscode.window.activeTextEditor && isSplunkFile(vscode.window.activeTextEditor.document.fileName)) {
-        handleSplunkFile(context);
+    vscode.commands.registerCommand('splunk.restartSpl2LanguageServer', async () => {
+        try {
+            if (spl2Client) {
+                await spl2Client.deactivate();
+            }
+            spl2Client = undefined;
+            await handleSpl2Document(context, progressBar);
+        } catch (err) {
+            console.warn(`Error restarting SPL2 language server, err: ${err}`);
+        }
+    });
+    if(vscode.window.activeTextEditor) {
+        if (isSplunkDocument(vscode.window.activeTextEditor.document)) {
+            handleSplunkDocument(context);
+        } else if (isSpl2Document(vscode.window.activeTextEditor.document)) {
+            await handleSpl2Document(context, progressBar);
+        }
     }
 
     // Set up listener for text document changes
@@ -219,32 +244,41 @@ function activate(context) {
     }));
 
     // Set up listener for active editor changing
-    context.subscriptions.push(vscode.window.onDidChangeActiveTextEditor( () => {
-        if (vscode.window.activeTextEditor && isSplunkFile(vscode.window.activeTextEditor.document.fileName)) {
-            handleSplunkFile(context);
+    context.subscriptions.push(vscode.window.onDidChangeActiveTextEditor( async () => {
+        if (!vscode.window.activeTextEditor) {
+            return;
+        }
+        if (isSplunkDocument(vscode.window.activeTextEditor.document)) {
+            handleSplunkDocument(context);
+        } else if (isSpl2Document(vscode.window.activeTextEditor.document)) {
+            await handleSpl2Document(context, progressBar);
         }
     }));
 
     // Notebook
-    context.subscriptions.push(vscode.workspace.registerNotebookSerializer('splunk-notebook', new notebookSerializers.SplunkNotebookSerializer(), {transientCellMetadata: {inputCollapsed: true, outputCollapsed: true}, transientOutputs: false}));
-	let controller = new notebookControllers.SplunkController()
-    context.subscriptions.push(controller)
-    context.subscriptions.push(vscode.notebooks.registerNotebookCellStatusBarItemProvider('splunk-notebook', new notebookProviders.CellResultCountStatusBarProvider(splunkOutputChannel)));
-    notebookCommands.registerNotebookCommands(controller, splunkOutputChannel, context)
+    context.subscriptions.push(vscode.workspace.registerNotebookSerializer('splunk-notebook', new SplunkNotebookSerializer(), {transientCellMetadata: {inputCollapsed: true, outputCollapsed: true}, transientOutputs: false}));
+	context.subscriptions.push(vscode.workspace.registerNotebookSerializer('spl2-notebook', new Spl2NotebookSerializer(), {transientCellMetadata: {inputCollapsed: true, outputCollapsed: true}, transientOutputs: false}));
+    const controller = new SplunkController();
+    context.subscriptions.push(controller);
+    const spl2Controller = new Spl2Controller();
+    context.subscriptions.push(spl2Controller);
+    context.subscriptions.push(vscode.notebooks.registerNotebookCellStatusBarItemProvider('splunk-notebook', new CellResultCountStatusBarProvider(splunkOutputChannel)));
+    context.subscriptions.push(vscode.notebooks.registerNotebookCellStatusBarItemProvider('spl2-notebook', new CellResultCountStatusBarProvider(splunkOutputChannel)));
+    notebookCommands.registerNotebookCommands([controller, spl2Controller], splunkOutputChannel, context);
 }
 exports.activate = activate;
 
-function isSplunkFile(fileName) {
+function isSplunkDocument(document) {
     let splunkFileExtensions = [".conf", "default.meta", "local.meta", "globalconfig.json"];
     for (let i=0; i < splunkFileExtensions.length; i++) {
-        if(fileName.toLowerCase().endsWith(splunkFileExtensions[i])) {
+        if(document.fileName.toLowerCase().endsWith(splunkFileExtensions[i])) {
             return true;
         }
     }
     return false;
 }
 
-function handleSplunkFile(context) {
+function handleSplunkDocument(context) {
 
     if(diagnosticCollection === undefined) {
         diagnosticCollection = vscode.languages.createDiagnosticCollection('splunk');
@@ -286,6 +320,37 @@ function handleSplunkFile(context) {
     specConfigs[currentDocument] = specConfig
 }
 
+function isSpl2Document(document) {
+    return document.languageId == 'splunk_spl2';
+}
+
+async function handleSpl2Document(context, progressBar) {
+    if (spl2Client) {
+        // Client and server are already running, try refreshing for case of new document
+        const range = new vscode.Range(new vscode.Position(0, 0), new vscode.Position(0, 1));
+        const text = vscode.window.activeTextEditor.document.getText(range) || " ";
+        vscode.window.activeTextEditor.edit((editBuilder) => {
+            // To refresh language server make a harmless edit by replacing the first character
+            editBuilder.replace(range, text);
+        });
+        return;
+    }
+    try {
+        const installedLatestLsp = await installMissingSpl2Requirements(context, progressBar);
+        if (!installedLatestLsp) {
+            await getLatestSpl2Release(context, progressBar);
+        }
+        const onSpl2Restart = async (nextPort) => {
+            await spl2Client.deactivate();
+            spl2PortToAttempt = nextPort;
+            spl2Client = await startSpl2ClientAndServer(context, progressBar, spl2PortToAttempt, onSpl2Restart);
+        };
+        spl2Client = await startSpl2ClientAndServer(context, progressBar, spl2PortToAttempt, onSpl2Restart);
+    } catch (err) {
+        vscode.window.showErrorMessage(`Issue setting up SPL2 environment: ${err}`);
+    }
+}
+
 function getSpecFilePath(basePath, filename) {
 
     // Get the custom configuration options
@@ -509,5 +574,10 @@ function getDiagnostics(specConfig, document) {
     return diagnostics;
 }
 
-function deactivate() { }
+async function deactivate() {
+    if (spl2Client) {
+        return await spl2Client.deactivate();
+    }
+}
+
 exports.deactivate = deactivate;

out/notebooks/commands.ts

@@ -3,26 +3,37 @@ import { SplunkController } from './controller';
 import { VIZ_TYPES } from './visualizations';
 import { getClient, getJobSearchLog, getSearchJobBySid } from './splunk';
 
-export async function registerNotebookCommands(controller: SplunkController, outputChannel: vscode.OutputChannel, context: vscode.ExtensionContext) {
-    context.subscriptions.push(vscode.commands.registerCommand('splunk.notebooks.addVisualizationPreference', (cell) => { 
-		addVisualizationPreference(controller, cell)
-	}))
+export async function registerNotebookCommands(controllers: SplunkController[], outputChannel: vscode.OutputChannel, context: vscode.ExtensionContext) {
+    context.subscriptions.push(vscode.commands.registerCommand('splunk.notebooks.addVisualizationPreference', (cell) => {
+		controllers.filter((controller) => (cell.notebook.notebookType === controller.notebookType))
+            .forEach((controller) => addVisualizationPreference(controller, cell));
+	}));
+
+    context.subscriptions.push(vscode.commands.registerCommand('splunk.notebooks.enterEarliestTime', (cell) => { 
+		controllers.filter((controller) => (cell.notebook.notebookType === controller.notebookType))
+            .forEach((controller) => enterEarliestTime(controller, cell));
+	}));
+
+    context.subscriptions.push(vscode.commands.registerCommand('splunk.notebooks.enterLatestTime', (cell) => { 
+		controllers.filter((controller) => (cell.notebook.notebookType === controller.notebookType))
+            .forEach((controller) => enterLatestTime(controller, cell));
+	}));
 
 	context.subscriptions.push(vscode.commands.registerCommand('splunk.notebooks.openJobInspector', (sid) => { 
 		openJobInspector(sid)
-	}))
+	}));
 
 	context.subscriptions.push(vscode.commands.registerCommand('splunk.notebooks.openSearchLog', (cell) => { 
 		openSearchLog(cell, outputChannel)
-	}))
+	}));
 
 	context.subscriptions.push(vscode.commands.registerCommand('splunk.notebooks.copyJobIdToClipboard', (cell) => { 
 		copyJobIdToClipboard(cell)
-	}))
+	}));
 
 	context.subscriptions.push(vscode.commands.registerCommand('splunk.notebooks.copyDetection', (detection) => { 
 		copyDetection(detection)
-	}))
+	}));
 }
 
 
@@ -112,6 +123,64 @@ export async function addVisualizationPreference(
     await controller.runCell(cell);
 }
 
+export async function enterEarliestTime(
+    controller: SplunkController,
+    cell: vscode.NotebookCell
+) {
+    const cellMetadata = { ...cell.metadata };
+    if (!cellMetadata.splunk) {
+        cellMetadata.splunk = {};
+    }
+
+    let value = await vscode.window.showInputBox({
+        title: 'Earliest time',
+        value: cellMetadata.splunk.earliestTime || '-24h',
+        prompt: 'e.g. -24h, @d, -2d@d+2h, 1687909025',
+    });
+
+    if (value === undefined) { // canceled
+        return;
+    }
+
+    cellMetadata.splunk.earliestTime = value;
+
+    const edit = new vscode.WorkspaceEdit();
+    const nbEdit = vscode.NotebookEdit.updateCellMetadata(cell.index, cellMetadata);
+
+    edit.set(cell.notebook.uri, [nbEdit]);
+
+    await vscode.workspace.applyEdit(edit);
+}
+
+export async function enterLatestTime(
+    controller: SplunkController,
+    cell: vscode.NotebookCell
+) {
+    const cellMetadata = { ...cell.metadata };
+    if (!cellMetadata.splunk) {
+        cellMetadata.splunk = {};
+    }
+
+    let value = await vscode.window.showInputBox({
+        title: 'Latest time',
+        value: cellMetadata.splunk.latestTime || 'now',
+        prompt: 'e.g. now, -24h, @d, -2d@d+2h, 1687909025',
+    });
+
+    if (value === undefined) { // canceled
+        return;
+    }
+
+    cellMetadata.splunk.latestTime = value;
+
+    const edit = new vscode.WorkspaceEdit();
+    const nbEdit = vscode.NotebookEdit.updateCellMetadata(cell.index, cellMetadata);
+
+    edit.set(cell.notebook.uri, [nbEdit]);
+
+    await vscode.workspace.applyEdit(edit);
+}
+
 export async function copyJobIdToClipboard(cell) {
     if (!cell.outputs || cell.outputs[0].metadata == undefined) {
         vscode.window.showErrorMessage("No job detected in cell. Please execute the cell and try again.")