mocks.ts

// TODO: This mocking is why we have to use `--runInBand` when we run tests, since there's only a single temp directory
// created

import * as fs from 'fs';
import * as os from 'os';
import * as path from 'path';
import { vi, afterAll, afterEach } from 'vitest';

vi.mock('fs');
vi.mock('os');

import { CLIENT_SDK_CONFIG_FILE, EDGE_SDK_CONFIG_FILE, SERVER_SDK_CONFIG_FILE } from './fixtures';

// We use `fs.existsSync()` in `getUserConfigFile()`. When we're not testing `getUserConfigFile()` specifically, all we
// need is for it to give us any valid answer, so make it always find what it's looking for. Since this is a core node
// built-in, though, which jest itself uses, otherwise let it do the normal thing. Storing the real version of the
// function also lets us restore the original when we do want to test
// `getUserConfigFile()`.
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
const fsReal = (await vi.importActual('fs')) as typeof import('fs');
export const realExistsSync = fsReal.existsSync;
export const mockExistsSync = (path: fs.PathLike): ReturnType<typeof realExistsSync> => {
  if (
    (path as string).endsWith(SERVER_SDK_CONFIG_FILE) ||
    (path as string).endsWith(CLIENT_SDK_CONFIG_FILE) ||
    (path as string).endsWith(EDGE_SDK_CONFIG_FILE)
  ) {
    return true;
  }

  return realExistsSync(path);
};
export const exitsSync = vi.spyOn(fs, 'existsSync').mockImplementation(mockExistsSync);

/** Mocking of temporary directory creation (so that we have a place to stick files (like `sentry.client.config.js`) in
 * order to test that we can find them) */

// Make it so that all temporary folders, either created directly by tests or by the code they're testing, will go into
// one spot that we know about, which we can then clean up when we're done
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
const osReal = (await vi.importActual('os')) as typeof import('os');
const realTmpdir = osReal.tmpdir;

// Including the random number ensures that even if multiple test files using these mocks are running at once, they have
// separate temporary folders
const TEMP_DIR_PATH = path.join(realTmpdir(), `sentry-nextjs-test-${Math.random()}`);

vi.spyOn(os, 'tmpdir').mockReturnValue(TEMP_DIR_PATH);
// In theory, we should always land in the `else` here, but this saves the cases where the prior run got interrupted and
// the `afterAll` below didn't happen.
if (fs.existsSync(TEMP_DIR_PATH)) {
  fs.rmSync(TEMP_DIR_PATH, { recursive: true, force: true });
}

fs.mkdirSync(TEMP_DIR_PATH);

afterAll(() => {
  fs.rmSync(TEMP_DIR_PATH, { recursive: true, force: true });
});

// In order to know what to expect in the webpack config `entry` property, we need to know the path of the temporary
// directory created when doing the file injection, so wrap the real `mkdtempSync` and store the resulting path where we
// can access it
export const mkdtempSyncSpy = vi.spyOn(fs, 'mkdtempSync');

afterEach(() => {
  mkdtempSyncSpy.mockClear();
});

// eslint-disable-next-line @typescript-eslint/unbound-method
const realConsoleWarn = global.console.warn;
global.console.warn = (...args: unknown[]) => {
  // Suppress the v7 -> v8 migration warning which would get spammed for the unit tests otherwise
  if (typeof args[0] === 'string' && args[0]?.includes('Learn more about setting up an instrumentation hook')) {
    return;
  }

  return realConsoleWarn(...args);
};