Migrate API Server #6426

alexanderbez · 2020-06-12T20:19:50Z

Description

This PR revises the model in which a API (REST) server is started. The server is now started in process along with the application binary & Tendermint -- everything is in a single process. This drastically reduces various complexities and simplifies the mental model.

Operators may now enable/disable the API server along with various other options. In the future, they'll be able to provide Caddy/TLS/Proxy configurations as well.

One thing left to consider is if how to handle proof verifications (i.e. trust-node) -- I left a TODO for this.

From an app developer's POV, not much changes. They still provide module route registration, except instead of passing it to a command, they now pass it along with their app constructor to the start command.

To test:

make build-docker-local-simapp (only needed to be invoked once to build the image)
make clean localnet-start
BUILDDIR=./build/macos make build-sim
Invoke and test various routes (localhost:1317-1320)
make localnet-stop

closes: #6408

/cc @jackzampolin @marbar3778

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the module structure standards.
Wrote unit and integration tests
Updated relevant documentation (docs/) or specification (x/<module>/spec/)
Added relevant godoc comments.
Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
Re-reviewed Files changed in the Github PR explorer

codecov · 2020-06-12T20:23:44Z

Codecov Report

Merging #6426 into master will increase coverage by 0.99%.
The diff coverage is 56.25%.

@@            Coverage Diff             @@
##           master    #6426      +/-   ##
==========================================
+ Coverage   54.80%   55.79%   +0.99%     
==========================================
  Files         378      465      +87     
  Lines       22391    27800    +5409     
==========================================
+ Hits        12272    15512    +3240     
- Misses       9194    11183    +1989     
- Partials      925     1105     +180

server/api/root.go

alexanderbez · 2020-06-13T15:14:18Z

I have the basis of this feature working. We're going to need to rethink the design and use of Context a bit. E.g. does it make sense to have trust-node and rpc flags defined?

…s-sdk into bez/6408-integrate-rest-svc

jackzampolin

Long overdue. Huge improvement would like to test but afk today

fedekunze

utACK, code looks good. Will test on Monday

fedekunze · 2020-06-13T18:38:02Z

CHANGELOG.md

@@ -39,6 +39,7 @@ Ref: https://keepachangelog.com/en/1.0.0/

 ### Client Breaking

+* (api) [\#6426](https://github.com/cosmos/cosmos-sdk/pull/6426) The ability to start an out-of-process API REST server has now been removed. Instead, the API server is now started in-process along with the application and Tendermint. Configuration options have been added to `app.toml` to enable/disable the API server along with additional HTTP server options.


Suggested change

* (api) [\#6426](https://github.com/cosmos/cosmos-sdk/pull/6426) The ability to start an out-of-process API REST server has now been removed. Instead, the API server is now started in-process along with the application and Tendermint. Configuration options have been added to `app.toml` to enable/disable the API server along with additional HTTP server options.

* (api) [\#6426](https://github.com/cosmos/cosmos-sdk/pull/6426) The ability to start an out-of-process API REST server has now been removed. Instead, the API server is now started in-process along with the application and Tendermint. Configuration options, i.e legacy flags, have been migrated to `app.toml` to enable/disable the API server along with additional HTTP server options.

Legacy flags? What legacy flags?

server/config/config.go

server/start.go

server/api/server.go

server/config/config.go

server/constructors.go

alessio

This is brilliant, left suggestions for a couple of cosmetic changes.

Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>

server/api/server.go

alexanderbez · 2020-06-15T14:10:56Z

I'll leave this PR open for another day or so to allow people to test, until I merge it.

fedekunze

tested ACK

fedekunze · 2020-06-15T16:55:09Z

It'd be nice if we could add the docs from Gaia and update them for the SDK. Maybe a follow-up issue/PR

jgimeno · 2020-06-16T15:16:05Z

server/config/config.go

+// APIConfig defines the API listener configuration.
+type APIConfig struct {
+	// Enable defines if the API server should be enabled.
+	Enable bool `mapstructure:"enable"`


@alexanderbez just saw this is not used, is that correct?

WDYM not used? It is used and is false by default.

Sorry, maybe I am wrong but inside here

cosmos-sdk/server/api/server.go

Line 48 in 8ee7d1f

func (s *Server) Start(cfg config.Config) error {

I dont see any if Config.API.Enabled and I am going crazy with it!

https://github.com/cosmos/cosmos-sdk/blob/master/server/start.go#L195

We should probably create the config before that and use that instead. Mind creating a small PR?

Leave it in my hands!

Start migration

9b328cf

alexanderbez added the WIP label Jun 12, 2020

alexanderbez assigned jgimeno and alexanderbez Jun 12, 2020

alexanderbez added the T: API Breaking Breaking changes that impact APIs and the SDK only (not state machine). label Jun 12, 2020

alexanderbez and others added 2 commits June 12, 2020 16:31

Merge branch 'master' into bez/6408-integrate-rest-svc

924c996

Rename

0fbf8b2

alexanderbez commented Jun 12, 2020

View reviewed changes

server/api/root.go Outdated Show resolved Hide resolved

alexanderbez and others added 2 commits June 12, 2020 20:26

Merge branch 'master' into bez/6408-integrate-rest-svc

48b2d68

updates

37746ea

alexanderbez and others added 4 commits June 13, 2020 11:47

Add TODO

90a78b1

Merge branch 'bez/6408-integrate-rest-svc' of github.com:cosmos/cosmo…

b937afa

…s-sdk into bez/6408-integrate-rest-svc

TODO

f16bf0b

Merge branch 'master' into bez/6408-integrate-rest-svc

cff231b

alexanderbez marked this pull request as ready for review June 13, 2020 15:56

alexanderbez requested review from aaronc, alessio, clevinson, fedekunze and jgimeno as code owners June 13, 2020 15:56

alexanderbez added R4R and removed WIP labels Jun 13, 2020

alexanderbez added 4 commits June 13, 2020 11:58

cl++

b0efad3

Merge branch 'bez/6408-integrate-rest-svc' of github.com:cosmos/cosmo…

5c6c33f

…s-sdk into bez/6408-integrate-rest-svc

update config

0082dee

Build updates

02f2bdb

alexanderbez requested review from sahith-narahari and AdityaSripal June 13, 2020 16:01

alexanderbez requested review from colin-axner, faboweb, jackzampolin and jbibla June 13, 2020 16:01

jackzampolin approved these changes Jun 13, 2020

View reviewed changes

fedekunze reviewed Jun 13, 2020

View reviewed changes

alexanderbez and others added 7 commits June 14, 2020 10:04

Add ref to TODO

cf5c2f3

Use codec.JSONMarshaler

2270b11

Refactor route registration

238a8d7

Cleanup

4256a85

Merge branch 'master' into bez/6408-integrate-rest-svc

3fb4a54

Disable API server by default

4dc4d70

Enable API server in testnet cmd

afe9a54

alessio reviewed Jun 14, 2020

View reviewed changes

server/api/server.go Outdated Show resolved Hide resolved

server/config/config.go Outdated Show resolved Hide resolved

server/config/config.go Show resolved Hide resolved

fedekunze reviewed Jun 15, 2020

View reviewed changes

server/constructors.go Outdated Show resolved Hide resolved

alessio suggested changes Jun 15, 2020

View reviewed changes

alessio approved these changes Jun 15, 2020

View reviewed changes

alexanderbez and others added 3 commits June 15, 2020 09:53

Update server/constructors.go

9522310

Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>

Merge branch 'master' into bez/6408-integrate-rest-svc

988f572

address comments

5c210bc

alessio reviewed Jun 15, 2020

View reviewed changes

server/api/server.go Show resolved Hide resolved

fedekunze approved these changes Jun 15, 2020

View reviewed changes

alexanderbez merged commit 6a05b83 into master Jun 15, 2020

alexanderbez deleted the bez/6408-integrate-rest-svc branch June 15, 2020 17:39

jgimeno reviewed Jun 16, 2020

View reviewed changes

larry0x pushed a commit to larry0x/cosmos-sdk that referenced this pull request May 22, 2023

Merge PR cosmos#6426: Migrate API Server

9290415

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate API Server #6426

Migrate API Server #6426

alexanderbez commented Jun 12, 2020 •

edited

codecov bot commented Jun 12, 2020 •

edited

alexanderbez commented Jun 13, 2020

jackzampolin left a comment

fedekunze left a comment

fedekunze Jun 13, 2020

alexanderbez Jun 14, 2020

alessio left a comment

alexanderbez commented Jun 15, 2020

fedekunze left a comment

fedekunze commented Jun 15, 2020

jgimeno Jun 16, 2020

alexanderbez Jun 16, 2020 •

edited

jgimeno Jun 16, 2020

alexanderbez Jun 16, 2020 •

edited

jgimeno Jun 16, 2020

		@@ -39,6 +39,7 @@ Ref: https://keepachangelog.com/en/1.0.0/

		### Client Breaking

		* (api) [\#6426](https://github.com/cosmos/cosmos-sdk/pull/6426) The ability to start an out-of-process API REST server has now been removed. Instead, the API server is now started in-process along with the application and Tendermint. Configuration options have been added to `app.toml` to enable/disable the API server along with additional HTTP server options.

Migrate API Server #6426

Migrate API Server #6426

Conversation

alexanderbez commented Jun 12, 2020 • edited

Description

codecov bot commented Jun 12, 2020 • edited

Codecov Report

alexanderbez commented Jun 13, 2020

jackzampolin left a comment

Choose a reason for hiding this comment

fedekunze left a comment

Choose a reason for hiding this comment

fedekunze Jun 13, 2020

Choose a reason for hiding this comment

alexanderbez Jun 14, 2020

Choose a reason for hiding this comment

alessio left a comment

Choose a reason for hiding this comment

alexanderbez commented Jun 15, 2020

fedekunze left a comment

Choose a reason for hiding this comment

fedekunze commented Jun 15, 2020

jgimeno Jun 16, 2020

Choose a reason for hiding this comment

alexanderbez Jun 16, 2020 • edited

Choose a reason for hiding this comment

jgimeno Jun 16, 2020

Choose a reason for hiding this comment

alexanderbez Jun 16, 2020 • edited

Choose a reason for hiding this comment

jgimeno Jun 16, 2020

Choose a reason for hiding this comment

alexanderbez commented Jun 12, 2020 •

edited

codecov bot commented Jun 12, 2020 •

edited

alexanderbez Jun 16, 2020 •

edited

alexanderbez Jun 16, 2020 •

edited