@rnx-kit/cli 0.12.5 → 0.14.0

package/test/bundle/metro.test.ts

@@ -1,115 +1,75 @@
-import type { AllPlatforms } from "@rnx-kit/tools-react-native/platform";
-import path from "path";
-import { createMetroBundleArgs } from "../../src/bundle/metro";
-import type { BundleConfig } from "../../src/bundle/types";
+import "jest-extended";
+import { metroBundle } from "../../src/bundle/metro";
+import type { CliPlatformBundleConfig } from "../../src/bundle/types";
 
-describe("CLI > Bundle > Metro > createMetroBundleArgs", () => {
-  const bundleConfig: BundleConfig = {
-    detectCyclicDependencies: true,
-    detectDuplicateDependencies: true,
-    typescriptValidation: true,
-    treeShake: true,
-    entryPath: "out/entry.js",
-    distPath: "out",
-    assetsPath: "out/assets",
-    bundlePrefix: "my-app",
-    platform: "ios",
-    dev: true,
-    minify: true,
-    sourceMapPath: "abc.map",
-    sourceMapSourceRootPath: "root-path-for-source-maps",
-  };
-
-  test("sets assetsDest", () => {
-    expect(createMetroBundleArgs(bundleConfig).assetsDest).toEqual(
-      bundleConfig.assetsPath
-    );
-  });
-
-  test("sets entryFile", () => {
-    expect(createMetroBundleArgs(bundleConfig).entryFile).toEqual(
-      bundleConfig.entryPath
-    );
-  });
-
-  test("sets minify", () => {
-    expect(createMetroBundleArgs(bundleConfig).minify).toEqual(
-      bundleConfig.minify
-    );
-  });
-
-  test("sets platform", () => {
-    expect(createMetroBundleArgs(bundleConfig).platform).toEqual(
-      bundleConfig.platform
-    );
-  });
-
-  test("sets dev", () => {
-    expect(createMetroBundleArgs(bundleConfig).dev).toEqual(bundleConfig.dev);
-  });
-
-  function testBundleFileExtension(
-    platform: AllPlatforms,
-    expectedExtension: string
-  ): void {
-    const copy: BundleConfig = { ...bundleConfig, platform };
-    const args = createMetroBundleArgs(copy);
-    expect(path.extname(args.bundleOutput).toLowerCase()).toEqual(
-      expectedExtension
-    );
-  }
+const { getDefaultConfig } = require("metro-config");
 
-  test("sets bundle file extension to .bundle for android", () => {
-    testBundleFileExtension("android", ".bundle");
-  });
+const mockCreateDirectory = jest.fn();
+const toolsNodeFS = require("@rnx-kit/tools-node/fs");
+toolsNodeFS.createDirectory = mockCreateDirectory;
 
-  test("sets bundle file extension to .jsbundle for ios", () => {
-    testBundleFileExtension("ios", ".jsbundle");
-  });
+const metroService = require("@rnx-kit/metro-service");
+const mockBundle = metroService.bundle;
 
-  test("sets bundle file extension to .jsbundle for macos", () => {
-    testBundleFileExtension("macos", ".jsbundle");
+describe("CLI > Bundle > Metro > metroBundle", () => {
+  afterEach(() => {
+    jest.resetAllMocks();
   });
 
-  test("sets bundle file extension to .bundle for windows", () => {
-    testBundleFileExtension("windows", ".bundle");
-  });
+  const bundleConfigNoPlugins: CliPlatformBundleConfig = {
+    entryFile: "out/entry.js",
+    bundleOutput: "src/main.jsbundle",
+    detectCyclicDependencies: false,
+    detectDuplicateDependencies: false,
+    typescriptValidation: false,
+    treeShake: false,
+    platform: "ios",
+    sourcemapOutput: "map/main.map",
+    sourcemapSourcesRoot: "root-path-for-source-maps",
+    sourcemapUseAbsolutePath: false,
+    assetsDest: "dist",
+  };
 
-  test("sets bundle file extension to .bundle for win32", () => {
-    testBundleFileExtension("win32", ".bundle");
-  });
+  const bundleConfig: CliPlatformBundleConfig = {
+    ...bundleConfigNoPlugins,
+    detectCyclicDependencies: true,
+    detectDuplicateDependencies: true,
+    typescriptValidation: true,
+    treeShake: true,
+  };
 
-  test("sets bundleOutput to prefix + platform + extension under distPath", () => {
-    expect(createMetroBundleArgs(bundleConfig).bundleOutput).toEqual(
-      path.join(bundleConfig.distPath, "my-app.ios.jsbundle")
-    );
-  });
+  const dev = true;
+  const minify = true;
 
-  test("sets bundleEncoding", () => {
-    expect(createMetroBundleArgs(bundleConfig).bundleEncoding).toEqual(
-      bundleConfig.bundleEncoding
-    );
+  it("does not use a custom serializer when all plugins are disabled", async () => {
+    const metroConfig = await getDefaultConfig();
+    expect(metroConfig.serializer.customSerializer).toBeNil();
+    await metroBundle(metroConfig, bundleConfigNoPlugins, dev, minify);
+    expect(metroConfig.serializer.customSerializer).toBeNil();
   });
 
-  test("always sets sourcemapOutput in dev mode", () => {
-    const copy: BundleConfig = { ...bundleConfig, dev: true };
-    delete copy.sourceMapPath;
-
-    const args = createMetroBundleArgs(copy);
-    expect(args.sourcemapOutput).toEqual(args.bundleOutput + ".map");
+  it("uses a custom serializer when at least one plugin is enabled", async () => {
+    const metroConfig = await getDefaultConfig();
+    expect(metroConfig.serializer.customSerializer).toBeNil();
+    await metroBundle(metroConfig, bundleConfig, dev, minify);
+    expect(metroConfig.serializer.customSerializer).not.toBeNil();
   });
 
-  test("sets sourcemapOutput in production mode", () => {
-    const copy: BundleConfig = { ...bundleConfig, dev: false };
-    const args = createMetroBundleArgs(copy);
-    expect(args.sourcemapOutput).toEqual(
-      path.join(bundleConfig.distPath, bundleConfig.sourceMapPath)
-    );
+  it("creates directories for the bundle, the source map, and assets", async () => {
+    await metroBundle(await getDefaultConfig(), bundleConfig, dev, minify);
+    expect(mockCreateDirectory).toHaveBeenCalledTimes(3);
+    expect(mockCreateDirectory).toHaveBeenNthCalledWith(1, "src");
+    expect(mockCreateDirectory).toHaveBeenNthCalledWith(2, "map");
+    expect(mockCreateDirectory).toHaveBeenNthCalledWith(3, "dist");
   });
 
-  test("sets sourcemapSourcesRoot", () => {
-    expect(createMetroBundleArgs(bundleConfig).sourcemapSourcesRoot).toEqual(
-      bundleConfig.sourceMapSourceRootPath
-    );
+  it("invokes the Metro bundler using all input parameters", async () => {
+    await metroBundle(await getDefaultConfig(), bundleConfig, dev, minify);
+    expect(mockBundle).toHaveBeenCalledTimes(1);
+    expect(mockBundle.mock.calls[0][0]).toEqual({
+      ...bundleConfig,
+      dev,
+      minify,
+    });
   });
 });

package/test/bundle/overrides.test.ts

@@ -1,29 +1,33 @@
 import "jest-extended";
-import { applyKitBundleConfigOverrides } from "../../src/bundle/overrides";
-import type { KitBundleConfig } from "../../src/bundle/types";
+import { applyBundleConfigOverrides } from "../../src/bundle/overrides";
+import type { CliPlatformBundleConfig } from "../../src/bundle/types";
 
-describe("CLI > Bundle > Overrides > applyKitBundleConfigOverrides", () => {
-  const config: KitBundleConfig = {
+describe("CLI > Bundle > Overrides > applyBundleConfigOverrides", () => {
+  const config: CliPlatformBundleConfig = {
+    entryFile: "src/index.js",
+    bundleOutput: "main.jsbundle",
+    sourcemapUseAbsolutePath: false,
     detectCyclicDependencies: true,
     detectDuplicateDependencies: true,
     typescriptValidation: true,
     treeShake: true,
-    entryPath: "dist/index.js",
-    distPath: "dist",
-    assetsPath: "dist",
-    bundlePrefix: "main",
     platform: "ios",
   };
 
   test("has no effect when no overrides are given", () => {
     const copy = { ...config };
-    applyKitBundleConfigOverrides({}, [copy]);
+    applyBundleConfigOverrides({}, [copy]);
     expect(copy).toEqual(config);
   });
 
   function testOverride(name: string, value: unknown) {
     const copy = { ...config };
-    applyKitBundleConfigOverrides(
+    if (name in copy) {
+      if (name !== undefined && name !== null) {
+        expect(copy[name]).not.toEqual(value);
+      }
+    }
+    applyBundleConfigOverrides(
       {
         [name]: value,
       },
@@ -35,35 +39,35 @@ describe("CLI > Bundle > Overrides > applyKitBundleConfigOverrides", () => {
     });
   }
 
-  test("changes entryPath using an override", () => {
-    testOverride("entryPath", "out/entry.js");
+  test("changes entryFile using an override", () => {
+    testOverride("entryFile", "foo.js");
   });
 
-  test("changes distPath using an override", () => {
-    testOverride("distPath", "out");
+  test("changes bundleOutput using an override", () => {
+    testOverride("bundleOutput", "foo.bundle");
   });
 
-  test("changes assetsPath using an override", () => {
-    testOverride("assetsPath", "out/assets");
+  test("sets bundleEncoding using an override", () => {
+    testOverride("bundleEncoding", "utf8");
   });
 
-  test("changes bundlePrefix using an override", () => {
-    testOverride("bundlePrefix", "main");
+  test("sets sourcemapOutput using an override", () => {
+    testOverride("sourcemapOutput", "out/foo.map");
   });
 
-  test("changes bundleEncoding using an override", () => {
-    testOverride("bundleEncoding", "utf8");
+  test("sets sourcemapSourcesRoot using an override", () => {
+    testOverride("sourcemapSourcesRoot", "/myrepo/packags/foo");
   });
 
-  test("changes sourcemapOutput using an override", () => {
-    testOverride("sourcemapOutput", "out/entry.map");
+  test("changes sourcemapUseAbsolutePath using an override", () => {
+    testOverride("sourcemapUseAbsolutePath", true);
   });
 
-  test("changes sourcemapSourcesRoot using an override", () => {
-    testOverride("sourcemapSourcesRoot", "out");
+  test("sets assetsDest using an override", () => {
+    testOverride("assetsDest", "dist");
   });
 
   test("changes treeShake using an override", () => {
-    testOverride("treeShake", true);
+    testOverride("treeShake", false);
   });
 });

package/test/copy-assets/assembleAarBundle.test.ts

@@ -5,6 +5,7 @@ import { assembleAarBundle } from "../../src/copy-assets";
 
 jest.mock("child_process");
 jest.mock("fs");
+jest.unmock("@rnx-kit/console");
 
 export const options = {
   platform: "android" as const,
@@ -23,11 +24,11 @@ export const context = {
 
 describe("assembleAarBundle", () => {
   const consoleWarnSpy = jest.spyOn(global.console, "warn");
+  const spawnSyncSpy = jest.spyOn(require("child_process"), "spawnSync");
 
   afterEach(() => {
     mockFiles();
     consoleWarnSpy.mockReset();
-    spawnSync.mockReset();
   });
 
   afterAll(() => {
@@ -48,7 +49,7 @@ describe("assembleAarBundle", () => {
       expect.anything(),
       expect.stringMatching(/cannot find `gradlew`$/)
     );
-    expect(spawnSync).not.toHaveBeenCalled();
+    expect(spawnSyncSpy).not.toHaveBeenCalled();
     expect(findFiles()).toEqual([]);
   });
 
@@ -82,7 +83,7 @@ describe("assembleAarBundle", () => {
       expect.anything(),
       expect.stringMatching(/cannot find `build.gradle`/)
     );
-    expect(spawnSync).not.toHaveBeenCalled();
+    expect(spawnSyncSpy).not.toHaveBeenCalled();
     expect(findFiles()).toEqual([
       [expect.stringMatching(/[/\\]gradlew$/), ""],
       [expect.stringMatching(/[/\\]gradlew.bat$/), ""],
@@ -114,7 +115,7 @@ describe("assembleAarBundle", () => {
     await assembleAarBundle(context, "@rnx-kit/react-native-auth", { aar: {} });
 
     expect(consoleWarnSpy).not.toHaveBeenCalled();
-    expect(spawnSync).toHaveBeenCalledWith(
+    expect(spawnSyncSpy).toHaveBeenCalledWith(
       expect.stringMatching(/[/\\]gradlew(?:\.bat)?$/),
       [":rnx-kit_react-native-auth:assembleRelease"],
       expect.objectContaining({
@@ -200,7 +201,7 @@ describe("assembleAarBundle", () => {
     await assembleAarBundle(context, "@rnx-kit/react-native-auth", { aar: {} });
 
     expect(consoleWarnSpy).not.toHaveBeenCalled();
-    expect(spawnSync).toHaveBeenCalledWith(
+    expect(spawnSyncSpy).toHaveBeenCalledWith(
       expect.stringMatching(/[/\\]gradlew(?:\.bat)?$/),
       [":rnx-kit_react-native-auth:assembleRelease"],
       expect.objectContaining({
@@ -281,7 +282,7 @@ describe("assembleAarBundle", () => {
     });
 
     expect(consoleWarnSpy).not.toHaveBeenCalled();
-    expect(spawnSync).toHaveBeenCalledWith(
+    expect(spawnSyncSpy).toHaveBeenCalledWith(
       expect.stringMatching(/[/\\]gradlew(?:\.bat)?$/),
       [":rnx-kit_react-native-auth:assembleRelease"],
       expect.objectContaining({

package/lib/types.d.ts

@@ -1,5 +0,0 @@
-export declare type TypeScriptValidationOptions = {
-    print?: (message: string) => void;
-    throwOnError?: boolean;
-};
-//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,oBAAY,2BAA2B,GAAG;IACxC,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC"}

package/lib/types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/src/types.ts

@@ -1,4 +0,0 @@
-export type TypeScriptValidationOptions = {
-  print?: (message: string) => void;
-  throwOnError?: boolean;
-};