615ad2f02b
Adds FlowStorm https://github.com/flow-storm/flow-storm-debugger v3.7.5, a well known (tracing) debugger for Clojure(Script). With FlowStorm, you can debug almost any cljs function in status-mobile. And although it is not as capable as on the JVM, its main features work well enough. How do I use it? Please, check the markdown diff in this PR: doc/debugging.md. When would you use FlowStorm in status-mobile? You can use it all the time if you want, but FlowStorm can be a powerful tool to understand complex pieces of code. Consider those large subscriptions or event handlers. Or all those components with lots of bindings and calculations. Understanding some of these things is no easy task, even with a REPL. It is not a replacement for re-frisk, those are very different tools and each have their place. Resources: - Repository: https://github.com/flow-storm/flow-storm-debugger - Documentation: https://flow-storm.github.io/flow-storm-debugger - Features: https://github.com/flow-storm/flow-storm-debugger#features - YouTube demos: https://github.com/flow-storm/flow-storm-debugger#some-demo-videos-newers-at-the-top |
||
|---|---|---|
| .. | ||
| deps | ||
| lib | ||
| mobile | ||
| pkgs | ||
| scripts | ||
| status-go | ||
| DETAILS.md | ||
| KNOWN_ISSUES.md | ||
| README.md | ||
| default.nix | ||
| nix.conf | ||
| overlay.nix | ||
| pkgs.nix | ||
| shell.nix | ||
| shells.nix | ||
| targets.nix | ||
README.md
Description
This folder contains configuration for Nix, a purely functional package manager used by the Status app for its build process.
Configuration
The main config file is nix/nix.conf and its main purpose is defining the binary caches which allow download of packages to avoid having to compile them yourself locally.
Build arguments
We leverage the environment variables for parameterization of the builds (e.g. to pass a build number or build type).
Here is the list of variables you can use to override defaults:
# Build type (influences which .env file gets used for feature flags)
export BUILD_TYPE="pr"
# Used for versionCode and CFBundleVersion in Android and iOS respectively
export BUILD_NUMBER=9999
# Gradle options passed for Android builds
export ANDROID_GRADLE_OPTS=""
# If APKs should be split based on architectures
export ANDROID_ABI_SPLIT=false
# Android architectures to build for
export ANDROID_ABI_INCLUDE="x86"
# Local source override, see below
export STATUS_GO_SRC_OVERRIDE="$HOME/my/source/status-go"
export STATUS_GO_IPFS_GATEWAY_URL="https://ipfs.status.im/"
You can see the defaults in code:
Shell
In order to access an interactive Nix shell a user should run make shell.
The Nix shell is started in this repo via the nix/scripts/shell.sh script, which is a wrapper around the nix-shell command and is intended for use with our main Makefile. This allows for an implicit use of nix-shell as the default shell in the Makefile.
Normally the shell starts without any specific target platform, if you want to change that you should export the TARGET env variable with appropriate value:
make shell TARGET=android
This way your shell and all other nix commands should run in a setup that is tailored towards Android development.
For valid values you can check the nix/shells.nix file.
⚠️ WARNING: To have Nix pick up all changes a new nix-shell needs to be spawned.
Using a local status-go repository
If you need to use a locally checked-out status-go repository, you can achieve that by defining the STATUS_GO_SRC_OVERRIDE
environment variable:
export STATUS_GO_SRC_OVERRIDE=$GOPATH/src/github.com/status-im/status-go
make release-android
Resources
You can learn more about Nix by watching these presentations:
- Nix Fundamentals (PDF, src)
- Nix in Status (PDF, src)
And you can read nix/DETAILS.md for more information.
Known Issues
See KNOWN_ISSUES.md.