Mitigate python extension rejecting ready promise (#1765)

Author: mattseddon

extension/src/extensions/python.test.ts

@@ -0,0 +1,82 @@
+import { extensions } from 'vscode'
+import {
+  getPythonBinPath,
+  getOnDidChangePythonExecutionDetails,
+  VscodePython
+} from './python'
+import { executeProcess } from '../processExecution'
+
+jest.mock('vscode')
+jest.mock('../processExecution')
+
+const mockedExecuteProcess = jest.mocked(executeProcess)
+
+const mockedExtensions = jest.mocked(extensions)
+const mockedGetExtension = jest.fn()
+mockedExtensions.getExtension = mockedGetExtension
+
+const mockedReady = jest.fn()
+const mockedOnDidChangeExecutionDetails = jest.fn()
+let mockedExecCommand: string[] | undefined
+
+const mockedSettings = {
+  getExecutionDetails: () => ({
+    execCommand: mockedExecCommand
+  }),
+  onDidChangeExecutionDetails: mockedOnDidChangeExecutionDetails
+}
+
+const mockedVscodePythonAPI = {
+  ready: mockedReady,
+  settings: mockedSettings
+} as unknown as VscodePython
+
+const mockedVscodePython = {
+  activate: () => Promise.resolve(mockedVscodePythonAPI)
+}
+
+beforeEach(() => {
+  jest.resetAllMocks()
+  mockedGetExtension.mockReturnValueOnce(mockedVscodePython)
+})
+
+describe('getPythonBinPath', () => {
+  const mockedPythonBinPath = '/some/path/to/python'
+  mockedExecCommand = [mockedPythonBinPath]
+
+  it('should return the python path even if the python ready promise rejects', async () => {
+    mockedReady.mockRejectedValueOnce(undefined)
+    mockedExecuteProcess.mockResolvedValueOnce(mockedPythonBinPath)
+
+    const pythonBinPath = await getPythonBinPath()
+
+    expect(pythonBinPath).toStrictEqual(mockedPythonBinPath)
+  })
+
+  it('should return the python path if the python extension initializes as expected', async () => {
+    mockedReady.mockResolvedValueOnce(undefined)
+    mockedExecuteProcess.mockResolvedValueOnce(mockedPythonBinPath)
+
+    const pythonBinPath = await getPythonBinPath()
+
+    expect(pythonBinPath).toStrictEqual(mockedPythonBinPath)
+  })
+})
+
+describe('getOnDidChangePythonExecutionDetails', () => {
+  it('should return the listener if the python ready promise rejects', async () => {
+    mockedReady.mockRejectedValueOnce(undefined)
+
+    const listener = await getOnDidChangePythonExecutionDetails()
+
+    expect(listener).toBe(mockedOnDidChangeExecutionDetails)
+  })
+
+  it('should return the listener if the python extension initializes as expected', async () => {
+    mockedReady.mockResolvedValueOnce(undefined)
+
+    const listener = await getOnDidChangePythonExecutionDetails()
+
+    expect(listener).toBe(mockedOnDidChangeExecutionDetails)
+  })
+})

extension/src/extensions/python.ts

@@ -11,19 +11,19 @@ interface Settings {
   }
 }
 
-interface VscodePython {
+export interface VscodePython {
   ready: Thenable<void>
   settings: Settings
 }
 
-export const getPythonExtensionSettings = async (): Promise<
-  Settings | undefined
-> => {
+const getPythonExtensionSettings = async (): Promise<Settings | undefined> => {
   const api = await getExtensionAPI<VscodePython>(PYTHON_EXTENSION_ID)
   if (!api) {
     return
   }
-  await api.ready
+  try {
+    await api.ready
+  } catch {}
   return api.settings
 }
 

extension/src/vscode/extensions.ts

@@ -13,13 +13,17 @@ type PackageJSON = {
 const getExtension = <T>(id: string): Extension<T & PackageJSON> | undefined =>
   extensions.getExtension<T & PackageJSON>(id)
 
-export const getExtensionAPI = <T>(name: string): Thenable<T> | undefined => {
+export const getExtensionAPI = async <T>(
+  name: string
+): Promise<T | undefined> => {
   const extension = getExtension<T>(name)
   if (!extension) {
     return
   }
 
-  return extension.activate()
+  try {
+    return await extension.activate()
+  } catch {}
 }
 
 export const getExtensionVersion = <T>(id: string): string | undefined => {