dogmatiq / interopspec

🚧 Protocol Buffers and gRPC definitions for improving engine interoperability.

Engine Interoperability Specification

Protocol Buffers and gRPC definitions that help improve interoperability between different Dogma engine implementations.

interopspec's Issues

Add ConfigAPI operation for loading single application config by key.

Change event stream API to support multiple ways of specifying the "start point".

A ConsumeRequest currently requires an offset, but this should just be one of several different ways to specify the start point within the stream.

We should have a message type named something like StartAtOffset that contains the offset, and ConsumeRequest can use a one_of to allow this type or any future types we may add.

Split CommandQueue service into separate inbound/outbound services.

Event stream partitioning.

The current event stream API does not allow specification of a stream within an application. It is assumed that every application has exactly one stream (as is the case with Verity).

We need to support multiple streams per application. This could be done by adding an additional piece of information to the API - a "partition ID" or "stream ID".

Another approach would be to simply rename "application ID" to "stream ID" within the consume request. Verity would simply use the application as the stream ID, whereas Veracity would be free to expose multiple streams with other IDs.

Regardless of the approach taken, the event stream API will need a way to enumerate the available streams.

There may also be a requirement to include "site" information in the API.

Use empty causation/correlation ID to signal root messages.

When a message is NOT caused by any other message, its causation and correlation IDs are set to its own message ID. We could save a little space on the wire and on disk if we instead allowed the zero-value to represent this state.

Add "site" concept to message envelope, etc.

This is a "site" in the NServiceBus sense, that is, an "installation site" of a specific application. It serves to disambiguate between two separate deployments (not just separate running instances) of a particular application.

Encode UUIDs (handler keys, etc) as two uint64s.

Merge other specs into this repo.

• envelopespec
• transportspec
• dogmatiq/configkit#103

Each in its own sub directory.