feat(cmd)_: status-backend
#5847
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Jenkins BuildsClick to see older builds (98)
|
igor-sirotin
force-pushed
the
feat/5828-status-backend
branch
4 times, most recently
from
ac82091 to
5462930
Compare
igor-sirotin
commented
Sep 23, 2024
| @@ -99,6 +99,7 @@ func initializeApplication(requestJSON string) string { | |||
| return string(data) | |||
| } | |||
|
|
|||
| // Deprecated: Use InitializeApplication instead. | |||
| func OpenAccounts(datadir string) string { | |||
There was a problem hiding this comment.
Nothing new here, it was deprecated already. It's just done for the private func:
Lines 107 to 109 in b3143ce
igor-sirotin
commented
Sep 23, 2024
There was a problem hiding this comment.
I could have gathered the list of funcs manually, but it would be not simple to keep it up to date.
igor-sirotin
force-pushed
the
feat/5828-status-backend
branch
from
5462930 to
16a4a48
Compare
igor-sirotin
requested review from
friofry,
plopezlpz,
Samyoul,
dlipicar,
osmaczko and
a team
osmaczko
approved these changes
Sep 25, 2024
igor-sirotin
force-pushed
the
feat/5828-status-backend
branch
from
91cd92a to
1d8e0b2
Compare
Codecov ReportAttention: Patch coverage is
✅ All tests successful. No failed tests found.
Additional details and impacted files@@ Coverage Diff @@
## develop #5847 +/- ##
==========================================
Coverage ? 46.06%
==========================================
Files ? 884
Lines ? 157156
Branches ? 0
==========================================
Hits ? 72397
Misses ? 76447
Partials ? 8312
Flags with carried forward coverage won't be shown. Click here to find out more.
|
qfrank
approved these changes
Sep 26, 2024
| } | ||
|
|
||
| if isDeprecated { | ||
| isDeprecated = false |
There was a problem hiding this comment.
We should support deprecated by default and maybe add a switch to disable it. Consider that the mobile client will use the server one day. That would be a really cool experience for mobile developers as they won't need to endure the long wait to re-build with status-go with each modification to status-go to debug or do something else ...
There was a problem hiding this comment.
Makes sense indeed, will do 👍
fbarbu15
reviewed
Sep 26, 2024
fix(statusd)_: manually serve
igor-sirotin
force-pushed
the
feat/5828-status-backend
branch
from
1ce9b15 to
2fa34eb
Compare
fbarbu15
approved these changes
Sep 26, 2024
friofry
reviewed
Sep 27, 2024
cmd/statusd/server/parse-api/main.go
Outdated
|
|
||
| // Function to check if a comment indicates a deprecated function | ||
| func isDeprecatedComment(line string) bool { | ||
| return strings.Contains(line, "// Deprecated:") |
There was a problem hiding this comment.
sometimes it's // DEPRECATED or @deprecated
There was a problem hiding this comment.
True. It will work in this file for all public methods now, but will make it a bit smarter 👍
There was a problem hiding this comment.
simple case-insensitive first comment word contains "deprecated" should do, right?
There was a problem hiding this comment.
Done: 2ba2613
Checking it like this:
Which matches https://go.dev/wiki/Deprecated.
Not bothering about @deprecated form, as it's not conventional in Go. Anyway, it's only used in wallet/api.go, and is not parsed by this program.
dlipicar
approved these changes
Sep 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #5828
Description
This PR introduces a new tool for debugging and testing
status-go.In contrast to existing
statusdandstatus-cli, thestatus-backendexposes full status-go API through HTTP.This allows to communicate with status-go through HTTP the same way as
status-desktopandstatus-mobiledo, including: create account, restore account, login, logout, start messenger, start wallet and subscribe to status-go signals.Implementation
I decided to keep
statusdas is. Reasoning here.Yet, when functional tests migrate to use
status-bacend, we can remove the--seed-pharseargument fromstatusd. It was introduced specifically for it.@osmaczko I kept
signals_serverinstatusdfor easier review of the changes in it.After this is merged, I will open a separate PR with just moving and renaming the files.
To continue the idea of a single server for both APIs:
I found a better solution. When using
status-backend, you don't need to start geth's RPC server at all. You can accessservices/*API throughCallRPCendpoint, just the same as desktop/mobile do.Usage
Start the app with the address to listen to:
Access the exposed API with any HTTP client you prefer:
Simple flows
Create account and login
InitializeApplicationCreateAccountAndLoginwakuext_startMessengerwallet_startWalletsettings_getSettings(temporary workaround, otherwise settings don't get saved into DB)Login into account
InitializeApplicationLoginAccountwakuext_startMessengerwallet_startWalletRequests collection
Not to pollute this PR, a follow-up PR with some basic requests is here: