(WIP) feat: staging release setup

.env.example

@@ -1,4 +1,5 @@
 FORK_URL=
 NODE_ENV=
+DEV_RPC=
 STAKING_TEST_KEYS_PATH=
-DEV_RPC=
+IS_STAGING=

.github/workflows/release.yml

@@ -63,6 +63,7 @@ jobs:
                 env: 
                     NODE_ENV: production
                     DEV_RPC: https://rpc-gate.autonolas.tech/gnosis-rpc/
+                    IS_STAGING: ${{ contains(github.ref, 'staging') }}
                     FORK_URL: https://rpc-gate.autonolas.tech/gnosis-rpc/
             - run: rm -rf /dist
             - name: "Build, notarize, publish"

build.js

@@ -1,6 +1,6 @@
 const dotenv = require('dotenv');
 const build = require('electron-builder').build;
-const {publishOptions} = require('./electron/constants/publishOptions');
+const { publishOptions } = require('./electron/constants/publishOptions');
 
 dotenv.config();
 
@@ -24,7 +24,7 @@ const main = async () => {
         target: [
           {
             target: 'default',
-            arch: ['x64','arm64'],
+            arch: ['x64', 'arm64'],
           },
         ],
         publish: publishOptions,
@@ -35,11 +35,11 @@ const main = async () => {
         entitlements: 'electron/entitlements.mac.plist',
         entitlementsInherit: 'electron/entitlements.mac.plist',
         notarize: {
-          teamId: process.env.APPLETEAMID
+          teamId: process.env.APPLETEAMID,
         },
       },
     },
   });
 };
 
-main().then((response) => { console.log('Build & Notarize complete'); }).catch((e) => console.error(e));
+main().then((response) => { console.log('Build & Notarize complete'); }).catch((e) => console.error(e));

electron/constants/publishOptions.js

@@ -2,10 +2,10 @@ const publishOptions = {
   provider: 'github',
   owner: 'valory-xyz',
   repo: 'olas-operate-app',
-  releaseType: 'release',
   token: process.env.GH_TOKEN,
   private: false,
   publishAutoUpdate: true,
+  releaseType: 'draft',
 };
 
 module.exports = { publishOptions };

electron/install.js

@@ -7,7 +7,12 @@ const process = require('process');
 const { spawnSync } = require('child_process');
 const Docker = require('dockerode');
 
-const Version = '0.1.0rc26';
+/**
+ * current version of the pearl release
+ * - use "" (nothing as a suffix) for latest release candidate, for example "0.1.0rc26"
+ * - use "alpha" for alpha release, for example "0.1.0rc26-alpha"
+ */
+const OlasMiddlewareVersion = '0.1.0rc26';
 const OperateDirectory = `${os.homedir()}/.operate`;
 const VenvDir = `${OperateDirectory}/venv`;
 const VersionFile = `${OperateDirectory}/version.txt`;
@@ -46,7 +51,7 @@ function appendLog(log) {
 function runCmdUnix(command, options) {
   fs.appendFileSync(
     OperateInstallationLog,
-    `Runninng ${command} with options ${JSON.stringify(options)}`,
+    `Running ${command} with options ${JSON.stringify(options)}`,
     { encoding: 'utf-8' },
   );
   let bin = getBinPath(command);
@@ -78,7 +83,7 @@ function runSudoUnix(command, options) {
   if (!bin) {
     throw new Error(`Command ${command} not found`);
   }
-  return new Promise(function (resolve, reject) {
+  return new Promise(function (resolve, _reject) {
     sudo.exec(
       `${bin} ${options}`,
       SudoOptions,
@@ -157,7 +162,7 @@ function installOperatePackageUnix(path) {
     '-m',
     'pip',
     'install',
-    `olas-operate-middleware==${Version}`,
+    `olas-operate-middleware==${OlasMiddlewareVersion}`,
   ]);
 }
 
@@ -167,7 +172,7 @@ function reInstallOperatePackageUnix(path) {
     '-m',
     'pip',
     'install',
-    `olas-operate-middleware==${Version}`,
+    `olas-operate-middleware==${OlasMiddlewareVersion}`,
     '--force-reinstall',
   ]);
 }
@@ -177,11 +182,11 @@ function installOperateCli(path) {
   if (fs.existsSync(installPath)) {
     fs.rmSync(installPath);
   }
-  return new Promise((resolve, reject) => {
+  return new Promise((resolve, _reject) => {
     fs.copyFile(
       `${OperateDirectory}/venv/bin/operate`,
       installPath,
-      function (error, stdout, stderr) {
+      function (error, _stdout, _stderr) {
         resolve(!error);
       },
     );
@@ -192,23 +197,23 @@ function createDirectory(path) {
   if (fs.existsSync(path)) {
     return;
   }
-  return new Promise((resolve, reject) => {
+  return new Promise((resolve, _reject) => {
     fs.mkdir(path, { recursive: true }, (error) => {
       resolve(!error);
     });
   });
 }
 
 function writeVersion() {
-  fs.writeFileSync(VersionFile, Version);
+  fs.writeFileSync(VersionFile, OlasMiddlewareVersion);
 }
 
 function versionBumpRequired() {
   if (!fs.existsSync(VersionFile)) {
     return true;
   }
-  const version = fs.readFileSync(VersionFile).toString();
-  return version != Version;
+  const olasMiddlewareVersionInFile = fs.readFileSync(VersionFile).toString();
+  return olasMiddlewareVersionInFile != OlasMiddlewareVersion;
 }
 
 function removeLogFile() {
@@ -265,7 +270,9 @@ async function setupDarwin(ipcChannel) {
 
   console.log(appendLog('Checking if upgrade is required'));
   if (versionBumpRequired()) {
-    console.log(appendLog(`Upgrading pearl daemon to ${Version}`));
+    console.log(
+      appendLog(`Upgrading pearl daemon to ${OlasMiddlewareVersion}`),
+    );
     reInstallOperatePackageUnix(OperateDirectory);
     writeVersion();
     removeLogFile();
@@ -322,7 +329,9 @@ async function setupUbuntu(ipcChannel) {
 
   console.log(appendLog('Checking if upgrade is required'));
   if (versionBumpRequired()) {
-    console.log(appendLog(`Upgrading pearl daemon to ${Version}`));
+    console.log(
+      appendLog(`Upgrading pearl daemon to ${OlasMiddlewareVersion}`),
+    );
     reInstallOperatePackageUnix(OperateDirectory);
     writeVersion();
     removeLogFile();

electron/main.js

@@ -256,7 +256,10 @@ const createMainWindow = () => {
     mainWindow.hide();
   });
 
-  setupStoreIpc(ipcMain, mainWindow);
+  const storeInitialValues = {
+    environmentName: process.env.IS_STAGING ? 'staging' : '',
+  };
+  setupStoreIpc(ipcMain, mainWindow, storeInitialValues);
 
   if (isDev) {
     mainWindow.webContents.openDevTools();

electron/store.js

@@ -1,27 +1,25 @@
 // set schema to validate store data
-const schema = {
-  isInitialFunded: {
-    type: 'boolean',
-    default: false,
-  },
-  firstStakingRewardAchieved: {
-    type: 'boolean',
-    default: false,
-  },
-  firstRewardNotificationShown: {
-    type: 'boolean',
-    default: false,
-  },
+const defaultSchema = {
+  environmentName: { type: 'string', default: '' },
+  isInitialFunded: { type: 'boolean', default: false },
+  firstStakingRewardAchieved: { type: 'boolean', default: false },
+  firstRewardNotificationShown: { type: 'boolean', default: false },
 };
 
-const setupStoreIpc = async (ipcChannel, mainWindow) => {
+const setupStoreIpc = async (ipcChannel, mainWindow, storeInitialValues) => {
   const Store = (await import('electron-store')).default;
 
-  /** @type import Store from 'electron-store' */
-  const store = new Store({
-    schema,
+  // set default values for store
+  const schema = Object.assign({}, defaultSchema);
+  Object.keys(schema).forEach((key) => {
+    if (storeInitialValues[key] !== undefined) {
+      schema[key].default = storeInitialValues[key];
+    }
   });
 
+  /** @type import Store from 'electron-store' */
+  const store = new Store({ schema });
+
   store.onDidAnyChange((data) => {
     if (mainWindow?.webContents)
       mainWindow.webContents.send('store-changed', data);

electron/update.js

@@ -4,14 +4,12 @@ const electronLogger = require('electron-log');
 
 const macUpdater = new electronUpdater.MacUpdater({
   ...publishOptions,
-  private: false,
+  channels: ['latest', 'beta', 'alpha'], // automatically update to all channels
 });
 
 macUpdater.logger = electronLogger;
 
-macUpdater.setFeedURL({
-  ...publishOptions,
-});
+macUpdater.setFeedURL({ ...publishOptions });
 
 macUpdater.autoDownload = true;
 macUpdater.autoInstallOnAppQuit = true;

frontend/components/Layout/TopBar.tsx

@@ -3,6 +3,7 @@ import styled from 'styled-components';
 
 import { COLOR } from '@/constants';
 import { useElectronApi } from '@/hooks/useElectronApi';
+import { useStore } from '@/hooks/useStore';
 
 const { Text } = Typography;
 
@@ -48,6 +49,9 @@ const TopBarContainer = styled.div`
 
 export const TopBar = () => {
   const electronApi = useElectronApi();
+  const store = useStore();
+  const envName = store?.storeState?.environmentName;
+
   return (
     <TopBarContainer>
       <TrafficLights>
@@ -56,7 +60,7 @@ export const TopBar = () => {
         <DisabledLight />
       </TrafficLights>
 
-      <Text>Pearl (alpha)</Text>
+      <Text>{`Pearl (alpha) ${envName ? `(${envName})` : ''}`.trim()}</Text>
     </TopBarContainer>
   );
 };

frontend/types/ElectronApi.ts

@@ -1,4 +1,5 @@
 export type ElectronStore = {
+  environmentName?: string;
   isInitialFunded?: boolean;
   firstStakingRewardAchieved?: boolean;
   firstRewardNotificationShown?: boolean;

package.json

@@ -1,5 +1,10 @@
 {
   "author": "Valory AG",
+  "main": "electron/main.js",
+  "name": "olas-operate-app",
+  "productName": "Pearl",
+  "private": true,
+  "version": "0.1.0-rc26",
   "dependencies": {
     "@ant-design/cssinjs": "^1.18.4",
     "@ant-design/icons": "^5.3.0",
@@ -36,10 +41,6 @@
     "net": "^1.0.2",
     "prettier": "^3.2.5"
   },
-  "main": "electron/main.js",
-  "name": "olas-operate-app",
-  "productName": "Pearl",
-  "private": true,
   "scripts": {
     "build:frontend": "cd frontend && yarn build && rm -rf ../electron/.next && cp -r .next ../electron/.next && rm -rf ../electron/public && cp -r public ../electron/public",
     "dev:backend": "poetry run python operate/cli.py",
@@ -53,6 +54,5 @@
     "test:frontend": "cd frontend && yarn test",
     "start": "electron .",
     "build": "rm -rf dist/ && electron-builder build"
-  },
-  "version": "0.1.0-rc26"
+  }
 }