Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2026-04-21 00:59:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

GitHub - avatar resolution improvements (#238239)

Browse Source 
* Add support for size

* Add support for extracting user id from GitHub no-reply email addresses

* Fix git blame email parsing

* Extrat link into function
This commit is contained in:
Ladislau Szomoru
2025-01-19 16:44:40 +01:00
committed by GitHub
parent 909c1538c2
commit 1600fb4c76
7 changed files with 63 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
extensions/github/src/historyItemDetailsProvider.ts
View File

@@ -5,11 +5,10 @@
import { authentication, Command, l10n, LogOutputChannel } from 'vscode';
import { Commit, Repository as GitHubRepository, Maybe } from '@octokit/graphql-schema';
import { API, AvatarQuery, Repository, SourceControlHistoryItemDetailsProvider } from './typings/git';
import { API, AvatarQuery, AvatarQueryCommit, Repository, SourceControlHistoryItemDetailsProvider } from './typings/git';
import { DisposableStore, getRepositoryDefaultRemote, getRepositoryDefaultRemoteUrl, getRepositoryFromUrl, groupBy, sequentialize } from './util';
import { AuthenticationError, getOctokitGraphql } from './auth';
const AVATAR_SIZE = 20;
import { getAvatarLink } from './links';
const ISSUE_EXPRESSION = /(([A-Za-z0-9_.\-]+)\/([A-Za-z0-9_.\-]+))?(#|GH-)([1-9][0-9]*)($|\b)/g;
@@ -22,7 +21,7 @@ const ASSIGNABLE_USERS_QUERY = `
login
name
email
avatarUrl(size: ${AVATAR_SIZE})
avatarUrl
}
}
}
@@ -37,7 +36,7 @@ const COMMIT_AUTHOR_QUERY = `
author {
name
email
avatarUrl(size: ${AVATAR_SIZE})
avatarUrl
user {
id
login
@@ -62,7 +61,12 @@ interface GitHubUser {
readonly avatarUrl: string;
}
function compareAvatarQuery(a: AvatarQuery, b: AvatarQuery): number {
function getUserIdFromNoReplyEmail(email: string | undefined): string | undefined {
const match = email?.match(/^([0-9]+)\+[^@]+@users\.noreply\.github\.com$/);
return match?.[1];
}
function compareAvatarQuery(a: AvatarQueryCommit, b: AvatarQueryCommit): number {
// Email
const emailComparison = (a.authorEmail ?? '').localeCompare(b.authorEmail ?? '');
if (emailComparison !== 0) {
@@ -88,8 +92,8 @@ export class GitHubSourceControlHistoryItemDetailsProvider implements SourceCont
}));
}
async provideAvatar(repository: Repository, query: AvatarQuery[]): Promise<Map<string, string | undefined> | undefined> {
this._logger.trace(`[GitHubSourceControlHistoryItemDetailsProvider][provideAvatar] Avatar resolution for ${query.length} commit(s) in ${repository.rootUri.fsPath}.`);
async provideAvatar(repository: Repository, query: AvatarQuery): Promise<Map<string, string | undefined> | undefined> {
this._logger.trace(`[GitHubSourceControlHistoryItemDetailsProvider][provideAvatar] Avatar resolution for ${query.commits.length} commit(s) in ${repository.rootUri.fsPath}.`);
if (!this._enabled) {
this._logger.trace(`[GitHubSourceControlHistoryItemDetailsProvider][provideAvatar] Avatar resolution is disabled.`);
@@ -113,7 +117,7 @@ export class GitHubSourceControlHistoryItemDetailsProvider implements SourceCont
}
// Group the query by author
const authorQuery = groupBy<AvatarQuery>(query, compareAvatarQuery);
const authorQuery = groupBy<AvatarQueryCommit>(query.commits, compareAvatarQuery);
const results = new Map<string, string | undefined>();
await Promise.all(authorQuery.map(async q => {
@@ -128,29 +132,33 @@ export class GitHubSourceControlHistoryItemDetailsProvider implements SourceCont
// Cache hit
if (avatarUrl) {
// Add avatar for each commit
for (const { commit } of q) {
results.set(commit, this._getAvatarUrl(avatarUrl, AVATAR_SIZE));
}
q.forEach(({ hash }) => results.set(hash, avatarUrl));
return;
}
// Check if any of the commit are being tracked in the list
// of known commits that have incomplte author information
if (q.some(({ commit }) => repositoryStore.commits.has(commit))) {
for (const { commit } of q) {
results.set(commit, undefined);
}
if (q.some(({ hash }) => repositoryStore.commits.has(hash))) {
q.forEach(({ hash }) => results.set(hash, undefined));
return;
}
// Try to extract the user identifier from GitHub no-reply emails
const userIdFromEmail = getUserIdFromNoReplyEmail(q[0].authorEmail);
if (userIdFromEmail) {
const avatarUrl = getAvatarLink(userIdFromEmail, query.size);
q.forEach(({ hash }) => results.set(hash, avatarUrl));
return;
}
// Get the commit details
const commitAuthor = await this._getCommitAuthor(descriptor, q[0].commit);
const commitAuthor = await this._getCommitAuthor(descriptor, q[0].hash);
if (!commitAuthor) {
// The commit has incomplete author information, so
// we should not try to query the authors details again
for (const { commit } of q) {
repositoryStore.commits.add(commit);
results.set(commit, undefined);
for (const { hash } of q) {
repositoryStore.commits.add(hash);
results.set(hash, undefined);
}
return;
}
@@ -159,9 +167,7 @@ export class GitHubSourceControlHistoryItemDetailsProvider implements SourceCont
repositoryStore.users.push(commitAuthor);
// Add avatar for each commit
for (const { commit } of q) {
results.set(commit, this._getAvatarUrl(commitAuthor.avatarUrl, AVATAR_SIZE));
}
q.forEach(({ hash }) => results.set(hash, `${commitAuthor.avatarUrl}&s=${query.size}`));
}));
return results;
@@ -296,10 +302,6 @@ export class GitHubSourceControlHistoryItemDetailsProvider implements SourceCont
}
}
private _getAvatarUrl(url: string, size: number): string {
return `${url}|height=${size},width=${size}`;
}
private _getRepositoryKey(descriptor: { owner: string; repo: string }): string {
return `${descriptor.owner}/${descriptor.repo}`;
}