Change IEnvironmentProvider interface

Author: Kartik Raj

src/client/pythonEnvironments/base/locator.ts

@@ -70,22 +70,22 @@ interface ILocatorFactoryAPI {
 
 export type ProposedDetailsAPI = (env: BaseEnvInfo) => Promise<EnvironmentDetailsByProvider | undefined>;
 export type InternalDetailsAPI = (env: BasicEnvInfo) => Promise<PythonEnvInfo | undefined>;
-
-export interface IDetailsAPI {
+export interface IResolverAPI {
+    /**
+     * Carries API to check if an environment can be recognized by the provider. Providers
+     * which returns details about an {@link EnvSource} are expected to
+     * provide this.
+     */
+    readonly sourceIdentifier: IIdentifierAPI | undefined;
     /**
-     * This is only called if the provider:
-     * * Can identify the environment.
-     * * Or can iterate out the environment.
      * Returns details or `undefined` if it was found if env is invalid.
+     * This is only called if:
+     * * The provider can identify the environment.
+     * * To get more details out of an environment already iterated by the provider.
      */
     getEnvironmentDetails: ProposedDetailsAPI;
 }
 
-export type IResolverAPI = IDetailsAPI | (IDetailsAPI & IIdentifierAPI);
-
-/**
- * Identifier need not be registered
- */
 interface IIdentifierAPI {
     /**
      * Environment source the provider identifies.
@@ -98,6 +98,7 @@ interface IIdentifierAPI {
 }
 
 export interface IInternalResolverAPI {
+    readonly kindIdentifier: IInternalIdentifierAPI | undefined;
     getEnvironmentDetails: InternalDetailsAPI;
 }
 

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

@@ -40,7 +40,9 @@ export class PythonEnvsResolver implements IResolvingLocator {
         if (this.parentLocator.addNewLocator) {
             this.parentLocator.addNewLocator(provider.createLocator, metadata);
         }
-        registerIdentifier(metadata.environments.envKinds[0], provider.canIdentifyEnvironment);
+        if (provider.kindIdentifier) {
+            registerIdentifier(provider.kindIdentifier.envKind, provider.kindIdentifier.canIdentifyEnvironment);
+        }
         registerResolver(metadata.environments.envKinds[0], provider.getEnvironmentDetails);
     }
 

src/client/pythonEnvironments/converter.ts

@@ -47,8 +47,12 @@ export function convertProviderMetaData(proposed: EnvironmentProviderMetadata):
 
 function convertResolverAPI(proposed: IResolverAPI): IInternalResolverAPI {
     return {
-        envKind: proposed.envSource ? convertKind(proposed.envSource) : undefined,
-        canIdentifyEnvironment: proposed.canIdentifyEnvironment,
+        kindIdentifier: proposed.sourceIdentifier
+            ? {
+                  envKind: convertKind(proposed.sourceIdentifier.envSource),
+                  canIdentifyEnvironment: proposed.sourceIdentifier.canIdentifyEnvironment,
+              }
+            : undefined,
         getEnvironmentDetails: convertDetailsAPI(proposed.getEnvironmentDetails),
     };
 }