@react-native-harness/metro 1.1.0-rc.1 → 1.1.0-rc.3

package/dist/withRnHarness.js

@@ -1,84 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withRnHarness = void 0;
-const config_1 = require("@react-native-harness/config");
-const resolver_1 = require("./resolvers/resolver");
-const manifest_1 = require("./manifest");
-const babel_transformer_1 = require("./babel-transformer");
-const metro_cache_1 = require("./metro-cache");
-const INTERNAL_CALLSITES_REGEX = /(^|[\\/])(node_modules[/\\]@react-native-harness)([\\/]|$)/;
-const withRnHarness = (config, isInvokedByHarness = false) => {
-    // This is a workaround for a regression in Metro 0.83, when promises are not handled correctly.
+let hasWarned = false;
+const withRnHarness = (config, _isInvokedByHarness = false) => {
     return async () => {
-        // If the function is not invoked by the Harness, return the config as is.
-        // We'll remove it in the next major version.
-        if (!isInvokedByHarness) {
-            return config;
+        if (!hasWarned) {
+            hasWarned = true;
+            console.warn("[react-native-harness] `withRnHarness` in Metro configs is deprecated and will be removed in a future release. Remove `withRnHarness` from your Metro config; React Native Harness now patches Metro internally.");
         }
-        const metroConfig = await config;
-        const { config: harnessConfig } = await (0, config_1.getConfig)(process.cwd());
-        const harnessResolver = (0, resolver_1.getHarnessResolver)(metroConfig, harnessConfig);
-        const harnessManifest = (0, manifest_1.getHarnessManifest)(harnessConfig);
-        const harnessBabelTransformerPath = (0, babel_transformer_1.getHarnessBabelTransformerPath)(metroConfig);
-        const patchedConfig = {
-            ...metroConfig,
-            cacheVersion: 'react-native-harness',
-            server: {
-                ...metroConfig.server,
-                forwardClientLogs: harnessConfig.forwardClientLogs ?? false,
-            },
-            serializer: {
-                ...metroConfig.serializer,
-                getPolyfills: (...args) => [
-                    ...(metroConfig.serializer?.getPolyfills?.(...args) ?? []),
-                    harnessManifest,
-                    require.resolve('@react-native-harness/runtime/polyfills/harness-module-system'),
-                ],
-                isThirdPartyModule({ path: modulePath }) {
-                    const isThirdPartyByDefault = metroConfig.serializer?.isThirdPartyModule?.({
-                        path: modulePath,
-                    }) ?? false;
-                    if (isThirdPartyByDefault) {
-                        return true;
-                    }
-                    return INTERNAL_CALLSITES_REGEX.test(modulePath);
-                },
-            },
-            resolver: {
-                ...metroConfig.resolver,
-                // Unlock __tests__ directory
-                blockList: undefined,
-                resolveRequest: harnessResolver,
-            },
-            transformer: {
-                ...metroConfig.transformer,
-                babelTransformerPath: harnessBabelTransformerPath,
-            },
-            symbolicator: {
-                ...metroConfig.symbolicator,
-                customizeFrame: async (frame) => {
-                    const defaultCustomizeFrame = await metroConfig.symbolicator?.customizeFrame?.(frame);
-                    const shouldCollapseByDefault = defaultCustomizeFrame?.collapse ?? false;
-                    if (shouldCollapseByDefault) {
-                        return {
-                            collapse: true,
-                        };
-                    }
-                    return {
-                        collapse: frame.file != null && INTERNAL_CALLSITES_REGEX.test(frame.file),
-                    };
-                },
-            },
-        };
-        if (harnessConfig.unstable__enableMetroCache) {
-            patchedConfig.cacheStores =
-                (0, metro_cache_1.getHarnessCacheStores)();
-        }
-        if (harnessConfig.unstable__skipAlreadyIncludedModules) {
-            patchedConfig.serializer.customSerializer =
-                require('./getHarnessSerializer').getHarnessSerializer();
-        }
-        return patchedConfig;
+        return await config;
     };
 };
 exports.withRnHarness = withRnHarness;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-harness/metro",
-  "version": "1.1.0-rc.1",
+  "version": "1.1.0-rc.3",
   "type": "commonjs",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -15,18 +15,13 @@
     }
   },
   "peerDependencies": {
-    "metro": "*",
-    "@react-native-harness/runtime": "1.1.0-rc.1"
+    "metro": "*"
   },
   "dependencies": {
-    "tslib": "^2.3.0",
-    "@react-native-harness/config": "1.1.0-rc.1",
-    "@react-native-harness/babel-preset": "1.1.0-rc.1"
+    "tslib": "^2.3.0"
   },
   "devDependencies": {
-    "@types/babel__core": "^7.20.5",
-    "metro": "*",
-    "@react-native-harness/runtime": "1.1.0-rc.1"
+    "metro": "*"
   },
   "license": "MIT"
 }

package/src/__tests__/withRnHarness.test.ts

@@ -0,0 +1,32 @@
+import { afterEach, describe, expect, it, vi } from 'vitest';
+
+const consoleWarnSpy = vi
+  .spyOn(console, 'warn')
+  .mockImplementation(() => undefined);
+
+afterEach(() => {
+  consoleWarnSpy.mockClear();
+  vi.resetModules();
+});
+
+describe('withRnHarness', () => {
+  it('returns the provided config unchanged', async () => {
+    const { withRnHarness } = await import('../withRnHarness.js');
+    const config = { resolver: { blockList: [] } };
+
+    await expect(withRnHarness(config)()).resolves.toBe(config);
+    expect(consoleWarnSpy).toHaveBeenCalledTimes(1);
+  });
+
+  it('warns only once across repeated calls', async () => {
+    const { withRnHarness } = await import('../withRnHarness.js');
+
+    await withRnHarness({ projectRoot: '/tmp/app' }, true)();
+    await withRnHarness(Promise.resolve({ projectRoot: '/tmp/app' }), true)();
+
+    expect(consoleWarnSpy).toHaveBeenCalledTimes(1);
+    expect(consoleWarnSpy.mock.calls[0]?.[0]).toContain(
+      'Remove `withRnHarness` from your Metro config'
+    );
+  });
+});

package/src/withRnHarness.ts

@@ -1,109 +1,17 @@
-import type { MetroConfig } from 'metro-config';
-import { getConfig } from '@react-native-harness/config';
-import { getHarnessResolver } from './resolvers/resolver';
-import { getHarnessManifest } from './manifest';
-import { getHarnessBabelTransformerPath } from './babel-transformer';
-import { getHarnessCacheStores } from './metro-cache';
-import type { NotReadOnly } from './utils';
+let hasWarned = false;
 
-const INTERNAL_CALLSITES_REGEX =
-  /(^|[\\/])(node_modules[/\\]@react-native-harness)([\\/]|$)/;
-
-export const withRnHarness = <T extends MetroConfig>(
+export const withRnHarness = <T>(
   config: T | Promise<T>,
-  isInvokedByHarness = false
+  _isInvokedByHarness = false
 ): (() => Promise<T>) => {
-  // This is a workaround for a regression in Metro 0.83, when promises are not handled correctly.
   return async () => {
-    // If the function is not invoked by the Harness, return the config as is.
-    // We'll remove it in the next major version.
-    if (!isInvokedByHarness) {
-      return config;
-    }
-
-    const metroConfig = await config;
-    const { config: harnessConfig } = await getConfig(process.cwd());
-
-    const harnessResolver = getHarnessResolver(metroConfig, harnessConfig);
-    const harnessManifest = getHarnessManifest(harnessConfig);
-    const harnessBabelTransformerPath =
-      getHarnessBabelTransformerPath(metroConfig);
-
-    const patchedConfig: MetroConfig = {
-      ...metroConfig,
-      cacheVersion: 'react-native-harness',
-      server: {
-        ...metroConfig.server,
-        forwardClientLogs: harnessConfig.forwardClientLogs ?? false,
-      },
-      serializer: {
-        ...metroConfig.serializer,
-        getPolyfills: (...args) => [
-          ...(metroConfig.serializer?.getPolyfills?.(...args) ?? []),
-          harnessManifest,
-          require.resolve(
-            '@react-native-harness/runtime/polyfills/harness-module-system'
-          ),
-        ],
-        isThirdPartyModule({ path: modulePath }) {
-          const isThirdPartyByDefault =
-            metroConfig.serializer?.isThirdPartyModule?.({
-              path: modulePath,
-            }) ?? false;
-
-          if (isThirdPartyByDefault) {
-            return true;
-          }
-
-          return INTERNAL_CALLSITES_REGEX.test(modulePath);
-        },
-      },
-      resolver: {
-        ...metroConfig.resolver,
-        // Unlock __tests__ directory
-        blockList: undefined,
-        resolveRequest: harnessResolver,
-      },
-      transformer: {
-        ...metroConfig.transformer,
-        babelTransformerPath: harnessBabelTransformerPath,
-      },
-      symbolicator: {
-        ...metroConfig.symbolicator,
-        customizeFrame: async (frame) => {
-          const defaultCustomizeFrame =
-            await metroConfig.symbolicator?.customizeFrame?.(frame);
-          const shouldCollapseByDefault =
-            defaultCustomizeFrame?.collapse ?? false;
-
-          if (shouldCollapseByDefault) {
-            return {
-              collapse: true,
-            };
-          }
-
-          return {
-            collapse:
-              frame.file != null && INTERNAL_CALLSITES_REGEX.test(frame.file),
-          };
-        },
-      },
-    };
-
-    if (harnessConfig.unstable__enableMetroCache) {
-      (patchedConfig.cacheStores as NotReadOnly<MetroConfig['cacheStores']>) =
-        getHarnessCacheStores();
-    }
-
-    if (harnessConfig.unstable__skipAlreadyIncludedModules) {
-      (
-        patchedConfig.serializer as NonNullable<
-          NotReadOnly<MetroConfig['serializer']>
-        >
-      ).customSerializer =
-        require('./getHarnessSerializer').getHarnessSerializer();
+    if (!hasWarned) {
+      hasWarned = true;
+      console.warn(
+        "[react-native-harness] `withRnHarness` in Metro configs is deprecated and will be removed in a future release. Remove `withRnHarness` from your Metro config; React Native Harness now patches Metro internally."
+      );
     }
 
-    return patchedConfig as T;
+    return await config;
   };
 };

package/tsconfig.json

@@ -3,15 +3,6 @@
   "files": [],
   "include": [],
   "references": [
-    {
-      "path": "../babel-preset"
-    },
-    {
-      "path": "../config"
-    },
-    {
-      "path": "../runtime"
-    },
     {
       "path": "./tsconfig.lib.json"
     }

package/tsconfig.lib.json

@@ -9,16 +9,5 @@
     "forceConsistentCasingInFileNames": true,
     "types": ["node"]
   },
-  "include": ["src/**/*.ts"],
-  "references": [
-    {
-      "path": "../babel-preset/tsconfig.lib.json"
-    },
-    {
-      "path": "../config/tsconfig.lib.json"
-    },
-    {
-      "path": "../runtime/tsconfig.lib.json"
-    }
-  ]
+  "include": ["src/**/*.ts"]
 }

package/vite.config.ts

@@ -0,0 +1,18 @@
+/// <reference types='vitest' />
+import { defineConfig } from 'vite';
+
+export default defineConfig(() => ({
+  root: __dirname,
+  cacheDir: '../../node_modules/.vite/packages/metro',
+  test: {
+    watch: false,
+    globals: true,
+    environment: 'node',
+    include: ['{src,tests}/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
+    reporters: ['default'],
+    coverage: {
+      reportsDirectory: './test-output/vitest/coverage',
+      provider: 'v8' as const,
+    },
+  },
+}));

package/src/babel-transformer.ts

@@ -1,40 +0,0 @@
-import type { BabelTransformer } from 'metro-babel-transformer';
-import { rnHarnessPlugins } from '@react-native-harness/babel-preset';
-import { MetroConfig } from '@react-native/metro-config';
-
-export const getHarnessBabelTransformerPath = (
-  metroConfig: MetroConfig
-): string => {
-  const upstreamTransformerPath = metroConfig.transformer?.babelTransformerPath;
-
-  if (!upstreamTransformerPath || typeof upstreamTransformerPath !== 'string') {
-    throw new Error('Upstream transformer path is not a string');
-  }
-
-  process.env.RN_HARNESS_UPSTREAM_TRANSFORMER_PATH = upstreamTransformerPath;
-  return require.resolve('./babel-transformer.js');
-};
-
-const transform: BabelTransformer['transform'] = (args) => {
-  const { plugins } = args;
-  const upstreamTransformerPath =
-    process.env.RN_HARNESS_UPSTREAM_TRANSFORMER_PATH;
-
-  if (!upstreamTransformerPath || typeof upstreamTransformerPath !== 'string') {
-    throw new Error('Upstream transformer path is not a string');
-  }
-
-  const upstreamTransformer = require(upstreamTransformerPath);
-  const pluginsWithHarness = [
-    // Checked against @babel/core's type definitions - plugins are an array of PluginItem
-    ...((plugins as unknown[]) ?? []),
-    ...rnHarnessPlugins,
-  ];
-
-  return upstreamTransformer.transform({
-    ...args,
-    plugins: pluginsWithHarness,
-  });
-};
-
-export { transform };

package/src/errors.ts

@@ -1,6 +0,0 @@
-export class CouldNotPatchModuleSystemError extends Error {
-  constructor() {
-    super('Could not patch module system');
-    this.name = 'CouldNotPatchModuleSystemError';
-  }
-}

package/src/getHarnessSerializer.ts

@@ -1,46 +0,0 @@
-import type { MetroConfig } from 'metro-config';
-
-export type Serializer = NonNullable<
-  NonNullable<MetroConfig['serializer']>['customSerializer']
->;
-
-const getBaseSerializer = (): Serializer => {
-  const baseJSBundle = require('metro/private/DeltaBundler/Serializers/baseJSBundle');
-  const bundleToString = require('metro/private/lib/bundleToString');
-
-  return (entryPoint, prepend, graph, bundleOptions) =>
-    bundleToString(baseJSBundle(entryPoint, prepend, graph, bundleOptions));
-};
-
-const getAllFiles = require('metro/private/DeltaBundler/Serializers/getAllFiles');
-
-export const getHarnessSerializer = (): Serializer => {
-  const baseSerializer = getBaseSerializer();
-  let mainEntryPointModules = new Set<string>();
-
-  return async (entryPoint, preModules, graph, options) => {
-    if (options.modulesOnly) {
-      // This is most likely a test file
-      return baseSerializer(entryPoint, preModules, graph, {
-        ...options,
-        processModuleFilter: (mod) => {
-          if (
-            options.processModuleFilter &&
-            !options.processModuleFilter(mod)
-          ) {
-            // If the module is not allowed by the processModuleFilter, skip it
-            return false;
-          }
-
-          // If the module is in the main entry point, skip it
-          return !mainEntryPointModules.has(mod.path);
-        },
-      });
-    }
-
-    mainEntryPointModules = new Set(
-      await getAllFiles(preModules, graph, options)
-    );
-    return baseSerializer(entryPoint, preModules, graph, options);
-  };
-};

package/src/jest-globals-mock.ts

@@ -1,6 +0,0 @@
-// Mock module for @jest/globals imports
-// This module throws immediately when imported to warn users about using Jest APIs
-
-throw new Error(
-  "Importing '@jest/globals' is not supported in Harness tests. Import from 'react-native-harness' instead."
-);

package/src/manifest.ts

@@ -1,24 +0,0 @@
-import path from 'node:path';
-import fs from 'node:fs';
-import { Config as HarnessConfig } from '@react-native-harness/config';
-
-const getManifestContent = (harnessConfig: HarnessConfig): string => {
-  return `global.RN_HARNESS = { 
-    appRegistryComponentName: '${harnessConfig.appRegistryComponentName}',
-    webSocketPort: ${harnessConfig.webSocketPort},
-    disableViewFlattening: ${harnessConfig.disableViewFlattening},
-  };`;
-};
-
-export const getHarnessManifest = (harnessConfig: HarnessConfig): string => {
-  const manifestContent = getManifestContent(harnessConfig);
-  const manifestPath = path.resolve(
-    process.cwd(),
-    'node_modules/.cache/rn-harness/manifest.js'
-  );
-
-  fs.mkdirSync(path.dirname(manifestPath), { recursive: true });
-  fs.writeFileSync(manifestPath, manifestContent);
-
-  return manifestPath;
-};

package/src/metro-cache.ts

@@ -1,24 +0,0 @@
-import { CacheStore, MetroCache } from 'metro-cache';
-import type { MixedOutput, TransformResult } from 'metro';
-import fs from 'node:fs';
-import path from 'node:path';
-import type { CacheStoresConfigT } from 'metro-config';
-
-const CACHE_ROOT = path.resolve(
-  process.cwd(),
-  'node_modules/.cache/rn-harness/metro-cache'
-);
-
-export const getHarnessCacheStores = (): ((
-  metroCache: MetroCache
-) => CacheStoresConfigT) => {
-  return ({ FileStore }) => {
-    fs.mkdirSync(CACHE_ROOT, { recursive: true });
-
-    return [
-      new FileStore({ root: CACHE_ROOT }) as CacheStore<
-        TransformResult<MixedOutput>
-      >,
-    ];
-  };
-};

package/src/resolvers/composite-resolver.ts

@@ -1,16 +0,0 @@
-import type { HarnessResolver, MetroResolver } from './types';
-
-export const createHarnessResolver = (
-  resolvers: HarnessResolver[]
-): MetroResolver => {
-  return (context, moduleName, platform) => {
-    for (const resolver of resolvers) {
-      const result = resolver(context, moduleName, platform);
-      if (result != null) {
-        return result;
-      }
-    }
-
-    return context.resolveRequest(context, moduleName, platform);
-  };
-};

package/src/resolvers/resolver.ts

@@ -1,100 +0,0 @@
-import type { MetroConfig } from '@react-native/metro-config';
-import type { Config as HarnessConfig } from '@react-native-harness/config';
-import path from 'node:path';
-import { createHarnessResolver } from './composite-resolver';
-import { createTsConfigResolver } from './tsconfig-resolver';
-import type { HarnessResolver, MetroResolver } from './types';
-
-// Safely resolves a path and strips its extension
-const getExtensionlessAbsolutePath = (basePath: string, relativePath = ''): string => {
-  const fullPath = path.resolve(basePath, relativePath);
-  const parsed = path.parse(fullPath);
-  return path.join(parsed.dir, parsed.name);
-}
-
-export const createHarnessEntryPointResolver = (harnessConfig: HarnessConfig): HarnessResolver => {
-  const rootPath = path.resolve(process.cwd());
-  const expectedEntryPoint = getExtensionlessAbsolutePath(rootPath, harnessConfig.entryPoint);
-  const resolvedHarnessPath = require.resolve('@react-native-harness/runtime/entry-point');
-
-  return (context, moduleName, _platform) => {
-    // 1. Resolve the origin path of the file making the import
-    const currentOrigin = path.resolve(context.originModulePath);
-
-    // Fast Fail: If the import isn't happening from the root directory, skip it immediately
-    if (currentOrigin !== rootPath) {
-      return null;
-    }
-
-    // 2. Resolve the module being imported and strip its extension
-    // This safely normalizes './index', './index.js', 'index.js', etc.
-    const requestedModule = getExtensionlessAbsolutePath(currentOrigin, moduleName);
-
-    // 3. String comparison
-    if (requestedModule === expectedEntryPoint) {
-      return {
-        type: 'sourceFile',
-        filePath: resolvedHarnessPath,
-      };
-    }
-
-    return null;
-  };
-};
-
-export const createJestGlobalsResolver = (): HarnessResolver => {
-  return (_context, moduleName, _platform) => {
-    // Intercept @jest/globals imports and redirect to mock module
-    if (moduleName === '@jest/globals') {
-      return {
-        type: 'sourceFile',
-        filePath: require.resolve('../jest-globals-mock'),
-      };
-    }
-
-    return null;
-  };
-};
-
-export const createJsxRuntimeResolver = (): HarnessResolver => {
-  const resolvedJsxRuntimePath = require.resolve(
-    '@react-native-harness/runtime/jsx-runtime'
-  );
-  const resolvedJsxDevRuntimePath = require.resolve(
-    '@react-native-harness/runtime/jsx-dev-runtime'
-  );
-
-  return (_context, moduleName, _platform) => {
-    if (moduleName === '@react-native-harness/runtime/jsx-runtime') {
-      return {
-        type: 'sourceFile',
-        filePath: resolvedJsxRuntimePath,
-      };
-    }
-
-    if (moduleName === '@react-native-harness/runtime/jsx-dev-runtime') {
-      return {
-        type: 'sourceFile',
-        filePath: resolvedJsxDevRuntimePath,
-      };
-    }
-
-    return null;
-  };
-};
-
-export const getHarnessResolver = (
-  metroConfig: MetroConfig,
-  harnessConfig: HarnessConfig
-): MetroResolver => {
-  const userResolver = metroConfig.resolver?.resolveRequest;
-  const resolvers: HarnessResolver[] = [
-    createHarnessEntryPointResolver(harnessConfig),
-    createJestGlobalsResolver(),
-    createJsxRuntimeResolver(),
-    createTsConfigResolver(process.cwd()),
-    userResolver,
-  ].filter((resolver): resolver is HarnessResolver => !!resolver);
-
-  return createHarnessResolver(resolvers);
-};