feat: command-line option can be used to specify app's data directory
In the repo:
```
$ bin/nim_status_client --help
```
In the packaged app (macOS example):
```
$ cd /Applications/Status.app/Contents/MacOS
$ ./nim_status_client --help
```
Output:
```
Usage:
nim_status_client [OPTIONS]...
The following options are available:
-d, --dataDir Status Desktop data directory.
```
**Using the option**
```
$ cd ~/status-ci-builds/master/Status.app/Contents/MacOS
$ ./nim_status_client --dataDir:"${HOME}/status-dirs/master"
```
In another terminal:
```
$ cd ~/status-ci-builds/PR-4242/Status.app/Contents/MacOS
$ ./nim_status_client --dataDir:"${HOME}/status-dirs/PR-4242"
```
The path supplied can be relative or absolute, and can be specified with
`--dataDir:[path]`, `--dataDir=[path]`, `-d:[path]`, or `-d=[path]`.
Either `:` or `=` must be used, i.e. this *will not* work: `--dataDir [path]`
or `-d [path]`.
The name of the option follows Nim's partial case-insensitivity rules, so
`--dataDir`, `--datadir`, and `--data_dir` are all equivalent. See
[Identifier equality][ieq] in the Nim Manual.
It is possible to run the same build in multiple terminals by supplying
different `--dataDir`, i.e. this works:
```
$ cd /Applications/Status.app/Contents/MacOS
$ ./nim_status_client --dataDir="${HOME}/temp/some1"
```
In another terminal:
```
$ cd /Applications/Status.app/Contents/MacOS
$ ./nim_status_client --dataDir="${HOME}/temp/some2"
```
**Windows**
It is recommended to use a Git Bash or MSYS2 terminal when invoking
`bin/nim_status_client.exe` (development build) or `bin/Status.exe` (production
build) on the command-line. The reason is that if the exe is invoked in a
session of `cmd.exe` it will return to the prompt immediately; the app will run
but there will be no output in the terminal. In any case, the `--dataDir`
option will take effect whether the exe is invoked in `cmd.exe` or a
recommended terminal.
For development builds, when invoking `bin/nim_status_client.exe` directly
instead of via `make run`, because e.g. you wish to use the `--dataDir` option,
it is required to first setup the `PATH` environment variable correctly. See
the `run-windows` target in this repo's Makefile for more information.
**Linux**
The `--dataDir` option may be passed to command-line invocation of a
production (AppImage) build in the same way as passing it to a development
build:
```
$ Status.AppImage --dataDir:/path/to/wherever
```
For development builds, when invoking `bin/nim_status_client` directly instead
of via `make run`, because e.g. you wish to use the `--dataDir` option, it is
required to setup the `LD_LIBRARY_PATH` environment variable correctly. See the
`run-linux` target in this repo's Makefile for more information.
---
BREAKING CHANGE: The `qt` subdir of the app's data directory is now a sibling
of the status-go directory rather than a subdir of the status-go directory:
```
Status (app data directory)
├── data (status-go directory)
├── qt
└── tmp
```
Because app settings are stored in the `qt` directory that means that existing
installations will lose their customized settings.
At app startup, it would be possible to detect `Status/data/qt` and if
`Status/qt` doesn't exist yet then copy `Status/data/qt` to
`Status/qt`. However, there was some concern that behavior could lead to
problems later on if we forget the workaround is in place. So for now that
settings preservation strategy has not been implemented, but it might be before
this commit is merged pending full team awareness/consensus.
---
Command-line option support is provided by
[nim-confutils](https://github.com/status-im/nim-confutils).
The environment variable `NIM_STATUS_CLIENT_DEV` has been removed in favor of
passing a "define" option to the Nim compiler: `-d:development` for development
builds (e.g. `make V=1`) and `-d:production` for packaged builds (e.g. `make
V=1 pkg`). Passing the correct option is handled automatically by the Makefile.
A make variable named `RELEASE` has been introduced, which defaults to
`false`. Presently the `RELEASE` variable should not be set on the command-line
nor in CI as more work needs to be done to toggle the proper compiler flags. In
the case of Status Desktop, "release vs. debug" is a concern orthogonal to
"production vs. development". At present, production builds and development
builds are all debug builds, but that will likely change in the future: we can
have non-release CI production builds and local development builds be debug
builds, while release builds in CI would be production builds with
`RELEASE=true` (the compiled executable will be fully optimized).
Prior to the changes in this PR, symmetry is somewhat lacking between
development and production (packaged) builds with respect to the concept of the
"data directory". In development builds the root of the repo effectively serves
as the `Status` directory used by production builds, e.g. on macOS
`~/Library/Application Support/Status`. Also, there's a bit of confusion as to
whether "data directory" refers to a directory for the desktop app's overall
data (including status-go data) or to the specific directory used by status-go.
This PR attempts to provide symmetry and reduce confusion:
* The term "data directory" means the directory used by the desktop app to
store multiple kinds of data and is not a reference to the subdirectory used by
status-go.
* For development builds the "data directory" defaults to `./Status/` relative
to the root of the repo.
* For production builds the "data directory" default is the same as before,
e.g. on macOS it's ` ~/Library/Application Support/Status/`.
The directory used by status-go is `Status/data/`. To be clear, that should be
referred to as the "status-go directory" and not the app's "data directory". It
would nice if we could rename it from `Status/data/` to `Status/status-go/`. We
can do that, I already checked that it works correctly; however, for existing
installations it would require that at app launch we check for the presence of
`Status/data/` and rename it to `Status/status-go`. While simple enough to do,
I was concerned that there might be edge cases where the directory rename could
cause a problem (e.g. if another copy of the app is running) so chose for now
to stick with the status-go directory being `Status/data/`.
---
**NOTES**
More work needs to be done to ensure that all data written by the app is
contained in the default or cli-specified data directory. Currently, both
development and production (packaged) builds are writing to common directories
outside of the data directory, e.g. located within `~/Library/` on
macOS. Changing that behavior seems like it will mainly involve changing
defaults related to Qt components such as the web engine. See:
https://github.com/status-im/status-desktop/issues/1141.
In general, additional refactoring could be done in the future. For
example, implementing `StatusDesktopConfig` in
`src/status/libstatus/accounts/constants.nim` (as done in this PR) works fine
for now, but better code organization is desirable.
---
Closes #2268
[ieq]: https://nim-lang.org/docs/manual.html#lexical-analysis-identifier-equality
2021-04-19 12:20:07 +00:00
|
|
|
/Status
|
2020-06-04 16:00:07 +00:00
|
|
|
/data
|
2020-05-06 17:40:00 +00:00
|
|
|
noBackup/
|
2020-05-08 16:08:59 +00:00
|
|
|
.idea
|
2020-05-11 19:54:02 +00:00
|
|
|
*.pro.user
|
2020-05-11 21:24:08 +00:00
|
|
|
*.pro.autosave
|
2020-05-18 15:42:22 +00:00
|
|
|
*.qml.autosave
|
2021-11-29 10:28:06 +00:00
|
|
|
*.log
|
feat: introduce Task Manager threadpool
The `TaskManager` threadpool is a memory-safe replacement for the `spawnAndSend` operations that are currently causing memory issues in status-desktop.
From a fundamental memory management point of view, `libstatus/settings`, `libstatus/contracts`, and `libstatus/tokens` (custom tokens) have all been converted to `{.threadvar.}`s and `Atomic[bool]`s to maintain the cache and `dirty` flag across threads, respectively, eliminating the need for thread locks and incorrect `{.gcsafe.}` compiler overrides.
The successful [recyclable threadpool experiment from `nim-task-runner`](https://github.com/status-im/nim-task-runner/blob/test/use-cases/test/use_cases/test_sync.nim) using `AsyncChannel[ThreadSafeString]`s was brought over to `status-desktop` and implemented in somewhat of a hardcoded manner, as we knew this would save some time instead of trying to create a fully fleshed out `nim-task-runner` API and build a miraculous macro that may or may not be able to generate the needed API.
The threadpool is started by the `TaskManager` and both the `TaskManager` and the `TaskManager`'s threadpool are started as early as possible in the application lifecycle (in `nim_status_client.nim`). The `TaskManager` creates a thread to run the threadpool. During its initialization, the threadpool then spools up all the threads it will manage and puts them in an idle thread sequence. This is to prevent expensive thread creation and teardown happening during the app's lifetime as it is quite expensive and blocks the main thread. When tasks comes in to the pool, the task is sent to an idle thread, or put in a queue if all threads are busy. The idle thread is moved to the busy thread sequence. When a task is completed, the thread is taken out of the busy threads sequence and moved back in to the sequence of idle threads, effectively recycling it.
The first `spawnAndSend` we were able to change over to the new threadpool was `estimate`, which estimates the gas of a sticker purchase transaction.
From the consumer point of view, the existing `spawnAndSend` to achieve this looks like:
```nim
proc estimate*(self: StickersView, packId: int, address: string, price: string, uuid: string) {.slot.} =
let status_stickers = self.status.stickers
spawnAndSend(self, "setGasEstimate") do:
var success: bool
var estimate = status_stickers.estimateGas(packId, address, price, success)
if not success:
estimate = 325000
let result: tuple[estimate: int, uuid: string] = (estimate, uuid)
Json.encode(result)
```
And the new syntax looks like this:
```nim
proc estimate*(self: StickersView, packId: int, address: string, price: string, uuid: string) {.slot.} =
self.status.taskManager.threadPool.stickers.stickerPackPurchaseGasEstimate(cast[pointer](self.vptr), "setGasEstimate", packId, address, price, uuid)
```
The logic inside the `spawnAndSend` body was moved to [src/status/tasks/stickers.nim](https://github.com/status-im/status-desktop/compare/experiment/tasks-3?expand=1#diff-09e57eef00b0cee5c4abdb9039f948d8372e7003e09e934a9b4c7e9167d47658).
This is just the first migration of `spawnAndSend`, however moving the majority of the remaining `spawnAndSend`s will likely just be an exercise in copy/pasta. There will be one or two that may require a bit more thinking, depending how they rely on data from the model.
Once the `spawnAndSend`s have been converted to the threadpool, we can start implementing the [long-running process from the task runner use case experiments](https://github.com/status-im/nim-task-runner/blob/test/use-cases/test/use_cases/test_long_running.nim).
And finally, we can then implement the [async tasks](https://github.com/status-im/nim-task-runner/blob/test/use-cases/test/use_cases/test_async.nim) if needed.
@michaelsbradleyjr and I spent many hours digging in to the depths of nim's memory management in an attempt to understand it. We have created [a presentation with our task runner experiment findings](https://docs.google.com/presentation/d/1ItCxAfsVTcIoH_E4bgvmHljhbU-tC3T6K2A6ahwAedk/edit?usp=sharing), and @michaelsbradleyjr has spent time [answering questions off the back of that presentation.](https://gist.github.com/michaelsbradleyjr/1eaa9937b3fbb4ffff3fb814f0dd82a9).
We have created a fork of `edn.nim` at `status-im/edn.nim` and we need the PR to be merged and the commit hash updated before we can merge this PR in to `status-desktop`.
2021-03-17 06:25:41 +00:00
|
|
|
.update.timestamp
|
2020-05-11 21:24:08 +00:00
|
|
|
.vscode
|
2020-05-14 20:19:01 +00:00
|
|
|
bin/
|
2020-06-04 20:56:44 +00:00
|
|
|
/bottles/
|
|
|
|
|
pkg/
|
2020-05-14 20:19:01 +00:00
|
|
|
vendor/.nimble
|
2020-05-15 13:00:49 +00:00
|
|
|
*.AppImage
|
2020-05-18 15:42:22 +00:00
|
|
|
tmp
|
2020-05-19 18:10:46 +00:00
|
|
|
nimcache
|
2020-06-04 16:00:07 +00:00
|
|
|
.DS_Store
|
2020-06-04 20:56:44 +00:00
|
|
|
nim-status-client*.tgz
|
|
|
|
|
node_modules
|
|
|
|
|
npm-debug.log*
|
|
|
|
|
npm-shrinkwrap.json
|
|
|
|
|
/package/
|
|
|
|
|
yarn-debug.log*
|
|
|
|
|
yarn-error.log*
|
|
|
|
|
yarn.lock
|
2020-06-17 12:53:51 +00:00
|
|
|
TODO
|
2020-06-30 21:35:24 +00:00
|
|
|
resources.rcc
|
2022-01-25 19:27:38 +00:00
|
|
|
ui/resources.qrc
|
2020-07-06 20:39:07 +00:00
|
|
|
status-react-translations/
|
2021-03-15 18:40:10 +00:00
|
|
|
/.update.timestamp
|
2021-05-27 07:53:40 +00:00
|
|
|
notarization.log
|
2021-11-29 10:28:06 +00:00
|
|
|
status-desktop.log
|
2022-01-06 19:29:19 +00:00
|
|
|
nim_status_client.log
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# CPP app =====================================================================
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# https://github.com/github/gitignore/blob/master/CMake.gitignore
|
|
|
|
|
CMakeLists.txt.user
|
|
|
|
|
CMakeCache.txt
|
|
|
|
|
CMakeFiles
|
|
|
|
|
CMakeScripts
|
|
|
|
|
Testing
|
|
|
|
|
Makefile
|
|
|
|
|
cmake_install.cmake
|
|
|
|
|
install_manifest.txt
|
|
|
|
|
compile_commands.json
|
|
|
|
|
CTestTestfile.cmake
|
|
|
|
|
_deps
|
2022-01-18 11:39:21 +00:00
|
|
|
.cache/
|
2022-01-06 19:29:19 +00:00
|
|
|
|
2022-05-04 09:25:01 +00:00
|
|
|
# QtCreator shadow builds
|
|
|
|
|
build-*/
|
2022-01-06 19:29:19 +00:00
|
|
|
|
|
|
|
|
# https://github.com/github/gitignore/blob/master/C%2B%2B.gitignore
|
|
|
|
|
# Prerequisites
|
|
|
|
|
*.d
|
|
|
|
|
|
|
|
|
|
# Compiled Object files
|
|
|
|
|
*.slo
|
|
|
|
|
*.lo
|
|
|
|
|
*.o
|
|
|
|
|
*.obj
|
|
|
|
|
|
|
|
|
|
# Precompiled Headers
|
|
|
|
|
*.gch
|
|
|
|
|
*.pch
|
|
|
|
|
|
|
|
|
|
# Compiled Dynamic libraries
|
|
|
|
|
*.so
|
|
|
|
|
*.dylib
|
|
|
|
|
*.dll
|
|
|
|
|
|
|
|
|
|
# Fortran module files
|
|
|
|
|
*.mod
|
|
|
|
|
*.smod
|
|
|
|
|
|
|
|
|
|
# Compiled Static libraries
|
|
|
|
|
*.lai
|
|
|
|
|
*.la
|
|
|
|
|
*.a
|
|
|
|
|
*.lib
|
|
|
|
|
|
|
|
|
|
# Executables
|
|
|
|
|
*.exe
|
|
|
|
|
*.out
|
|
|
|
|
*.app
|
