Pub/Sub topic where replay is required

errorpubsub-replay-required

The design declares that consumers must be able to replay history. A fan-out topic that does not retain messages cannot deliver that.

Severity: error
Selects: every node of kind pubsub-topic
Components in scope: 13

What it checks

It looks at every node of kind pubsub-topic, and fires when:

— all of these hold:
— the design requirement `messaging.replay` is true
— the node's `replay` is false

Message

Topic '{{node.id}}' cannot replay messages, but the design requires replay. Use a stream or a replayable queue.

{{node.id}} style paths are filled in from the node, the edge or the design the finding is about.

Applies to · 13 components

Pub/Sub topic pubsub-topic

Tripped by · 5

Reference designs whose broken twin names this rule in its header. The gate reads the same header, and fails when a rule no design trips.

facebook-taoreference linear-syncreference order-processingreference pokemon-goreference spotify-playbackreference

Source

1# yaml-language-server: $schema=../schema/rule.schema.json
2# The design declares that consumers must be able to replay history, but a fan-out topic
3# without replay cannot deliver that. Tripped by designs/order-processing.broken.yaml.
4schemaVersion: "1"
5type: "rule"
6id: "pubsub-replay-required"
7severity: "error"
8select:
9  node:
10    kind: "pubsub-topic"
11when:
12  all:
13    - requirement: "messaging.replay"
14      equals: true
15    - prop: "replay"
16      equals: false
17message: "Topic '{{node.id}}' cannot replay messages, but the design requires replay. Use a stream or a replayable queue."

The same page as markdown, for an agent: /catalogue/rules/pubsub-replay-required.md