BREAKING: feat: get queued outbound message in transport handle message

[dbluhm]

This will enable queues to annotate outbound messages with relevant context for things like dead letter queues that know which wallet sent the message that failed, what message was being sent, etc.

This is a breaking change for plugins adding queue implementations (cc @shaangill025) but we think this is worthwhile for the ability to improve internal error handling.

[swcurran]

@dbluhm -- is this a "hold 0.8.0 release until this is in", or is it OK to wait for the next release?

[dbluhm]

This can wait (sorry for the slow response and glad you didn't wait on me lol)

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[dbluhm]

@swcurran I'd like to see this PR merged but I think the breaking change status has scared us away from merging so far 😅 To reiterate, this breaking change affects only message queue plugins and will not affect deployments not using these plugins. For message queue plugins, the required modifications should be pretty minimal; we have a branch for the Kafka plugin already that incorporates this change. Updating the Redis plugin should be pretty trivial.

[swcurran]

@dbluhm -- shall we merge this one next? @usingtechnology, @Jsyro, @shaangill025 -- who is the best to coordinate what changes need to be made to the plugins for Redis once this is merged.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[usingtechnology]

i guess it will depend on workloads. if @shaangill025 is busy, i could probably jump in and tackle it. do we know if the redis queue plugin is in production anywhere?

[swcurran]

It is being used in BCGov by at least the Mediator dev/test. It may be in use in the prod instance as well.

[swcurran]

Please do. We’re pushing on getting a bunch of merges done now that we have 0.8.2 out the door.

[shaangill025]

I think the changes in Redis plugin to work with this PR will involve the following:
https://github.com/bcgov/aries-acapy-plugin-redis-events/blob/a27cefe5de1b8e74e3c154bf9c782b6dcb4b464b/redis_queue/v1_0/outbound.py#L63

async def handle_message(
      self,
      profile: Profile,
      outbound_message: QueuedOutboundMessage,
      endpoint: str,
      metadata: dict = None,
      api_key: str = None,
  ):
      """Prepare and send message to external queue."""
      payload = outbound_message.payload

Also adding QueuedOutboundMessage import here

[dbluhm]

As @shaangill025 outlined, changes were pretty minimal so I went ahead and opened a PR with those changes over there.

[dbluhm]

Please do. We’re pushing on getting a bunch of merges done now that we have 0.8.2 out the door.

A little unclear to me: are there external dependencies blocking this PR specifically or can we go ahead and merge?

[swcurran]

No. We’ll merge. We are also going to do a tag on the Redis plugin on the commit before merging this one to point out the breaking change.