test(gatsby): Migrate to vitest#15494

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
AbhiPrasad merged 1 commit into from
Feb 25, 2025
Merged

test(gatsby): Migrate to vitest #15494

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
2 changes: 1 addition & 1 deletion packages/gatsby/.eslintrc.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@ module.exports = {
jsx: true,
},
// ignore these because they're not covered by a `tsconfig`, which makes eslint throw an error
ignorePatterns: ['gatsby-node.d.ts'],
ignorePatterns: ['gatsby-node.d.ts', 'setup/globalSetup.ts'],
overrides: [
{
files: ['scripts/**/*.ts'],
Expand Down
4 changes: 2 additions & 2 deletions packages/gatsby/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,8 +75,8 @@
"clean": "rimraf build coverage *.d.ts sentry-gatsby-*.tgz",
"fix": "eslint . --format stylish --fix",
"lint": "eslint . --format stylish",
"test": "yarn ts-node scripts/pretest.ts && yarn jest",
"test:watch": "yarn ts-node scripts/pretest.ts && yarn jest --watch",
"test": "vitest run",
"test:watch": "vitest --watch",
"yalc:publish": "yalc publish --push --sig"
},
"volta": {
Expand Down
6 changes: 5 additions & 1 deletion packages/gatsby/scripts/pretest.ts → packages/gatsby/setup/globalSetup.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,4 +11,8 @@ function ensurePluginTypes(): void {
}
}

ensurePluginTypes();
import type { GlobalSetupContext } from 'vitest/node';

export default function setup(_: GlobalSetupContext) {
ensurePluginTypes();
}
54 changes: 36 additions & 18 deletions packages/gatsby/test/gatsby-node.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
import { sentryWebpackPlugin } from '@sentry/webpack-plugin';
import { onCreateWebpackConfig } from '../gatsby-node';
import { describe, afterAll, afterEach, beforeEach, beforeAll, vi, it, expect } from 'vitest';

vi.hoisted(
() =>
void mock('@sentry/webpack-plugin', {
sentryWebpackPlugin: vi.fn().mockReturnValue({}),
}),
);

// Need to override mock because `gatsby-node.js` loads `@sentry/webpack-plugin` as a CJS file.
async function mock(mockedUri: string, stub: any) {
const { Module } = await import('module');

// @ts-expect-error test
Module._load_original = Module._load;
// @ts-expect-error test
Module._load = (uri, parent) => {
if (uri === mockedUri) return stub;
// @ts-expect-error test
return Module._load_original(uri, parent);
};
}

jest.mock('@sentry/webpack-plugin', () => ({
sentryWebpackPlugin: jest.fn().mockReturnValue({
apply: jest.fn(),
}),
}));
import { onCreateWebpackConfig } from '../gatsby-node';

describe('onCreateWebpackConfig', () => {
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { sentryWebpackPlugin } = require('@sentry/webpack-plugin');
let originalNodeEnv: string | undefined;

beforeAll(() => {
Expand All@@ -20,15 +38,15 @@ describe('onCreateWebpackConfig', () => {
});

afterEach(() => {
jest.clearAllMocks();
vi.clearAllMocks();
});

it('sets a webpack config', () => {
const actions = {
setWebpackConfig: jest.fn(),
setWebpackConfig: vi.fn(),
};

const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

onCreateWebpackConfig({ actions, getConfig }, {});

Expand All@@ -38,10 +56,10 @@ describe('onCreateWebpackConfig', () => {

it('does not set a webpack config if enableClientWebpackPlugin is false', () => {
const actions = {
setWebpackConfig: jest.fn(),
setWebpackConfig: vi.fn(),
};

const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

onCreateWebpackConfig({ actions, getConfig }, { enableClientWebpackPlugin: false });

Expand All@@ -50,21 +68,21 @@ describe('onCreateWebpackConfig', () => {

describe('delete source maps after upload', () => {
beforeEach(() => {
jest.clearAllMocks();
vi.clearAllMocks();
});

const actions = {
setWebpackConfig: jest.fn(),
setWebpackConfig: vi.fn(),
};

const getConfig = jest.fn();
const getConfig = vi.fn();

it('sets sourceMapFilesToDeleteAfterUpload when provided in options', () => {
const actions = {
setWebpackConfig: jest.fn(),
setWebpackConfig: vi.fn(),
};

const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

onCreateWebpackConfig({ actions, getConfig }, { deleteSourcemapsAfterUpload: true });

Expand All@@ -79,7 +97,7 @@ describe('onCreateWebpackConfig', () => {
);
});

test.each([
it.each([
{
name: 'without provided options: sets hidden source maps and deletes source maps',
initialConfig: undefined,
Expand Down
2 changes: 2 additions & 0 deletions packages/gatsby/test/index.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
import { describe, it, expect } from 'vitest';

import * as GatsbyIntegration from '../src/index';

describe('package', () => {
Expand Down
17 changes: 10 additions & 7 deletions packages/gatsby/test/sdk.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
import type { Mock } from 'vitest';
import { describe, afterEach, expect, vi, test } from 'vitest';

import { SDK_VERSION, init } from '@sentry/react';

import { init as gatsbyInit } from '../src/sdk';

jest.mock('@sentry/react', () => {
const actual = jest.requireActual('@sentry/react');
vi.mock('@sentry/react', async requiredActual => {
const actual = (await requiredActual()) as any;
return {
...actual,
init: jest.fn().mockImplementation(actual.init),
init: vi.fn().mockImplementation(actual.init),
};
});

const reactInit = init as jest.Mock;
const reactInit = init as Mock;

describe('Initialize React SDK', () => {
afterEach(() => reactInit.mockReset());

test('Has correct SDK metadata', () => {
gatsbyInit({});
const calledWith = reactInit.mock.calls[0][0];
const calledWith = reactInit.mock.calls[0]?.[0];
const sdkMetadata = calledWith._metadata.sdk;
expect(sdkMetadata.name).toStrictEqual('sentry.javascript.gatsby');
expect(sdkMetadata.version).toBe(SDK_VERSION);
Expand All@@ -31,7 +34,7 @@ describe('Initialize React SDK', () => {
test('not defined by default', () => {
gatsbyInit({});
expect(reactInit).toHaveBeenCalledTimes(1);
const callingObject = reactInit.mock.calls[0][0];
const callingObject = reactInit.mock.calls[0]?.[0];
expect(callingObject.environment).not.toBeDefined();
});

Expand All@@ -40,7 +43,7 @@ describe('Initialize React SDK', () => {
environment: 'custom env!',
});
expect(reactInit).toHaveBeenCalledTimes(1);
const callingObject = reactInit.mock.calls[0][0];
const callingObject = reactInit.mock.calls[0]?.[0];
expect(callingObject.environment).toStrictEqual('custom env!');
});
});
Expand Down
4 changes: 2 additions & 2 deletions packages/gatsby/tsconfig.test.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
{
"extends": "./tsconfig.json",

"include": ["test/**/*"],
"include": ["test/**/*", "vite.config.ts", "setup/**/*"],

"compilerOptions": {
// should include all types from `./tsconfig.json` plus types for all test frameworks used
"types": ["node", "jest"],
"types": ["node"],

// other package-specific, test-specific options

Expand Down
11 changes: 11 additions & 0 deletions packages/gatsby/vite.config.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
import { defineConfig } from 'vitest/config';

import baseConfig from '../../vite/vite.config';

export default defineConfig({
...baseConfig,
test: {
...baseConfig.test,
globalSetup: 'setup/globalSetup.ts',
},
});
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
test(gatsby): Migrate to vitest#15494

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

AbhiPrasad
merged 1 commit into

from

Feb 25, 2025
 Merged


test(gatsby): Migrate to vitest
#15494
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


2 changes: 1 addition & 1 deletion
packages/gatsby/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@ module.exports = {
 jsx: true,
 },
 // ignore these because they're not covered by a `tsconfig`, which makes eslint throw an error
 ignorePatterns: ['gatsby-node.d.ts'],
 ignorePatterns: ['gatsby-node.d.ts', 'setup/globalSetup.ts'],
 overrides: [
 {
 files: ['scripts/**/*.ts'],
Expand Down

4 changes: 2 additions & 2 deletions
packages/gatsby/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,8 +75,8 @@
 "clean": "rimraf build coverage *.d.ts sentry-gatsby-*.tgz",
 "fix": "eslint . --format stylish --fix",
 "lint": "eslint . --format stylish",
 "test": "yarn ts-node scripts/pretest.ts && yarn jest",
 "test:watch": "yarn ts-node scripts/pretest.ts && yarn jest --watch",
 "test": "vitest run",
 "test:watch": "vitest --watch",
 "yalc:publish": "yalc publish --push --sig"
 },
 "volta": {
Expand Down

6 changes: 5 additions & 1 deletion
packages/gatsby/scripts/pretest.ts → packages/gatsby/setup/globalSetup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,4 +11,8 @@ function ensurePluginTypes(): void {
 }
}

ensurePluginTypes();
import type { GlobalSetupContext } from 'vitest/node';

export default function setup(_: GlobalSetupContext) {
 ensurePluginTypes();
}

54 changes: 36 additions & 18 deletions
packages/gatsby/test/gatsby-node.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
import { sentryWebpackPlugin } from '@sentry/webpack-plugin';
import { onCreateWebpackConfig } from '../gatsby-node';
import { describe, afterAll, afterEach, beforeEach, beforeAll, vi, it, expect } from 'vitest';

vi.hoisted(
 () =>
 void mock('@sentry/webpack-plugin', {
 sentryWebpackPlugin: vi.fn().mockReturnValue({}),
 }),
);

// Need to override mock because `gatsby-node.js` loads `@sentry/webpack-plugin` as a CJS file.
async function mock(mockedUri: string, stub: any) {
 const { Module } = await import('module');

 // @ts-expect-error test
 Module._load_original = Module._load;
 // @ts-expect-error test
 Module._load = (uri, parent) => {
 if (uri === mockedUri) return stub;
 // @ts-expect-error test
 return Module._load_original(uri, parent);
 };
}

jest.mock('@sentry/webpack-plugin', () => ({
 sentryWebpackPlugin: jest.fn().mockReturnValue({
 apply: jest.fn(),
 }),
}));
import { onCreateWebpackConfig } from '../gatsby-node';

describe('onCreateWebpackConfig', () => {
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const { sentryWebpackPlugin } = require('@sentry/webpack-plugin');
 let originalNodeEnv: string | undefined;

 beforeAll(() => {
Expand All@@ -20,15 +38,15 @@ describe('onCreateWebpackConfig', () => {
 });

 afterEach(() => {
jest.clearAllMocks();
vi.clearAllMocks();
 });

 it('sets a webpack config', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, {});

Expand All@@ -38,10 +56,10 @@ describe('onCreateWebpackConfig', () => {

 it('does not set a webpack config if enableClientWebpackPlugin is false', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, { enableClientWebpackPlugin: false });

Expand All@@ -50,21 +68,21 @@ describe('onCreateWebpackConfig', () => {

 describe('delete source maps after upload', () => {
 beforeEach(() => {
jest.clearAllMocks();
vi.clearAllMocks();
 });

 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn();
 const getConfig = vi.fn();

 it('sets sourceMapFilesToDeleteAfterUpload when provided in options', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, { deleteSourcemapsAfterUpload: true });

Expand All@@ -79,7 +97,7 @@ describe('onCreateWebpackConfig', () => {
 );
 });

test.each([
it.each([
 {
 name: 'without provided options: sets hidden source maps and deletes source maps',
 initialConfig: undefined,
Expand Down

2 changes: 2 additions & 0 deletions
packages/gatsby/test/index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
import { describe, it, expect } from 'vitest';

import * as GatsbyIntegration from '../src/index';

describe('package', () => {
Expand Down

17 changes: 10 additions & 7 deletions
packages/gatsby/test/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
import type { Mock } from 'vitest';
import { describe, afterEach, expect, vi, test } from 'vitest';

import { SDK_VERSION, init } from '@sentry/react';

import { init as gatsbyInit } from '../src/sdk';

jest.mock('@sentry/react', () => {
 const actual = jest.requireActual('@sentry/react');
vi.mock('@sentry/react', async requiredActual => {
 const actual = (await requiredActual()) as any;
 return {
 ...actual,
 init: jest.fn().mockImplementation(actual.init),
 init: vi.fn().mockImplementation(actual.init),
 };
});

const reactInit = init as jest.Mock;
const reactInit = init as Mock;

describe('Initialize React SDK', () => {
 afterEach(() => reactInit.mockReset());

 test('Has correct SDK metadata', () => {
 gatsbyInit({});
 const calledWith = reactInit.mock.calls[0][0];
 const calledWith = reactInit.mock.calls[0]?.[0];
 const sdkMetadata = calledWith._metadata.sdk;
 expect(sdkMetadata.name).toStrictEqual('sentry.javascript.gatsby');
 expect(sdkMetadata.version).toBe(SDK_VERSION);
Expand All@@ -31,7 +34,7 @@ describe('Initialize React SDK', () => {
 test('not defined by default', () => {
 gatsbyInit({});
 expect(reactInit).toHaveBeenCalledTimes(1);
 const callingObject = reactInit.mock.calls[0][0];
 const callingObject = reactInit.mock.calls[0]?.[0];
 expect(callingObject.environment).not.toBeDefined();
 });

Expand All@@ -40,7 +43,7 @@ describe('Initialize React SDK', () => {
 environment: 'custom env!',
 });
 expect(reactInit).toHaveBeenCalledTimes(1);
 const callingObject = reactInit.mock.calls[0][0];
 const callingObject = reactInit.mock.calls[0]?.[0];
 expect(callingObject.environment).toStrictEqual('custom env!');
 });
 });
Expand Down

4 changes: 2 additions & 2 deletions
packages/gatsby/tsconfig.test.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
{
 "extends": "./tsconfig.json",

 "include": ["test/**/*"],
 "include": ["test/**/*", "vite.config.ts", "setup/**/*"],

 "compilerOptions": {
 // should include all types from `./tsconfig.json` plus types for all test frameworks used
 "types": ["node", "jest"],
 "types": ["node"],

 // other package-specific, test-specific options

Expand Down

11 changes: 11 additions & 0 deletions
packages/gatsby/vite.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
import { defineConfig } from 'vitest/config';

import baseConfig from '../../vite/vite.config';

export default defineConfig({
 ...baseConfig,
 test: {
 ...baseConfig.test,
 globalSetup: 'setup/globalSetup.ts',
 },
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
test(gatsby): Migrate to vitest#15494

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

AbhiPrasad
merged 1 commit into

from

Feb 25, 2025
 Merged


test(gatsby): Migrate to vitest
#15494
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


2 changes: 1 addition & 1 deletion
packages/gatsby/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@ module.exports = {
 jsx: true,
 },
 // ignore these because they're not covered by a `tsconfig`, which makes eslint throw an error
 ignorePatterns: ['gatsby-node.d.ts'],
 ignorePatterns: ['gatsby-node.d.ts', 'setup/globalSetup.ts'],
 overrides: [
 {
 files: ['scripts/**/*.ts'],
Expand Down

4 changes: 2 additions & 2 deletions
packages/gatsby/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,8 +75,8 @@
 "clean": "rimraf build coverage *.d.ts sentry-gatsby-*.tgz",
 "fix": "eslint . --format stylish --fix",
 "lint": "eslint . --format stylish",
 "test": "yarn ts-node scripts/pretest.ts && yarn jest",
 "test:watch": "yarn ts-node scripts/pretest.ts && yarn jest --watch",
 "test": "vitest run",
 "test:watch": "vitest --watch",
 "yalc:publish": "yalc publish --push --sig"
 },
 "volta": {
Expand Down

6 changes: 5 additions & 1 deletion
packages/gatsby/scripts/pretest.ts → packages/gatsby/setup/globalSetup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,4 +11,8 @@ function ensurePluginTypes(): void {
 }
}

ensurePluginTypes();
import type { GlobalSetupContext } from 'vitest/node';

export default function setup(_: GlobalSetupContext) {
 ensurePluginTypes();
}

54 changes: 36 additions & 18 deletions
packages/gatsby/test/gatsby-node.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
import { sentryWebpackPlugin } from '@sentry/webpack-plugin';
import { onCreateWebpackConfig } from '../gatsby-node';
import { describe, afterAll, afterEach, beforeEach, beforeAll, vi, it, expect } from 'vitest';

vi.hoisted(
 () =>
 void mock('@sentry/webpack-plugin', {
 sentryWebpackPlugin: vi.fn().mockReturnValue({}),
 }),
);

// Need to override mock because `gatsby-node.js` loads `@sentry/webpack-plugin` as a CJS file.
async function mock(mockedUri: string, stub: any) {
 const { Module } = await import('module');

 // @ts-expect-error test
 Module._load_original = Module._load;
 // @ts-expect-error test
 Module._load = (uri, parent) => {
 if (uri === mockedUri) return stub;
 // @ts-expect-error test
 return Module._load_original(uri, parent);
 };
}

jest.mock('@sentry/webpack-plugin', () => ({
 sentryWebpackPlugin: jest.fn().mockReturnValue({
 apply: jest.fn(),
 }),
}));
import { onCreateWebpackConfig } from '../gatsby-node';

describe('onCreateWebpackConfig', () => {
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const { sentryWebpackPlugin } = require('@sentry/webpack-plugin');
 let originalNodeEnv: string | undefined;

 beforeAll(() => {
Expand All@@ -20,15 +38,15 @@ describe('onCreateWebpackConfig', () => {
 });

 afterEach(() => {
jest.clearAllMocks();
vi.clearAllMocks();
 });

 it('sets a webpack config', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, {});

Expand All@@ -38,10 +56,10 @@ describe('onCreateWebpackConfig', () => {

 it('does not set a webpack config if enableClientWebpackPlugin is false', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, { enableClientWebpackPlugin: false });

Expand All@@ -50,21 +68,21 @@ describe('onCreateWebpackConfig', () => {

 describe('delete source maps after upload', () => {
 beforeEach(() => {
jest.clearAllMocks();
vi.clearAllMocks();
 });

 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn();
 const getConfig = vi.fn();

 it('sets sourceMapFilesToDeleteAfterUpload when provided in options', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, { deleteSourcemapsAfterUpload: true });

Expand All@@ -79,7 +97,7 @@ describe('onCreateWebpackConfig', () => {
 );
 });

test.each([
it.each([
 {
 name: 'without provided options: sets hidden source maps and deletes source maps',
 initialConfig: undefined,
Expand Down

2 changes: 2 additions & 0 deletions
packages/gatsby/test/index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
import { describe, it, expect } from 'vitest';

import * as GatsbyIntegration from '../src/index';

describe('package', () => {
Expand Down

17 changes: 10 additions & 7 deletions
packages/gatsby/test/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
import type { Mock } from 'vitest';
import { describe, afterEach, expect, vi, test } from 'vitest';

import { SDK_VERSION, init } from '@sentry/react';

import { init as gatsbyInit } from '../src/sdk';

jest.mock('@sentry/react', () => {
 const actual = jest.requireActual('@sentry/react');
vi.mock('@sentry/react', async requiredActual => {
 const actual = (await requiredActual()) as any;
 return {
 ...actual,
 init: jest.fn().mockImplementation(actual.init),
 init: vi.fn().mockImplementation(actual.init),
 };
});

const reactInit = init as jest.Mock;
const reactInit = init as Mock;

describe('Initialize React SDK', () => {
 afterEach(() => reactInit.mockReset());

 test('Has correct SDK metadata', () => {
 gatsbyInit({});
 const calledWith = reactInit.mock.calls[0][0];
 const calledWith = reactInit.mock.calls[0]?.[0];
 const sdkMetadata = calledWith._metadata.sdk;
 expect(sdkMetadata.name).toStrictEqual('sentry.javascript.gatsby');
 expect(sdkMetadata.version).toBe(SDK_VERSION);
Expand All@@ -31,7 +34,7 @@ describe('Initialize React SDK', () => {
 test('not defined by default', () => {
 gatsbyInit({});
 expect(reactInit).toHaveBeenCalledTimes(1);
 const callingObject = reactInit.mock.calls[0][0];
 const callingObject = reactInit.mock.calls[0]?.[0];
 expect(callingObject.environment).not.toBeDefined();
 });

Expand All@@ -40,7 +43,7 @@ describe('Initialize React SDK', () => {
 environment: 'custom env!',
 });
 expect(reactInit).toHaveBeenCalledTimes(1);
 const callingObject = reactInit.mock.calls[0][0];
 const callingObject = reactInit.mock.calls[0]?.[0];
 expect(callingObject.environment).toStrictEqual('custom env!');
 });
 });
Expand Down

4 changes: 2 additions & 2 deletions
packages/gatsby/tsconfig.test.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
{
 "extends": "./tsconfig.json",

 "include": ["test/**/*"],
 "include": ["test/**/*", "vite.config.ts", "setup/**/*"],

 "compilerOptions": {
 // should include all types from `./tsconfig.json` plus types for all test frameworks used
 "types": ["node", "jest"],
 "types": ["node"],

 // other package-specific, test-specific options

Expand Down

11 changes: 11 additions & 0 deletions
packages/gatsby/vite.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
import { defineConfig } from 'vitest/config';

import baseConfig from '../../vite/vite.config';

export default defineConfig({
 ...baseConfig,
 test: {
 ...baseConfig.test,
 globalSetup: 'setup/globalSetup.ts',
 },
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
test(gatsby): Migrate to vitest#15494

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

AbhiPrasad
merged 1 commit into

from

Feb 25, 2025
 Merged


test(gatsby): Migrate to vitest
#15494
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


2 changes: 1 addition & 1 deletion
packages/gatsby/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@ module.exports = {
 jsx: true,
 },
 // ignore these because they're not covered by a `tsconfig`, which makes eslint throw an error
 ignorePatterns: ['gatsby-node.d.ts'],
 ignorePatterns: ['gatsby-node.d.ts', 'setup/globalSetup.ts'],
 overrides: [
 {
 files: ['scripts/**/*.ts'],
Expand Down

4 changes: 2 additions & 2 deletions
packages/gatsby/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,8 +75,8 @@
 "clean": "rimraf build coverage *.d.ts sentry-gatsby-*.tgz",
 "fix": "eslint . --format stylish --fix",
 "lint": "eslint . --format stylish",
 "test": "yarn ts-node scripts/pretest.ts && yarn jest",
 "test:watch": "yarn ts-node scripts/pretest.ts && yarn jest --watch",
 "test": "vitest run",
 "test:watch": "vitest --watch",
 "yalc:publish": "yalc publish --push --sig"
 },
 "volta": {
Expand Down

6 changes: 5 additions & 1 deletion
packages/gatsby/scripts/pretest.ts → packages/gatsby/setup/globalSetup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,4 +11,8 @@ function ensurePluginTypes(): void {
 }
}

ensurePluginTypes();
import type { GlobalSetupContext } from 'vitest/node';

export default function setup(_: GlobalSetupContext) {
 ensurePluginTypes();
}

54 changes: 36 additions & 18 deletions
packages/gatsby/test/gatsby-node.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
import { sentryWebpackPlugin } from '@sentry/webpack-plugin';
import { onCreateWebpackConfig } from '../gatsby-node';
import { describe, afterAll, afterEach, beforeEach, beforeAll, vi, it, expect } from 'vitest';

vi.hoisted(
 () =>
 void mock('@sentry/webpack-plugin', {
 sentryWebpackPlugin: vi.fn().mockReturnValue({}),
 }),
);

// Need to override mock because `gatsby-node.js` loads `@sentry/webpack-plugin` as a CJS file.
async function mock(mockedUri: string, stub: any) {
 const { Module } = await import('module');

 // @ts-expect-error test
 Module._load_original = Module._load;
 // @ts-expect-error test
 Module._load = (uri, parent) => {
 if (uri === mockedUri) return stub;
 // @ts-expect-error test
 return Module._load_original(uri, parent);
 };
}

jest.mock('@sentry/webpack-plugin', () => ({
 sentryWebpackPlugin: jest.fn().mockReturnValue({
 apply: jest.fn(),
 }),
}));
import { onCreateWebpackConfig } from '../gatsby-node';

describe('onCreateWebpackConfig', () => {
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const { sentryWebpackPlugin } = require('@sentry/webpack-plugin');
 let originalNodeEnv: string | undefined;

 beforeAll(() => {
Expand All@@ -20,15 +38,15 @@ describe('onCreateWebpackConfig', () => {
 });

 afterEach(() => {
jest.clearAllMocks();
vi.clearAllMocks();
 });

 it('sets a webpack config', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, {});

Expand All@@ -38,10 +56,10 @@ describe('onCreateWebpackConfig', () => {

 it('does not set a webpack config if enableClientWebpackPlugin is false', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, { enableClientWebpackPlugin: false });

Expand All@@ -50,21 +68,21 @@ describe('onCreateWebpackConfig', () => {

 describe('delete source maps after upload', () => {
 beforeEach(() => {
jest.clearAllMocks();
vi.clearAllMocks();
 });

 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn();
 const getConfig = vi.fn();

 it('sets sourceMapFilesToDeleteAfterUpload when provided in options', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, { deleteSourcemapsAfterUpload: true });

Expand All@@ -79,7 +97,7 @@ describe('onCreateWebpackConfig', () => {
 );
 });

test.each([
it.each([
 {
 name: 'without provided options: sets hidden source maps and deletes source maps',
 initialConfig: undefined,
Expand Down

2 changes: 2 additions & 0 deletions
packages/gatsby/test/index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
import { describe, it, expect } from 'vitest';

import * as GatsbyIntegration from '../src/index';

describe('package', () => {
Expand Down

17 changes: 10 additions & 7 deletions
packages/gatsby/test/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
import type { Mock } from 'vitest';
import { describe, afterEach, expect, vi, test } from 'vitest';

import { SDK_VERSION, init } from '@sentry/react';

import { init as gatsbyInit } from '../src/sdk';

jest.mock('@sentry/react', () => {
 const actual = jest.requireActual('@sentry/react');
vi.mock('@sentry/react', async requiredActual => {
 const actual = (await requiredActual()) as any;
 return {
 ...actual,
 init: jest.fn().mockImplementation(actual.init),
 init: vi.fn().mockImplementation(actual.init),
 };
});

const reactInit = init as jest.Mock;
const reactInit = init as Mock;

describe('Initialize React SDK', () => {
 afterEach(() => reactInit.mockReset());

 test('Has correct SDK metadata', () => {
 gatsbyInit({});
 const calledWith = reactInit.mock.calls[0][0];
 const calledWith = reactInit.mock.calls[0]?.[0];
 const sdkMetadata = calledWith._metadata.sdk;
 expect(sdkMetadata.name).toStrictEqual('sentry.javascript.gatsby');
 expect(sdkMetadata.version).toBe(SDK_VERSION);
Expand All@@ -31,7 +34,7 @@ describe('Initialize React SDK', () => {
 test('not defined by default', () => {
 gatsbyInit({});
 expect(reactInit).toHaveBeenCalledTimes(1);
 const callingObject = reactInit.mock.calls[0][0];
 const callingObject = reactInit.mock.calls[0]?.[0];
 expect(callingObject.environment).not.toBeDefined();
 });

Expand All@@ -40,7 +43,7 @@ describe('Initialize React SDK', () => {
 environment: 'custom env!',
 });
 expect(reactInit).toHaveBeenCalledTimes(1);
 const callingObject = reactInit.mock.calls[0][0];
 const callingObject = reactInit.mock.calls[0]?.[0];
 expect(callingObject.environment).toStrictEqual('custom env!');
 });
 });
Expand Down

4 changes: 2 additions & 2 deletions
packages/gatsby/tsconfig.test.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
{
 "extends": "./tsconfig.json",

 "include": ["test/**/*"],
 "include": ["test/**/*", "vite.config.ts", "setup/**/*"],

 "compilerOptions": {
 // should include all types from `./tsconfig.json` plus types for all test frameworks used
 "types": ["node", "jest"],
 "types": ["node"],

 // other package-specific, test-specific options

Expand Down

11 changes: 11 additions & 0 deletions
packages/gatsby/vite.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
import { defineConfig } from 'vitest/config';

import baseConfig from '../../vite/vite.config';

export default defineConfig({
 ...baseConfig,
 test: {
 ...baseConfig.test,
 globalSetup: 'setup/globalSetup.ts',
 },
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
test(gatsby): Migrate to vitest#15494

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

AbhiPrasad
merged 1 commit into

from

Feb 25, 2025
 Merged


test(gatsby): Migrate to vitest
#15494
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


2 changes: 1 addition & 1 deletion
packages/gatsby/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@ module.exports = {
 jsx: true,
 },
 // ignore these because they're not covered by a `tsconfig`, which makes eslint throw an error
 ignorePatterns: ['gatsby-node.d.ts'],
 ignorePatterns: ['gatsby-node.d.ts', 'setup/globalSetup.ts'],
 overrides: [
 {
 files: ['scripts/**/*.ts'],
Expand Down

4 changes: 2 additions & 2 deletions
packages/gatsby/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,8 +75,8 @@
 "clean": "rimraf build coverage *.d.ts sentry-gatsby-*.tgz",
 "fix": "eslint . --format stylish --fix",
 "lint": "eslint . --format stylish",
 "test": "yarn ts-node scripts/pretest.ts && yarn jest",
 "test:watch": "yarn ts-node scripts/pretest.ts && yarn jest --watch",
 "test": "vitest run",
 "test:watch": "vitest --watch",
 "yalc:publish": "yalc publish --push --sig"
 },
 "volta": {
Expand Down

6 changes: 5 additions & 1 deletion
packages/gatsby/scripts/pretest.ts → packages/gatsby/setup/globalSetup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,4 +11,8 @@ function ensurePluginTypes(): void {
 }
}

ensurePluginTypes();
import type { GlobalSetupContext } from 'vitest/node';

export default function setup(_: GlobalSetupContext) {
 ensurePluginTypes();
}

54 changes: 36 additions & 18 deletions
packages/gatsby/test/gatsby-node.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
import { sentryWebpackPlugin } from '@sentry/webpack-plugin';
import { onCreateWebpackConfig } from '../gatsby-node';
import { describe, afterAll, afterEach, beforeEach, beforeAll, vi, it, expect } from 'vitest';

vi.hoisted(
 () =>
 void mock('@sentry/webpack-plugin', {
 sentryWebpackPlugin: vi.fn().mockReturnValue({}),
 }),
);

// Need to override mock because `gatsby-node.js` loads `@sentry/webpack-plugin` as a CJS file.
async function mock(mockedUri: string, stub: any) {
 const { Module } = await import('module');

 // @ts-expect-error test
 Module._load_original = Module._load;
 // @ts-expect-error test
 Module._load = (uri, parent) => {
 if (uri === mockedUri) return stub;
 // @ts-expect-error test
 return Module._load_original(uri, parent);
 };
}

jest.mock('@sentry/webpack-plugin', () => ({
 sentryWebpackPlugin: jest.fn().mockReturnValue({
 apply: jest.fn(),
 }),
}));
import { onCreateWebpackConfig } from '../gatsby-node';

describe('onCreateWebpackConfig', () => {
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const { sentryWebpackPlugin } = require('@sentry/webpack-plugin');
 let originalNodeEnv: string | undefined;

 beforeAll(() => {
Expand All@@ -20,15 +38,15 @@ describe('onCreateWebpackConfig', () => {
 });

 afterEach(() => {
jest.clearAllMocks();
vi.clearAllMocks();
 });

 it('sets a webpack config', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, {});

Expand All@@ -38,10 +56,10 @@ describe('onCreateWebpackConfig', () => {

 it('does not set a webpack config if enableClientWebpackPlugin is false', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, { enableClientWebpackPlugin: false });

Expand All@@ -50,21 +68,21 @@ describe('onCreateWebpackConfig', () => {

 describe('delete source maps after upload', () => {
 beforeEach(() => {
jest.clearAllMocks();
vi.clearAllMocks();
 });

 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn();
 const getConfig = vi.fn();

 it('sets sourceMapFilesToDeleteAfterUpload when provided in options', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, { deleteSourcemapsAfterUpload: true });

Expand All@@ -79,7 +97,7 @@ describe('onCreateWebpackConfig', () => {
 );
 });

test.each([
it.each([
 {
 name: 'without provided options: sets hidden source maps and deletes source maps',
 initialConfig: undefined,
Expand Down

2 changes: 2 additions & 0 deletions
packages/gatsby/test/index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
import { describe, it, expect } from 'vitest';

import * as GatsbyIntegration from '../src/index';

describe('package', () => {
Expand Down

17 changes: 10 additions & 7 deletions
packages/gatsby/test/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
import type { Mock } from 'vitest';
import { describe, afterEach, expect, vi, test } from 'vitest';

import { SDK_VERSION, init } from '@sentry/react';

import { init as gatsbyInit } from '../src/sdk';

jest.mock('@sentry/react', () => {
 const actual = jest.requireActual('@sentry/react');
vi.mock('@sentry/react', async requiredActual => {
 const actual = (await requiredActual()) as any;
 return {
 ...actual,
 init: jest.fn().mockImplementation(actual.init),
 init: vi.fn().mockImplementation(actual.init),
 };
});

const reactInit = init as jest.Mock;
const reactInit = init as Mock;

describe('Initialize React SDK', () => {
 afterEach(() => reactInit.mockReset());

 test('Has correct SDK metadata', () => {
 gatsbyInit({});
 const calledWith = reactInit.mock.calls[0][0];
 const calledWith = reactInit.mock.calls[0]?.[0];
 const sdkMetadata = calledWith._metadata.sdk;
 expect(sdkMetadata.name).toStrictEqual('sentry.javascript.gatsby');
 expect(sdkMetadata.version).toBe(SDK_VERSION);
Expand All@@ -31,7 +34,7 @@ describe('Initialize React SDK', () => {
 test('not defined by default', () => {
 gatsbyInit({});
 expect(reactInit).toHaveBeenCalledTimes(1);
 const callingObject = reactInit.mock.calls[0][0];
 const callingObject = reactInit.mock.calls[0]?.[0];
 expect(callingObject.environment).not.toBeDefined();
 });

Expand All@@ -40,7 +43,7 @@ describe('Initialize React SDK', () => {
 environment: 'custom env!',
 });
 expect(reactInit).toHaveBeenCalledTimes(1);
 const callingObject = reactInit.mock.calls[0][0];
 const callingObject = reactInit.mock.calls[0]?.[0];
 expect(callingObject.environment).toStrictEqual('custom env!');
 });
 });
Expand Down

4 changes: 2 additions & 2 deletions
packages/gatsby/tsconfig.test.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
{
 "extends": "./tsconfig.json",

 "include": ["test/**/*"],
 "include": ["test/**/*", "vite.config.ts", "setup/**/*"],

 "compilerOptions": {
 // should include all types from `./tsconfig.json` plus types for all test frameworks used
 "types": ["node", "jest"],
 "types": ["node"],

 // other package-specific, test-specific options

Expand Down

11 changes: 11 additions & 0 deletions
packages/gatsby/vite.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
import { defineConfig } from 'vitest/config';

import baseConfig from '../../vite/vite.config';

export default defineConfig({
 ...baseConfig,
 test: {
 ...baseConfig.test,
 globalSetup: 'setup/globalSetup.ts',
 },
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
test(gatsby): Migrate to vitest#15494

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

AbhiPrasad
merged 1 commit into

from

Feb 25, 2025
 Merged


test(gatsby): Migrate to vitest
#15494
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


2 changes: 1 addition & 1 deletion
packages/gatsby/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@ module.exports = {
 jsx: true,
 },
 // ignore these because they're not covered by a `tsconfig`, which makes eslint throw an error
 ignorePatterns: ['gatsby-node.d.ts'],
 ignorePatterns: ['gatsby-node.d.ts', 'setup/globalSetup.ts'],
 overrides: [
 {
 files: ['scripts/**/*.ts'],
Expand Down

4 changes: 2 additions & 2 deletions
packages/gatsby/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,8 +75,8 @@
 "clean": "rimraf build coverage *.d.ts sentry-gatsby-*.tgz",
 "fix": "eslint . --format stylish --fix",
 "lint": "eslint . --format stylish",
 "test": "yarn ts-node scripts/pretest.ts && yarn jest",
 "test:watch": "yarn ts-node scripts/pretest.ts && yarn jest --watch",
 "test": "vitest run",
 "test:watch": "vitest --watch",
 "yalc:publish": "yalc publish --push --sig"
 },
 "volta": {
Expand Down

6 changes: 5 additions & 1 deletion
packages/gatsby/scripts/pretest.ts → packages/gatsby/setup/globalSetup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,4 +11,8 @@ function ensurePluginTypes(): void {
 }
}

ensurePluginTypes();
import type { GlobalSetupContext } from 'vitest/node';

export default function setup(_: GlobalSetupContext) {
 ensurePluginTypes();
}

54 changes: 36 additions & 18 deletions
packages/gatsby/test/gatsby-node.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
import { sentryWebpackPlugin } from '@sentry/webpack-plugin';
import { onCreateWebpackConfig } from '../gatsby-node';
import { describe, afterAll, afterEach, beforeEach, beforeAll, vi, it, expect } from 'vitest';

vi.hoisted(
 () =>
 void mock('@sentry/webpack-plugin', {
 sentryWebpackPlugin: vi.fn().mockReturnValue({}),
 }),
);

// Need to override mock because `gatsby-node.js` loads `@sentry/webpack-plugin` as a CJS file.
async function mock(mockedUri: string, stub: any) {
 const { Module } = await import('module');

 // @ts-expect-error test
 Module._load_original = Module._load;
 // @ts-expect-error test
 Module._load = (uri, parent) => {
 if (uri === mockedUri) return stub;
 // @ts-expect-error test
 return Module._load_original(uri, parent);
 };
}

jest.mock('@sentry/webpack-plugin', () => ({
 sentryWebpackPlugin: jest.fn().mockReturnValue({
 apply: jest.fn(),
 }),
}));
import { onCreateWebpackConfig } from '../gatsby-node';

describe('onCreateWebpackConfig', () => {
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const { sentryWebpackPlugin } = require('@sentry/webpack-plugin');
 let originalNodeEnv: string | undefined;

 beforeAll(() => {
Expand All@@ -20,15 +38,15 @@ describe('onCreateWebpackConfig', () => {
 });

 afterEach(() => {
jest.clearAllMocks();
vi.clearAllMocks();
 });

 it('sets a webpack config', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, {});

Expand All@@ -38,10 +56,10 @@ describe('onCreateWebpackConfig', () => {

 it('does not set a webpack config if enableClientWebpackPlugin is false', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, { enableClientWebpackPlugin: false });

Expand All@@ -50,21 +68,21 @@ describe('onCreateWebpackConfig', () => {

 describe('delete source maps after upload', () => {
 beforeEach(() => {
jest.clearAllMocks();
vi.clearAllMocks();
 });

 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn();
 const getConfig = vi.fn();

 it('sets sourceMapFilesToDeleteAfterUpload when provided in options', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, { deleteSourcemapsAfterUpload: true });

Expand All@@ -79,7 +97,7 @@ describe('onCreateWebpackConfig', () => {
 );
 });

test.each([
it.each([
 {
 name: 'without provided options: sets hidden source maps and deletes source maps',
 initialConfig: undefined,
Expand Down

2 changes: 2 additions & 0 deletions
packages/gatsby/test/index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
import { describe, it, expect } from 'vitest';

import * as GatsbyIntegration from '../src/index';

describe('package', () => {
Expand Down

17 changes: 10 additions & 7 deletions
packages/gatsby/test/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
import type { Mock } from 'vitest';
import { describe, afterEach, expect, vi, test } from 'vitest';

import { SDK_VERSION, init } from '@sentry/react';

import { init as gatsbyInit } from '../src/sdk';

jest.mock('@sentry/react', () => {
 const actual = jest.requireActual('@sentry/react');
vi.mock('@sentry/react', async requiredActual => {
 const actual = (await requiredActual()) as any;
 return {
 ...actual,
 init: jest.fn().mockImplementation(actual.init),
 init: vi.fn().mockImplementation(actual.init),
 };
});

const reactInit = init as jest.Mock;
const reactInit = init as Mock;

describe('Initialize React SDK', () => {
 afterEach(() => reactInit.mockReset());

 test('Has correct SDK metadata', () => {
 gatsbyInit({});
 const calledWith = reactInit.mock.calls[0][0];
 const calledWith = reactInit.mock.calls[0]?.[0];
 const sdkMetadata = calledWith._metadata.sdk;
 expect(sdkMetadata.name).toStrictEqual('sentry.javascript.gatsby');
 expect(sdkMetadata.version).toBe(SDK_VERSION);
Expand All@@ -31,7 +34,7 @@ describe('Initialize React SDK', () => {
 test('not defined by default', () => {
 gatsbyInit({});
 expect(reactInit).toHaveBeenCalledTimes(1);
 const callingObject = reactInit.mock.calls[0][0];
 const callingObject = reactInit.mock.calls[0]?.[0];
 expect(callingObject.environment).not.toBeDefined();
 });

Expand All@@ -40,7 +43,7 @@ describe('Initialize React SDK', () => {
 environment: 'custom env!',
 });
 expect(reactInit).toHaveBeenCalledTimes(1);
 const callingObject = reactInit.mock.calls[0][0];
 const callingObject = reactInit.mock.calls[0]?.[0];
 expect(callingObject.environment).toStrictEqual('custom env!');
 });
 });
Expand Down

4 changes: 2 additions & 2 deletions
packages/gatsby/tsconfig.test.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
{
 "extends": "./tsconfig.json",

 "include": ["test/**/*"],
 "include": ["test/**/*", "vite.config.ts", "setup/**/*"],

 "compilerOptions": {
 // should include all types from `./tsconfig.json` plus types for all test frameworks used
 "types": ["node", "jest"],
 "types": ["node"],

 // other package-specific, test-specific options

Expand Down

11 changes: 11 additions & 0 deletions
packages/gatsby/vite.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
import { defineConfig } from 'vitest/config';

import baseConfig from '../../vite/vite.config';

export default defineConfig({
 ...baseConfig,
 test: {
 ...baseConfig.test,
 globalSetup: 'setup/globalSetup.ts',
 },
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
test(gatsby): Migrate to vitest#15494

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

AbhiPrasad
merged 1 commit into

from

Feb 25, 2025
 Merged


test(gatsby): Migrate to vitest
#15494
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


2 changes: 1 addition & 1 deletion
packages/gatsby/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@ module.exports = {
 jsx: true,
 },
 // ignore these because they're not covered by a `tsconfig`, which makes eslint throw an error
 ignorePatterns: ['gatsby-node.d.ts'],
 ignorePatterns: ['gatsby-node.d.ts', 'setup/globalSetup.ts'],
 overrides: [
 {
 files: ['scripts/**/*.ts'],
Expand Down

4 changes: 2 additions & 2 deletions
packages/gatsby/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,8 +75,8 @@
 "clean": "rimraf build coverage *.d.ts sentry-gatsby-*.tgz",
 "fix": "eslint . --format stylish --fix",
 "lint": "eslint . --format stylish",
 "test": "yarn ts-node scripts/pretest.ts && yarn jest",
 "test:watch": "yarn ts-node scripts/pretest.ts && yarn jest --watch",
 "test": "vitest run",
 "test:watch": "vitest --watch",
 "yalc:publish": "yalc publish --push --sig"
 },
 "volta": {
Expand Down

6 changes: 5 additions & 1 deletion
packages/gatsby/scripts/pretest.ts → packages/gatsby/setup/globalSetup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,4 +11,8 @@ function ensurePluginTypes(): void {
 }
}

ensurePluginTypes();
import type { GlobalSetupContext } from 'vitest/node';

export default function setup(_: GlobalSetupContext) {
 ensurePluginTypes();
}

54 changes: 36 additions & 18 deletions
packages/gatsby/test/gatsby-node.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
import { sentryWebpackPlugin } from '@sentry/webpack-plugin';
import { onCreateWebpackConfig } from '../gatsby-node';
import { describe, afterAll, afterEach, beforeEach, beforeAll, vi, it, expect } from 'vitest';

vi.hoisted(
 () =>
 void mock('@sentry/webpack-plugin', {
 sentryWebpackPlugin: vi.fn().mockReturnValue({}),
 }),
);

// Need to override mock because `gatsby-node.js` loads `@sentry/webpack-plugin` as a CJS file.
async function mock(mockedUri: string, stub: any) {
 const { Module } = await import('module');

 // @ts-expect-error test
 Module._load_original = Module._load;
 // @ts-expect-error test
 Module._load = (uri, parent) => {
 if (uri === mockedUri) return stub;
 // @ts-expect-error test
 return Module._load_original(uri, parent);
 };
}

jest.mock('@sentry/webpack-plugin', () => ({
 sentryWebpackPlugin: jest.fn().mockReturnValue({
 apply: jest.fn(),
 }),
}));
import { onCreateWebpackConfig } from '../gatsby-node';

describe('onCreateWebpackConfig', () => {
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const { sentryWebpackPlugin } = require('@sentry/webpack-plugin');
 let originalNodeEnv: string | undefined;

 beforeAll(() => {
Expand All@@ -20,15 +38,15 @@ describe('onCreateWebpackConfig', () => {
 });

 afterEach(() => {
jest.clearAllMocks();
vi.clearAllMocks();
 });

 it('sets a webpack config', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, {});

Expand All@@ -38,10 +56,10 @@ describe('onCreateWebpackConfig', () => {

 it('does not set a webpack config if enableClientWebpackPlugin is false', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, { enableClientWebpackPlugin: false });

Expand All@@ -50,21 +68,21 @@ describe('onCreateWebpackConfig', () => {

 describe('delete source maps after upload', () => {
 beforeEach(() => {
jest.clearAllMocks();
vi.clearAllMocks();
 });

 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn();
 const getConfig = vi.fn();

 it('sets sourceMapFilesToDeleteAfterUpload when provided in options', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, { deleteSourcemapsAfterUpload: true });

Expand All@@ -79,7 +97,7 @@ describe('onCreateWebpackConfig', () => {
 );
 });

test.each([
it.each([
 {
 name: 'without provided options: sets hidden source maps and deletes source maps',
 initialConfig: undefined,
Expand Down

2 changes: 2 additions & 0 deletions
packages/gatsby/test/index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
import { describe, it, expect } from 'vitest';

import * as GatsbyIntegration from '../src/index';

describe('package', () => {
Expand Down

17 changes: 10 additions & 7 deletions
packages/gatsby/test/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
import type { Mock } from 'vitest';
import { describe, afterEach, expect, vi, test } from 'vitest';

import { SDK_VERSION, init } from '@sentry/react';

import { init as gatsbyInit } from '../src/sdk';

jest.mock('@sentry/react', () => {
 const actual = jest.requireActual('@sentry/react');
vi.mock('@sentry/react', async requiredActual => {
 const actual = (await requiredActual()) as any;
 return {
 ...actual,
 init: jest.fn().mockImplementation(actual.init),
 init: vi.fn().mockImplementation(actual.init),
 };
});

const reactInit = init as jest.Mock;
const reactInit = init as Mock;

describe('Initialize React SDK', () => {
 afterEach(() => reactInit.mockReset());

 test('Has correct SDK metadata', () => {
 gatsbyInit({});
 const calledWith = reactInit.mock.calls[0][0];
 const calledWith = reactInit.mock.calls[0]?.[0];
 const sdkMetadata = calledWith._metadata.sdk;
 expect(sdkMetadata.name).toStrictEqual('sentry.javascript.gatsby');
 expect(sdkMetadata.version).toBe(SDK_VERSION);
Expand All@@ -31,7 +34,7 @@ describe('Initialize React SDK', () => {
 test('not defined by default', () => {
 gatsbyInit({});
 expect(reactInit).toHaveBeenCalledTimes(1);
 const callingObject = reactInit.mock.calls[0][0];
 const callingObject = reactInit.mock.calls[0]?.[0];
 expect(callingObject.environment).not.toBeDefined();
 });

Expand All@@ -40,7 +43,7 @@ describe('Initialize React SDK', () => {
 environment: 'custom env!',
 });
 expect(reactInit).toHaveBeenCalledTimes(1);
 const callingObject = reactInit.mock.calls[0][0];
 const callingObject = reactInit.mock.calls[0]?.[0];
 expect(callingObject.environment).toStrictEqual('custom env!');
 });
 });
Expand Down

4 changes: 2 additions & 2 deletions
packages/gatsby/tsconfig.test.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
{
 "extends": "./tsconfig.json",

 "include": ["test/**/*"],
 "include": ["test/**/*", "vite.config.ts", "setup/**/*"],

 "compilerOptions": {
 // should include all types from `./tsconfig.json` plus types for all test frameworks used
 "types": ["node", "jest"],
 "types": ["node"],

 // other package-specific, test-specific options

Expand Down

11 changes: 11 additions & 0 deletions
packages/gatsby/vite.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
import { defineConfig } from 'vitest/config';

import baseConfig from '../../vite/vite.config';

export default defineConfig({
 ...baseConfig,
 test: {
 ...baseConfig.test,
 globalSetup: 'setup/globalSetup.ts',
 },
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
test(gatsby): Migrate to vitest#15494

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

AbhiPrasad
merged 1 commit into

from

Feb 25, 2025
 Merged


test(gatsby): Migrate to vitest
#15494
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


2 changes: 1 addition & 1 deletion
packages/gatsby/.eslintrc.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@ module.exports = {
 jsx: true,
 },
 // ignore these because they're not covered by a `tsconfig`, which makes eslint throw an error
 ignorePatterns: ['gatsby-node.d.ts'],
 ignorePatterns: ['gatsby-node.d.ts', 'setup/globalSetup.ts'],
 overrides: [
 {
 files: ['scripts/**/*.ts'],
Expand Down

4 changes: 2 additions & 2 deletions
packages/gatsby/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,8 +75,8 @@
 "clean": "rimraf build coverage *.d.ts sentry-gatsby-*.tgz",
 "fix": "eslint . --format stylish --fix",
 "lint": "eslint . --format stylish",
 "test": "yarn ts-node scripts/pretest.ts && yarn jest",
 "test:watch": "yarn ts-node scripts/pretest.ts && yarn jest --watch",
 "test": "vitest run",
 "test:watch": "vitest --watch",
 "yalc:publish": "yalc publish --push --sig"
 },
 "volta": {
Expand Down

6 changes: 5 additions & 1 deletion
packages/gatsby/scripts/pretest.ts → packages/gatsby/setup/globalSetup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,4 +11,8 @@ function ensurePluginTypes(): void {
 }
}

ensurePluginTypes();
import type { GlobalSetupContext } from 'vitest/node';

export default function setup(_: GlobalSetupContext) {
 ensurePluginTypes();
}

54 changes: 36 additions & 18 deletions
packages/gatsby/test/gatsby-node.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
import { sentryWebpackPlugin } from '@sentry/webpack-plugin';
import { onCreateWebpackConfig } from '../gatsby-node';
import { describe, afterAll, afterEach, beforeEach, beforeAll, vi, it, expect } from 'vitest';

vi.hoisted(
 () =>
 void mock('@sentry/webpack-plugin', {
 sentryWebpackPlugin: vi.fn().mockReturnValue({}),
 }),
);

// Need to override mock because `gatsby-node.js` loads `@sentry/webpack-plugin` as a CJS file.
async function mock(mockedUri: string, stub: any) {
 const { Module } = await import('module');

 // @ts-expect-error test
 Module._load_original = Module._load;
 // @ts-expect-error test
 Module._load = (uri, parent) => {
 if (uri === mockedUri) return stub;
 // @ts-expect-error test
 return Module._load_original(uri, parent);
 };
}

jest.mock('@sentry/webpack-plugin', () => ({
 sentryWebpackPlugin: jest.fn().mockReturnValue({
 apply: jest.fn(),
 }),
}));
import { onCreateWebpackConfig } from '../gatsby-node';

describe('onCreateWebpackConfig', () => {
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const { sentryWebpackPlugin } = require('@sentry/webpack-plugin');
 let originalNodeEnv: string | undefined;

 beforeAll(() => {
Expand All@@ -20,15 +38,15 @@ describe('onCreateWebpackConfig', () => {
 });

 afterEach(() => {
jest.clearAllMocks();
vi.clearAllMocks();
 });

 it('sets a webpack config', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, {});

Expand All@@ -38,10 +56,10 @@ describe('onCreateWebpackConfig', () => {

 it('does not set a webpack config if enableClientWebpackPlugin is false', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, { enableClientWebpackPlugin: false });

Expand All@@ -50,21 +68,21 @@ describe('onCreateWebpackConfig', () => {

 describe('delete source maps after upload', () => {
 beforeEach(() => {
jest.clearAllMocks();
vi.clearAllMocks();
 });

 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn();
 const getConfig = vi.fn();

 it('sets sourceMapFilesToDeleteAfterUpload when provided in options', () => {
 const actions = {
 setWebpackConfig: jest.fn(),
 setWebpackConfig: vi.fn(),
 };

 const getConfig = jest.fn().mockReturnValue({ devtool: 'source-map' });
 const getConfig = vi.fn().mockReturnValue({ devtool: 'source-map' });

 onCreateWebpackConfig({ actions, getConfig }, { deleteSourcemapsAfterUpload: true });

Expand All@@ -79,7 +97,7 @@ describe('onCreateWebpackConfig', () => {
 );
 });

test.each([
it.each([
 {
 name: 'without provided options: sets hidden source maps and deletes source maps',
 initialConfig: undefined,
Expand Down

2 changes: 2 additions & 0 deletions
packages/gatsby/test/index.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
import { describe, it, expect } from 'vitest';

import * as GatsbyIntegration from '../src/index';

describe('package', () => {
Expand Down

17 changes: 10 additions & 7 deletions
packages/gatsby/test/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
import type { Mock } from 'vitest';
import { describe, afterEach, expect, vi, test } from 'vitest';

import { SDK_VERSION, init } from '@sentry/react';

import { init as gatsbyInit } from '../src/sdk';

jest.mock('@sentry/react', () => {
 const actual = jest.requireActual('@sentry/react');
vi.mock('@sentry/react', async requiredActual => {
 const actual = (await requiredActual()) as any;
 return {
 ...actual,
 init: jest.fn().mockImplementation(actual.init),
 init: vi.fn().mockImplementation(actual.init),
 };
});

const reactInit = init as jest.Mock;
const reactInit = init as Mock;

describe('Initialize React SDK', () => {
 afterEach(() => reactInit.mockReset());

 test('Has correct SDK metadata', () => {
 gatsbyInit({});
 const calledWith = reactInit.mock.calls[0][0];
 const calledWith = reactInit.mock.calls[0]?.[0];
 const sdkMetadata = calledWith._metadata.sdk;
 expect(sdkMetadata.name).toStrictEqual('sentry.javascript.gatsby');
 expect(sdkMetadata.version).toBe(SDK_VERSION);
Expand All@@ -31,7 +34,7 @@ describe('Initialize React SDK', () => {
 test('not defined by default', () => {
 gatsbyInit({});
 expect(reactInit).toHaveBeenCalledTimes(1);
 const callingObject = reactInit.mock.calls[0][0];
 const callingObject = reactInit.mock.calls[0]?.[0];
 expect(callingObject.environment).not.toBeDefined();
 });

Expand All@@ -40,7 +43,7 @@ describe('Initialize React SDK', () => {
 environment: 'custom env!',
 });
 expect(reactInit).toHaveBeenCalledTimes(1);
 const callingObject = reactInit.mock.calls[0][0];
 const callingObject = reactInit.mock.calls[0]?.[0];
 expect(callingObject.environment).toStrictEqual('custom env!');
 });
 });
Expand Down

4 changes: 2 additions & 2 deletions
packages/gatsby/tsconfig.test.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
{
 "extends": "./tsconfig.json",

 "include": ["test/**/*"],
 "include": ["test/**/*", "vite.config.ts", "setup/**/*"],

 "compilerOptions": {
 // should include all types from `./tsconfig.json` plus types for all test frameworks used
 "types": ["node", "jest"],
 "types": ["node"],

 // other package-specific, test-specific options

Expand Down

11 changes: 11 additions & 0 deletions
packages/gatsby/vite.config.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
import { defineConfig } from 'vitest/config';

import baseConfig from '../../vite/vite.config';

export default defineConfig({
 ...baseConfig,
 test: {
 ...baseConfig.test,
 globalSetup: 'setup/globalSetup.ts',
 },
});