Search index without an asynchronous feed

errorderived-store-without-cdc-or-rebuild

A search index is derived data and needs an asynchronous feed from a stream, change data capture or an indexing worker. Without one it is written inline on the request path, and it can never be rebuilt after it drifts.

Severity: error
Selects: every node of kind search-index
Components in scope: 32

What it checks

It looks at every node of kind search-index, and fires when:

— this does not hold:
— the node has at least one asynchronous incoming edge from a stream, change-data-capture or worker

Message

Search index '{{node.id}}' has no asynchronous feed from a stream, change data capture or worker. It cannot be rebuilt or kept in sync independently of the write path.

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

Applies to · 32 components

Search index search-index

Tripped by · 15

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.

airbnb-searchreference booking-searchreference facebook-taoreference gitlab-architecturereference grab-georeference instagram-feedreference lyft-envoyreference notion-shardingreference proximity-servicereference stack-overflowreference tinder-georeference twitch-livereference twitter-timelinereference uber-dispatchreference x-recommendationreference

Source

1# yaml-language-server: $schema=../schema/rule.schema.json
2# A search index is derived data. If nothing feeds it asynchronously (a stream, change data
3# capture or an indexing worker) it is either written inline on the request path or never
4# rebuilt after drift. Tripped by: designs/twitter-timeline.broken.yaml
5schemaVersion: "1"
6type: "rule"
7id: "derived-store-without-cdc-or-rebuild"
8severity: "error"
9select:
10  node:
11    kind: "search-index"
12when:
13  not:
14    hasEdge:
15      direction: "in"
16      mode: "async"
17      peerKind: ["stream", "change-data-capture", "worker"]
18message: "Search index '{{node.id}}' has no asynchronous feed from a stream, change data capture or worker. It cannot be rebuilt or kept in sync independently of the write path."

The same page as markdown, for an agent: /catalogue/rules/derived-store-without-cdc-or-rebuild.md