Skip to content

Commit fd6e405

Browse files
AbhiPrasadAbhiPrasad
authored
test(feedback): Migrate from jest to vitest (#15497)
1 parent 06d2479 commit fd6e405

File tree

11 files changed

+59
-48
lines changed

11 files changed

+59
-48
lines changed

‎packages/feedback/.eslintrc.js

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,4 @@
55

66
module.exports = {
77
extends: ['../../.eslintrc.js'],
8-
overrides: [
9-
{
10-
files: ['jest.setup.ts', 'jest.config.ts'],
11-
parserOptions: {
12-
project: ['tsconfig.test.json'],
13-
},
14-
},
15-
],
168
};

‎packages/feedback/jest.config.js

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎packages/feedback/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@
6262
"clean": "rimraf build sentry-internal-feedback-*.tgz",
6363
"fix": "eslint . --format stylish --fix",
6464
"lint": "eslint . --format stylish",
65-
"test": "jest",
66-
"test:watch": "jest --watch",
65+
"test": "vitest run",
66+
"test:watch": "vitest --watch",
6767
"yalc:publish": "yalc publish --push --sig"
6868
},
6969
"volta": {

‎packages/feedback/src/core/TestClient.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ export class TestClient extends Client<TestClientOptions> {
1414
/**
1515
*
1616
*/
17+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
1718
public eventFromException(exception: any): PromiseLike<Event> {
1819
return resolvedSyncPromise({
1920
exception: {

‎packages/feedback/src/core/components/Actor.test.ts renamed to ‎packages/feedback/test/core/components/Actor.test.ts

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
1-
import { TRIGGER_LABEL } from '../../constants';
2-
import { getFeedback } from '../getFeedback';
3-
import { buildFeedbackIntegration } from '../integration';
1+
/**
2+
* @vitest-environment jsdom
3+
*/
4+
import { vi, describe, it, expect } from 'vitest';
5+
6+
import { TRIGGER_LABEL } from '../../../src/constants';
7+
import { getFeedback } from '../../../src/core/getFeedback';
8+
import { buildFeedbackIntegration } from '../../../src/core/integration';
49
import { mockSdk } from '../mockSdk';
510

611
describe('Actor', () => {
712
it('renders the actor button', () => {
813
const feedbackIntegration = buildFeedbackIntegration({
9-
lazyLoadIntegration: jest.fn(),
14+
lazyLoadIntegration: vi.fn(),
1015
});
1116

1217
const configuredIntegration = feedbackIntegration({});
@@ -27,7 +32,7 @@ describe('Actor', () => {
2732

2833
it('renders the correct aria label for the button', () => {
2934
const feedbackIntegration = buildFeedbackIntegration({
30-
lazyLoadIntegration: jest.fn(),
35+
lazyLoadIntegration: vi.fn(),
3136
});
3237

3338
const configuredIntegration = feedbackIntegration({});

‎packages/feedback/src/core/getFeedback.test.ts renamed to ‎packages/feedback/test/core/getFeedback.test.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
import { vi, describe, it, expect } from 'vitest';
2+
13
import { getCurrentScope } from '@sentry/core';
2-
import { getFeedback } from './getFeedback';
3-
import { buildFeedbackIntegration } from './integration';
4+
import { getFeedback } from '../../src/core/getFeedback';
5+
import { buildFeedbackIntegration } from '../../src/core/integration';
46
import { mockSdk } from './mockSdk';
57

68
describe('getFeedback', () => {
@@ -26,7 +28,7 @@ describe('getFeedback', () => {
2628

2729
it('works with a client with Feedback', () => {
2830
const feedbackIntegration = buildFeedbackIntegration({
29-
lazyLoadIntegration: jest.fn(),
31+
lazyLoadIntegration: vi.fn(),
3032
});
3133

3234
const configuredIntegration = feedbackIntegration({});

‎packages/feedback/src/core/mockSdk.ts renamed to ‎packages/feedback/test/core/mockSdk.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
import { vi } from 'vitest';
2+
13
import type { Envelope, Transport, TransportMakeRequestResponse } from '@sentry/core';
24

3-
import type { TestClientOptions } from './TestClient';
4-
import { getDefaultClientOptions, init } from './TestClient';
5+
import type { TestClientOptions } from '../../src/core/TestClient';
6+
import { getDefaultClientOptions, init } from '../../src/core/TestClient';
57

68
export interface MockSdkParams {
79
sentryOptions?: Partial<TestClientOptions>;
@@ -11,7 +13,7 @@ class MockTransport implements Transport {
1113
public send: (request: Envelope) => PromiseLike<TransportMakeRequestResponse>;
1214

1315
public constructor() {
14-
this.send = jest.fn(async () => {
16+
this.send = vi.fn(async () => {
1517
return {
1618
statusCode: 200,
1719
};

‎packages/feedback/src/core/sendFeedback.test.ts renamed to ‎packages/feedback/test/core/sendFeedback.test.ts

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/**
2+
* @vitest-environment jsdom
3+
*/
4+
import { vi, describe, it, expect } from 'vitest';
5+
16
import {
27
addBreadcrumb,
38
getClient,
@@ -9,7 +14,7 @@ import {
914
} from '@sentry/core';
1015

1116
import { mockSdk } from './mockSdk';
12-
import { sendFeedback } from './sendFeedback';
17+
import { sendFeedback } from '../../src/core/sendFeedback';
1318

1419
import { TextDecoder, TextEncoder } from 'util';
1520
const patchedEncoder = (!global.window.TextEncoder && (global.window.TextEncoder = TextEncoder)) || true;
@@ -20,7 +25,7 @@ describe('sendFeedback', () => {
2025
beforeEach(() => {
2126
getIsolationScope().clear();
2227
getCurrentScope().clear();
23-
jest.clearAllMocks();
28+
vi.clearAllMocks();
2429
});
2530

2631
afterAll(() => {
@@ -32,7 +37,7 @@ describe('sendFeedback', () => {
3237

3338
it('sends feedback with minimal options', async () => {
3439
mockSdk();
35-
const mockTransport = jest.spyOn(getClient()!.getTransport()!, 'send');
40+
const mockTransport = vi.spyOn(getClient()!.getTransport()!, 'send');
3641

3742
const promise = sendFeedback({
3843
message: 'mi',
@@ -67,7 +72,7 @@ describe('sendFeedback', () => {
6772
feedback: {
6873
message: 'mi',
6974
source: 'api',
70-
url: 'http://localhost/',
75+
url: 'http://localhost:3000/',
7176
},
7277
},
7378
level: 'info',
@@ -83,7 +88,7 @@ describe('sendFeedback', () => {
8388

8489
it('sends feedback with full options', async () => {
8590
mockSdk();
86-
const mockTransport = jest.spyOn(getClient()!.getTransport()!, 'send');
91+
const mockTransport = vi.spyOn(getClient()!.getTransport()!, 'send');
8792

8893
const promise = sendFeedback({
8994
name: 'doe',
@@ -142,7 +147,7 @@ describe('sendFeedback', () => {
142147

143148
it('applies active span data to feedback', async () => {
144149
mockSdk({ sentryOptions: { tracesSampleRate: 1 } });
145-
const mockTransport = jest.spyOn(getClient()!.getTransport()!, 'send');
150+
const mockTransport = vi.spyOn(getClient()!.getTransport()!, 'send');
146151

147152
await startSpan({ name: 'test span' }, () => {
148153
return sendFeedback({
@@ -181,7 +186,7 @@ describe('sendFeedback', () => {
181186
message: 'mi',
182187
name: 'doe',
183188
source: 'api',
184-
url: 'http://localhost/',
189+
url: 'http://localhost:3000/',
185190
},
186191
},
187192
level: 'info',
@@ -197,7 +202,7 @@ describe('sendFeedback', () => {
197202

198203
it('applies scope data to feedback', async () => {
199204
mockSdk({ sentryOptions: { tracesSampleRate: 1 } });
200-
const mockTransport = jest.spyOn(getClient()!.getTransport()!, 'send');
205+
const mockTransport = vi.spyOn(getClient()!.getTransport()!, 'send');
201206

202207
await withIsolationScope(isolationScope => {
203208
isolationScope.setTag('test-1', 'tag');
@@ -242,7 +247,7 @@ describe('sendFeedback', () => {
242247
message: 'mi',
243248
name: 'doe',
244249
source: 'api',
245-
url: 'http://localhost/',
250+
url: 'http://localhost:3000/',
246251
},
247252
},
248253
extra: {
@@ -266,7 +271,7 @@ describe('sendFeedback', () => {
266271

267272
it('handles 400 transport error', async () => {
268273
mockSdk();
269-
jest.spyOn(getClient()!.getTransport()!, 'send').mockImplementation(() => {
274+
vi.spyOn(getClient()!.getTransport()!, 'send').mockImplementation(() => {
270275
return Promise.resolve({ statusCode: 400 });
271276
});
272277

@@ -283,7 +288,7 @@ describe('sendFeedback', () => {
283288

284289
it('handles 0 transport error', async () => {
285290
mockSdk();
286-
jest.spyOn(getClient()!.getTransport()!, 'send').mockImplementation(() => {
291+
vi.spyOn(getClient()!.getTransport()!, 'send').mockImplementation(() => {
287292
return Promise.resolve({ statusCode: 0 });
288293
});
289294

@@ -300,7 +305,7 @@ describe('sendFeedback', () => {
300305

301306
it('handles 200 transport response', async () => {
302307
mockSdk();
303-
jest.spyOn(getClient()!.getTransport()!, 'send').mockImplementation(() => {
308+
vi.spyOn(getClient()!.getTransport()!, 'send').mockImplementation(() => {
304309
return Promise.resolve({ statusCode: 200 });
305310
});
306311

@@ -314,10 +319,10 @@ describe('sendFeedback', () => {
314319
});
315320

316321
it('handles timeout', async () => {
317-
jest.useFakeTimers();
322+
vi.useFakeTimers();
318323

319324
mockSdk();
320-
jest.spyOn(getClient()!.getTransport()!, 'send').mockImplementation(() => {
325+
vi.spyOn(getClient()!.getTransport()!, 'send').mockImplementation(() => {
321326
return new Promise(resolve => setTimeout(resolve, 10_000));
322327
});
323328

@@ -327,16 +332,16 @@ describe('sendFeedback', () => {
327332
message: 'mi',
328333
});
329334

330-
jest.advanceTimersByTime(5_000);
335+
vi.advanceTimersByTime(5_000);
331336

332337
await expect(promise).rejects.toMatch('Unable to determine if Feedback was correctly sent.');
333338

334-
jest.useRealTimers();
339+
vi.useRealTimers();
335340
});
336341

337342
it('sends attachments', async () => {
338343
mockSdk();
339-
const mockTransport = jest.spyOn(getClient()!.getTransport()!, 'send');
344+
const mockTransport = vi.spyOn(getClient()!.getTransport()!, 'send');
340345

341346
const attachment1 = new Uint8Array([1, 2, 3, 4, 5]);
342347
const attachment2 = new Uint8Array([6, 7, 8, 9]);
@@ -395,7 +400,7 @@ describe('sendFeedback', () => {
395400
message: 'mi',
396401
name: 'doe',
397402
source: 'api',
398-
url: 'http://localhost/',
403+
url: 'http://localhost:3000/',
399404
},
400405
},
401406
level: 'info',

‎packages/feedback/tsconfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@
1313
"react-dom": ["./node_modules/preact/compat/"]
1414
}
1515
},
16-
"include": ["src/**/*.ts","src/**/*.tsx"]
16+
"include": ["src/**/*.ts", "src/**/*.tsx"]
1717
}

‎packages/feedback/tsconfig.test.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
22
"extends": "./tsconfig.json",
33

4-
"include": ["test/**/*.ts", "jest.config.ts", "jest.setup.ts"],
4+
"include": ["test/**/*.ts", "vite.config.ts"],
55

66
"compilerOptions": {
7-
"types": ["node", "jest"],
7+
"types": ["node"],
88
"esModuleInterop": true,
99
"allowJs": true,
1010
"noImplicitAny": true,

‎packages/feedback/vite.config.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
import { defineConfig } from 'vitest/config';
2+
3+
import baseConfig from '../../vite/vite.config';
4+
5+
export default defineConfig({
6+
...baseConfig,
7+
test: {
8+
...baseConfig.test,
9+
},
10+
});

0 commit comments

Comments
 (0)