Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat: embedded REST proxy and web console server #729

Merged
merged 16 commits into from
May 8, 2021

Conversation

dmacvicar
Copy link
Contributor

@dmacvicar dmacvicar commented May 2, 2021

This PR adds the option to start a REST API server which proxies the gRPC API ('/api` on :8080)

If built with make WEBCONSOLE=1, the frontendcode is embedded using statik and served on /. This is automatically configured via build tags. If no tag or make option is given, the webconsole is not setup.

So it goes like this:

  • immudb runtime option -> enables web server
  • If compiled with webconsole support, web server also serves a webconsole, if not, only API

The option is called WebServer, as I did not want to be more granular about the API and the web console. They use the same server and port.

Missing in draft:

Notes

  • The way I figure out where to connect for the gRPC API is simple: if we bind to 0.0.0.0, I use 127.0.0.1. If not, I use the address bind address as specified by the user. there is no client connection anymore. ImmuServiceServer is used.
  • The reason to use statik over go:embed is to support building with Go < 1.16

@dmacvicar dmacvicar force-pushed the feat/embedded-rest-proxy branch 2 times, most recently from 3592aeb to bb2d515 Compare May 7, 2021 14:23
@coveralls
Copy link
Collaborator

coveralls commented May 7, 2021

Coverage Status

Coverage increased (+0.07%) to 88.095% when pulling ab04363 on feat/embedded-rest-proxy into 8a73ab4 on master.

@dmacvicar dmacvicar marked this pull request as ready for review May 7, 2021 15:28
jeroiraz
jeroiraz previously approved these changes May 7, 2021
…PC client

Note that the generated gateway code has a comment about this:

// RegisterImmuServiceHandlerServer registers the http handlers for service ImmuService to "mux".
// UnaryRPC     :call ImmuServiceServer directly.
// StreamingRPC :currently unsupported pending grpc/grpc-go#906.
// Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterImmuServiceHandlerFromEndpoint instead.
func RegisterImmuServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ImmuServiceServer) error {
@dmacvicar dmacvicar merged commit 40e76e5 into master May 8, 2021
@byo byo deleted the feat/embedded-rest-proxy branch October 14, 2022 10:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants