fix: support import rstest in node_modules (#547)

Author: 9aoy

e2e/runner/test/fixtures/runner.test.ts

@@ -0,0 +1,6 @@
+import { expect, it } from '@rstest/core';
+import 'rstest-import';
+
+it('should run setup correctly', async () => {
+  expect(process.env.A).toBe('A');
+});

e2e/runner/test/fixtures/test-rstest-import/index.js

@@ -0,0 +1,18 @@
+import { beforeAll, describe, expect, it, rs } from '@rstest/core';
+
+beforeAll(() => {
+  process.env.A = 'A';
+});
+
+describe('wrap test', () => {
+  it('should run', () => {
+    const fn = rs.fn(() => 'hello');
+
+    expect(fn()).toBe('hello');
+    expect('call it').toBe('call it');
+  });
+
+  it.todo('should not run', () => {
+    expect(1 + 1).toBe(3);
+  });
+});

e2e/runner/test/fixtures/test-rstest-import/package.json

@@ -0,0 +1,11 @@
+{
+  "private": true,
+  "name": "@rstest/tests-rstest-import",
+  "main": "index.js",
+  "type": "module",
+  "sideEffects": true,
+  "version": "1.0.0",
+  "devDependencies": {
+    "@rstest/core": "workspace:*"
+  }
+}

e2e/runner/test/runner.test.ts

@@ -0,0 +1,29 @@
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { it } from '@rstest/core';
+import { prepareFixtures, runRstestCli } from '../../scripts/';
+
+const __filename = fileURLToPath(import.meta.url);
+
+const __dirname = dirname(__filename);
+
+it('should import rstest correctly in node_modules', async () => {
+  await prepareFixtures({
+    fixturesPath: join(__dirname, './fixtures/test-rstest-import'),
+    fixturesTargetPath: join(
+      __dirname,
+      './fixtures/node_modules/rstest-import',
+    ),
+  });
+  const { expectExecSuccess, expectLog } = await runRstestCli({
+    command: 'rstest',
+    args: ['run', 'runner.test.ts'],
+    options: {
+      nodeOptions: {
+        cwd: join(__dirname, 'fixtures'),
+      },
+    },
+  });
+  await expectExecSuccess();
+  expectLog('Tests 2 passed | 1 todo');
+});

e2e/watch/index.test.ts

@@ -1,11 +1,15 @@
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
-import { describe, expect, it } from '@rstest/core';
+import { describe, expect, it, rs } from '@rstest/core';
 import { prepareFixtures, runRstestCli } from '../scripts';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
+rs.setConfig({
+  retry: 3,
+});
+
 describe('watch', () => {
   it('test files should be ran when create / update / delete', async () => {
     const { fs } = await prepareFixtures({

packages/core/src/runtime/api/index.ts

@@ -40,7 +40,7 @@ export const createRstestRuntime = (
 
   const rstest = createRstestUtilities(workerState);
 
-  return {
+  const runtime = {
     runner,
     api: {
       ...runnerAPI,
@@ -50,4 +50,8 @@ export const createRstestRuntime = (
       rs: rstest,
     },
   };
+
+  globalThis.RSTEST_API = runtime.api;
+
+  return runtime;
 };

packages/core/src/runtime/api/public.ts

@@ -3,16 +3,61 @@ import type { Rstest, RstestUtilities } from '../../types';
 export type { Assertion } from '../../types/expect';
 export type { Mock } from '../../types/mock';
 
-export declare const expect: Rstest['expect'];
-export declare const assert: Rstest['assert'];
-export declare const it: Rstest['it'];
-export declare const test: Rstest['test'];
-export declare const describe: Rstest['describe'];
-export declare const beforeAll: Rstest['beforeAll'];
-export declare const afterAll: Rstest['afterAll'];
-export declare const beforeEach: Rstest['beforeEach'];
-export declare const afterEach: Rstest['afterEach'];
-export declare const rstest: RstestUtilities;
-export declare const rs: RstestUtilities;
-export declare const onTestFinished: Rstest['onTestFinished'];
-export declare const onTestFailed: Rstest['onTestFailed'];
+declare global {
+  var RSTEST_API: Rstest | undefined;
+}
+
+const check = (name: keyof Rstest) => {
+  if (!globalThis.RSTEST_API?.[name]) {
+    throw new Error(
+      `Rstest API '${name}' is not registered yet, please make sure you are running in a rstest environment.`,
+    );
+  }
+};
+
+const wrapRstestAPI = <T extends keyof Omit<Rstest, 'rstest' | 'rs'>>(
+  name: T,
+): Rstest[T] => {
+  const fn = (...args: Parameters<Rstest[T]>) => {
+    check(name);
+    return globalThis.RSTEST_API![name].call(
+      globalThis.RSTEST_API![name],
+      // @ts-expect-error
+      ...args,
+    );
+  };
+
+  return new Proxy(fn, {
+    get(_target, key, receiver) {
+      check(name);
+      return Reflect.get(globalThis.RSTEST_API?.[name] || {}, key, receiver);
+    },
+  }) as Rstest[T];
+};
+
+const wrapRstestUtilitiesAPI = <T extends keyof Pick<Rstest, 'rstest' | 'rs'>>(
+  name: T,
+): Rstest[T] => {
+  return new Proxy({} as Rstest[T], {
+    get(_target, key, receiver) {
+      check(name);
+      return Reflect.get(globalThis.RSTEST_API?.[name] || {}, key, receiver);
+    },
+  });
+};
+
+export const expect: Rstest['expect'] = wrapRstestAPI('expect');
+export const assert: Rstest['assert'] = wrapRstestAPI('assert');
+export const it: Rstest['it'] = wrapRstestAPI('it');
+export const test: Rstest['test'] = wrapRstestAPI('test');
+export const describe: Rstest['describe'] = wrapRstestAPI('describe');
+export const beforeAll: Rstest['beforeAll'] = wrapRstestAPI('beforeAll');
+export const afterAll: Rstest['afterAll'] = wrapRstestAPI('afterAll');
+export const beforeEach: Rstest['beforeEach'] = wrapRstestAPI('beforeEach');
+export const afterEach: Rstest['afterEach'] = wrapRstestAPI('afterEach');
+export const rstest: RstestUtilities = wrapRstestUtilitiesAPI('rstest');
+export const rs: RstestUtilities = wrapRstestUtilitiesAPI('rs');
+export const onTestFinished: Rstest['onTestFinished'] =
+  wrapRstestAPI('onTestFinished');
+export const onTestFailed: Rstest['onTestFailed'] =
+  wrapRstestAPI('onTestFailed');