Skip to content
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.

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

feat(ConnectWalletForm): let retry key auto-add on some errors #642

Merged
merged 1 commit into from
Oct 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion src/background/services/background.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import type { Browser } from 'webextension-polyfill';
import type { ToBackgroundMessage } from '@/shared/messages';
import {
errorWithKeyToJSON,
failure,
getNextOccurrence,
getWalletInformation,
Expand Down Expand Up @@ -278,7 +279,7 @@ export class Background {
} catch (e) {
if (isErrorWithKey(e)) {
this.logger.error(message.action, e);
return failure({ key: e.key, substitutions: e.substitutions });
return failure(errorWithKeyToJSON(e));
}
if (e instanceof OpenPaymentsClientError) {
this.logger.error(message.action, e.message, e.description);
Expand Down
12 changes: 8 additions & 4 deletions src/background/services/keyAutoAdd.ts
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,14 @@ export class KeyAutoAddService {
this.browser.tabs.onRemoved.removeListener(onTabCloseListener);
const { stepName, details: err } = message.payload;
reject(
new ErrorWithKey('connectWalletKeyService_error_failed', [
stepName,
isErrorWithKey(err.error) ? this.t(err.error) : err.message,
]),
new ErrorWithKey(
'connectWalletKeyService_error_failed',
[
stepName,
isErrorWithKey(err.error) ? this.t(err.error) : err.message,
],
isErrorWithKey(err.error) ? err.error : undefined,
),
);
} else if (message.action === 'PROGRESS') {
// can also save progress to show in popup
Expand Down
21 changes: 20 additions & 1 deletion src/popup/components/ConnectWalletForm.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,7 @@ export const ConnectWalletForm = ({
details: errors.keyPair,
whyText: t('connectWallet_error_failedAutoKeyAddWhy'),
}}
retry={resetState}
hideError={!errors.keyPair}
text={t('connectWallet_label_publicKey')}
learnMoreText={t('connectWallet_text_publicKeyLearnMore')}
Expand Down Expand Up @@ -394,10 +395,11 @@ export const ConnectWalletForm = ({
const ManualKeyPairNeeded: React.FC<{
error: { message: string; details: null | ErrorInfo; whyText: string };
hideError?: boolean;
retry: () => Promise<void>;
text: string;
learnMoreText: string;
publicKey: string;
}> = ({ error, hideError, text, learnMoreText, publicKey }) => {
}> = ({ error, hideError, text, learnMoreText, publicKey, retry }) => {
const ErrorDetails = () => {
if (!error || !error.details) return null;
return (
Expand All @@ -406,6 +408,15 @@ const ManualKeyPairNeeded: React.FC<{
{error.whyText}
</summary>
<span>{error.details.message}</span>
{canRetryAutoKeyAdd(error.details.info) && (
<button
type="button"
onClick={retry}
className="ml-1 inline-block text-primary underline"
>
Try again?
</button>
)}
</details>
);
};
Expand Down Expand Up @@ -448,6 +459,14 @@ function isAutoKeyAddFailed(state: PopupTransientState['connect']) {
return false;
}

function canRetryAutoKeyAdd(err?: ErrorInfo['info']) {
if (!err) return false;
return (
err.cause?.key === 'connectWalletKeyService_error_timeoutLogin' ||
err.cause?.key === 'connectWalletKeyService_error_accountNotFound'
);
}

const Footer: React.FC<{
text: string;
learnMoreText: string;
Expand Down
10 changes: 7 additions & 3 deletions src/shared/helpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ export interface ErrorWithKeyLike<T extends ErrorKeys = ErrorKeys> {
key: Extract<ErrorKeys, T>;
// Could be empty, but required for checking if an object follows this interface
substitutions: string[];
cause?: ErrorWithKeyLike;
}

export class ErrorWithKey<T extends ErrorKeys = ErrorKeys>
Expand All @@ -83,8 +84,9 @@ export class ErrorWithKey<T extends ErrorKeys = ErrorKeys>
constructor(
public readonly key: ErrorWithKeyLike<T>['key'],
public readonly substitutions: ErrorWithKeyLike<T>['substitutions'] = [],
public readonly cause?: ErrorWithKeyLike,
) {
super(key);
super(key, { cause });
}
}

Expand All @@ -96,7 +98,8 @@ export class ErrorWithKey<T extends ErrorKeys = ErrorKeys>
export const errorWithKey = <T extends ErrorKeys = ErrorKeys>(
key: ErrorWithKeyLike<T>['key'],
substitutions: ErrorWithKeyLike<T>['substitutions'] = [],
) => ({ key, substitutions });
cause?: ErrorWithKeyLike,
) => ({ key, substitutions, cause });

export const isErrorWithKey = (err: any): err is ErrorWithKeyLike => {
if (!err || typeof err !== 'object') return false;
Expand All @@ -107,7 +110,8 @@ export const isErrorWithKey = (err: any): err is ErrorWithKeyLike => {
};

export const errorWithKeyToJSON = (err: ErrorWithKeyLike): ErrorWithKeyLike => {
return { key: err.key, substitutions: err.substitutions };
const { key, substitutions, cause } = err;
return { key, substitutions, cause };
};

export const success = <TPayload = undefined>(
Expand Down