Skip to content

Refreshes expired integration sessions before use and improves error handling #4241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 24, 2025
Merged

Refreshes expired integration sessions before use and improves error handling #4241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions src/plus/integrations/authentication/cloudIntegrationService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,21 @@ export class CloudIntegrationService {
},
);
}

if (refresh) {
// try once to just get the lastest token if the refresh fails, and give up if that fails too
const newTokenRsp = await this.connection.fetchGkApi(
`v1/provider-tokens/${cloudIntegrationType}`,
{ method: 'GET' },
{ organizationId: false },
);
if (newTokenRsp.ok) {
return (await newTokenRsp.json())?.data as Promise<
CloudIntegrationAuthenticationSession | undefined
>;
}
}

return undefined;
}

Expand Down
58 changes: 58 additions & 0 deletions src/plus/integrations/integration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,18 @@ export abstract class IntegrationBase<
return defaultValue;
}

@gate()
protected async refreshSessionIfExpired(scope?: LogScope): Promise<void> {
if (this._session?.expiresAt != null && this._session.expiresAt < new Date()) {
// The current session is expired, so get the latest from the cloud and refresh if needed
try {
await this.syncCloudConnection('connected', true);
} catch (ex) {
Logger.error(ex, scope);
}
}
}

@debug()
trackRequestException(): void {
this.requestExceptionCount++;
Expand Down Expand Up @@ -433,6 +445,8 @@ export abstract class IntegrationBase<
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

try {
const issues = await this.searchProviderMyIssues(
this._session!,
Expand Down Expand Up @@ -463,6 +477,8 @@ export abstract class IntegrationBase<
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

const issueOrPR = this.container.cache.getIssueOrPullRequest(
id,
options?.type,
Expand Down Expand Up @@ -507,6 +523,8 @@ export abstract class IntegrationBase<
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

const issue = this.container.cache.getIssue(
id,
resource,
Expand Down Expand Up @@ -542,6 +560,8 @@ export abstract class IntegrationBase<
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

const { expiryOverride, ...opts } = options ?? {};

const currentAccount = await this.container.cache.getCurrentAccount(
Expand Down Expand Up @@ -574,6 +594,8 @@ export abstract class IntegrationBase<
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

const pr = await this.container.cache.getPullRequest(id, resource, this, () => ({
value: (async () => {
try {
Expand Down Expand Up @@ -604,9 +626,12 @@ export abstract class IssueIntegration<
@gate()
@debug()
async getAccountForResource(resource: T): Promise<Account | undefined> {
const scope = getLogScope();
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

try {
const account = await this.getProviderAccountForResource(this._session!, resource);
this.resetRequestExceptionCount();
Expand All @@ -624,9 +649,12 @@ export abstract class IssueIntegration<
@gate()
@debug()
async getResourcesForUser(): Promise<T[] | undefined> {
const scope = getLogScope();
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

try {
const resources = await this.getProviderResourcesForUser(this._session!);
this.resetRequestExceptionCount();
Expand All @@ -640,9 +668,12 @@ export abstract class IssueIntegration<

@debug()
async getProjectsForResources(resources: T[]): Promise<T[] | undefined> {
const scope = getLogScope();
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

try {
const projects = await this.getProviderProjectsForResources(this._session!, resources);
this.resetRequestExceptionCount();
Expand All @@ -669,9 +700,12 @@ export abstract class IssueIntegration<
project: T,
options?: { user?: string; filters?: IssueFilter[] },
): Promise<IssueShape[] | undefined> {
const scope = getLogScope();
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

try {
const issues = await this.getProviderIssuesForProject(this._session!, project, options);
this.resetRequestExceptionCount();
Expand Down Expand Up @@ -708,6 +742,8 @@ export abstract class HostingIntegration<
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

try {
const author = await this.getProviderAccountForEmail(this._session!, repo, email, options);
this.resetRequestExceptionCount();
Expand Down Expand Up @@ -740,6 +776,8 @@ export abstract class HostingIntegration<
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

try {
const author = await this.getProviderAccountForCommit(this._session!, repo, rev, options);
this.resetRequestExceptionCount();
Expand Down Expand Up @@ -768,6 +806,8 @@ export abstract class HostingIntegration<
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

const defaultBranch = this.container.cache.getRepositoryDefaultBranch(
repo,
this,
Expand Down Expand Up @@ -805,6 +845,8 @@ export abstract class HostingIntegration<
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

const metadata = this.container.cache.getRepositoryMetadata(
repo,
this,
Expand Down Expand Up @@ -845,6 +887,8 @@ export abstract class HostingIntegration<
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return false;

await this.refreshSessionIfExpired(scope);

try {
const result = await this.mergeProviderPullRequest(this._session!, pr, options);
this.resetRequestExceptionCount();
Expand Down Expand Up @@ -877,6 +921,8 @@ export abstract class HostingIntegration<
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

const { expiryOverride, ...opts } = options ?? {};

const pr = this.container.cache.getPullRequestForBranch(
Expand Down Expand Up @@ -920,6 +966,8 @@ export abstract class HostingIntegration<
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

const pr = this.container.cache.getPullRequestForSha(
rev,
repo,
Expand Down Expand Up @@ -954,10 +1002,13 @@ export abstract class HostingIntegration<
customUrl?: string;
},
): Promise<PagedResult<ProviderIssue> | undefined> {
const scope = getLogScope();
const providerId = this.authProvider.id;
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

const api = await this.getProvidersApi();
if (
providerId !== HostingIntegrationId.GitLab &&
Expand Down Expand Up @@ -1157,10 +1208,13 @@ export abstract class HostingIntegration<
customUrl?: string;
},
): Promise<PagedResult<ProviderPullRequest> | undefined> {
const scope = getLogScope();
const providerId = this.authProvider.id;
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

const api = await this.getProvidersApi();
if (
providerId !== HostingIntegrationId.GitLab &&
Expand Down Expand Up @@ -1319,6 +1373,8 @@ export abstract class HostingIntegration<
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

const start = Date.now();
try {
const pullRequests = await this.searchProviderMyPullRequests(
Expand Down Expand Up @@ -1361,6 +1417,8 @@ export abstract class HostingIntegration<
const connected = this.maybeConnected ?? (await this.isConnected());
if (!connected) return undefined;

await this.refreshSessionIfExpired(scope);

try {
const prs = await this.searchProviderPullRequests?.(
this._session!,
Expand Down
45 changes: 32 additions & 13 deletions src/plus/integrations/providers/providersApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import {
AuthenticationError,
AuthenticationErrorReason,
RequestClientError,
RequestNotFoundError,
RequestRateLimitError,
} from '../../../errors';
import type { PagedResult } from '../../../git/gitProvider';
Expand Down Expand Up @@ -378,15 +379,17 @@ export class ProvidersApi {
throw new Error(`Provider with id ${providerId} not registered`);
}

switch (providerId) {
case IssueIntegrationId.Jira: {
if (error?.response?.status != null) {
if (error.response.status === 401) {
throw new AuthenticationError(providerId, AuthenticationErrorReason.Forbidden, error);
} else if (error.response.status === 429) {
if (error?.response?.status != null) {
switch (error.response.status) {
case 404: // Not found
case 410: // Gone
case 422: // Unprocessable Entity
throw new RequestNotFoundError(error);
case 401: // Unauthorized
if (error.message?.includes('rate limit')) {
let resetAt: number | undefined;

const reset = error.response.headers?.['x-ratelimit-reset'];
const reset = error.response?.headers?.['x-ratelimit-reset'];
if (reset != null) {
resetAt = parseInt(reset, 10);
if (Number.isNaN(resetAt)) {
Expand All @@ -395,16 +398,32 @@ export class ProvidersApi {
}

throw new RequestRateLimitError(error, token, resetAt);
} else if (error.response.status >= 400 && error.response.status < 500) {
throw new RequestClientError(error);
}
throw new AuthenticationError(providerId, AuthenticationErrorReason.Unauthorized, error);
case 403: // Forbidden
throw new AuthenticationError(providerId, AuthenticationErrorReason.Forbidden, error);
case 429: {
// Too Many Requests
let resetAt: number | undefined;

const reset = error.response.headers?.['x-ratelimit-reset'];
if (reset != null) {
resetAt = parseInt(reset, 10);
if (Number.isNaN(resetAt)) {
resetAt = undefined;
}
}

throw new RequestRateLimitError(error, token, resetAt);
}
throw error;
}
default: {
throw error;
default:
if (error.response.status >= 400 && error.response.status < 500) {
throw new RequestClientError(error);
}
}
}

throw error;
}

async getPagedResult<T>(
Expand Down