Upgrade Cerebro core update packages and improve project build (#559)

* fix: removeNoise function not working correctly * style: fix linter errors * chore(deps): use exact dependencies * CI: try build gh action * ci: fix gh token * ci: fix repo * chore: small refactor * chore: rm deprecated proptypes - use prop-types * chore: small refactor * fix: can not read getPrimarydisplay of undefined * chore: update electron to v19 * chore: update deps * chore: update deps * chore: use new electron whenReady * chore: lint webpack configs * CI: delete unused files * CI: run on workflow dispatch * chore: update dev deps * chore: update deps * deps: update url-loader * chore: fix plugin installation errors chore: move to rimraf * chore: fix building errors * CI: run scripts in parallel * chore: update babel * chore: update webpack dev middleware * chore: update cross-env * chore: update redux * chore: update linter config * fix: quit app not working * chore: remove unused code * fix: remote module in background window * chore: update deps, autoinstall app deps * docs: update readme * chore: minor fixes * docs: two package.json msg + delete broken links * ci: update workflows, work when tags pushed * ci: test CI * chore: fix babel target * CI: test new release * CI: test on release * CI: run on gh release * Update build.yml * Update build.yml * docs: update release configuration * docs: target info * docs: how to publish a release * CI: run on git tags * chore: move to @cerebroapp/cerebro-ui * chore: add @cerebroapp/cerebro-ui dependency * feat: support @cerebroapp in plugin names * fix: handle @cerebroapp directory * chore: refactor promises * chore: small refactor * chore: fix tests script * CI: add tests to publish workflow * chore: adjusting json package description and version * chore: add new rule in eslint * doc: update readme * feat: add template string * refactor: fix lint problems * chore: remove comments Co-authored-by: oguhpereira <[email protected]>
cerebroapp · Jul 21, 2022 · eaa59bf · eaa59bf
1 parent 606a1ba
commit eaa59bf
Show file tree

Hide file tree

Showing 80 changed files with 5,216 additions and 5,242 deletions.
diff --git a/.babelrc b/.babelrc
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,5 +1,5 @@
 {
-  "parser": "babel-eslint",
+  "parser": "@babel/eslint-parser",
   "extends": "airbnb",
   "env": {
     "browser": true,
@@ -16,6 +16,7 @@
     "no-useless-escape": 0,
     "no-mixed-operators": "off",
     "no-continue": "off",
+    "no-unused-expressions": ["error", { "allowShortCircuit": true, "allowTernary": true }],
     "import/no-extraneous-dependencies": "off",
     "import/imports-first": "off",
     "import/extensions": "off",
@@ -32,7 +33,8 @@
     "prefer-spread": "off",
     "class-methods-use-this": "off",
     "jsx-a11y/no-static-element-interactions": "off",
-    "jsx-a11y/label-has-for": "off"
+    "jsx-a11y/label-has-for": "off",
+    "linebreak-style": 0
   },
   "plugins": [
     "jsx-a11y",
@@ -43,8 +45,8 @@
   "settings": {
     "import/core-modules": "electron",
     "import/resolver": {
-      "webpack": {
-        "config": "../webpack.config.base.js"
+      "node": {
+        "paths": ["app"]
       }
     }
   }

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,41 @@
+name: Build/release
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+        - uses: actions/checkout@v3
+        - name: Use Node.js 16
+          uses: actions/setup-node@v3
+          with:
+            node-version: 16
+        - run: yarn
+        - run: yarn test --detectOpenHandles --forceExit
+
+  release:
+    needs: test
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v3
+
+      - name: Install Node.js, NPM and Yarn
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - name: Build & Release Electron app
+        uses: samuelmeuli/action-electron-builder@v1
+        with:
+          github_token: ${{ secrets.github_token }}
+          release: true
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -46,19 +46,26 @@ First, clone the repo via git:
 ```bash
 $ git clone https://github.com/cerebroapp/cerebro.git cerebro
 ```
+Open the project
+
+```bash
+$ cd cerebro
+```
 
 And then install dependencies:
 
+
 ```bash
-$ cd cerebro && yarn && cd ./app && yarn && cd ../
+yarn
 ```
 
 ### Run
+
 ```bash
 $ yarn run dev
 ```
 
-> Note: requires a node version >=6.x
+> Note: requires a node version >=16.x
 
 ### Resolve common issues
 1. `AssertionError: Current node version is not supported for development` on npm postinstall.
@@ -90,19 +97,26 @@ Use this command to build `.app` file:
 $ yarn build
 ```
 
+## For developers
+
+### Publish a release
 
-## Be in touch
-Follow to be notified about new releases or learn some productivity tips with Cerebro:
+CerebroApp is using GH actions to build the app and publish it to a release. To publish a new release follow the steps below:
 
-* [Twitter](https://twitter.com/cerebro_app)
-* [Facebook](https://www.facebook.com/cerebroapp)
-* [Google+](https://plus.google.com/104292436165594177472)
-* [VK.com](https://vk.com/cerebroapp) – channel in Russian
+1. Update the version on both `package.json` and `app/package.json` files.
+2. Create a release with from GH and publish it. 🚧 The release **tag** SHOULD NOT contain the `v` prefix (❌ `v0.1.2` → ✅`0.1.2`).
+3. Complete the name with a name and a description of the release.
+4. The GH action is triggered and the release is updated when executables are built.
 
-Or [subscribe to newsletter](http://eepurl.com/coiKU9) to be notified only about big releases.
+### Add dependencies
+
+CerebroApp was created from an [old version of electron-react-boilerplate](https://github.com/cerebroapp/cerebro/commit/57b6e28c0f64beae8948cf17f099fa5d6236ae3c) and uses a two package.json file structure. If you are interested in developing a new feature, you should read about this structure in the [electron-react-boilerplate documentation](https://www.electron.build/tutorials/two-package-structure.html).
+
+
+# Support
 
-## Support
 ### Backers
+
 Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/cerebro#backer)]
 
 <a href="https://opencollective.com/cerebro/backer/0/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/0/avatar.svg"></a>
@@ -171,4 +185,5 @@ Become a sponsor and get your logo on our README on Github with a link to your s
 <a href="https://opencollective.com/cerebro/sponsor/29/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/29/avatar.svg"></a>
 
 ## License
-MIT © [Alexandr Subbotin](https://github.com/KELiON)
+
+MIT © [Cerebro App](https://github.com/cerebroapp/cerebro/blob/master/LICENSE)
diff --git a/__mocks__/@electron/remote.js b/__mocks__/@electron/remote.js
@@ -0,0 +1,5 @@
+module.exports = {
+  app: {
+    getPath: jest.fn(),
+  }
+}
diff --git a/__mocks__/electron.js b/__mocks__/electron.js
@@ -0,0 +1,8 @@
+module.exports = {
+  app: {
+    getPath: jest.fn(),
+  },
+  ipcRenderer: {
+    on: jest.fn(),
+  }
+}
diff --git a/__mocks__/fileMock.js b/__mocks__/fileMock.js
@@ -0,0 +1 @@
+module.exports = ''
diff --git a/__mocks__/lib/config.js b/__mocks__/lib/config.js
diff --git a/__mocks__/lib/plugins.js b/__mocks__/lib/plugins.js
diff --git a/__mocks__/plugins.js b/__mocks__/plugins.js
diff --git a/app/background/background.js b/app/background/background.js
@@ -3,35 +3,35 @@ import ReactDOM from 'react-dom'
 import plugins from 'plugins'
 import { on, send } from 'lib/rpc'
 import { settings as pluginSettings, modulesDirectory } from 'lib/plugins'
+import fixPath from 'fix-path'
 
-require('fix-path')()
+fixPath()
 
 global.React = React
 global.ReactDOM = ReactDOM
 global.isBackground = true
 
 on('initializePluginAsync', ({ name }) => {
   console.group(`Initialize async plugin ${name}`)
+
   try {
     const { initializeAsync } = plugins[name]
       ? plugins[name]
       : window.require(`${modulesDirectory}/${name}`)
+
     if (!initializeAsync) {
       console.log('no `initializeAsync` function, skipped')
       return
     }
+
     console.log('running `initializeAsync`')
     initializeAsync((data) => {
       console.log('Done! Sending data back to main window')
       // Send message back to main window with initialization result
-      send('plugin.message', {
-        name,
-        data,
-      })
+      send('plugin.message', { name, data })
     }, pluginSettings.getUserSettings(name))
-  } catch (err) {
-    console.log('Failed', err)
-  }
+  } catch (err) { console.log('Failed', err) }
+
   console.groupEnd()
 })
 

diff --git a/app/background/createWindow.js b/app/background/createWindow.js
@@ -10,6 +10,7 @@ export default ({ src }) => {
       contextIsolation: false
     },
   })
+
   backgroundWindow.loadURL(src)
   return backgroundWindow
 }
diff --git a/app/background/index.html b/app/background/index.html
@@ -5,7 +5,9 @@
       (function() {
         const script = document.createElement('script');
         script.async = true;
-        script.src = (process.env.HOT) ? 'http://localhost:3000/dist/background.bundle.js' : '../dist/background.bundle.js';
+        script.src = (process.env.HOT)
+          ? 'http://localhost:3000/dist/background.bundle.js'
+          : '../dist/background.bundle.js';
         document.write(script.outerHTML);
       }());
     </script>

diff --git a/app/initAutoUpdater.js b/app/initAutoUpdater.js
@@ -1,11 +1,12 @@
-import * as os from "os";
-import { dialog, } from 'electron'
-import { autoUpdater } from "electron-updater";
+import { autoUpdater } from 'electron-updater'
 
 const event = 'update-downloaded'
 
+const TEN_SECONDS = 10 * 1000
+const ONE_HOUR = 60 * 60 * 1000
+
 export default (w) => {
-  if (process.env.NODE_ENV === 'development' || os.platform() === "linux") {
+  if (process.env.NODE_ENV === 'development' || process.platform === 'linux') {
     return
   }
 
@@ -18,9 +19,9 @@ export default (w) => {
 
   setTimeout(() => {
     autoUpdater.checkForUpdates()
-  }, 10 * 1000)
+  }, TEN_SECONDS)
 
   setInterval(() => {
     autoUpdater.checkForUpdates()
-  }, 60 * 60 * 1000)
-}
+  }, ONE_HOUR)
+}
diff --git a/app/lib/config.js b/app/lib/config.js
@@ -1,9 +1,13 @@
-import { app, remote, ipcRenderer } from 'electron'
+import { app, ipcRenderer } from 'electron'
 import fs from 'fs'
 import { memoize } from 'cerebro-tools'
 import { trackEvent } from './trackEvent'
 import loadThemes from './loadThemes'
 
+const remote = process.type === 'browser'
+  ? undefined
+  : require('@electron/remote')
+
 const electronApp = remote ? remote.app : app
 
 // initiate portable mode
@@ -55,13 +59,13 @@ const readConfig = () => {
  */
 const get = (key) => {
   let config
+
   if (!fs.existsSync(CONFIG_FILE)) {
     // Save default config to local storage
     config = defaultSettings()
     fs.writeFileSync(CONFIG_FILE, JSON.stringify(config, null, 2))
-  } else {
-    config = readConfig()
-  }
+  } else { config = readConfig() }
+
   return config[key]
 }
 
@@ -87,6 +91,7 @@ const set = (key, value) => {
     event: `Change ${key}`,
     label: value
   })
+
   if (ipcRenderer) {
     console.log('notify main process', key, value)
     // Notify main process about settings changes