[PM-9022] scaffold the extension and build pipeline (#9948)

* feat: add macos xcode project

* feat: add extension to mas build

* feat: use `after-sign` to avoid issues

Electron builder modifies the .plist in the extension which causes issues with the signing process. Copying and re-signing manually avoids this because it bypasses the electron builder for the extension

* feat: always clean build and add better error handling

* chore: add some logging to after-sign

* feat: automatically cleanup xcode build to avoid duplicate extensions

* docs: add information about managing extensions

* feat: add missing safari extension logging

* lint: allow macos filenames

* chore: add macos to platform ownership

* lint: add some additional allowed files

* feat: don't build autofill extension for MAS

* chore: ignore capital letters linting for all macos files

* chore: replace gulpfile with regular node script

* chore: add lint rules to script

* lint: fix remaining lint issues in script

* chore: tweak lint rule

* feat: remove desktop target

* fix: use new provisioning profile for dev extension

* Update to unblock CI builds

* chore: remove extension from masdev pack

This way we don't include the extension in any build and can avoid the signing issues it brings

* chore: add autofill as codeowner

* chore: remove xcuserdata

* chore: ignore xcuserdata

---------

Co-authored-by: Vince Grassia <593223+vgrassia@users.noreply.github.com>
Co-authored-by: Michał Chęciński <mchecinski@bitwarden.com>
Co-authored-by: Matt Bishop <mbishop@bitwarden.com>

apps/desktop/scripts/after-sign.js

@@ -15,36 +15,62 @@ async function run(context) {
   const appName = context.packager.appInfo.productFilename;
   const appPath = `${context.appOutDir}/${appName}.app`;
   const macBuild = context.electronPlatformName === "darwin";
-  const copyPlugIn = ["darwin", "mas"].includes(context.electronPlatformName);
+  const copySafariExtension = ["darwin", "mas"].includes(context.electronPlatformName);
+  const copyAutofillExtension = ["mas"].includes(context.electronPlatformName);
 
-  if (copyPlugIn) {
+  let shouldResign = false;
+
+  // cannot use extraFiles because it modifies the extensions .plist and makes it invalid
+  if (copyAutofillExtension) {
+    console.log("### Copying autofill extension");
+    const extensionPath = path.join(__dirname, "../macos/dist/autofill-extension.appex");
+    if (!fse.existsSync(extensionPath)) {
+      console.log("### Autofill extension not found - skipping");
+    } else {
+      if (!fse.existsSync(path.join(appPath, "Contents/PlugIns"))) {
+        fse.mkdirSync(path.join(appPath, "Contents/PlugIns"));
+      }
+      fse.copySync(extensionPath, path.join(appPath, "Contents/PlugIns/autofill-extension.appex"));
+      shouldResign = true;
+    }
+  }
+
+  if (copySafariExtension) {
+    console.log("### Copying safari extension");
     // Copy Safari plugin to work-around https://github.com/electron-userland/electron-builder/issues/5552
     const plugIn = path.join(__dirname, "../PlugIns");
-    if (fse.existsSync(plugIn)) {
-      fse.mkdirSync(path.join(appPath, "Contents/PlugIns"));
+    if (!fse.existsSync(plugIn)) {
+      console.log("### Safari extension not found - skipping");
+    } else {
+      if (!fse.existsSync(path.join(appPath, "Contents/PlugIns"))) {
+        fse.mkdirSync(path.join(appPath, "Contents/PlugIns"));
+      }
       fse.copySync(
         path.join(plugIn, "safari.appex"),
         path.join(appPath, "Contents/PlugIns/safari.appex"),
       );
+      shouldResign = true;
+    }
+  }
 
-      // Resign to sign safari extension
-      if (context.electronPlatformName === "mas") {
-        const masBuildOptions = deepAssign(
-          {},
-          context.packager.platformSpecificBuildOptions,
-          context.packager.config.mas,
-        );
-        if (context.targets.some((e) => e.name === "mas-dev")) {
-          deepAssign(masBuildOptions, {
-            type: "development",
-          });
-        }
-        if (context.packager.packagerOptions.prepackaged == null) {
-          await context.packager.sign(appPath, context.appOutDir, masBuildOptions, context.arch);
-        }
-      } else {
-        await context.packager.signApp(context, true);
+  if (shouldResign) {
+    // Resign to sign safari extension
+    if (context.electronPlatformName === "mas") {
+      const masBuildOptions = deepAssign(
+        {},
+        context.packager.platformSpecificBuildOptions,
+        context.packager.config.mas,
+      );
+      if (context.targets.some((e) => e.name === "mas-dev")) {
+        deepAssign(masBuildOptions, {
+          type: "development",
+        });
       }
+      if (context.packager.packagerOptions.prepackaged == null) {
+        await context.packager.sign(appPath, context.appOutDir, masBuildOptions, context.arch);
+      }
+    } else {
+      await context.packager.signApp(context, true);
     }
   }
 

apps/desktop/scripts/build-macos-extension.js

@@ -0,0 +1,62 @@
+/* eslint-disable @typescript-eslint/no-var-requires, no-console */
+const child = require("child_process");
+const { exit } = require("process");
+
+const fse = require("fs-extra");
+
+const paths = {
+  macosBuild: "./macos/build",
+  extensionBuild: "./macos/build/Release/autofill-extension.appex",
+  extensionDistDir: "./macos/dist",
+  extensionDist: "./macos/dist/autofill-extension.appex",
+  macOsProject: "./macos/desktop.xcodeproj",
+  macOsConfig: "./macos/production.xcconfig",
+};
+
+async function buildMacOs() {
+  if (fse.existsSync(paths.macosBuild)) {
+    fse.removeSync(paths.macosBuild);
+  }
+
+  if (fse.existsSync(paths.extensionDistDir)) {
+    fse.removeSync(paths.extensionDistDir);
+  }
+
+  const proc = child.spawn("xcodebuild", [
+    "-project",
+    paths.macOsProject,
+    "-alltargets",
+    "-configuration",
+    "Release",
+    "-xcconfig",
+    paths.macOsConfig,
+  ]);
+  stdOutProc(proc);
+  await new Promise((resolve, reject) =>
+    proc.on("close", (code) => {
+      if (code > 0) {
+        console.error("xcodebuild failed with code", code);
+        return reject(new Error(`xcodebuild failed with code ${code}`));
+      }
+      console.log("xcodebuild success");
+      resolve();
+    }),
+  );
+
+  fse.mkdirSync(paths.extensionDistDir);
+  fse.copySync(paths.extensionBuild, paths.extensionDist);
+  // Delete the build dir, otherwise MacOS will load the extension from there instead of the Bitwarden.app bundle
+  fse.removeSync(paths.macosBuild);
+}
+
+function stdOutProc(proc) {
+  proc.stdout.on("data", (data) => console.log(data.toString()));
+  proc.stderr.on("data", (data) => console.error(data.toString()));
+}
+
+buildMacOs()
+  .then(() => console.log("macOS build complete"))
+  .catch((err) => {
+    console.error("macOS build failed", err);
+    exit(-1);
+  });