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.

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

Jump to bottom

refactor(ConnectWalletForm): preserve key in errors #641

Merged
merged 6 commits into from
Oct 4, 2024
Merged

refactor(ConnectWalletForm): preserve key in errors #641

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5f5ab27
refactor(ConnectWalletForm): preserve key in errors
sidvishnoi Oct 3, 2024
24ffdd3
Merge branch 'main' into preserve-error-key
sidvishnoi Oct 3, 2024
dbe6ba8
remove changes from other branch
sidvishnoi Oct 3, 2024
a012ce4
missed one (thanks to 'any')
sidvishnoi Oct 3, 2024
843524d
use `prev` instead of `_`
sidvishnoi Oct 4, 2024
15a52f2
ev not optional in handleSubmit (for now)
sidvishnoi Oct 4, 2024
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
107 changes: 49 additions & 58 deletions src/popup/components/ConnectWalletForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ import {
isErrorWithKey,
sleep,
type ErrorWithKeyLike,
type ErrorKeys,
} from '@/shared/helpers';
import type { WalletAddress } from '@interledger/open-payments';
import type { ConnectWalletPayload, Response } from '@/shared/messages';
Expand All @@ -30,6 +29,10 @@ interface Inputs {
recurring: boolean;
}

type ErrorInfo = { message: string; info?: ErrorWithKeyLike };
type ErrorsParams = 'walletAddressUrl' | 'amount' | 'keyPair' | 'connect';
type Errors = Record<ErrorsParams, ErrorInfo | null>;

interface ConnectWalletFormProps {
publicKey: string;
defaultValues: Partial<Inputs>;
Expand Down Expand Up @@ -62,34 +65,34 @@ export const ConnectWalletForm = ({
const [recurring, setRecurring] = React.useState<Inputs['recurring']>(
defaultValues.recurring || false,
);

const [autoKeyShareFailed, setAutoKeyShareFailed] = React.useState(
isAutoKeyAddFailed(state),
);

const resetState = React.useCallback(async () => {
await clearConnectState();
setErrors((_) => ({ ..._, keyPair: '', connect: '' }));
setErrors((prev) => ({ ...prev, keyPair: null, connect: null }));
setAutoKeyShareFailed(false);
}, [clearConnectState]);

const toErrorInfo = React.useCallback(
(err?: string | ErrorWithKeyLike | null): ErrorInfo | null => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we have the error as string as well? Can't we pass the whole error directly? For example here:

web-monetization-extension/src/popup/components/ConnectWalletForm.tsx

Lines 114 to 124 in a012ce4

try {
setIsValidating((_) => ({ ..._, walletAddressUrl: true }));
const url = new URL(toWalletAddressUrl(walletAddressUrl));
const walletAddress = await getWalletInfo(url.toString());
setWalletAddressInfo(walletAddress);
} catch (error) {
setErrors((_) => ({
..._,
walletAddressUrl: toErrorInfo(error.message),
}));
return false;

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we allow passing { message: string } (which matches Error), we've to always add a check for isErrorWithKey, which is more expensive then typeof err === 'string'.

I'll look into rationalizing error types as a follow-up. I basically want only Error ({ messsage: string }) and ErrorWithKeyLike, with failure or ErrorResponse allowing returning serialization of either.

if (!err) return null;
if (typeof err === 'string') return { message: err };
return { message: t(err), info: err };
},
[t],
);

const [walletAddressInfo, setWalletAddressInfo] =
React.useState<WalletAddress | null>(null);

const [errors, setErrors] = React.useState({
walletAddressUrl: '',
amount: '',
keyPair:
state?.status === 'error:key'
? isErrorWithKey(state.error)
? t(state.error)
: state.error
: '',
connect:
state?.status === 'error'
? isErrorWithKey(state.error)
? t(state.error)
: state.error
: '',
const [errors, setErrors] = React.useState<Errors>({
walletAddressUrl: null,
amount: null,
keyPair: state?.status === 'error:key' ? toErrorInfo(state.error) : null,
connect: state?.status === 'error' ? toErrorInfo(state.error) : null,
raducristianpopa marked this conversation as resolved.
Show resolved Hide resolved
});
const [isValidating, setIsValidating] = React.useState({
walletAddressUrl: false,
Expand All @@ -106,22 +109,25 @@ export const ConnectWalletForm = ({

const getWalletInformation = React.useCallback(
async (walletAddressUrl: string): Promise<boolean> => {
setErrors((_) => ({ ..._, walletAddressUrl: '' }));
setErrors((prev) => ({ ...prev, walletAddressUrl: null }));
if (!walletAddressUrl) return false;
try {
setIsValidating((_) => ({ ..._, walletAddressUrl: true }));
const url = new URL(toWalletAddressUrl(walletAddressUrl));
const walletAddress = await getWalletInfo(url.toString());
setWalletAddressInfo(walletAddress);
} catch (error) {
setErrors((_) => ({ ..._, walletAddressUrl: error.message }));
setErrors((prev) => ({
...prev,
walletAddressUrl: toErrorInfo(error.message),
}));
return false;
} finally {
setIsValidating((_) => ({ ..._, walletAddressUrl: false }));
}
return true;
},
[getWalletInfo],
[getWalletInfo, toErrorInfo],
);

const handleWalletAddressUrlChange = React.useCallback(
Expand All @@ -130,21 +136,21 @@ export const ConnectWalletForm = ({
setWalletAddressUrl(value);

const error = validateWalletAddressUrl(value);
setErrors((_) => ({ ..._, walletAddressUrl: error ? t(error) : '' }));
setErrors((prev) => ({ ...prev, walletAddressUrl: toErrorInfo(error) }));
saveValue('walletAddressUrl', value);
if (!error) {
const ok = await getWalletInformation(value);
return ok;
}
return false;
},
[saveValue, getWalletInformation, t],
[saveValue, getWalletInformation, toErrorInfo],
);

const handleAmountChange = React.useCallback(
(value: string, input: HTMLInputElement) => {
const error = validateAmount(value, currencySymbol.symbol);
setErrors((_) => ({ ..._, amount: error ? t(error) : '' }));
setErrors((prev) => ({ ...prev, amount: toErrorInfo(error) }));

const amountValue = formatNumber(+value, currencySymbol.scale);
if (!error) {
Expand All @@ -153,23 +159,19 @@ export const ConnectWalletForm = ({
}
saveValue('amount', error ? value : amountValue);
},
[saveValue, currencySymbol, t],
[saveValue, currencySymbol, toErrorInfo],
);

const handleSubmit = async (ev: React.FormEvent<HTMLFormElement>) => {
ev.preventDefault();
if (!walletAddressInfo) {
setErrors((_) => ({ ..._, walletAddressUrl: 'Not fetched yet?!' }));
return;
}

const errWalletAddressUrl = validateWalletAddressUrl(walletAddressUrl);
const errAmount = validateAmount(amount, currencySymbol.symbol);
if (errAmount || errWalletAddressUrl) {
setErrors((_) => ({
..._,
walletAddressUrl: errWalletAddressUrl ? t(errWalletAddressUrl) : '',
amount: errAmount && t(errAmount),
setErrors((prev) => ({
...prev,
walletAddressUrl: toErrorInfo(errWalletAddressUrl),
amount: toErrorInfo(errAmount),
Comment on lines +173 to +174
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are mixing errors as exceptions and errors as value with the validateWalletAddressUrl and validateAmount. Not a big fan, but I understand why this approach.

It might be worth looking into neverthrow later on.

}));
return;
}
Expand All @@ -181,7 +183,7 @@ export const ConnectWalletForm = ({
skipAutoKeyShare = true;
setAutoKeyShareFailed(true);
}
setErrors((_) => ({ ..._, keyPair: '', connect: '' }));
setErrors((prev) => ({ ...prev, keyPair: null, connect: null }));
const res = await connectWallet({
walletAddressUrl: toWalletAddressUrl(walletAddressUrl),
amount,
Expand All @@ -194,16 +196,16 @@ export const ConnectWalletForm = ({
if (isErrorWithKey(res.error)) {
const error = res.error;
if (error.key.startsWith('connectWalletKeyService_error_')) {
setErrors((_) => ({ ..._, keyPair: t(error) }));
setErrors((prev) => ({ ...prev, keyPair: toErrorInfo(error) }));
} else {
setErrors((_) => ({ ..._, connect: t(error) }));
setErrors((prev) => ({ ...prev, connect: toErrorInfo(error) }));
}
} else {
throw new Error(res.message);
}
}
} catch (error) {
setErrors((_) => ({ ..._, connect: error.message }));
setErrors((prev) => ({ ...prev, connect: toErrorInfo(error.message) }));
} finally {
setIsSubmitting(false);
}
Expand Down Expand Up @@ -239,15 +241,15 @@ export const ConnectWalletForm = ({
</div>

{errors.connect && (
<ErrorMessage error={errors.connect} className="my-0" />
<ErrorMessage error={errors.connect.message} className="my-0" />
)}

<Input
type="text"
label={t('connectWallet_label_walletAddress')}
id="connectWalletAddressUrl"
placeholder="https://ilp.rafiki.money/johndoe"
errorMessage={errors.walletAddressUrl}
errorMessage={errors.walletAddressUrl?.message}
defaultValue={walletAddressUrl}
addOn={
isValidating.walletAddressUrl ? (
Expand Down Expand Up @@ -312,7 +314,7 @@ export const ConnectWalletForm = ({
readOnly={!walletAddressInfo?.assetCode || isSubmitting}
addOn={<span className="text-weak">{currencySymbol.symbol}</span>}
aria-invalid={!!errors.amount}
aria-describedby={errors.amount}
aria-describedby={errors.amount?.message}
required={true}
onKeyDown={allowOnlyNumericInput}
onBlur={(ev) => {
Expand All @@ -337,7 +339,7 @@ export const ConnectWalletForm = ({
</div>

{errors.amount && (
<p className="px-2 text-sm text-error">{errors.amount}</p>
<p className="px-2 text-sm text-error">{errors.amount.message}</p>
)}
</fieldset>

Expand Down Expand Up @@ -390,20 +392,20 @@ export const ConnectWalletForm = ({
};

const ManualKeyPairNeeded: React.FC<{
error: { message: string; details: string; whyText: string };
error: { message: string; details: null | ErrorInfo; whyText: string };
hideError?: boolean;
text: string;
learnMoreText: string;
publicKey: string;
}> = ({ error, hideError, text, learnMoreText, publicKey }) => {
const ErrorDetails = () => {
if (!error) return null;
if (!error || !error.details) return null;
return (
<details className="group inline-block">
<summary className="cursor-pointer list-none underline decoration-dotted group-open:sr-only">
{error.whyText}
</summary>
<span>{error.details}</span>
<span>{error.details.message}</span>
</details>
);
};
Expand Down Expand Up @@ -465,18 +467,7 @@ const Footer: React.FC<{
);
};

type ErrorCodeWalletAddressUrl = Extract<
ErrorKeys,
`connectWallet_error_url${string}`
>;
type ErrorCodeAmount = Extract<
ErrorKeys,
`connectWallet_error_amount${string}`
>;

function validateWalletAddressUrl(
value: string,
): '' | ErrorWithKeyLike<ErrorCodeWalletAddressUrl> {
function validateWalletAddressUrl(value: string): null | ErrorWithKeyLike {
if (!value) {
return errorWithKey('connectWallet_error_urlRequired');
}
Expand All @@ -491,13 +482,13 @@ function validateWalletAddressUrl(
return errorWithKey('connectWallet_error_urlInvalidNotHttps');
}

return '';
return null;
}

function validateAmount(
value: string,
currencySymbol: string,
): '' | ErrorWithKeyLike<ErrorCodeAmount> {
): null | ErrorWithKeyLike {
if (!value) {
return errorWithKey('connectWallet_error_amountRequired');
}
Expand All @@ -510,7 +501,7 @@ function validateAmount(
if (val <= 0) {
return errorWithKey('connectWallet_error_amountMinimum');
}
return '';
return null;
}

function allowOnlyNumericInput(ev: React.KeyboardEvent<HTMLInputElement>) {
Expand Down