Skip to content

Commit a98eb59

Browse files
authored
feat: remove sentry (ethersphere#368)
* build: update packages * chore: add type casts * chore: remove sentry * build: add open * chore: update depcheckrc
1 parent ac01891 commit a98eb59

File tree

15 files changed

+5958
-5092
lines changed

15 files changed

+5958
-5092
lines changed

.depcheckrc.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
"ts-node",
99
"concurrently",
1010
"cross-env",
11-
"cpy"
11+
"cpy",
12+
"open"
1213
]
1314
}

.github/workflows/assets.yml

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,6 @@ jobs:
1919
- name: Install all dependencies
2020
run: npm ci && cd ./ui && npm ci
2121

22-
- name: Configure secrets
23-
uses: jossef/action-set-json-field@v1
24-
with:
25-
file: src/.sentry.json
26-
field: KEY
27-
value: ${{ secrets.SENTRY_KEY }}
28-
2922
- name: Set MacOS signing certs
3023
run: .github/tools/add-macos-cert.sh
3124
env:
@@ -65,13 +58,6 @@ jobs:
6558
- name: Install dependencies
6659
run: npm ci && cd ./ui && npm ci
6760

68-
- name: Configure secrets
69-
uses: jossef/action-set-json-field@v1
70-
with:
71-
file: src/.sentry.json
72-
field: KEY
73-
value: ${{ secrets.SENTRY_KEY }}
74-
7561
- name: Set MacOS signing certs
7662
if: matrix.os == 'macos-latest'
7763
run: .github/tools/add-macos-cert.sh
@@ -90,8 +76,6 @@ jobs:
9076

9177
- name: Build
9278
run: npm run build
93-
env:
94-
REACT_APP_SENTRY_KEY: ${{ secrets.SENTRY_KEY_UI }}
9579

9680
- name: Copy dashboard lib
9781
run: cp ./ui/node_modules/@ethersphere/bee-dashboard/lib/* ./dist/ui/static/js
@@ -114,29 +98,3 @@ jobs:
11498
run: npm run publish:linux:arm64
11599
env:
116100
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
117-
118-
- name: Create Sentry release for Desktop
119-
if: matrix.os == 'ubuntu-latest'
120-
uses: getsentry/action-release@v1
121-
env:
122-
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
123-
SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
124-
SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
125-
with:
126-
ignore_missing: true
127-
ignore_empty: true
128-
sourcemaps: ./dist/desktop/src
129-
version: ${{ github.event.client_payload.version }}
130-
# TODO: https://github.com/ethersphere/swarm-desktop/issues/250
131-
# - name: Create Sentry release for UI
132-
# if: matrix.os == 'ubuntu-latest'
133-
# uses: getsentry/action-release@v1
134-
# env:
135-
# SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
136-
# SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
137-
# SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
138-
# with:
139-
# ignore_missing: true
140-
# ignore_empty: true
141-
# sourcemaps: ./dist/ui/static/js
142-
# version: ${{ github.event.client_payload.version }}

.github/workflows/pre-release.yml

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,6 @@ jobs:
4141
field: version
4242
value: ${{ github.event.inputs.version }}
4343

44-
- name: Configure secrets
45-
uses: jossef/action-set-json-field@v1
46-
with:
47-
file: src/.sentry.json
48-
field: KEY
49-
value: ${{ secrets.SENTRY_KEY }}
50-
5144
- name: Set MacOS signing certs
5245
run: .github/tools/add-macos-cert.sh
5346
env:
@@ -101,13 +94,6 @@ jobs:
10194
field: version
10295
value: ${{ github.event.inputs.version }}
10396

104-
- name: Configure secrets
105-
uses: jossef/action-set-json-field@v1
106-
with:
107-
file: src/.sentry.json
108-
field: KEY
109-
value: ${{ secrets.SENTRY_KEY }}
110-
11197
- name: Set MacOS signing certs
11298
if: matrix.os == 'macos-latest'
11399
run: .github/tools/add-macos-cert.sh
@@ -126,9 +112,6 @@ jobs:
126112

127113
- name: Build
128114
run: npm run build
129-
env:
130-
REACT_APP_SENTRY_KEY: ${{ secrets.SENTRY_KEY_UI }}
131-
REACT_APP_SENTRY_ENVIRONMENT: 'prerelease'
132115

133116
- name: Purge ui src
134117
run: npx rimraf ./ui
@@ -147,16 +130,3 @@ jobs:
147130
run: npm run publish:linux:arm64
148131
env:
149132
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
150-
151-
- name: Create Sentry release
152-
if: matrix.os == 'ubuntu-latest'
153-
uses: getsentry/action-release@v1
154-
env:
155-
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
156-
SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
157-
SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
158-
with:
159-
ignore_missing: true
160-
ignore_empty: true
161-
sourcemaps: ./dist/desktop/src
162-
version: ${{ github.event.inputs.version }}

README.md

Lines changed: 34 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010

1111
> Electron Desktop app that helps you easily spin up and manage Swarm's Bee node
1212
13-
**Warning: Swarm Desktop is in Beta and currently includes the [Sentry](https://sentry.io/welcome/) application monitoring and bug reporting software which automatically collects data in order to help improve the software.**
13+
**Warning: This project is in beta state. There might (and most probably will) be changes in the future to its API and
14+
working. Also, no guarantees can be made about its stability, efficiency, and security at this stage.**
1415

15-
**Warning: This project is in beta state. There might (and most probably will) be changes in the future to its API and working. Also, no guarantees can be made about its stability, efficiency, and security at this stage.**
16-
17-
Stay up to date by joining the [official Discord](https://discord.gg/GU22h2utj6) and by keeping an eye on the [releases tab](https://github.com/ethersphere/swarm-desktop/releases).
16+
Stay up to date by joining the [official Discord](https://discord.gg/GU22h2utj6) and by keeping an eye on the
17+
[releases tab](https://github.com/ethersphere/swarm-desktop/releases).
1818

1919
## Table of Contents
2020

@@ -27,17 +27,17 @@ Stay up to date by joining the [official Discord](https://discord.gg/GU22h2utj6)
2727

2828
## Install
2929

30-
Go to the [releases page](https://github.com/ethersphere/swarm-desktop/releases/latest) and download the correct build for your operation system:
31-
32-
- Windows: `Swarm.Desktop-***.Setup.exe`
33-
- macOS: `Swarm.Desktop-darwin-x64-***.zip`
34-
- Linux: `swarm-desktop_***_amd64.deb` or `swarm-desktop-***-1.x86_64.rpm`
30+
Go to the [releases page](https://github.com/ethersphere/swarm-desktop/releases/latest) and download the correct build
31+
for your operation system:
3532

36-
> Until 1.0 release, all our developer releases has automatically enabled error tracking and reporting using sentry.io which is not possible to opt-out!
33+
- Windows: `Swarm.Desktop-***.Setup.exe`
34+
- macOS: `Swarm.Desktop-darwin-x64-***.zip`
35+
- Linux: `swarm-desktop_***_amd64.deb` or `swarm-desktop-***-1.x86_64.rpm`
3736

3837
### macOS
3938

40-
macOS may not allow you to run the .app after unzipping. To solve this, right click the .app and click Open. You will have an option to ignore the warning.
39+
macOS may not allow you to run the .app after unzipping. To solve this, right click the .app and click Open. You will
40+
have an option to ignore the warning.
4141

4242
## Usage
4343

@@ -49,57 +49,60 @@ There are some ways you can make this module better:
4949

5050
- Consult our [open issues](https://github.com/ethersphere/swarm-desktop/issues) and take on one of them
5151
- Help our tests reach 100% coverage!
52-
- Join us in our [Discord chat](https://discord.gg/wdghaQsGq5) in the #develop-on-swarm channel if you have questions or want to give feedback
52+
- Join us in our [Discord chat](https://discord.gg/wdghaQsGq5) in the #develop-on-swarm channel if you have questions or
53+
want to give feedback
5354

5455
### Architecture
5556

5657
Swarm Desktop consists of two components:
5758

58-
1. Electron back-end that provides orchestration API that retrieve, spins, stops and manage the Bee node
59-
2. Bundled [Bee Dashboard](https://github.com/ethersphere/bee-dashboard) that provides UI to manage Bee node and provides access to Swarm network
59+
1. Electron back-end that provides orchestration API that retrieve, spins, stops and manage the Bee node
60+
2. Bundled [Bee Dashboard](https://github.com/ethersphere/bee-dashboard) that provides UI to manage Bee node and
61+
provides access to Swarm network
6062

6163
The Electron back-end is placed in `src` folder.
6264

6365
The Bee Desktop stores logs of both itself and Bee in the application's logs folder:
6466

65-
- macOS: `~/Library/Logs/Swarm Desktop/`
66-
- Windows: `%LOCALAPPDATA%\Swarm Desktop\Log\` (for example, `C:\Users\USERNAME\AppData\Local\Swarm Desktop\Log\`)
67-
- Linux: `~/.local/state/Swarm Desktop/`
67+
- macOS: `~/Library/Logs/Swarm Desktop/`
68+
- Windows: `%LOCALAPPDATA%\Swarm Desktop\Log\` (for example, `C:\Users\USERNAME\AppData\Local\Swarm Desktop\Log\`)
69+
- Linux: `~/.local/state/Swarm Desktop/`
6870

6971
It also stores configuration files, Bee assets and other things in application's data folder:
7072

71-
- Windows: `%LOCALAPPDATA%\Swarm Desktop\Data` (for example, `C:\Users\USERNAME\AppData\Local\Swarm Desktop\Data`)
72-
- Mac OS: `~/Library/Application Support/Swarm Desktop`
73-
- Linux: `~/.local/share/Swarm Desktop` (or `$XDG_DATA_HOME/Swarm Desktop`)
73+
- Windows: `%LOCALAPPDATA%\Swarm Desktop\Data` (for example, `C:\Users\USERNAME\AppData\Local\Swarm Desktop\Data`)
74+
- Mac OS: `~/Library/Application Support/Swarm Desktop`
75+
- Linux: `~/.local/share/Swarm Desktop` (or `$XDG_DATA_HOME/Swarm Desktop`)
7476

7577
### Development
7678

7779
As there are several independent components it bit depends on what you want to develop.
7880

79-
**Be aware!** The UI won't automatically open during development in order not to confuse on which
80-
environment they are running. You have to open them manually.
81+
**Be aware!** The UI won't automatically open during development in order not to confuse on which environment they are
82+
running. You have to open them manually.
8183

8284
#### Electron Desktop
8385

8486
To work on the Electron Desktop back-end you just need to do your work and then run `npm start`. This will launch the
85-
Electron app and shows the Tray icon. No UI will be opened automatically. If you need to make more adjustment you have to exit
86-
the process with `SIGINT (CTRL+C)` and relaunch.
87+
Electron app and shows the Tray icon. No UI will be opened automatically. If you need to make more adjustment you have
88+
to exit the process with `SIGINT (CTRL+C)` and relaunch.
8789

8890
#### UI (Dashboard)
8991

90-
To work on the Dashboard, run first `npm start` that will spin up the Electron Desktop back-end. Then go to your locally cloned `bee-dashboard` repo and
91-
in it start the development server with `npm start`. Dashboard also needs to have API key injected in order to use the
92-
Desktop's API. You can inject it by running `npm run desktop` in the Dashboard repo that will open the Dashboard UI with API key in the URL.
93-
Changes are automatically hot-reloaded.
92+
To work on the Dashboard, run first `npm start` that will spin up the Electron Desktop back-end. Then go to your locally
93+
cloned `bee-dashboard` repo and in it start the development server with `npm start`. Dashboard also needs to have API
94+
key injected in order to use the Desktop's API. You can inject it by running `npm run desktop` in the Dashboard repo
95+
that will open the Dashboard UI with API key in the URL. Changes are automatically hot-reloaded.
9496

95-
The UI served by the Desktop itself is updated only when you update the `@ethersphere/bee-dashboard` NPM package in the Desktop repo.
97+
The UI served by the Desktop itself is updated only when you update the `@ethersphere/bee-dashboard` NPM package in the
98+
Desktop repo.
9699

97100
#### Maintenance tasks
98101

99102
There are several handy scripts:
100103

101-
- `npm run purge:data` that purge's the Desktop's data folder
102-
- `npm run purge:logs` that purge's the Desktop's logs folder
104+
- `npm run purge:data` that purge's the Desktop's data folder
105+
- `npm run purge:logs` that purge's the Desktop's logs folder
103106

104107
## Maintainers
105108

0 commit comments

Comments
 (0)