fix: mediator updates #432

TimoGlastra · 2021-08-20T08:23:57Z

extract logic for implicit pickup from websocket transport to mediation module
- This will make it easier to move to implicit pickup of non-websocket transports
add test for restarting recipient agent
add timeout to return when is connected
fix issue where services were not reassigned after sorting or filtering
add persistence for mediator routing keys

Signed-off-by: Timo Glastra <timo@animo.id>

codecov-commenter · 2021-08-20T08:33:15Z

Codecov Report

Merging #432 (5ea2270) into main (56cb9f2) will increase coverage by 0.41%.
The diff coverage is 68.81%.

@@            Coverage Diff             @@
##             main     #432      +/-   ##
==========================================
+ Coverage   85.66%   86.07%   +0.41%     
==========================================
  Files         249      252       +3     
  Lines        5351     5394      +43     
  Branches      796      797       +1     
==========================================
+ Hits         4584     4643      +59     
+ Misses        767      751      -16

Impacted Files	Coverage Δ
packages/core/src/types.ts	`100.00% <ø> (ø)`
packages/core/src/transport/WsOutboundTransport.ts	`7.81% <18.18%> (+3.86%)`	⬆️
...ckages/core/src/modules/routing/RecipientModule.ts	`63.81% <21.73%> (+0.77%)`	⬆️
packages/core/src/agent/MessageSender.ts	`71.42% <33.33%> (ø)`
.../modules/connections/services/ConnectionService.ts	`98.85% <100.00%> (+<0.01%)`	⬆️
...odules/routing/repository/MediatorRoutingRecord.ts	`100.00% <100.00%> (ø)`
...es/routing/repository/MediatorRoutingRepository.ts	`100.00% <100.00%> (ø)`
...kages/core/src/modules/routing/repository/index.ts	`100.00% <100.00%> (ø)`
...re/src/modules/routing/services/MediatorService.ts	`73.00% <100.00%> (+4.03%)`	⬆️
packages/core/src/storage/BaseRecord.ts	`72.22% <100.00%> (ø)`
... and 9 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 56cb9f2...5ea2270. Read the comment docs.

TimoGlastra · 2021-08-20T11:30:30Z

packages/core/src/agent/MessageSender.ts

    const queueService = allServices.find((s) => isDidCommTransportQueue(s.serviceEndpoint))

    //If restrictive will remove services not listed in schemes list
    if (transportPriority?.restrictive) {
-      services.filter((service) => {
+      services = services.filter((service) => {


@JamesKEbert @burdettadam The services were not being reassigned meaning the sort and filter did not do anything. This should fix it.

This means that currently it will take the http endpoint, send the ping and receive the ping response after which the http endpoint is closed 😄

So if we could merge this rather sooner than later that would be great!

How embarrassing! Thanks for catching that.

Whoooops--my bad!
As a side note, the array.sort() method does actually do its operation in place and returns too, so it doesn't necessarily have to be reassigned too, but doesn't hurt to reassign it. :)

Ah you're right. So weird that filter does not do its operation in place, but sort does. Thanks

Signed-off-by: Timo Glastra <timo@animo.id>

JamesKEbert

These are great, thanks @TimoGlastra! I am okay merging, but definitely would like to remove our need to externalize the connectionRecords to the transports.

JamesKEbert · 2021-08-21T00:30:46Z

packages/core/src/transport/WsOutboundTransporter.ts

    this.transportTable.forEach((socket) => {
      socket.removeEventListener('message', this.handleMessageEvent)
      socket.close()
    })
  }

  public async sendMessage(outboundPackage: OutboundPackage) {
-    const { payload, endpoint } = outboundPackage
+    const { payload, endpoint, connection } = outboundPackage


I personally would really like to see this be connectionId as a string vs sending the whole connectionRecord, since that starts to really tie our transports into the inner workings of the Framework more than they are now.

That's an interesting point. But connectionRecrod is already part of the public API of the framework 🤔 If you think we're exposing too much framework internal info via connectionRecord, maybe, we should introduce some domain object hiding unnecessary details.

jakubkoci · 2021-08-21T07:20:57Z

packages/core/src/modules/routing/RecipientModule.ts

+      })
+
+    await this.openMediationWebSocket(mediator)
+  }


Shouldn't those methods be part of the transport layer rather than inside the core of the framework? Or, it's just temporary?

What it does is sending a trust ping message with a restriction to only use websocket. The websocket will be kept alive autmoatically (I'd like to make the keep alive more explicit)

I'm not sure yet how we could nicely integrate this into the transport layer. Would be nice to not make it WebSocket specific (so just send a ping and keep the socket alive), but we need to specify somewhere which transports are capable of this, as e.g. HTTP isn't.

Maybe a transport should be able to specify whether it can send multiple messages (WebSocket is ∞, while HTTP is 1 request, 1 response). That way we wouldn't have to specify WS explicitly, but rather whether we want a transport that can stay open (for implicit pickup)

I'm going to think about it for a while. We can have a discussion about it in the WG call

I have opened #435. Please leave your thoughts :)

jakubkoci · 2021-08-21T07:31:48Z

packages/core/src/transport/WsOutboundTransporter.ts

    this.transportTable.forEach((socket) => {
      socket.removeEventListener('message', this.handleMessageEvent)
      socket.close()
    })
  }

  public async sendMessage(outboundPackage: OutboundPackage) {
-    const { payload, endpoint } = outboundPackage
+    const { payload, endpoint, connection } = outboundPackage


That's an interesting point. But connectionRecrod is already part of the public API of the framework 🤔 If you think we're exposing too much framework internal info via connectionRecord, maybe, we should introduce some domain object hiding unnecessary details.

jakubkoci · 2021-08-21T07:34:36Z

I see there is some bugfix as part of the PR so we should merge it.

Signed-off-by: Timo Glastra <timo@animo.id>

TimoGlastra added 5 commits August 20, 2021 10:07

fix: persist mediator routing keys

03c6636

Signed-off-by: Timo Glastra <timo@animo.id>

fix: services were not reassigned

df4af99

Signed-off-by: Timo Glastra <timo@animo.id>

test: add mediation recipient restart test

174b8d2

Signed-off-by: Timo Glastra <timo@animo.id>

fix: add timeout to return when is connected

4dd6e4e

Signed-off-by: Timo Glastra <timo@animo.id>

refactor: extract pickup logic from ws transport

5d79591

Signed-off-by: Timo Glastra <timo@animo.id>

TimoGlastra requested a review from a team as a code owner August 20, 2021 08:23

TimoGlastra requested a review from burdettadam August 20, 2021 08:24

TimoGlastra commented Aug 20, 2021

View reviewed changes

TimoGlastra linked an issue Aug 20, 2021 that may be closed by this pull request

Mediator routing keys are not persisted between startups #423

Closed

berendsliedrecht approved these changes Aug 20, 2021

View reviewed changes

feat: return mediation record from provision

b17d57f

Signed-off-by: Timo Glastra <timo@animo.id>

burdettadam approved these changes Aug 20, 2021

View reviewed changes

JamesKEbert approved these changes Aug 21, 2021

View reviewed changes

jakubkoci approved these changes Aug 21, 2021

View reviewed changes

refactor: connection id instead of record

63c9254

Signed-off-by: Timo Glastra <timo@animo.id>

TimoGlastra enabled auto-merge (squash) August 21, 2021 09:57

TimoGlastra added 3 commits August 21, 2021 11:59

Merge branch 'main' into feat/mediation-updates

4a73348

Merge remote-tracking branch 'upstream/main' into feat/mediation-updates

18a2ed4

test: fix mediation test

5ea2270

Signed-off-by: Timo Glastra <timo@animo.id>

TimoGlastra merged commit 163cda1 into openwallet-foundation:main Aug 21, 2021

TimoGlastra deleted the feat/mediation-updates branch October 28, 2021 10:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: mediator updates #432

fix: mediator updates #432

TimoGlastra commented Aug 20, 2021

codecov-commenter commented Aug 20, 2021 •

edited

TimoGlastra Aug 20, 2021

burdettadam Aug 20, 2021

JamesKEbert Aug 20, 2021

TimoGlastra Aug 21, 2021 •

edited

JamesKEbert left a comment

JamesKEbert Aug 21, 2021

jakubkoci Aug 21, 2021

jakubkoci Aug 21, 2021

TimoGlastra Aug 21, 2021

TimoGlastra Aug 21, 2021

jakubkoci Aug 21, 2021

jakubkoci commented Aug 21, 2021

fix: mediator updates #432

fix: mediator updates #432

Conversation

TimoGlastra commented Aug 20, 2021

codecov-commenter commented Aug 20, 2021 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TimoGlastra Aug 21, 2021 • edited

Choose a reason for hiding this comment

JamesKEbert 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

jakubkoci commented Aug 21, 2021

codecov-commenter commented Aug 20, 2021 •

edited

TimoGlastra Aug 21, 2021 •

edited