Support for alpha build channel

scripts/prepare_alpha_build.js

@@ -0,0 +1,78 @@
+// Copyright 2021 Signal Messenger, LLC
+// SPDX-License-Identifier: AGPL-3.0-only
+
+/* eslint-disable no-console */
+
+const fs = require('fs');
+const _ = require('lodash');
+
+const packageJson = require('../package.json');
+const { isAlpha } = require('../ts/util/version');
+
+const { version } = packageJson;
+
+// You might be wondering why this file is necessary. It comes down to our desire to allow
+//   side-by-side installation of production and alpha builds. Electron-Builder uses
+//   top-level data from package.json for many things, like the executable name, the
+//   debian package name, the install directory under /opt on linux, etc. We tried
+//   adding the ${channel} macro to these values, but Electron-Builder didn't like that.
+
+if (!isAlpha(version)) {
+  process.exit();
+}
+
+console.log('prepare_alpha_build: updating package.json');
+
+// -------
+
+const NAME_PATH = 'name';
+const PRODUCTION_NAME = 'signal-desktop';
+const ALPHA_NAME = 'signal-desktop-alpha';
+
+const PRODUCT_NAME_PATH = 'productName';
+const PRODUCTION_PRODUCT_NAME = 'Signal';
+const ALPHA_PRODUCT_NAME = 'Signal Alpha';
+
+const APP_ID_PATH = 'build.appId';
+const PRODUCTION_APP_ID = 'org.whispersystems.signal-desktop';
+const ALPHA_APP_ID = 'org.whispersystems.signal-desktop-alpha';
+
+const STARTUP_WM_CLASS_PATH = 'build.linux.desktop.StartupWMClass';
+const PRODUCTION_STARTUP_WM_CLASS = 'Signal';
+const ALPHA_STARTUP_WM_CLASS = 'Signal Alpha';
+
+const DESKTOP_NAME_PATH = 'desktopName';
+
+// Note: we're avoiding dashes in our .desktop name due to xdg-settings behavior
+//   https://github.com/signalapp/Signal-Desktop/issues/3602
+const PRODUCTION_DESKTOP_NAME = 'signal.desktop';
+const ALPHA_DESKTOP_NAME = 'signalalpha.desktop';
+
+// -------
+
+function checkValue(object, objectPath, expected) {
+  const actual = _.get(object, objectPath);
+  if (actual !== expected) {
+    throw new Error(`${objectPath} was ${actual}; expected ${expected}`);
+  }
+}
+
+// ------
+
+checkValue(packageJson, NAME_PATH, PRODUCTION_NAME);
+checkValue(packageJson, PRODUCT_NAME_PATH, PRODUCTION_PRODUCT_NAME);
+checkValue(packageJson, APP_ID_PATH, PRODUCTION_APP_ID);
+checkValue(packageJson, STARTUP_WM_CLASS_PATH, PRODUCTION_STARTUP_WM_CLASS);
+checkValue(packageJson, DESKTOP_NAME_PATH, PRODUCTION_DESKTOP_NAME);
+
+// -------
+
+_.set(packageJson, NAME_PATH, ALPHA_NAME);
+_.set(packageJson, PRODUCT_NAME_PATH, ALPHA_PRODUCT_NAME);
+_.set(packageJson, APP_ID_PATH, ALPHA_APP_ID);
+_.set(packageJson, STARTUP_WM_CLASS_PATH, ALPHA_STARTUP_WM_CLASS);
+_.set(packageJson, DESKTOP_NAME_PATH, ALPHA_DESKTOP_NAME);
+
+// -------
+
+fs.writeFileSync('./package.json', JSON.stringify(packageJson, null, '  '));

scripts/prepare_alpha_version.js

@@ -0,0 +1,33 @@
+// Copyright 2021 Signal Messenger, LLC
+// SPDX-License-Identifier: AGPL-3.0-only
+
+/* eslint-disable no-console */
+
+const fs = require('fs');
+const { execSync } = require('child_process');
+
+const _ = require('lodash');
+
+const { generateAlphaVersion } = require('../ts/util/version');
+
+const packageJson = require('../package.json');
+
+const { version: currentVersion } = packageJson;
+
+const shortSha = execSync('git rev-parse --short HEAD')
+  .toString('utf8')
+  .replace(/[\n\r]/g, '');
+
+const alphaVersion = generateAlphaVersion({ currentVersion, shortSha });
+
+console.log(
+  `prepare_alpha_version: updating package.json.\n  Previous: ${currentVersion}\n  New:      ${alphaVersion}`
+);
+
+// -------
+
+_.set(packageJson, 'version', alphaVersion);
+
+// -------
+
+fs.writeFileSync('./package.json', JSON.stringify(packageJson, null, '  '));

scripts/prepare_beta_build.js

@@ -0,0 +1,78 @@
+// Copyright 2018-2020 Signal Messenger, LLC
+// SPDX-License-Identifier: AGPL-3.0-only
+
+/* eslint-disable no-console */
+
+const fs = require('fs');
+const _ = require('lodash');
+
+const packageJson = require('../package.json');
+const { isBeta } = require('../ts/util/version');
+
+const { version } = packageJson;
+
+// You might be wondering why this file is necessary. It comes down to our desire to allow
+//   side-by-side installation of production and beta builds. Electron-Builder uses
+//   top-level data from package.json for many things, like the executable name, the
+//   debian package name, the install directory under /opt on linux, etc. We tried
+//   adding the ${channel} macro to these values, but Electron-Builder didn't like that.
+
+if (!isBeta(version)) {
+  process.exit();
+}
+
+console.log('prepare_beta_build: updating package.json');
+
+// -------
+
+const NAME_PATH = 'name';
+const PRODUCTION_NAME = 'signal-desktop';
+const BETA_NAME = 'signal-desktop-beta';
+
+const PRODUCT_NAME_PATH = 'productName';
+const PRODUCTION_PRODUCT_NAME = 'Signal';
+const BETA_PRODUCT_NAME = 'Signal Beta';
+
+const APP_ID_PATH = 'build.appId';
+const PRODUCTION_APP_ID = 'org.whispersystems.signal-desktop';
+const BETA_APP_ID = 'org.whispersystems.signal-desktop-beta';
+
+const STARTUP_WM_CLASS_PATH = 'build.linux.desktop.StartupWMClass';
+const PRODUCTION_STARTUP_WM_CLASS = 'Signal';
+const BETA_STARTUP_WM_CLASS = 'Signal Beta';
+
+const DESKTOP_NAME_PATH = 'desktopName';
+
+// Note: we're avoiding dashes in our .desktop name due to xdg-settings behavior
+//   https://github.com/signalapp/Signal-Desktop/issues/3602
+const PRODUCTION_DESKTOP_NAME = 'signal.desktop';
+const BETA_DESKTOP_NAME = 'signalbeta.desktop';
+
+// -------
+
+function checkValue(object, objectPath, expected) {
+  const actual = _.get(object, objectPath);
+  if (actual !== expected) {
+    throw new Error(`${objectPath} was ${actual}; expected ${expected}`);
+  }
+}
+
+// ------
+
+checkValue(packageJson, NAME_PATH, PRODUCTION_NAME);
+checkValue(packageJson, PRODUCT_NAME_PATH, PRODUCTION_PRODUCT_NAME);
+checkValue(packageJson, APP_ID_PATH, PRODUCTION_APP_ID);
+checkValue(packageJson, STARTUP_WM_CLASS_PATH, PRODUCTION_STARTUP_WM_CLASS);
+checkValue(packageJson, DESKTOP_NAME_PATH, PRODUCTION_DESKTOP_NAME);
+
+// -------
+
+_.set(packageJson, NAME_PATH, BETA_NAME);
+_.set(packageJson, PRODUCT_NAME_PATH, BETA_PRODUCT_NAME);
+_.set(packageJson, APP_ID_PATH, BETA_APP_ID);
+_.set(packageJson, STARTUP_WM_CLASS_PATH, BETA_STARTUP_WM_CLASS);
+_.set(packageJson, DESKTOP_NAME_PATH, BETA_DESKTOP_NAME);
+
+// -------
+
+fs.writeFileSync('./package.json', JSON.stringify(packageJson, null, '  '));

scripts/prepare_windows_cert.js

@@ -0,0 +1,50 @@
+// Copyright 2018-2020 Signal Messenger, LLC
+// SPDX-License-Identifier: AGPL-3.0-only
+
+/* eslint-disable no-console */
+
+const fs = require('fs');
+const _ = require('lodash');
+
+const packageJson = require('../package.json');
+
+// We have different windows certificates used in each of our build machines, and this
+//   script makes it easier to ready the app to build on a given machine.
+
+// -------
+
+const KEY = 'build.win.certificateSha1';
+const DEFAULT_VALUE = '8C9A0B5C852EC703D83EF7BFBCEB54B796073759';
+
+const BUILDER_A = '507769334DA990A8DDE858314B0CDFC228E7CFA1';
+const BUILDER_B = 'C689B0988CA1A7DF99E4CE4433AC7EA8B82F8D41';
+
+let targetValue = DEFAULT_VALUE;
+
+if (process.env.WINDOWS_BUILDER === 'A') {
+  targetValue = BUILDER_A;
+}
+if (process.env.WINDOWS_BUILDER === 'B') {
+  targetValue = BUILDER_B;
+}
+
+// -------
+
+function checkValue(object, objectPath, expected) {
+  const actual = _.get(object, objectPath);
+  if (actual !== expected) {
+    throw new Error(`${objectPath} was ${actual}; expected ${expected}`);
+  }
+}
+
+// ------
+
+checkValue(packageJson, KEY, DEFAULT_VALUE);
+
+// -------
+
+_.set(packageJson, KEY, targetValue);
+
+// -------
+
+fs.writeFileSync('./package.json', JSON.stringify(packageJson, null, '  '));