Class ExternalApiFeature

src/features/ExternalApi.ts:38–213

*/
export class ExternalApiFeature implements IPowerShellExtensionClient {
    private static readonly registeredExternalExtension: Map<
        string,
        IExternalExtension
    > = new Map<string, IExternalExtension>();

    constructor(
        private extensionContext: vscode.ExtensionContext,
        private sessionManager: SessionManager,
        private logger: ILogger,
    ) {}

    /*
    DESCRIPTION:
        Registers your extension to allow usage of the external API. The returns
        a session UUID that will need to be passed in to subsequent API calls.

    USAGE:
        powerShellExtensionClient.registerExternalExtension(
            "ms-vscode.PesterTestExplorer" // the name of the extension using us
            "v1"); // API Version.

    RETURNS:
        string session uuid
    */
    public registerExternalExtension(id: string, apiVersion = "v1"): string {
        this.logger.writeDebug(
            `Registering extension '${id}' for use with API version '${apiVersion}'.`,
        );

        for (const [
            _name,
            externalExtension,
        ] of ExternalApiFeature.registeredExternalExtension) {
            if (externalExtension.id === id) {
                const message = `The extension '${id}' is already registered.`;
                this.logger.writeWarning(message);
                throw new Error(message);
            }
        }

        if (!vscode.extensions.all.some((ext) => ext.id === id)) {
            throw new Error(
                `No extension installed with id '${id}'. You must use a valid extension id.`,
            );
        }

        // Our ID is only only allowed to be used in our unit tests.
        if (
            id === "ms-vscode.powershell" &&
            !(this.extensionContext.extensionMode === vscode.ExtensionMode.Test)
        ) {
            throw new Error(
                "You can't use the PowerShell extension's id in this registration.",
            );
        }

        const uuid = uuidv4();