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

chore: bump asset controllers to 39 + polling API #28025

Merged
merged 12 commits into from
Oct 29, 2024
Merged

chore: bump asset controllers to 39 + polling API #28025

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
85fe12d
bump asset controllers to 39
bergeron Oct 22, 2024
0f3cd64
update ConfirmTransaction
bergeron Oct 22, 2024
bdf921b
fix useGasFeeEstimates unit test
bergeron Oct 22, 2024
9bc4ecf
fix usePolling tests
bergeron Oct 23, 2024
9b1529b
bump controller utils
bergeron Oct 23, 2024
c8bcc0b
remove patch
bergeron Oct 23, 2024
d1a3782
Merge branch 'develop' into brian/asset-controller-39
bergeron Oct 23, 2024
05fd6ef
Update LavaMoat policies
metamaskbot Oct 23, 2024
9dfdfa8
lint
bergeron Oct 23, 2024
04ea3d6
Merge branch 'brian/asset-controller-39' of github.com:MetaMask/metam…
bergeron Oct 23, 2024
cf66072
Merge branch 'develop' into brian/asset-controller-39
bergeron Oct 24, 2024
b93a15d
Merge branch 'develop' into brian/asset-controller-39
bergeron Oct 28, 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
0 ...s-controllers-npm-38.3.0-57b3d695bb.patch → ...s-controllers-npm-39.0.0-57b3d695bb.patch
View file
Open in desktop
File renamed without changes.
7 changes: 3 additions & 4 deletions app/scripts/metamask-controller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4002,10 +4002,9 @@ export default class MetamaskController extends EventEmitter {
),

// CurrencyRateController
currencyRateStartPollingByNetworkClientId:
currencyRateController.startPollingByNetworkClientId.bind(
currencyRateController,
),
currencyRateStartPolling: currencyRateController.startPolling.bind(
currencyRateController,
),
currencyRateStopPollingByPollingToken:
currencyRateController.stopPollingByPollingToken.bind(
currencyRateController,
Expand Down
8 changes: 1 addition & 7 deletions lavamoat/browserify/beta/policy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -674,13 +674,13 @@
"@ethersproject/providers": true,
"@metamask/abi-utils": true,
"@metamask/assets-controllers>@metamask/polling-controller": true,
"@metamask/assets-controllers>@metamask/rpc-errors": true,
"@metamask/base-controller": true,
"@metamask/contract-metadata": true,
"@metamask/controller-utils": true,
"@metamask/eth-query": true,
"@metamask/metamask-eth-abis": true,
"@metamask/name-controller>async-mutex": true,
"@metamask/rpc-errors": true,
"@metamask/utils": true,
"bn.js": true,
"cockatiel": true,
Expand All @@ -702,12 +702,6 @@
"uuid": true
}
},
"@metamask/assets-controllers>@metamask/rpc-errors": {
"packages": {
"@metamask/rpc-errors>fast-safe-stringify": true,
"@metamask/utils": true
}
},
"@metamask/base-controller": {
"globals": {
"setTimeout": true
Expand Down
8 changes: 1 addition & 7 deletions lavamoat/browserify/flask/policy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -674,13 +674,13 @@
"@ethersproject/providers": true,
"@metamask/abi-utils": true,
"@metamask/assets-controllers>@metamask/polling-controller": true,
"@metamask/assets-controllers>@metamask/rpc-errors": true,
"@metamask/base-controller": true,
"@metamask/contract-metadata": true,
"@metamask/controller-utils": true,
"@metamask/eth-query": true,
"@metamask/metamask-eth-abis": true,
"@metamask/name-controller>async-mutex": true,
"@metamask/rpc-errors": true,
"@metamask/utils": true,
"bn.js": true,
"cockatiel": true,
Expand All @@ -702,12 +702,6 @@
"uuid": true
}
},
"@metamask/assets-controllers>@metamask/rpc-errors": {
"packages": {
"@metamask/rpc-errors>fast-safe-stringify": true,
"@metamask/utils": true
}
},
"@metamask/base-controller": {
"globals": {
"setTimeout": true
Expand Down
8 changes: 1 addition & 7 deletions lavamoat/browserify/main/policy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -674,13 +674,13 @@
"@ethersproject/providers": true,
"@metamask/abi-utils": true,
"@metamask/assets-controllers>@metamask/polling-controller": true,
"@metamask/assets-controllers>@metamask/rpc-errors": true,
"@metamask/base-controller": true,
"@metamask/contract-metadata": true,
"@metamask/controller-utils": true,
"@metamask/eth-query": true,
"@metamask/metamask-eth-abis": true,
"@metamask/name-controller>async-mutex": true,
"@metamask/rpc-errors": true,
"@metamask/utils": true,
"bn.js": true,
"cockatiel": true,
Expand All @@ -702,12 +702,6 @@
"uuid": true
}
},
"@metamask/assets-controllers>@metamask/rpc-errors": {
"packages": {
"@metamask/rpc-errors>fast-safe-stringify": true,
"@metamask/utils": true
}
},
"@metamask/base-controller": {
"globals": {
"setTimeout": true
Expand Down
8 changes: 1 addition & 7 deletions lavamoat/browserify/mmi/policy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -766,13 +766,13 @@
"@ethersproject/providers": true,
"@metamask/abi-utils": true,
"@metamask/assets-controllers>@metamask/polling-controller": true,
"@metamask/assets-controllers>@metamask/rpc-errors": true,
"@metamask/base-controller": true,
"@metamask/contract-metadata": true,
"@metamask/controller-utils": true,
"@metamask/eth-query": true,
"@metamask/metamask-eth-abis": true,
"@metamask/name-controller>async-mutex": true,
"@metamask/rpc-errors": true,
"@metamask/utils": true,
"bn.js": true,
"cockatiel": true,
Expand All @@ -794,12 +794,6 @@
"uuid": true
}
},
"@metamask/assets-controllers>@metamask/rpc-errors": {
"packages": {
"@metamask/rpc-errors>fast-safe-stringify": true,
"@metamask/utils": true
}
},
"@metamask/base-controller": {
"globals": {
"setTimeout": true
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,12 +305,12 @@
"@metamask/address-book-controller": "^6.0.0",
"@metamask/announcement-controller": "^7.0.0",
"@metamask/approval-controller": "^7.0.0",
"@metamask/assets-controllers": "patch:@metamask/assets-controllers@npm%3A38.3.0#~/.yarn/patches/@metamask-assets-controllers-npm-38.3.0-57b3d695bb.patch",
"@metamask/assets-controllers": "patch:@metamask/assets-controllers@npm%3A39.0.0#~/.yarn/patches/@metamask-assets-controllers-npm-39.0.0-57b3d695bb.patch",
"@metamask/base-controller": "^7.0.0",
"@metamask/bitcoin-wallet-snap": "^0.8.1",
"@metamask/browser-passworder": "^4.3.0",
"@metamask/contract-metadata": "^2.5.0",
"@metamask/controller-utils": "^11.2.0",
"@metamask/controller-utils": "^11.4.0",
"@metamask/design-tokens": "^4.0.0",
"@metamask/ens-controller": "^13.0.0",
"@metamask/ens-resolver-snap": "^0.1.2",
Expand Down
5 changes: 3 additions & 2 deletions ui/hooks/useCurrencyRatePolling.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@ const useCurrencyRatePolling = (networkClientId?: string) => {
const selectedNetworkClientId = useSelector(getSelectedNetworkClientId);

usePolling({
startPollingByNetworkClientId: currencyRateStartPollingByNetworkClientId,
startPolling: (input) =>
currencyRateStartPollingByNetworkClientId(input.networkClientId),
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you help me understand why we aren't updating the action to also be currencyRateStartPolling?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

in actions.ts i kept the function name currencyRateStartPollingByNetworkClientId to minimize changes since it does still accept a network client id (for now)

stopPollingByPollingToken: currencyRateStopPollingByPollingToken,
networkClientId: networkClientId ?? selectedNetworkClientId,
input: { networkClientId: networkClientId ?? selectedNetworkClientId },
enabled: useCurrencyRateCheck && completedOnboarding,
});
};
Expand Down
5 changes: 3 additions & 2 deletions ui/hooks/useGasFeeEstimates.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,10 @@ export function useGasFeeEstimates(_networkClientId) {
}, [networkClientId]);

usePolling({
startPollingByNetworkClientId: gasFeeStartPollingByNetworkClientId,
startPolling: (input) =>
gasFeeStartPollingByNetworkClientId(input.networkClientId),
stopPollingByPollingToken: gasFeeStopPollingByPollingToken,
networkClientId,
input: { networkClientId },
});

return {
Expand Down
9 changes: 4 additions & 5 deletions ui/hooks/useGasFeeEstimates.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import {
getIsNetworkBusyByChainId,
} from '../ducks/metamask/metamask';
import {
gasFeeStartPollingByNetworkClientId,
gasFeeStopPollingByPollingToken,
getNetworkConfigurationByNetworkClientId,
} from '../store/actions';
Expand Down Expand Up @@ -115,9 +114,9 @@ describe('useGasFeeEstimates', () => {
renderHook(() => useGasFeeEstimates());
});
expect(usePolling).toHaveBeenCalledWith({
startPollingByNetworkClientId: gasFeeStartPollingByNetworkClientId,
startPolling: expect.any(Function),
stopPollingByPollingToken: gasFeeStopPollingByPollingToken,
networkClientId: 'selectedNetworkClientId',
input: { networkClientId: 'selectedNetworkClientId' },
});
});

Expand All @@ -127,9 +126,9 @@ describe('useGasFeeEstimates', () => {
renderHook(() => useGasFeeEstimates('networkClientId1'));
});
expect(usePolling).toHaveBeenCalledWith({
startPollingByNetworkClientId: gasFeeStartPollingByNetworkClientId,
startPolling: expect.any(Function),
stopPollingByPollingToken: gasFeeStopPollingByPollingToken,
networkClientId: 'networkClientId1',
input: { networkClientId: 'networkClientId1' },
});
});

Expand Down
16 changes: 6 additions & 10 deletions ui/hooks/usePolling.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,29 @@ import usePolling from './usePolling';

describe('usePolling', () => {
// eslint-disable-next-line jest/no-done-callback
it('calls startPollingByNetworkClientId and callback option args with polling token when component instantiating the hook mounts', (done) => {
it('calls startPolling and calls back with polling token when component instantiating the hook mounts', (done) => {
const mockStart = jest.fn().mockImplementation(() => {
return Promise.resolve('pollingToken');
});
const mockStop = jest.fn();
const networkClientId = 'mainnet';
const options = {};
const mockState = {
metamask: {},
};

renderHookWithProvider(() => {
usePolling({
callback: (pollingToken) => {
expect(mockStart).toHaveBeenCalledWith(networkClientId, options);
expect(mockStart).toHaveBeenCalledWith({ networkClientId });
expect(pollingToken).toBeDefined();
done();
return (_pollingToken) => {
// noop
};
},
startPollingByNetworkClientId: mockStart,
startPolling: mockStart,
stopPollingByPollingToken: mockStop,
networkClientId,
options,
input: { networkClientId },
});
}, mockState);
});
Expand All @@ -39,7 +37,6 @@ describe('usePolling', () => {
});
const mockStop = jest.fn();
const networkClientId = 'mainnet';
const options = {};
const mockState = {
metamask: {},
};
Expand All @@ -54,10 +51,9 @@ describe('usePolling', () => {
done();
};
},
startPollingByNetworkClientId: mockStart,
startPolling: mockStart,
stopPollingByPollingToken: mockStop,
networkClientId,
options,
input: { networkClientId },
}),
mockState,
);
Expand Down
30 changes: 8 additions & 22 deletions ui/hooks/usePolling.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,16 @@
import { useEffect, useRef } from 'react';

type UsePollingOptions = {
type UsePollingOptions<PollingInput> = {
callback?: (pollingToken: string) => (pollingToken: string) => void;
startPollingByNetworkClientId: (
networkClientId: string,
// TODO: Replace `any` with type
// eslint-disable-next-line @typescript-eslint/no-explicit-any
options: any,
) => Promise<string>;
startPolling: (input: PollingInput) => Promise<string>;
stopPollingByPollingToken: (pollingToken: string) => void;
networkClientId: string;
// TODO: Replace `any` with type
// eslint-disable-next-line @typescript-eslint/no-explicit-any
options?: any;
input: PollingInput;
enabled?: boolean;
};

const usePolling = (usePollingOptions: UsePollingOptions) => {
const usePolling = <PollingInput>(
usePollingOptions: UsePollingOptions<PollingInput>,
) => {
const pollTokenRef = useRef<null | string>(null);
const cleanupRef = useRef<null | ((pollingToken: string) => void)>(null);
let isMounted = false;
Expand All @@ -38,10 +32,7 @@ const usePolling = (usePollingOptions: UsePollingOptions) => {

// Start polling when the component mounts
usePollingOptions
.startPollingByNetworkClientId(
usePollingOptions.networkClientId,
usePollingOptions.options,
)
.startPolling(usePollingOptions.input)
.then((pollToken) => {
pollTokenRef.current = pollToken;
cleanupRef.current = usePollingOptions.callback?.(pollToken) || null;
Expand All @@ -56,12 +47,7 @@ const usePolling = (usePollingOptions: UsePollingOptions) => {
cleanup();
};
}, [
usePollingOptions.networkClientId,
usePollingOptions.options &&
JSON.stringify(
usePollingOptions.options,
Object.keys(usePollingOptions.options).sort(),
),
usePollingOptions.input && JSON.stringify(usePollingOptions.input),
usePollingOptions.enabled,
]);
};
Expand Down
5 changes: 3 additions & 2 deletions ui/pages/confirmations/confirm-transaction/confirm-transaction.component.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,10 @@ const ConfirmTransaction = () => {
const prevTransactionId = usePrevious(transactionId);

usePolling({
startPollingByNetworkClientId: gasFeeStartPollingByNetworkClientId,
startPolling: (input) =>
gasFeeStartPollingByNetworkClientId(input.networkClientId),
stopPollingByPollingToken: gasFeeStopPollingByPollingToken,
networkClientId: transaction.networkClientId ?? networkClientId,
input: { networkClientId: transaction.networkClientId ?? networkClientId },
});

useEffect(() => {
Expand Down
4 changes: 2 additions & 2 deletions ui/store/actions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4524,8 +4524,8 @@ export async function currencyRateStartPollingByNetworkClientId(
networkClientId: string,
): Promise<string> {
const pollingToken = await submitRequestToBackground(
'currencyRateStartPollingByNetworkClientId',
[networkClientId],
'currencyRateStartPolling',
[{ networkClientId }],
);
await addPollingTokenToAppState(pollingToken);
return pollingToken;
Expand Down
Loading