chore(manager): cleanup and fix Manager build (Jigsaw-Code#1497)

src/server_manager/electron_app/build.action.sh

@@ -13,10 +13,13 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-set -eux
+set -eu
+
+# Electron app root folder
+readonly STATIC_DIR="${BUILD_DIR}/server_manager/electron_app/static"
+rm -rf "${STATIC_DIR}"
+mkdir -p "${STATIC_DIR}"
 
-PLATFORM=$1
-STAGING_PERCENTAGE=100
 VERSION_NAME='0.0.0-debug'
 BUILD_MODE=debug
 for i in "$@"; do
@@ -29,10 +32,6 @@ for i in "$@"; do
     VERSION_NAME="${i#*=}"
     shift
     ;;
-  --stagingPercentage=*)
-    STAGING_PERCENTAGE="${i#*=}"
-    shift
-    ;;
   --* | -*)
     echo "Unknown option: ${i}"
     exit 1
@@ -41,29 +40,28 @@ for i in "$@"; do
   esac
 done
 
-readonly OUT_DIR="${BUILD_DIR}/server_manager/electron_app"
-rm -rf "${OUT_DIR}"
-
-# Electron app root folder
-readonly STATIC_DIR="${OUT_DIR}/static"
-mkdir -p "${STATIC_DIR}"
+if [[ -z "${WEBPACK_MODE:-}" ]]; then
+  case "${BUILD_MODE}" in
+    release)
+      export WEBPACK_MODE="production";;
+    *)
+      export WEBPACK_MODE="development";;
+  esac
+fi
 
 # Build the Web App.
 run_action server_manager/web_app/build
 
 # Compile the Electron main process and preload to the app root folder.
 # Since Node.js on Cygwin doesn't like absolute Unix-style paths,
 # we'll use relative paths here.
-webpack --config=src/server_manager/electron_main.webpack.mjs ${BUILD_ENV:+--mode=${BUILD_ENV}}
-webpack --config=src/server_manager/electron_preload.webpack.mjs ${BUILD_ENV:+--mode=${BUILD_ENV}}
+webpack --config=src/server_manager/electron_main.webpack.mjs ${WEBPACK_MODE:+--mode=${WEBPACK_MODE}}
+webpack --config=src/server_manager/electron_preload.webpack.mjs ${WEBPACK_MODE:+--mode=${WEBPACK_MODE}}
 
 # Assemble everything together.
 mkdir -p "${STATIC_DIR}/server_manager"
 cp -r "${BUILD_DIR}/server_manager/web_app/static" "${STATIC_DIR}/server_manager/web_app/"
 
-# TODO(fortuna): Separate the build of Electron main and the Electron package.
-# Building the package significantly delays the start action.
-
 # Electron requires a package.json file for the app's name, etc.
 # We also need to install NPMs at this location for require()
 # in order for require() to work right in the renderer process, which
@@ -76,9 +74,3 @@ npm ci --prod --ignore-scripts
 # Icons.
 cd "${ROOT_DIR}"
 electron-icon-maker --input=src/server_manager/images/launcher-icon.png --output=build/server_manager/electron_app/static
-
-# TODO(daniellacosse): refactor these scripts into node so we can call the electron builder there directly
-# shellcheck disable=SC2046
-electron-builder $(node src/server_manager/scripts/get_electron_build_flags.mjs "${PLATFORM}" --buildMode "${BUILD_MODE}")
-
-src/server_manager/scripts/finish_info_files.sh "${PLATFORM}" "${STAGING_PERCENTAGE}"

src/server_manager/electron_app/package.action.sh

@@ -0,0 +1,103 @@
+#!/bin/bash -eu
+#
+# Copyright 2024 The Outline Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+set -eu
+
+SCRIPT_DIR="$(dirname "$0")"
+PROJECT_DIR="${BUILD_DIR}/server_manager/electron_app/static"
+BUILD_MODE=debug
+PLATFORM= 
+
+function package_electron() {
+  declare -a electron_builder_cmd=(
+    electron-builder
+    --projectDir="${PROJECT_DIR}"
+    --config="${SCRIPT_DIR}/electron_builder.json"
+    --publish=never
+  )
+
+  case "${PLATFORM}" in
+    linux)
+      electron_builder_cmd+=(--linux);;
+    windows)
+      electron_builder_cmd+=(--win --ia32);;
+    macos)
+      electron_builder_cmd+=(--mac);;
+    *)
+      echo "Unsupported platform ${PLATFORM}" >&2 && exit 1
+  esac
+
+  if [[ "${BUILD_MODE}" == "release" ]]; then
+    electron_builder_cmd+=(
+      --config.generateUpdatesFilesForAllChannels=true
+      --config.publish.provider=generic
+      --config.publish.url=https://s3.amazonaws.com/outline-releases/manager/
+    )
+  fi
+
+  "${electron_builder_cmd[@]}"
+}
+
+function finish_yaml_files() {
+  declare -r staging_percentage="${1?Staging percentage missing}"
+
+  local release_channel
+  release_channel=$(node_modules/node-jq/bin/jq -r '.version' src/server_manager/package.json | cut -s -d'-' -f2)
+  # If this isn't an alpha or beta build, `cut -s` will return an empty string
+  if [[ -z "${release_channel}" ]]; then
+    release_channel=latest
+  fi
+  echo "stagingPercentage: ${staging_percentage}" >> "${PROJECT_DIR}/dist/${release_channel}${PLATFORM}.yml"
+
+  # If we cut a staged mainline release, beta testers will take the update as well.
+  if [[ "${release_channel}" == "latest" ]]; then
+    echo "stagingPercentage: ${staging_percentage}" >> "${PROJECT_DIR}/dist/beta${PLATFORM}.yml"
+  fi
+
+  # We don't support alpha releases
+  rm -f "${PROJECT_DIR}/dist/alpha${PLATFORM}.yml"
+}
+
+function main() {
+  declare staging_percentage=100
+  declare version_name='0.0.0-debug'
+  for i in "$@"; do
+    case "${i}" in
+    --buildMode=*)
+      BUILD_MODE="${i#*=}"
+      shift
+      ;;
+    --versionName=*)
+      version_name="${i#*=}"
+      shift
+      ;;
+    --stagingPercentage=*)
+      staging_percentage="${i#*=}"
+      shift
+      ;;
+    --* | -*)
+      echo "Unknown option: ${i}"
+      exit 1
+      ;;
+    *) ;;
+    esac
+  done
+  PLATFORM="${1?Platform missing}"
+  run_action server_manager/electron_app/build --buildMode="${BUILD_MODE}" --versionName="${version_name}"
+  package_electron
+  finish_yaml_files "${staging_percentage}"
+}
+
+main "$@"

src/server_manager/electron_app/start.action.sh

@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-run_action server_manager/electron_app/build "$1"
+run_action server_manager/electron_app/build "$@"
 
 cd "${BUILD_DIR}/server_manager/electron_app/static"