Skip to content

chore(gas-fee-controller): replace Sinon with Jest fake timers #7968

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
cryptodev-2s merged 1 commit into from
Feb 18, 2026
+33 −41
Merged

chore(gas-fee-controller): replace Sinon with Jest fake timers #7968

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
3 changes: 0 additions & 3 deletions eslint-suppressions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -951,9 +951,6 @@
},
"@typescript-eslint/naming-convention": {
"count": 1
},
"import-x/namespace": {
"count": 2
}
},
"packages/gas-fee-controller/src/GasFeeController.ts": {
Expand Down
1 change: 0 additions & 1 deletion packages/gas-fee-controller/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@
"jest": "^29.7.0",
"jest-when": "^3.4.2",
"nock": "^13.3.1",
"sinon": "^9.2.4",
"ts-jest": "^29.2.5",
"typedoc": "^0.25.13",
"typedoc-plugin-missing-exports": "^2.0.0",
Expand Down
69 changes: 33 additions & 36 deletions packages/gas-fee-controller/src/GasFeeController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ import type {
} from '@metamask/network-controller';
import type { Hex } from '@metamask/utils';
import nock from 'nock';
import * as sinon from 'sinon';

import determineGasFeeCalculations from './determineGasFeeCalculations';
import {
Expand Down Expand Up @@ -74,12 +73,10 @@ const getRootMessenger = (): RootMessenger => {
const setupNetworkController = async ({
rootMessenger,
state,
clock,
initializeProvider = true,
}: {
rootMessenger: RootMessenger;
state: Partial<NetworkState>;
clock: sinon.SinonFakeTimers;
initializeProvider?: boolean;
}) => {
const networkControllerMessenger = new Messenger<
Expand Down Expand Up @@ -128,7 +125,7 @@ const setupNetworkController = async ({
networkController.initializeProvider();
// Ensure that the request for eth_getBlockByNumber made by the PollingBlockTracker
// inside the NetworkController goes through
await clock.nextAsync();
await jest.advanceTimersToNextTimerAsync();
}

return networkController;
Expand Down Expand Up @@ -256,7 +253,6 @@ function buildMockGasFeeStateEthGasPrice({
}

describe('GasFeeController', () => {
let clock: sinon.SinonFakeTimers;
let gasFeeController: GasFeeController;
let networkController: NetworkController;

Expand Down Expand Up @@ -312,7 +308,6 @@ describe('GasFeeController', () => {
networkController = await setupNetworkController({
rootMessenger,
state: networkControllerState,
clock,
initializeProvider: initializeNetworkProvider,
});
const restrictedMessenger = getGasFeeControllerMessenger(rootMessenger);
Expand All @@ -332,7 +327,7 @@ describe('GasFeeController', () => {
}

beforeEach(() => {
clock = sinon.useFakeTimers();
jest.useFakeTimers({ doNotFake: ['nextTick', 'queueMicrotask'] });
mockedDetermineGasFeeCalculations.mockResolvedValue(
buildMockGasFeeStateFeeMarket(),
);
Expand All @@ -344,7 +339,7 @@ describe('GasFeeController', () => {
// TODO: Either fix this lint violation or explain why it's necessary to ignore.
// eslint-disable-next-line @typescript-eslint/no-floating-promises
blockTracker?.destroy();
sinon.restore();
jest.useRealTimers();
});

describe('constructor', () => {
Expand Down Expand Up @@ -433,8 +428,10 @@ describe('GasFeeController', () => {
});

it('should continue updating the state with all estimate data (including new time estimates because of a subsequent call to determineGasFeeCalculations) on a set interval', async () => {
const pollingInterval = 10000;
await setupGasFeeController({ interval: pollingInterval });
await gasFeeController.getGasFeeEstimatesAndStartPolling(undefined);
await clock.nextAsync();
await jest.advanceTimersByTimeAsync(pollingInterval);

expect(gasFeeController.state).toMatchObject(
mockDetermineGasFeeCalculationsReturnValues[1],
Expand Down Expand Up @@ -501,7 +498,7 @@ describe('GasFeeController', () => {
await gasFeeController.getGasFeeEstimatesAndStartPolling(
'some-previously-unseen-token',
);
await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);

expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(2);
});
Expand All @@ -524,8 +521,8 @@ describe('GasFeeController', () => {

await gasFeeController.getGasFeeEstimatesAndStartPolling(undefined);
await gasFeeController.getGasFeeEstimatesAndStartPolling(undefined);
await clock.tickAsync(pollingInterval);
await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);

expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(3);
});
Expand All @@ -549,8 +546,8 @@ describe('GasFeeController', () => {
const pollToken =
await gasFeeController.getGasFeeEstimatesAndStartPolling(undefined);
await gasFeeController.getGasFeeEstimatesAndStartPolling(pollToken);
await clock.tickAsync(pollingInterval);
await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);

expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(4);
});
Expand Down Expand Up @@ -582,8 +579,8 @@ describe('GasFeeController', () => {
await gasFeeController.getGasFeeEstimatesAndStartPolling(
'some-previously-unseen-token-2',
);
await clock.tickAsync(pollingInterval);
await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);

expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(3);
});
Expand Down Expand Up @@ -632,12 +629,12 @@ describe('GasFeeController', () => {
await setupGasFeeController({ interval: pollingInterval });
const pollToken =
await gasFeeController.getGasFeeEstimatesAndStartPolling(undefined);
await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(2);

gasFeeController.disconnectPoller(pollToken);

await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(2);
});

Expand All @@ -646,13 +643,13 @@ describe('GasFeeController', () => {
await setupGasFeeController({ interval: pollingInterval });
const pollToken =
await gasFeeController.getGasFeeEstimatesAndStartPolling(undefined);
await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(2);

gasFeeController.disconnectPoller(pollToken);

await gasFeeController.getGasFeeEstimatesAndStartPolling(pollToken);
await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(4);
});
});
Expand All @@ -662,12 +659,12 @@ describe('GasFeeController', () => {
const pollingInterval = 10000;
await setupGasFeeController({ interval: pollingInterval });
await gasFeeController.getGasFeeEstimatesAndStartPolling(undefined);
await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(2);

gasFeeController.disconnectPoller('some-previously-unseen-token');

await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(3);
});
});
Expand All @@ -681,12 +678,12 @@ describe('GasFeeController', () => {
const pollToken1 =
await gasFeeController.getGasFeeEstimatesAndStartPolling(undefined);
await gasFeeController.getGasFeeEstimatesAndStartPolling(undefined);
await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(1);

gasFeeController.disconnectPoller(pollToken1);

await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(2);
});
});
Expand All @@ -707,12 +704,12 @@ describe('GasFeeController', () => {
const pollingInterval = 10000;
await setupGasFeeController({ interval: pollingInterval });
await gasFeeController.getGasFeeEstimatesAndStartPolling(undefined);
await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(2);

gasFeeController.stopPolling();

await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(2);
});

Expand All @@ -721,13 +718,13 @@ describe('GasFeeController', () => {
await setupGasFeeController({ interval: pollingInterval });
const pollToken =
await gasFeeController.getGasFeeEstimatesAndStartPolling(undefined);
await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(2);

gasFeeController.stopPolling();

await gasFeeController.getGasFeeEstimatesAndStartPolling(pollToken);
await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(4);
});

Expand All @@ -753,12 +750,12 @@ describe('GasFeeController', () => {
const pollToken =
await gasFeeController.getGasFeeEstimatesAndStartPolling(undefined);
await gasFeeController.getGasFeeEstimatesAndStartPolling(pollToken);
await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(3);

gasFeeController.stopPolling();

await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(3);
});

Expand All @@ -768,13 +765,13 @@ describe('GasFeeController', () => {
const pollToken =
await gasFeeController.getGasFeeEstimatesAndStartPolling(undefined);
await gasFeeController.getGasFeeEstimatesAndStartPolling(pollToken);
await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(3);

gasFeeController.stopPolling();

await gasFeeController.getGasFeeEstimatesAndStartPolling(pollToken);
await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(5);
});
});
Expand Down Expand Up @@ -1241,7 +1238,7 @@ describe('GasFeeController', () => {
gasFeeController.startPolling({
networkClientId: 'linea-sepolia',
});
await clock.tickAsync(0);
await jest.advanceTimersByTimeAsync(0);
expect(mockedDetermineGasFeeCalculations).toHaveBeenNthCalledWith(
1,
expect.objectContaining({
Expand All @@ -1250,9 +1247,9 @@ describe('GasFeeController', () => {
)}`,
}),
);
await clock.tickAsync(pollingInterval / 2);
await jest.advanceTimersByTimeAsync(pollingInterval / 2);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledTimes(1);
await clock.tickAsync(pollingInterval / 2);
await jest.advanceTimersByTimeAsync(pollingInterval / 2);
expect(mockedDetermineGasFeeCalculations).toHaveBeenNthCalledWith(
2,
expect.objectContaining({
Expand All @@ -1270,7 +1267,7 @@ describe('GasFeeController', () => {
gasFeeController.startPolling({
networkClientId: 'sepolia',
});
await clock.tickAsync(pollingInterval);
await jest.advanceTimersByTimeAsync(pollingInterval);
expect(mockedDetermineGasFeeCalculations).toHaveBeenCalledWith(
expect.objectContaining({
fetchGasEstimatesUrl: `https://some-eip-1559-endpoint/${convertHexToDecimal(
Expand Down
1 change: 0 additions & 1 deletion yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3703,7 +3703,6 @@ __metadata:
jest: "npm:^29.7.0"
jest-when: "npm:^3.4.2"
nock: "npm:^13.3.1"
sinon: "npm:^9.2.4"
ts-jest: "npm:^29.2.5"
typedoc: "npm:^0.25.13"
typedoc-plugin-missing-exports: "npm:^2.0.0"
Expand Down