Add to proposed API

Author: Kartik Raj

src/client/apiTypes.ts

@@ -5,6 +5,7 @@ import { Event, Uri } from 'vscode';
 import { Resource } from './common/types';
 import { IDataViewerDataProvider, IJupyterUriProvider } from './jupyter/types';
 import { EnvPathType, PythonEnvKind } from './pythonEnvironments/base/info';
+import { ProgressNotificationEvent } from './pythonEnvironments/base/locator';
 
 /*
  * Do not introduce any breaking changes to this API.
@@ -203,6 +204,10 @@ export interface IProposedExtensionAPI {
          *                    is triggered.
          */
         refreshEnvironment(options?: RefreshEnvironmentsOptions): Promise<EnvPathType[] | undefined>;
+        /**
+         * Fires with details of the current discovery progress, i.e when it starts, finishes or any other relevant stage.
+         */
+        readonly onRefreshProgress: Event<ProgressNotificationEvent>;
         /**
          * Returns a promise for the ongoing refresh. Returns `undefined` if there are no active
          * refreshes going on.

src/client/proposedApi.ts

@@ -112,6 +112,7 @@ export function buildProposedApi(
             onDidChangeExecutionDetails: interpreterService.onDidChangeInterpreterConfiguration,
             onDidEnvironmentsChanged: onDidInterpretersChangedEvent.event,
             onDidActiveEnvironmentChanged: onDidActiveInterpreterChangedEvent.event,
+            onRefreshProgress: discoveryApi.onProgress,
         },
     };
     return proposed;

src/test/proposedApi.unit.test.ts

@@ -9,7 +9,7 @@ import { IInterpreterPathService } from '../client/common/types';
 import { IInterpreterService } from '../client/interpreter/contracts';
 import { IServiceContainer } from '../client/ioc/types';
 import { buildProposedApi } from '../client/proposedApi';
-import { IDiscoveryAPI } from '../client/pythonEnvironments/base/locator';
+import { IDiscoveryAPI, ProgressNotificationEvent } from '../client/pythonEnvironments/base/locator';
 import { PythonEnvironment } from '../client/pythonEnvironments/info';
 import { PythonEnvKind, PythonEnvSource } from '../client/pythonEnvironments/base/info';
 import { Architecture } from '../client/common/utils/platform';
@@ -21,6 +21,7 @@ suite('Proposed Extension API', () => {
     let interpreterPathService: typemoq.IMock<IInterpreterPathService>;
     let interpreterService: typemoq.IMock<IInterpreterService>;
     let onDidExecutionEvent: Event<Uri | undefined>;
+    let onRefreshProgress: Event<ProgressNotificationEvent>;
 
     let proposed: IProposedExtensionAPI;
 
@@ -30,14 +31,21 @@ suite('Proposed Extension API', () => {
         interpreterPathService = typemoq.Mock.ofType<IInterpreterPathService>(undefined, typemoq.MockBehavior.Strict);
         interpreterService = typemoq.Mock.ofType<IInterpreterService>(undefined, typemoq.MockBehavior.Strict);
         onDidExecutionEvent = typemoq.Mock.ofType<Event<Uri | undefined>>().object;
+        onRefreshProgress = typemoq.Mock.ofType<Event<ProgressNotificationEvent>>().object;
         interpreterService.setup((i) => i.onDidChangeInterpreterConfiguration).returns(() => onDidExecutionEvent);
 
         serviceContainer.setup((s) => s.get(IInterpreterPathService)).returns(() => interpreterPathService.object);
         serviceContainer.setup((s) => s.get(IInterpreterService)).returns(() => interpreterService.object);
 
+        discoverAPI.setup((d) => d.onProgress).returns(() => onRefreshProgress);
+
         proposed = buildProposedApi(discoverAPI.object, serviceContainer.object);
     });
 
+    test('Provide a callback for tracking refresh progress', async () => {
+        assert.deepEqual(proposed.environment.onRefreshProgress, onRefreshProgress);
+    });
+
     test('Provide a callback which is called when execution details changes', async () => {
         assert.deepEqual(onDidExecutionEvent, proposed.environment.onDidChangeExecutionDetails);
     });