Add mediator and simple client implementation #977

nain-F49FF806 · 2023-09-13T23:52:34Z

Client agent has majorly common code with mediator agent.
It's in essence one hybrid, with code organized separately.
This is in anticipation of splitting client into separate binary.

Then again, Aries agents are meant to be horizontal (p2p). So perhaps a multifunctional agent isn't all that odd.

codecov-commenter · 2023-09-14T00:19:27Z

Codecov Report

Merging #977 (e020eba) into main (dbaac13) will increase coverage by 0.00%.
The diff coverage is n/a.

❗ Current head e020eba differs from pull request most recent head 23fd9fa. Consider uploading reports for the commit 23fd9fa to get more accurate results

@@           Coverage Diff           @@
##             main     #977   +/-   ##
=======================================
  Coverage   36.31%   36.32%           
=======================================
  Files         386      386           
  Lines       22040    22040           
  Branches     4062     4073   +11     
=======================================
+ Hits         8003     8005    +2     
  Misses      11877    11877           
+ Partials     2160     2158    -2

Flag	Coverage Δ
unittests-aries-vcx	`36.32% <ø> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 4 files with indirect coverage changes

Patrik-Stas · 2023-10-03T12:43:58Z

Hi @nain-F49FF806 note that all of the commits must be DCO signed

nain-F49FF806 · 2023-10-03T13:33:57Z

@Patrik-Stas Yes. This PR is currently WIP. (Specifically the unsigned commit)

I was using the (absence of) DCO as an automatic block. 😅

Patrik-Stas

review is not complete yet (far from it), but just submitting my intermediate comments

mediator/Cargo.toml

mediator/src/bin/mediator.rs

mediator/src/agent/mod.rs

Signed-off-by: Naian <[email protected]>

Has majorly common code with mediator agent. It's in essence one hybrid, with organized code. Then again, aries agents are meant to be horizontal. Signed-off-by: Naian <[email protected]>

Signed-off-by: Naian <[email protected]>

The workspace Cargo.lock will be used since mediator is now part of workspace. This can be removed Signed-off-by: Naian <[email protected]>

Signed-off-by: Naian <[email protected]>

Patrik-Stas · 2023-10-20T17:53:04Z

agents/rust/mediator/.cargo/config.toml

this is commented, shall be removed?

Patrik-Stas · 2023-10-20T17:54:01Z

agents/rust/mediator/README.md

+
+Currently exposed endpoints.
+
+```yaml


the endpoints below are now out of sync - but note my comments on endpoint routes, before you start changing this

Patrik-Stas · 2023-10-20T17:55:40Z

agents/rust/mediator/README.md

+    Encrypted Aries messages (envelops) can be passed and received from this endpoint in json serialized format.
+```
+
+### Client API


let's remove this, for once, I am not sure if there a value to the web client, I think TUI is a lot nicer, secondly if we were to keep this, it would probably be separate project. Let's keep this readme focus on mediator only

Patrik-Stas · 2023-10-20T17:58:40Z

agents/rust/mediator/client-webapi/Cargo.toml

I mentioned elsewhere, but why don't we just keep the TUI in favor of this?

Patrik-Stas · 2023-10-20T17:59:43Z

agents/rust/mediator/mediation/.github/workflows/rust-basic.yml

let's keep all workflows in the root .github/ directory

Patrik-Stas · 2023-10-20T18:11:08Z

agents/rust/mediator/mediation/README.md

+> The commits are made in such a way as to demonstrate and try one feature or workflow (refactoring) at a time.  
+> So the git log could be educative.  
+>
+> ## Some Interesting commits


Feel free to include this somewhere along project plan notes, but probably doesn't belong here.

Patrik-Stas · 2023-10-20T18:16:37Z

agents/rust/mediator/mediation/src/router.rs

+        .route("/forward", post(handle_forward))
+        .route("/pickup", post(handle_pickup))


these can be either:

a single didcomm endpoint

or 2 endpoints as you have it, but then I'd suggest /didcomm for 3rd party fw messages and /didcomm-client for didcomm messages from clients (eg connections, mediation coordition, pickup)

2 endpoints can be really good idea from oversight perspective, in logs it would be easier to distinguish between incoming 3rd party messages, client messages and plot stats and graphs out of that data

Patrik-Stas · 2023-10-20T18:18:43Z

agents/rust/mediator/mediation/src/routes/json.rs

+pub async fn respond_message_json(Json(body): Json<MessageJson>) -> Json<MessageResponseJson> {
+    Json(MessageResponseJson {
+        message: (body.message),
+        response: ("I am groot".to_owned()),


Patrik-Stas · 2023-10-20T18:23:48Z

agents/rust/mediator/mediation/src/server.rs

+    let app = create_router().await;
+    info!("Starting server");
+    // add server task to main loop
+    axum::Server::bind(&"127.0.0.1:7999".parse().unwrap())


Let's the IP and the port configurable. You can keep the current values as defaults

Patrik-Stas · 2023-10-20T18:24:49Z

agents/rust/mediator/mediation/src/storage/database/mod.rs

+// Copyright 2023 Naian G.
+// SPDX-License-Identifier: Apache-2.0
+
+// unimplemented!()


if we going with mysql only, I guess we can remove the commented code?

Patrik-Stas · 2023-10-20T18:27:59Z

@nain-F49FF806 I've left another round of comments. I think we could get initial version merged after these, and we can keep bigger improvements in a todo list externally

Signed-off-by: Patrik <[email protected]>

Patrik-Stas · 2023-10-24T16:02:51Z

For now, I am merging this as is~ The outstanding comments shall be addressed in subsequent PRs

nain-F49FF806 force-pushed the nain/mediator-client branch 2 times, most recently from ba7b96f to f619fab Compare September 14, 2023 00:02

nain-F49FF806 force-pushed the nain/mediator branch from 4adc7dd to d07c054 Compare September 19, 2023 03:01

nain-F49FF806 force-pushed the nain/mediator-client branch 4 times, most recently from 241be31 to 54026f3 Compare September 21, 2023 18:43

nain-F49FF806 force-pushed the nain/mediator-client branch 2 times, most recently from 3b6393e to 66dc3a4 Compare October 3, 2023 11:31

nain-F49FF806 changed the title ~~Add simple client implementation~~ Add mediator and simple client implementation Oct 3, 2023

nain-F49FF806 force-pushed the nain/mediator branch from d07c054 to 2821f11 Compare October 3, 2023 11:42

nain-F49FF806 mentioned this pull request Oct 3, 2023

Initial mediator work #976

Closed

nain-F49FF806 changed the base branch from nain/mediator to main October 3, 2023 11:46

nain-F49FF806 force-pushed the nain/mediator-client branch 3 times, most recently from f66a1b3 to 23932c2 Compare October 6, 2023 16:41

Patrik-Stas requested changes Oct 10, 2023

View reviewed changes

nain-F49FF806 force-pushed the nain/mediator-client branch 3 times, most recently from ea170f4 to 8bb431e Compare October 12, 2023 15:25

nain-F49FF806 added 7 commits October 13, 2023 14:37

Mediator oob invitation poc

1ca8468

Signed-off-by: Naian <[email protected]>

catch panics

066cfbf

Signed-off-by: Naian <[email protected]>

Take endpoint root address from environment variable

9b3f954

Signed-off-by: Naian <[email protected]>

Add readme with instructions

ab1ca13

Signed-off-by: Naian <[email protected]>

Add simple client implementation

3ee2b5f

Has majorly common code with mediator agent. It's in essence one hybrid, with organized code. Then again, aries agents are meant to be horizontal. Signed-off-by: Naian <[email protected]>

Add binary (functional) crate for client

0108c99

Signed-off-by: Naian <[email protected]>

docs: update mediator/README.md

11fe11f

Signed-off-by: Naian <[email protected]>

nain-F49FF806 added 24 commits October 18, 2023 20:30

chore: cargo +nightly fmt

271df64

Signed-off-by: Naian <[email protected]>

refactor(mediator): move to different subdirectory

fde73dc

Signed-off-by: Naian <[email protected]>

refactor: regular target dir

8395967

Signed-off-by: Naian <[email protected]>

refactor(mediator): conditional compilation of client tui.

38df22b

Signed-off-by: Naian <[email protected]>

chore: delete Cargo.lock

8386049

The workspace Cargo.lock will be used since mediator is now part of workspace. This can be removed Signed-off-by: Naian <[email protected]>

refactor: move client features behind feature flags

77fdaec

Signed-off-by: Naian <[email protected]>

cargo +nightly fmt

ca77ca0

Signed-off-by: Naian <[email protected]>

refactor: inline mediation code (including mediator persistence)

f7a459f

Signed-off-by: Naian <[email protected]>

cargo +nightly fmt

45842ec

Signed-off-by: Naian <[email protected]>

clippy fixes

7e6f468

Signed-off-by: Naian <[email protected]>

cargo +nightly fmt inlined package

b11bd27

Signed-off-by: Naian <[email protected]>

refactor: comment out unimplemented features

05cea28

Signed-off-by: Naian <[email protected]>

refactor: move didcomm+protocol handlers to separate layer

70c36e1

Signed-off-by: Naian <[email protected]>

chore: small cleanup changes.

ed87eba

Signed-off-by: Naian <[email protected]>

ci(mediator): ci fixes and other fixes

a02c1fe

Signed-off-by: Naian <[email protected]>

chore(mediator-client): cleanup agent client code

4e2f09a

Signed-off-by: Naian <[email protected]>

docs: Update readme, and client endpoint

8a7a45b

Signed-off-by: Naian <[email protected]>

build(deps): update version number after refactor

7d351cf

Signed-off-by: Naian <[email protected]>

ci: update sqlx database migrations path

7474032

Signed-off-by: Naian <[email protected]>

test: separate repeated pieces of code into own functions

03053f3

Signed-off-by: Naian <[email protected]>

chore: cargo clipy --tests

2b4cc37

Signed-off-by: Naian <[email protected]>

refactor: rename AgentMaker -> AgentBuilder

fbc0987

Signed-off-by: Naian <[email protected]>

refactor(mediator-client): move to separate package

df49c68

Signed-off-by: Naian <[email protected]>

refactor(mediator-client-tui): move to separate package

e020eba

Signed-off-by: Naian <[email protected]>

Patrik-Stas requested changes Oct 20, 2023

View reviewed changes

Merge branch 'main' into nain/mediator-client

23fd9fa

Signed-off-by: Patrik <[email protected]>

Patrik-Stas merged commit 04b486b into main Oct 24, 2023
30 of 31 checks passed

Patrik-Stas deleted the nain/mediator-client branch October 24, 2023 16:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add mediator and simple client implementation #977

Add mediator and simple client implementation #977

nain-F49FF806 commented Sep 13, 2023 •

edited

Loading

codecov-commenter commented Sep 14, 2023 •

edited

Loading

Patrik-Stas commented Oct 3, 2023

nain-F49FF806 commented Oct 3, 2023

Patrik-Stas left a comment

Patrik-Stas Oct 20, 2023

Patrik-Stas Oct 20, 2023

Patrik-Stas Oct 20, 2023

Patrik-Stas Oct 20, 2023

Patrik-Stas Oct 20, 2023

Patrik-Stas Oct 20, 2023

Patrik-Stas Oct 20, 2023

Patrik-Stas Oct 20, 2023

Patrik-Stas Oct 20, 2023

Patrik-Stas Oct 20, 2023

Patrik-Stas commented Oct 20, 2023

Patrik-Stas commented Oct 24, 2023

		.route("/forward", post(handle_forward))
		.route("/pickup", post(handle_pickup))


		Currently exposed endpoints.

		```yaml

Add mediator and simple client implementation #977

Add mediator and simple client implementation #977

Conversation

nain-F49FF806 commented Sep 13, 2023 • edited Loading

codecov-commenter commented Sep 14, 2023 • edited Loading

Codecov Report

Patrik-Stas commented Oct 3, 2023

nain-F49FF806 commented Oct 3, 2023

Patrik-Stas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Patrik-Stas commented Oct 20, 2023

Patrik-Stas commented Oct 24, 2023

nain-F49FF806 commented Sep 13, 2023 •

edited

Loading

codecov-commenter commented Sep 14, 2023 •

edited

Loading