Recover from file read errors

server/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Bash Language Server
 
+## 1.11.3
+
+* Recover from file reading errors (https://github.com/bash-lsp/bash-language-server/pull/211)
+
 ## 1.11.2
 
 * Fix invalid documentHighlight response when word cannot be found (https://github.com/bash-lsp/bash-language-server/pull/209)

server/package.json

@@ -3,7 +3,7 @@
   "description": "A language server for Bash",
   "author": "Mads Hartmann",
   "license": "MIT",
-  "version": "1.11.2",
+  "version": "1.11.3",
   "publisher": "mads-hartmann",
   "main": "./out/server.js",
   "typings": "./out/server.d.ts",

server/src/__tests__/analyzer.test.ts

@@ -1,4 +1,5 @@
 import FIXTURES, { FIXTURE_FOLDER } from '../../../testing/fixtures'
+import { getMockConnection } from '../../../testing/mocks'
 import Analyzer from '../analyser'
 import { initializeParser } from '../parser'
 
@@ -113,11 +114,7 @@ describe('fromRoot', () => {
 
     jest.spyOn(Date, 'now').mockImplementation(() => 0)
 
-    const connection: any = {
-      console: {
-        log: jest.fn(),
-      },
-    }
+    const connection = getMockConnection()
 
     const newAnalyzer = await Analyzer.fromRoot({
       connection,
@@ -127,7 +124,7 @@ describe('fromRoot', () => {
 
     expect(newAnalyzer).toBeDefined()
 
-    const FIXTURE_FILES_MATCHING_GLOB = 9
+    const FIXTURE_FILES_MATCHING_GLOB = 10
 
     // Intro, stats on glob, one file skipped due to shebang, and outro
     const LOG_LINES = FIXTURE_FILES_MATCHING_GLOB + 4

server/src/__tests__/server.test.ts

@@ -1,71 +1,14 @@
 import * as lsp from 'vscode-languageserver'
 
 import { FIXTURE_FOLDER, FIXTURE_URI } from '../../../testing/fixtures'
+import { getMockConnection } from '../../../testing/mocks'
 import LspServer from '../server'
 import { CompletionItemDataType } from '../types'
 
 async function initializeServer() {
   const diagnostics: Array<lsp.PublishDiagnosticsParams | undefined> = undefined
-  const console: any = {
-    error: jest.fn(),
-    warn: jest.fn(),
-    info: jest.fn(),
-    log: jest.fn(),
-  }
 
-  const connection: jest.Mocked<lsp.Connection> = {
-    client: {} as any,
-    console,
-    dispose: jest.fn(),
-    listen: jest.fn(),
-    onCodeAction: jest.fn(),
-    onCodeLens: jest.fn(),
-    onCodeLensResolve: jest.fn(),
-    onColorPresentation: jest.fn(),
-    onCompletion: jest.fn(),
-    onCompletionResolve: jest.fn(),
-    onDeclaration: jest.fn(),
-    onDefinition: jest.fn(),
-    onDidChangeConfiguration: jest.fn(),
-    onDidChangeTextDocument: jest.fn(),
-    onDidChangeWatchedFiles: jest.fn(),
-    onDidCloseTextDocument: jest.fn(),
-    onDidOpenTextDocument: jest.fn(),
-    onDidSaveTextDocument: jest.fn(),
-    onDocumentColor: jest.fn(),
-    onDocumentFormatting: jest.fn(),
-    onDocumentHighlight: jest.fn(),
-    onDocumentLinkResolve: jest.fn(),
-    onDocumentLinks: jest.fn(),
-    onDocumentOnTypeFormatting: jest.fn(),
-    onDocumentRangeFormatting: jest.fn(),
-    onDocumentSymbol: jest.fn(),
-    onExecuteCommand: jest.fn(),
-    onExit: jest.fn(),
-    onFoldingRanges: jest.fn(),
-    onHover: jest.fn(),
-    onImplementation: jest.fn(),
-    onInitialize: jest.fn(),
-    onInitialized: jest.fn(),
-    onNotification: jest.fn(),
-    onPrepareRename: jest.fn(),
-    onReferences: jest.fn(),
-    onRenameRequest: jest.fn(),
-    onRequest: jest.fn(),
-    onShutdown: jest.fn(),
-    onSignatureHelp: jest.fn(),
-    onTypeDefinition: jest.fn(),
-    onWillSaveTextDocument: jest.fn(),
-    onWillSaveTextDocumentWaitUntil: jest.fn(),
-    onWorkspaceSymbol: jest.fn(),
-    sendDiagnostics: jest.fn(),
-    sendNotification: jest.fn(),
-    sendRequest: jest.fn(),
-    telemetry: {} as any,
-    tracer: {} as any,
-    window: {} as any,
-    workspace: {} as any,
-  }
+  const connection = getMockConnection()
 
   const server = await LspServer.initialize(connection, {
     rootPath: FIXTURE_FOLDER,

server/src/analyser.ts

@@ -66,15 +66,18 @@ export default class Analyzer {
         const uri = `file://${filePath}`
         connection.console.log(`Analyzing ${uri}`)
 
-        const fileContent = fs.readFileSync(filePath, 'utf8')
-
-        const shebang = getShebang(fileContent)
-        if (shebang && !isBashShebang(shebang)) {
-          connection.console.log(`Skipping file ${uri} with shebang "${shebang}"`)
-          return
+        try {
+          const fileContent = fs.readFileSync(filePath, 'utf8')
+          const shebang = getShebang(fileContent)
+          if (shebang && !isBashShebang(shebang)) {
+            connection.console.log(`Skipping file ${uri} with shebang "${shebang}"`)
+            return
+          }
+
+          analyzer.analyze(uri, LSP.TextDocument.create(uri, 'shell', 1, fileContent))
+        } catch (error) {
+          connection.console.warn(`Failed analyzing ${uri}. Error: ${error.message}`)
         }
-
-        analyzer.analyze(uri, LSP.TextDocument.create(uri, 'shell', 1, fileContent))
       })
 
       connection.console.log(`Analyzer finished after ${getTimePassed()}`)

testing/fixtures/broken-symlink.sh

@@ -0,0 +1 @@
+x.sh

testing/mocks.ts

@@ -0,0 +1,64 @@
+import * as lsp from 'vscode-languageserver'
+
+export function getMockConnection(): jest.Mocked<lsp.Connection> {
+  const console: any = {
+    error: jest.fn(),
+    warn: jest.fn(),
+    info: jest.fn(),
+    log: jest.fn(),
+  }
+
+  return {
+    client: {} as any,
+    console,
+    dispose: jest.fn(),
+    listen: jest.fn(),
+    onCodeAction: jest.fn(),
+    onCodeLens: jest.fn(),
+    onCodeLensResolve: jest.fn(),
+    onColorPresentation: jest.fn(),
+    onCompletion: jest.fn(),
+    onCompletionResolve: jest.fn(),
+    onDeclaration: jest.fn(),
+    onDefinition: jest.fn(),
+    onDidChangeConfiguration: jest.fn(),
+    onDidChangeTextDocument: jest.fn(),
+    onDidChangeWatchedFiles: jest.fn(),
+    onDidCloseTextDocument: jest.fn(),
+    onDidOpenTextDocument: jest.fn(),
+    onDidSaveTextDocument: jest.fn(),
+    onDocumentColor: jest.fn(),
+    onDocumentFormatting: jest.fn(),
+    onDocumentHighlight: jest.fn(),
+    onDocumentLinkResolve: jest.fn(),
+    onDocumentLinks: jest.fn(),
+    onDocumentOnTypeFormatting: jest.fn(),
+    onDocumentRangeFormatting: jest.fn(),
+    onDocumentSymbol: jest.fn(),
+    onExecuteCommand: jest.fn(),
+    onExit: jest.fn(),
+    onFoldingRanges: jest.fn(),
+    onHover: jest.fn(),
+    onImplementation: jest.fn(),
+    onInitialize: jest.fn(),
+    onInitialized: jest.fn(),
+    onNotification: jest.fn(),
+    onPrepareRename: jest.fn(),
+    onReferences: jest.fn(),
+    onRenameRequest: jest.fn(),
+    onRequest: jest.fn(),
+    onShutdown: jest.fn(),
+    onSignatureHelp: jest.fn(),
+    onTypeDefinition: jest.fn(),
+    onWillSaveTextDocument: jest.fn(),
+    onWillSaveTextDocumentWaitUntil: jest.fn(),
+    onWorkspaceSymbol: jest.fn(),
+    sendDiagnostics: jest.fn(),
+    sendNotification: jest.fn(),
+    sendRequest: jest.fn(),
+    telemetry: {} as any,
+    tracer: {} as any,
+    window: {} as any,
+    workspace: {} as any,
+  }
+}