fix(flux-lsp/516): isolate the source of the runtime bugs, with the new schema injection (#4980)

We have many bugs (>3k in 2 days) being reported from the connector library used to connect our UI with our LSP worker thread. The connector library is swallowing the stacktrace, so we don't know the reason. Nor do we know yet if it's impacting users.

Therefore the purpose of this PR is to increase the honeybadger error reporting. Add error reporting on the global scope of the worker thread itself, and add reporting on one possible upstream culprit.

Author: wiedld

src/languageSupport/languages/flux/lsp/connection.ts

@@ -15,6 +15,9 @@ import {
   ExecuteCommandT,
 } from 'src/languageSupport/languages/flux/lsp/utils'
 
+// error reporting
+import {reportErrorThroughHoneyBadger} from 'src/shared/utils/errors'
+
 class LspConnectionManager {
   private _worker: Worker
   private _model: MonacoTypes.editor.IModel
@@ -69,15 +72,23 @@ class LspConnectionManager {
     command: ExecuteCommand,
     data: Omit<ExecuteCommandArgument, 'textDocument'>
   ) {
-    this._worker.postMessage(
-      executeCommand([
+    let msg
+    try {
+      msg = executeCommand([
         command,
         {
           ...data,
           textDocument: {uri: this._model.uri.toString()},
         },
       ] as ExecuteCommandT)
-    )
+    } catch (err) {
+      console.error(`Error ExecuteCommand:`, err)
+      reportErrorThroughHoneyBadger(err, {
+        name: 'LSP injection payload',
+      })
+      return
+    }
+    this._worker.postMessage(msg)
   }
 
   dispose() {

src/languageSupport/languages/flux/lsp/monaco.flux.lsp.ts

@@ -75,6 +75,10 @@ export function initLspWorker() {
   } else {
     worker = new Fallback()
   }
+  worker.onerror = (err: ErrorEvent) => {
+    const error: Error = {...err, name: 'worker.onerror'}
+    reportErrorThroughHoneyBadger(error, {name: 'LSP worker'})
+  }
   manager = new ConnectionManager(worker)
 
   messageReader = new BrowserMessageReader(worker)

src/languageSupport/languages/flux/lsp/utils.ts

@@ -83,7 +83,38 @@ export type ExecuteCommandT =
   | [ExecuteCommand.InjectTagValue, ExecuteCommandInjectTagValue]
   | [ExecuteCommand.InjectField, ExecuteCommandInjectField]
 
-export const executeCommand = ([command, arg]: ExecuteCommandT) => {
+function validateExecuteCommandPayload([command, arg]: ExecuteCommandT):
+  | boolean
+  | never {
+  const checkIsString = (arg, prop) => {
+    if (!(arg[prop] && typeof arg[prop] === 'string')) {
+      throw new Error(
+        `${prop} should be type string, instead found: ${typeof arg[prop]}`
+      )
+    }
+    return true
+  }
+
+  switch (command) {
+    case ExecuteCommand.InjectionMeasurement:
+      return checkIsString(arg, 'bucket')
+    case ExecuteCommand.InjectTag:
+    case ExecuteCommand.InjectField:
+      return checkIsString(arg, 'bucket') && checkIsString(arg, 'name')
+    case ExecuteCommand.InjectTagValue:
+      return (
+        checkIsString(arg, 'bucket') &&
+        checkIsString(arg, 'name') &&
+        checkIsString(arg, 'value')
+      )
+    default:
+      throw new Error(`unrecognized ExecuteCommand`)
+  }
+}
+
+export const executeCommand = (payload: ExecuteCommandT): object | never => {
+  validateExecuteCommandPayload(payload)
+  const [command, arg] = payload
   return createRequest(Methods.ExecuteCommand, {
     command,
     arguments: [arg],

src/languageSupport/languages/flux/lsp/worker/utils.ts

@@ -3,6 +3,6 @@ export const respond = (msg, cb) => {
     const d = JSON.parse(msg)
     cb(d)
   } catch (e) {
-    console.warn(e)
+    console.error(e)
   }
 }