VSCode自定义Authentication Provider登录后‘登录’选项未消失求助

可能的原因 #

• 登录成功后未正确调用VSCode认证API更新会话状态，导致VSCode认证管理器未感知到登录状态变化
• 自定义认证提供者的getSessions方法未正确返回已登录会话，比如从存储读取失败或返回空数组
• 会话状态未持久化，重启前VSCode无法获取到已登录的会话信息
• 注册认证提供者时配置有误，或未正确触发UI刷新事件

解决步骤 #

1. 登录成功后创建/更新会话 #

登录流程完成后，必须调用vscode.authentication.createSession（首次登录）或updateSession（会话更新）方法，将用户账户信息传递给VSCode认证系统，示例代码：

import * as vscode from 'vscode';

// 登录成功后执行该逻辑
const userAccount: vscode.AuthenticationAccount = {
    id: '用户唯一标识ID',
    label: '显示的用户名'
};

// 创建新会话，替换your-provider-id为你的提供者ID，scopes替换为实际需要的权限范围
await vscode.authentication.createSession('your-provider-id', ['read:user'], userAccount);

2. 确保getSessions方法正确返回会话 #

自定义AuthenticationProvider的getSessions方法需要从持久化存储（比如扩展上下文的globalState）中读取已保存的会话并返回，示例：

class CustomAuthProvider implements vscode.AuthenticationProvider {
    constructor(private readonly context: vscode.ExtensionContext) {}

    async getSessions(scopes?: string[]): Promise<vscode.AuthenticationSession[]> {
        // 从扩展存储中读取已保存的会话
        const savedSession = this.context.globalState.get<vscode.AuthenticationSession>('auth-session');
        // 如果会话存在且匹配所需权限范围，返回会话数组
        if (savedSession && (!scopes || scopes.every(s => savedSession.scopes.includes(s)))) {
            return [savedSession];
        }
        return [];
    }

    // 其他方法（比如login、logout）实现...
}

注意：创建会话后，一定要把会话信息保存到globalState中，这样getSessions才能读取到。

3. 触发UI状态刷新 #

如果创建会话后UI仍未更新，可以主动触发认证提供者的onDidChangeSessions事件：

// 在CustomAuthProvider中定义事件发射器
private readonly _onDidChangeSessions = new vscode.EventEmitter<vscode.AuthenticationProviderAuthenticationSessionsChangeEvent>();
readonly onDidChangeSessions = this._onDidChangeSessions.event;

// 登录成功后触发事件
this._onDidChangeSessions.fire({ added: [newSession], removed: [], changed: [] });

4. 检查提供者注册配置 #

在扩展的activate方法中注册提供者时，确保ID和标签正确，并且根据需求设置supportsMultipleAccounts：

export function activate(context: vscode.ExtensionContext) {
    const authProvider = new CustomAuthProvider(context);
    context.subscriptions.push(
        vscode.authentication.registerAuthenticationProvider(
            'your-provider-id',
            '自定义登录',
            authProvider,
            { supportsMultipleAccounts: false }
        )
    );
}

5. 清理旧缓存 #

如果之前有残留的无效会话缓存，可以在扩展激活时清理旧的会话存储：

// 在扩展激活时清理旧会话
context.globalState.update('auth-session', undefined);

内容的提问来源于stack exchange，提问作者toho