Skip to content

chore(profile-metrics-controller): replace Sinon with Jest in ProfileMetricsService tests #7916

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

Draft
cryptodev-2s wants to merge 1 commit into
base: main
Choose a base branch
from
+25 −16
Draft

chore(profile-metrics-controller): replace Sinon with Jest in ProfileMetricsService tests #7916

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
1 change: 0 additions & 1 deletion packages/profile-metrics-controller/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@
"deepmerge": "^4.2.2",
"jest": "^29.7.0",
"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
39 changes: 25 additions & 14 deletions packages/profile-metrics-controller/src/ProfileMetricsService.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { HttpError } from '@metamask/controller-utils';
import { Messenger, MOCK_ANY_NAMESPACE } from '@metamask/messenger';
import type {
MockAnyNamespace,
Expand All @@ -6,16 +7,13 @@ import type {
} from '@metamask/messenger';
import { SDK } from '@metamask/profile-sync-controller';
import nock from 'nock';
import { useFakeTimers } from 'sinon';
import type { SinonFakeTimers } from 'sinon';

import { ProfileMetricsService } from '.';
import type {
ProfileMetricsSubmitMetricsRequest,
ProfileMetricsServiceMessenger,
} from '.';
import { getAuthUrl } from './ProfileMetricsService';
import { HttpError } from '../../controller-utils/src/util';

const defaultBaseEndpoint = getAuthUrl(SDK.Env.DEV);

Expand All @@ -37,14 +35,12 @@ function createMockRequest(
}

describe('ProfileMetricsService', () => {
let clock: SinonFakeTimers;

beforeEach(() => {
clock = useFakeTimers();
jest.useFakeTimers({ legacyFakeTimers: true });
});

afterEach(() => {
clock.restore();
jest.useRealTimers();
});

describe('constructor', () => {
Expand Down Expand Up @@ -101,10 +97,12 @@ describe('ProfileMetricsService', () => {
});

it('calls onDegraded listeners if the request takes longer than 5 seconds to resolve', async () => {
const perfStart = performance.now();
nock(defaultBaseEndpoint)
.put('/profile/accounts')
.reply(200, () => {
clock.tick(6000);
jest.advanceTimersByTime(6000);
jest.spyOn(performance, 'now').mockReturnValue(perfStart + 6000);
return {
data: {
success: true,
Expand All @@ -124,10 +122,12 @@ describe('ProfileMetricsService', () => {
});

it('allows the degradedThreshold to be changed', async () => {
const perfStart = performance.now();
nock(defaultBaseEndpoint)
.put('/profile/accounts')
.reply(200, () => {
clock.tick(1000);
jest.advanceTimersByTime(1000);
jest.spyOn(performance, 'now').mockReturnValue(perfStart + 1000);
return {
data: {
success: true,
Expand All @@ -153,7 +153,9 @@ describe('ProfileMetricsService', () => {
it('attempts a request that responds with non-200 up to 4 times, throwing if it never succeeds', async () => {
nock(defaultBaseEndpoint).put('/profile/accounts').times(4).reply(500);
const { service, rootMessenger } = getService();
service.onRetry(clock.next);
service.onRetry(({ delay }: { delay: number }) => {
jest.advanceTimersByTime(delay);
});

await expect(
rootMessenger.call(
Expand All @@ -168,7 +170,9 @@ describe('ProfileMetricsService', () => {
it('calls onDegraded listeners when the maximum number of retries is exceeded', async () => {
nock(defaultBaseEndpoint).put('/profile/accounts').times(4).reply(500);
const { service, rootMessenger } = getService();
service.onRetry(clock.next);
service.onRetry(({ delay }: { delay: number }) => {
jest.advanceTimersByTime(delay);
});
const onDegradedListener = jest.fn();
service.onDegraded(onDegradedListener);

Expand All @@ -186,7 +190,9 @@ describe('ProfileMetricsService', () => {
it('intercepts requests and throws a circuit break error after the 4th failed attempt, running onBreak listeners', async () => {
nock(defaultBaseEndpoint).put('/profile/accounts').times(12).reply(500);
const { service, rootMessenger } = getService();
service.onRetry(clock.next);
service.onRetry(({ delay }: { delay: number }) => {
jest.advanceTimersByTime(delay);
});
const onBreakListener = jest.fn();
service.onBreak(onBreakListener);

Expand Down Expand Up @@ -252,7 +258,9 @@ describe('ProfileMetricsService', () => {
policyOptions: { circuitBreakDuration },
},
});
service.onRetry(clock.next);
service.onRetry(({ delay }: { delay: number }) => {
jest.advanceTimersByTime(delay);
});

await expect(
rootMessenger.call(
Expand Down Expand Up @@ -286,7 +294,10 @@ describe('ProfileMetricsService', () => {
).rejects.toThrow(
'Execution prevented because the circuit breaker is open',
);
await clock.tickAsync(circuitBreakDuration);
jest.advanceTimersByTime(circuitBreakDuration);
jest
.spyOn(Date, 'now')
.mockReturnValue(Number(Date.now()) + circuitBreakDuration);
const submitMetricsResponse =
await service.submitMetrics(createMockRequest());
expect(submitMetricsResponse).toBeUndefined();
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 @@ -4450,7 +4450,6 @@ __metadata:
deepmerge: "npm:^4.2.2"
jest: "npm:^29.7.0"
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
Loading