Change getter to function

Author: Kartik Raj

src/client/interpreter/contracts.ts

@@ -18,7 +18,7 @@ export const IComponentAdapter = Symbol('IComponentAdapter');
 export interface IComponentAdapter {
     readonly onProgress: Event<ProgressNotificationEvent>;
     triggerRefresh(query?: PythonLocatorQuery & { clearCache?: boolean }, trigger?: 'auto' | 'ui'): Promise<void>;
-    readonly refreshPromise: Promise<void> | undefined;
+    getRefreshPromise(): Promise<void> | undefined;
     readonly onChanged: Event<PythonEnvironmentsChangedEvent>;
     // VirtualEnvPrompt
     onDidCreate(resource: Resource, callback: () => void): Disposable;

src/client/interpreter/display/progressDisplay.ts

@@ -35,8 +35,9 @@ export class InterpreterLocatorProgressStatubarHandler implements IExtensionSing
             (event) => {
                 if (event.stage === ProgressReportStage.discoveryStarted) {
                     this.showProgress();
-                    if (this.pyenvs.refreshPromise) {
-                        this.pyenvs.refreshPromise.then(() => this.hideProgress());
+                    const refreshPromise = this.pyenvs.getRefreshPromise();
+                    if (refreshPromise) {
+                        refreshPromise.then(() => this.hideProgress());
                     }
                 }
             },

src/client/interpreter/interpreterService.ts

@@ -48,7 +48,7 @@ export class InterpreterService implements Disposable, IInterpreterService {
     }
 
     public get refreshPromise(): Promise<void> | undefined {
-        return this.pyenvs.refreshPromise;
+        return this.pyenvs.getRefreshPromise();
     }
 
     public get onDidChangeInterpreter(): Event<void> {

src/client/proposedApi.ts

@@ -16,7 +16,7 @@ import { IInterpreterService } from './interpreter/contracts';
 import { IServiceContainer } from './ioc/types';
 import { PythonEnvInfo } from './pythonEnvironments/base/info';
 import { getEnvPath } from './pythonEnvironments/base/info/env';
-import { IDiscoveryAPI } from './pythonEnvironments/base/locator';
+import { GetRefreshEnvironmentsOptions, IDiscoveryAPI } from './pythonEnvironments/base/locator';
 
 const onDidInterpretersChangedEvent = new EventEmitter<EnvironmentsChangedParams[]>();
 export function reportInterpretersChanged(e: EnvironmentsChangedParams[]): void {
@@ -106,8 +106,8 @@ export function buildProposedApi(
                 const paths = discoveryApi.getEnvs().map((e) => getEnvPath(e.executable.filename, e.location));
                 return Promise.resolve(paths);
             },
-            getRefreshPromise(): Promise<void> | undefined {
-                return discoveryApi.refreshPromise;
+            getRefreshPromise(options?: GetRefreshEnvironmentsOptions): Promise<void> | undefined {
+                return discoveryApi.getRefreshPromise(options);
             },
             onDidChangeExecutionDetails: interpreterService.onDidChangeInterpreterConfiguration,
             onDidEnvironmentsChanged: onDidInterpretersChangedEvent.event,

src/client/pythonEnvironments/api.ts

@@ -6,7 +6,12 @@ import { StopWatch } from '../common/utils/stopWatch';
 import { sendTelemetryEvent } from '../telemetry';
 import { EventName } from '../telemetry/constants';
 import { getEnvPath } from './base/info/env';
-import { IDiscoveryAPI, ProgressNotificationEvent, PythonLocatorQuery } from './base/locator';
+import {
+    GetRefreshEnvironmentsOptions,
+    IDiscoveryAPI,
+    ProgressNotificationEvent,
+    PythonLocatorQuery,
+} from './base/locator';
 
 export type GetLocatorFunc = () => Promise<IDiscoveryAPI>;
 
@@ -31,8 +36,8 @@ class PythonEnvironments implements IDiscoveryAPI {
         return this.locator.onProgress;
     }
 
-    public get refreshPromise() {
-        return this.locator.refreshPromise;
+    public getRefreshPromise(options?: GetRefreshEnvironmentsOptions) {
+        return this.locator.getRefreshPromise(options);
     }
 
     public get onChanged() {

src/client/pythonEnvironments/base/locator.ts

@@ -203,7 +203,7 @@ export interface IDiscoveryAPI {
      * Resolves once environment list has finished refreshing, i.e all environments are
      * discovered. Carries `undefined` if there is no refresh currently going on.
      */
-    readonly refreshPromise: Promise<void> | undefined;
+    getRefreshPromise(options?: GetRefreshEnvironmentsOptions): Promise<void> | undefined;
     /**
      * Triggers a new refresh for query if there isn't any already running.
      */

src/client/pythonEnvironments/base/locators/composite/envsCollectionService.ts

@@ -35,7 +35,7 @@ export class EnvsCollectionService extends PythonEnvsWatcher<PythonEnvCollection
         return this.progress.event;
     }
 
-    public get refreshPromise(): Promise<void> | undefined {
+    public getRefreshPromise(): Promise<void> | undefined {
         return this.refreshPromises.size > 0
             ? Promise.all(Array.from(this.refreshPromises.values())).then()
             : undefined;

src/client/pythonEnvironments/legacyIOC.ts

@@ -107,8 +107,8 @@ class ComponentAdapter implements IComponentAdapter {
         return this.api.triggerRefresh(query, trigger);
     }
 
-    public get refreshPromise() {
-        return this.api.refreshPromise;
+    public getRefreshPromise() {
+        return this.api.getRefreshPromise();
     }
 
     public get onProgress() {
@@ -235,7 +235,7 @@ class ComponentAdapter implements IComponentAdapter {
         }
         // We should already have initiated discovery. Wait for an env to be added
         // to the collection until the refresh has finished.
-        await Promise.race([onAddedToCollection.promise, this.api.refreshPromise]);
+        await Promise.race([onAddedToCollection.promise, this.api.getRefreshPromise()]);
         const envs = await asyncFilter(this.api.getEnvs(), (e) => filter(convertEnvInfo(e)));
         return envs.length > 0;
     }
@@ -297,7 +297,7 @@ class ComponentAdapter implements IComponentAdapter {
         if (options?.ignoreCache) {
             await this.api.triggerRefresh(query);
         }
-        await this.api.refreshPromise;
+        await this.api.getRefreshPromise();
         const envs = this.api.getEnvs(query);
         return envs.map(convertEnvInfo);
     }

src/test/proposedApi.unit.test.ts

@@ -389,7 +389,7 @@ suite('Proposed Extension API', () => {
 
     test('getRefreshPromise: common scenario', () => {
         const expected = Promise.resolve();
-        discoverAPI.setup((d) => d.refreshPromise).returns(() => expected);
+        discoverAPI.setup((d) => d.getRefreshPromise()).returns(() => expected);
         const actual = proposed.environment.getRefreshPromise();
 
         // We are comparing instances here, they should be the same instance.

src/test/pythonEnvironments/base/locators/composite/envsCollectionService.unit.test.ts

@@ -149,9 +149,9 @@ suite('Python envs locator - Environments Collection', async () => {
         let envs = collectionService.getEnvs();
 
         assertEnvsEqual(envs, []);
-        expect(collectionService.refreshPromise).to.not.equal(undefined);
+        expect(collectionService.getRefreshPromise()).to.not.equal(undefined);
 
-        await collectionService.refreshPromise;
+        await collectionService.getRefreshPromise();
         envs = collectionService.getEnvs();
 
         assertEnvsEqual(
@@ -377,14 +377,14 @@ suite('Python envs locator - Environments Collection', async () => {
         });
         collectionService = new EnvsCollectionService(cache, parentLocator);
 
-        expect(collectionService.refreshPromise).to.equal(
+        expect(collectionService.getRefreshPromise()).to.equal(
             undefined,
             'Should be undefined if no refresh is currently going on',
         );
 
         const promise = collectionService.triggerRefresh();
 
-        const onGoingRefreshPromise = collectionService.refreshPromise;
+        const onGoingRefreshPromise = collectionService.getRefreshPromise();
         expect(onGoingRefreshPromise).to.not.equal(undefined, 'Refresh triggered should be tracked');
         const onGoingRefreshPromiseDeferred = createDeferredFromPromise(onGoingRefreshPromise!);
         await sleep(1);
@@ -393,7 +393,7 @@ suite('Python envs locator - Environments Collection', async () => {
         deferred.resolve();
         await promise;
 
-        expect(collectionService.refreshPromise).to.equal(
+        expect(collectionService.getRefreshPromise()).to.equal(
             undefined,
             'Should be undefined if no refresh is currently going on',
         );
@@ -557,7 +557,7 @@ suite('Python envs locator - Environments Collection', async () => {
         refreshDeferred.resolve();
         await sleep(1);
 
-        await collectionService.refreshPromise; // Wait for refresh to finish
+        await collectionService.getRefreshPromise(); // Wait for refresh to finish
 
         /**
          * We expect 2 refreshes to be triggered in total, explanation: