fix(windows): support for custom Package.appxmanifest (#302)

package.json

@@ -79,6 +79,7 @@
     "@types/mustache": "^4.0.0",
     "@types/node": "^12.0.0",
     "@types/prompts": "^2.0.0",
+    "@types/rimraf": "^3.0.0",
     "eslint": "^7.10.0",
     "eslint-plugin-jest": "^24.0.0",
     "eslint-plugin-prettier": "^3.1.4",

scripts/configure.js

@@ -605,7 +605,6 @@ function isDestructive(packagePath, { files, oldFiles }) {
  */
 function removeAllFiles(files, destination) {
   /** @type {(p: string, cb: (error?: Error) => void) => void} */
-  // @ts-ignore
   const rimraf = require("rimraf");
 
   const rethrow = (/** @type {Error | undefined} */ error) => {

test/configure/getAppName.test.js

@@ -9,7 +9,7 @@
 jest.mock("fs");
 
 describe("getAppName()", () => {
-  const { mockFiles } = require("./mockFiles");
+  const { mockFiles } = require("../mockFiles");
   const { getAppName } = require("../../scripts/configure");
 
   const consoleSpy = jest.spyOn(global.console, "warn");

test/configure/isDestructive.test.js

@@ -9,7 +9,7 @@
 jest.mock("fs");
 
 describe("isDestructive()", () => {
-  const { mockFiles } = require("./mockFiles");
+  const { mockFiles } = require("../mockFiles");
   const { isDestructive } = require("../../scripts/configure");
 
   /**

test/configure/removeAllFiles.test.js

@@ -11,7 +11,7 @@ jest.mock("fs");
 const fs = require("fs");
 
 describe("removeAllFiles()", () => {
-  const { mockFiles } = require("./mockFiles");
+  const { mockFiles } = require("../mockFiles");
   const { removeAllFiles } = require("../../scripts/configure");
 
   beforeEach(() => {

test/configure/updatePackageManifest.test.js

@@ -9,7 +9,7 @@
 jest.mock("fs");
 
 describe("updatePackageManifest()", () => {
-  const { mockFiles } = require("./mockFiles");
+  const { mockFiles } = require("../mockFiles");
   const { updatePackageManifest } = require("../../scripts/configure");
 
   afterEach(() => mockFiles());

test/configure/writeAllFiles.test.js

@@ -12,7 +12,7 @@ const fs = require("fs");
 const path = require("path");
 
 describe("writeAllFiles()", () => {
-  const { mockFiles } = require("./mockFiles");
+  const { mockFiles } = require("../mockFiles");
   const { writeAllFiles } = require("../../scripts/configure");
 
   afterEach(() => {

test/configure/mockFiles.js → test/mockFiles.js

@@ -19,7 +19,10 @@ function mockFiles(...files) {
   // @ts-ignore `__setMockFiles`
   fs.__setMockFiles(
     Object.fromEntries(
-      files.map(([filename, content]) => [filename, JSON.stringify(content)])
+      files.map(([filename, content]) => [
+        filename,
+        typeof content === "string" ? content : JSON.stringify(content),
+      ])
     )
   );
 }

test/windows-test-app/copyAndReplace.test.js

@@ -9,19 +9,19 @@
 jest.mock("fs");
 
 describe("copyAndReplace", () => {
+  const { mockFiles } = require("../mockFiles");
   const { copyAndReplace } = require("../../windows/test-app");
 
-  // @ts-ignore `__setMockFiles`
-  afterEach(() => require("fs").__setMockFiles({}));
+  afterEach(() => mockFiles());
 
   test("replaces text files only", () => {
+    mockFiles(
+      ["ReactTestApp_TemporaryKey.pfx", "binary"],
+      ["ReactTestApp.png", "binary"],
+      ["ReactTestApp.sln", "binary"]
+    );
+
     const fs = require("fs");
-    // @ts-ignore `__setMockFiles`
-    fs.__setMockFiles({
-      "ReactTestApp_TemporaryKey.pfx": "binary",
-      "ReactTestApp.png": "binary",
-      "ReactTestApp.sln": "binary",
-    });
 
     const replacements = { binary: "text" };
 

test/windows-test-app/generateSolution.test.js

@@ -10,6 +10,7 @@ jest.mock("fs");
 
 describe("generateSolution", () => {
   const path = require("path");
+  const { mockFiles } = require("../mockFiles");
   const { generateSolution } = require("../../windows/test-app");
 
   const cwd = process.cwd();
@@ -24,8 +25,7 @@ describe("generateSolution", () => {
   });
 
   afterEach(() => {
-    // @ts-ignore `__setMockFiles`
-    require("fs").__setMockFiles({});
+    mockFiles();
     process.chdir(cwd);
   });
 
@@ -42,22 +42,18 @@ describe("generateSolution", () => {
   });
 
   test("exits if 'react-native-windows' folder cannot be found", () => {
-    // @ts-ignore `__setMockFiles`
-    require("fs").__setMockFiles({
-      [path.resolve("", "node_modules")]: "directory",
-    });
+    mockFiles([path.resolve("", "node_modules"), "directory"]);
 
     expect(generateSolution("test", options)).toBe(
       "Could not find 'react-native-windows'"
     );
   });
 
   test("exits if 'react-native-test-app' folder cannot be found", () => {
-    // @ts-ignore `__setMockFiles`
-    require("fs").__setMockFiles({
-      [path.resolve("", "node_modules")]: "directory",
-      [path.resolve("", "node_modules", "react-native-windows")]: "directory",
-    });
+    mockFiles(
+      [path.resolve("", "node_modules"), "directory"],
+      [path.resolve("", "node_modules", "react-native-windows"), "directory"]
+    );
 
     expect(generateSolution("test", options)).toBe(
       "Could not find 'react-native-test-app'"

test/windows-test-app/getBundleResources.test.js

@@ -10,43 +10,74 @@ jest.mock("fs");
 
 describe("getBundleResources", () => {
   const path = require("path");
+  const { mockFiles } = require("../mockFiles");
   const { getBundleResources } = require("../../windows/test-app");
 
-  // @ts-ignore `__setMockFiles`
-  afterEach(() => require("fs").__setMockFiles({}));
+  afterEach(() => mockFiles());
 
   test("returns app name and bundle resources", () => {
     const assets = path.join("dist", "assets");
     const bundle = path.join("dist", "main.bundle");
-    // @ts-ignore `__setMockFiles`
-    require("fs").__setMockFiles({
-      "app.json": JSON.stringify({
-        name: "Example",
-        resources: [assets, bundle],
-      }),
-      [assets]: "directory",
-      [bundle]: "text",
-    });
-
-    const [appName, bundleDirContent, bundleFileContent] = getBundleResources(
-      "app.json",
-      path.resolve("")
+    mockFiles(
+      [
+        "app.json",
+        {
+          name: "Example",
+          resources: [assets, bundle],
+        },
+      ],
+      [assets, "directory"],
+      [bundle, "text"]
     );
 
+    const {
+      appName,
+      appxManifest,
+      bundleDirContent,
+      bundleFileContent,
+    } = getBundleResources("app.json", path.resolve(""));
+
     expect(appName).toBe("Example");
+    expect(appxManifest).toBe("windows/Package.appxmanifest");
     expect(bundleDirContent).toBe(`${assets}\\**\\*;`);
     expect(bundleFileContent).toBe(`${bundle};`);
   });
 
+  test("returns package manifest", () => {
+    mockFiles([
+      "app.json",
+      {
+        windows: {
+          appxManifest: "windows/Example/Package.appxmanifest",
+        },
+      },
+    ]);
+
+    const {
+      appName,
+      appxManifest,
+      bundleDirContent,
+      bundleFileContent,
+    } = getBundleResources("app.json", path.resolve(""));
+
+    expect(appName).toBe("ReactTestApp");
+    expect(appxManifest).toBe("windows/Example/Package.appxmanifest");
+    expect(bundleDirContent).toBe("");
+    expect(bundleFileContent).toBe("");
+  });
+
   test("handles missing manifest", () => {
     const warnSpy = jest.spyOn(global.console, "warn").mockImplementation();
 
-    const [appName, bundleDirContent, bundleFileContent] = getBundleResources(
-      "",
-      ""
-    );
+    const {
+      appName,
+      appxManifest,
+      bundleDirContent,
+      bundleFileContent,
+    } = getBundleResources("", "");
 
     expect(appName).toBe("ReactTestApp");
+    expect(appxManifest).toBe("windows/Package.appxmanifest");
     expect(bundleDirContent).toBeFalsy();
     expect(bundleFileContent).toBeFalsy();
 
@@ -56,19 +87,19 @@ describe("getBundleResources", () => {
   });
 
   test("handles invalid manifest", () => {
-    // @ts-ignore `__setMockFiles`
-    require("fs").__setMockFiles({
-      "app.json": "-",
-    });
+    mockFiles(["app.json", "-"]);
 
     const warnSpy = jest.spyOn(global.console, "warn").mockImplementation();
 
-    const [appName, bundleDirContent, bundleFileContent] = getBundleResources(
-      "app.json",
-      path.resolve("")
-    );
+    const {
+      appName,
+      appxManifest,
+      bundleDirContent,
+      bundleFileContent,
+    } = getBundleResources("app.json", path.resolve(""));
 
     expect(appName).toBe("ReactTestApp");
+    expect(appxManifest).toBe("windows/Package.appxmanifest");
     expect(bundleDirContent).toBeFalsy();
     expect(bundleFileContent).toBeFalsy();
 

test/windows-test-app/parseResources.test.js

@@ -9,10 +9,10 @@
 jest.mock("fs");
 
 describe("parseResources", () => {
+  const { mockFiles } = require("../mockFiles");
   const { parseResources } = require("../../windows/test-app");
 
-  // @ts-ignore `__setMockFiles`
-  afterEach(() => require("fs").__setMockFiles({}));
+  afterEach(() => mockFiles());
 
   test("returns empty strings for no resources", () => {
     expect(parseResources(undefined, "", "")).toEqual(["", ""]);
@@ -22,11 +22,7 @@ describe("parseResources", () => {
   });
 
   test("returns references to existing assets", () => {
-    // @ts-ignore `__setMockFiles`
-    require("fs").__setMockFiles({
-      "dist/assets": "directory",
-      "dist/main.jsbundle": "text",
-    });
+    mockFiles(["dist/assets", "directory"], ["dist/main.jsbundle", "text"]);
 
     expect(
       parseResources(

windows/ReactTestApp/App.cpp

@@ -9,8 +9,6 @@
 
 #include "App.h"
 
-#include "MainPage.h"
-
 using winrt::ReactTestApp::implementation::App;
 using winrt::Windows::ApplicationModel::SuspendingEventArgs;
 using winrt::Windows::ApplicationModel::Activation::ApplicationExecutionState;
@@ -73,12 +71,10 @@ void App::OnLaunched(LaunchActivatedEventArgs const &e)
             // Ensure the current window is active
             Window::Current().Activate();
         }
-    } else {
-        if (!e.PrelaunchActivated()) {
-            NavigateToFirstPage(rootFrame, e);
-            // Ensure the current window is active
-            Window::Current().Activate();
-        }
+    } else if (!e.PrelaunchActivated()) {
+        NavigateToFirstPage(rootFrame, e);
+        // Ensure the current window is active
+        Window::Current().Activate();
     }
 }
 
@@ -110,6 +106,6 @@ void App::NavigateToFirstPage(Frame &rootFrame, LaunchActivatedEventArgs const &
         // When the navigation stack isn't restored navigate to the first page,
         // configuring the new page by passing required information as a navigation
         // parameter
-        rootFrame.Navigate(xaml_typename<ReactTestApp::MainPage>(), box_value(e.Arguments()));
+        rootFrame.Navigate(xaml_typename<MainPage>(), box_value(e.Arguments()));
     }
 }

windows/ReactTestApp/ReactTestApp.vcxproj

@@ -166,7 +166,10 @@
         </Page>
     </ItemGroup>
     <ItemGroup>
-        <AppxManifest Include="$(ReactTestAppDir)\Package.appxmanifest">
+        <AppxManifest Include="$(SolutionDir)$(ReactTestAppPackageManifest)" Condition="Exists('$(SolutionDir)$(ReactTestAppPackageManifest)')">
+            <SubType>Designer</SubType>
+        </AppxManifest>
+        <AppxManifest Include="$(ReactTestAppDir)\Package.appxmanifest" Condition="!Exists('$(SolutionDir)$(ReactTestAppPackageManifest)')">
             <SubType>Designer</SubType>
         </AppxManifest>
     </ItemGroup>

windows/ReactTestApp/ReactTestApp.vcxproj.filters

@@ -36,6 +36,7 @@
         </Text>
     </ItemGroup>
     <ItemGroup>
+        <AppxManifest Include="$(SolutionDir)$(ReactTestAppPackageManifest)" />
         <AppxManifest Include="$(ReactTestAppDir)\Package.appxmanifest" />
     </ItemGroup>
     <ItemGroup>