Add fallback/cutoff to our backend calls similar to how we handle GitHub queries #3519 (#3494)

* Handles errors of GKDev API and Code suggestions (drafts)
(#3494, #3519)

* Makes Provider-related errors more generic, e.g. drops provider prefix
(#3494, #3519)

* Counts exceptions of GK API and drops current session if gets too many
(#3494, #3519)

* Handles more different error types differently
(#3494, #3519)

* Handle exception on reactivating ProTrial
(#3494, #3519)

* Checks unsuccessful response on rate limits and timeouts to pause them
(#3494, #3519)

* Create GK scoped "show message/error" functions
(#3494, #3519)

Author: sergeibbb

src/config.ts

@@ -589,6 +589,9 @@ export type SuppressedMessages =
 	| 'suppressLineUncommittedWarning'
 	| 'suppressNoRepositoryWarning'
 	| 'suppressRebaseSwitchToTextWarning'
+	| 'suppressGkDisconnectedTooManyFailedRequestsWarningMessage'
+	| 'suppressGkRequestFailed500Warning'
+	| 'suppressGkRequestTimedOutWarning'
 	| 'suppressIntegrationDisconnectedTooManyFailedRequestsWarning'
 	| 'suppressIntegrationRequestFailed500Warning'
 	| 'suppressIntegrationRequestTimedOutWarning'

src/errors.ts

@@ -210,30 +210,54 @@ export class ProviderNotFoundError extends Error {
 	}
 }
 
-export class ProviderRequestClientError extends Error {
+export class RequestClientError extends Error {
 	constructor(public readonly original: Error) {
 		super(original.message);
 
-		Error.captureStackTrace?.(this, ProviderRequestClientError);
+		Error.captureStackTrace?.(this, RequestClientError);
 	}
 }
 
-export class ProviderRequestNotFoundError extends Error {
+export class RequestNotFoundError extends Error {
 	constructor(public readonly original: Error) {
 		super(original.message);
 
-		Error.captureStackTrace?.(this, ProviderRequestNotFoundError);
+		Error.captureStackTrace?.(this, RequestNotFoundError);
 	}
 }
 
-export class ProviderRequestRateLimitError extends Error {
+export class RequestRateLimitError extends Error {
 	constructor(
 		public readonly original: Error,
-		public readonly token: string,
+		public readonly token: string | undefined,
 		public readonly resetAt: number | undefined,
 	) {
 		super(original.message);
 
-		Error.captureStackTrace?.(this, ProviderRequestRateLimitError);
+		Error.captureStackTrace?.(this, RequestRateLimitError);
+	}
+}
+
+export class RequestGoneError extends Error {
+	constructor(public readonly original: Error) {
+		super(original.message);
+
+		Error.captureStackTrace?.(this, RequestGoneError);
+	}
+}
+
+export class RequestUnprocessableEntityError extends Error {
+	constructor(public readonly original: Error) {
+		super(original.message);
+
+		Error.captureStackTrace?.(this, RequestUnprocessableEntityError);
+	}
+}
+
+export class RequestsAreBlockedTemporarilyError extends Error {
+	constructor() {
+		super('Requests are blocked');
+
+		Error.captureStackTrace?.(this, RequestsAreBlockedTemporarilyError);
 	}
 }

src/messages.ts

@@ -160,6 +160,30 @@ export function showRebaseSwitchToTextWarningMessage(): Promise<MessageItem | un
 	);
 }
 
+export function showGkDisconnectedTooManyFailedRequestsWarningMessage(): Promise<MessageItem | undefined> {
+	return showMessage(
+		'error',
+		`Requests to GitKraken have stopped being sent for this session, because of too many failed requests.`,
+		'suppressGkDisconnectedTooManyFailedRequestsWarningMessage',
+		undefined,
+		{
+			title: 'OK',
+		},
+	);
+}
+
+export function showGkRequestFailed500WarningMessage(message: string): Promise<MessageItem | undefined> {
+	return showMessage('error', message, 'suppressGkRequestFailed500Warning', undefined, {
+		title: 'OK',
+	});
+}
+
+export function showGkRequestTimedOutWarningMessage(): Promise<MessageItem | undefined> {
+	return showMessage('error', `GitKraken request timed out.`, 'suppressGkRequestTimedOutWarning', undefined, {
+		title: 'OK',
+	});
+}
+
 export function showIntegrationDisconnectedTooManyFailedRequestsWarningMessage(
 	providerName: string,
 ): Promise<MessageItem | undefined> {

src/plus/gk/account/subscriptionService.ts

@@ -26,7 +26,7 @@ import type { CoreColors } from '../../../constants.colors';
 import { Commands } from '../../../constants.commands';
 import type { Source, TrackingContext } from '../../../constants.telemetry';
 import type { Container } from '../../../container';
-import { AccountValidationError } from '../../../errors';
+import { AccountValidationError, RequestsAreBlockedTemporarilyError } from '../../../errors';
 import type { RepositoriesChangeEvent } from '../../../git/gitProviderService';
 import { executeCommand, registerCommand } from '../../../system/command';
 import { configuration } from '../../../system/configuration';
@@ -418,6 +418,7 @@ export class SubscriptionService implements Disposable {
 	}
 
 	private async logoutCore(reset: boolean = false): Promise<void> {
+		this.connection.resetRequestExceptionCount();
 		this._lastValidatedDate = undefined;
 		if (this._validationTimer != null) {
 			clearInterval(this._validationTimer);
@@ -497,24 +498,41 @@ export class SubscriptionService implements Disposable {
 		const session = await this.ensureSession(false);
 		if (session == null) return;
 
-		const rsp = await this.connection.fetchApi('user/reactivate-trial', {
-			method: 'POST',
-			body: JSON.stringify({ client: 'gitlens' }),
-		});
+		try {
+			const rsp = await this.connection.fetchApi('user/reactivate-trial', {
+				method: 'POST',
+				body: JSON.stringify({ client: 'gitlens' }),
+			});
+
+			if (!rsp.ok) {
+				if (rsp.status === 409) {
+					void window.showErrorMessage(
+						'You are not eligible to reactivate your Pro trial. If you feel that is an error, please contact support.',
+						'OK',
+					);
+					return;
+				}
 
-		if (!rsp.ok) {
-			if (rsp.status === 409) {
 				void window.showErrorMessage(
-					'You are not eligible to reactivate your Pro trial. If you feel that is an error, please contact support.',
+					`Unable to reactivate trial: (${rsp.status}) ${rsp.statusText}. Please try again. If this issue persists, please contact support.`,
+					'OK',
+				);
+				return;
+			}
+		} catch (ex) {
+			if (ex instanceof RequestsAreBlockedTemporarilyError) {
+				void window.showErrorMessage(
+					'Unable to reactivate trial: Too many failed requests. Please reload the window and try again.',
 					'OK',
 				);
 				return;
 			}
 
 			void window.showErrorMessage(
-				`Unable to reactivate trial: (${rsp.status}) ${rsp.statusText}. Please try again. If this issue persists, please contact support.`,
+				`Unable to reactivate trial. Please try again. If this issue persists, please contact support.`,
 				'OK',
 			);
+			Logger.error(ex, scope);
 			return;
 		}
 
@@ -1161,6 +1179,7 @@ export class SubscriptionService implements Disposable {
 			}
 		}
 
+		this.connection.resetRequestExceptionCount();
 		return session;
 	}