Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 109 additions & 1 deletion content/docs/kernel/cluster.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -322,7 +322,44 @@ notification the cache compares the incoming version with the stored one:
This eliminates a whole class of bugs where a slow-arriving "old"
invalidation evicts a "newer" value the node has already learned about.

### 6.2 The metadata change event
### 6.2 The cluster-invalidation family

Cross-node metadata invalidation is not one channel — it is a **family** of
three independent PubSub lanes, late-bound by `MetadataClusterBridgePlugin`
(`@objectstack/service-cluster`) at `kernel:ready`, one per state owner that
goes stale when metadata changes on a different node:

| Lane | Channel | Payload type | Package | Converges |
|---|---|---|---|---|
| 1 — metadata service cache | `metadata.changed` | `ClusterMetadataChangedPayload` | `@objectstack/metadata` | `MetadataManager`'s registry/list caches |
| 2 — ObjectQL object registry | `metadata.mutated` (`METADATA_MUTATION_CLUSTER_CHANNEL`, #13331) | `ClusterMetadataMutationPayload` | `@objectstack/metadata-protocol` | ObjectQL's OBJECT registry, from a `sys_metadata` re-read |
| 3 — ObjectQL driver registry | `datasource.mutated` (`DATASOURCE_MUTATION_CLUSTER_CHANNEL`, #13805) | `ClusterDatasourceMutationPayload` | `@objectstack/service-datasource` | ObjectQL's DRIVER registry, from a shared datasource-record re-read |

Lanes 2 and 3 share one contract, stated once here rather than in each
channel's own doc comment:

- **Address-only signal.** No message body ever rides these channels — the
payload names only what changed (a metadata address, or a datasource
name), never the changed value.
- **Receipt runs convergence, not trust.** A peer that receives a signal does
not apply the payload as content; it re-reads its OWN copy of the source of
truth (`sys_metadata` for lane 2, the shared datasource record for lane 3)
and converges its local registry from that read. A duplicate or re-ordered
delivery converges to the same state as a single one.
- **`originNode` loopback suppression.** Every payload carries the publishing
node's id; a peer that receives its own `originNode` drops the message —
the write-through or pool rebuild already ran, synchronously, at the door
that persisted the change.
- **At-most-once, bounded by boot rehydration.** No shipped `IPubSub` driver
exceeds at-most-once delivery (§4.2), so a lost message is not retried.
Each lane narrows the staleness window this always had — "until the next
full reload on restart" — to "one network hop"; it does not promise more.

All three lanes skip their fan-out on the same condition — the in-process
`memory` cluster driver, described for lane 1 immediately below, applies
identically to lanes 2 and 3 (#14021).

#### Lane 1 — `metadata.changed` (the metadata service cache)

**Current behaviour.** Cross-node metadata invalidation already works, but
not through any event bus (there isn't one — see §4). The metadata manager
Expand DownExpand Up@@ -382,6 +419,70 @@ guarantee that two rapid updates to the same item are applied to every
node's cache in order, and the at-least-once guarantee would let a briefly
partitioned node catch up on reconnect.

#### Lane 2 — `metadata.mutated` (the ObjectQL object registry)

The metadata **protocol** (`@objectstack/metadata-protocol`) fans out on a
second, independent channel — `METADATA_MUTATION_CLUSTER_CHANNEL =
'metadata.mutated'` (#13331) — with payload type
`ClusterMetadataMutationPayload`:

```ts
// packages/metadata-protocol/src/protocol.ts
export interface ClusterMetadataMutationPayload {
originNode?: string; // used for loopback suppression
event: MetadataMutationEvent; // address-only: type/name/state/org scope, no body
}
```

This lane exists because lane 1 replays into the metadata **service**'s own
caches, not into the ObjectQL **object registry** the runtime authoring path
(`saveMetaItem` → `applyRegistryWriteThrough`) mutates behind the data plane.
Without it, an object authored at runtime through `PUT /api/v1/meta/*`
answers `OBJECT_NOT_FOUND` on every replica that did not perform the write,
until restart — measured on a 3-replica EE deployment: 200 concurrent
creates through the load balancer gave 67×201 / 133×404.

On receipt, a peer suppresses its own `originNode`, then re-reads the row
from its OWN `sys_metadata` and re-runs the registry write-through from that
read (`applyRemoteMetadataMutation`) rather than applying the payload as
content. Attached by `MetadataClusterBridgePlugin`'s protocol lane at
`kernel:ready`, duck-typed against `protocol.attachMetadataMutationPubSub()`
so this package takes no dependency on `@objectstack/metadata-protocol`.

#### Lane 3 — `datasource.mutated` (the ObjectQL driver registry)

The datasource admin service (`@objectstack/service-datasource`) fans out on
a third channel — `DATASOURCE_MUTATION_CLUSTER_CHANNEL =
'datasource.mutated'` (#13805) — with payload type
`ClusterDatasourceMutationPayload`:

```ts
// packages/services/service-datasource/src/datasource-admin-service.ts
export interface ClusterDatasourceMutationPayload {
originNode?: string; // used for loopback suppression
name: string; // the datasource whose shared record was just written
}
```

Lane 2's family, adopted by the driver registry: `registerPool` /
`unregisterPool` mutate the ObjectQL DRIVER registry on the serving replica
only, so before this channel a `DELETE /api/v1/datasources/:name` recovered
`/api/v1/ready` on the one replica that served it, while every other replica
kept the stuck driver until restart. Symmetric by construction — create,
update and delete all publish this one shape, and a receiver cannot tell
which it was without reading, which is the point.

On receipt, a peer suppresses its own `originNode`, then re-reads the shared
datasource record for `name` and converges its own pool from that read
(builds what the read says should be live, rebuilds what changed, evicts
what is gone); convergence for the same name is serialized so two signals in
quick succession — a create chased by an update — apply in order. Attached
by `MetadataClusterBridgePlugin`'s datasource lane at `kernel:ready`,
duck-typed against `datasource-admin.attachDatasourceMutationPubSub()` so
this package takes no dependency on `@objectstack/service-datasource`, and
`@objectstack/objectql` — the driver registry's owner — is handed no bus at
all; the admin service publishes on the write doors it already owns.

### 6.3 Reader contract

> **Status: planned.** Today readers are invalidated by the `metadata.changed`
Expand DownExpand Up@@ -464,6 +565,13 @@ cluster.pubsub.subscribe('metadata.changed', (msg) => {
})
```

> **Already covered?** The subscription above is for a cache that mirrors
> the metadata **service**'s own state (lane 1, §6.2). If what you are
> caching is ObjectQL's **object** or **driver** registry instead, check
> §6.2 first — lanes 2 (`metadata.mutated`) and 3 (`datasource.mutated`)
> already keep those registries converged across replicas, and a second
> subscription would be redundant.

A higher-level cache factory (with automatic version comparison) is part of
the Phase 4 / §6 target design but is **not yet implemented**. No
`if (cluster)` branches are needed either way — the `memory` driver makes
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ import { isInProcessClusterDriver } from './split-brain-guard.js';
* `datasource.mutated` — payload shape defined by
* `ClusterDatasourceMutationPayload` in `@objectstack/service-datasource`.
*
* See `content/docs/kernel/cluster.mdx` §5.
* See `content/docs/kernel/cluster.mdx` §6.2.
*/
export class MetadataClusterBridgePlugin implements Plugin {
name = 'com.objectstack.service.metadata-cluster-bridge';
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 109 additions & 1 deletion content/docs/kernel/cluster.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -322,7 +322,44 @@ notification the cache compares the incoming version with the stored one:
This eliminates a whole class of bugs where a slow-arriving "old"
invalidation evicts a "newer" value the node has already learned about.

### 6.2 The metadata change event
### 6.2 The cluster-invalidation family

Cross-node metadata invalidation is not one channel — it is a **family** of
three independent PubSub lanes, late-bound by `MetadataClusterBridgePlugin`
(`@objectstack/service-cluster`) at `kernel:ready`, one per state owner that
goes stale when metadata changes on a different node:

| Lane | Channel | Payload type | Package | Converges |
|---|---|---|---|---|
| 1 — metadata service cache | `metadata.changed` | `ClusterMetadataChangedPayload` | `@objectstack/metadata` | `MetadataManager`'s registry/list caches |
| 2 — ObjectQL object registry | `metadata.mutated` (`METADATA_MUTATION_CLUSTER_CHANNEL`, #13331) | `ClusterMetadataMutationPayload` | `@objectstack/metadata-protocol` | ObjectQL's OBJECT registry, from a `sys_metadata` re-read |
| 3 — ObjectQL driver registry | `datasource.mutated` (`DATASOURCE_MUTATION_CLUSTER_CHANNEL`, #13805) | `ClusterDatasourceMutationPayload` | `@objectstack/service-datasource` | ObjectQL's DRIVER registry, from a shared datasource-record re-read |

Lanes 2 and 3 share one contract, stated once here rather than in each
channel's own doc comment:

- **Address-only signal.** No message body ever rides these channels — the
payload names only what changed (a metadata address, or a datasource
name), never the changed value.
- **Receipt runs convergence, not trust.** A peer that receives a signal does
not apply the payload as content; it re-reads its OWN copy of the source of
truth (`sys_metadata` for lane 2, the shared datasource record for lane 3)
and converges its local registry from that read. A duplicate or re-ordered
delivery converges to the same state as a single one.
- **`originNode` loopback suppression.** Every payload carries the publishing
node's id; a peer that receives its own `originNode` drops the message —
the write-through or pool rebuild already ran, synchronously, at the door
that persisted the change.
- **At-most-once, bounded by boot rehydration.** No shipped `IPubSub` driver
exceeds at-most-once delivery (§4.2), so a lost message is not retried.
Each lane narrows the staleness window this always had — "until the next
full reload on restart" — to "one network hop"; it does not promise more.

All three lanes skip their fan-out on the same condition — the in-process
`memory` cluster driver, described for lane 1 immediately below, applies
identically to lanes 2 and 3 (#14021).

#### Lane 1 — `metadata.changed` (the metadata service cache)

**Current behaviour.** Cross-node metadata invalidation already works, but
not through any event bus (there isn't one — see §4). The metadata manager
Expand DownExpand Up@@ -382,6 +419,70 @@ guarantee that two rapid updates to the same item are applied to every
node's cache in order, and the at-least-once guarantee would let a briefly
partitioned node catch up on reconnect.

#### Lane 2 — `metadata.mutated` (the ObjectQL object registry)

The metadata **protocol** (`@objectstack/metadata-protocol`) fans out on a
second, independent channel — `METADATA_MUTATION_CLUSTER_CHANNEL =
'metadata.mutated'` (#13331) — with payload type
`ClusterMetadataMutationPayload`:

```ts
// packages/metadata-protocol/src/protocol.ts
export interface ClusterMetadataMutationPayload {
originNode?: string; // used for loopback suppression
event: MetadataMutationEvent; // address-only: type/name/state/org scope, no body
}
```

This lane exists because lane 1 replays into the metadata **service**'s own
caches, not into the ObjectQL **object registry** the runtime authoring path
(`saveMetaItem` → `applyRegistryWriteThrough`) mutates behind the data plane.
Without it, an object authored at runtime through `PUT /api/v1/meta/*`
answers `OBJECT_NOT_FOUND` on every replica that did not perform the write,
until restart — measured on a 3-replica EE deployment: 200 concurrent
creates through the load balancer gave 67×201 / 133×404.

On receipt, a peer suppresses its own `originNode`, then re-reads the row
from its OWN `sys_metadata` and re-runs the registry write-through from that
read (`applyRemoteMetadataMutation`) rather than applying the payload as
content. Attached by `MetadataClusterBridgePlugin`'s protocol lane at
`kernel:ready`, duck-typed against `protocol.attachMetadataMutationPubSub()`
so this package takes no dependency on `@objectstack/metadata-protocol`.

#### Lane 3 — `datasource.mutated` (the ObjectQL driver registry)

The datasource admin service (`@objectstack/service-datasource`) fans out on
a third channel — `DATASOURCE_MUTATION_CLUSTER_CHANNEL =
'datasource.mutated'` (#13805) — with payload type
`ClusterDatasourceMutationPayload`:

```ts
// packages/services/service-datasource/src/datasource-admin-service.ts
export interface ClusterDatasourceMutationPayload {
originNode?: string; // used for loopback suppression
name: string; // the datasource whose shared record was just written
}
```

Lane 2's family, adopted by the driver registry: `registerPool` /
`unregisterPool` mutate the ObjectQL DRIVER registry on the serving replica
only, so before this channel a `DELETE /api/v1/datasources/:name` recovered
`/api/v1/ready` on the one replica that served it, while every other replica
kept the stuck driver until restart. Symmetric by construction — create,
update and delete all publish this one shape, and a receiver cannot tell
which it was without reading, which is the point.

On receipt, a peer suppresses its own `originNode`, then re-reads the shared
datasource record for `name` and converges its own pool from that read
(builds what the read says should be live, rebuilds what changed, evicts
what is gone); convergence for the same name is serialized so two signals in
quick succession — a create chased by an update — apply in order. Attached
by `MetadataClusterBridgePlugin`'s datasource lane at `kernel:ready`,
duck-typed against `datasource-admin.attachDatasourceMutationPubSub()` so
this package takes no dependency on `@objectstack/service-datasource`, and
`@objectstack/objectql` — the driver registry's owner — is handed no bus at
all; the admin service publishes on the write doors it already owns.

### 6.3 Reader contract

> **Status: planned.** Today readers are invalidated by the `metadata.changed`
Expand DownExpand Up@@ -464,6 +565,13 @@ cluster.pubsub.subscribe('metadata.changed', (msg) => {
})
```

> **Already covered?** The subscription above is for a cache that mirrors
> the metadata **service**'s own state (lane 1, §6.2). If what you are
> caching is ObjectQL's **object** or **driver** registry instead, check
> §6.2 first — lanes 2 (`metadata.mutated`) and 3 (`datasource.mutated`)
> already keep those registries converged across replicas, and a second
> subscription would be redundant.

A higher-level cache factory (with automatic version comparison) is part of
the Phase 4 / §6 target design but is **not yet implemented**. No
`if (cluster)` branches are needed either way — the `memory` driver makes
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ import { isInProcessClusterDriver } from './split-brain-guard.js';
* `datasource.mutated` — payload shape defined by
* `ClusterDatasourceMutationPayload` in `@objectstack/service-datasource`.
*
* See `content/docs/kernel/cluster.mdx` §5.
* See `content/docs/kernel/cluster.mdx` §6.2.
*/
export class MetadataClusterBridgePlugin implements Plugin {
name = 'com.objectstack.service.metadata-cluster-bridge';
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 109 additions & 1 deletion content/docs/kernel/cluster.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -322,7 +322,44 @@ notification the cache compares the incoming version with the stored one:
This eliminates a whole class of bugs where a slow-arriving "old"
invalidation evicts a "newer" value the node has already learned about.

### 6.2 The metadata change event
### 6.2 The cluster-invalidation family

Cross-node metadata invalidation is not one channel — it is a **family** of
three independent PubSub lanes, late-bound by `MetadataClusterBridgePlugin`
(`@objectstack/service-cluster`) at `kernel:ready`, one per state owner that
goes stale when metadata changes on a different node:

| Lane | Channel | Payload type | Package | Converges |
|---|---|---|---|---|
| 1 — metadata service cache | `metadata.changed` | `ClusterMetadataChangedPayload` | `@objectstack/metadata` | `MetadataManager`'s registry/list caches |
| 2 — ObjectQL object registry | `metadata.mutated` (`METADATA_MUTATION_CLUSTER_CHANNEL`, #13331) | `ClusterMetadataMutationPayload` | `@objectstack/metadata-protocol` | ObjectQL's OBJECT registry, from a `sys_metadata` re-read |
| 3 — ObjectQL driver registry | `datasource.mutated` (`DATASOURCE_MUTATION_CLUSTER_CHANNEL`, #13805) | `ClusterDatasourceMutationPayload` | `@objectstack/service-datasource` | ObjectQL's DRIVER registry, from a shared datasource-record re-read |

Lanes 2 and 3 share one contract, stated once here rather than in each
channel's own doc comment:

- **Address-only signal.** No message body ever rides these channels — the
payload names only what changed (a metadata address, or a datasource
name), never the changed value.
- **Receipt runs convergence, not trust.** A peer that receives a signal does
not apply the payload as content; it re-reads its OWN copy of the source of
truth (`sys_metadata` for lane 2, the shared datasource record for lane 3)
and converges its local registry from that read. A duplicate or re-ordered
delivery converges to the same state as a single one.
- **`originNode` loopback suppression.** Every payload carries the publishing
node's id; a peer that receives its own `originNode` drops the message —
the write-through or pool rebuild already ran, synchronously, at the door
that persisted the change.
- **At-most-once, bounded by boot rehydration.** No shipped `IPubSub` driver
exceeds at-most-once delivery (§4.2), so a lost message is not retried.
Each lane narrows the staleness window this always had — "until the next
full reload on restart" — to "one network hop"; it does not promise more.

All three lanes skip their fan-out on the same condition — the in-process
`memory` cluster driver, described for lane 1 immediately below, applies
identically to lanes 2 and 3 (#14021).

#### Lane 1 — `metadata.changed` (the metadata service cache)

**Current behaviour.** Cross-node metadata invalidation already works, but
not through any event bus (there isn't one — see §4). The metadata manager
Expand DownExpand Up@@ -382,6 +419,70 @@ guarantee that two rapid updates to the same item are applied to every
node's cache in order, and the at-least-once guarantee would let a briefly
partitioned node catch up on reconnect.

#### Lane 2 — `metadata.mutated` (the ObjectQL object registry)

The metadata **protocol** (`@objectstack/metadata-protocol`) fans out on a
second, independent channel — `METADATA_MUTATION_CLUSTER_CHANNEL =
'metadata.mutated'` (#13331) — with payload type
`ClusterMetadataMutationPayload`:

```ts
// packages/metadata-protocol/src/protocol.ts
export interface ClusterMetadataMutationPayload {
originNode?: string; // used for loopback suppression
event: MetadataMutationEvent; // address-only: type/name/state/org scope, no body
}
```

This lane exists because lane 1 replays into the metadata **service**'s own
caches, not into the ObjectQL **object registry** the runtime authoring path
(`saveMetaItem` → `applyRegistryWriteThrough`) mutates behind the data plane.
Without it, an object authored at runtime through `PUT /api/v1/meta/*`
answers `OBJECT_NOT_FOUND` on every replica that did not perform the write,
until restart — measured on a 3-replica EE deployment: 200 concurrent
creates through the load balancer gave 67×201 / 133×404.

On receipt, a peer suppresses its own `originNode`, then re-reads the row
from its OWN `sys_metadata` and re-runs the registry write-through from that
read (`applyRemoteMetadataMutation`) rather than applying the payload as
content. Attached by `MetadataClusterBridgePlugin`'s protocol lane at
`kernel:ready`, duck-typed against `protocol.attachMetadataMutationPubSub()`
so this package takes no dependency on `@objectstack/metadata-protocol`.

#### Lane 3 — `datasource.mutated` (the ObjectQL driver registry)

The datasource admin service (`@objectstack/service-datasource`) fans out on
a third channel — `DATASOURCE_MUTATION_CLUSTER_CHANNEL =
'datasource.mutated'` (#13805) — with payload type
`ClusterDatasourceMutationPayload`:

```ts
// packages/services/service-datasource/src/datasource-admin-service.ts
export interface ClusterDatasourceMutationPayload {
originNode?: string; // used for loopback suppression
name: string; // the datasource whose shared record was just written
}
```

Lane 2's family, adopted by the driver registry: `registerPool` /
`unregisterPool` mutate the ObjectQL DRIVER registry on the serving replica
only, so before this channel a `DELETE /api/v1/datasources/:name` recovered
`/api/v1/ready` on the one replica that served it, while every other replica
kept the stuck driver until restart. Symmetric by construction — create,
update and delete all publish this one shape, and a receiver cannot tell
which it was without reading, which is the point.

On receipt, a peer suppresses its own `originNode`, then re-reads the shared
datasource record for `name` and converges its own pool from that read
(builds what the read says should be live, rebuilds what changed, evicts
what is gone); convergence for the same name is serialized so two signals in
quick succession — a create chased by an update — apply in order. Attached
by `MetadataClusterBridgePlugin`'s datasource lane at `kernel:ready`,
duck-typed against `datasource-admin.attachDatasourceMutationPubSub()` so
this package takes no dependency on `@objectstack/service-datasource`, and
`@objectstack/objectql` — the driver registry's owner — is handed no bus at
all; the admin service publishes on the write doors it already owns.

### 6.3 Reader contract

> **Status: planned.** Today readers are invalidated by the `metadata.changed`
Expand DownExpand Up@@ -464,6 +565,13 @@ cluster.pubsub.subscribe('metadata.changed', (msg) => {
})
```

> **Already covered?** The subscription above is for a cache that mirrors
> the metadata **service**'s own state (lane 1, §6.2). If what you are
> caching is ObjectQL's **object** or **driver** registry instead, check
> §6.2 first — lanes 2 (`metadata.mutated`) and 3 (`datasource.mutated`)
> already keep those registries converged across replicas, and a second
> subscription would be redundant.

A higher-level cache factory (with automatic version comparison) is part of
the Phase 4 / §6 target design but is **not yet implemented**. No
`if (cluster)` branches are needed either way — the `memory` driver makes
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ import { isInProcessClusterDriver } from './split-brain-guard.js';
* `datasource.mutated` — payload shape defined by
* `ClusterDatasourceMutationPayload` in `@objectstack/service-datasource`.
*
* See `content/docs/kernel/cluster.mdx` §5.
* See `content/docs/kernel/cluster.mdx` §6.2.
*/
export class MetadataClusterBridgePlugin implements Plugin {
name = 'com.objectstack.service.metadata-cluster-bridge';
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 109 additions & 1 deletion content/docs/kernel/cluster.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -322,7 +322,44 @@ notification the cache compares the incoming version with the stored one:
This eliminates a whole class of bugs where a slow-arriving "old"
invalidation evicts a "newer" value the node has already learned about.

### 6.2 The metadata change event
### 6.2 The cluster-invalidation family

Cross-node metadata invalidation is not one channel — it is a **family** of
three independent PubSub lanes, late-bound by `MetadataClusterBridgePlugin`
(`@objectstack/service-cluster`) at `kernel:ready`, one per state owner that
goes stale when metadata changes on a different node:

| Lane | Channel | Payload type | Package | Converges |
|---|---|---|---|---|
| 1 — metadata service cache | `metadata.changed` | `ClusterMetadataChangedPayload` | `@objectstack/metadata` | `MetadataManager`'s registry/list caches |
| 2 — ObjectQL object registry | `metadata.mutated` (`METADATA_MUTATION_CLUSTER_CHANNEL`, #13331) | `ClusterMetadataMutationPayload` | `@objectstack/metadata-protocol` | ObjectQL's OBJECT registry, from a `sys_metadata` re-read |
| 3 — ObjectQL driver registry | `datasource.mutated` (`DATASOURCE_MUTATION_CLUSTER_CHANNEL`, #13805) | `ClusterDatasourceMutationPayload` | `@objectstack/service-datasource` | ObjectQL's DRIVER registry, from a shared datasource-record re-read |

Lanes 2 and 3 share one contract, stated once here rather than in each
channel's own doc comment:

- **Address-only signal.** No message body ever rides these channels — the
payload names only what changed (a metadata address, or a datasource
name), never the changed value.
- **Receipt runs convergence, not trust.** A peer that receives a signal does
not apply the payload as content; it re-reads its OWN copy of the source of
truth (`sys_metadata` for lane 2, the shared datasource record for lane 3)
and converges its local registry from that read. A duplicate or re-ordered
delivery converges to the same state as a single one.
- **`originNode` loopback suppression.** Every payload carries the publishing
node's id; a peer that receives its own `originNode` drops the message —
the write-through or pool rebuild already ran, synchronously, at the door
that persisted the change.
- **At-most-once, bounded by boot rehydration.** No shipped `IPubSub` driver
exceeds at-most-once delivery (§4.2), so a lost message is not retried.
Each lane narrows the staleness window this always had — "until the next
full reload on restart" — to "one network hop"; it does not promise more.

All three lanes skip their fan-out on the same condition — the in-process
`memory` cluster driver, described for lane 1 immediately below, applies
identically to lanes 2 and 3 (#14021).

#### Lane 1 — `metadata.changed` (the metadata service cache)

**Current behaviour.** Cross-node metadata invalidation already works, but
not through any event bus (there isn't one — see §4). The metadata manager
Expand DownExpand Up@@ -382,6 +419,70 @@ guarantee that two rapid updates to the same item are applied to every
node's cache in order, and the at-least-once guarantee would let a briefly
partitioned node catch up on reconnect.

#### Lane 2 — `metadata.mutated` (the ObjectQL object registry)

The metadata **protocol** (`@objectstack/metadata-protocol`) fans out on a
second, independent channel — `METADATA_MUTATION_CLUSTER_CHANNEL =
'metadata.mutated'` (#13331) — with payload type
`ClusterMetadataMutationPayload`:

```ts
// packages/metadata-protocol/src/protocol.ts
export interface ClusterMetadataMutationPayload {
originNode?: string; // used for loopback suppression
event: MetadataMutationEvent; // address-only: type/name/state/org scope, no body
}
```

This lane exists because lane 1 replays into the metadata **service**'s own
caches, not into the ObjectQL **object registry** the runtime authoring path
(`saveMetaItem` → `applyRegistryWriteThrough`) mutates behind the data plane.
Without it, an object authored at runtime through `PUT /api/v1/meta/*`
answers `OBJECT_NOT_FOUND` on every replica that did not perform the write,
until restart — measured on a 3-replica EE deployment: 200 concurrent
creates through the load balancer gave 67×201 / 133×404.

On receipt, a peer suppresses its own `originNode`, then re-reads the row
from its OWN `sys_metadata` and re-runs the registry write-through from that
read (`applyRemoteMetadataMutation`) rather than applying the payload as
content. Attached by `MetadataClusterBridgePlugin`'s protocol lane at
`kernel:ready`, duck-typed against `protocol.attachMetadataMutationPubSub()`
so this package takes no dependency on `@objectstack/metadata-protocol`.

#### Lane 3 — `datasource.mutated` (the ObjectQL driver registry)

The datasource admin service (`@objectstack/service-datasource`) fans out on
a third channel — `DATASOURCE_MUTATION_CLUSTER_CHANNEL =
'datasource.mutated'` (#13805) — with payload type
`ClusterDatasourceMutationPayload`:

```ts
// packages/services/service-datasource/src/datasource-admin-service.ts
export interface ClusterDatasourceMutationPayload {
originNode?: string; // used for loopback suppression
name: string; // the datasource whose shared record was just written
}
```

Lane 2's family, adopted by the driver registry: `registerPool` /
`unregisterPool` mutate the ObjectQL DRIVER registry on the serving replica
only, so before this channel a `DELETE /api/v1/datasources/:name` recovered
`/api/v1/ready` on the one replica that served it, while every other replica
kept the stuck driver until restart. Symmetric by construction — create,
update and delete all publish this one shape, and a receiver cannot tell
which it was without reading, which is the point.

On receipt, a peer suppresses its own `originNode`, then re-reads the shared
datasource record for `name` and converges its own pool from that read
(builds what the read says should be live, rebuilds what changed, evicts
what is gone); convergence for the same name is serialized so two signals in
quick succession — a create chased by an update — apply in order. Attached
by `MetadataClusterBridgePlugin`'s datasource lane at `kernel:ready`,
duck-typed against `datasource-admin.attachDatasourceMutationPubSub()` so
this package takes no dependency on `@objectstack/service-datasource`, and
`@objectstack/objectql` — the driver registry's owner — is handed no bus at
all; the admin service publishes on the write doors it already owns.

### 6.3 Reader contract

> **Status: planned.** Today readers are invalidated by the `metadata.changed`
Expand DownExpand Up@@ -464,6 +565,13 @@ cluster.pubsub.subscribe('metadata.changed', (msg) => {
})
```

> **Already covered?** The subscription above is for a cache that mirrors
> the metadata **service**'s own state (lane 1, §6.2). If what you are
> caching is ObjectQL's **object** or **driver** registry instead, check
> §6.2 first — lanes 2 (`metadata.mutated`) and 3 (`datasource.mutated`)
> already keep those registries converged across replicas, and a second
> subscription would be redundant.

A higher-level cache factory (with automatic version comparison) is part of
the Phase 4 / §6 target design but is **not yet implemented**. No
`if (cluster)` branches are needed either way — the `memory` driver makes
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ import { isInProcessClusterDriver } from './split-brain-guard.js';
* `datasource.mutated` — payload shape defined by
* `ClusterDatasourceMutationPayload` in `@objectstack/service-datasource`.
*
* See `content/docs/kernel/cluster.mdx` §5.
* See `content/docs/kernel/cluster.mdx` §6.2.
*/
export class MetadataClusterBridgePlugin implements Plugin {
name = 'com.objectstack.service.metadata-cluster-bridge';
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 109 additions & 1 deletion content/docs/kernel/cluster.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -322,7 +322,44 @@ notification the cache compares the incoming version with the stored one:
This eliminates a whole class of bugs where a slow-arriving "old"
invalidation evicts a "newer" value the node has already learned about.

### 6.2 The metadata change event
### 6.2 The cluster-invalidation family

Cross-node metadata invalidation is not one channel — it is a **family** of
three independent PubSub lanes, late-bound by `MetadataClusterBridgePlugin`
(`@objectstack/service-cluster`) at `kernel:ready`, one per state owner that
goes stale when metadata changes on a different node:

| Lane | Channel | Payload type | Package | Converges |
|---|---|---|---|---|
| 1 — metadata service cache | `metadata.changed` | `ClusterMetadataChangedPayload` | `@objectstack/metadata` | `MetadataManager`'s registry/list caches |
| 2 — ObjectQL object registry | `metadata.mutated` (`METADATA_MUTATION_CLUSTER_CHANNEL`, #13331) | `ClusterMetadataMutationPayload` | `@objectstack/metadata-protocol` | ObjectQL's OBJECT registry, from a `sys_metadata` re-read |
| 3 — ObjectQL driver registry | `datasource.mutated` (`DATASOURCE_MUTATION_CLUSTER_CHANNEL`, #13805) | `ClusterDatasourceMutationPayload` | `@objectstack/service-datasource` | ObjectQL's DRIVER registry, from a shared datasource-record re-read |

Lanes 2 and 3 share one contract, stated once here rather than in each
channel's own doc comment:

- **Address-only signal.** No message body ever rides these channels — the
payload names only what changed (a metadata address, or a datasource
name), never the changed value.
- **Receipt runs convergence, not trust.** A peer that receives a signal does
not apply the payload as content; it re-reads its OWN copy of the source of
truth (`sys_metadata` for lane 2, the shared datasource record for lane 3)
and converges its local registry from that read. A duplicate or re-ordered
delivery converges to the same state as a single one.
- **`originNode` loopback suppression.** Every payload carries the publishing
node's id; a peer that receives its own `originNode` drops the message —
the write-through or pool rebuild already ran, synchronously, at the door
that persisted the change.
- **At-most-once, bounded by boot rehydration.** No shipped `IPubSub` driver
exceeds at-most-once delivery (§4.2), so a lost message is not retried.
Each lane narrows the staleness window this always had — "until the next
full reload on restart" — to "one network hop"; it does not promise more.

All three lanes skip their fan-out on the same condition — the in-process
`memory` cluster driver, described for lane 1 immediately below, applies
identically to lanes 2 and 3 (#14021).

#### Lane 1 — `metadata.changed` (the metadata service cache)

**Current behaviour.** Cross-node metadata invalidation already works, but
not through any event bus (there isn't one — see §4). The metadata manager
Expand DownExpand Up@@ -382,6 +419,70 @@ guarantee that two rapid updates to the same item are applied to every
node's cache in order, and the at-least-once guarantee would let a briefly
partitioned node catch up on reconnect.

#### Lane 2 — `metadata.mutated` (the ObjectQL object registry)

The metadata **protocol** (`@objectstack/metadata-protocol`) fans out on a
second, independent channel — `METADATA_MUTATION_CLUSTER_CHANNEL =
'metadata.mutated'` (#13331) — with payload type
`ClusterMetadataMutationPayload`:

```ts
// packages/metadata-protocol/src/protocol.ts
export interface ClusterMetadataMutationPayload {
originNode?: string; // used for loopback suppression
event: MetadataMutationEvent; // address-only: type/name/state/org scope, no body
}
```

This lane exists because lane 1 replays into the metadata **service**'s own
caches, not into the ObjectQL **object registry** the runtime authoring path
(`saveMetaItem` → `applyRegistryWriteThrough`) mutates behind the data plane.
Without it, an object authored at runtime through `PUT /api/v1/meta/*`
answers `OBJECT_NOT_FOUND` on every replica that did not perform the write,
until restart — measured on a 3-replica EE deployment: 200 concurrent
creates through the load balancer gave 67×201 / 133×404.

On receipt, a peer suppresses its own `originNode`, then re-reads the row
from its OWN `sys_metadata` and re-runs the registry write-through from that
read (`applyRemoteMetadataMutation`) rather than applying the payload as
content. Attached by `MetadataClusterBridgePlugin`'s protocol lane at
`kernel:ready`, duck-typed against `protocol.attachMetadataMutationPubSub()`
so this package takes no dependency on `@objectstack/metadata-protocol`.

#### Lane 3 — `datasource.mutated` (the ObjectQL driver registry)

The datasource admin service (`@objectstack/service-datasource`) fans out on
a third channel — `DATASOURCE_MUTATION_CLUSTER_CHANNEL =
'datasource.mutated'` (#13805) — with payload type
`ClusterDatasourceMutationPayload`:

```ts
// packages/services/service-datasource/src/datasource-admin-service.ts
export interface ClusterDatasourceMutationPayload {
originNode?: string; // used for loopback suppression
name: string; // the datasource whose shared record was just written
}
```

Lane 2's family, adopted by the driver registry: `registerPool` /
`unregisterPool` mutate the ObjectQL DRIVER registry on the serving replica
only, so before this channel a `DELETE /api/v1/datasources/:name` recovered
`/api/v1/ready` on the one replica that served it, while every other replica
kept the stuck driver until restart. Symmetric by construction — create,
update and delete all publish this one shape, and a receiver cannot tell
which it was without reading, which is the point.

On receipt, a peer suppresses its own `originNode`, then re-reads the shared
datasource record for `name` and converges its own pool from that read
(builds what the read says should be live, rebuilds what changed, evicts
what is gone); convergence for the same name is serialized so two signals in
quick succession — a create chased by an update — apply in order. Attached
by `MetadataClusterBridgePlugin`'s datasource lane at `kernel:ready`,
duck-typed against `datasource-admin.attachDatasourceMutationPubSub()` so
this package takes no dependency on `@objectstack/service-datasource`, and
`@objectstack/objectql` — the driver registry's owner — is handed no bus at
all; the admin service publishes on the write doors it already owns.

### 6.3 Reader contract

> **Status: planned.** Today readers are invalidated by the `metadata.changed`
Expand DownExpand Up@@ -464,6 +565,13 @@ cluster.pubsub.subscribe('metadata.changed', (msg) => {
})
```

> **Already covered?** The subscription above is for a cache that mirrors
> the metadata **service**'s own state (lane 1, §6.2). If what you are
> caching is ObjectQL's **object** or **driver** registry instead, check
> §6.2 first — lanes 2 (`metadata.mutated`) and 3 (`datasource.mutated`)
> already keep those registries converged across replicas, and a second
> subscription would be redundant.

A higher-level cache factory (with automatic version comparison) is part of
the Phase 4 / §6 target design but is **not yet implemented**. No
`if (cluster)` branches are needed either way — the `memory` driver makes
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ import { isInProcessClusterDriver } from './split-brain-guard.js';
* `datasource.mutated` — payload shape defined by
* `ClusterDatasourceMutationPayload` in `@objectstack/service-datasource`.
*
* See `content/docs/kernel/cluster.mdx` §5.
* See `content/docs/kernel/cluster.mdx` §6.2.
*/
export class MetadataClusterBridgePlugin implements Plugin {
name = 'com.objectstack.service.metadata-cluster-bridge';
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 109 additions & 1 deletion content/docs/kernel/cluster.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -322,7 +322,44 @@ notification the cache compares the incoming version with the stored one:
This eliminates a whole class of bugs where a slow-arriving "old"
invalidation evicts a "newer" value the node has already learned about.

### 6.2 The metadata change event
### 6.2 The cluster-invalidation family

Cross-node metadata invalidation is not one channel — it is a **family** of
three independent PubSub lanes, late-bound by `MetadataClusterBridgePlugin`
(`@objectstack/service-cluster`) at `kernel:ready`, one per state owner that
goes stale when metadata changes on a different node:

| Lane | Channel | Payload type | Package | Converges |
|---|---|---|---|---|
| 1 — metadata service cache | `metadata.changed` | `ClusterMetadataChangedPayload` | `@objectstack/metadata` | `MetadataManager`'s registry/list caches |
| 2 — ObjectQL object registry | `metadata.mutated` (`METADATA_MUTATION_CLUSTER_CHANNEL`, #13331) | `ClusterMetadataMutationPayload` | `@objectstack/metadata-protocol` | ObjectQL's OBJECT registry, from a `sys_metadata` re-read |
| 3 — ObjectQL driver registry | `datasource.mutated` (`DATASOURCE_MUTATION_CLUSTER_CHANNEL`, #13805) | `ClusterDatasourceMutationPayload` | `@objectstack/service-datasource` | ObjectQL's DRIVER registry, from a shared datasource-record re-read |

Lanes 2 and 3 share one contract, stated once here rather than in each
channel's own doc comment:

- **Address-only signal.** No message body ever rides these channels — the
payload names only what changed (a metadata address, or a datasource
name), never the changed value.
- **Receipt runs convergence, not trust.** A peer that receives a signal does
not apply the payload as content; it re-reads its OWN copy of the source of
truth (`sys_metadata` for lane 2, the shared datasource record for lane 3)
and converges its local registry from that read. A duplicate or re-ordered
delivery converges to the same state as a single one.
- **`originNode` loopback suppression.** Every payload carries the publishing
node's id; a peer that receives its own `originNode` drops the message —
the write-through or pool rebuild already ran, synchronously, at the door
that persisted the change.
- **At-most-once, bounded by boot rehydration.** No shipped `IPubSub` driver
exceeds at-most-once delivery (§4.2), so a lost message is not retried.
Each lane narrows the staleness window this always had — "until the next
full reload on restart" — to "one network hop"; it does not promise more.

All three lanes skip their fan-out on the same condition — the in-process
`memory` cluster driver, described for lane 1 immediately below, applies
identically to lanes 2 and 3 (#14021).

#### Lane 1 — `metadata.changed` (the metadata service cache)

**Current behaviour.** Cross-node metadata invalidation already works, but
not through any event bus (there isn't one — see §4). The metadata manager
Expand DownExpand Up@@ -382,6 +419,70 @@ guarantee that two rapid updates to the same item are applied to every
node's cache in order, and the at-least-once guarantee would let a briefly
partitioned node catch up on reconnect.

#### Lane 2 — `metadata.mutated` (the ObjectQL object registry)

The metadata **protocol** (`@objectstack/metadata-protocol`) fans out on a
second, independent channel — `METADATA_MUTATION_CLUSTER_CHANNEL =
'metadata.mutated'` (#13331) — with payload type
`ClusterMetadataMutationPayload`:

```ts
// packages/metadata-protocol/src/protocol.ts
export interface ClusterMetadataMutationPayload {
originNode?: string; // used for loopback suppression
event: MetadataMutationEvent; // address-only: type/name/state/org scope, no body
}
```

This lane exists because lane 1 replays into the metadata **service**'s own
caches, not into the ObjectQL **object registry** the runtime authoring path
(`saveMetaItem` → `applyRegistryWriteThrough`) mutates behind the data plane.
Without it, an object authored at runtime through `PUT /api/v1/meta/*`
answers `OBJECT_NOT_FOUND` on every replica that did not perform the write,
until restart — measured on a 3-replica EE deployment: 200 concurrent
creates through the load balancer gave 67×201 / 133×404.

On receipt, a peer suppresses its own `originNode`, then re-reads the row
from its OWN `sys_metadata` and re-runs the registry write-through from that
read (`applyRemoteMetadataMutation`) rather than applying the payload as
content. Attached by `MetadataClusterBridgePlugin`'s protocol lane at
`kernel:ready`, duck-typed against `protocol.attachMetadataMutationPubSub()`
so this package takes no dependency on `@objectstack/metadata-protocol`.

#### Lane 3 — `datasource.mutated` (the ObjectQL driver registry)

The datasource admin service (`@objectstack/service-datasource`) fans out on
a third channel — `DATASOURCE_MUTATION_CLUSTER_CHANNEL =
'datasource.mutated'` (#13805) — with payload type
`ClusterDatasourceMutationPayload`:

```ts
// packages/services/service-datasource/src/datasource-admin-service.ts
export interface ClusterDatasourceMutationPayload {
originNode?: string; // used for loopback suppression
name: string; // the datasource whose shared record was just written
}
```

Lane 2's family, adopted by the driver registry: `registerPool` /
`unregisterPool` mutate the ObjectQL DRIVER registry on the serving replica
only, so before this channel a `DELETE /api/v1/datasources/:name` recovered
`/api/v1/ready` on the one replica that served it, while every other replica
kept the stuck driver until restart. Symmetric by construction — create,
update and delete all publish this one shape, and a receiver cannot tell
which it was without reading, which is the point.

On receipt, a peer suppresses its own `originNode`, then re-reads the shared
datasource record for `name` and converges its own pool from that read
(builds what the read says should be live, rebuilds what changed, evicts
what is gone); convergence for the same name is serialized so two signals in
quick succession — a create chased by an update — apply in order. Attached
by `MetadataClusterBridgePlugin`'s datasource lane at `kernel:ready`,
duck-typed against `datasource-admin.attachDatasourceMutationPubSub()` so
this package takes no dependency on `@objectstack/service-datasource`, and
`@objectstack/objectql` — the driver registry's owner — is handed no bus at
all; the admin service publishes on the write doors it already owns.

### 6.3 Reader contract

> **Status: planned.** Today readers are invalidated by the `metadata.changed`
Expand DownExpand Up@@ -464,6 +565,13 @@ cluster.pubsub.subscribe('metadata.changed', (msg) => {
})
```

> **Already covered?** The subscription above is for a cache that mirrors
> the metadata **service**'s own state (lane 1, §6.2). If what you are
> caching is ObjectQL's **object** or **driver** registry instead, check
> §6.2 first — lanes 2 (`metadata.mutated`) and 3 (`datasource.mutated`)
> already keep those registries converged across replicas, and a second
> subscription would be redundant.

A higher-level cache factory (with automatic version comparison) is part of
the Phase 4 / §6 target design but is **not yet implemented**. No
`if (cluster)` branches are needed either way — the `memory` driver makes
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ import { isInProcessClusterDriver } from './split-brain-guard.js';
* `datasource.mutated` — payload shape defined by
* `ClusterDatasourceMutationPayload` in `@objectstack/service-datasource`.
*
* See `content/docs/kernel/cluster.mdx` §5.
* See `content/docs/kernel/cluster.mdx` §6.2.
*/
export class MetadataClusterBridgePlugin implements Plugin {
name = 'com.objectstack.service.metadata-cluster-bridge';
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 109 additions & 1 deletion content/docs/kernel/cluster.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -322,7 +322,44 @@ notification the cache compares the incoming version with the stored one:
This eliminates a whole class of bugs where a slow-arriving "old"
invalidation evicts a "newer" value the node has already learned about.

### 6.2 The metadata change event
### 6.2 The cluster-invalidation family

Cross-node metadata invalidation is not one channel — it is a **family** of
three independent PubSub lanes, late-bound by `MetadataClusterBridgePlugin`
(`@objectstack/service-cluster`) at `kernel:ready`, one per state owner that
goes stale when metadata changes on a different node:

| Lane | Channel | Payload type | Package | Converges |
|---|---|---|---|---|
| 1 — metadata service cache | `metadata.changed` | `ClusterMetadataChangedPayload` | `@objectstack/metadata` | `MetadataManager`'s registry/list caches |
| 2 — ObjectQL object registry | `metadata.mutated` (`METADATA_MUTATION_CLUSTER_CHANNEL`, #13331) | `ClusterMetadataMutationPayload` | `@objectstack/metadata-protocol` | ObjectQL's OBJECT registry, from a `sys_metadata` re-read |
| 3 — ObjectQL driver registry | `datasource.mutated` (`DATASOURCE_MUTATION_CLUSTER_CHANNEL`, #13805) | `ClusterDatasourceMutationPayload` | `@objectstack/service-datasource` | ObjectQL's DRIVER registry, from a shared datasource-record re-read |

Lanes 2 and 3 share one contract, stated once here rather than in each
channel's own doc comment:

- **Address-only signal.** No message body ever rides these channels — the
payload names only what changed (a metadata address, or a datasource
name), never the changed value.
- **Receipt runs convergence, not trust.** A peer that receives a signal does
not apply the payload as content; it re-reads its OWN copy of the source of
truth (`sys_metadata` for lane 2, the shared datasource record for lane 3)
and converges its local registry from that read. A duplicate or re-ordered
delivery converges to the same state as a single one.
- **`originNode` loopback suppression.** Every payload carries the publishing
node's id; a peer that receives its own `originNode` drops the message —
the write-through or pool rebuild already ran, synchronously, at the door
that persisted the change.
- **At-most-once, bounded by boot rehydration.** No shipped `IPubSub` driver
exceeds at-most-once delivery (§4.2), so a lost message is not retried.
Each lane narrows the staleness window this always had — "until the next
full reload on restart" — to "one network hop"; it does not promise more.

All three lanes skip their fan-out on the same condition — the in-process
`memory` cluster driver, described for lane 1 immediately below, applies
identically to lanes 2 and 3 (#14021).

#### Lane 1 — `metadata.changed` (the metadata service cache)

**Current behaviour.** Cross-node metadata invalidation already works, but
not through any event bus (there isn't one — see §4). The metadata manager
Expand DownExpand Up@@ -382,6 +419,70 @@ guarantee that two rapid updates to the same item are applied to every
node's cache in order, and the at-least-once guarantee would let a briefly
partitioned node catch up on reconnect.

#### Lane 2 — `metadata.mutated` (the ObjectQL object registry)

The metadata **protocol** (`@objectstack/metadata-protocol`) fans out on a
second, independent channel — `METADATA_MUTATION_CLUSTER_CHANNEL =
'metadata.mutated'` (#13331) — with payload type
`ClusterMetadataMutationPayload`:

```ts
// packages/metadata-protocol/src/protocol.ts
export interface ClusterMetadataMutationPayload {
originNode?: string; // used for loopback suppression
event: MetadataMutationEvent; // address-only: type/name/state/org scope, no body
}
```

This lane exists because lane 1 replays into the metadata **service**'s own
caches, not into the ObjectQL **object registry** the runtime authoring path
(`saveMetaItem` → `applyRegistryWriteThrough`) mutates behind the data plane.
Without it, an object authored at runtime through `PUT /api/v1/meta/*`
answers `OBJECT_NOT_FOUND` on every replica that did not perform the write,
until restart — measured on a 3-replica EE deployment: 200 concurrent
creates through the load balancer gave 67×201 / 133×404.

On receipt, a peer suppresses its own `originNode`, then re-reads the row
from its OWN `sys_metadata` and re-runs the registry write-through from that
read (`applyRemoteMetadataMutation`) rather than applying the payload as
content. Attached by `MetadataClusterBridgePlugin`'s protocol lane at
`kernel:ready`, duck-typed against `protocol.attachMetadataMutationPubSub()`
so this package takes no dependency on `@objectstack/metadata-protocol`.

#### Lane 3 — `datasource.mutated` (the ObjectQL driver registry)

The datasource admin service (`@objectstack/service-datasource`) fans out on
a third channel — `DATASOURCE_MUTATION_CLUSTER_CHANNEL =
'datasource.mutated'` (#13805) — with payload type
`ClusterDatasourceMutationPayload`:

```ts
// packages/services/service-datasource/src/datasource-admin-service.ts
export interface ClusterDatasourceMutationPayload {
originNode?: string; // used for loopback suppression
name: string; // the datasource whose shared record was just written
}
```

Lane 2's family, adopted by the driver registry: `registerPool` /
`unregisterPool` mutate the ObjectQL DRIVER registry on the serving replica
only, so before this channel a `DELETE /api/v1/datasources/:name` recovered
`/api/v1/ready` on the one replica that served it, while every other replica
kept the stuck driver until restart. Symmetric by construction — create,
update and delete all publish this one shape, and a receiver cannot tell
which it was without reading, which is the point.

On receipt, a peer suppresses its own `originNode`, then re-reads the shared
datasource record for `name` and converges its own pool from that read
(builds what the read says should be live, rebuilds what changed, evicts
what is gone); convergence for the same name is serialized so two signals in
quick succession — a create chased by an update — apply in order. Attached
by `MetadataClusterBridgePlugin`'s datasource lane at `kernel:ready`,
duck-typed against `datasource-admin.attachDatasourceMutationPubSub()` so
this package takes no dependency on `@objectstack/service-datasource`, and
`@objectstack/objectql` — the driver registry's owner — is handed no bus at
all; the admin service publishes on the write doors it already owns.

### 6.3 Reader contract

> **Status: planned.** Today readers are invalidated by the `metadata.changed`
Expand DownExpand Up@@ -464,6 +565,13 @@ cluster.pubsub.subscribe('metadata.changed', (msg) => {
})
```

> **Already covered?** The subscription above is for a cache that mirrors
> the metadata **service**'s own state (lane 1, §6.2). If what you are
> caching is ObjectQL's **object** or **driver** registry instead, check
> §6.2 first — lanes 2 (`metadata.mutated`) and 3 (`datasource.mutated`)
> already keep those registries converged across replicas, and a second
> subscription would be redundant.

A higher-level cache factory (with automatic version comparison) is part of
the Phase 4 / §6 target design but is **not yet implemented**. No
`if (cluster)` branches are needed either way — the `memory` driver makes
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ import { isInProcessClusterDriver } from './split-brain-guard.js';
* `datasource.mutated` — payload shape defined by
* `ClusterDatasourceMutationPayload` in `@objectstack/service-datasource`.
*
* See `content/docs/kernel/cluster.mdx` §5.
* See `content/docs/kernel/cluster.mdx` §6.2.
*/
export class MetadataClusterBridgePlugin implements Plugin {
name = 'com.objectstack.service.metadata-cluster-bridge';
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 109 additions & 1 deletion content/docs/kernel/cluster.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -322,7 +322,44 @@ notification the cache compares the incoming version with the stored one:
This eliminates a whole class of bugs where a slow-arriving "old"
invalidation evicts a "newer" value the node has already learned about.

### 6.2 The metadata change event
### 6.2 The cluster-invalidation family

Cross-node metadata invalidation is not one channel — it is a **family** of
three independent PubSub lanes, late-bound by `MetadataClusterBridgePlugin`
(`@objectstack/service-cluster`) at `kernel:ready`, one per state owner that
goes stale when metadata changes on a different node:

| Lane | Channel | Payload type | Package | Converges |
|---|---|---|---|---|
| 1 — metadata service cache | `metadata.changed` | `ClusterMetadataChangedPayload` | `@objectstack/metadata` | `MetadataManager`'s registry/list caches |
| 2 — ObjectQL object registry | `metadata.mutated` (`METADATA_MUTATION_CLUSTER_CHANNEL`, #13331) | `ClusterMetadataMutationPayload` | `@objectstack/metadata-protocol` | ObjectQL's OBJECT registry, from a `sys_metadata` re-read |
| 3 — ObjectQL driver registry | `datasource.mutated` (`DATASOURCE_MUTATION_CLUSTER_CHANNEL`, #13805) | `ClusterDatasourceMutationPayload` | `@objectstack/service-datasource` | ObjectQL's DRIVER registry, from a shared datasource-record re-read |

Lanes 2 and 3 share one contract, stated once here rather than in each
channel's own doc comment:

- **Address-only signal.** No message body ever rides these channels — the
payload names only what changed (a metadata address, or a datasource
name), never the changed value.
- **Receipt runs convergence, not trust.** A peer that receives a signal does
not apply the payload as content; it re-reads its OWN copy of the source of
truth (`sys_metadata` for lane 2, the shared datasource record for lane 3)
and converges its local registry from that read. A duplicate or re-ordered
delivery converges to the same state as a single one.
- **`originNode` loopback suppression.** Every payload carries the publishing
node's id; a peer that receives its own `originNode` drops the message —
the write-through or pool rebuild already ran, synchronously, at the door
that persisted the change.
- **At-most-once, bounded by boot rehydration.** No shipped `IPubSub` driver
exceeds at-most-once delivery (§4.2), so a lost message is not retried.
Each lane narrows the staleness window this always had — "until the next
full reload on restart" — to "one network hop"; it does not promise more.

All three lanes skip their fan-out on the same condition — the in-process
`memory` cluster driver, described for lane 1 immediately below, applies
identically to lanes 2 and 3 (#14021).

#### Lane 1 — `metadata.changed` (the metadata service cache)

**Current behaviour.** Cross-node metadata invalidation already works, but
not through any event bus (there isn't one — see §4). The metadata manager
Expand DownExpand Up@@ -382,6 +419,70 @@ guarantee that two rapid updates to the same item are applied to every
node's cache in order, and the at-least-once guarantee would let a briefly
partitioned node catch up on reconnect.

#### Lane 2 — `metadata.mutated` (the ObjectQL object registry)

The metadata **protocol** (`@objectstack/metadata-protocol`) fans out on a
second, independent channel — `METADATA_MUTATION_CLUSTER_CHANNEL =
'metadata.mutated'` (#13331) — with payload type
`ClusterMetadataMutationPayload`:

```ts
// packages/metadata-protocol/src/protocol.ts
export interface ClusterMetadataMutationPayload {
originNode?: string; // used for loopback suppression
event: MetadataMutationEvent; // address-only: type/name/state/org scope, no body
}
```

This lane exists because lane 1 replays into the metadata **service**'s own
caches, not into the ObjectQL **object registry** the runtime authoring path
(`saveMetaItem` → `applyRegistryWriteThrough`) mutates behind the data plane.
Without it, an object authored at runtime through `PUT /api/v1/meta/*`
answers `OBJECT_NOT_FOUND` on every replica that did not perform the write,
until restart — measured on a 3-replica EE deployment: 200 concurrent
creates through the load balancer gave 67×201 / 133×404.

On receipt, a peer suppresses its own `originNode`, then re-reads the row
from its OWN `sys_metadata` and re-runs the registry write-through from that
read (`applyRemoteMetadataMutation`) rather than applying the payload as
content. Attached by `MetadataClusterBridgePlugin`'s protocol lane at
`kernel:ready`, duck-typed against `protocol.attachMetadataMutationPubSub()`
so this package takes no dependency on `@objectstack/metadata-protocol`.

#### Lane 3 — `datasource.mutated` (the ObjectQL driver registry)

The datasource admin service (`@objectstack/service-datasource`) fans out on
a third channel — `DATASOURCE_MUTATION_CLUSTER_CHANNEL =
'datasource.mutated'` (#13805) — with payload type
`ClusterDatasourceMutationPayload`:

```ts
// packages/services/service-datasource/src/datasource-admin-service.ts
export interface ClusterDatasourceMutationPayload {
originNode?: string; // used for loopback suppression
name: string; // the datasource whose shared record was just written
}
```

Lane 2's family, adopted by the driver registry: `registerPool` /
`unregisterPool` mutate the ObjectQL DRIVER registry on the serving replica
only, so before this channel a `DELETE /api/v1/datasources/:name` recovered
`/api/v1/ready` on the one replica that served it, while every other replica
kept the stuck driver until restart. Symmetric by construction — create,
update and delete all publish this one shape, and a receiver cannot tell
which it was without reading, which is the point.

On receipt, a peer suppresses its own `originNode`, then re-reads the shared
datasource record for `name` and converges its own pool from that read
(builds what the read says should be live, rebuilds what changed, evicts
what is gone); convergence for the same name is serialized so two signals in
quick succession — a create chased by an update — apply in order. Attached
by `MetadataClusterBridgePlugin`'s datasource lane at `kernel:ready`,
duck-typed against `datasource-admin.attachDatasourceMutationPubSub()` so
this package takes no dependency on `@objectstack/service-datasource`, and
`@objectstack/objectql` — the driver registry's owner — is handed no bus at
all; the admin service publishes on the write doors it already owns.

### 6.3 Reader contract

> **Status: planned.** Today readers are invalidated by the `metadata.changed`
Expand DownExpand Up@@ -464,6 +565,13 @@ cluster.pubsub.subscribe('metadata.changed', (msg) => {
})
```

> **Already covered?** The subscription above is for a cache that mirrors
> the metadata **service**'s own state (lane 1, §6.2). If what you are
> caching is ObjectQL's **object** or **driver** registry instead, check
> §6.2 first — lanes 2 (`metadata.mutated`) and 3 (`datasource.mutated`)
> already keep those registries converged across replicas, and a second
> subscription would be redundant.

A higher-level cache factory (with automatic version comparison) is part of
the Phase 4 / §6 target design but is **not yet implemented**. No
`if (cluster)` branches are needed either way — the `memory` driver makes
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ import { isInProcessClusterDriver } from './split-brain-guard.js';
* `datasource.mutated` — payload shape defined by
* `ClusterDatasourceMutationPayload` in `@objectstack/service-datasource`.
*
* See `content/docs/kernel/cluster.mdx` §5.
* See `content/docs/kernel/cluster.mdx` §6.2.
*/
export class MetadataClusterBridgePlugin implements Plugin {
name = 'com.objectstack.service.metadata-cluster-bridge';
Expand Down
Loading