Dynamic control API exposed via gRPC (#32) #33

evdokimovs · 2019-07-04T10:14:59Z

Dynamic control API exposed via gRPC

Resolves #32

Part of 0.2.0 Roadmap #27

Synopsis

Need implement dynamic control API exposed via gRPC. In this PR will be implemented only Create, Get and Delete methods. Apply is not part of this PR and will be implemented in the future.

Solution

Checklist

evdokimovs · 2019-07-12T15:56:25Z

@alexlapa , @tyranron ,

С #[automatically_derived] clippy все равно ругается, поэтому оставлю вариант с #[allow()].

evdokimovs · 2019-07-15T09:39:21Z

@alexlapa ,

На данный момент у нас в proto спеке во всех эндпоинтах есть поле dst. Насколько оно нам вообще нужно? На данный момент же получатель находится сам на стороне сервера. Это пережитки прошлого и стоит удалить эти поля, или есть какой-то другой смысл, которого я не знаю?

tyranron · 2019-07-15T10:42:52Z

@evdokimovs the referred spec is just an example. The dst field is used in some media elements to show how it could be declared. The meaning of the src and dst fields maps directly to source and sink notions of GStreamer elements (ability to specify elements where from/to a media stream should flow).

If you do not need these fields in the current implementation at all, then just do not declare them.

evdokimovs · 2019-07-15T11:11:57Z

@tyranron ,

@evdokimovs the referred spec is just an example. The dst field is used in some media elements to show how it could be declared. The meaning of the src and dst fields maps directly to source and sink notions of GStreamer elements (ability to specify elements where from/to a media stream should flow).

If you do not need these fields in the current implementation at all, then just do not declare them.

Хорошо, спасибо.

evdokimovs · 2019-07-17T14:51:59Z

FCM

Implement dynamic Control API exposed via gRPC (#33, #32)

- add gRPC Control API server
- implement 'Create', 'Delete', 'Get' methods of Control API
- add client for manual tests of gRPC control API
- add E2E tests for gRPC Control API
- add '[server.control.grpc]' section to configure Control API gRPC server
- add 'server.client.http.public_url' option to configure public URL of Client API HTTP server

Additionally:
- rename '[server]' section of Client API HTTP server as '[server.client.http]'
- add global app context
- use tinyurl.com instead of tiny.cc in docs
- add printing info about module and line in logs
- fix medea-demo:edge Dockerfile

alexlapa

@evdokimovs ,

Необходимо актуализировать ветку. И вешаю waiting до завершения 0.1.0 milestone.

evdokimovs · 2019-08-02T16:01:54Z

@alexlapa ,

Если сделать запрос ровно в момент выключения gRPC сервера, то вернется такая ошибка:

RpcFailure(RpcStatus { status: Unavailable, details: Some("Socket closed") }).

…n ci]

alexlapa

@evdokimovs ,

Discussed:

Sync with mainline
Some minor changes (added todos)

alexlapa · 2019-10-18T12:56:55Z

@evdokimovs ,

Там косячек с medea-demo:edge, засуньте туда в Dockerfile FROM alexlapa/rust-beta:1.39-beta.5, пожалуйста.

tyranron

FCM

Implement dynamic Control API exposed via gRPC (#33, #32)

- integrate gRPC Control API server
- imp 'Create', 'Delete', 'Get' methods of Control API
- add temporary client for manual tests of gRPC Control API
- create E2E tests for gRPC Control API
- add '[server.control.grpc]' section to configure Control API gRPC server
- rename '[server]' section of Client API HTTP server as '[server.client.http]'
- add 'server.client.http.public_url' option to configure public URL of Client API HTTP server

Additionally:
- expose configuration changes in 'medea-demo' Helm chart values and bump up its version to 0.2.0
- use tinyurl.com instead of tiny.cc in docs
- remove installing 'rustfmt' on CI as it now goes in default profile for rustup
- fix missing CMake installation in Dockerfile
- describe explicit env var names in configuration file
- provide global AppContext
- add module path and file line number to logs
- refactor types and attributes usage in 'conf' module and split tests by submodules

tyranron · 2019-10-25T07:18:52Z

jason/demo/chart/medea-demo/values.yaml

-      bind_port: 8080
+      client:
+        http:
+          public_url: ws://127.0.0.1:8080/ws


Changes to Helm chart, especially breaking ones, should go with chart's version bump.

tyranron · 2019-10-25T07:28:02Z

proto/control-api/src/grpc/api.proto

@@ -36,10 +36,10 @@ message CreateRequest {
  }
 }

-// Request with many Elements IDs.
+// Request with many Elements Full IDs (FIDs) elements.


Please, be more careful with docs formulation.

tyranron · 2019-10-25T07:30:18Z

proto/control-api/src/grpc/api.proto

 message CreateRequest {
-  // ID of the Element to be created..
-  string id = 1;
+  // Full ID (FID) of the Element in which will be created provided element.


When dealing with abbreviations, it's better to do vice versa: first goes abbreviation and then full words in parentheses.

FID (full ID)

Such approach leads people towards abbreviation use.

tyranron · 2019-10-25T07:35:35Z

src/api/client/session.rs

@@ -99,7 +99,7 @@ impl Actor for WsSession {
    /// Starts [`Heartbeat`] mechanism and sends [`RpcConnectionEstablished`]
    /// signal to the [`Room`].
    fn started(&mut self, ctx: &mut Self::Context) {
-        debug!("Started WsSession for member {}", self.member_id);
+        debug!("Started WsSession for Member [id = {}]", self.member_id);


You do not need interpolation/formatting in logs when you're using structured logs already. Leverage the power of abstractions you're using.

Consider to refactor it in a separate PR. All lines like the one above should be refactored in the following manner:

debug!("Started WsSession for Member"; "Member.id" => self.member_id);

This will serve good both for reading in console, indexing in logs aggregation databases and reducing ops per log line.

tyranron · 2019-10-25T07:46:51Z

.travis.yml

@@ -20,8 +20,6 @@ stages:

 jobs:
  allow_failures:
-    - rust: nightly
-      stage: check


Yeah, rustfmt now goes in a default profile for rustup, however, it still can be missing in nightly builds.

tyranron · 2019-10-25T08:15:46Z

src/signalling/participants.rs

+
+    /// Some error happened in [`Member`].
+    #[display(fmt = "{}", _0)]
+    MemberError(MemberError),


This is unnecessary. Omitting attribute will result in the same trvivial implementation.

tyranron · 2019-10-25T08:17:19Z

src/signalling/participants.rs

    ///
-    /// Returns [`AuthorizationError::InvalidCredentials`] if [`Member`]
+    /// Returns [`Err(AuthorizationError::InvalidCredentials)`] if [`Member`]


I doubt that will render in docs OK.

evdokimovs added feature New feature or request k::api Related to API (application interface) labels Jul 4, 2019

evdokimovs added this to the 0.2.0 milestone Jul 4, 2019

evdokimovs self-assigned this Jul 4, 2019

evdokimovs marked this pull request as ready for review July 17, 2019 15:04

evdokimovs requested a review from alexlapa July 17, 2019 15:04

alexlapa added the waiting: materials There is a need for additional actions/info outside the issue/PR to continue its solving. label Jul 19, 2019

alexlapa suggested changes Jul 19, 2019

View reviewed changes

evdokimovs added 4 commits August 16, 2019 19:33

Optimize caching for Travis CI [run ci]

9d00297

Down services when e2e test fail

6572962

Fix Travis if

5d1dc10

Add contributing guide

e3386af

tyranron force-pushed the master branch 3 times, most recently from 8f9956c to 7432f56 Compare August 21, 2019 14:55

evdokimovs added 9 commits August 21, 2019 19:46

Commit for check that CI works [run ci]

4fe5b90

Fix e2e tests, remove $(shell)

b97dc21

Merge branch 'master' into static-control-api

690053b

Fix docs refs

7574f1f

Update CHANGELOG [run ci]

d2a5eba

Remove allow clippy::use_self from jason, use stable clippy in CI [ru…

e510d43

…n ci]

Add dockerized building, upd contributing guide [run ci]

d824aa2

Merge branch 'master' into static-control-api

e86257a

Fix Makefile [run ci]

9b83a5b

evdokimovs added 2 commits October 16, 2019 17:10

Fix docs

b7c92fa

Small fix

3886462

evdokimovs requested a review from alexlapa October 16, 2019 14:28

some fixes

d20067d

alexlapa suggested changes Oct 18, 2019

View reviewed changes

evdokimovs added 3 commits October 18, 2019 15:31

Move sids to room_service

a15e47c

Create Room on empty unparsed FID [run ci]

0da8c7a

Merge branch 'master' into 32-grpc-dynamic-control-api [run ci]

cb4f121

evdokimovs added 5 commits October 18, 2019 16:02

Use alexlapa in Jason Dockerfile [run ci]

48d7d8a

Fix log level in config [run ci]

e6148b4

Run rustfmt on latests nightly [run ci]

66d2e84

Remove allow failure from rustfmt [run ci]

2e68c94

Small naming changes [run ci]

45ed048

evdokimovs requested a review from alexlapa October 18, 2019 15:08

extend grpc e2e tests [run ci]

f8f7cc9

alexlapa approved these changes Oct 21, 2019

View reviewed changes

alexlapa requested a review from tyranron October 21, 2019 09:02

tyranron added 3 commits October 25, 2019 09:31

Bump up chart version to 0.2.0

d748f63

Correct docs in proto spec

5a0a946

Docs and code style corrections

a3db13d

tyranron approved these changes Oct 25, 2019

View reviewed changes

evdokimovs added 3 commits October 25, 2019 14:20

Fix sink creating [run ci]

3d29f44

Fix rustfmt installation [run ci]

483fa74

Update Cargo.lock [run ci]

2467eb0

evdokimovs changed the title ~~WIP: Dynamic control API exposed via gRPC (#32)~~ Dynamic control API exposed via gRPC (#32) Oct 25, 2019

evdokimovs merged commit e71c31c into master Oct 25, 2019

evdokimovs deleted the 32-grpc-dynamic-control-api branch October 25, 2019 13:45

tyranron added enhancement Improvement of existing features or bugfix k::config Related to application configuration labels Oct 25, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dynamic control API exposed via gRPC (#32) #33

Dynamic control API exposed via gRPC (#32) #33

evdokimovs commented Jul 4, 2019 •

edited

Loading

evdokimovs commented Jul 12, 2019

evdokimovs commented Jul 15, 2019

tyranron commented Jul 15, 2019

evdokimovs commented Jul 15, 2019

evdokimovs commented Jul 17, 2019 •

edited by alexlapa

Loading

alexlapa left a comment

evdokimovs commented Aug 2, 2019

alexlapa left a comment

alexlapa commented Oct 18, 2019

tyranron left a comment

tyranron Oct 25, 2019

tyranron Oct 25, 2019

tyranron Oct 25, 2019

tyranron Oct 25, 2019

tyranron Oct 25, 2019

tyranron Oct 25, 2019

tyranron Oct 25, 2019

tyranron Oct 25, 2019

Dynamic control API exposed via gRPC (#32) #33

Dynamic control API exposed via gRPC (#32) #33

Conversation

evdokimovs commented Jul 4, 2019 • edited Loading