development/vscode
development/vscode
1
0
Fork 0
mirror of https://github.com/Microsoft/vscode synced 2024-08-27 04:49:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

ensure GitHub Edu telemetry fires only per account not per session

Browse source
This commit is contained in:
Tyler Leonhardt 2022-04-11 11:04:46 -07:00
parent 783c0f8921
commit 46452a2dbf
No known key found for this signature in database
GPG key ID: D9BFA0BA8AD9F6F7
1 changed files with 13 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
extensions/github-authentication/src/github.ts
View file

@ -36,6 +36,7 @@ export class GitHubAuthenticationProvider implements vscode.AuthenticationProvid
private _keychain: Keychain = new Keychain(this.context, `${this.type}.auth`, this._logger);
private _sessionsPromise: Promise<vscode.AuthenticationSession[]>;
private _accountsSeen = new Set<string>();
private _disposable: vscode.Disposable;
constructor(private readonly context: vscode.ExtensionContext, private readonly type: AuthProviderType) {
@ -55,7 +56,11 @@ export class GitHubAuthenticationProvider implements vscode.AuthenticationProvid
}
// Contains the current state of the sessions we have available.
this._sessionsPromise = this.readSessions();
this._sessionsPromise = this.readSessions().then((sessions) => {
// fire telemetry after a second to allow the workbench to focus on loading
setTimeout(() => sessions.forEach(s => this.afterSessionLoad(s)), 1000);
return sessions;
});
this._disposable = vscode.Disposable.from(
this._telemetryReporter,
@ -86,8 +91,12 @@ export class GitHubAuthenticationProvider implements vscode.AuthenticationProvid
return finalSessions;
}
private async afterTokenLoad(token: string): Promise<void> {
this._githubServer.sendAdditionalTelemetryInfo(token);
private async afterSessionLoad(session: vscode.AuthenticationSession): Promise<void> {
// We only want to fire a telemetry if we haven't seen this account yet in this session.
if (!this._accountsSeen.has(session.account.id)) {
this._accountsSeen.add(session.account.id);
this._githubServer.sendAdditionalTelemetryInfo(session.accessToken);
}
}
private async checkForUpdates() {
@ -164,8 +173,6 @@ export class GitHubAuthenticationProvider implements vscode.AuthenticationProvid
}
}
setTimeout(() => this.afterTokenLoad(session.accessToken), 1000);
this._logger.trace(`Read the following session from the keychain with the following scopes: ${scopesStr}`);
scopesSeen.add(scopesStr);
return {
@ -218,8 +225,8 @@ export class GitHubAuthenticationProvider implements vscode.AuthenticationProvid
const scopeString = sortedScopes.join(' ');
const token = await this._githubServer.login(scopeString);
this.afterTokenLoad(token);
const session = await this.tokenToSession(token, sortedScopes);
this.afterSessionLoad(session);
const sessions = await this._sessionsPromise;
const sessionIndex = sessions.findIndex(s => s.id === session.id || arrayEquals([...s.scopes].sort(), sortedScopes));