Merge pull request bash-lsp#224 from bash-lsp/handle-glob-error

Handle glob errors instead of crashing

Author: skovhus

server/src/__tests__/analyzer.test.ts

@@ -2,6 +2,7 @@ import FIXTURES, { FIXTURE_FOLDER } from '../../../testing/fixtures'
 import { getMockConnection } from '../../../testing/mocks'
 import Analyzer from '../analyser'
 import { initializeParser } from '../parser'
+import * as fsUtil from '../util/fs'
 
 let analyzer: Analyzer
 
@@ -206,6 +207,8 @@ describe('fromRoot', () => {
 
  expect(newAnalyzer).toBeDefined()
 
+ expect(connection.window.showWarningMessage).not.toHaveBeenCalled()
+
  const FIXTURE_FILES_MATCHING_GLOB = 10
 
  // Intro, stats on glob, one file skipped due to shebang, and outro
@@ -222,4 +225,26 @@ describe('fromRoot', () => {
  'Analyzer finished after 0 seconds',
  )
  })
+
+ it('handles glob errors', async () => {
+ jest
+ .spyOn(fsUtil, 'getFilePaths')
+ .mockImplementation(() => Promise.reject(new Error('BOOM')))
+
+ const parser = await initializeParser()
+
+ const connection = getMockConnection()
+
+ const newAnalyzer = await Analyzer.fromRoot({
+ connection,
+ rootPath: FIXTURE_FOLDER,
+ parser,
+ })
+
+ expect(newAnalyzer).toBeDefined()
+
+ expect(connection.window.showWarningMessage).toHaveBeenCalledWith(
+ expect.stringContaining('BOOM'),
+ )
+ })
 })

server/src/analyser.ts

@@ -55,7 +55,14 @@ export default class Analyzer {
  const getTimePassed = (): string =>
  `${(Date.now() - lookupStartTime) / 1000} seconds`
 
- const filePaths = await getFilePaths({ globPattern, rootPath })
+ let filePaths: string[] = []
+ try {
+ filePaths = await getFilePaths({ globPattern, rootPath })
+ } catch (error) {
+ connection.window.showWarningMessage(
+ `Failed to analyze bash files using the glob "${globPattern}". The experience will be degraded. Consider configuring the glob or fix any permission issues. Error: ${error.message}`,
+ )
+ }
 
  // TODO: we could load all files without extensions: globPattern: '**/[^.]'
 

testing/mocks.ts

@@ -62,7 +62,14 @@ export function getMockConnection(): jest.Mocked<lsp.Connection> {
  sendRequest: jest.fn(),
  telemetry: {} as any,
  tracer: {} as any,
- window: {} as any,
+ window: {
+ attachWorkDoneProgress: jest.fn(),
+ connection: {} as any,
+ createWorkDoneProgress: jest.fn(),
+ showErrorMessage: jest.fn(),
+ showInformationMessage: jest.fn(),
+ showWarningMessage: jest.fn(),
+ },
  workspace: {} as any,
  }
 }