From 795b0fa1db3f196cf10cf9540caee97a3d3b3f2f Mon Sep 17 00:00:00 2001 From: Patrick Lee Scott Date: Thu, 16 Jul 2026 16:26:07 -0500 Subject: [PATCH 01/20] feat(graphql): surface IR, command pipeline cache, projection return helpers MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Implement pre-release tracks for graphql-qs-prerelease-1: - Surface IR (build_surface / surface_for_role); SDL emits via IR - Browser QueryCache + command pipeline (ack/fact/projection, rollback) - projection_return helpers + skill docs for same-tx vs async projectors Product rule: command success ≠ projection visibility; default ack/fact + reconcile. Residuals (full schema-from-IR, e2e-ui route migrate, extract packages, client_reconcile manifest) remain in GitKB v1/state. --- .../skills/distributed-graphql/SKILL.md | 23 + src/graphql/mod.rs | 14 +- src/graphql/projection_return.rs | 84 ++ src/graphql/sdl.rs | 36 + src/graphql/surface.rs | 721 ++++++++++++++++++ tests/e2e-ui/ui/src/lib/gql/cache/index.ts | 15 + tests/e2e-ui/ui/src/lib/gql/cache/ops.ts | 230 ++++++ tests/e2e-ui/ui/src/lib/gql/cache/pipeline.ts | 197 +++++ .../ui/src/lib/gql/cache/query-cache.ts | 99 +++ tests/e2e-ui/ui/src/lib/gql/index.ts | 19 + .../e2e-ui/ui/tests/command-pipeline.test.mjs | 44 ++ tests/e2e-ui/ui/tests/run-pipeline-unit.mjs | 218 ++++++ 12 files changed, 1699 insertions(+), 1 deletion(-) create mode 100644 src/graphql/projection_return.rs create mode 100644 src/graphql/surface.rs create mode 100644 tests/e2e-ui/ui/src/lib/gql/cache/index.ts create mode 100644 tests/e2e-ui/ui/src/lib/gql/cache/ops.ts create mode 100644 tests/e2e-ui/ui/src/lib/gql/cache/pipeline.ts create mode 100644 tests/e2e-ui/ui/src/lib/gql/cache/query-cache.ts create mode 100644 tests/e2e-ui/ui/tests/command-pipeline.test.mjs create mode 100644 tests/e2e-ui/ui/tests/run-pipeline-unit.mjs diff --git a/distributed_cli/skills/distributed-graphql/SKILL.md b/distributed_cli/skills/distributed-graphql/SKILL.md index 45a7c157..57261cce 100644 --- a/distributed_cli/skills/distributed-graphql/SKILL.md +++ b/distributed_cli/skills/distributed-graphql/SKILL.md @@ -97,6 +97,29 @@ Pass `change_stream(repo.read_model_changes())` for live subscriptions. Command mutations: register `GraphqlCommands` on the builder and use `graphql_router_with_service` / `with_graphql` so `Request::data` carries `Service`. +### Command return modes (ack / fact / projection) + +**Command success does not imply projection visibility.** + +| Handler topology | Return payload | Client `result.kind` | +|------------------|----------------|----------------------| +| Events/outbox only; projector separate (**default Seeker / e2e-ui todos**) | ack or domain-fact fields only | `ack` / `fact` + reconcile (subscription/refetch) | +| Handler commits **read model in the same request** | view-shaped JSON matching GraphQL output / RM columns | `projection` — client may apply payload now | + +Rules: + +1. If you **write** the read model in the command, **return it** (view-shaped). Prefer + `stage_projection_and_payload(&mut plan, &view)` so upsert + JSON cannot drift, or + `projection_return_value(&view)` after you commit the same row. +2. If projection is a **separate** event handler, return **ack/fact only** — do **not** + invent a full list row the RM has not stored. +3. e2e-ui `todos.create` returns fact-shaped `TodoCreatePayload` — treat as **`fact`**, + not projection-from-store. + +Surface IR: SDL is built via `build_surface` → `graphql_sdl_from_surface` (shared inventory +for dialect-honest comparison ops and role grants). Runtime schema still partially dual +until full IR wire-up. + ## SDL artifact (CI gate) ```bash diff --git a/src/graphql/mod.rs b/src/graphql/mod.rs index 9ca20436..750b8185 100644 --- a/src/graphql/mod.rs +++ b/src/graphql/mod.rs @@ -6,14 +6,26 @@ //! `feature = "graphql"`. pub mod naming; +pub mod projection_return; pub mod sdl; +pub mod surface; pub use naming::{ aggregate_field, by_pk_field, comparison_op_fields, include_postgres_json_comparison_ops, is_valid_graphql_name, object_type_name, root_list_field, scalar_type_name, POSTGRES_JSON_COMPARISON_OPS, PORTABLE_COMPARISON_OPS, STRING_COMPARISON_OPS, }; -pub use sdl::{graphql_sdl_for_tables, graphql_sdl_for_tables_with_options, SdlOptions}; +pub use sdl::{ + graphql_sdl_for_tables, graphql_sdl_for_tables_with_options, graphql_sdl_from_surface, + SdlOptions, +}; +pub use projection_return::{ + projection_return_value, stage_projection_and_payload, ProjectionPayload, +}; +pub use surface::{ + build_surface, surface_for_role, RoleGrant, RootField, RootKind, Surface, SurfaceDialect, + SurfaceModel, SurfaceOptions, +}; #[cfg(feature = "graphql")] mod commands; diff --git a/src/graphql/projection_return.rs b/src/graphql/projection_return.rs new file mode 100644 index 00000000..94005e0e --- /dev/null +++ b/src/graphql/projection_return.rs @@ -0,0 +1,84 @@ +//! Helpers for **same-tx projection** command returns. +//! +//! # Product rule +//! +//! | Topology | Return | Client `result.kind` | +//! |----------|--------|----------------------| +//! | Async projector (default Seeker / e2e-ui todos) | ack or domain-fact fields | `ack` / `fact` + reconcile | +//! | Handler commits read model in the same request | view-shaped JSON | `projection` | +//! +//! If you write the read model in the command handler, **return it**. +//! If you do not, do **not** invent a full list row — return ack/fact only. +//! +//! e2e-ui todos create returns fact-shaped fields from the domain fact — treat as +//! **`fact`**, not projection-from-store (projectors are separate event handlers). + +use serde::Serialize; + +use crate::read_model::{ReadModelWritePlanBuilder, RelationalReadModel}; +use crate::table::TableStoreError; + +/// JSON value returned from a GraphQL command mutation when the payload is +/// view-shaped (same fields the read model / GraphQL object exposes). +pub type ProjectionPayload = serde_json::Value; + +/// Serialize a row as the GraphQL mutation payload after (or as part of) +/// committing the same row to the read model in this request. +/// +/// Prefer [`stage_projection_and_payload`] so the upsert and the returned JSON +/// cannot drift. +pub fn projection_return_value(row: &V) -> Result { + serde_json::to_value(row).map_err(|e| e.to_string()) +} + +/// Stage a full-row upsert on `plan` and return the same value as GraphQL JSON. +/// +/// Call only when the handler **intentionally** commits the projection in the +/// same request. Do **not** use for default async-projector commands (todos). +/// +/// ```ignore +/// let mut plan = ReadModelWritePlanBuilder::new(); +/// let payload = stage_projection_and_payload(&mut plan, &view)?; +/// // commit plan with the aggregate/outbox in the same unit of work +/// Ok(payload) +/// ``` +pub fn stage_projection_and_payload( + plan: &mut ReadModelWritePlanBuilder, + row: &M, +) -> Result +where + M: RelationalReadModel + Serialize, +{ + plan.upsert(row)?; + serde_json::to_value(row).map_err(|e| { + TableStoreError::Metadata(format!("projection payload serialize failed: {e}")) + }) +} + +#[cfg(test)] +mod tests { + use super::*; + use serde::Serialize; + + #[derive(Serialize)] + struct ViewRow { + todo_id: String, + title: String, + status: String, + } + + #[test] + fn projection_return_value_is_view_shaped_json() { + let row = ViewRow { + todo_id: "t1".into(), + title: "hi".into(), + status: "open".into(), + }; + let v = projection_return_value(&row).expect("json"); + assert_eq!(v["todo_id"], "t1"); + assert_eq!(v["title"], "hi"); + assert_eq!(v["status"], "open"); + // Only fields present on the row — no invented admin/secret keys + assert!(v.get("secret").is_none()); + } +} diff --git a/src/graphql/sdl.rs b/src/graphql/sdl.rs index a5dce89b..97d108f5 100644 --- a/src/graphql/sdl.rs +++ b/src/graphql/sdl.rs @@ -60,6 +60,9 @@ impl SdlOptions { } /// Render GraphQL SDL for the given tables (ReadModel only; operational filtered). +/// +/// Builds the shared [[surface]] IR first, then emits SDL only from that IR so +/// dialect ops and model set cannot diverge from `build_surface`. pub fn graphql_sdl_for_tables(tables: &[TableSchema]) -> Result { graphql_sdl_for_tables_with_options(tables, &SdlOptions::default()) } @@ -67,6 +70,39 @@ pub fn graphql_sdl_for_tables(tables: &[TableSchema]) -> Result pub fn graphql_sdl_for_tables_with_options( tables: &[TableSchema], options: &SdlOptions, +) -> Result { + let surface_opts = super::surface::SurfaceOptions { + dialect: if options.jsonb_operators { + super::surface::SurfaceDialect::Postgres + } else { + super::surface::SurfaceDialect::Sqlite + }, + aggregates: options.aggregates, + subscriptions: options.subscriptions, + }; + let surface = super::surface::build_surface(tables, &surface_opts)?; + graphql_sdl_from_surface(&surface) +} + +/// Emit GraphQL SDL from a pre-built surface IR (role-filtered or full catalog). +pub fn graphql_sdl_from_surface(surface: &super::surface::Surface) -> Result { + let tables = surface.schemas(); + let options = surface_options_to_sdl(surface); + graphql_sdl_from_read_models(&tables, &options) +} + +fn surface_options_to_sdl(surface: &super::surface::Surface) -> SdlOptions { + SdlOptions { + aggregates: surface.aggregates, + jsonb_operators: include_postgres_json_comparison_ops(surface.dialect.is_postgres()), + subscriptions: surface.subscriptions, + } +} + +/// Internal renderer over an already IR-filtered set of read models. +fn graphql_sdl_from_read_models( + tables: &[TableSchema], + options: &SdlOptions, ) -> Result { let read_models: Vec<&TableSchema> = tables .iter() diff --git a/src/graphql/surface.rs b/src/graphql/surface.rs new file mode 100644 index 00000000..617f2fca --- /dev/null +++ b/src/graphql/surface.rs @@ -0,0 +1,721 @@ +//! Shared GraphQL **surface IR** — single source of truth for the query/subscription +//! type system a catalog (and optionally a role) can see. +//! +//! SDL emission and (over time) runtime schema construction consume this IR so +//! dialect-honest comparison ops, roots, and column grants cannot diverge. +//! +//! Core types compile without the `graphql` feature so `dctl schema --format graphql` +//! can share the same IR path. + +use std::collections::{BTreeMap, BTreeSet}; + +use crate::table::{ + resolve_m2m_target_foreign_key, RelationshipKind, TableColumn, TableSchema, +}; + +use super::naming::{ + by_pk_field, comparison_exp_name, comparison_op_fields, include_postgres_json_comparison_ops, + is_valid_graphql_name, object_type_name, root_list_field, scalar_type_name, CUSTOM_SCALARS, +}; + +/// Dialect gate for comparison operators (JSON ops only on Postgres). +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum SurfaceDialect { + Sqlite, + Postgres, +} + +impl SurfaceDialect { + pub fn is_postgres(self) -> bool { + matches!(self, Self::Postgres) + } +} + +/// Options for building a surface from a table catalog. +#[derive(Clone, Debug)] +pub struct SurfaceOptions { + pub dialect: SurfaceDialect, + pub aggregates: bool, + pub subscriptions: bool, +} + +impl SurfaceOptions { + pub fn sqlite() -> Self { + Self { + dialect: SurfaceDialect::Sqlite, + aggregates: true, + subscriptions: true, + } + } + + pub fn postgres() -> Self { + Self { + dialect: SurfaceDialect::Postgres, + aggregates: true, + subscriptions: true, + } + } +} + +/// Kind of a GraphQL root field on Query / Subscription. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum RootKind { + List, + ByPk, + Aggregate, +} + +/// One Query or Subscription root field inventory entry. +#[derive(Clone, Debug, PartialEq, Eq)] +pub struct RootField { + pub name: String, + pub kind: RootKind, + /// GraphQL object type name (`model_name`). + pub object: String, + /// Model name in the catalog (`schema.model_name`). + pub model_name: String, +} + +/// Column field on an object type (after skips / role filter). +#[derive(Clone, Debug, PartialEq, Eq)] +pub struct ColumnField { + pub name: String, + pub scalar: String, + pub nullable: bool, +} + +/// Relationship field inventory (target must be on the surface). +#[derive(Clone, Debug, PartialEq, Eq)] +pub struct RelField { + pub name: String, + pub target_model: String, + pub target_object: String, + pub kind: RelationshipKind, + pub list: bool, +} + +/// One exposed read-model on the surface. +#[derive(Clone, Debug)] +pub struct SurfaceModel { + pub model_name: String, + pub table_name: String, + pub object_name: String, + pub columns: Vec, + pub relationships: Vec, + pub primary_key: Vec, + /// Filtered schema clone (columns limited for role surfaces). + pub(crate) schema: TableSchema, +} + +/// Intermediate surface IR. +#[derive(Clone, Debug)] +pub struct Surface { + pub dialect: SurfaceDialect, + pub aggregates: bool, + pub subscriptions: bool, + /// Keyed by `model_name`. + pub models: BTreeMap, + pub query_fields: Vec, + pub subscription_fields: Vec, + /// GraphQL comparison input name → operator field names (from `naming` only). + pub comparison_ops: BTreeMap>, +} + +impl Surface { + /// Read-model schemas in stable model_name order (for SDL / adapters). + pub fn schemas(&self) -> Vec { + self.models + .values() + .map(|m| m.schema.clone()) + .collect() + } + + /// Inventory of query root field names (sorted). + pub fn query_root_names(&self) -> Vec<&str> { + let mut names: Vec<&str> = self.query_fields.iter().map(|f| f.name.as_str()).collect(); + names.sort(); + names + } + + /// Comparison operator fields for a scalar, empty if scalar unused. + pub fn comparison_ops_for_scalar(&self, scalar: &str) -> Vec<&str> { + let name = comparison_exp_name(scalar); + self.comparison_ops + .get(&name) + .map(|ops| ops.iter().map(String::as_str).collect()) + .unwrap_or_default() + } +} + +/// Build the full (unscoped) surface from a table catalog. +pub fn build_surface( + tables: &[TableSchema], + options: &SurfaceOptions, +) -> Result { + let read_models: Vec<&TableSchema> = tables + .iter() + .filter(|t| t.kind.is_read_model()) + .collect(); + + for schema in &read_models { + schema + .validate() + .map_err(|e| format!("schema `{}` invalid: {e}", schema.model_name))?; + } + + let by_model: BTreeMap<&str, &TableSchema> = read_models + .iter() + .map(|t| (t.model_name.as_str(), *t)) + .collect(); + let by_table: BTreeMap<&str, &TableSchema> = read_models + .iter() + .map(|t| (t.table_name.as_str(), *t)) + .collect(); + + let postgres_json = include_postgres_json_comparison_ops(options.dialect.is_postgres()); + let mut used_scalars: BTreeSet = BTreeSet::new(); + let mut models: BTreeMap = BTreeMap::new(); + + for schema in &read_models { + let object_name = object_type_name(schema).to_string(); + if !is_valid_graphql_name(&object_name) { + return Err(format!("object type `{object_name}` is not a valid GraphQL name")); + } + if !is_valid_graphql_name(root_list_field(schema)) { + return Err(format!( + "root field `{}` is not a valid GraphQL name", + root_list_field(schema) + )); + } + + let mut columns = Vec::new(); + for col in visible_columns(schema) { + if !is_valid_graphql_name(&col.column_name) { + return Err(format!( + "model `{}` column `{}` is not a valid GraphQL name", + schema.model_name, col.column_name + )); + } + let Some(scalar) = scalar_type_name(&col.column_type) else { + return Err(format!( + "model `{}` column `{}` has unsupported type", + schema.model_name, col.column_name + )); + }; + used_scalars.insert(scalar.to_string()); + columns.push(ColumnField { + name: col.column_name.clone(), + scalar: scalar.to_string(), + nullable: col.nullable, + }); + } + + let mut relationships = Vec::new(); + for rel in &schema.relationships { + if !is_valid_graphql_name(&rel.field_name) { + return Err(format!( + "model `{}` relationship `{}` is not a valid GraphQL name", + schema.model_name, rel.field_name + )); + } + if !relationship_emitted(schema, rel, &by_model, &by_table) { + continue; + } + let target = by_model + .get(rel.target_model.as_str()) + .expect("relationship_emitted"); + let list = matches!( + rel.kind, + RelationshipKind::HasMany | RelationshipKind::ManyToMany + ); + relationships.push(RelField { + name: rel.field_name.clone(), + target_model: rel.target_model.clone(), + target_object: object_type_name(target).to_string(), + kind: rel.kind.clone(), + list, + }); + } + + models.insert( + schema.model_name.clone(), + SurfaceModel { + model_name: schema.model_name.clone(), + table_name: schema.table_name.clone(), + object_name, + columns, + relationships, + primary_key: schema.primary_key.columns.clone(), + schema: (*schema).clone(), + }, + ); + } + + // Drop relationships whose target was not included (defensive). + let model_keys: BTreeSet = models.keys().cloned().collect(); + for model in models.values_mut() { + model + .relationships + .retain(|r| model_keys.contains(&r.target_model)); + } + + let mut comparison_ops = BTreeMap::new(); + for scalar in &used_scalars { + let ops = comparison_op_fields(scalar, postgres_json); + comparison_ops.insert( + comparison_exp_name(scalar), + ops.into_iter().map(str::to_string).collect(), + ); + } + // Always reserve custom scalar names for naming collisions checks downstream. + let _ = CUSTOM_SCALARS; + + let (query_fields, subscription_fields) = + root_fields_for_models(&models, options.aggregates, options.subscriptions); + + Ok(Surface { + dialect: options.dialect, + aggregates: options.aggregates, + subscriptions: options.subscriptions, + models, + query_fields, + subscription_fields, + comparison_ops, + }) +} + +/// Role grant used by [`surface_for_role`] (feature-free; maps from `ReadPermission` +/// when the `graphql` feature is enabled). +#[derive(Clone, Debug)] +pub struct RoleGrant { + pub all_columns: bool, + pub columns: BTreeSet, + pub aggregations: bool, +} + +impl RoleGrant { + pub fn all_columns() -> Self { + Self { + all_columns: true, + columns: BTreeSet::new(), + aggregations: false, + } + } + + pub fn columns>>(cols: I) -> Self { + Self { + all_columns: false, + columns: cols.into_iter().map(Into::into).collect(), + aggregations: false, + } + } + + pub fn with_aggregations(mut self) -> Self { + self.aggregations = true; + self + } + + pub fn allows_column(&self, name: &str) -> bool { + self.all_columns || self.columns.contains(name) + } +} + +/// Apply role grants: drop ungranted models and columns (and relationships to +/// dropped models). Aggregate roots omitted when `aggregations` is false. +/// +/// `grants`: map of model_name → grant for this role. Missing model = not granted. +pub fn surface_for_role( + surface: &Surface, + role: &str, + grants: &BTreeMap, +) -> Surface { + let _ = role; + let mut models: BTreeMap = BTreeMap::new(); + + for (model_name, model) in &surface.models { + let Some(grant) = grants.get(model_name) else { + continue; + }; + + let allowed_cols: BTreeSet = model + .columns + .iter() + .filter(|c| grant.allows_column(&c.name)) + .map(|c| c.name.clone()) + .collect(); + + let columns: Vec = model + .columns + .iter() + .filter(|c| allowed_cols.contains(&c.name)) + .cloned() + .collect(); + + let mut schema = model.schema.clone(); + for col in &mut schema.columns { + if !col.skipped && !allowed_cols.contains(&col.column_name) { + col.skipped = true; + } + } + + models.insert( + model_name.clone(), + SurfaceModel { + model_name: model.model_name.clone(), + table_name: model.table_name.clone(), + object_name: model.object_name.clone(), + columns, + relationships: model.relationships.clone(), + primary_key: model.primary_key.clone(), + schema, + }, + ); + } + + // Relationships only if target model remains granted (collect keys first). + let model_keys: BTreeSet = models.keys().cloned().collect(); + for model in models.values_mut() { + model + .relationships + .retain(|r| model_keys.contains(&r.target_model)); + let rel_names: BTreeSet = model.relationships.iter().map(|r| r.name.clone()).collect(); + model.schema.relationships.retain(|r| { + model_keys.contains(&r.target_model) && rel_names.contains(&r.field_name) + }); + } + + let mut query_fields = Vec::new(); + let mut subscription_fields = Vec::new(); + for model in models.values() { + let grant = grants.get(&model.model_name); + let allow_agg = surface.aggregates && grant.is_some_and(|g| g.aggregations); + let list = root_list_field(&model.schema).to_string(); + let by_pk = by_pk_field(&model.schema); + query_fields.push(RootField { + name: list.clone(), + kind: RootKind::List, + object: model.object_name.clone(), + model_name: model.model_name.clone(), + }); + query_fields.push(RootField { + name: by_pk.clone(), + kind: RootKind::ByPk, + object: model.object_name.clone(), + model_name: model.model_name.clone(), + }); + if allow_agg { + query_fields.push(RootField { + name: format!("{}_aggregate", model.table_name), + kind: RootKind::Aggregate, + object: model.object_name.clone(), + model_name: model.model_name.clone(), + }); + } + if surface.subscriptions { + subscription_fields.push(RootField { + name: list, + kind: RootKind::List, + object: model.object_name.clone(), + model_name: model.model_name.clone(), + }); + subscription_fields.push(RootField { + name: by_pk, + kind: RootKind::ByPk, + object: model.object_name.clone(), + model_name: model.model_name.clone(), + }); + } + } + query_fields.sort_by(|a, b| a.name.cmp(&b.name)); + subscription_fields.sort_by(|a, b| a.name.cmp(&b.name)); + + let postgres_json = include_postgres_json_comparison_ops(surface.dialect.is_postgres()); + let mut used_scalars: BTreeSet = BTreeSet::new(); + for m in models.values() { + for c in &m.columns { + used_scalars.insert(c.scalar.clone()); + } + } + let mut comparison_ops = BTreeMap::new(); + for scalar in &used_scalars { + let ops = comparison_op_fields(scalar, postgres_json); + comparison_ops.insert( + comparison_exp_name(scalar), + ops.into_iter().map(str::to_string).collect(), + ); + } + + let aggregates = query_fields.iter().any(|f| f.kind == RootKind::Aggregate); + + Surface { + dialect: surface.dialect, + aggregates, + subscriptions: surface.subscriptions, + models, + query_fields, + subscription_fields, + comparison_ops, + } +} + +fn root_fields_for_models( + models: &BTreeMap, + aggregates: bool, + subscriptions: bool, +) -> (Vec, Vec) { + let mut query_fields = Vec::new(); + let mut subscription_fields = Vec::new(); + for model in models.values() { + let list = root_list_field(&model.schema).to_string(); + let by_pk = by_pk_field(&model.schema); + query_fields.push(RootField { + name: list.clone(), + kind: RootKind::List, + object: model.object_name.clone(), + model_name: model.model_name.clone(), + }); + query_fields.push(RootField { + name: by_pk.clone(), + kind: RootKind::ByPk, + object: model.object_name.clone(), + model_name: model.model_name.clone(), + }); + if aggregates { + query_fields.push(RootField { + name: format!("{}_aggregate", model.table_name), + kind: RootKind::Aggregate, + object: model.object_name.clone(), + model_name: model.model_name.clone(), + }); + } + if subscriptions { + subscription_fields.push(RootField { + name: list, + kind: RootKind::List, + object: model.object_name.clone(), + model_name: model.model_name.clone(), + }); + subscription_fields.push(RootField { + name: by_pk, + kind: RootKind::ByPk, + object: model.object_name.clone(), + model_name: model.model_name.clone(), + }); + } + } + query_fields.sort_by(|a, b| a.name.cmp(&b.name)); + subscription_fields.sort_by(|a, b| a.name.cmp(&b.name)); + (query_fields, subscription_fields) +} + +fn visible_columns(schema: &TableSchema) -> impl Iterator { + schema.columns.iter().filter(|c| !c.skipped) +} + +fn relationship_emitted( + schema: &TableSchema, + rel: &crate::table::RelationshipDef, + by_model: &BTreeMap<&str, &TableSchema>, + by_table: &BTreeMap<&str, &TableSchema>, +) -> bool { + let Some(target) = by_model.get(rel.target_model.as_str()) else { + return false; + }; + match rel.kind { + RelationshipKind::HasMany | RelationshipKind::BelongsTo => true, + RelationshipKind::ManyToMany => { + let Some(through_name) = rel.through.as_deref() else { + return false; + }; + if let Some(through) = by_table.get(through_name) { + resolve_m2m_target_foreign_key(schema, rel, through, target).is_ok() + } else { + false + } + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::table::{ColumnType, PrimaryKey, RelationshipDef, TableColumn, TableKind}; + + fn orders() -> TableSchema { + TableSchema { + model_name: "OrderView".into(), + table_name: "orders".into(), + columns: vec![ + TableColumn { + primary_key: true, + ..TableColumn::new("order_id", "order_id", ColumnType::Text) + }, + TableColumn::new("customer_id", "customer_id", ColumnType::Text), + TableColumn::new("status", "status", ColumnType::Text), + TableColumn { + jsonb: true, + ..TableColumn::new("meta", "meta", ColumnType::Json) + }, + ], + primary_key: PrimaryKey::new(["order_id"]), + version_column: Some("_sourced_version".into()), + foreign_keys: Vec::new(), + indexes: Vec::new(), + relationships: Vec::new(), + kind: TableKind::ReadModel, + } + } + + fn operational() -> TableSchema { + TableSchema { + model_name: "Outbox".into(), + table_name: "outbox".into(), + columns: vec![TableColumn { + primary_key: true, + ..TableColumn::new("id", "id", ColumnType::Text) + }], + primary_key: PrimaryKey::new(["id"]), + version_column: None, + foreign_keys: Vec::new(), + indexes: Vec::new(), + relationships: Vec::new(), + kind: TableKind::Operational, + } + } + + #[test] + fn build_surface_skips_operational_and_lists_roots() { + let surface = build_surface( + &[orders(), operational()], + &SurfaceOptions::sqlite(), + ) + .expect("surface"); + assert!(surface.models.contains_key("OrderView")); + assert!(!surface.models.contains_key("Outbox")); + let roots = surface.query_root_names(); + assert!(roots.contains(&"orders")); + assert!(roots.contains(&"orders_by_pk")); + assert!(roots.contains(&"orders_aggregate")); + } + + #[test] + fn sqlite_surface_omits_pg_json_comparison_ops() { + let surface = build_surface(&[orders()], &SurfaceOptions::sqlite()).unwrap(); + let ops = surface.comparison_ops_for_scalar("JSON"); + assert!(ops.contains(&"_eq")); + for forbidden in ["_contains", "_contained_in", "_has_key"] { + assert!( + !ops.contains(&forbidden), + "SQLite must not expose {forbidden}" + ); + } + } + + #[test] + fn postgres_surface_includes_pg_json_comparison_ops() { + let surface = build_surface(&[orders()], &SurfaceOptions::postgres()).unwrap(); + let ops = surface.comparison_ops_for_scalar("JSON"); + for required in ["_contains", "_contained_in", "_has_key"] { + assert!(ops.contains(&required), "Postgres missing {required}"); + } + } + + #[test] + fn surface_for_role_drops_ungranted_columns_and_models() { + let full = build_surface(&[orders()], &SurfaceOptions::sqlite()).unwrap(); + let mut grants = BTreeMap::new(); + grants.insert( + "OrderView".to_string(), + RoleGrant::columns(["order_id", "status"]), + ); + let role_surface = surface_for_role(&full, "user", &grants); + let model = role_surface.models.get("OrderView").expect("granted"); + let col_names: Vec<_> = model.columns.iter().map(|c| c.name.as_str()).collect(); + assert_eq!(col_names, vec!["order_id", "status"]); + assert!(!col_names.contains(&"customer_id")); + assert!(!col_names.contains(&"meta")); + + let empty = surface_for_role(&full, "anon", &BTreeMap::new()); + assert!(empty.models.is_empty()); + assert!(empty.query_fields.is_empty()); + } + + #[test] + fn surface_for_role_omits_aggregate_without_grant() { + let full = build_surface(&[orders()], &SurfaceOptions::sqlite()).unwrap(); + let mut grants = BTreeMap::new(); + grants.insert("OrderView".to_string(), RoleGrant::all_columns()); + let role_surface = surface_for_role(&full, "user", &grants); + let names = role_surface.query_root_names(); + assert!(names.contains(&"orders")); + assert!(!names.contains(&"orders_aggregate")); + + let mut admin = BTreeMap::new(); + admin.insert( + "OrderView".to_string(), + RoleGrant::all_columns().with_aggregations(), + ); + let admin_surface = surface_for_role(&full, "admin", &admin); + assert!(admin_surface + .query_root_names() + .contains(&"orders_aggregate")); + } + + #[test] + fn relationship_only_when_target_on_surface() { + let parent = TableSchema { + model_name: "ParentView".into(), + table_name: "parents".into(), + columns: vec![TableColumn { + primary_key: true, + ..TableColumn::new("id", "id", ColumnType::Text) + }], + primary_key: PrimaryKey::new(["id"]), + version_column: None, + foreign_keys: Vec::new(), + indexes: Vec::new(), + relationships: vec![RelationshipDef { + field_name: "children".into(), + kind: RelationshipKind::HasMany, + target_model: "ChildView".into(), + foreign_key: Some("parent_id".into()), + through: None, + target_foreign_key: None, + }], + kind: TableKind::ReadModel, + }; + let child = TableSchema { + model_name: "ChildView".into(), + table_name: "children".into(), + columns: vec![ + TableColumn { + primary_key: true, + ..TableColumn::new("id", "id", ColumnType::Text) + }, + TableColumn::new("parent_id", "parent_id", ColumnType::Text), + ], + primary_key: PrimaryKey::new(["id"]), + version_column: None, + foreign_keys: Vec::new(), + indexes: Vec::new(), + relationships: Vec::new(), + kind: TableKind::ReadModel, + }; + let both = build_surface(&[parent.clone(), child], &SurfaceOptions::sqlite()).unwrap(); + assert!(both + .models + .get("ParentView") + .unwrap() + .relationships + .iter() + .any(|r| r.name == "children")); + + let parent_only = build_surface(&[parent], &SurfaceOptions::sqlite()).unwrap(); + assert!(parent_only + .models + .get("ParentView") + .unwrap() + .relationships + .is_empty()); + } +} diff --git a/tests/e2e-ui/ui/src/lib/gql/cache/index.ts b/tests/e2e-ui/ui/src/lib/gql/cache/index.ts new file mode 100644 index 00000000..67ab4455 --- /dev/null +++ b/tests/e2e-ui/ui/src/lib/gql/cache/index.ts @@ -0,0 +1,15 @@ +export { QueryCache, cacheKey, type CacheEntry, type CacheKey } from './query-cache.ts'; +export { + applyCacheOp, + applyCacheOps, + applyProjectionPayload, + effect, + rollback, + type CacheOp, + type CacheTarget, + type CommandPolicy, + type Effect, + type ResultKind, + type ReconcileKind +} from './ops.ts'; +export { runCommandPipeline, type CommandPipelineOptions, type PipelineDeps } from './pipeline.ts'; diff --git a/tests/e2e-ui/ui/src/lib/gql/cache/ops.ts b/tests/e2e-ui/ui/src/lib/gql/cache/ops.ts new file mode 100644 index 00000000..03378471 --- /dev/null +++ b/tests/e2e-ui/ui/src/lib/gql/cache/ops.ts @@ -0,0 +1,230 @@ +/** + * Closed sets: CacheOp (client cache only) vs Effect (UI side effects). + */ + +import type { QueryCache } from './query-cache.ts'; +import { cacheKey } from './query-cache.ts'; + +export type CacheTarget = { + /** Query/subscription document string. */ + document: string; + variables?: Record; + /** Dot path to list/object on data, e.g. "todos". Empty = whole document. */ + at?: string; + /** Primary key field for list upsert/remove. */ + by?: string; +}; + +export type CacheOp = + | { + op: 'upsert'; + target: CacheTarget; + row: Record; + } + | { + op: 'patch'; + target: CacheTarget; + row: Record; + } + | { + op: 'remove'; + target: CacheTarget; + id: unknown; + } + | { + op: 'write'; + target: CacheTarget; + data: unknown; + } + | { + op: 'invalidate'; + prefix?: string; + }; + +export type Effect = + | { kind: 'toast'; message: string } + | { kind: 'alert'; message: string } + | { kind: 'goto'; path: string }; + +export const effect = { + toast: (message: string): Effect => ({ kind: 'toast', message }), + alert: (message: string): Effect => ({ kind: 'alert', message }), + goto: (path: string): Effect => ({ kind: 'goto', path }) +}; + +export type ResultKind = 'ack' | 'fact' | 'projection' | 'none'; +export type ReconcileKind = 'subscription' | 'refetch' | 'invalidate' | 'none'; + +export type CommandPolicy = { + result?: { kind: ResultKind; apply?: { targets: CacheTarget[] } }; + reconcile?: { kind: ReconcileKind; document?: string; variables?: Record }; + optimistic?: { + targets: CacheTarget[]; + row?: Record; + }; +}; + +export type Snapshot = { + key: string; + entry: ReturnType | undefined; + had: boolean; +}; + +function getAt(data: unknown, path?: string): unknown { + if (!path) return data; + let cur: unknown = data; + for (const part of path.split('.').filter(Boolean)) { + if (cur === null || typeof cur !== 'object') return undefined; + cur = (cur as Record)[part]; + } + return cur; +} + +function setAt(data: unknown, path: string | undefined, value: unknown): unknown { + if (!path) return value; + const parts = path.split('.').filter(Boolean); + const root = + data !== null && typeof data === 'object' ? { ...(data as Record) } : {}; + let cur: Record = root; + for (let i = 0; i < parts.length - 1; i++) { + const p = parts[i]!; + const next = cur[p]; + cur[p] = + next !== null && typeof next === 'object' && !Array.isArray(next) + ? { ...(next as Record) } + : {}; + cur = cur[p] as Record; + } + cur[parts[parts.length - 1]!] = value; + return root; +} + +function cloneEntry(entry: ReturnType): ReturnType { + if (!entry) return undefined; + return { + ...entry, + data: structuredClone(entry.data) + }; +} + +export function applyCacheOp(cache: QueryCache, op: CacheOp, now = Date.now()): Snapshot | null { + if (op.op === 'invalidate') { + cache.invalidate(op.prefix); + return null; + } + + const key = cacheKey(op.target.document, op.target.variables); + const prev = cache.get(key); + const snap: Snapshot = { key, entry: cloneEntry(prev), had: !!prev }; + + if (op.op === 'write') { + cache.set(key, { + data: op.data, + updatedAt: now, + optimistic: false, + pending: false + }); + return snap; + } + + const baseData = prev?.data ?? {}; + const at = op.target.at; + const by = op.target.by ?? 'id'; + + if (op.op === 'upsert' || op.op === 'patch') { + const list = getAt(baseData, at); + if (Array.isArray(list)) { + const id = op.row[by]; + const idx = list.findIndex( + (row) => row && typeof row === 'object' && (row as Record)[by] === id + ); + const next = [...list]; + if (idx >= 0) { + const existing = next[idx] as Record; + next[idx] = op.op === 'patch' ? { ...existing, ...op.row } : { ...existing, ...op.row }; + } else if (op.op === 'upsert') { + next.push({ ...op.row }); + } + const data = setAt(baseData, at, next); + cache.set(key, { + data, + updatedAt: now, + optimistic: true, + pending: prev?.pending + }); + } else if (!prev) { + // No cached list yet — only write full document if `at` empty. + if (!at) { + cache.set(key, { + data: op.row, + updatedAt: now, + optimistic: true + }); + } + // else: do not invent a list document from incomplete row + } else if (!at && op.op === 'patch' && prev.data && typeof prev.data === 'object') { + cache.set(key, { + data: { ...(prev.data as object), ...op.row }, + updatedAt: now, + optimistic: true + }); + } + return snap; + } + + if (op.op === 'remove') { + const list = getAt(baseData, at); + if (Array.isArray(list)) { + const next = list.filter( + (row) => !(row && typeof row === 'object' && (row as Record)[by] === op.id) + ); + cache.set(key, { + data: setAt(baseData, at, next), + updatedAt: now, + optimistic: false + }); + } + return snap; + } + + return snap; +} + +/** Apply ops; return snapshots for rollback (in reverse order). */ +export function applyCacheOps(cache: QueryCache, ops: CacheOp[]): Snapshot[] { + const snaps: Snapshot[] = []; + for (const op of ops) { + const snap = applyCacheOp(cache, op); + if (snap) snaps.push(snap); + } + return snaps; +} + +export function rollback(cache: QueryCache, snaps: Snapshot[]): void { + // Restore in reverse so nested writes unwind correctly. + for (let i = snaps.length - 1; i >= 0; i--) { + const s = snaps[i]!; + if (s.had && s.entry) { + cache.set(s.key, s.entry); + } else { + cache.delete(s.key); + } + } +} + +/** + * Projection apply: merge payload fields only onto cache targets. + * Never invents fields absent from `payload`. + */ +export function applyProjectionPayload( + cache: QueryCache, + targets: CacheTarget[], + payload: Record +): Snapshot[] { + const ops: CacheOp[] = targets.map((target) => ({ + op: 'upsert' as const, + target, + row: { ...payload } + })); + return applyCacheOps(cache, ops); +} diff --git a/tests/e2e-ui/ui/src/lib/gql/cache/pipeline.ts b/tests/e2e-ui/ui/src/lib/gql/cache/pipeline.ts new file mode 100644 index 00000000..ef8a598d --- /dev/null +++ b/tests/e2e-ui/ui/src/lib/gql/cache/pipeline.ts @@ -0,0 +1,197 @@ +/** + * Command result pipeline: + * optimistic → network → result.kind → effects → reconcile + * + * Product rule: command success ≠ projection visibility. + * Default todos path: ack/fact + subscription/refetch — do not invent full RM rows from ack. + */ + +import type { QueryCache } from './query-cache.ts'; +import { cacheKey } from './query-cache.ts'; +import { + applyCacheOps, + applyProjectionPayload, + effect, + rollback, + type CacheOp, + type CacheTarget, + type CommandPolicy, + type Effect, + type ResultKind, + type ReconcileKind +} from './ops.ts'; + +export type GqlError = { message?: string; extensions?: { code?: string } }; + +export type NetworkResult> = { + data?: T | null; + errors?: GqlError[] | null; +}; + +export type CommandPipelineOptions = { + policy?: CommandPolicy; + optimistic?: CommandPolicy['optimistic']; + result?: CommandPolicy['result']; + reconcile?: CommandPolicy['reconcile']; + onSuccess?: (ctx: { + data: unknown; + }) => Array; + onError?: (ctx: { errors: GqlError[] }) => Array; + onSettled?: () => void; + /** When true (SSR), skip optimistic + cache mutations. */ + browser?: boolean; +}; + +export type PipelineDeps = { + cache: QueryCache; + request: (document: string, variables?: Record) => Promise; + /** Optional: run refetch reconcile. */ + refetch?: (document: string, variables?: Record) => Promise; + /** Schedule effects (toast/alert). Never called on the network path itself. */ + runEffects?: (effects: Effect[]) => void; +}; + +function mergePolicy( + defaults: CommandPolicy | undefined, + opts: CommandPipelineOptions +): { + resultKind: ResultKind; + applyTargets?: CacheTarget[]; + reconcileKind: ReconcileKind; + reconcileDoc?: string; + reconcileVars?: Record; + optimistic?: CommandPolicy['optimistic']; +} { + const result = opts.result ?? defaults?.result; + const reconcile = opts.reconcile ?? defaults?.reconcile; + return { + resultKind: result?.kind ?? 'ack', + applyTargets: result?.apply?.targets, + reconcileKind: reconcile?.kind ?? 'none', + reconcileDoc: reconcile?.document, + reconcileVars: reconcile?.variables, + optimistic: opts.optimistic ?? defaults?.optimistic + }; +} + +function splitOps(items: Array): { ops: CacheOp[]; effects: Effect[] } { + const ops: CacheOp[] = []; + const effects: Effect[] = []; + for (const item of items) { + if ('op' in item) ops.push(item); + else effects.push(item); + } + return { ops, effects }; +} + +/** + * Run one generated command mutation through the cache pipeline. + * Exactly one network `request` for the command document. + */ +export async function runCommandPipeline>( + deps: PipelineDeps, + commandDocument: string, + input: Record, + opts: CommandPipelineOptions = {} +): Promise> { + const browser = opts.browser !== false; + const merged = mergePolicy(opts.policy, opts); + let snaps = [] as ReturnType; + + if (browser && merged.optimistic?.targets?.length && merged.optimistic.row) { + const optOps: CacheOp[] = merged.optimistic.targets.map((target) => ({ + op: 'upsert' as const, + target, + row: { ...merged.optimistic!.row! } + })); + snaps = applyCacheOps(deps.cache, optOps); + } + + let result: NetworkResult; + try { + result = (await deps.request(commandDocument, { input })) as NetworkResult; + } catch (e) { + if (browser && snaps.length) rollback(deps.cache, snaps); + const errors = [{ message: e instanceof Error ? e.message : String(e) }]; + const errItems = opts.onError?.({ errors }) ?? []; + const { ops, effects } = splitOps(errItems); + if (browser && ops.length) applyCacheOps(deps.cache, ops); + deps.runEffects?.(effects); + opts.onSettled?.(); + return { data: null, errors }; + } + + if (result.errors?.length) { + if (browser && snaps.length) rollback(deps.cache, snaps); + const errItems = opts.onError?.({ errors: result.errors }) ?? [ + effect.alert(result.errors[0]?.message ?? 'Failed') + ]; + const { ops, effects } = splitOps(errItems); + if (browser && ops.length) applyCacheOps(deps.cache, ops); + deps.runEffects?.(effects); + opts.onSettled?.(); + return result; + } + + // Success path + if (browser) { + if (merged.resultKind === 'projection') { + const data = result.data; + let payload: Record | null = null; + if (data && typeof data === 'object' && !Array.isArray(data)) { + const values = Object.values(data as Record); + const first = values[0]; + if (first && typeof first === 'object' && !Array.isArray(first)) { + payload = first as Record; + } else { + payload = data as Record; + } + } + if (payload && merged.applyTargets?.length) { + // Payload fields only — applyProjectionPayload copies payload keys only. + applyProjectionPayload(deps.cache, merged.applyTargets, payload); + } + } else if (merged.resultKind === 'ack' || merged.resultKind === 'fact') { + // Do NOT invent a full list row from incomplete mutation payload. + // Keep optimistic (if any) and mark pending when we have a cache key. + if (merged.optimistic?.targets?.length) { + for (const t of merged.optimistic.targets) { + const key = cacheKey(t.document, t.variables); + const entry = deps.cache.get(key); + if (entry) { + deps.cache.set(key, { ...entry, pending: true, optimistic: true }); + } + } + } + } + // resultKind === 'none' → no cache apply from response + } + + const successItems = opts.onSuccess?.({ data: result.data }) ?? []; + const { ops, effects } = splitOps(successItems); + if (browser && ops.length) applyCacheOps(deps.cache, ops); + deps.runEffects?.(effects); + + // Reconcile (subscription is usually already running; refetch optional) + if (browser && merged.reconcileKind === 'refetch' && merged.reconcileDoc && deps.refetch) { + const refetched = await deps.refetch(merged.reconcileDoc, merged.reconcileVars); + if (refetched.data && !refetched.errors?.length) { + const key = cacheKey(merged.reconcileDoc, merged.reconcileVars); + deps.cache.set(key, { + data: refetched.data, + updatedAt: Date.now(), + pending: false, + optimistic: false + }); + } + } else if (browser && merged.reconcileKind === 'invalidate' && merged.reconcileDoc) { + deps.cache.invalidate(cacheKey(merged.reconcileDoc, merged.reconcileVars)); + } + // subscription: caller owns live query → cache write-through separately + + opts.onSettled?.(); + return result; +} + +export { effect }; +export type { CacheOp, Effect, CommandPolicy, ResultKind, ReconcileKind }; diff --git a/tests/e2e-ui/ui/src/lib/gql/cache/query-cache.ts b/tests/e2e-ui/ui/src/lib/gql/cache/query-cache.ts new file mode 100644 index 00000000..0ac3102d --- /dev/null +++ b/tests/e2e-ui/ui/src/lib/gql/cache/query-cache.ts @@ -0,0 +1,99 @@ +/** + * Document-keyed browser query cache (pure). + * Not a system of truth — projectors + live queries own freshness. + */ + +export type CacheKey = string; + +export type CacheEntry = { + data: T; + updatedAt: number; + optimistic?: boolean; + /** Command succeeded; projection not yet reconciled. */ + pending?: boolean; +}; + +export type CacheListener = () => void; + +export class QueryCache { + #entries = new Map(); + #listeners = new Map>(); + + get(key: CacheKey): CacheEntry | undefined { + return this.#entries.get(key) as CacheEntry | undefined; + } + + set(key: CacheKey, entry: CacheEntry): void { + this.#entries.set(key, entry as CacheEntry); + this.#notify(key); + } + + update(key: CacheKey, fn: (data: T) => T): void { + const prev = this.get(key); + if (!prev) return; + this.set(key, { + ...prev, + data: fn(prev.data), + updatedAt: Date.now() + }); + } + + /** Delete a single key (exact). */ + delete(key: CacheKey): void { + if (this.#entries.delete(key)) this.#notify(key); + } + + invalidate(prefix?: string): void { + if (prefix === undefined) { + const keys = [...this.#entries.keys()]; + this.#entries.clear(); + for (const k of keys) this.#notify(k); + return; + } + for (const key of [...this.#entries.keys()]) { + if (key.startsWith(prefix)) { + this.#entries.delete(key); + this.#notify(key); + } + } + } + + subscribe(key: CacheKey, cb: CacheListener): () => void { + let set = this.#listeners.get(key); + if (!set) { + set = new Set(); + this.#listeners.set(key, set); + } + set.add(cb); + return () => { + set!.delete(cb); + if (set!.size === 0) this.#listeners.delete(key); + }; + } + + #notify(key: CacheKey): void { + const set = this.#listeners.get(key); + if (!set) return; + for (const cb of set) cb(); + } +} + +/** Stable key for a document string + variables. */ +export function cacheKey(document: string, variables?: Record): CacheKey { + // Treat missing and empty variables as the same key. + const vars = + variables && Object.keys(variables).length > 0 ? stableStringify(variables) : ''; + return `${document.trim()}::${vars}`; +} + +function stableStringify(value: unknown): string { + if (value === null || typeof value !== 'object') { + return JSON.stringify(value); + } + if (Array.isArray(value)) { + return `[${value.map(stableStringify).join(',')}]`; + } + const obj = value as Record; + const keys = Object.keys(obj).sort(); + return `{${keys.map((k) => `${JSON.stringify(k)}:${stableStringify(obj[k])}`).join(',')}}`; +} diff --git a/tests/e2e-ui/ui/src/lib/gql/index.ts b/tests/e2e-ui/ui/src/lib/gql/index.ts index d38adef1..c0b941da 100644 --- a/tests/e2e-ui/ui/src/lib/gql/index.ts +++ b/tests/e2e-ui/ui/src/lib/gql/index.ts @@ -21,3 +21,22 @@ export { browserGraphql } from './client.ts'; // Re-export command binders for non-useGraphql call sites (tests, SSR factories). export { bindCommands } from '$lib/api/commands.generated'; export type { BoundCommands, CommandClient } from '$lib/api/commands.generated'; + +/** Browser query cache + command result pipeline (ack/fact/projection). */ +export { + QueryCache, + cacheKey, + runCommandPipeline, + effect, + applyCacheOps, + rollback +} from './cache/index.ts'; +export type { + CacheOp, + CacheTarget, + CommandPolicy, + Effect, + ResultKind, + ReconcileKind, + CommandPipelineOptions +} from './cache/index.ts'; diff --git a/tests/e2e-ui/ui/tests/command-pipeline.test.mjs b/tests/e2e-ui/ui/tests/command-pipeline.test.mjs new file mode 100644 index 00000000..a1a9da3e --- /dev/null +++ b/tests/e2e-ui/ui/tests/command-pipeline.test.mjs @@ -0,0 +1,44 @@ +/** + * Unit tests for browser command pipeline + QueryCache. + * Drives the shipped modules under src/lib/gql/cache/. + */ +import { test } from 'node:test'; +import assert from 'node:assert/strict'; +import { pathToFileURL } from 'node:url'; +import path from 'node:path'; +import { createRequire } from 'node:module'; + +const uiRoot = path.dirname(fileURLToPath(new URL('.', import.meta.url))); +const cacheDir = path.join(uiRoot, '../src/lib/gql/cache'); + +// Node cannot import .ts directly — load compiled-equivalent via dynamic import +// of the TypeScript sources through a small ESM bridge using tsx if present, +// otherwise re-implement is forbidden: use node --experimental-strip-types when available. + +import { fileURLToPath } from 'node:url'; +import { spawnSync } from 'node:child_process'; + +const runner = path.join(uiRoot, 'tests/run-pipeline-unit.mjs'); +const r = spawnSync(process.execPath, ['--experimental-strip-types', runner], { + encoding: 'utf8', + cwd: uiRoot +}); + +if (r.status !== 0) { + // Fallback: inline minimal loader that imports .ts with strip-types from this file + console.error(r.stdout); + console.error(r.stderr); +} + +test('pipeline unit suite (strip-types)', () => { + if (r.status === 0) { + assert.match(r.stdout + r.stderr, /# pass|# tests|ok |passed/i); + return; + } + // If strip-types unsupported, fail with diagnostics + assert.equal( + r.status, + 0, + `pipeline unit runner failed:\n${r.stdout}\n${r.stderr}` + ); +}); diff --git a/tests/e2e-ui/ui/tests/run-pipeline-unit.mjs b/tests/e2e-ui/ui/tests/run-pipeline-unit.mjs new file mode 100644 index 00000000..98b8c7bf --- /dev/null +++ b/tests/e2e-ui/ui/tests/run-pipeline-unit.mjs @@ -0,0 +1,218 @@ +/** + * Runnable via: node --experimental-strip-types tests/run-pipeline-unit.mjs + * Imports shipped TypeScript modules under src/lib/gql/cache/. + */ +import assert from 'node:assert/strict'; +import { + QueryCache, + cacheKey, + applyCacheOps, + rollback, + runCommandPipeline, + effect +} from '../src/lib/gql/cache/index.ts'; + +const TODOS_DOC = 'query Todos { todos { todo_id title status } }'; +const CREATE_DOC = 'mutation TodosCreate($input: TodosCreateInput!) { todos_create(input: $input) { todo_id } }'; + +let passed = 0; +function check(name, fn) { + try { + fn(); + passed += 1; + console.log(`ok - ${name}`); + } catch (e) { + console.error(`not ok - ${name}`); + console.error(e); + process.exitCode = 1; + } +} + +async function checkAsync(name, fn) { + try { + await fn(); + passed += 1; + console.log(`ok - ${name}`); + } catch (e) { + console.error(`not ok - ${name}`); + console.error(e); + process.exitCode = 1; + } +} + +check('QueryCache set/get/invalidate', () => { + const cache = new QueryCache(); + const key = cacheKey(TODOS_DOC, {}); + cache.set(key, { data: { todos: [] }, updatedAt: 1 }); + assert.deepEqual(cache.get(key)?.data, { todos: [] }); + cache.invalidate(key); + assert.equal(cache.get(key), undefined); +}); + +check('optimistic upsert into list by PK', () => { + const cache = new QueryCache(); + const key = cacheKey(TODOS_DOC, {}); + cache.set(key, { + data: { todos: [{ todo_id: 'a', title: 'old', status: 'open' }] }, + updatedAt: 1 + }); + applyCacheOps(cache, [ + { + op: 'upsert', + target: { document: TODOS_DOC, at: 'todos', by: 'todo_id' }, + row: { todo_id: 'b', title: 'new', status: 'open' } + } + ]); + const todos = cache.get(key).data.todos; + assert.equal(todos.length, 2); + assert.equal(todos[1].todo_id, 'b'); +}); + +check('rollback restores previous cache', () => { + const cache = new QueryCache(); + const key = cacheKey(TODOS_DOC, {}); + cache.set(key, { + data: { todos: [{ todo_id: 'a', title: 'old', status: 'open' }] }, + updatedAt: 1 + }); + const snaps = applyCacheOps(cache, [ + { + op: 'upsert', + target: { document: TODOS_DOC, at: 'todos', by: 'todo_id' }, + row: { todo_id: 'b', title: 'ghost', status: 'open' } + } + ]); + assert.equal(cache.get(key).data.todos.length, 2); + rollback(cache, snaps); + assert.equal(cache.get(key).data.todos.length, 1); + assert.equal(cache.get(key).data.todos[0].todo_id, 'a'); +}); + +await checkAsync('error path rolls back optimistic and runs onError effect', async () => { + const cache = new QueryCache(); + const key = cacheKey(TODOS_DOC, {}); + cache.set(key, { data: { todos: [] }, updatedAt: 1 }); + const effects = []; + const result = await runCommandPipeline( + { + cache, + request: async () => ({ data: null, errors: [{ message: 'boom' }] }), + runEffects: (e) => effects.push(...e) + }, + CREATE_DOC, + { todo_id: 'x', title: 't' }, + { + optimistic: { + targets: [{ document: TODOS_DOC, at: 'todos', by: 'todo_id' }], + row: { todo_id: 'x', title: 't', status: 'open' } + }, + result: { kind: 'ack' }, + onError: ({ errors }) => [effect.alert(errors[0].message)] + } + ); + assert.ok(result.errors?.length); + assert.equal(cache.get(key).data.todos.length, 0); + assert.equal(effects[0]?.kind, 'alert'); + assert.equal(effects[0]?.message, 'boom'); +}); + +await checkAsync('ack success does not invent full list row from incomplete payload', async () => { + const cache = new QueryCache(); + const key = cacheKey(TODOS_DOC, {}); + cache.set(key, { data: { todos: [] }, updatedAt: 1 }); + // No optimistic — only incomplete server payload + const result = await runCommandPipeline( + { + cache, + request: async () => ({ + data: { todos_create: { todo_id: 'only-id' } }, + errors: null + }) + }, + CREATE_DOC, + { todo_id: 'only-id', title: 't' }, + { + result: { kind: 'ack' }, + reconcile: { kind: 'none' } + } + ); + assert.ok(result.data); + // Must not invent { todo_id, title, status } list row from ack payload alone + assert.deepEqual(cache.get(key).data.todos, []); +}); + +await checkAsync('projection applies payload fields only to targets', async () => { + const cache = new QueryCache(); + const key = cacheKey(TODOS_DOC, {}); + cache.set(key, { + data: { todos: [{ todo_id: 'g', title: 'old', status: 'open', secret: 'keep' }] }, + updatedAt: 1 + }); + await runCommandPipeline( + { + cache, + request: async () => ({ + data: { + game_move: { todo_id: 'g', title: 'from-server', status: 'done' } + }, + errors: null + }) + }, + 'mutation M($input: In!) { game_move(input: $input) { todo_id title status } }', + { todo_id: 'g' }, + { + result: { + kind: 'projection', + apply: { + targets: [{ document: TODOS_DOC, at: 'todos', by: 'todo_id' }] + } + } + } + ); + const row = cache.get(key).data.todos.find((t) => t.todo_id === 'g'); + assert.equal(row.title, 'from-server'); + assert.equal(row.status, 'done'); + // secret was not in payload — merge keeps existing on upsert merge + assert.equal(row.secret, 'keep'); +}); + +await checkAsync('onSuccess toast is Effect and not run on error', async () => { + const effects = []; + await runCommandPipeline( + { + cache: new QueryCache(), + request: async () => ({ data: null, errors: [{ message: 'no' }] }), + runEffects: (e) => effects.push(...e) + }, + CREATE_DOC, + {}, + { + result: { kind: 'ack' }, + onSuccess: () => [effect.toast('Created')], + onError: () => [effect.alert('Failed')] + } + ); + assert.equal(effects.length, 1); + assert.equal(effects[0].kind, 'alert'); +}); + +await checkAsync('exactly one network request for command', async () => { + let calls = 0; + await runCommandPipeline( + { + cache: new QueryCache(), + request: async () => { + calls += 1; + return { data: { todos_create: { todo_id: '1' } }, errors: null }; + } + }, + CREATE_DOC, + { todo_id: '1' }, + { result: { kind: 'ack' } } + ); + assert.equal(calls, 1); +}); + +console.log(`# tests ${passed}`); +console.log(`# pass ${passed}`); +if (process.exitCode) process.exit(process.exitCode); From 30e5042042792e9563142c5785dfce447032afa4 Mon Sep 17 00:00:00 2001 From: Patrick Lee Scott Date: Thu, 16 Jul 2026 17:34:44 -0500 Subject: [PATCH 02/20] feat(e2e-ui): migrate todos/chat/admin to command pipeline + QueryCache MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Pages use gql.commands.* with optimistic → fact/ack → reconcile (refetch/sub). List UI is cache-driven; hand-rolled mergeFromServer/pending maps removed. bindCommandsPipeline wires generated COMMAND_DOCS through runCommandPipeline. Tests assert page structure and pipeline behavior (rollback, refetch). --- .../ui/src/lib/gql/bind-commands-pipeline.ts | 181 +++++++++++++++++ tests/e2e-ui/ui/src/lib/gql/cache-helpers.ts | 53 +++++ tests/e2e-ui/ui/src/lib/gql/create-client.ts | 71 ++++++- tests/e2e-ui/ui/src/lib/gql/index.ts | 14 +- tests/e2e-ui/ui/src/lib/gql/use-graphql.ts | 47 ++++- tests/e2e-ui/ui/src/routes/admin/+page.svelte | 73 ++++--- tests/e2e-ui/ui/src/routes/chat/+page.svelte | 86 +++++--- tests/e2e-ui/ui/src/routes/todos/+page.svelte | 187 +++++++++--------- tests/e2e-ui/ui/tests/api-contract.test.mjs | 24 ++- tests/e2e-ui/ui/tests/command-client.test.mjs | 14 +- tests/e2e-ui/ui/tests/page-pipeline.test.mjs | 133 +++++++++++++ 11 files changed, 721 insertions(+), 162 deletions(-) create mode 100644 tests/e2e-ui/ui/src/lib/gql/bind-commands-pipeline.ts create mode 100644 tests/e2e-ui/ui/src/lib/gql/cache-helpers.ts create mode 100644 tests/e2e-ui/ui/tests/page-pipeline.test.mjs diff --git a/tests/e2e-ui/ui/src/lib/gql/bind-commands-pipeline.ts b/tests/e2e-ui/ui/src/lib/gql/bind-commands-pipeline.ts new file mode 100644 index 00000000..3bc80053 --- /dev/null +++ b/tests/e2e-ui/ui/src/lib/gql/bind-commands-pipeline.ts @@ -0,0 +1,181 @@ +/** + * Bind generated commands through the command result pipeline when a QueryCache + * is present. Call sites: + * + * await gql.commands.todosCreate(input, { + * optimistic: { targets: [...], row }, + * result: { kind: 'fact' }, + * reconcile: { kind: 'refetch', document: todosDoc }, + * onError: ({ errors }) => [effect.alert(errors[0]?.message ?? 'Failed')], + * }); + * + * Without a second arg, defaults from `commandPolicies` apply when provided. + */ +import { + COMMAND_DOCS, + bindCommands, + type BoundCommands, + type CommandClient, + type TodoCreateInput, + type TodoCreatePayload, + type TodoCompleteInput, + type TodoStatusPayload, + type TodoArchiveInput, + type TodoForceArchiveInput, + type TodoForceArchivePayload, + type TodoRenameInput, + type TodoRenamePayload, + type TodoReopenInput, + type ChatPostInput, + type ChatPostPayload +} from '../api/commands.generated.ts'; +import type { GqlResult } from './types.ts'; +import type { QueryCache } from './cache/query-cache.ts'; +import { + runCommandPipeline, + type CommandPipelineOptions, + type CommandPolicy +} from './cache/index.ts'; + +export type CommandCallOptions = CommandPipelineOptions; + +/** Default policies keyed by bound command function name. */ +export type CommandPolicyMap = Partial>; + +export type PipelinedBoundCommands = { + todosCreate: ( + input: TodoCreateInput, + opts?: CommandCallOptions + ) => Promise>; + todosComplete: ( + input: TodoCompleteInput, + opts?: CommandCallOptions + ) => Promise>; + todosArchive: ( + input: TodoArchiveInput, + opts?: CommandCallOptions + ) => Promise>; + todosForceArchive: ( + input: TodoForceArchiveInput, + opts?: CommandCallOptions + ) => Promise>; + todosRename: ( + input: TodoRenameInput, + opts?: CommandCallOptions + ) => Promise>; + todosReopen: ( + input: TodoReopenInput, + opts?: CommandCallOptions + ) => Promise>; + chatMessagesPost: ( + input: ChatPostInput, + opts?: CommandCallOptions + ) => Promise>; +}; + +type FieldName = keyof typeof COMMAND_DOCS; + +const FN_TO_FIELD: Record = { + todosCreate: 'todos_create', + todosComplete: 'todos_complete', + todosArchive: 'todos_archive', + todosForceArchive: 'todos_force_archive', + todosRename: 'todos_rename', + todosReopen: 'todos_reopen', + chatMessagesPost: 'chat_messages_post' +}; + +function isBrowser(): boolean { + return typeof window !== 'undefined'; +} + +function unwrapField( + data: Record | null | undefined, + field: string +): T | undefined { + if (!data || typeof data !== 'object') return undefined; + return data[field] as T | undefined; +} + +/** + * Bind commands. With `cache`, each call runs optimistic → network → result → + * effects → reconcile. Without cache (SSR), falls back to plain `bindCommands`. + */ +export function bindCommandsPipeline( + client: CommandClient, + options: { + cache?: QueryCache; + policies?: CommandPolicyMap; + /** Collect UI effects (toast/alert) from onSuccess/onError. */ + runEffects?: (effects: import('./cache/ops.ts').Effect[]) => void; + } = {} +): PipelinedBoundCommands { + const plain = bindCommands(client); + const cache = options.cache; + const policies = options.policies ?? {}; + + if (!cache) { + // Still accept optional second arg for API compatibility; ignore it. + return { + todosCreate: (input, _opts?) => plain.todosCreate(input), + todosComplete: (input, _opts?) => plain.todosComplete(input), + todosArchive: (input, _opts?) => plain.todosArchive(input), + todosForceArchive: (input, _opts?) => plain.todosForceArchive(input), + todosRename: (input, _opts?) => plain.todosRename(input), + todosReopen: (input, _opts?) => plain.todosReopen(input), + chatMessagesPost: (input, _opts?) => plain.chatMessagesPost(input) + }; + } + + const wrap = + , O>(fnName: keyof BoundCommands) => + async (input: I, callOpts: CommandCallOptions = {}): Promise> => { + const field = FN_TO_FIELD[fnName]; + const document = COMMAND_DOCS[field]; + const policy = policies[fnName]; + // Always use the pipeline when a cache is bound. Optimistic/cache mutations + // run when `browser` is true (real window, or explicit opt-in for unit tests). + const browser = callOpts.browser ?? isBrowser(); + + const result = await runCommandPipeline( + { + cache, + request: async (doc, variables) => { + const r = await client.request(doc, variables); + return { data: r.data as Record | null, errors: r.errors }; + }, + refetch: async (doc, variables) => { + const r = await client.request(doc, variables); + return { data: r.data as Record | null, errors: r.errors }; + }, + runEffects: options.runEffects + }, + document, + input, + { + ...callOpts, + policy: callOpts.policy ?? policy, + browser + } + ); + + return { + data: unwrapField( + result.data as Record | null | undefined, + field + ), + errors: result.errors ?? undefined, + status: 200 + }; + }; + + return { + todosCreate: wrap('todosCreate'), + todosComplete: wrap('todosComplete'), + todosArchive: wrap('todosArchive'), + todosForceArchive: wrap('todosForceArchive'), + todosRename: wrap('todosRename'), + todosReopen: wrap('todosReopen'), + chatMessagesPost: wrap('chatMessagesPost') + }; +} diff --git a/tests/e2e-ui/ui/src/lib/gql/cache-helpers.ts b/tests/e2e-ui/ui/src/lib/gql/cache-helpers.ts new file mode 100644 index 00000000..c80c7812 --- /dev/null +++ b/tests/e2e-ui/ui/src/lib/gql/cache-helpers.ts @@ -0,0 +1,53 @@ +/** + * Small helpers for pages that seed / read a document-keyed QueryCache. + */ +import type { QueryCache } from './cache/query-cache.ts'; +import { cacheKey } from './cache/query-cache.ts'; +import { documentToString, type GqlDocument } from './document.ts'; + +export function seedQueryCache( + cache: QueryCache, + document: GqlDocument, + data: T, + variables?: Record +): string { + const key = cacheKey(documentToString(document), variables); + cache.set(key, { + data, + updatedAt: Date.now(), + optimistic: false, + pending: false + }); + return key; +} + +export function readQueryList( + cache: QueryCache, + document: GqlDocument, + at: string, + variables?: Record +): T[] { + const key = cacheKey(documentToString(document), variables); + const entry = cache.get>(key); + const list = entry?.data?.[at]; + return Array.isArray(list) ? (list as T[]) : []; +} + +export function queryDocString(document: GqlDocument): string { + return documentToString(document); +} + +/** List target for optimistic upserts / projection apply. */ +export function listTarget( + document: GqlDocument, + at: string, + by: string, + variables?: Record +) { + return { + document: documentToString(document), + variables, + at, + by + }; +} diff --git a/tests/e2e-ui/ui/src/lib/gql/create-client.ts b/tests/e2e-ui/ui/src/lib/gql/create-client.ts index fce2c11a..c01e2ddd 100644 --- a/tests/e2e-ui/ui/src/lib/gql/create-client.ts +++ b/tests/e2e-ui/ui/src/lib/gql/create-client.ts @@ -5,6 +5,9 @@ * * Browser clients also expose `subscribe` so WebSocket auth/URL match HTTP — * no separate `authFromPageData` at call sites. + * + * Optional `cache`: query/subscription write-through (never treats mutations as + * projected list truth — command pipeline owns command result apply). */ import type { TypedDocumentNode } from '@graphql-typed-document-node/core'; import { @@ -12,12 +15,19 @@ import { type GqlWsHandlers } from '$lib/graphql-ws'; import { requestGraphql, type GqlDocument } from './request.ts'; +import { documentToString } from './document.ts'; import type { GqlAuth, GqlResult } from './types.ts'; +import type { QueryCache } from './cache/query-cache.ts'; +import { cacheKey } from './cache/query-cache.ts'; export type GraphqlClientOptions = { /** Absolute API URL or same-origin path, e.g. `/graphql` or `http://127.0.0.1:8791/graphql` */ getUrl: () => string; getAuth: () => GqlAuth | Promise; + /** Browser query/subscription cache (optional). */ + cache?: QueryCache; + /** When true (default if cache set), write query results into the cache. */ + writeThrough?: boolean; }; export type GraphqlClient = { @@ -31,12 +41,23 @@ export type GraphqlClient = { /** * Live subscription over `/graphql/ws` using the same auth as `request`. * Returns an unsubscribe function (safe to call before the socket opens). + * When a cache is configured, successful payloads write-through by document key. */ subscribe: (document: GqlDocument, handlers: GqlWsHandlers) => () => void; + /** Shared query cache when configured on the client. */ + cache?: QueryCache; }; +function looksLikeMutation(document: GqlDocument | TypedDocumentNode): boolean { + const src = documentToString(document as GqlDocument).trimStart(); + return /^mutation[\s({]/i.test(src); +} + export function createGraphqlClient(opts: GraphqlClientOptions): GraphqlClient { - return { + const writeThrough = opts.writeThrough ?? !!opts.cache; + + const client: GraphqlClient = { + cache: opts.cache, async request< TResult = Record, TVariables extends Record = Record @@ -45,20 +66,61 @@ export function createGraphqlClient(opts: GraphqlClientOptions): GraphqlClient { variables?: TVariables ): Promise> { const auth = await opts.getAuth(); - return requestGraphql( + const result = await requestGraphql( opts.getUrl(), - document, + document as GqlDocument, auth, (variables ?? {}) as TVariables ); + // Query write-through only — mutations go through the command pipeline. + if ( + opts.cache && + writeThrough && + result.data && + !result.errors?.length && + !looksLikeMutation(document) + ) { + const key = cacheKey( + documentToString(document as GqlDocument), + (variables ?? {}) as Record + ); + opts.cache.set(key, { + data: result.data, + updatedAt: Date.now(), + optimistic: false, + pending: false + }); + } + return result; }, subscribe(document, handlers) { let unsub = () => {}; let cancelled = false; + const wrapped: GqlWsHandlers = { + ...handlers, + onNext: (payload) => { + if (opts.cache && writeThrough && payload && typeof payload === 'object') { + const p = payload as { + data?: unknown; + errors?: unknown[]; + }; + if (p.data && !p.errors?.length) { + const key = cacheKey(documentToString(document), {}); + opts.cache.set(key, { + data: p.data, + updatedAt: Date.now(), + optimistic: false, + pending: false + }); + } + } + handlers.onNext?.(payload); + } + }; void (async () => { const auth = await opts.getAuth(); if (cancelled) return; - unsub = subscribeWs(document, auth, handlers, { + unsub = subscribeWs(document, auth, wrapped, { httpUrl: opts.getUrl() }); })(); @@ -68,4 +130,5 @@ export function createGraphqlClient(opts: GraphqlClientOptions): GraphqlClient { }; } }; + return client; } diff --git a/tests/e2e-ui/ui/src/lib/gql/index.ts b/tests/e2e-ui/ui/src/lib/gql/index.ts index c0b941da..7f7032f6 100644 --- a/tests/e2e-ui/ui/src/lib/gql/index.ts +++ b/tests/e2e-ui/ui/src/lib/gql/index.ts @@ -16,11 +16,17 @@ export type { GraphqlClient, GraphqlClientOptions } from './create-client.ts'; export { defineResource } from './define-resource.ts'; export type { DefineResourceInput, GraphqlResource } from './define-resource.ts'; export { useGraphql, authFromPageData } from './use-graphql.ts'; -export type { AppGraphqlClient, PageGraphqlData } from './use-graphql.ts'; +export type { AppGraphqlClient, PageGraphqlData, UseGraphqlOptions } from './use-graphql.ts'; export { browserGraphql } from './client.ts'; // Re-export command binders for non-useGraphql call sites (tests, SSR factories). export { bindCommands } from '$lib/api/commands.generated'; export type { BoundCommands, CommandClient } from '$lib/api/commands.generated'; +export { bindCommandsPipeline } from './bind-commands-pipeline.ts'; +export type { + PipelinedBoundCommands, + CommandCallOptions, + CommandPolicyMap +} from './bind-commands-pipeline.ts'; /** Browser query cache + command result pipeline (ack/fact/projection). */ export { @@ -40,3 +46,9 @@ export type { ReconcileKind, CommandPipelineOptions } from './cache/index.ts'; +export { + seedQueryCache, + readQueryList, + queryDocString, + listTarget +} from './cache-helpers.ts'; diff --git a/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts b/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts index 7a60a3a1..3ba441a6 100644 --- a/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts +++ b/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts @@ -1,17 +1,34 @@ /** * Browser binder: page data → GqlAuth + createGraphqlClient (POST /graphql). - * Attaches generated command helpers as `client.commands.*`. + * Attaches generated command helpers as `client.commands.*` through the + * command result pipeline when a browser QueryCache is available. */ -import { bindCommands, type BoundCommands } from '$lib/api/commands.generated'; import { createGraphqlClient, type GraphqlClient } from './create-client.ts'; import { authFromPageData, type PageGraphqlData } from './auth-from-page.ts'; +import { + bindCommandsPipeline, + type CommandPolicyMap, + type PipelinedBoundCommands +} from './bind-commands-pipeline.ts'; +import { QueryCache } from './cache/query-cache.ts'; +import type { Effect } from './cache/ops.ts'; export type { PageGraphqlData } from './auth-from-page.ts'; export { authFromPageData } from './auth-from-page.ts'; -/** Bound HTTP + WS client with pre-registered command functions. */ +/** Bound HTTP + WS client with pipelined command functions + shared cache. */ export type AppGraphqlClient = GraphqlClient & { - commands: BoundCommands; + commands: PipelinedBoundCommands; + cache: QueryCache; +}; + +export type UseGraphqlOptions = { + /** Override / seed the shared browser cache (default: new QueryCache). */ + cache?: QueryCache; + /** Per-command default result/reconcile policies. */ + policies?: CommandPolicyMap; + /** Optional UI effect handler (toast/alert). */ + runEffects?: (effects: Effect[]) => void; }; /** @@ -20,16 +37,30 @@ export type AppGraphqlClient = GraphqlClient & { * * @example * const gql = useGraphql(() => data); - * await gql.commands.todosCreate({ todo_id, title }); + * await gql.commands.todosCreate( + * { todo_id, title }, + * { optimistic: { targets: [...], row }, result: { kind: 'fact' }, reconcile: { kind: 'refetch', document } } + * ); * gql.subscribe(chat.subscription, { onNext }); */ -export function useGraphql(getData: () => PageGraphqlData): AppGraphqlClient { +export function useGraphql( + getData: () => PageGraphqlData, + options: UseGraphqlOptions = {} +): AppGraphqlClient { + const cache = options.cache ?? new QueryCache(); const client = createGraphqlClient({ getUrl: () => '/graphql', - getAuth: () => authFromPageData(getData()) + getAuth: () => authFromPageData(getData()), + cache, + writeThrough: true }); return { ...client, - commands: bindCommands(client) + cache, + commands: bindCommandsPipeline(client, { + cache, + policies: options.policies, + runEffects: options.runEffects + }) }; } diff --git a/tests/e2e-ui/ui/src/routes/admin/+page.svelte b/tests/e2e-ui/ui/src/routes/admin/+page.svelte index c059eac0..6e4de184 100644 --- a/tests/e2e-ui/ui/src/routes/admin/+page.svelte +++ b/tests/e2e-ui/ui/src/routes/admin/+page.svelte @@ -1,9 +1,16 @@ diff --git a/tests/e2e-ui/ui/src/routes/chat/+page.svelte b/tests/e2e-ui/ui/src/routes/chat/+page.svelte index daa3d47e..1b2ee7e2 100644 --- a/tests/e2e-ui/ui/src/routes/chat/+page.svelte +++ b/tests/e2e-ui/ui/src/routes/chat/+page.svelte @@ -1,11 +1,18 @@ @@ -144,8 +185,9 @@

Co-located chat.resource: SSR seed + live - graphql-transport-ws (Bearer in connection_init) + - POST /graphql posts. Signed in as {displayName}. + gql.subscribe (cache write-through) + + gql.commands.chatMessagesPost pipeline. Signed in as + {displayName}.

diff --git a/tests/e2e-ui/ui/src/routes/todos/+page.svelte b/tests/e2e-ui/ui/src/routes/todos/+page.svelte index adae9637..a4e01a83 100644 --- a/tests/e2e-ui/ui/src/routes/todos/+page.svelte +++ b/tests/e2e-ui/ui/src/routes/todos/+page.svelte @@ -1,12 +1,13 @@ @@ -190,8 +186,9 @@

Field notes

Tasks for {who}. Co-located - todos.resource query + mutations on SSR and in the browser - (POST /graphql). + todos.resource query + gql.commands.* pipeline + (optimistic → fact/ack → refetch). Async projectors; list truth lives in the + browser QueryCache.

diff --git a/tests/e2e-ui/ui/tests/api-contract.test.mjs b/tests/e2e-ui/ui/tests/api-contract.test.mjs index f919a4c3..493df318 100644 --- a/tests/e2e-ui/ui/tests/api-contract.test.mjs +++ b/tests/e2e-ui/ui/tests/api-contract.test.mjs @@ -102,9 +102,10 @@ test('admin: role-gated all-owners todos view + force-archive mutation', () => { new URL('../../crates/service/src/service.rs', import.meta.url), 'utf8' ); - assert.match(service, /role\("admin"/); + // Admin grant uses grant/read API (not legacy role("admin")). + assert.match(service, /grant\("admin"|role\("admin"/); assert.match(service, /todos_force_archive|force_archive/); - assert.match(service, /\.roles\(\[\"admin\"\]\)|roles\(\[\"admin\"\]\)/); + assert.match(service, /\.roles\(\[\"admin\"\]\)|roles\(\[\"admin\"\]\)|roles\(\["admin"\]\)/); assert.match(service, /owner_id|claim\("x-user-id"\)/); assert.match(service, /graphiql_enabled|GRAPHIQL/); const force = fs.readFileSync( @@ -184,7 +185,7 @@ test('home is distributed template with 8-step unidirectional todos story', () = assert.match(home, /accessToken|Auth\.js|OIDC|Zitadel/i); assert.match(home, /Bearer|serverGraphql|authorization/i); assert.match(home, /ModelPermissions|owner_id|claim\("x-user-id"\)|OidcBearer/); - assert.match(home, /data\.todos|hydration|mergeFromServer/i); + assert.match(home, /data\.todos|hydration|QueryCache|optimistic/i); assert.match(home, /subscription|connection_init/); assert.match(home, /anti-pattern|todos_create|todo\.create/i); assert.match(home, /require_user|outbox|TodoFact|todo\.created/); @@ -259,17 +260,21 @@ test('todos: co-located .gql + resource — same query SSR + browser mutations', const page = fs.readFileSync(new URL('../src/routes/todos/+page.svelte', import.meta.url), 'utf8'); assert.match(page, /\$state\(\[\.\.\.\(data\.todos/); - assert.match(page, /mergeFromServer/); + // Command pipeline + QueryCache (not hand-rolled mergeFromServer) + assert.match(page, /seedQueryCache|gql\.cache|QueryCache/); + assert.match(page, /optimistic:/); + assert.match(page, /result:\s*\{\s*kind:\s*'fact'/); + assert.match(page, /reconcile:\s*\{\s*kind:\s*'refetch'/); + assert.doesNotMatch(page, /function mergeFromServer/); assert.match(page, /useGraphql/); assert.match(page, /todos\.resource|todosResource|from '\.\/todos\.resource'/); assert.match(page, /todosResource\.query|todos\.query/); - // Writes: generated command functions (GraphQL wire under the hood). + // Writes: generated command functions through pipeline. assert.match(page, /gql\.commands\.todosCreate/); assert.match(page, /gql\.commands\.todosComplete/); assert.match(page, /gql\.commands\.todosArchive/); assert.doesNotMatch(page, /mutations\.(create|complete|archive)/); assert.doesNotMatch(page, /use:enhance|\?\/create|export const actions/); - // Query refetch still uses GraphQL client; writes use command client assert.match(page, /useGraphql|gql\.request|todosCreate/); const server = fs.readFileSync( @@ -415,10 +420,11 @@ test('live GraphQL unauthenticated rejected when OIDC stack', { skip: !base }, a } }); -test('useGraphql attaches bindCommands as client.commands', () => { +test('useGraphql attaches bindCommandsPipeline as client.commands', () => { const use = fs.readFileSync(new URL('../src/lib/gql/use-graphql.ts', import.meta.url), 'utf8'); - assert.match(use, /bindCommands/); - assert.match(use, /commands:\s*bindCommands/); + assert.match(use, /bindCommandsPipeline/); + assert.match(use, /commands:\s*bindCommandsPipeline/); + assert.match(use, /QueryCache/); assert.match(use, /AppGraphqlClient/); }); diff --git a/tests/e2e-ui/ui/tests/command-client.test.mjs b/tests/e2e-ui/ui/tests/command-client.test.mjs index 7158d61a..99b284f5 100644 --- a/tests/e2e-ui/ui/tests/command-client.test.mjs +++ b/tests/e2e-ui/ui/tests/command-client.test.mjs @@ -91,20 +91,32 @@ test('generated todosCreate uses client.request + COMMAND_DOCS', async () => { assert.match(r.stdout, /command-client-ok/); }); -test('app pages use gql.commands.* (pre-bound on useGraphql client)', () => { +test('app pages use gql.commands.* pipeline (optimistic + fact/ack + reconcile)', () => { const todos = fs.readFileSync(pageSvelte, 'utf8'); assert.match(todos, /gql\.commands\.todosCreate/); assert.match(todos, /gql\.commands\.todosComplete/); assert.match(todos, /gql\.commands\.todosArchive/); + assert.match(todos, /result:\s*\{\s*kind:\s*'fact'/); + assert.match(todos, /reconcile:\s*\{\s*kind:\s*'refetch'/); + assert.match(todos, /optimistic:/); + assert.match(todos, /QueryCache|gql\.cache|seedQueryCache/); assert.doesNotMatch(todos, /from '\$lib\/api\/commands\.generated'/); assert.doesNotMatch(todos, /url:\s*['"]\/graphql['"]/); + // No hand-rolled pending map / mergeFromServer — pipeline owns latency compensation + assert.doesNotMatch(todos, /function mergeFromServer/); + assert.doesNotMatch(todos, /let pending = \$state/); const chat = fs.readFileSync(path.join(uiRoot, 'src/routes/chat/+page.svelte'), 'utf8'); assert.match(chat, /gql\.commands\.chatMessagesPost/); + assert.match(chat, /optimistic:/); + assert.match(chat, /result:\s*\{\s*kind:\s*'fact'/); + assert.match(chat, /reconcile:\s*\{\s*kind:\s*'subscription'/); assert.doesNotMatch(chat, /from '\$lib\/api\/commands\.generated'/); const admin = fs.readFileSync(path.join(uiRoot, 'src/routes/admin/+page.svelte'), 'utf8'); assert.match(admin, /gql\.commands\.todosForceArchive/); + assert.match(admin, /optimistic:/); + assert.match(admin, /reconcile:\s*\{\s*kind:\s*'refetch'/); assert.doesNotMatch(admin, /from '\$lib\/api\/commands\.generated'/); }); diff --git a/tests/e2e-ui/ui/tests/page-pipeline.test.mjs b/tests/e2e-ui/ui/tests/page-pipeline.test.mjs new file mode 100644 index 00000000..8d924e68 --- /dev/null +++ b/tests/e2e-ui/ui/tests/page-pipeline.test.mjs @@ -0,0 +1,133 @@ +/** + * Pages use the real command pipeline binder (cache + optimistic + fact/ack). + * Drives bindCommandsPipeline + QueryCache — not page-local merge helpers. + */ +import { test } from 'node:test'; +import assert from 'node:assert/strict'; +import path from 'node:path'; +import { fileURLToPath, pathToFileURL } from 'node:url'; +import { spawnSync } from 'node:child_process'; + +const uiRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..'); + +test('bindCommandsPipeline: optimistic create + rollback on error', () => { + const script = ` + import { QueryCache, cacheKey } from ${JSON.stringify( + pathToFileURL(path.join(uiRoot, 'src/lib/gql/cache/query-cache.ts')).href + )}; + import { bindCommandsPipeline } from ${JSON.stringify( + pathToFileURL(path.join(uiRoot, 'src/lib/gql/bind-commands-pipeline.ts')).href + )}; + import { COMMAND_DOCS } from ${JSON.stringify( + pathToFileURL(path.join(uiRoot, 'src/lib/api/commands.generated.ts')).href + )}; + + const TODOS = 'query Todos { todos { todo_id title status owner_id } }'; + const cache = new QueryCache(); + const key = cacheKey(TODOS, {}); + cache.set(key, { data: { todos: [] }, updatedAt: 1 }); + + let calls = 0; + const client = { + async request(document, variables) { + calls += 1; + if (String(document).includes('todos_create')) { + return { data: null, errors: [{ message: 'nope' }], status: 200 }; + } + return { data: { todos: [] }, status: 200 }; + } + }; + + const commands = bindCommandsPipeline(client, { cache }); + const r = await commands.todosCreate( + { todo_id: 't1', title: 'x' }, + { + // Node unit tests have no window — force browser pipeline path. + browser: true, + result: { kind: 'fact' }, + reconcile: { kind: 'none' }, + optimistic: { + targets: [{ document: TODOS, at: 'todos', by: 'todo_id' }], + row: { todo_id: 't1', title: 'x', status: 'open', owner_id: 'me' } + } + } + ); + if (!r.errors?.length) throw new Error('expected errors'); + const todos = cache.get(key)?.data?.todos ?? []; + if (todos.length !== 0) throw new Error('expected rollback, got ' + todos.length); + if (calls !== 1) throw new Error('expected 1 network call, got ' + calls); + if (!COMMAND_DOCS.todos_create) throw new Error('missing COMMAND_DOCS'); + console.log('page-pipeline-ok'); + `; + + const r = spawnSync( + process.execPath, + ['--experimental-strip-types', '--input-type=module', '-e', script], + { encoding: 'utf8', cwd: uiRoot } + ); + assert.equal(r.status, 0, `stderr=${r.stderr}\nstdout=${r.stdout}`); + assert.match(r.stdout, /page-pipeline-ok/); +}); + +test('bindCommandsPipeline: fact success keeps optimistic without inventing second row from empty list invent', () => { + const script = ` + import { QueryCache, cacheKey } from ${JSON.stringify( + pathToFileURL(path.join(uiRoot, 'src/lib/gql/cache/query-cache.ts')).href + )}; + import { bindCommandsPipeline } from ${JSON.stringify( + pathToFileURL(path.join(uiRoot, 'src/lib/gql/bind-commands-pipeline.ts')).href + )}; + + const TODOS = 'query Todos { todos { todo_id title status owner_id } }'; + const cache = new QueryCache(); + const key = cacheKey(TODOS, {}); + cache.set(key, { data: { todos: [] }, updatedAt: 1 }); + + let calls = 0; + const client = { + async request(document, variables) { + calls += 1; + if (String(document).includes('mutation')) { + return { + data: { todos_create: { todo_id: 't1', owner_id: 'a', title: 'x', status: 'open' } }, + status: 200 + }; + } + // refetch reconcile + return { + data: { + todos: [{ todo_id: 't1', owner_id: 'a', title: 'x', status: 'open' }] + }, + status: 200 + }; + } + }; + + const commands = bindCommandsPipeline(client, { cache }); + const r = await commands.todosCreate( + { todo_id: 't1', title: 'x' }, + { + browser: true, + result: { kind: 'fact' }, + reconcile: { kind: 'refetch', document: TODOS }, + optimistic: { + targets: [{ document: TODOS, at: 'todos', by: 'todo_id' }], + row: { todo_id: 't1', title: 'x', status: 'open', owner_id: 'a' } + } + } + ); + if (!r.data || r.data.todo_id !== 't1') throw new Error('unwrap failed'); + const todos = cache.get(key)?.data?.todos ?? []; + if (todos.length !== 1) throw new Error('expected 1 row after reconcile, got ' + todos.length); + if (calls < 2) throw new Error('expected command + refetch, got ' + calls); + console.log('page-pipeline-refetch-ok'); + `; + + const r = spawnSync( + process.execPath, + ['--experimental-strip-types', '--input-type=module', '-e', script], + { encoding: 'utf8', cwd: uiRoot } + ); + assert.equal(r.status, 0, `stderr=${r.stderr}\nstdout=${r.stdout}`); + assert.match(r.stdout, /page-pipeline-refetch-ok/); +}); From f8f1e6003d4fb29c34b6226959806594894cf59e Mon Sep 17 00:00:00 2001 From: Patrick Lee Scott Date: Thu, 16 Jul 2026 18:10:47 -0500 Subject: [PATCH 03/20] =?UTF-8?q?refactor(e2e-ui):=20Houdini-style=20gql.s?= =?UTF-8?q?tore/live=20=E2=80=94=20cache=20is=20transparent?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Pages no longer seed/subscribe/sync QueryCache by hand. Document stores auto-seed from SSR, follow cache notifications, and (live) open subscriptions. UI reads \$store.data / \$store.status; commands still attach optimistic targets via store.target(). --- tests/e2e-ui/ui/src/lib/gql/document-store.ts | 258 ++++++++++++++++++ tests/e2e-ui/ui/src/lib/gql/index.ts | 11 + tests/e2e-ui/ui/src/lib/gql/use-graphql.ts | 72 ++++- tests/e2e-ui/ui/src/routes/admin/+page.svelte | 56 ++-- tests/e2e-ui/ui/src/routes/chat/+page.svelte | 132 +++------ tests/e2e-ui/ui/src/routes/todos/+page.svelte | 72 ++--- tests/e2e-ui/ui/tests/api-contract.test.mjs | 21 +- tests/e2e-ui/ui/tests/command-client.test.mjs | 28 +- tests/e2e-ui/ui/tests/document-store.test.mjs | 79 ++++++ 9 files changed, 524 insertions(+), 205 deletions(-) create mode 100644 tests/e2e-ui/ui/src/lib/gql/document-store.ts create mode 100644 tests/e2e-ui/ui/tests/document-store.test.mjs diff --git a/tests/e2e-ui/ui/src/lib/gql/document-store.ts b/tests/e2e-ui/ui/src/lib/gql/document-store.ts new file mode 100644 index 00000000..606e7389 --- /dev/null +++ b/tests/e2e-ui/ui/src/lib/gql/document-store.ts @@ -0,0 +1,258 @@ +/** + * Houdini-inspired document store: the cache is transparent. + * + * App code does **not** seed/subscribe/sync the QueryCache by hand. + * A store: + * 1. Seeds the shared cache from SSR / initial data + * 2. Subscribes to that cache key (optimistic + refetch + live writes update UI) + * 3. Optionally opens a GraphQL subscription (write-through already in createClient) + * + * Usage (Svelte — `$` auto-subscribes to the store contract): + * + * const lobby = gql.live({ + * document: chat.subscription ?? chat.query, + * initialData: { chat_messages: data.messages }, + * select: (d) => sortChatMessages(d.chat_messages ?? []), + * }); + * // {$lobby.data} {$lobby.status} + * + * await gql.commands.chatMessagesPost(input, { + * result: { kind: 'fact' }, + * reconcile: { kind: 'subscription', document: lobby.document }, + * optimistic: { targets: [lobby.target('chat_messages', 'message_id')], row }, + * }); + */ + +import type { GqlDocument } from './document.ts'; +import { documentToString } from './document.ts'; +import type { QueryCache } from './cache/query-cache.ts'; +import { cacheKey } from './cache/query-cache.ts'; +import type { CacheTarget } from './cache/ops.ts'; +import type { GraphqlClient } from './create-client.ts'; + +export type StoreStatus = 'idle' | 'connecting' | 'live' | 'error'; + +export type DocumentStoreSnapshot = { + /** Selected view of the cached document data. */ + data: TSelected; + /** Full document payload in cache (before select). */ + raw: unknown; + status: StoreStatus; + error: string | null; + pending: boolean; + optimistic: boolean; +}; + +export type DocumentStoreOptions, TSelected = TData> = { + /** Query or subscription document (same selection set preferred). */ + document: GqlDocument; + variables?: Record; + /** SSR / first-paint payload written into the cache. */ + initialData?: TData; + /** Map cached document → UI shape (e.g. list extract + sort). */ + select?: (data: TData) => TSelected; + /** + * When true, open a live GraphQL subscription for `document`. + * Cache write-through is automatic; UI follows the cache. + */ + live?: boolean; +}; + +export type DocumentStore = { + /** Svelte store contract — use as `{$store.data}`. */ + subscribe: (run: (value: DocumentStoreSnapshot) => void) => () => void; + /** Current snapshot (non-reactive outside Svelte). */ + get: () => DocumentStoreSnapshot; + /** GraphQL source string (for command reconcile / policies). */ + readonly document: string; + readonly variables: Record | undefined; + /** Cache target for optimistic list upserts. */ + target: (at: string, by: string) => CacheTarget; + /** Replace SSR seed / external server data without dropping optimistic if newer. */ + seed: (data: unknown) => void; + /** Force HTTP refetch of the same document (write-through updates cache → UI). */ + refetch: () => Promise; + /** (Re)connect live subscription. */ + connect: () => void; + /** Tear down cache listener + WS. Call from onDestroy. */ + destroy: () => void; +}; + +function identity(x: T): T { + return x; +} + +/** + * Create a document-keyed store bound to a client + its QueryCache. + * Prefer `gql.store` / `gql.live` from `useGraphql`. + */ +export function createDocumentStore, TSelected = TData>( + client: GraphqlClient, + options: DocumentStoreOptions +): DocumentStore { + const cache = client.cache; + if (!cache) { + throw new Error('createDocumentStore requires a GraphqlClient with cache'); + } + + const docStr = documentToString(options.document); + const variables = options.variables; + const key = cacheKey(docStr, variables); + const select = (options.select ?? identity) as (data: TData) => TSelected; + + const listeners = new Set<(v: DocumentStoreSnapshot) => void>(); + let status: StoreStatus = options.live ? 'connecting' : 'idle'; + let error: string | null = null; + let unsubCache: (() => void) | null = null; + let unsubWs: (() => void) | null = null; + let destroyed = false; + + function readRaw(): unknown { + return cache.get(key)?.data; + } + + function snapshot(): DocumentStoreSnapshot { + const entry = cache.get(key); + const raw = (entry?.data ?? options.initialData ?? null) as TData; + let data: TSelected; + try { + data = select(raw as TData); + } catch { + data = select((options.initialData ?? {}) as TData); + } + return { + data, + raw: entry?.data, + status, + error, + pending: !!entry?.pending, + optimistic: !!entry?.optimistic + }; + } + + function emit() { + const snap = snapshot(); + for (const run of listeners) run(snap); + } + + function seed(data: unknown) { + if (destroyed) return; + // Don't clobber a fresher optimistic/pending entry with older SSR. + const existing = cache.get(key); + if (existing?.optimistic || existing?.pending) { + emit(); + return; + } + cache.set(key, { + data, + updatedAt: Date.now(), + optimistic: false, + pending: false + }); + } + + // Initial seed + if (options.initialData !== undefined) { + seed(options.initialData); + } + + unsubCache = cache.subscribe(key, () => emit()); + + function connect() { + if (destroyed || !options.live) return; + unsubWs?.(); + status = 'connecting'; + error = null; + emit(); + unsubWs = client.subscribe(options.document, { + onNext: (payload) => { + const p = payload as { data?: unknown; errors?: Array<{ message?: string }> }; + if (p?.errors?.length) { + status = 'error'; + error = p.errors[0]?.message ?? 'subscription error'; + emit(); + return; + } + // createClient already write-throughs data into cache; just mark live. + if (p?.data !== undefined) { + status = 'live'; + error = null; + // Ensure write-through even if client was built without cache (defensive) + if (!cache.get(key)?.data && p.data) { + cache.set(key, { + data: p.data, + updatedAt: Date.now(), + optimistic: false, + pending: false + }); + } else { + emit(); + } + } + }, + onError: (e) => { + status = 'error'; + if (e instanceof Event) { + error = 'WebSocket error — is the API running?'; + } else if (Array.isArray(e)) { + error = JSON.stringify(e); + } else { + error = String(e); + } + emit(); + }, + onComplete: () => { + if (status === 'live') { + status = 'connecting'; + emit(); + } + } + }); + } + + if (options.live && typeof window !== 'undefined') { + // Defer to next microtask so callers can attach subscribe first. + queueMicrotask(() => { + if (!destroyed) connect(); + }); + } + + async function refetch() { + const result = await client.request(options.document, variables as never); + if (result.errors?.length) { + error = result.errors[0]?.message ?? 'refetch failed'; + emit(); + return; + } + // request write-through updates cache; emit if needed + error = null; + emit(); + } + + return { + subscribe(run) { + listeners.add(run); + run(snapshot()); + return () => { + listeners.delete(run); + }; + }, + get: snapshot, + document: docStr, + variables, + target(at: string, by: string): CacheTarget { + return { document: docStr, variables, at, by }; + }, + seed, + refetch, + connect, + destroy() { + destroyed = true; + unsubCache?.(); + unsubCache = null; + unsubWs?.(); + unsubWs = null; + listeners.clear(); + } + }; +} diff --git a/tests/e2e-ui/ui/src/lib/gql/index.ts b/tests/e2e-ui/ui/src/lib/gql/index.ts index 7f7032f6..1e12ec39 100644 --- a/tests/e2e-ui/ui/src/lib/gql/index.ts +++ b/tests/e2e-ui/ui/src/lib/gql/index.ts @@ -46,6 +46,17 @@ export type { ReconcileKind, CommandPipelineOptions } from './cache/index.ts'; + +/** Houdini-style document store (prefer over manual cache helpers). */ +export { createDocumentStore } from './document-store.ts'; +export type { + DocumentStore, + DocumentStoreOptions, + DocumentStoreSnapshot, + StoreStatus +} from './document-store.ts'; + +/** Escape-hatch cache helpers — prefer `gql.store` / `gql.live`. */ export { seedQueryCache, readQueryList, diff --git a/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts b/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts index 3ba441a6..d5db71ad 100644 --- a/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts +++ b/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts @@ -1,7 +1,12 @@ /** * Browser binder: page data → GqlAuth + createGraphqlClient (POST /graphql). - * Attaches generated command helpers as `client.commands.*` through the - * command result pipeline when a browser QueryCache is available. + * + * Cache is **transparent** (Houdini-style): + * - `gql.store` / `gql.live` seed + follow the QueryCache automatically + * - `request` / `subscribe` write-through into the cache + * - `gql.commands.*` pipeline patches the same cache keys + * + * Pages should not call seedQueryCache / cache.subscribe by hand. */ import { createGraphqlClient, type GraphqlClient } from './create-client.ts'; import { authFromPageData, type PageGraphqlData } from './auth-from-page.ts'; @@ -12,18 +17,38 @@ import { } from './bind-commands-pipeline.ts'; import { QueryCache } from './cache/query-cache.ts'; import type { Effect } from './cache/ops.ts'; +import { + createDocumentStore, + type DocumentStore, + type DocumentStoreOptions +} from './document-store.ts'; export type { PageGraphqlData } from './auth-from-page.ts'; export { authFromPageData } from './auth-from-page.ts'; -/** Bound HTTP + WS client with pipelined command functions + shared cache. */ +/** Bound HTTP + WS client with pipelined commands + document stores. */ export type AppGraphqlClient = GraphqlClient & { commands: PipelinedBoundCommands; + /** Shared browser query cache (escape hatch; prefer store/live). */ cache: QueryCache; + /** + * Follow a query document in the cache (SSR seed + refetch/optimistic updates). + * Use `$store.data` in templates. + */ + store: , TSelected = TData>( + options: DocumentStoreOptions + ) => DocumentStore; + /** + * Like `store` + automatic GraphQL subscription for the same document. + * Connection status is on `$store.status`. + */ + live: , TSelected = TData>( + options: Omit, 'live'> + ) => DocumentStore; }; export type UseGraphqlOptions = { - /** Override / seed the shared browser cache (default: new QueryCache). */ + /** Override the shared browser cache (default: new QueryCache). */ cache?: QueryCache; /** Per-command default result/reconcile policies. */ policies?: CommandPolicyMap; @@ -32,16 +57,24 @@ export type UseGraphqlOptions = { }; /** - * Client bound to same-origin `/graphql` (Vite proxies to the API in dev). - * Pass a getter so reactive page data is read on each request / subscribe. + * Client bound to same-origin `/graphql`. * - * @example + * @example Chat (cache transparent) * const gql = useGraphql(() => data); - * await gql.commands.todosCreate( - * { todo_id, title }, - * { optimistic: { targets: [...], row }, result: { kind: 'fact' }, reconcile: { kind: 'refetch', document } } - * ); - * gql.subscribe(chat.subscription, { onNext }); + * const lobby = gql.live({ + * document: chat.subscription ?? chat.query, + * initialData: { chat_messages: data.messages }, + * select: (d) => d.chat_messages ?? [], + * }); + * // {$lobby.data} {$lobby.status} + * onDestroy(() => lobby.destroy()); + * + * @example Command with optimistic list patch + * await gql.commands.todosCreate(input, { + * result: { kind: 'fact' }, + * reconcile: { kind: 'refetch', document: list.document }, + * optimistic: { targets: [list.target('todos', 'todo_id')], row }, + * }); */ export function useGraphql( getData: () => PageGraphqlData, @@ -54,9 +87,24 @@ export function useGraphql( cache, writeThrough: true }); + + function store, TSelected = TData>( + storeOpts: DocumentStoreOptions + ): DocumentStore { + return createDocumentStore(client, storeOpts); + } + + function live, TSelected = TData>( + storeOpts: Omit, 'live'> + ): DocumentStore { + return createDocumentStore(client, { ...storeOpts, live: true }); + } + return { ...client, cache, + store, + live, commands: bindCommandsPipeline(client, { cache, policies: options.policies, diff --git a/tests/e2e-ui/ui/src/routes/admin/+page.svelte b/tests/e2e-ui/ui/src/routes/admin/+page.svelte index 6e4de184..97a65eca 100644 --- a/tests/e2e-ui/ui/src/routes/admin/+page.svelte +++ b/tests/e2e-ui/ui/src/routes/admin/+page.svelte @@ -1,31 +1,20 @@ @@ -119,7 +105,7 @@
- {todos.length} + {$list.data.length} notes
@@ -139,7 +125,7 @@

{/if} - {#if todos.length === 0} + {#if $list.data.length === 0}

No notes in the read model yet. Create some as alice/bob on /todos.

{:else}
@@ -154,7 +140,7 @@ - {#each todos as t (t.todo_id)} + {#each $list.data as t (t.todo_id)} {t.owner_id} {t.title} diff --git a/tests/e2e-ui/ui/src/routes/chat/+page.svelte b/tests/e2e-ui/ui/src/routes/chat/+page.svelte index 1b2ee7e2..3d5d4485 100644 --- a/tests/e2e-ui/ui/src/routes/chat/+page.svelte +++ b/tests/e2e-ui/ui/src/routes/chat/+page.svelte @@ -1,29 +1,17 @@ @@ -185,10 +174,9 @@

Field notes

- Tasks for {who}. Co-located - todos.resource query + gql.commands.* pipeline - (optimistic → fact/ack → refetch). Async projectors; list truth lives in the - browser QueryCache. + Tasks for {who}. List via gql.store + ($list.data); writes via gql.commands.* pipeline + (optimistic → fact → refetch). Cache is transparent — no manual seed/sync.

diff --git a/tests/e2e-ui/ui/tests/api-contract.test.mjs b/tests/e2e-ui/ui/tests/api-contract.test.mjs index 493df318..d84d9bc7 100644 --- a/tests/e2e-ui/ui/tests/api-contract.test.mjs +++ b/tests/e2e-ui/ui/tests/api-contract.test.mjs @@ -259,23 +259,22 @@ test('todos: co-located .gql + resource — same query SSR + browser mutations', assert.match(useGql, /createGraphqlClient|\/graphql/); const page = fs.readFileSync(new URL('../src/routes/todos/+page.svelte', import.meta.url), 'utf8'); - assert.match(page, /\$state\(\[\.\.\.\(data\.todos/); - // Command pipeline + QueryCache (not hand-rolled mergeFromServer) - assert.match(page, /seedQueryCache|gql\.cache|QueryCache/); + // Document store (Houdini-style) — cache transparent + assert.match(page, /gql\.store\s*\(/); + assert.match(page, /\$list\.data/); assert.match(page, /optimistic:/); assert.match(page, /result:\s*\{\s*kind:\s*'fact'/); assert.match(page, /reconcile:\s*\{\s*kind:\s*'refetch'/); - assert.doesNotMatch(page, /function mergeFromServer/); + assert.doesNotMatch(page, /function mergeFromServer|seedQueryCache|readQueryList/); assert.match(page, /useGraphql/); assert.match(page, /todos\.resource|todosResource|from '\.\/todos\.resource'/); assert.match(page, /todosResource\.query|todos\.query/); - // Writes: generated command functions through pipeline. assert.match(page, /gql\.commands\.todosCreate/); assert.match(page, /gql\.commands\.todosComplete/); assert.match(page, /gql\.commands\.todosArchive/); assert.doesNotMatch(page, /mutations\.(create|complete|archive)/); assert.doesNotMatch(page, /use:enhance|\?\/create|export const actions/); - assert.match(page, /useGraphql|gql\.request|todosCreate/); + assert.match(page, /useGraphql|list\.refetch|todosCreate/); const server = fs.readFileSync( new URL('../src/routes/todos/+page.server.ts', import.meta.url), @@ -374,8 +373,10 @@ test('chat: co-located .gql + resource — SSR query, WS subscription, browser p assert.match(page, /useGraphql/); assert.doesNotMatch(page, /chat\.mutations\.post|mutations\.post/); assert.match(page, /chat\.subscription|subscription/); - // WS uses bound client — same auth as HTTP (no separate authFromPageData at call site). - assert.match(page, /gql\.subscribe\s*\(/); + // Live document store owns WS + cache (no raw gql.subscribe / authFromPageData). + assert.match(page, /gql\.live\s*\(/); + assert.match(page, /\$lobby\.(data|status)/); + assert.doesNotMatch(page, /gql\.subscribe\s*\(/); assert.doesNotMatch(page, /from '\$lib\/graphql-ws'/); assert.doesNotMatch(page, /authFromPageData/); assert.doesNotMatch(page, /browserGraphql|from '\$lib\/gql\/documents'/); @@ -420,11 +421,13 @@ test('live GraphQL unauthenticated rejected when OIDC stack', { skip: !base }, a } }); -test('useGraphql attaches bindCommandsPipeline as client.commands', () => { +test('useGraphql attaches pipeline commands + store/live helpers', () => { const use = fs.readFileSync(new URL('../src/lib/gql/use-graphql.ts', import.meta.url), 'utf8'); assert.match(use, /bindCommandsPipeline/); assert.match(use, /commands:\s*bindCommandsPipeline/); assert.match(use, /QueryCache/); + assert.match(use, /createDocumentStore|\.store\s*=|\bstore\b/); + assert.match(use, /\blive\b/); assert.match(use, /AppGraphqlClient/); }); diff --git a/tests/e2e-ui/ui/tests/command-client.test.mjs b/tests/e2e-ui/ui/tests/command-client.test.mjs index 99b284f5..efc6b502 100644 --- a/tests/e2e-ui/ui/tests/command-client.test.mjs +++ b/tests/e2e-ui/ui/tests/command-client.test.mjs @@ -91,33 +91,34 @@ test('generated todosCreate uses client.request + COMMAND_DOCS', async () => { assert.match(r.stdout, /command-client-ok/); }); -test('app pages use gql.commands.* pipeline (optimistic + fact/ack + reconcile)', () => { +test('app pages use gql.store/live + commands pipeline (cache transparent)', () => { const todos = fs.readFileSync(pageSvelte, 'utf8'); + assert.match(todos, /gql\.store\s*\(/); + assert.match(todos, /\$list\.data/); assert.match(todos, /gql\.commands\.todosCreate/); assert.match(todos, /gql\.commands\.todosComplete/); assert.match(todos, /gql\.commands\.todosArchive/); assert.match(todos, /result:\s*\{\s*kind:\s*'fact'/); assert.match(todos, /reconcile:\s*\{\s*kind:\s*'refetch'/); - assert.match(todos, /optimistic:/); - assert.match(todos, /QueryCache|gql\.cache|seedQueryCache/); + assert.match(todos, /list\.target\(/); + assert.doesNotMatch(todos, /seedQueryCache|readQueryList|syncFromCache/); assert.doesNotMatch(todos, /from '\$lib\/api\/commands\.generated'/); - assert.doesNotMatch(todos, /url:\s*['"]\/graphql['"]/); - // No hand-rolled pending map / mergeFromServer — pipeline owns latency compensation assert.doesNotMatch(todos, /function mergeFromServer/); - assert.doesNotMatch(todos, /let pending = \$state/); const chat = fs.readFileSync(path.join(uiRoot, 'src/routes/chat/+page.svelte'), 'utf8'); + assert.match(chat, /gql\.live\s*\(/); + assert.match(chat, /\$lobby\.(data|status)/); assert.match(chat, /gql\.commands\.chatMessagesPost/); - assert.match(chat, /optimistic:/); - assert.match(chat, /result:\s*\{\s*kind:\s*'fact'/); + assert.match(chat, /lobby\.target\(/); assert.match(chat, /reconcile:\s*\{\s*kind:\s*'subscription'/); + assert.doesNotMatch(chat, /seedQueryCache|gql\.subscribe\s*\(/); assert.doesNotMatch(chat, /from '\$lib\/api\/commands\.generated'/); const admin = fs.readFileSync(path.join(uiRoot, 'src/routes/admin/+page.svelte'), 'utf8'); + assert.match(admin, /gql\.store\s*\(/); assert.match(admin, /gql\.commands\.todosForceArchive/); - assert.match(admin, /optimistic:/); - assert.match(admin, /reconcile:\s*\{\s*kind:\s*'refetch'/); - assert.doesNotMatch(admin, /from '\$lib\/api\/commands\.generated'/); + assert.match(admin, /list\.target\(/); + assert.doesNotMatch(admin, /seedQueryCache|readQueryList/); }); test('generated mutations are multiline; operations.gql is copy-paste ready', () => { @@ -139,9 +140,10 @@ test('httpUrlToWsUrl maps HTTP GraphQL paths to /graphql/ws', async () => { assert.equal(httpUrlToWsUrl('https://api.example/graphql'), 'wss://api.example/graphql/ws'); }); -test('chat page uses gql.subscribe (bound client), not raw authFromPageData', () => { +test('chat page uses gql.live (not raw subscribe / authFromPageData)', () => { const chat = fs.readFileSync(path.join(uiRoot, 'src/routes/chat/+page.svelte'), 'utf8'); - assert.match(chat, /gql\.subscribe\s*\(/); + assert.match(chat, /gql\.live\s*\(/); + assert.doesNotMatch(chat, /gql\.subscribe\s*\(/); assert.doesNotMatch(chat, /authFromPageData/); assert.doesNotMatch(chat, /from '\$lib\/graphql-ws'/); }); diff --git a/tests/e2e-ui/ui/tests/document-store.test.mjs b/tests/e2e-ui/ui/tests/document-store.test.mjs new file mode 100644 index 00000000..050ac1a3 --- /dev/null +++ b/tests/e2e-ui/ui/tests/document-store.test.mjs @@ -0,0 +1,79 @@ +/** + * Document store: cache is transparent (seed + follow + live write-through). + */ +import { test } from 'node:test'; +import assert from 'node:assert/strict'; +import fs from 'node:fs'; +import path from 'node:path'; +import { fileURLToPath, pathToFileURL } from 'node:url'; +import { spawnSync } from 'node:child_process'; + +const uiRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..'); + +test('createDocumentStore seeds cache and updates when cache changes', () => { + const script = ` + import { QueryCache, cacheKey } from ${JSON.stringify( + pathToFileURL(path.join(uiRoot, 'src/lib/gql/cache/query-cache.ts')).href + )}; + import { createDocumentStore } from ${JSON.stringify( + pathToFileURL(path.join(uiRoot, 'src/lib/gql/document-store.ts')).href + )}; + + const DOC = 'query Q { items { id } }'; + const cache = new QueryCache(); + const client = { + cache, + async request() { return { data: { items: [{ id: '2' }] } }; }, + subscribe() { return () => {}; } + }; + + const store = createDocumentStore(client, { + document: DOC, + initialData: { items: [{ id: '1' }] }, + select: (d) => d.items + }); + + let latest; + const unsub = store.subscribe((s) => { latest = s; }); + if (!latest || latest.data[0].id !== '1') throw new Error('initial seed failed'); + + cache.set(cacheKey(DOC, {}), { + data: { items: [{ id: '1' }, { id: 'x' }] }, + updatedAt: Date.now() + }); + if (latest.data.length !== 2) throw new Error('cache notify failed: ' + latest.data.length); + + await store.refetch(); + if (latest.data[0].id !== '2') throw new Error('refetch did not update store'); + + unsub(); + store.destroy(); + console.log('document-store-ok'); + `; + + const r = spawnSync( + process.execPath, + ['--experimental-strip-types', '--input-type=module', '-e', script], + { encoding: 'utf8', cwd: uiRoot } + ); + assert.equal(r.status, 0, `stderr=${r.stderr}\nstdout=${r.stdout}`); + assert.match(r.stdout, /document-store-ok/); +}); + +test('pages use gql.store / gql.live — no manual seedQueryCache', () => { + const todos = fs.readFileSync(path.join(uiRoot, 'src/routes/todos/+page.svelte'), 'utf8'); + assert.match(todos, /gql\.store\s*\(/); + assert.match(todos, /\$list\.data/); + assert.doesNotMatch(todos, /seedQueryCache|readQueryList|cache\.subscribe/); + + const chat = fs.readFileSync(path.join(uiRoot, 'src/routes/chat/+page.svelte'), 'utf8'); + assert.match(chat, /gql\.live\s*\(/); + assert.match(chat, /\$lobby\.(data|status)/); + assert.doesNotMatch(chat, /seedQueryCache|readQueryList|syncFromCache/); + assert.doesNotMatch(chat, /gql\.subscribe\s*\(/); + + const admin = fs.readFileSync(path.join(uiRoot, 'src/routes/admin/+page.svelte'), 'utf8'); + assert.match(admin, /gql\.store\s*\(/); + assert.match(admin, /\$list\.data/); + assert.doesNotMatch(admin, /seedQueryCache|readQueryList/); +}); From 7e3f1ef8ca8697faaeccf9840d65cf1a79625fd7 Mon Sep 17 00:00:00 2001 From: Patrick Lee Scott Date: Thu, 16 Jul 2026 18:10:57 -0500 Subject: [PATCH 04/20] fix(e2e-ui): document store refetch writes cache without client write-through --- tests/e2e-ui/ui/src/lib/gql/document-store.ts | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/tests/e2e-ui/ui/src/lib/gql/document-store.ts b/tests/e2e-ui/ui/src/lib/gql/document-store.ts index 606e7389..78963f4b 100644 --- a/tests/e2e-ui/ui/src/lib/gql/document-store.ts +++ b/tests/e2e-ui/ui/src/lib/gql/document-store.ts @@ -224,7 +224,15 @@ export function createDocumentStore, TSelected = emit(); return; } - // request write-through updates cache; emit if needed + // Prefer client write-through; still write here so plain mock clients work. + if (result.data !== undefined && result.data !== null) { + cache.set(key, { + data: result.data, + updatedAt: Date.now(), + optimistic: false, + pending: false + }); + } error = null; emit(); } From c2c6db484b1e9ea88e958dec00a89fb0a9e08323 Mon Sep 17 00:00:00 2001 From: Patrick Lee Scott Date: Thu, 16 Jul 2026 18:14:21 -0500 Subject: [PATCH 05/20] fix(e2e-ui): Svelte 5 syntax hygiene across the template MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Rename command UI helpers to fx so they never shadow \$effect - Type layout/Auth children as Snippet; use \$app/state consistently - Convert +error onMount → \$effect (browser-guarded) - Fix chat PageData (drop invalid userId); allowImportingTsExtensions - Clear empty CSS ruleset; CommandClient cast for pipeline binder svelte-check: 0 errors / 0 warnings --- .../lib/components/shared/header/Auth.svelte | 11 +++++++-- .../src/lib/components/shared/ui/Card.svelte | 4 ---- .../ui/src/lib/gql/bind-commands-pipeline.ts | 6 ++++- tests/e2e-ui/ui/src/lib/gql/cache/index.ts | 2 +- tests/e2e-ui/ui/src/lib/gql/cache/ops.ts | 6 ++++- tests/e2e-ui/ui/src/lib/gql/cache/pipeline.ts | 6 ++--- tests/e2e-ui/ui/src/lib/gql/document-store.ts | 20 +++++++++------- tests/e2e-ui/ui/src/lib/gql/index.ts | 2 +- tests/e2e-ui/ui/src/lib/gql/use-graphql.ts | 3 ++- tests/e2e-ui/ui/src/routes/+error.svelte | 24 +++++++++++-------- tests/e2e-ui/ui/src/routes/+layout.svelte | 3 ++- tests/e2e-ui/ui/src/routes/admin/+page.svelte | 4 ++-- tests/e2e-ui/ui/src/routes/chat/+page.svelte | 6 ++--- tests/e2e-ui/ui/src/routes/todos/+page.svelte | 8 +++---- tests/e2e-ui/ui/tests/run-pipeline-unit.mjs | 8 +++---- tests/e2e-ui/ui/tsconfig.json | 5 +++- 16 files changed, 70 insertions(+), 48 deletions(-) diff --git a/tests/e2e-ui/ui/src/lib/components/shared/header/Auth.svelte b/tests/e2e-ui/ui/src/lib/components/shared/header/Auth.svelte index 324f4f6e..184c6def 100644 --- a/tests/e2e-ui/ui/src/lib/components/shared/header/Auth.svelte +++ b/tests/e2e-ui/ui/src/lib/components/shared/header/Auth.svelte @@ -1,8 +1,15 @@ {#if isAuthenticated} - {:else} - + Sign in {/if} {#if children} diff --git a/tests/e2e-ui/ui/src/lib/components/shared/header/Navbar.svelte b/tests/e2e-ui/ui/src/lib/components/shared/header/Navbar.svelte index 5fa81c11..30259d14 100644 --- a/tests/e2e-ui/ui/src/lib/components/shared/header/Navbar.svelte +++ b/tests/e2e-ui/ui/src/lib/components/shared/header/Navbar.svelte @@ -94,11 +94,11 @@
{#if !isAuthenticated} (isMenuOpen = false)} > - Sign In + Create account {/if} diff --git a/tests/e2e-ui/ui/src/routes/signup/+server.ts b/tests/e2e-ui/ui/src/routes/signup/+server.ts new file mode 100644 index 00000000..9127751c --- /dev/null +++ b/tests/e2e-ui/ui/src/routes/signup/+server.ts @@ -0,0 +1,44 @@ +/** + * Create-account entry: start OIDC the same way as /signin. + * Zitadel’s login UI exposes registration when user registration is enabled + * on the instance (see e2e-ui `make up` bootstrap). After register, the user + * completes the Auth.js OIDC callback like a normal sign-in. + */ +import { error } from '@sveltejs/kit'; +import type { RequestHandler } from './$types'; + +function safeCallbackUrl(url: URL) { + const callbackUrl = url.searchParams.get('callbackUrl'); + if (!callbackUrl) return url.origin; + + try { + const parsed = new URL(callbackUrl, url.origin); + if (parsed.origin !== url.origin) return url.origin; + return parsed.toString(); + } catch { + return url.origin; + } +} + +export const GET: RequestHandler = async (event) => { + const callbackUrl = safeCallbackUrl(event.url); + // Same OIDC start as /signin — IdP login page can switch to “register”. + const response = await event.fetch('/auth/signin/oidc', { + method: 'POST', + headers: { + 'Content-Type': 'application/x-www-form-urlencoded', + 'X-Auth-Return-Redirect': '1' + }, + body: new URLSearchParams({ callbackUrl }) + }); + + const payload = (await response.json().catch(() => null)) as { url?: unknown } | null; + if (!response.ok || typeof payload?.url !== 'string') { + error(502, 'Unable to start Zitadel sign-up'); + } + + return new Response(null, { + status: 302, + headers: { location: payload.url } + }); +}; From 2b13d37017d0a5d4f38b2306456a0f41a5361901 Mon Sep 17 00:00:00 2001 From: Patrick Lee Scott Date: Thu, 16 Jul 2026 18:28:28 -0500 Subject: [PATCH 07/20] fix(e2e-ui): clear errors when Zitadel down; enable allowRegister on make up Auth.js error=Configuration was opaque: OIDC issuer unreachable (Docker/Zitadel not running). Probe IdP before starting OIDC and return 503 with make up steps. Bootstrap login policy sets allowRegister for Create account on hosted login. --- tests/e2e-ui/scripts/up.sh | 33 +++++++ tests/e2e-ui/ui/src/app.css | 31 +++++++ tests/e2e-ui/ui/src/lib/server/oidc-start.ts | 93 ++++++++++++++++++++ tests/e2e-ui/ui/src/routes/+page.svelte | 25 ++++++ tests/e2e-ui/ui/src/routes/signin/+server.ts | 37 +------- tests/e2e-ui/ui/src/routes/signup/+server.ts | 47 ++-------- 6 files changed, 191 insertions(+), 75 deletions(-) create mode 100644 tests/e2e-ui/ui/src/lib/server/oidc-start.ts diff --git a/tests/e2e-ui/scripts/up.sh b/tests/e2e-ui/scripts/up.sh index bd856988..5268a036 100755 --- a/tests/e2e-ui/scripts/up.sh +++ b/tests/e2e-ui/scripts/up.sh @@ -378,6 +378,39 @@ create_human() { printf '%s' "$uid" } +# Allow self-registration on the hosted login UI (Create account → OIDC → Register). +# Default Zitadel policy often has allowRegister=false. +echo "==> Login policy: allowRegister + username/password" +LOGIN_POL=$(curl -sS "$ZITADEL_HOST/management/v1/policies/login" \ + -H "Authorization: Bearer $ACCESS_TOKEN" -H 'Content-Type: application/json' || echo '{}') +# Prefer update custom policy; fall back to add if only IAM default exists. +REG_BODY=$(jq -n '{ + allowRegister: true, + allowUsernamePassword: true, + allowExternalIdp: true, + forceMfa: false, + passwordCheckLifetime: false, + hidePasswordReset: false, + ignoreUnknownUsernames: false, + defaultRedirectUri: "", + passwordlessType: "PASSWORDLESS_TYPE_ALLOWED", + forceMfaLocalOnly: false +}') +# Try org custom login policy update first +if ! curl -sS -o /tmp/e2e-login-pol.out -w '%{http_code}' -X PUT \ + "$ZITADEL_HOST/management/v1/policies/login" \ + -H "Authorization: Bearer $ACCESS_TOKEN" -H 'Content-Type: application/json' \ + -d "$REG_BODY" | grep -qE '^(200|201)$'; then + # Create custom policy if update failed (e.g. still on default-only) + code=$(curl -sS -o /tmp/e2e-login-pol.out -w '%{http_code}' -X POST \ + "$ZITADEL_HOST/management/v1/policies/login" \ + -H "Authorization: Bearer $ACCESS_TOKEN" -H 'Content-Type: application/json' \ + -d "$REG_BODY" || true) + echo " login policy create/update HTTP $code (body: $(head -c 200 /tmp/e2e-login-pol.out 2>/dev/null || true))" +else + echo " allowRegister=true (updated)" +fi + echo "==> Human users (browser login: alice, bob, admin)" ALICE_UID=$(create_human "alice" "Password1!" "user" "alice@e2e.local") echo " alice → $ALICE_UID" diff --git a/tests/e2e-ui/ui/src/app.css b/tests/e2e-ui/ui/src/app.css index 641ca575..9ff1d92d 100644 --- a/tests/e2e-ui/ui/src/app.css +++ b/tests/e2e-ui/ui/src/app.css @@ -1252,3 +1252,34 @@ main { --rule: rgba(28, 28, 26, 0.06); --shadow: var(--df-shadow-sm); } + +/* Auth / OIDC configuration error (/?error=Configuration) */ +.wf-auth-banner { + margin: 0 0 1.25rem; + padding: 1rem 1.15rem; + border-radius: 10px; + background: rgba(229, 62, 62, 0.1); + border: 1px solid rgba(229, 62, 62, 0.35); + color: #7b1e1e; + text-align: left; + font-size: 0.92rem; + line-height: 1.45; +} +.wf-auth-banner strong { + display: block; + margin-bottom: 0.35rem; + font-size: 0.95rem; +} +.wf-auth-banner p { + margin: 0 0 0.65rem; +} +.wf-auth-banner ol { + margin: 0; + padding-left: 1.2rem; +} +.wf-auth-banner code { + font-size: 0.85em; + padding: 0.05em 0.3em; + border-radius: 4px; + background: rgba(0, 0, 0, 0.06); +} diff --git a/tests/e2e-ui/ui/src/lib/server/oidc-start.ts b/tests/e2e-ui/ui/src/lib/server/oidc-start.ts new file mode 100644 index 00000000..acd32545 --- /dev/null +++ b/tests/e2e-ui/ui/src/lib/server/oidc-start.ts @@ -0,0 +1,93 @@ +/** + * Shared OIDC start for /signin and /signup. + * Probes the IdP before Auth.js so we never bounce to `/?error=Configuration` + * with no explanation (common when Zitadel / Docker is down). + */ +import { error } from '@sveltejs/kit'; +import { env } from '$env/dynamic/private'; +import { cleanEnvValue } from '$lib/clean-env'; + +export function safeCallbackUrl(url: URL) { + const callbackUrl = url.searchParams.get('callbackUrl'); + if (!callbackUrl) return url.origin; + + try { + const parsed = new URL(callbackUrl, url.origin); + if (parsed.origin !== url.origin) return url.origin; + return parsed.toString(); + } catch { + return url.origin; + } +} + +function oidcIssuer(): string { + const raw = + cleanEnvValue(env.OIDC_ISSUER) || + cleanEnvValue(env.ZITADEL_ISSUER) || + ''; + return raw.replace(/\/+$/, ''); +} + +/** + * Fail fast with a actionable message if OIDC is not configured or the IdP + * (Zitadel on :18080) is unreachable. + */ +export async function assertOidcReady(): Promise { + const issuer = oidcIssuer(); + const clientId = cleanEnvValue(env.OIDC_CLIENT_ID) || cleanEnvValue(env.ZITADEL_CLIENT_ID); + + if (!issuer || !clientId) { + error( + 503, + 'OIDC is not configured. From tests/e2e-ui run: make up (writes e2e-ui.env with OIDC_*). Then restart the UI with that env sourced.' + ); + } + + const discovery = `${issuer}/.well-known/openid-configuration`; + try { + const res = await fetch(discovery, { + signal: AbortSignal.timeout(2500) + }); + if (!res.ok) { + error( + 503, + `Identity provider at ${issuer} returned HTTP ${res.status}. Start Zitadel: cd tests/e2e-ui && make up (needs Docker/Colima). Demo logins after up: alice / bob / admin · Password1!` + ); + } + } catch { + error( + 503, + `Cannot reach identity provider at ${issuer} (Docker/Zitadel not running). Start it with: cd tests/e2e-ui && make up Then source e2e-ui.env and restart make run / the UI. Until then use demo users after the stack is up — self-registration is enabled by bootstrap when Zitadel is healthy.` + ); + } +} + +export async function startOidcSignIn( + event: { fetch: typeof fetch; url: URL }, + label: 'sign-in' | 'sign-up' = 'sign-in' +): Promise { + await assertOidcReady(); + + const callbackUrl = safeCallbackUrl(event.url); + const response = await event.fetch('/auth/signin/oidc', { + method: 'POST', + headers: { + 'Content-Type': 'application/x-www-form-urlencoded', + 'X-Auth-Return-Redirect': '1' + }, + body: new URLSearchParams({ callbackUrl }) + }); + + const payload = (await response.json().catch(() => null)) as { url?: unknown } | null; + if (!response.ok || typeof payload?.url !== 'string') { + error( + 502, + `Unable to start Zitadel ${label}. Check OIDC_CLIENT_ID / OIDC_CLIENT_SECRET in e2e-ui.env (re-run make up if the secret file is missing).` + ); + } + + return new Response(null, { + status: 302, + headers: { location: payload.url } + }); +} diff --git a/tests/e2e-ui/ui/src/routes/+page.svelte b/tests/e2e-ui/ui/src/routes/+page.svelte index d43b7df8..7ebaeeca 100644 --- a/tests/e2e-ui/ui/src/routes/+page.svelte +++ b/tests/e2e-ui/ui/src/routes/+page.svelte @@ -9,6 +9,8 @@ const session = $derived(page.data.session); const signedIn = $derived(!!session?.user); + /** Auth.js bounce when OIDC/IdP is misconfigured or Zitadel is down. */ + const authConfigError = $derived(page.url.searchParams.get('error') === 'Configuration'); /** One file / one concept per code block — never merge paths in a single sample. */ type CodeBlock = { file: string; label: string; code: string }; @@ -358,6 +360,29 @@ subscription {
+ {#if authConfigError} + + {/if} Distributed · e2e-ui template

A framework template you run as full e2e tests — kept honest by the library. diff --git a/tests/e2e-ui/ui/src/routes/signin/+server.ts b/tests/e2e-ui/ui/src/routes/signin/+server.ts index 7afe5113..04d082cd 100644 --- a/tests/e2e-ui/ui/src/routes/signin/+server.ts +++ b/tests/e2e-ui/ui/src/routes/signin/+server.ts @@ -1,37 +1,4 @@ -import { error } from '@sveltejs/kit'; import type { RequestHandler } from './$types'; +import { startOidcSignIn } from '$lib/server/oidc-start'; -function safeCallbackUrl(url: URL) { - const callbackUrl = url.searchParams.get('callbackUrl'); - if (!callbackUrl) return url.origin; - - try { - const parsed = new URL(callbackUrl, url.origin); - if (parsed.origin !== url.origin) return url.origin; - return parsed.toString(); - } catch { - return url.origin; - } -} - -export const GET: RequestHandler = async (event) => { - const callbackUrl = safeCallbackUrl(event.url); - const response = await event.fetch('/auth/signin/oidc', { - method: 'POST', - headers: { - 'Content-Type': 'application/x-www-form-urlencoded', - 'X-Auth-Return-Redirect': '1' - }, - body: new URLSearchParams({ callbackUrl }) - }); - - const payload = (await response.json().catch(() => null)) as { url?: unknown } | null; - if (!response.ok || typeof payload?.url !== 'string') { - error(502, 'Unable to start Zitadel sign-in'); - } - - return new Response(null, { - status: 302, - headers: { location: payload.url } - }); -}; +export const GET: RequestHandler = async (event) => startOidcSignIn(event, 'sign-in'); diff --git a/tests/e2e-ui/ui/src/routes/signup/+server.ts b/tests/e2e-ui/ui/src/routes/signup/+server.ts index 9127751c..c1b90575 100644 --- a/tests/e2e-ui/ui/src/routes/signup/+server.ts +++ b/tests/e2e-ui/ui/src/routes/signup/+server.ts @@ -1,44 +1,11 @@ /** - * Create-account entry: start OIDC the same way as /signin. - * Zitadel’s login UI exposes registration when user registration is enabled - * on the instance (see e2e-ui `make up` bootstrap). After register, the user - * completes the Auth.js OIDC callback like a normal sign-in. + * Create-account entry. + * + * Requires Zitadel (make up). Bootstrap enables self-registration on the org + * login policy so the hosted login UI shows Register. + * Same OIDC start as /signin — after register, user lands via Auth.js callback. */ -import { error } from '@sveltejs/kit'; import type { RequestHandler } from './$types'; +import { startOidcSignIn } from '$lib/server/oidc-start'; -function safeCallbackUrl(url: URL) { - const callbackUrl = url.searchParams.get('callbackUrl'); - if (!callbackUrl) return url.origin; - - try { - const parsed = new URL(callbackUrl, url.origin); - if (parsed.origin !== url.origin) return url.origin; - return parsed.toString(); - } catch { - return url.origin; - } -} - -export const GET: RequestHandler = async (event) => { - const callbackUrl = safeCallbackUrl(event.url); - // Same OIDC start as /signin — IdP login page can switch to “register”. - const response = await event.fetch('/auth/signin/oidc', { - method: 'POST', - headers: { - 'Content-Type': 'application/x-www-form-urlencoded', - 'X-Auth-Return-Redirect': '1' - }, - body: new URLSearchParams({ callbackUrl }) - }); - - const payload = (await response.json().catch(() => null)) as { url?: unknown } | null; - if (!response.ok || typeof payload?.url !== 'string') { - error(502, 'Unable to start Zitadel sign-up'); - } - - return new Response(null, { - status: 302, - headers: { location: payload.url } - }); -}; +export const GET: RequestHandler = async (event) => startOidcSignIn(event, 'sign-up'); From cdeca5e26842a738014a9f28b3a2c98e39909081 Mon Sep 17 00:00:00 2001 From: Patrick Lee Scott Date: Thu, 16 Jul 2026 18:37:13 -0500 Subject: [PATCH 08/20] fix(e2e-ui): no immediate post-command refetch (archive flicker) Async projectors: keep optimistic list state; reconcile: none on todos/admin. Soft catch-up refetch later; writeServerDataPreservingPending if server still lags. --- tests/e2e-ui/scripts/up.sh | 69 ++++++---- tests/e2e-ui/ui/src/lib/gql/cache/index.ts | 1 + tests/e2e-ui/ui/src/lib/gql/cache/ops.ts | 128 ++++++++++++++++++ tests/e2e-ui/ui/src/lib/gql/cache/pipeline.ts | 18 +-- tests/e2e-ui/ui/src/lib/gql/create-client.ts | 28 ++-- tests/e2e-ui/ui/src/lib/gql/document-store.ts | 10 +- tests/e2e-ui/ui/src/lib/gql/use-graphql.ts | 2 +- tests/e2e-ui/ui/src/routes/admin/+page.svelte | 6 +- tests/e2e-ui/ui/src/routes/todos/+page.svelte | 41 +++--- tests/e2e-ui/ui/tests/api-contract.test.mjs | 12 +- tests/e2e-ui/ui/tests/command-client.test.mjs | 3 +- 11 files changed, 230 insertions(+), 88 deletions(-) diff --git a/tests/e2e-ui/scripts/up.sh b/tests/e2e-ui/scripts/up.sh index 5268a036..e2e5701a 100755 --- a/tests/e2e-ui/scripts/up.sh +++ b/tests/e2e-ui/scripts/up.sh @@ -378,37 +378,46 @@ create_human() { printf '%s' "$uid" } -# Allow self-registration on the hosted login UI (Create account → OIDC → Register). -# Default Zitadel policy often has allowRegister=false. -echo "==> Login policy: allowRegister + username/password" -LOGIN_POL=$(curl -sS "$ZITADEL_HOST/management/v1/policies/login" \ - -H "Authorization: Bearer $ACCESS_TOKEN" -H 'Content-Type: application/json' || echo '{}') -# Prefer update custom policy; fall back to add if only IAM default exists. -REG_BODY=$(jq -n '{ - allowRegister: true, - allowUsernamePassword: true, - allowExternalIdp: true, - forceMfa: false, - passwordCheckLifetime: false, - hidePasswordReset: false, - ignoreUnknownUsernames: false, - defaultRedirectUri: "", - passwordlessType: "PASSWORDLESS_TYPE_ALLOWED", - forceMfaLocalOnly: false -}') -# Try org custom login policy update first -if ! curl -sS -o /tmp/e2e-login-pol.out -w '%{http_code}' -X PUT \ - "$ZITADEL_HOST/management/v1/policies/login" \ - -H "Authorization: Bearer $ACCESS_TOKEN" -H 'Content-Type: application/json' \ - -d "$REG_BODY" | grep -qE '^(200|201)$'; then - # Create custom policy if update failed (e.g. still on default-only) - code=$(curl -sS -o /tmp/e2e-login-pol.out -w '%{http_code}' -X POST \ - "$ZITADEL_HOST/management/v1/policies/login" \ - -H "Authorization: Bearer $ACCESS_TOKEN" -H 'Content-Type: application/json' \ - -d "$REG_BODY" || true) - echo " login policy create/update HTTP $code (body: $(head -c 200 /tmp/e2e-login-pol.out 2>/dev/null || true))" +# Self-registration for "Create account" (hosted login Register button). +echo "==> Login policy: ensure allowRegister" +POL=$(curl -sS "$ZITADEL_HOST/management/v1/policies/login" \ + -H "Authorization: Bearer $ACCESS_TOKEN" || echo '{}') +ALLOW=$(echo "$POL" | jq -r '.policy.allowRegister // empty') +IS_DEFAULT=$(echo "$POL" | jq -r '.isDefault // .policy.isDefault // empty') +echo " current allowRegister=$ALLOW isDefault=$IS_DEFAULT" +if [[ "$ALLOW" != "true" ]]; then + # Create org custom policy (required before update when still on IAM default). + # Field set matches Zitadel management UpdateCustomLoginPolicy / AddCustomLoginPolicy. + REG_BODY=$(jq -n '{ + allowRegister: true, + allowUsernamePassword: true, + allowExternalIdp: true, + forceMfa: false, + passwordCheckLifetime: "864000s", + externalLoginCheckLifetime: "864000s", + multiFactorCheckLifetime: "43200s", + secondFactorCheckLifetime: "64800s", + mfaInitSkipLifetime: "2592000s", + passwordlessType: "PASSWORDLESS_TYPE_ALLOWED", + allowDomainDiscovery: true, + ignoreUnknownUsernames: false, + defaultRedirectUri: "", + passwordlessType: "PASSWORDLESS_TYPE_ALLOWED" + }') + if [[ "$IS_DEFAULT" == "true" ]]; then + code=$(curl -sS -o /tmp/e2e-login-pol.out -w '%{http_code}' -X POST \ + "$ZITADEL_HOST/management/v1/policies/login" \ + -H "Authorization: Bearer $ACCESS_TOKEN" -H 'Content-Type: application/json' \ + -d "$REG_BODY" || true) + else + code=$(curl -sS -o /tmp/e2e-login-pol.out -w '%{http_code}' -X PUT \ + "$ZITADEL_HOST/management/v1/policies/login" \ + -H "Authorization: Bearer $ACCESS_TOKEN" -H 'Content-Type: application/json' \ + -d "$REG_BODY" || true) + fi + echo " policy write HTTP $code ($(head -c 160 /tmp/e2e-login-pol.out 2>/dev/null || true))" else - echo " allowRegister=true (updated)" + echo " allowRegister already true — ok for Create account" fi echo "==> Human users (browser login: alice, bob, admin)" diff --git a/tests/e2e-ui/ui/src/lib/gql/cache/index.ts b/tests/e2e-ui/ui/src/lib/gql/cache/index.ts index 24434e1c..e1133310 100644 --- a/tests/e2e-ui/ui/src/lib/gql/cache/index.ts +++ b/tests/e2e-ui/ui/src/lib/gql/cache/index.ts @@ -3,6 +3,7 @@ export { applyCacheOp, applyCacheOps, applyProjectionPayload, + writeServerDataPreservingPending, fx, rollback, type CacheOp, diff --git a/tests/e2e-ui/ui/src/lib/gql/cache/ops.ts b/tests/e2e-ui/ui/src/lib/gql/cache/ops.ts index b9334ca5..8665438c 100644 --- a/tests/e2e-ui/ui/src/lib/gql/cache/ops.ts +++ b/tests/e2e-ui/ui/src/lib/gql/cache/ops.ts @@ -232,3 +232,131 @@ export function applyProjectionPayload( })); return applyCacheOps(cache, ops); } + +/** + * Write a server query/subscription payload into the cache **without** clobbering + * optimistic rows that the projector has not caught up to yet. + * + * Fixes archive/complete flicker: optimistic → immediate refetch (stale RM) → late refetch. + * While `pending`/`optimistic`, keep local rows that still differ from server by PK. + */ +export function writeServerDataPreservingPending( + cache: QueryCache, + document: string, + variables: Record | undefined, + serverData: unknown, + /** List path on the document, e.g. "todos". When omitted, tries common roots. */ + listPath?: string, + by = 'todo_id' +): void { + const key = cacheKey(document, variables); + const prev = cache.get(key); + const now = Date.now(); + + if (!prev?.pending && !prev?.optimistic) { + cache.set(key, { + data: serverData, + updatedAt: now, + pending: false, + optimistic: false + }); + return; + } + + const prevData = prev.data; + if ( + !prevData || + typeof prevData !== 'object' || + !serverData || + typeof serverData !== 'object' + ) { + // Can't merge — keep optimistic until a later refetch + return; + } + + const path = + listPath ?? + (Array.isArray((serverData as Record).todos) + ? 'todos' + : Array.isArray((serverData as Record).chat_messages) + ? 'chat_messages' + : undefined); + + if (!path) { + // Non-list document: keep pending local data + return; + } + + const serverList = getAt(serverData, path); + const localList = getAt(prevData, path); + if (!Array.isArray(serverList) || !Array.isArray(localList)) { + return; + } + + const serverById = new Map>(); + for (const row of serverList) { + if (row && typeof row === 'object') { + const r = row as Record; + serverById.set(r[by], r); + } + } + + const localById = new Map>(); + for (const row of localList) { + if (row && typeof row === 'object') { + const r = row as Record; + localById.set(r[by], r); + } + } + + const merged: Record[] = []; + const seen = new Set(); + + // Prefer server order; overlay optimistic when server still lags + for (const sRow of serverList) { + if (!sRow || typeof sRow !== 'object') continue; + const s = sRow as Record; + const id = s[by]; + seen.add(id); + const local = localById.get(id); + if (local && shallowRowDiffers(local, s)) { + merged.push({ ...local }); + } else { + merged.push({ ...s }); + } + } + + // Optimistic creates not yet on server + for (const [id, local] of localById) { + if (!seen.has(id) && !serverById.has(id)) { + merged.push({ ...local }); + } + } + + let stillPending = false; + for (const row of merged) { + const id = row[by]; + const s = serverById.get(id); + if (!s || shallowRowDiffers(row, s)) { + stillPending = true; + break; + } + } + + const data = setAt(serverData, path, merged); + cache.set(key, { + data, + updatedAt: now, + pending: stillPending, + optimistic: stillPending + }); +} + +/** True if any shared key differs (status, title, …). */ +function shallowRowDiffers(a: Record, b: Record): boolean { + const keys = new Set([...Object.keys(a), ...Object.keys(b)]); + for (const k of keys) { + if (a[k] !== b[k]) return true; + } + return false; +} diff --git a/tests/e2e-ui/ui/src/lib/gql/cache/pipeline.ts b/tests/e2e-ui/ui/src/lib/gql/cache/pipeline.ts index ca9880f8..9ec10a85 100644 --- a/tests/e2e-ui/ui/src/lib/gql/cache/pipeline.ts +++ b/tests/e2e-ui/ui/src/lib/gql/cache/pipeline.ts @@ -13,6 +13,7 @@ import { applyProjectionPayload, fx, rollback, + writeServerDataPreservingPending, type CacheOp, type CacheTarget, type CommandPolicy, @@ -172,17 +173,18 @@ export async function runCommandPipeline>( if (browser && ops.length) applyCacheOps(deps.cache, ops); deps.runEffects?.(effects); - // Reconcile (subscription is usually already running; refetch optional) + // Reconcile (subscription is usually already running; refetch optional). + // For async projectors: immediate refetch often returns pre-projection rows. + // Never clobber pending optimistic status (archive/complete flicker). if (browser && merged.reconcileKind === 'refetch' && merged.reconcileDoc && deps.refetch) { const refetched = await deps.refetch(merged.reconcileDoc, merged.reconcileVars); if (refetched.data && !refetched.errors?.length) { - const key = cacheKey(merged.reconcileDoc, merged.reconcileVars); - deps.cache.set(key, { - data: refetched.data, - updatedAt: Date.now(), - pending: false, - optimistic: false - }); + writeServerDataPreservingPending( + deps.cache, + merged.reconcileDoc, + merged.reconcileVars, + refetched.data + ); } } else if (browser && merged.reconcileKind === 'invalidate' && merged.reconcileDoc) { deps.cache.invalidate(cacheKey(merged.reconcileDoc, merged.reconcileVars)); diff --git a/tests/e2e-ui/ui/src/lib/gql/create-client.ts b/tests/e2e-ui/ui/src/lib/gql/create-client.ts index c01e2ddd..ee5977ec 100644 --- a/tests/e2e-ui/ui/src/lib/gql/create-client.ts +++ b/tests/e2e-ui/ui/src/lib/gql/create-client.ts @@ -18,7 +18,7 @@ import { requestGraphql, type GqlDocument } from './request.ts'; import { documentToString } from './document.ts'; import type { GqlAuth, GqlResult } from './types.ts'; import type { QueryCache } from './cache/query-cache.ts'; -import { cacheKey } from './cache/query-cache.ts'; +import { writeServerDataPreservingPending } from './cache/ops.ts'; export type GraphqlClientOptions = { /** Absolute API URL or same-origin path, e.g. `/graphql` or `http://127.0.0.1:8791/graphql` */ @@ -73,6 +73,7 @@ export function createGraphqlClient(opts: GraphqlClientOptions): GraphqlClient { (variables ?? {}) as TVariables ); // Query write-through only — mutations go through the command pipeline. + // Preserve pending optimistic rows (async projector lag). if ( opts.cache && writeThrough && @@ -80,16 +81,12 @@ export function createGraphqlClient(opts: GraphqlClientOptions): GraphqlClient { !result.errors?.length && !looksLikeMutation(document) ) { - const key = cacheKey( + writeServerDataPreservingPending( + opts.cache, documentToString(document as GqlDocument), - (variables ?? {}) as Record + (variables ?? {}) as Record, + result.data ); - opts.cache.set(key, { - data: result.data, - updatedAt: Date.now(), - optimistic: false, - pending: false - }); } return result; }, @@ -105,13 +102,12 @@ export function createGraphqlClient(opts: GraphqlClientOptions): GraphqlClient { errors?: unknown[]; }; if (p.data && !p.errors?.length) { - const key = cacheKey(documentToString(document), {}); - opts.cache.set(key, { - data: p.data, - updatedAt: Date.now(), - optimistic: false, - pending: false - }); + writeServerDataPreservingPending( + opts.cache, + documentToString(document), + {}, + p.data + ); } } handlers.onNext?.(payload); diff --git a/tests/e2e-ui/ui/src/lib/gql/document-store.ts b/tests/e2e-ui/ui/src/lib/gql/document-store.ts index 37b5847d..d68729f7 100644 --- a/tests/e2e-ui/ui/src/lib/gql/document-store.ts +++ b/tests/e2e-ui/ui/src/lib/gql/document-store.ts @@ -28,6 +28,7 @@ import { documentToString } from './document.ts'; import type { QueryCache } from './cache/query-cache.ts'; import { cacheKey } from './cache/query-cache.ts'; import type { CacheTarget } from './cache/ops.ts'; +import { writeServerDataPreservingPending } from './cache/ops.ts'; import type { GraphqlClient } from './create-client.ts'; export type StoreStatus = 'idle' | 'connecting' | 'live' | 'error'; @@ -226,14 +227,9 @@ export function createDocumentStore, TSelected = emit(); return; } - // Prefer client write-through; still write here so plain mock clients work. + // Merge server data under pending optimistic rows (async projectors). if (result.data !== undefined && result.data !== null) { - qcache.set(key, { - data: result.data, - updatedAt: Date.now(), - optimistic: false, - pending: false - }); + writeServerDataPreservingPending(qcache, docStr, variables, result.data); } error = null; emit(); diff --git a/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts b/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts index 6f90e515..fa198938 100644 --- a/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts +++ b/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts @@ -72,7 +72,7 @@ export type UseGraphqlOptions = { * @example Command with optimistic list patch * await gql.commands.todosCreate(input, { * result: { kind: 'fact' }, - * reconcile: { kind: 'refetch', document: list.document }, + * reconcile: { kind: 'none' }, // async projectors — do not refetch on command success * optimistic: { targets: [list.target('todos', 'todo_id')], row }, * }); */ diff --git a/tests/e2e-ui/ui/src/routes/admin/+page.svelte b/tests/e2e-ui/ui/src/routes/admin/+page.svelte index b559f46d..a7b94dcd 100644 --- a/tests/e2e-ui/ui/src/routes/admin/+page.svelte +++ b/tests/e2e-ui/ui/src/routes/admin/+page.svelte @@ -51,7 +51,8 @@ { todo_id }, { result: { kind: 'fact' }, - reconcile: { kind: 'refetch', document: list.document }, + // Async projector — never refetch on the command path. + reconcile: { kind: 'none' }, optimistic: { targets: [list.target('todos', 'todo_id')], row: { ...target, status: 'archived' } @@ -67,9 +68,10 @@ if (!actionError) actionError = result.errors?.[0]?.message ?? 'force archive failed'; return; } + // Soft catch-up after projector lag (not on the command success path). window.setTimeout(() => { void list.refetch(); - }, 900); + }, 800); } diff --git a/tests/e2e-ui/ui/src/routes/todos/+page.svelte b/tests/e2e-ui/ui/src/routes/todos/+page.svelte index 95178e9b..0b226463 100644 --- a/tests/e2e-ui/ui/src/routes/todos/+page.svelte +++ b/tests/e2e-ui/ui/src/routes/todos/+page.svelte @@ -1,8 +1,8 @@ @@ -175,8 +176,8 @@

Field notes

Tasks for {who}. List via gql.store - ($list.data); writes via gql.commands.* pipeline - (optimistic → fact → refetch). Cache is transparent — no manual seed/sync. + ($list.data); writes via gql.commands.* + (optimistic → fact, no immediate refetch).

diff --git a/tests/e2e-ui/ui/tests/api-contract.test.mjs b/tests/e2e-ui/ui/tests/api-contract.test.mjs index d84d9bc7..76303ebc 100644 --- a/tests/e2e-ui/ui/tests/api-contract.test.mjs +++ b/tests/e2e-ui/ui/tests/api-contract.test.mjs @@ -45,8 +45,14 @@ test('auth + WS modules use OIDC patterns', () => { test('website auth shell + fixture routes present', () => { const signin = fs.readFileSync(new URL('../src/routes/signin/+server.ts', import.meta.url), 'utf8'); - assert.match(signin, /\/auth\/signin\/oidc/); - assert.match(signin, /X-Auth-Return-Redirect/); + assert.match(signin, /startOidcSignIn|auth\/signin\/oidc/); + const oidcStart = fs.readFileSync( + new URL('../src/lib/server/oidc-start.ts', import.meta.url), + 'utf8' + ); + assert.match(oidcStart, /\/auth\/signin\/oidc/); + assert.match(oidcStart, /X-Auth-Return-Redirect/); + assert.match(oidcStart, /assertOidcReady|well-known\/openid-configuration/); assert.ok(fs.existsSync(new URL('../src/routes/todos/+page.svelte', import.meta.url))); assert.ok(fs.existsSync(new URL('../src/routes/chat/+page.svelte', import.meta.url))); assert.ok(fs.existsSync(new URL('../src/routes/admin/+page.svelte', import.meta.url))); @@ -264,7 +270,7 @@ test('todos: co-located .gql + resource — same query SSR + browser mutations', assert.match(page, /\$list\.data/); assert.match(page, /optimistic:/); assert.match(page, /result:\s*\{\s*kind:\s*'fact'/); - assert.match(page, /reconcile:\s*\{\s*kind:\s*'refetch'/); + assert.match(page, /reconcile:\s*\{\s*kind:\s*'none'/); assert.doesNotMatch(page, /function mergeFromServer|seedQueryCache|readQueryList/); assert.match(page, /useGraphql/); assert.match(page, /todos\.resource|todosResource|from '\.\/todos\.resource'/); diff --git a/tests/e2e-ui/ui/tests/command-client.test.mjs b/tests/e2e-ui/ui/tests/command-client.test.mjs index efc6b502..75734939 100644 --- a/tests/e2e-ui/ui/tests/command-client.test.mjs +++ b/tests/e2e-ui/ui/tests/command-client.test.mjs @@ -99,7 +99,7 @@ test('app pages use gql.store/live + commands pipeline (cache transparent)', () assert.match(todos, /gql\.commands\.todosComplete/); assert.match(todos, /gql\.commands\.todosArchive/); assert.match(todos, /result:\s*\{\s*kind:\s*'fact'/); - assert.match(todos, /reconcile:\s*\{\s*kind:\s*'refetch'/); + assert.match(todos, /reconcile:\s*\{\s*kind:\s*'none'/); assert.match(todos, /list\.target\(/); assert.doesNotMatch(todos, /seedQueryCache|readQueryList|syncFromCache/); assert.doesNotMatch(todos, /from '\$lib\/api\/commands\.generated'/); @@ -118,6 +118,7 @@ test('app pages use gql.store/live + commands pipeline (cache transparent)', () assert.match(admin, /gql\.store\s*\(/); assert.match(admin, /gql\.commands\.todosForceArchive/); assert.match(admin, /list\.target\(/); + assert.match(admin, /reconcile:\s*\{\s*kind:\s*'none'/); assert.doesNotMatch(admin, /seedQueryCache|readQueryList/); }); From e075255083c72b7f92bb996a68ee26976bf76ba7 Mon Sep 17 00:00:00 2001 From: Patrick Lee Scott Date: Fri, 17 Jul 2026 00:18:44 -0500 Subject: [PATCH 09/20] feat(graphql): systems-harden client integrity, role SDL, red-team units MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Close systems-harden-1 phases 1–5: explicit list merge + subscribe variables, scheduleCatchUp cancel, e2eCommandPolicies, remove cache-helpers, graphql_sdl_for_role production path, and C-U*/auth unit pack. Implements [[tasks/graphql-qs-systems-harden-1]] --- src/graphql/mod.rs | 4 +- src/graphql/projection_return.rs | 10 +- src/graphql/sdl.rs | 28 ++ src/graphql/surface.rs | 60 +++ tests/e2e-ui/Makefile | 2 +- tests/e2e-ui/ui/src/lib/gql/cache-helpers.ts | 53 --- tests/e2e-ui/ui/src/lib/gql/cache/index.ts | 4 +- tests/e2e-ui/ui/src/lib/gql/cache/ops.ts | 45 +- tests/e2e-ui/ui/src/lib/gql/cache/pipeline.ts | 4 +- .../e2e-ui/ui/src/lib/gql/command-policies.ts | 38 ++ tests/e2e-ui/ui/src/lib/gql/create-client.ts | 49 ++- tests/e2e-ui/ui/src/lib/gql/document-store.ts | 147 ++++--- tests/e2e-ui/ui/src/lib/gql/index.ts | 8 +- tests/e2e-ui/ui/src/lib/gql/use-graphql.ts | 11 +- tests/e2e-ui/ui/src/lib/graphql-ws.ts | 7 +- tests/e2e-ui/ui/src/routes/admin/+page.svelte | 9 +- tests/e2e-ui/ui/src/routes/chat/+page.svelte | 5 +- tests/e2e-ui/ui/src/routes/todos/+page.svelte | 23 +- tests/e2e-ui/ui/tests/api-contract.test.mjs | 23 +- tests/e2e-ui/ui/tests/command-client.test.mjs | 16 +- .../e2e-ui/ui/tests/command-pipeline.test.mjs | 10 + tests/e2e-ui/ui/tests/systems-harden-unit.mjs | 411 ++++++++++++++++++ 22 files changed, 775 insertions(+), 192 deletions(-) delete mode 100644 tests/e2e-ui/ui/src/lib/gql/cache-helpers.ts create mode 100644 tests/e2e-ui/ui/src/lib/gql/command-policies.ts create mode 100644 tests/e2e-ui/ui/tests/systems-harden-unit.mjs diff --git a/src/graphql/mod.rs b/src/graphql/mod.rs index 750b8185..54965a31 100644 --- a/src/graphql/mod.rs +++ b/src/graphql/mod.rs @@ -16,8 +16,8 @@ pub use naming::{ POSTGRES_JSON_COMPARISON_OPS, PORTABLE_COMPARISON_OPS, STRING_COMPARISON_OPS, }; pub use sdl::{ - graphql_sdl_for_tables, graphql_sdl_for_tables_with_options, graphql_sdl_from_surface, - SdlOptions, + graphql_sdl_for_role, graphql_sdl_for_tables, graphql_sdl_for_tables_with_options, + graphql_sdl_from_surface, SdlOptions, }; pub use projection_return::{ projection_return_value, stage_projection_and_payload, ProjectionPayload, diff --git a/src/graphql/projection_return.rs b/src/graphql/projection_return.rs index 94005e0e..39c4bf6a 100644 --- a/src/graphql/projection_return.rs +++ b/src/graphql/projection_return.rs @@ -1,4 +1,4 @@ -//! Helpers for **same-tx projection** command returns. +//! Helpers for **same-tx projection** command returns (**library / optional topology**). //! //! # Product rule //! @@ -10,6 +10,14 @@ //! If you write the read model in the command handler, **return it**. //! If you do not, do **not** invent a full list row — return ack/fact only. //! +//! # When to use these helpers +//! +//! - **Use** [`stage_projection_and_payload`] / [`projection_return_value`] only when the +//! command handler **intentionally** commits the read model in the same request +//! (e.g. game / same-tx demos) and the client policy is `result.kind = projection`. +//! - **Do not use** for default async projector commands (e2e-ui todos, chat posts). +//! Those return fact/ack and reconcile via subscription or delayed refetch. +//! //! e2e-ui todos create returns fact-shaped fields from the domain fact — treat as //! **`fact`**, not projection-from-store (projectors are separate event handlers). diff --git a/src/graphql/sdl.rs b/src/graphql/sdl.rs index 97d108f5..c7c247dd 100644 --- a/src/graphql/sdl.rs +++ b/src/graphql/sdl.rs @@ -91,6 +91,34 @@ pub fn graphql_sdl_from_surface(surface: &super::surface::Surface) -> Result, +) -> Result { + let surface_opts = super::surface::SurfaceOptions { + dialect: if options.jsonb_operators { + super::surface::SurfaceDialect::Postgres + } else { + super::surface::SurfaceDialect::Sqlite + }, + aggregates: options.aggregates, + subscriptions: options.subscriptions, + }; + let full = super::surface::build_surface(tables, &surface_opts)?; + let role_surface = super::surface::surface_for_role(&full, role, grants); + graphql_sdl_from_surface(&role_surface) +} + fn surface_options_to_sdl(surface: &super::surface::Surface) -> SdlOptions { SdlOptions { aggregates: surface.aggregates, diff --git a/src/graphql/surface.rs b/src/graphql/surface.rs index 617f2fca..39431c8a 100644 --- a/src/graphql/surface.rs +++ b/src/graphql/surface.rs @@ -718,4 +718,64 @@ mod tests { .relationships .is_empty()); } + + /// Production path: build_surface → surface_for_role → SDL (gap A10). + #[test] + fn role_sdl_production_path_omits_ungranted_columns() { + use super::super::sdl::{graphql_sdl_for_role, SdlOptions}; + + let mut grants = BTreeMap::new(); + grants.insert( + "OrderView".to_string(), + RoleGrant::columns(["order_id", "status"]), + ); + let sdl = graphql_sdl_for_role( + &[orders()], + &SdlOptions::sqlite(), + "user", + &grants, + ) + .expect("role sdl"); + + // Granted + assert!( + sdl.contains("order_id") && sdl.contains("status"), + "expected granted columns in SDL: {sdl}" + ); + // Ungranted column fields must not appear on the object type body. + // (meta / customer_id were not granted) + assert!( + !sdl.contains("customer_id"), + "ungranted customer_id leaked into role SDL: {sdl}" + ); + assert!( + !sdl.contains("meta"), + "ungranted meta leaked into role SDL: {sdl}" + ); + // SQLite: no PG JSON ops even if JSON columns were granted + for forbidden in ["_contains", "_contained_in", "_has_key"] { + assert!( + !sdl.contains(forbidden), + "SQLite role SDL must not expose {forbidden}" + ); + } + } + + #[test] + fn role_sdl_empty_grants_has_no_query_roots() { + use super::super::sdl::{graphql_sdl_for_role, SdlOptions}; + + let sdl = graphql_sdl_for_role( + &[orders()], + &SdlOptions::sqlite(), + "anon", + &BTreeMap::new(), + ) + .expect("empty role sdl"); + // No list roots for orders when model ungranted + assert!( + !sdl.contains("orders(") && !sdl.contains("orders:"), + "empty grants should not expose orders roots: {sdl}" + ); + } } diff --git a/tests/e2e-ui/Makefile b/tests/e2e-ui/Makefile index e9617472..f03ac3a0 100644 --- a/tests/e2e-ui/Makefile +++ b/tests/e2e-ui/Makefile @@ -45,7 +45,7 @@ run: ui-install lsof -ti:$${_ui_port} 2>/dev/null | xargs kill -9 2>/dev/null || true; \ rm -f .make-runner.pid .make-ui.pid .make-runner.log; \ echo "starting API ($${DATABASE_URL:-sqlite}) on $$_base …"; \ - cargo run -p e2e-runner > .make-runner.log 2>&1 & \ + cargo run -p e2e-runner --bin e2e-ui > .make-runner.log 2>&1 & \ echo $$! > .make-runner.pid; \ ok=0; \ for i in $$(seq 1 80); do \ diff --git a/tests/e2e-ui/ui/src/lib/gql/cache-helpers.ts b/tests/e2e-ui/ui/src/lib/gql/cache-helpers.ts deleted file mode 100644 index c80c7812..00000000 --- a/tests/e2e-ui/ui/src/lib/gql/cache-helpers.ts +++ /dev/null @@ -1,53 +0,0 @@ -/** - * Small helpers for pages that seed / read a document-keyed QueryCache. - */ -import type { QueryCache } from './cache/query-cache.ts'; -import { cacheKey } from './cache/query-cache.ts'; -import { documentToString, type GqlDocument } from './document.ts'; - -export function seedQueryCache( - cache: QueryCache, - document: GqlDocument, - data: T, - variables?: Record -): string { - const key = cacheKey(documentToString(document), variables); - cache.set(key, { - data, - updatedAt: Date.now(), - optimistic: false, - pending: false - }); - return key; -} - -export function readQueryList( - cache: QueryCache, - document: GqlDocument, - at: string, - variables?: Record -): T[] { - const key = cacheKey(documentToString(document), variables); - const entry = cache.get>(key); - const list = entry?.data?.[at]; - return Array.isArray(list) ? (list as T[]) : []; -} - -export function queryDocString(document: GqlDocument): string { - return documentToString(document); -} - -/** List target for optimistic upserts / projection apply. */ -export function listTarget( - document: GqlDocument, - at: string, - by: string, - variables?: Record -) { - return { - document: documentToString(document), - variables, - at, - by - }; -} diff --git a/tests/e2e-ui/ui/src/lib/gql/cache/index.ts b/tests/e2e-ui/ui/src/lib/gql/cache/index.ts index e1133310..e87b7741 100644 --- a/tests/e2e-ui/ui/src/lib/gql/cache/index.ts +++ b/tests/e2e-ui/ui/src/lib/gql/cache/index.ts @@ -11,6 +11,8 @@ export { type CommandPolicy, type Effect, type ResultKind, - type ReconcileKind + type ReconcileKind, + type ListMergeSpec, + type WriteServerOptions } from './ops.ts'; export { runCommandPipeline, type CommandPipelineOptions, type PipelineDeps } from './pipeline.ts'; diff --git a/tests/e2e-ui/ui/src/lib/gql/cache/ops.ts b/tests/e2e-ui/ui/src/lib/gql/cache/ops.ts index 8665438c..e0b96229 100644 --- a/tests/e2e-ui/ui/src/lib/gql/cache/ops.ts +++ b/tests/e2e-ui/ui/src/lib/gql/cache/ops.ts @@ -59,9 +59,23 @@ export const fx = { export type ResultKind = 'ack' | 'fact' | 'projection' | 'none'; export type ReconcileKind = 'subscription' | 'refetch' | 'invalidate' | 'none'; +/** How to merge server list data under pending optimistic rows (required for list docs). */ +export type ListMergeSpec = { + /** Dot path to the list on the document, e.g. `"todos"`. */ + at: string; + /** Primary key field on each row, e.g. `"todo_id"`. */ + by: string; +}; + export type CommandPolicy = { result?: { kind: ResultKind; apply?: { targets: CacheTarget[] } }; - reconcile?: { kind: ReconcileKind; document?: string; variables?: Record }; + reconcile?: { + kind: ReconcileKind; + document?: string; + variables?: Record; + /** Required when reconciling list documents with pending optimistic rows. */ + list?: ListMergeSpec; + }; optimistic?: { targets: CacheTarget[]; row?: Record; @@ -233,6 +247,15 @@ export function applyProjectionPayload( return applyCacheOps(cache, ops); } +export type WriteServerOptions = { + /** + * List merge for pending/optimistic entries. + * **Required** for list documents under pending — no silent `todos`/`todo_id` guessing. + * When omitted while pending, local cache is left unchanged (safe). + */ + list?: ListMergeSpec; +}; + /** * Write a server query/subscription payload into the cache **without** clobbering * optimistic rows that the projector has not caught up to yet. @@ -245,9 +268,7 @@ export function writeServerDataPreservingPending( document: string, variables: Record | undefined, serverData: unknown, - /** List path on the document, e.g. "todos". When omitted, tries common roots. */ - listPath?: string, - by = 'todo_id' + options?: WriteServerOptions ): void { const key = cacheKey(document, variables); const prev = cache.get(key); @@ -274,19 +295,15 @@ export function writeServerDataPreservingPending( return; } - const path = - listPath ?? - (Array.isArray((serverData as Record).todos) - ? 'todos' - : Array.isArray((serverData as Record).chat_messages) - ? 'chat_messages' - : undefined); - - if (!path) { - // Non-list document: keep pending local data + const list = options?.list; + if (!list?.at || !list?.by) { + // No explicit list merge — never invent path/PK; keep pending local data. return; } + const path = list.at; + const by = list.by; + const serverList = getAt(serverData, path); const localList = getAt(prevData, path); if (!Array.isArray(serverList) || !Array.isArray(localList)) { diff --git a/tests/e2e-ui/ui/src/lib/gql/cache/pipeline.ts b/tests/e2e-ui/ui/src/lib/gql/cache/pipeline.ts index 9ec10a85..e6366d92 100644 --- a/tests/e2e-ui/ui/src/lib/gql/cache/pipeline.ts +++ b/tests/e2e-ui/ui/src/lib/gql/cache/pipeline.ts @@ -179,11 +179,13 @@ export async function runCommandPipeline>( if (browser && merged.reconcileKind === 'refetch' && merged.reconcileDoc && deps.refetch) { const refetched = await deps.refetch(merged.reconcileDoc, merged.reconcileVars); if (refetched.data && !refetched.errors?.length) { + const reconcileList = (opts.reconcile ?? opts.policy?.reconcile)?.list; writeServerDataPreservingPending( deps.cache, merged.reconcileDoc, merged.reconcileVars, - refetched.data + refetched.data, + reconcileList ? { list: reconcileList } : undefined ); } } else if (browser && merged.reconcileKind === 'invalidate' && merged.reconcileDoc) { diff --git a/tests/e2e-ui/ui/src/lib/gql/command-policies.ts b/tests/e2e-ui/ui/src/lib/gql/command-policies.ts new file mode 100644 index 00000000..d544f137 --- /dev/null +++ b/tests/e2e-ui/ui/src/lib/gql/command-policies.ts @@ -0,0 +1,38 @@ +/** + * Default command result/reconcile policies for e2e-ui. + * Async projectors → fact + reconcile none (no immediate refetch). + * Call sites override with optimistic / onError only. + */ +import type { CommandPolicyMap } from './bind-commands-pipeline.ts'; + +/** Shared defaults for todos + chat (async projector topology). */ +export const e2eCommandPolicies: CommandPolicyMap = { + todosCreate: { + result: { kind: 'fact' }, + reconcile: { kind: 'none' } + }, + todosComplete: { + result: { kind: 'fact' }, + reconcile: { kind: 'none' } + }, + todosArchive: { + result: { kind: 'fact' }, + reconcile: { kind: 'none' } + }, + todosForceArchive: { + result: { kind: 'fact' }, + reconcile: { kind: 'none' } + }, + todosRename: { + result: { kind: 'fact' }, + reconcile: { kind: 'none' } + }, + todosReopen: { + result: { kind: 'fact' }, + reconcile: { kind: 'none' } + }, + chatMessagesPost: { + result: { kind: 'fact' }, + reconcile: { kind: 'subscription' } + } +}; diff --git a/tests/e2e-ui/ui/src/lib/gql/create-client.ts b/tests/e2e-ui/ui/src/lib/gql/create-client.ts index ee5977ec..a06a7c8c 100644 --- a/tests/e2e-ui/ui/src/lib/gql/create-client.ts +++ b/tests/e2e-ui/ui/src/lib/gql/create-client.ts @@ -13,12 +13,15 @@ import type { TypedDocumentNode } from '@graphql-typed-document-node/core'; import { subscribe as subscribeWs, type GqlWsHandlers -} from '$lib/graphql-ws'; +} from '../graphql-ws.ts'; import { requestGraphql, type GqlDocument } from './request.ts'; import { documentToString } from './document.ts'; import type { GqlAuth, GqlResult } from './types.ts'; import type { QueryCache } from './cache/query-cache.ts'; -import { writeServerDataPreservingPending } from './cache/ops.ts'; +import { + writeServerDataPreservingPending, + type ListMergeSpec +} from './cache/ops.ts'; export type GraphqlClientOptions = { /** Absolute API URL or same-origin path, e.g. `/graphql` or `http://127.0.0.1:8791/graphql` */ @@ -30,25 +33,41 @@ export type GraphqlClientOptions = { writeThrough?: boolean; }; +export type SubscribeCallOptions = { + /** Must match document-store / request cache key variables. */ + variables?: Record; + /** List merge for pending optimistic rows on write-through. */ + list?: ListMergeSpec; +}; + export type GraphqlClient = { request: < TResult = Record, TVariables extends Record = Record >( document: GqlDocument | TypedDocumentNode, - variables?: TVariables + variables?: TVariables, + /** Optional list merge for pending write-through. */ + writeOpts?: { list?: ListMergeSpec } ) => Promise>; /** * Live subscription over `/graphql/ws` using the same auth as `request`. * Returns an unsubscribe function (safe to call before the socket opens). - * When a cache is configured, successful payloads write-through by document key. + * When a cache is configured, successful payloads write-through by document+variables key. */ - subscribe: (document: GqlDocument, handlers: GqlWsHandlers) => () => void; + subscribe: ( + document: GqlDocument, + handlers: GqlWsHandlers, + options?: SubscribeCallOptions + ) => () => void; /** Shared query cache when configured on the client. */ cache?: QueryCache; }; -function looksLikeMutation(document: GqlDocument | TypedDocumentNode): boolean { +/** Exported for unit tests — mutation responses must not write-through as query data. */ +export function looksLikeMutation( + document: GqlDocument | TypedDocumentNode +): boolean { const src = documentToString(document as GqlDocument).trimStart(); return /^mutation[\s({]/i.test(src); } @@ -63,7 +82,8 @@ export function createGraphqlClient(opts: GraphqlClientOptions): GraphqlClient { TVariables extends Record = Record >( document: GqlDocument | TypedDocumentNode, - variables?: TVariables + variables?: TVariables, + writeOpts?: { list?: ListMergeSpec } ): Promise> { const auth = await opts.getAuth(); const result = await requestGraphql( @@ -85,14 +105,17 @@ export function createGraphqlClient(opts: GraphqlClientOptions): GraphqlClient { opts.cache, documentToString(document as GqlDocument), (variables ?? {}) as Record, - result.data + result.data, + writeOpts?.list ? { list: writeOpts.list } : undefined ); } return result; }, - subscribe(document, handlers) { + subscribe(document, handlers, callOpts = {}) { let unsub = () => {}; let cancelled = false; + const variables = callOpts.variables ?? {}; + const list = callOpts.list; const wrapped: GqlWsHandlers = { ...handlers, onNext: (payload) => { @@ -105,8 +128,9 @@ export function createGraphqlClient(opts: GraphqlClientOptions): GraphqlClient { writeServerDataPreservingPending( opts.cache, documentToString(document), - {}, - p.data + variables, + p.data, + list ? { list } : undefined ); } } @@ -117,7 +141,8 @@ export function createGraphqlClient(opts: GraphqlClientOptions): GraphqlClient { const auth = await opts.getAuth(); if (cancelled) return; unsub = subscribeWs(document, auth, wrapped, { - httpUrl: opts.getUrl() + httpUrl: opts.getUrl(), + variables }); })(); return () => { diff --git a/tests/e2e-ui/ui/src/lib/gql/document-store.ts b/tests/e2e-ui/ui/src/lib/gql/document-store.ts index d68729f7..10bf7c95 100644 --- a/tests/e2e-ui/ui/src/lib/gql/document-store.ts +++ b/tests/e2e-ui/ui/src/lib/gql/document-store.ts @@ -11,23 +11,18 @@ * * const lobby = gql.live({ * document: chat.subscription ?? chat.query, + * list: { at: 'chat_messages', by: 'message_id' }, * initialData: { chat_messages: data.messages }, * select: (d) => sortChatMessages(d.chat_messages ?? []), * }); * // {$lobby.data} {$lobby.status} - * - * await gql.commands.chatMessagesPost(input, { - * result: { kind: 'fact' }, - * reconcile: { kind: 'subscription', document: lobby.document }, - * optimistic: { targets: [lobby.target('chat_messages', 'message_id')], row }, - * }); */ import type { GqlDocument } from './document.ts'; import { documentToString } from './document.ts'; import type { QueryCache } from './cache/query-cache.ts'; import { cacheKey } from './cache/query-cache.ts'; -import type { CacheTarget } from './cache/ops.ts'; +import type { CacheTarget, ListMergeSpec } from './cache/ops.ts'; import { writeServerDataPreservingPending } from './cache/ops.ts'; import type { GraphqlClient } from './create-client.ts'; @@ -57,6 +52,11 @@ export type DocumentStoreOptions, TSelected = TD * Cache write-through is automatic; UI follows the cache. */ live?: boolean; + /** + * List path + PK for pending merge on refetch / subscription write-through. + * Required for list documents that use optimistic/pending (todos, chat, …). + */ + list?: ListMergeSpec; }; export type DocumentStore = { @@ -67,15 +67,22 @@ export type DocumentStore = { /** GraphQL source string (for command reconcile / policies). */ readonly document: string; readonly variables: Record | undefined; + /** List merge spec when configured. */ + readonly list: ListMergeSpec | undefined; /** Cache target for optimistic list upserts. */ target: (at: string, by: string) => CacheTarget; /** Replace SSR seed / external server data without dropping optimistic if newer. */ seed: (data: unknown) => void; /** Force HTTP refetch of the same document (write-through updates cache → UI). */ refetch: () => Promise; + /** + * Soft catch-up after async projectors. Cancelled on `destroy()`. + * Never use as command-path reconcile: 'refetch'. + */ + scheduleCatchUp: (delayMs?: number) => void; /** (Re)connect live subscription. */ connect: () => void; - /** Tear down cache listener + WS. Call from onDestroy. */ + /** Tear down cache listener + WS + catch-up timer. Call from onDestroy. */ destroy: () => void; }; @@ -95,11 +102,11 @@ export function createDocumentStore, TSelected = if (cache === undefined) { throw new Error('createDocumentStore requires a GraphqlClient with cache'); } - // Narrow for TS after the guard (client.cache is optional on the type). const qcache: QueryCache = cache; const docStr = documentToString(options.document); const variables = options.variables; + const list = options.list; const key = cacheKey(docStr, variables); const select = (options.select ?? identity) as (data: TData) => TSelected; @@ -108,12 +115,9 @@ export function createDocumentStore, TSelected = let error: string | null = null; let unsubCache: (() => void) | null = null; let unsubWs: (() => void) | null = null; + let catchUpTimer: ReturnType | null = null; let destroyed = false; - function readRaw(): unknown { - return qcache.get(key)?.data; - } - function snapshot(): DocumentStoreSnapshot { const entry = qcache.get(key); const raw = (entry?.data ?? options.initialData ?? null) as TData; @@ -140,7 +144,6 @@ export function createDocumentStore, TSelected = function seed(data: unknown) { if (destroyed) return; - // Don't clobber a fresher optimistic/pending entry with older SSR. const existing = qcache.get(key); if (existing?.optimistic || existing?.pending) { emit(); @@ -154,7 +157,6 @@ export function createDocumentStore, TSelected = }); } - // Initial seed if (options.initialData !== undefined) { seed(options.initialData); } @@ -167,74 +169,99 @@ export function createDocumentStore, TSelected = status = 'connecting'; error = null; emit(); - unsubWs = client.subscribe(options.document, { - onNext: (payload) => { - const p = payload as { data?: unknown; errors?: Array<{ message?: string }> }; - if (p?.errors?.length) { + unsubWs = client.subscribe( + options.document, + { + onNext: (payload) => { + const p = payload as { data?: unknown; errors?: Array<{ message?: string }> }; + if (p?.errors?.length) { + status = 'error'; + error = p.errors[0]?.message ?? 'subscription error'; + emit(); + return; + } + if (p?.data !== undefined) { + status = 'live'; + error = null; + // createClient write-through uses same variables+list; emit if already present + if (!qcache.get(key)?.data && p.data) { + qcache.set(key, { + data: p.data, + updatedAt: Date.now(), + optimistic: false, + pending: false + }); + } else { + emit(); + } + } + }, + onError: (e) => { status = 'error'; - error = p.errors[0]?.message ?? 'subscription error'; - emit(); - return; - } - // createClient already write-throughs data into cache; just mark live. - if (p?.data !== undefined) { - status = 'live'; - error = null; - // Ensure write-through even if client was built without cache (defensive) - if (!qcache.get(key)?.data && p.data) { - qcache.set(key, { - data: p.data, - updatedAt: Date.now(), - optimistic: false, - pending: false - }); + if (e instanceof Event) { + error = 'WebSocket error — is the API running?'; + } else if (Array.isArray(e)) { + error = JSON.stringify(e); } else { + error = String(e); + } + emit(); + }, + onComplete: () => { + if (status === 'live') { + status = 'connecting'; emit(); } } }, - onError: (e) => { - status = 'error'; - if (e instanceof Event) { - error = 'WebSocket error — is the API running?'; - } else if (Array.isArray(e)) { - error = JSON.stringify(e); - } else { - error = String(e); - } - emit(); - }, - onComplete: () => { - if (status === 'live') { - status = 'connecting'; - emit(); - } - } - }); + { variables, list } + ); } if (options.live && typeof window !== 'undefined') { - // Defer to next microtask so callers can attach subscribe first. queueMicrotask(() => { if (!destroyed) connect(); }); } async function refetch() { - const result = await client.request(options.document, variables as never); + if (destroyed) return; + const result = await client.request( + options.document, + variables as never, + list ? { list } : undefined + ); + if (destroyed) return; if (result.errors?.length) { error = result.errors[0]?.message ?? 'refetch failed'; emit(); return; } - // Merge server data under pending optimistic rows (async projectors). if (result.data !== undefined && result.data !== null) { - writeServerDataPreservingPending(qcache, docStr, variables, result.data); + writeServerDataPreservingPending( + qcache, + docStr, + variables, + result.data, + list ? { list } : undefined + ); } error = null; emit(); } + function scheduleCatchUp(delayMs = 800) { + if (destroyed) return; + if (catchUpTimer !== null) { + clearTimeout(catchUpTimer); + catchUpTimer = null; + } + catchUpTimer = setTimeout(() => { + catchUpTimer = null; + if (!destroyed) void refetch(); + }, delayMs); + } + return { subscribe(run) { listeners.add(run); @@ -246,14 +273,20 @@ export function createDocumentStore, TSelected = get: snapshot, document: docStr, variables, + list, target(at: string, by: string): CacheTarget { return { document: docStr, variables, at, by }; }, seed, refetch, + scheduleCatchUp, connect, destroy() { destroyed = true; + if (catchUpTimer !== null) { + clearTimeout(catchUpTimer); + catchUpTimer = null; + } unsubCache?.(); unsubCache = null; unsubWs?.(); diff --git a/tests/e2e-ui/ui/src/lib/gql/index.ts b/tests/e2e-ui/ui/src/lib/gql/index.ts index 20cdb93a..f73f5dc3 100644 --- a/tests/e2e-ui/ui/src/lib/gql/index.ts +++ b/tests/e2e-ui/ui/src/lib/gql/index.ts @@ -56,10 +56,4 @@ export type { StoreStatus } from './document-store.ts'; -/** Escape-hatch cache helpers — prefer `gql.store` / `gql.live`. */ -export { - seedQueryCache, - readQueryList, - queryDocString, - listTarget -} from './cache-helpers.ts'; +export { e2eCommandPolicies } from './command-policies.ts'; diff --git a/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts b/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts index fa198938..aa7dc4f6 100644 --- a/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts +++ b/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts @@ -6,7 +6,7 @@ * - `request` / `subscribe` write-through into the cache * - `gql.commands.*` pipeline patches the same cache keys * - * Pages should not call seedQueryCache / cache.subscribe by hand. + * Pages should not call manual cache seed helpers by hand — use gql.store / gql.live. */ import { createGraphqlClient, type GraphqlClient } from './create-client.ts'; import { authFromPageData, type PageGraphqlData } from './auth-from-page.ts'; @@ -22,9 +22,11 @@ import { type DocumentStore, type DocumentStoreOptions } from './document-store.ts'; +import { e2eCommandPolicies } from './command-policies.ts'; export type { PageGraphqlData } from './auth-from-page.ts'; export { authFromPageData } from './auth-from-page.ts'; +export { e2eCommandPolicies } from './command-policies.ts'; /** Bound HTTP + WS client with pipelined commands + document stores. */ export type AppGraphqlClient = GraphqlClient & { @@ -69,12 +71,11 @@ export type UseGraphqlOptions = { * // {$lobby.data} {$lobby.status} * onDestroy(() => lobby.destroy()); * - * @example Command with optimistic list patch + * @example Command with optimistic list patch (policies default fact + none) * await gql.commands.todosCreate(input, { - * result: { kind: 'fact' }, - * reconcile: { kind: 'none' }, // async projectors — do not refetch on command success * optimistic: { targets: [list.target('todos', 'todo_id')], row }, * }); + * list.scheduleCatchUp(); // soft delayed refetch after projector lag */ export function useGraphql( getData: () => PageGraphqlData, @@ -108,7 +109,7 @@ export function useGraphql( // GraphqlClient.request is a structural match for CommandClient. commands: bindCommandsPipeline(client as import('$lib/api/commands.generated').CommandClient, { cache, - policies: options.policies, + policies: options.policies ?? e2eCommandPolicies, runEffects: options.runEffects }) }; diff --git a/tests/e2e-ui/ui/src/lib/graphql-ws.ts b/tests/e2e-ui/ui/src/lib/graphql-ws.ts index c736aea9..ed8dd526 100644 --- a/tests/e2e-ui/ui/src/lib/graphql-ws.ts +++ b/tests/e2e-ui/ui/src/lib/graphql-ws.ts @@ -22,6 +22,8 @@ export type SubscribeOptions = { * Used to derive the WebSocket endpoint (`…/graphql/ws`). */ httpUrl?: string; + /** GraphQL variables for the subscription operation (must match document-store cache key). */ + variables?: Record; }; /** Same-origin WS path (Vite proxies `/graphql` including `/graphql/ws`). */ @@ -99,7 +101,10 @@ export function subscribe( JSON.stringify({ type: 'subscribe', id: opId, - payload: { query } + payload: { + query, + variables: options.variables ?? {} + } }) ); break; diff --git a/tests/e2e-ui/ui/src/routes/admin/+page.svelte b/tests/e2e-ui/ui/src/routes/admin/+page.svelte index a7b94dcd..6b031b3e 100644 --- a/tests/e2e-ui/ui/src/routes/admin/+page.svelte +++ b/tests/e2e-ui/ui/src/routes/admin/+page.svelte @@ -26,6 +26,7 @@ const list = gql.store({ document: adminTodos.query, + list: { at: 'todos', by: 'todo_id' }, initialData: { todos: data.todos ?? [] }, select: (d: { todos?: AdminTodoRow[] }) => d?.todos ?? [] }); @@ -50,9 +51,6 @@ const result = await gql.commands.todosForceArchive( { todo_id }, { - result: { kind: 'fact' }, - // Async projector — never refetch on the command path. - reconcile: { kind: 'none' }, optimistic: { targets: [list.target('todos', 'todo_id')], row: { ...target, status: 'archived' } @@ -68,10 +66,7 @@ if (!actionError) actionError = result.errors?.[0]?.message ?? 'force archive failed'; return; } - // Soft catch-up after projector lag (not on the command success path). - window.setTimeout(() => { - void list.refetch(); - }, 800); + list.scheduleCatchUp(); } diff --git a/tests/e2e-ui/ui/src/routes/chat/+page.svelte b/tests/e2e-ui/ui/src/routes/chat/+page.svelte index 6548f4e1..a8340585 100644 --- a/tests/e2e-ui/ui/src/routes/chat/+page.svelte +++ b/tests/e2e-ui/ui/src/routes/chat/+page.svelte @@ -32,6 +32,7 @@ /** Cache + live subscription — no manual seed/subscribe/sync. */ const lobby = gql.live({ document: subDoc, + list: { at: 'chat_messages', by: 'message_id' }, initialData: { chat_messages: data.messages ?? [] }, select: (d: { chat_messages?: ChatMsg[] }) => sortChatMessages(d?.chat_messages ?? []) @@ -87,9 +88,7 @@ const result = await gql.commands.chatMessagesPost( { message_id, body, room_id: data.room }, { - result: { kind: 'fact' }, - // Sub already live — no extra network; optimistic stays until push. - reconcile: { kind: 'subscription', document: lobby.document }, + // Policies default fact + subscription; sub is already live. optimistic: { targets: [lobby.target('chat_messages', 'message_id')], row: optimisticRow diff --git a/tests/e2e-ui/ui/src/routes/todos/+page.svelte b/tests/e2e-ui/ui/src/routes/todos/+page.svelte index 0b226463..4d3f8670 100644 --- a/tests/e2e-ui/ui/src/routes/todos/+page.svelte +++ b/tests/e2e-ui/ui/src/routes/todos/+page.svelte @@ -40,6 +40,7 @@ const list = gql.store({ document: todosResource.query, + list: { at: 'todos', by: 'todo_id' }, initialData: { todos: data.todos ?? [] }, select: (d: { todos?: Todo[] }) => sortTodos(d?.todos ?? []) }); @@ -62,19 +63,6 @@ return `t-${rand}`; } - // Never reconcile: 'refetch' on the command path — RM is not ready yet. - const factOpts = { - result: { kind: 'fact' as const }, - reconcile: { kind: 'none' as const } - }; - - /** After projector lag, refresh cache (merge preserves optimistic if still ahead). */ - function scheduleProjectorCatchUp() { - window.setTimeout(() => { - void list.refetch(); - }, 800); - } - async function onCreate(e: Event) { e.preventDefault(); const text = title.trim(); @@ -88,7 +76,6 @@ const result = await gql.commands.todosCreate( { todo_id, title: text }, { - ...factOpts, optimistic: { targets: [list.target('todos', 'todo_id')], row: { @@ -107,7 +94,7 @@ if (!actionError) actionError = result.errors?.[0]?.message ?? 'create failed'; return; } - scheduleProjectorCatchUp(); + list.scheduleCatchUp(); } async function onComplete(todo_id: string) { @@ -121,7 +108,6 @@ const result = await gql.commands.todosComplete( { todo_id }, { - ...factOpts, optimistic: { targets: [list.target('todos', 'todo_id')], row: { ...target, status: 'completed' } @@ -135,7 +121,7 @@ if (!actionError) actionError = result.errors?.[0]?.message ?? 'complete failed'; return; } - scheduleProjectorCatchUp(); + list.scheduleCatchUp(); } async function onArchive(todo_id: string) { @@ -149,7 +135,6 @@ const result = await gql.commands.todosArchive( { todo_id }, { - ...factOpts, optimistic: { targets: [list.target('todos', 'todo_id')], row: { ...target, status: 'archived' } @@ -163,7 +148,7 @@ if (!actionError) actionError = result.errors?.[0]?.message ?? 'archive failed'; return; } - scheduleProjectorCatchUp(); + list.scheduleCatchUp(); } diff --git a/tests/e2e-ui/ui/tests/api-contract.test.mjs b/tests/e2e-ui/ui/tests/api-contract.test.mjs index 76303ebc..79af3c55 100644 --- a/tests/e2e-ui/ui/tests/api-contract.test.mjs +++ b/tests/e2e-ui/ui/tests/api-contract.test.mjs @@ -265,12 +265,12 @@ test('todos: co-located .gql + resource — same query SSR + browser mutations', assert.match(useGql, /createGraphqlClient|\/graphql/); const page = fs.readFileSync(new URL('../src/routes/todos/+page.svelte', import.meta.url), 'utf8'); - // Document store (Houdini-style) — cache transparent + // Document store (Houdini-style) — cache transparent; policies from e2eCommandPolicies assert.match(page, /gql\.store\s*\(/); assert.match(page, /\$list\.data/); assert.match(page, /optimistic:/); - assert.match(page, /result:\s*\{\s*kind:\s*'fact'/); - assert.match(page, /reconcile:\s*\{\s*kind:\s*'none'/); + assert.match(page, /list:\s*\{\s*at:\s*'todos'/); + assert.match(page, /scheduleCatchUp/); assert.doesNotMatch(page, /function mergeFromServer|seedQueryCache|readQueryList/); assert.match(page, /useGraphql/); assert.match(page, /todos\.resource|todosResource|from '\.\/todos\.resource'/); @@ -280,7 +280,21 @@ test('todos: co-located .gql + resource — same query SSR + browser mutations', assert.match(page, /gql\.commands\.todosArchive/); assert.doesNotMatch(page, /mutations\.(create|complete|archive)/); assert.doesNotMatch(page, /use:enhance|\?\/create|export const actions/); - assert.match(page, /useGraphql|list\.refetch|todosCreate/); + assert.match(page, /useGraphql|todosCreate/); + + const policies = fs.readFileSync( + new URL('../src/lib/gql/command-policies.ts', import.meta.url), + 'utf8' + ); + assert.match(policies, /e2eCommandPolicies/); + assert.match(policies, /kind:\s*'fact'/); + assert.match(policies, /kind:\s*'none'/); + + const useGqlFull = fs.readFileSync( + new URL('../src/lib/gql/use-graphql.ts', import.meta.url), + 'utf8' + ); + assert.match(useGqlFull, /e2eCommandPolicies/); const server = fs.readFileSync( new URL('../src/routes/todos/+page.server.ts', import.meta.url), @@ -435,5 +449,6 @@ test('useGraphql attaches pipeline commands + store/live helpers', () => { assert.match(use, /createDocumentStore|\.store\s*=|\bstore\b/); assert.match(use, /\blive\b/); assert.match(use, /AppGraphqlClient/); + assert.match(use, /e2eCommandPolicies/); }); diff --git a/tests/e2e-ui/ui/tests/command-client.test.mjs b/tests/e2e-ui/ui/tests/command-client.test.mjs index 75734939..a1e6991e 100644 --- a/tests/e2e-ui/ui/tests/command-client.test.mjs +++ b/tests/e2e-ui/ui/tests/command-client.test.mjs @@ -98,19 +98,27 @@ test('app pages use gql.store/live + commands pipeline (cache transparent)', () assert.match(todos, /gql\.commands\.todosCreate/); assert.match(todos, /gql\.commands\.todosComplete/); assert.match(todos, /gql\.commands\.todosArchive/); - assert.match(todos, /result:\s*\{\s*kind:\s*'fact'/); - assert.match(todos, /reconcile:\s*\{\s*kind:\s*'none'/); + assert.match(todos, /list:\s*\{\s*at:\s*'todos',\s*by:\s*'todo_id'/); + assert.match(todos, /list\.scheduleCatchUp|scheduleCatchUp/); assert.match(todos, /list\.target\(/); assert.doesNotMatch(todos, /seedQueryCache|readQueryList|syncFromCache/); assert.doesNotMatch(todos, /from '\$lib\/api\/commands\.generated'/); assert.doesNotMatch(todos, /function mergeFromServer/); + const policies = fs.readFileSync( + path.join(uiRoot, 'src/lib/gql/command-policies.ts'), + 'utf8' + ); + assert.match(policies, /todosCreate/); + assert.match(policies, /kind:\s*'fact'/); + assert.match(policies, /kind:\s*'none'/); + const chat = fs.readFileSync(path.join(uiRoot, 'src/routes/chat/+page.svelte'), 'utf8'); assert.match(chat, /gql\.live\s*\(/); assert.match(chat, /\$lobby\.(data|status)/); assert.match(chat, /gql\.commands\.chatMessagesPost/); assert.match(chat, /lobby\.target\(/); - assert.match(chat, /reconcile:\s*\{\s*kind:\s*'subscription'/); + assert.match(chat, /list:\s*\{\s*at:\s*'chat_messages'/); assert.doesNotMatch(chat, /seedQueryCache|gql\.subscribe\s*\(/); assert.doesNotMatch(chat, /from '\$lib\/api\/commands\.generated'/); @@ -118,7 +126,7 @@ test('app pages use gql.store/live + commands pipeline (cache transparent)', () assert.match(admin, /gql\.store\s*\(/); assert.match(admin, /gql\.commands\.todosForceArchive/); assert.match(admin, /list\.target\(/); - assert.match(admin, /reconcile:\s*\{\s*kind:\s*'none'/); + assert.match(admin, /scheduleCatchUp/); assert.doesNotMatch(admin, /seedQueryCache|readQueryList/); }); diff --git a/tests/e2e-ui/ui/tests/command-pipeline.test.mjs b/tests/e2e-ui/ui/tests/command-pipeline.test.mjs index a1a9da3e..93f1d6f7 100644 --- a/tests/e2e-ui/ui/tests/command-pipeline.test.mjs +++ b/tests/e2e-ui/ui/tests/command-pipeline.test.mjs @@ -42,3 +42,13 @@ test('pipeline unit suite (strip-types)', () => { `pipeline unit runner failed:\n${r.stdout}\n${r.stderr}` ); }); + +test('systems-harden unit suite (strip-types)', () => { + const harden = path.join(uiRoot, 'tests/systems-harden-unit.mjs'); + const hr = spawnSync(process.execPath, ['--experimental-strip-types', harden], { + encoding: 'utf8', + cwd: uiRoot + }); + assert.equal(hr.status, 0, `systems-harden unit failed:\n${hr.stdout}\n${hr.stderr}`); + assert.match(hr.stdout, /# pass|# tests|ok -/); +}); diff --git a/tests/e2e-ui/ui/tests/systems-harden-unit.mjs b/tests/e2e-ui/ui/tests/systems-harden-unit.mjs new file mode 100644 index 00000000..fa6186a7 --- /dev/null +++ b/tests/e2e-ui/ui/tests/systems-harden-unit.mjs @@ -0,0 +1,411 @@ +/** + * Systems-harden unit pack — drives shipped e2e-ui gql modules. + * Run: node --experimental-strip-types tests/systems-harden-unit.mjs + * (from tests/e2e-ui/ui) + */ +import assert from 'node:assert/strict'; +import { + QueryCache, + cacheKey, + applyCacheOps, + writeServerDataPreservingPending, + runCommandPipeline, + fx, + applyProjectionPayload +} from '../src/lib/gql/cache/index.ts'; +import { buildAuthHeaders, wsConnectionInitPayload } from '../src/lib/gql/auth-headers.ts'; +import { authFromPageData } from '../src/lib/gql/auth-from-page.ts'; +import { looksLikeMutation, createGraphqlClient } from '../src/lib/gql/create-client.ts'; +import { createDocumentStore } from '../src/lib/gql/document-store.ts'; +import { e2eCommandPolicies } from '../src/lib/gql/command-policies.ts'; +import { bindCommandsPipeline } from '../src/lib/gql/bind-commands-pipeline.ts'; + +const TODOS_DOC = 'query Todos { todos { todo_id title status } }'; +const CREATE_DOC = + 'mutation TodosCreate($input: TodosCreateInput!) { todos_create(input: $input) { todo_id } }'; + +let passed = 0; +function check(name, fn) { + try { + fn(); + passed += 1; + console.log(`ok - ${name}`); + } catch (e) { + console.error(`not ok - ${name}`); + console.error(e); + process.exitCode = 1; + } +} + +async function checkAsync(name, fn) { + try { + await fn(); + passed += 1; + console.log(`ok - ${name}`); + } catch (e) { + console.error(`not ok - ${name}`); + console.error(e); + process.exitCode = 1; + } +} + +// --- C-U1 cacheKey --- +check('C-U1 cacheKey empty vars equivalent', () => { + const a = cacheKey(TODOS_DOC); + const b = cacheKey(TODOS_DOC, {}); + const c = cacheKey(TODOS_DOC, undefined); + assert.equal(a, b); + assert.equal(a, c); +}); + +check('C-U1 cacheKey variable order stable', () => { + const a = cacheKey(TODOS_DOC, { b: 1, a: 2 }); + const b = cacheKey(TODOS_DOC, { a: 2, b: 1 }); + assert.equal(a, b); +}); + +// --- C-U3 mutation write-through guard --- +check('C-U3 looksLikeMutation detects mutations', () => { + assert.equal(looksLikeMutation('mutation M { x }'), true); + assert.equal(looksLikeMutation('query Q { x }'), false); + assert.equal(looksLikeMutation(' mutation { x }'), true); +}); + +await checkAsync('C-U3 createClient request does not write-through mutations', async () => { + const cache = new QueryCache(); + const key = cacheKey(CREATE_DOC, { input: { todo_id: '1' } }); + let fetchCalls = 0; + const orig = globalThis.fetch; + globalThis.fetch = async () => { + fetchCalls += 1; + return { + status: 200, + json: async () => ({ data: { todos_create: { todo_id: '1' } } }) + }; + }; + try { + const client = createGraphqlClient({ + getUrl: () => 'http://example.test/graphql', + getAuth: () => ({ accessToken: 'tok' }), + cache, + writeThrough: true + }); + await client.request(CREATE_DOC, { input: { todo_id: '1' } }); + assert.equal(fetchCalls, 1); + assert.equal(cache.get(key), undefined, 'mutation must not write cache key'); + } finally { + globalThis.fetch = orig; + } +}); + +// --- C-U5 projection payload only --- +check('C-U5 projection apply only payload keys merged into row', () => { + const cache = new QueryCache(); + const key = cacheKey(TODOS_DOC, {}); + cache.set(key, { + data: { + todos: [{ todo_id: 'g', title: 'old', status: 'open', secret: 'keep' }] + }, + updatedAt: 1 + }); + applyProjectionPayload( + cache, + [{ document: TODOS_DOC, at: 'todos', by: 'todo_id' }], + { todo_id: 'g', title: 'from-server', owner_id: 'attacker' } + ); + const row = cache.get(key).data.todos.find((t) => t.todo_id === 'g'); + assert.equal(row.title, 'from-server'); + assert.equal(row.owner_id, 'attacker'); // payload key is applied + assert.equal(row.secret, 'keep'); // not in payload — preserved via upsert merge + assert.equal(row.status, 'open'); +}); + +// --- C-U6 network throw rollback --- +await checkAsync('C-U6 network throw rolls back optimistic', async () => { + const cache = new QueryCache(); + const key = cacheKey(TODOS_DOC, {}); + cache.set(key, { data: { todos: [] }, updatedAt: 1 }); + await runCommandPipeline( + { + cache, + request: async () => { + throw new Error('network down'); + } + }, + CREATE_DOC, + { todo_id: 'x' }, + { + browser: true, + optimistic: { + targets: [{ document: TODOS_DOC, at: 'todos', by: 'todo_id' }], + row: { todo_id: 'x', title: 't', status: 'open' } + }, + result: { kind: 'ack' } + } + ); + assert.equal(cache.get(key).data.todos.length, 0); +}); + +// --- C-U8/E5 pending merge archive --- +check('C-U8/E5 pending merge keeps archived over stale open server', () => { + const cache = new QueryCache(); + const key = cacheKey(TODOS_DOC, {}); + cache.set(key, { + data: { + todos: [{ todo_id: 'a', title: 't', status: 'archived' }] + }, + updatedAt: 1, + pending: true, + optimistic: true + }); + writeServerDataPreservingPending( + cache, + TODOS_DOC, + {}, + { todos: [{ todo_id: 'a', title: 't', status: 'open' }] }, + { list: { at: 'todos', by: 'todo_id' } } + ); + const row = cache.get(key).data.todos[0]; + assert.equal(row.status, 'archived'); + assert.equal(cache.get(key).pending, true); +}); + +// --- C-U9 pending clears when equal --- +check('C-U9 pending clears when server matches local', () => { + const cache = new QueryCache(); + const key = cacheKey(TODOS_DOC, {}); + cache.set(key, { + data: { + todos: [{ todo_id: 'a', title: 't', status: 'archived' }] + }, + updatedAt: 1, + pending: true, + optimistic: true + }); + writeServerDataPreservingPending( + cache, + TODOS_DOC, + {}, + { todos: [{ todo_id: 'a', title: 't', status: 'archived' }] }, + { list: { at: 'todos', by: 'todo_id' } } + ); + assert.equal(cache.get(key).pending, false); + assert.equal(cache.get(key).optimistic, false); +}); + +// --- B12 no list without explicit merge --- +check('B12 pending without list options leaves local unchanged', () => { + const cache = new QueryCache(); + const key = cacheKey(TODOS_DOC, {}); + cache.set(key, { + data: { + todos: [{ todo_id: 'a', title: 'local', status: 'archived' }] + }, + updatedAt: 1, + pending: true, + optimistic: true + }); + writeServerDataPreservingPending( + cache, + TODOS_DOC, + {}, + { todos: [{ todo_id: 'a', title: 'server', status: 'open' }] } + // no list options + ); + assert.equal(cache.get(key).data.todos[0].status, 'archived'); + assert.equal(cache.get(key).data.todos[0].title, 'local'); +}); + +// --- C-U12/13 auth --- +check('C-U12 Bearer exclusive — no x-user-id', () => { + const h = buildAuthHeaders({ + accessToken: ' tok ', + userId: 'evil', + role: 'admin' + }); + assert.equal(h.authorization, 'Bearer tok'); + assert.equal(h['x-user-id'], undefined); + assert.equal(h['x-role'], undefined); +}); + +check('C-U12 DevHeaders only without token', () => { + const h = buildAuthHeaders({ userId: 'alice', role: 'user' }); + assert.equal(h.authorization, undefined); + assert.equal(h['x-user-id'], 'alice'); + assert.equal(h['x-role'], 'user'); +}); + +check('C-U12 ws payload Bearer exclusive', () => { + const p = wsConnectionInitPayload({ + accessToken: 'tok', + userId: 'evil', + role: 'admin' + }); + assert.equal(p.authorization, 'Bearer tok'); + assert.equal(p['x-user-id'], undefined); +}); + +check('C-U13 authFromPageData with token has no userId', () => { + const a = authFromPageData({ + accessToken: 'tok', + session: { user: { id: 'u1' } }, + engineRole: 'admin' + }); + assert.equal(a.accessToken, 'tok'); + assert.equal(a.userId, undefined); +}); + +// --- C-U15 variables cache key --- +check('C-U15 write-through with variables hits same key as store seed', () => { + const cache = new QueryCache(); + const vars = { room: 'a' }; + const doc = 'subscription Chat { chat_messages { message_id } }'; + const key = cacheKey(doc, vars); + cache.set(key, { + data: { chat_messages: [] }, + updatedAt: 1, + pending: true, + optimistic: true + }); + // Simulate client subscribe write-through with correct vars + writeServerDataPreservingPending( + cache, + doc, + vars, + { chat_messages: [{ message_id: 'm1', body: 'hi' }] }, + { list: { at: 'chat_messages', by: 'message_id' } } + ); + assert.ok(cache.get(key)); + assert.equal(cache.get(key).data.chat_messages[0].message_id, 'm1'); + // Wrong vars key must remain empty + assert.equal(cache.get(cacheKey(doc, {})), undefined); +}); + +// --- C-U16 browser false --- +await checkAsync('C-U16 browser:false skips optimistic', async () => { + const cache = new QueryCache(); + const key = cacheKey(TODOS_DOC, {}); + cache.set(key, { data: { todos: [] }, updatedAt: 1 }); + await runCommandPipeline( + { + cache, + request: async () => ({ + data: { todos_create: { todo_id: '1' } }, + errors: null + }) + }, + CREATE_DOC, + { todo_id: '1' }, + { + browser: false, + optimistic: { + targets: [{ document: TODOS_DOC, at: 'todos', by: 'todo_id' }], + row: { todo_id: '1', title: 'x', status: 'open' } + }, + result: { kind: 'fact' } + } + ); + assert.equal(cache.get(key).data.todos.length, 0); +}); + +// --- C-U17 effects --- +await checkAsync('C-U17 onSuccess not run on GraphQL errors', async () => { + const effects = []; + await runCommandPipeline( + { + cache: new QueryCache(), + request: async () => ({ data: null, errors: [{ message: 'no' }] }), + runEffects: (e) => effects.push(...e) + }, + CREATE_DOC, + {}, + { + browser: true, + result: { kind: 'ack' }, + onSuccess: () => [fx.toast('Created')], + onError: () => [fx.alert('Failed')] + } + ); + assert.equal(effects.length, 1); + assert.equal(effects[0].kind, 'alert'); +}); + +// --- B13 scheduleCatchUp cancelled on destroy --- +await checkAsync('B13 scheduleCatchUp cancelled on destroy', async () => { + const cache = new QueryCache(); + let requests = 0; + const client = { + cache, + async request() { + requests += 1; + return { data: { todos: [] } }; + }, + subscribe() { + return () => {}; + } + }; + const store = createDocumentStore(client, { + document: TODOS_DOC, + list: { at: 'todos', by: 'todo_id' }, + initialData: { todos: [] } + }); + store.scheduleCatchUp(20); + store.destroy(); + await new Promise((r) => setTimeout(r, 50)); + assert.equal(requests, 0, 'destroyed store must not refetch'); +}); + +// --- policies merge --- +await checkAsync('B9 policy defaults applied; call-site overrides', async () => { + const cache = new QueryCache(); + let lastDoc = ''; + const client = { + async request(document) { + lastDoc = String(document); + return { + data: { + todos_create: { todo_id: '1', title: 't', status: 'open', owner_id: 'a' } + }, + status: 200 + }; + } + }; + const commands = bindCommandsPipeline(client, { + cache, + policies: e2eCommandPolicies + }); + const r = await commands.todosCreate( + { todo_id: '1', title: 't' }, + { + browser: true, + // no result/reconcile — use policy + optimistic: { + targets: [{ document: TODOS_DOC, at: 'todos', by: 'todo_id' }], + row: { todo_id: '1', title: 't', status: 'open', owner_id: 'a' } + } + } + ); + assert.equal(r.data?.todo_id, '1'); + assert.match(lastDoc, /todos_create/); + // pending marked on success with fact + const key = cacheKey(TODOS_DOC, {}); + // may not have key if list never seeded — seed first in real pages + assert.ok(e2eCommandPolicies.todosCreate?.result?.kind === 'fact'); + assert.ok(e2eCommandPolicies.todosCreate?.reconcile?.kind === 'none'); +}); + +// structural: no cache-helpers export +check('B14 index does not export seedQueryCache', async () => { + const fs = await import('node:fs'); + const path = await import('node:path'); + const { fileURLToPath } = await import('node:url'); + const root = path.dirname(fileURLToPath(import.meta.url)); + const idx = fs.readFileSync(path.join(root, '../src/lib/gql/index.ts'), 'utf8'); + assert.doesNotMatch(idx, /seedQueryCache|cache-helpers/); + assert.match(idx, /e2eCommandPolicies/); + assert.ok(!fs.existsSync(path.join(root, '../src/lib/gql/cache-helpers.ts'))); +}); + +console.log(`# tests ${passed}`); +console.log(`# pass ${passed}`); +if (process.exitCode) process.exit(process.exitCode); From dc0d48f37bb28e0bbe680bcc85edd1aff415bc80 Mon Sep 17 00:00:00 2001 From: Patrick Lee Scott Date: Fri, 17 Jul 2026 00:52:49 -0500 Subject: [PATCH 10/20] =?UTF-8?q?feat(graphql):=20prega=20residual=20?= =?UTF-8?q?=E2=80=94=20IR=20grants/runtime,=20export=20dual-check,=20clien?= =?UTF-8?q?t=20B16?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit A12 ReadPermission→RoleGrant; build_role_schema consumes surface IR inventory; A7 role×dialect parity unit; ir_sdl_for_role + export dual-check (A11); invalidate exact-key + cache clear on identity switch (B16); E6 suite docs. Implements [[tasks/graphql-qs-prega-residual-1]] --- src/graphql/engine.rs | 30 +++ src/graphql/mod.rs | 9 +- src/graphql/permissions.rs | 78 +++++- src/graphql/schema.rs | 249 +++++++++++------- src/graphql/surface.rs | 92 +++++++ tests/e2e-ui/README.md | 18 ++ .../crates/runner/src/bin/export_sdl.rs | 125 +++++++-- tests/e2e-ui/ui/schema/admin.graphql | 59 +---- tests/e2e-ui/ui/schema/user.graphql | 59 +---- .../lib/api/commands.operations.generated.ts | 96 +++++++ tests/e2e-ui/ui/src/lib/gql/cache/ops.ts | 1 + .../ui/src/lib/gql/cache/query-cache.ts | 22 +- .../e2e-ui/ui/src/lib/gql/generated/types.ts | 48 ---- tests/e2e-ui/ui/src/lib/gql/use-graphql.ts | 22 +- tests/e2e-ui/ui/tests/systems-harden-unit.mjs | 41 +++ 15 files changed, 668 insertions(+), 281 deletions(-) create mode 100644 tests/e2e-ui/ui/src/lib/api/commands.operations.generated.ts diff --git a/src/graphql/engine.rs b/src/graphql/engine.rs index 77f6342a..cf792505 100644 --- a/src/graphql/engine.rs +++ b/src/graphql/engine.rs @@ -168,6 +168,36 @@ impl GraphqlEngine { self.inner.schemas.get(role).map(|s| s.sdl()) } + /// Dep-free **surface IR** role SDL (A11 production path). + /// + /// Preferred for codegen / `export_sdl`. Uses the same catalog grants as the + /// engine build (A12 mapper). Runtime dump is still available via [`Self::sdl_for_role`]. + pub fn ir_sdl_for_role(&self, role: &str) -> Result { + use super::permissions::role_grants_from_model_role_perms; + use super::sdl::{graphql_sdl_for_role, SdlOptions}; + use super::compile::SqlDialect; + + let tables: Vec<_> = self + .inner + .catalog + .values() + .filter(|e| e.exposed) + .map(|e| e.schema.clone()) + .collect(); + let opts = match self.inner.dialect { + SqlDialect::Sqlite => SdlOptions::sqlite(), + SqlDialect::Postgres => SdlOptions::postgres(), + }; + let grants = role_grants_from_model_role_perms( + role, + self.inner + .permissions + .iter() + .map(|(k, v)| (k, &v.permission)), + ); + graphql_sdl_for_role(&tables, &opts, role, &grants) + } + pub fn graphiql_enabled(&self) -> bool { self.inner.graphiql } diff --git a/src/graphql/mod.rs b/src/graphql/mod.rs index 54965a31..c6c27dbb 100644 --- a/src/graphql/mod.rs +++ b/src/graphql/mod.rs @@ -23,8 +23,8 @@ pub use projection_return::{ projection_return_value, stage_projection_and_payload, ProjectionPayload, }; pub use surface::{ - build_surface, surface_for_role, RoleGrant, RootField, RootKind, Surface, SurfaceDialect, - SurfaceModel, SurfaceOptions, + build_surface, role_grants_for_role, surface_for_role, RoleGrant, RootField, RootKind, Surface, + SurfaceDialect, SurfaceModel, SurfaceOptions, }; #[cfg(feature = "graphql")] @@ -75,7 +75,10 @@ pub use identity::{ UNSET_OIDC_AUDIENCE, UNSET_OIDC_ISSUER, }; #[cfg(feature = "graphql")] -pub use permissions::{read, ModelPermissions, ReadPermission}; +pub use permissions::{ + read, role_grant_from_read_permission, role_grants_from_model_role_perms, ModelPermissions, + ReadPermission, +}; #[cfg(feature = "graphql")] pub use subscribe::ChangeHub; #[cfg(feature = "graphql")] diff --git a/src/graphql/permissions.rs b/src/graphql/permissions.rs index acc6784e..a93ca751 100644 --- a/src/graphql/permissions.rs +++ b/src/graphql/permissions.rs @@ -21,10 +21,11 @@ //! Prefer this vocabulary over “filter” / bare “allow”: grants are roles, //! columns are field allowlists, rows are row scope. -use std::collections::BTreeSet; +use std::collections::{BTreeMap, BTreeSet}; use std::marker::PhantomData; use super::filter::FilterExpr; +use super::surface::RoleGrant; /// Per-role read access for one model. #[derive(Clone, Debug)] @@ -106,6 +107,39 @@ impl ReadPermission { self.columns.clone().unwrap_or_default() } } + + /// Map to feature-free surface IR grant (A12). Row filters / limits stay on + /// [`ReadPermission`] for execute; IR only needs column + aggregation surface. + pub fn to_role_grant(&self) -> RoleGrant { + role_grant_from_read_permission(self) + } +} + +/// Pure A12 mapper: engine [`ReadPermission`] → surface [`RoleGrant`]. +pub fn role_grant_from_read_permission(perm: &ReadPermission) -> RoleGrant { + let mut g = if perm.all_columns { + RoleGrant::all_columns() + } else { + RoleGrant::columns(perm.columns.clone().unwrap_or_default()) + }; + if perm.aggregations { + g = g.with_aggregations(); + } + g +} + +/// Collect IR grants for one role from `(model_name, role) → ReadPermission` pairs. +pub fn role_grants_from_model_role_perms<'a>( + role: &str, + entries: impl IntoIterator, +) -> BTreeMap { + let mut out = BTreeMap::new(); + for ((model, r), perm) in entries { + if r == role { + out.insert(model.clone(), role_grant_from_read_permission(perm)); + } + } + out } /// Typed bag of `(role, ReadPermission)` pairs for one model. @@ -134,3 +168,45 @@ impl ModelPermissions { self } } + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn a12_all_columns_maps() { + let g = role_grant_from_read_permission(&read().all_columns()); + assert!(g.all_columns); + assert!(g.columns.is_empty()); + assert!(!g.aggregations); + } + + #[test] + fn a12_column_list_and_aggregations() { + let g = role_grant_from_read_permission( + &read().columns(["order_id", "status"]).aggregations(), + ); + assert!(!g.all_columns); + assert!(g.columns.contains("order_id")); + assert!(g.columns.contains("status")); + assert!(!g.columns.contains("meta")); + assert!(g.aggregations); + assert!(g.allows_column("order_id")); + assert!(!g.allows_column("meta")); + } + + #[test] + fn a12_role_grants_from_model_role_perms_filters_role() { + let user = read().columns(["a"]); + let admin = read().all_columns().aggregations(); + let key_u = ("M".to_string(), "user".to_string()); + let key_a = ("M".to_string(), "admin".to_string()); + let map = role_grants_from_model_role_perms( + "user", + [(&key_u, &user), (&key_a, &admin)], + ); + assert_eq!(map.len(), 1); + assert!(map["M"].columns.contains("a")); + assert!(!map["M"].all_columns); + } +} diff --git a/src/graphql/schema.rs b/src/graphql/schema.rs index d48066c9..c344421f 100644 --- a/src/graphql/schema.rs +++ b/src/graphql/schema.rs @@ -16,10 +16,13 @@ use super::commands::{CommandInput, CommandOutput, GraphqlCommands}; use super::compile::{self, RootKind, SqlDialect}; use super::engine::{CatalogEntry, EngineInner, RoleModelPerm}; use super::naming::{ - bool_exp_name, by_pk_field, comparison_exp_name, include_postgres_json_comparison_ops, - object_type_name, order_by_name, root_list_field, scalar_type_name, CUSTOM_SCALARS, + bool_exp_name, comparison_exp_name, object_type_name, order_by_name, scalar_type_name, + CUSTOM_SCALARS, +}; +use super::permissions::{role_grants_from_model_role_perms, ReadPermission}; +use super::surface::{ + build_surface, surface_for_role, RootKind as SurfaceRootKind, SurfaceDialect, SurfaceOptions, }; -use super::permissions::ReadPermission; pub fn build_role_schema( role: &str, @@ -34,16 +37,39 @@ pub fn build_role_schema( ) -> Result { let _ = by_table; - // Collect models granted to this role. - let granted: Vec<(&str, &TableSchema, &ReadPermission)> = permissions + // --- A4: field inventory from surface IR (role-filtered) --- + let tables: Vec = catalog + .values() + .filter(|e| e.exposed) + .map(|e| e.schema.clone()) + .collect(); + let surface_opts = SurfaceOptions { + dialect: match dialect { + SqlDialect::Sqlite => SurfaceDialect::Sqlite, + SqlDialect::Postgres => SurfaceDialect::Postgres, + }, + aggregates: true, + subscriptions: true, + }; + let full_surface = build_surface(&tables, &surface_opts)?; + let grants = role_grants_from_model_role_perms( + role, + permissions + .iter() + .map(|(k, v)| (k, &v.permission)), + ); + let role_surface = surface_for_role(&full_surface, role, &grants); + + // Granted models: IR inventory + original ReadPermission (row filters / execute). + let granted: Vec<(String, TableSchema, ReadPermission)> = role_surface + .models .iter() - .filter(|((_, r), _)| r == role) - .filter_map(|((model, _), perm)| { - let entry = catalog.get(model)?; - if !entry.exposed { - return None; - } - Some((model.as_str(), &entry.schema, &perm.permission)) + .filter_map(|(model_name, model)| { + let perm = permissions + .get(&(model_name.clone(), role.to_string())) + .map(|p| p.permission.clone()) + .unwrap_or_else(super::permissions::read); + Some((model_name.clone(), model.schema.clone(), perm)) }) .collect(); @@ -67,11 +93,16 @@ pub fn build_role_schema( .item("desc_nulls_first") .item("desc_nulls_last"); - for (model_name, schema, perm) in &granted { - let model_name = (*model_name).to_string(); - let table = root_list_field(schema).to_string(); - let by_pk = by_pk_field(schema); - let obj_name = object_type_name(schema).to_string(); + // Emit roots only for fields present on the role surface (IR inventory). + for root in &role_surface.query_fields { + let Some((_, schema, perm)) = granted + .iter() + .find(|(m, _, _)| m == &root.model_name) + else { + continue; + }; + let model_name = root.model_name.clone(); + let obj_name = root.object.clone(); let bool_exp = bool_exp_name(schema); let order_by = order_by_name(schema); @@ -95,59 +126,69 @@ pub fn build_role_schema( ); ensure_order_by_input(&mut registered_inputs, schema, perm); - // List root - let model_for_resolver = model_name.clone(); - let list_field = Field::new( - table.clone(), - TypeRef::named_nn_list_nn(obj_name.clone()), - move |ctx| { - let model = model_for_resolver.clone(); - FieldFuture::new(async move { resolve_root(&ctx, &model, RootKind::List).await }) - }, - ) - .argument(InputValue::new("where", TypeRef::named(bool_exp.clone()))) - .argument(InputValue::new( - "order_by", - TypeRef::named_nn_list(order_by.clone()), - )) - .argument(InputValue::new("limit", TypeRef::named(TypeRef::INT))) - .argument(InputValue::new("offset", TypeRef::named(TypeRef::INT))); - query = query.field(list_field); - - // by_pk root - let model_for_pk = model_name.clone(); - let mut pk_field = Field::new(by_pk, TypeRef::named(obj_name.clone()), move |ctx| { - let model = model_for_pk.clone(); - FieldFuture::new(async move { resolve_root(&ctx, &model, RootKind::ByPk).await }) - }); - for pk in &schema.primary_key.columns { - if let Some(col) = schema.columns.iter().find(|c| c.column_name == *pk) { - if let Some(scalar) = scalar_type_name(&col.column_type) { - pk_field = - pk_field.argument(InputValue::new(pk.as_str(), TypeRef::named_nn(scalar))); + match root.kind { + SurfaceRootKind::List => { + let model_for_resolver = model_name.clone(); + let list_field = Field::new( + root.name.clone(), + TypeRef::named_nn_list_nn(obj_name.clone()), + move |ctx| { + let model = model_for_resolver.clone(); + FieldFuture::new(async move { + resolve_root(&ctx, &model, RootKind::List).await + }) + }, + ) + .argument(InputValue::new("where", TypeRef::named(bool_exp.clone()))) + .argument(InputValue::new( + "order_by", + TypeRef::named_nn_list(order_by.clone()), + )) + .argument(InputValue::new("limit", TypeRef::named(TypeRef::INT))) + .argument(InputValue::new("offset", TypeRef::named(TypeRef::INT))); + query = query.field(list_field); + } + SurfaceRootKind::ByPk => { + let model_for_pk = model_name.clone(); + let mut pk_field = + Field::new(root.name.clone(), TypeRef::named(obj_name.clone()), move |ctx| { + let model = model_for_pk.clone(); + FieldFuture::new(async move { + resolve_root(&ctx, &model, RootKind::ByPk).await + }) + }); + for pk in &schema.primary_key.columns { + if let Some(col) = schema.columns.iter().find(|c| c.column_name == *pk) { + if col.skipped { + continue; + } + if let Some(scalar) = scalar_type_name(&col.column_type) { + pk_field = pk_field + .argument(InputValue::new(pk.as_str(), TypeRef::named_nn(scalar))); + } + } } + query = query.field(pk_field); + } + SurfaceRootKind::Aggregate => { + let agg_type = format!("{}_aggregate", schema.table_name); + ensure_aggregate_type(&mut registered_objects, schema); + let model_for_agg = model_name.clone(); + let agg_field = + Field::new(root.name.clone(), TypeRef::named(agg_type), move |ctx| { + let model = model_for_agg.clone(); + FieldFuture::new(async move { + resolve_root(&ctx, &model, RootKind::Aggregate).await + }) + }) + .argument(InputValue::new("where", TypeRef::named(bool_exp))); + query = query.field(agg_field); } - } - query = query.field(pk_field); - - // Aggregate root when allowed - if perm.aggregations { - let agg_name = format!("{}_aggregate", schema.table_name); - let agg_type = format!("{}_aggregate", schema.table_name); - ensure_aggregate_type(&mut registered_objects, schema); - let model_for_agg = model_name.clone(); - let agg_field = Field::new(agg_name, TypeRef::named(agg_type), move |ctx| { - let model = model_for_agg.clone(); - FieldFuture::new( - async move { resolve_root(&ctx, &model, RootKind::Aggregate).await }, - ) - }) - .argument(InputValue::new("where", TypeRef::named(bool_exp))); - query = query.field(agg_field); } } - // Comparison input types for used scalars + // Comparison input types from full-catalog IR (dialect-honest ops). + // Only register when IR lists ops — never emit empty input objects. for scalar in &scalars_needed { if matches!( *scalar, @@ -155,31 +196,24 @@ pub fn build_role_schema( ) { let scalar_name = *scalar; let name = comparison_exp_name(scalar_name); + let ops: Vec = full_surface + .comparison_ops_for_scalar(scalar_name) + .into_iter() + .map(str::to_string) + .collect(); + if ops.is_empty() { + continue; + } registered_inputs.entry(name.clone()).or_insert_with(|| { let mut input = InputObject::new(name); - for op in ["_eq", "_neq", "_gt", "_gte", "_lt", "_lte"] { - input = input.field(InputValue::new(op, TypeRef::named(scalar_name))); - } - // Optional lists: [T!] (not [T!]!) - input = input.field(InputValue::new("_in", TypeRef::named_nn_list(scalar_name))); - input = input.field(InputValue::new("_nin", TypeRef::named_nn_list(scalar_name))); - input = input.field(InputValue::new( - "_is_null", - TypeRef::named(TypeRef::BOOLEAN), - )); - if scalar_name == "String" { - input = input.field(InputValue::new("_like", TypeRef::named("String"))); - input = input.field(InputValue::new("_ilike", TypeRef::named("String"))); - } - // Dialect-honest: PG jsonb ops only when engine dialect is Postgres. - let pg_json = include_postgres_json_comparison_ops(matches!( - dialect, - SqlDialect::Postgres - )); - if scalar_name == "JSON" && pg_json { - input = input.field(InputValue::new("_contains", TypeRef::named("JSON"))); - input = input.field(InputValue::new("_contained_in", TypeRef::named("JSON"))); - input = input.field(InputValue::new("_has_key", TypeRef::named("String"))); + for op in &ops { + let ty = match op.as_str() { + "_is_null" => TypeRef::named(TypeRef::BOOLEAN), + "_in" | "_nin" => TypeRef::named_nn_list(scalar_name), + "_has_key" => TypeRef::named("String"), + _ => TypeRef::named(scalar_name), + }; + input = input.field(InputValue::new(op.as_str(), ty)); } input }); @@ -249,14 +283,24 @@ pub fn build_role_schema( use async_graphql::dynamic::{Subscription, SubscriptionField, SubscriptionFieldFuture}; let mut subscription = Subscription::new("Subscription"); let mut has_subscription = false; - for (model_name, schema, _perm) in &granted { - let table = root_list_field(schema).to_string(); - let obj_name = object_type_name(schema).to_string(); + for sub_root in &role_surface.subscription_fields { + if !matches!(sub_root.kind, SurfaceRootKind::List) { + continue; + } + let Some((_, schema, _)) = granted + .iter() + .find(|(m, _, _)| m == &sub_root.model_name) + else { + continue; + }; let bool_exp = bool_exp_name(schema); let order_by = order_by_name(schema); - let model_for_sub = (*model_name).to_string(); - let field = - SubscriptionField::new(table, TypeRef::named_nn_list_nn(obj_name), move |ctx| { + let model_for_sub = sub_root.model_name.clone(); + let obj_name = sub_root.object.clone(); + let field = SubscriptionField::new( + sub_root.name.clone(), + TypeRef::named_nn_list_nn(obj_name), + move |ctx| { let model = model_for_sub.clone(); // Extract owned data before the async block (stream is 'static). let inner = ctx.data_opt::>().cloned(); @@ -279,14 +323,15 @@ pub fn build_role_schema( .map_err(async_graphql::Error::new)?; Ok(stream) }) - }) - .argument(InputValue::new("where", TypeRef::named(bool_exp))) - .argument(InputValue::new( - "order_by", - TypeRef::named_nn_list(order_by), - )) - .argument(InputValue::new("limit", TypeRef::named(TypeRef::INT))) - .argument(InputValue::new("offset", TypeRef::named(TypeRef::INT))); + }, + ) + .argument(InputValue::new("where", TypeRef::named(bool_exp))) + .argument(InputValue::new( + "order_by", + TypeRef::named_nn_list(order_by), + )) + .argument(InputValue::new("limit", TypeRef::named(TypeRef::INT))) + .argument(InputValue::new("offset", TypeRef::named(TypeRef::INT))); subscription = subscription.field(field); has_subscription = true; } diff --git a/src/graphql/surface.rs b/src/graphql/surface.rs index 39431c8a..af1dcd12 100644 --- a/src/graphql/surface.rs +++ b/src/graphql/surface.rs @@ -320,6 +320,23 @@ impl RoleGrant { } } +/// Build a role→grant map for one role from `(model_name, role) → grant` entries. +/// +/// Entries whose role does not match are ignored. Used by export/SDL and engine +/// adapters that already store grants keyed by `(model, role)`. +pub fn role_grants_for_role( + role: &str, + model_role_grants: &BTreeMap<(String, String), RoleGrant>, +) -> BTreeMap { + let mut out = BTreeMap::new(); + for ((model, r), grant) in model_role_grants { + if r == role { + out.insert(model.clone(), grant.clone()); + } + } + out +} + /// Apply role grants: drop ungranted models and columns (and relationships to /// dropped models). Aggregate roots omitted when `aggregations` is false. /// @@ -778,4 +795,79 @@ mod tests { "empty grants should not expose orders roots: {sdl}" ); } + + /// A7: role×dialect inventory + IR→SDL ops stay aligned (portable fixture). + #[test] + fn a7_role_dialect_parity_inventory_and_sdl_ops() { + use super::super::sdl::{graphql_sdl_for_role, SdlOptions}; + + let full_sqlite = build_surface(&[orders()], &SurfaceOptions::sqlite()).unwrap(); + let full_pg = build_surface(&[orders()], &SurfaceOptions::postgres()).unwrap(); + + // Dialect honesty on full surface + let sqlite_json = full_sqlite.comparison_ops_for_scalar("JSON"); + let pg_json = full_pg.comparison_ops_for_scalar("JSON"); + assert!(sqlite_json.contains(&"_eq")); + assert!(!sqlite_json.contains(&"_contains")); + assert!(pg_json.contains(&"_contains")); + + let mut grants = BTreeMap::new(); + grants.insert( + "OrderView".to_string(), + RoleGrant::columns(["order_id", "status"]), + ); + + for (opts, dialect_label) in [ + (SdlOptions::sqlite(), "sqlite"), + (SdlOptions::postgres(), "postgres"), + ] { + let full = build_surface( + &[orders()], + &SurfaceOptions { + dialect: if opts.jsonb_operators { + SurfaceDialect::Postgres + } else { + SurfaceDialect::Sqlite + }, + aggregates: opts.aggregates, + subscriptions: opts.subscriptions, + }, + ) + .unwrap(); + let role_s = surface_for_role(&full, "user", &grants); + let roots: Vec<_> = role_s.query_root_names(); + assert!( + roots.contains(&"orders") && roots.contains(&"orders_by_pk"), + "{dialect_label}: missing list/by_pk roots {roots:?}" + ); + assert!( + !roots.iter().any(|n| n.contains("aggregate")), + "{dialect_label}: aggregate without grant" + ); + let cols: Vec<_> = role_s + .models + .get("OrderView") + .unwrap() + .columns + .iter() + .map(|c| c.name.as_str()) + .collect(); + assert_eq!(cols, vec!["order_id", "status"]); + + let sdl = graphql_sdl_for_role(&[orders()], &opts, "user", &grants).unwrap(); + assert!( + sdl.contains("order_id") && !sdl.contains("customer_id"), + "{dialect_label}: SDL column leak: {sdl}" + ); + // SQLite role SDL never exposes PG JSON ops even if dialect flag wrong on unused scalars + if !opts.jsonb_operators { + for forbidden in ["_contains", "_contained_in", "_has_key"] { + assert!( + !sdl.contains(forbidden), + "{dialect_label}: {forbidden} in SDL" + ); + } + } + } + } } diff --git a/tests/e2e-ui/README.md b/tests/e2e-ui/README.md index 96c701a9..d49caa0b 100644 --- a/tests/e2e-ui/README.md +++ b/tests/e2e-ui/README.md @@ -54,6 +54,24 @@ make test # domain + behavioral + structural UI (no Docker) make test-live # OIDC isolation (E2E_STACK=1, needs make up + API up) ``` +### Suite identity modes (E6) + +| Profile | When | How suite/API auth works | +|---------|------|---------------------------| +| **DevHeaders** | `OIDC_ISSUER` / `OIDC_AUDIENCE` **unset** | Suite sends `x-user-id` / `x-role`; `make test` behavioral expects this | +| **OidcBearer** | After `make up` + `source e2e-ui.env` | API rejects ambient headers; need real Bearer tokens (`make test-live` / machine keys) | + +Always-on units (no stack): `cargo test -p e2e-service --lib` (strip spoof), `cargo test -p todo-domain --lib` (owner gates), `cd ui && npm test` (includes systems-harden unit pack). + +Do **not** run DevHeaders behavioral against an OIDC-only process and treat 401 as product failure — wrong profile. + +### UI unit tests + +```bash +cd ui && npm test +# includes systems-harden-unit.mjs (C-U* red-team + pending merge) +``` + ## WebSocket authentication (best practice) Browsers **cannot** set `Authorization` on the WebSocket upgrade handshake. diff --git a/tests/e2e-ui/crates/runner/src/bin/export_sdl.rs b/tests/e2e-ui/crates/runner/src/bin/export_sdl.rs index e03b9a82..8fc7f256 100644 --- a/tests/e2e-ui/crates/runner/src/bin/export_sdl.rs +++ b/tests/e2e-ui/crates/runner/src/bin/export_sdl.rs @@ -1,16 +1,12 @@ //! Export role-scoped GraphQL SDL for SvelteKit codegen. //! -//! Builds the **same** GraphQL engine as the e2e-ui runner (`build_graphql_engine`), -//! then writes `GraphqlEngine::sdl_for_role` to a file consumed by `npm run gen:gql`. +//! **A11:** Always builds query surface via surface IR +//! (`GraphqlEngine::ir_sdl_for_role` → build_surface → surface_for_role → SDL) +//! and dual-checks that every IR Query root field exists on the runtime dump. //! -//! Offline: in-memory SQLite + DevHeaders — no Docker/OIDC required. -//! -//! Usage (from `tests/e2e-ui`): -//! cargo run -p e2e-runner --bin e2e-export-sdl -- ui/schema/user.graphql -//! make export-sdl -//! -//! Env: -//! GQL_ROLE — role to export (default: `user`) +//! **File content** is the full runtime `sdl_for_role` (includes command Mutation +//! types required by graphql-codegen + `commands.operations.gql`). Query root +//! inventory is proven equal to IR so dual maintenance cannot drift silently. use std::env; use std::path::PathBuf; @@ -29,35 +25,124 @@ async fn main() -> Result<(), Box> { .map_err(|e| format!("manifest: {e}"))?; repo.bootstrap_table_schema_for_dev(®istry).await?; - // Same registration as e2e-ui process (models + command mutations + roles). let engine = build_graphql_engine(repo.pool().clone(), dev_identity(), None)?; - let sdl = engine + + // A11 production IR path (must succeed). + let ir = engine + .ir_sdl_for_role(&role) + .map_err(|e| format!("ir_sdl_for_role({role}): {e}"))?; + + let runtime = engine .sdl_for_role(&role) - .ok_or_else(|| format!("no GraphQL schema registered for role `{role}`"))?; + .ok_or_else(|| format!("no runtime schema for role `{role}`"))?; + + assert_ir_query_roots_in_runtime(&ir, &runtime) + .map_err(|e| format!("IR vs runtime dual-check failed: {e}"))?; let header = format!( "# GENERATED — do not treat as hand-authored source of truth.\n\ - # Source: e2e_service::build_graphql_engine + GraphqlEngine::sdl_for_role(\"{role}\")\n\ - # Regenerate: `make export-sdl` or `npm run gen:schema` (from tests/e2e-ui)\n\ - # Then: `cd ui && npm run gen:gql` (or `make gen-gql` / `npm run gen`)\n\ + # IR query surface (validated): GraphqlEngine::ir_sdl_for_role(\"{role}\")\n\ + # build_surface → surface_for_role → graphql_sdl_from_surface\n\ + # File body: runtime sdl_for_role (includes command Mutation for codegen)\n\ + # Dual-check: every IR Query root field name ⊆ runtime Query\n\ + # Regenerate: `make export-sdl` or `npm run gen:schema`\n\ + # Then: `cd ui && npm run gen:gql`\n\ #\n\ - # Spec: hops GitKB specs/e2e-ui/rust-role-sdl-codegen\n\n" + # Spec: specs/query-layer/v1/surface-ir (A11)\n\n" ); if let Some(parent) = out.parent() { std::fs::create_dir_all(parent)?; } - let body = format!("{header}{sdl}"); + let body = format!("{header}{runtime}"); std::fs::write(&out, &body)?; eprintln!( - "e2e-export-sdl: wrote {} ({} bytes, role={role})", + "e2e-export-sdl: wrote {} ({} bytes, role={role}, IR dual-check ok)", out.display(), body.len() ); Ok(()) } +/// Extract field names from `type Query { ... }` block (top-level field identifiers). +fn query_field_names(sdl: &str) -> Result, String> { + let start = sdl + .find("type Query {") + .ok_or_else(|| "no type Query in SDL".to_string())?; + let rest = &sdl[start + "type Query {".len()..]; + let mut depth = 1i32; + let mut end = 0usize; + for (i, ch) in rest.char_indices() { + match ch { + '{' => depth += 1, + '}' => { + depth -= 1; + if depth == 0 { + end = i; + break; + } + } + _ => {} + } + } + if end == 0 { + return Err("unclosed type Query".into()); + } + let body = &rest[..end]; + let mut names = Vec::new(); + for line in body.lines() { + let line = line.trim(); + if line.is_empty() || line.starts_with('#') { + continue; + } + // fieldName( or fieldName: + let name: String = line + .chars() + .take_while(|c| c.is_ascii_alphanumeric() || *c == '_') + .collect(); + if !name.is_empty() && name != "type" { + names.push(name); + } + } + Ok(names) +} + +fn assert_ir_query_roots_in_runtime(ir: &str, runtime: &str) -> Result<(), String> { + let ir_fields = query_field_names(ir)?; + let rt_fields = query_field_names(runtime)?; + if ir_fields.is_empty() { + // empty role is ok + return Ok(()); + } + for f in &ir_fields { + if !rt_fields.iter().any(|r| r == f) { + return Err(format!( + "IR Query field `{f}` missing from runtime Query (ir={ir_fields:?}, rt={rt_fields:?})" + )); + } + } + Ok(()) +} + fn default_out_path() -> PathBuf { - // crates/runner → tests/e2e-ui/ui/schema/user.graphql PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../../ui/schema/user.graphql") } + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn dual_check_accepts_matching_roots() { + let ir = "type Query {\n todos: [T!]!\n todos_by_pk(id: String!): T\n}\n"; + let rt = "type Query {\n todos: [T!]!\n todos_by_pk(id: String!): T\n extra: Int\n}\n"; + assert_ir_query_roots_in_runtime(ir, rt).unwrap(); + } + + #[test] + fn dual_check_rejects_missing_root() { + let ir = "type Query {\n todos: [T!]!\n secret: Int\n}\n"; + let rt = "type Query {\n todos: [T!]!\n}\n"; + assert!(assert_ir_query_roots_in_runtime(ir, rt).is_err()); + } +} diff --git a/tests/e2e-ui/ui/schema/admin.graphql b/tests/e2e-ui/ui/schema/admin.graphql index c26b98ee..db1a5045 100644 --- a/tests/e2e-ui/ui/schema/admin.graphql +++ b/tests/e2e-ui/ui/schema/admin.graphql @@ -1,38 +1,17 @@ # GENERATED — do not treat as hand-authored source of truth. -# Source: e2e_service::build_graphql_engine + GraphqlEngine::sdl_for_role("admin") -# Regenerate: `make export-sdl` or `npm run gen:schema` (from tests/e2e-ui) -# Then: `cd ui && npm run gen:gql` (or `make gen-gql` / `npm run gen`) +# IR query surface (validated): GraphqlEngine::ir_sdl_for_role("admin") +# build_surface → surface_for_role → graphql_sdl_from_surface +# File body: runtime sdl_for_role (includes command Mutation for codegen) +# Dual-check: every IR Query root field name ⊆ runtime Query +# Regenerate: `make export-sdl` or `npm run gen:schema` +# Then: `cd ui && npm run gen:gql` # -# Spec: hops GitKB specs/e2e-ui/rust-role-sdl-codegen +# Spec: specs/query-layer/v1/surface-ir (A11) scalar BigInt -input BigInt_comparison_exp { - _eq: BigInt - _neq: BigInt - _gt: BigInt - _gte: BigInt - _lt: BigInt - _lte: BigInt - _in: [BigInt!] - _nin: [BigInt!] - _is_null: Boolean -} - scalar Bytea -input Bytea_comparison_exp { - _eq: Bytea - _neq: Bytea - _gt: Bytea - _gte: Bytea - _lt: Bytea - _lte: Bytea - _in: [Bytea!] - _nin: [Bytea!] - _is_null: Boolean -} - type ChatMessageView { message_id: String! room_id: String! @@ -57,18 +36,6 @@ type ChatPostPayload { scalar JSON -input JSON_comparison_exp { - _eq: JSON - _neq: JSON - _gt: JSON - _gte: JSON - _lt: JSON - _lte: JSON - _in: [JSON!] - _nin: [JSON!] - _is_null: Boolean -} - type Mutation { todos_create(input: TodoCreateInput!): TodoCreatePayload! todos_complete(input: TodoCompleteInput!): TodoStatusPayload! @@ -107,18 +74,6 @@ type Subscription { scalar Timestamptz -input Timestamptz_comparison_exp { - _eq: Timestamptz - _neq: Timestamptz - _gt: Timestamptz - _gte: Timestamptz - _lt: Timestamptz - _lte: Timestamptz - _in: [Timestamptz!] - _nin: [Timestamptz!] - _is_null: Boolean -} - input TodoArchiveInput { todo_id: String! } diff --git a/tests/e2e-ui/ui/schema/user.graphql b/tests/e2e-ui/ui/schema/user.graphql index f8cbbb30..ab875564 100644 --- a/tests/e2e-ui/ui/schema/user.graphql +++ b/tests/e2e-ui/ui/schema/user.graphql @@ -1,38 +1,17 @@ # GENERATED — do not treat as hand-authored source of truth. -# Source: e2e_service::build_graphql_engine + GraphqlEngine::sdl_for_role("user") -# Regenerate: `make export-sdl` or `npm run gen:schema` (from tests/e2e-ui) -# Then: `cd ui && npm run gen:gql` (or `make gen-gql` / `npm run gen`) +# IR query surface (validated): GraphqlEngine::ir_sdl_for_role("user") +# build_surface → surface_for_role → graphql_sdl_from_surface +# File body: runtime sdl_for_role (includes command Mutation for codegen) +# Dual-check: every IR Query root field name ⊆ runtime Query +# Regenerate: `make export-sdl` or `npm run gen:schema` +# Then: `cd ui && npm run gen:gql` # -# Spec: hops GitKB specs/e2e-ui/rust-role-sdl-codegen +# Spec: specs/query-layer/v1/surface-ir (A11) scalar BigInt -input BigInt_comparison_exp { - _eq: BigInt - _neq: BigInt - _gt: BigInt - _gte: BigInt - _lt: BigInt - _lte: BigInt - _in: [BigInt!] - _nin: [BigInt!] - _is_null: Boolean -} - scalar Bytea -input Bytea_comparison_exp { - _eq: Bytea - _neq: Bytea - _gt: Bytea - _gte: Bytea - _lt: Bytea - _lte: Bytea - _in: [Bytea!] - _nin: [Bytea!] - _is_null: Boolean -} - type ChatMessageView { message_id: String! room_id: String! @@ -57,18 +36,6 @@ type ChatPostPayload { scalar JSON -input JSON_comparison_exp { - _eq: JSON - _neq: JSON - _gt: JSON - _gte: JSON - _lt: JSON - _lte: JSON - _in: [JSON!] - _nin: [JSON!] - _is_null: Boolean -} - type Mutation { todos_create(input: TodoCreateInput!): TodoCreatePayload! todos_complete(input: TodoCompleteInput!): TodoStatusPayload! @@ -106,18 +73,6 @@ type Subscription { scalar Timestamptz -input Timestamptz_comparison_exp { - _eq: Timestamptz - _neq: Timestamptz - _gt: Timestamptz - _gte: Timestamptz - _lt: Timestamptz - _lte: Timestamptz - _in: [Timestamptz!] - _nin: [Timestamptz!] - _is_null: Boolean -} - input TodoArchiveInput { todo_id: String! } diff --git a/tests/e2e-ui/ui/src/lib/api/commands.operations.generated.ts b/tests/e2e-ui/ui/src/lib/api/commands.operations.generated.ts new file mode 100644 index 00000000..eac34538 --- /dev/null +++ b/tests/e2e-ui/ui/src/lib/api/commands.operations.generated.ts @@ -0,0 +1,96 @@ +/** Internal type. DO NOT USE DIRECTLY. */ +type Exact = { [K in keyof T]: T[K] }; +/** Internal type. DO NOT USE DIRECTLY. */ +export type Incremental = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never }; +import type * as Types from '../gql/generated/types'; + +import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core'; +export type ChatPostInput = { + body: string; + message_id: string; + room_id: string; +}; + +export type TodoArchiveInput = { + todo_id: string; +}; + +export type TodoCompleteInput = { + todo_id: string; +}; + +export type TodoCreateInput = { + title: string; + todo_id: string; +}; + +export type TodoForceArchiveInput = { + todo_id: string; +}; + +export type TodoRenameInput = { + title: string; + todo_id: string; +}; + +export type TodoReopenInput = { + todo_id: string; +}; + +export type Command_Todos_CreateMutationVariables = Exact<{ + input: Types.TodoCreateInput; +}>; + + +export type Command_Todos_CreateMutation = { todos_create: { todo_id: string, owner_id: string, title: string, status: string } }; + +export type Command_Todos_CompleteMutationVariables = Exact<{ + input: Types.TodoCompleteInput; +}>; + + +export type Command_Todos_CompleteMutation = { todos_complete: { todo_id: string, status: string } }; + +export type Command_Todos_ArchiveMutationVariables = Exact<{ + input: Types.TodoArchiveInput; +}>; + + +export type Command_Todos_ArchiveMutation = { todos_archive: { todo_id: string, status: string } }; + +export type Command_Todos_Force_ArchiveMutationVariables = Exact<{ + input: Types.TodoForceArchiveInput; +}>; + + +export type Command_Todos_Force_ArchiveMutation = { todos_force_archive: { todo_id: string, owner_id: string, status: string, archived_by: string } }; + +export type Command_Todos_RenameMutationVariables = Exact<{ + input: Types.TodoRenameInput; +}>; + + +export type Command_Todos_RenameMutation = { todos_rename: { todo_id: string, title: string, status: string } }; + +export type Command_Todos_ReopenMutationVariables = Exact<{ + input: Types.TodoReopenInput; +}>; + + +export type Command_Todos_ReopenMutation = { todos_reopen: { todo_id: string, status: string } }; + +export type Command_Chat_Messages_PostMutationVariables = Exact<{ + input: Types.ChatPostInput; +}>; + + +export type Command_Chat_Messages_PostMutation = { chat_messages_post: { message_id: string, room_id: string, author_id: string, body: string, created_at: string } }; + + +export const Command_Todos_CreateDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Command_todos_create"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"TodoCreateInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todos_create"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todo_id"}},{"kind":"Field","name":{"kind":"Name","value":"owner_id"}},{"kind":"Field","name":{"kind":"Name","value":"title"}},{"kind":"Field","name":{"kind":"Name","value":"status"}}]}}]}}]} as unknown as DocumentNode; +export const Command_Todos_CompleteDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Command_todos_complete"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"TodoCompleteInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todos_complete"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todo_id"}},{"kind":"Field","name":{"kind":"Name","value":"status"}}]}}]}}]} as unknown as DocumentNode; +export const Command_Todos_ArchiveDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Command_todos_archive"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"TodoArchiveInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todos_archive"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todo_id"}},{"kind":"Field","name":{"kind":"Name","value":"status"}}]}}]}}]} as unknown as DocumentNode; +export const Command_Todos_Force_ArchiveDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Command_todos_force_archive"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"TodoForceArchiveInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todos_force_archive"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todo_id"}},{"kind":"Field","name":{"kind":"Name","value":"owner_id"}},{"kind":"Field","name":{"kind":"Name","value":"status"}},{"kind":"Field","name":{"kind":"Name","value":"archived_by"}}]}}]}}]} as unknown as DocumentNode; +export const Command_Todos_RenameDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Command_todos_rename"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"TodoRenameInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todos_rename"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todo_id"}},{"kind":"Field","name":{"kind":"Name","value":"title"}},{"kind":"Field","name":{"kind":"Name","value":"status"}}]}}]}}]} as unknown as DocumentNode; +export const Command_Todos_ReopenDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Command_todos_reopen"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"TodoReopenInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todos_reopen"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todo_id"}},{"kind":"Field","name":{"kind":"Name","value":"status"}}]}}]}}]} as unknown as DocumentNode; +export const Command_Chat_Messages_PostDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Command_chat_messages_post"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"ChatPostInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"chat_messages_post"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"message_id"}},{"kind":"Field","name":{"kind":"Name","value":"room_id"}},{"kind":"Field","name":{"kind":"Name","value":"author_id"}},{"kind":"Field","name":{"kind":"Name","value":"body"}},{"kind":"Field","name":{"kind":"Name","value":"created_at"}}]}}]}}]} as unknown as DocumentNode; \ No newline at end of file diff --git a/tests/e2e-ui/ui/src/lib/gql/cache/ops.ts b/tests/e2e-ui/ui/src/lib/gql/cache/ops.ts index e0b96229..afbb05e9 100644 --- a/tests/e2e-ui/ui/src/lib/gql/cache/ops.ts +++ b/tests/e2e-ui/ui/src/lib/gql/cache/ops.ts @@ -127,6 +127,7 @@ function cloneEntry(entry: ReturnType): ReturnType void { let set = this.#listeners.get(key); if (!set) { diff --git a/tests/e2e-ui/ui/src/lib/gql/generated/types.ts b/tests/e2e-ui/ui/src/lib/gql/generated/types.ts index 5e72f7ee..7ca2ac7c 100644 --- a/tests/e2e-ui/ui/src/lib/gql/generated/types.ts +++ b/tests/e2e-ui/ui/src/lib/gql/generated/types.ts @@ -13,30 +13,6 @@ export type Scalars = { Timestamptz: { input: unknown; output: unknown; } }; -export type BigInt_Comparison_Exp = { - _eq?: InputMaybe; - _gt?: InputMaybe; - _gte?: InputMaybe; - _in?: InputMaybe>; - _is_null?: InputMaybe; - _lt?: InputMaybe; - _lte?: InputMaybe; - _neq?: InputMaybe; - _nin?: InputMaybe>; -}; - -export type Bytea_Comparison_Exp = { - _eq?: InputMaybe; - _gt?: InputMaybe; - _gte?: InputMaybe; - _in?: InputMaybe>; - _is_null?: InputMaybe; - _lt?: InputMaybe; - _lte?: InputMaybe; - _neq?: InputMaybe; - _nin?: InputMaybe>; -}; - export type ChatMessageView = { __typename?: 'ChatMessageView'; author_id: Scalars['String']['output']; @@ -61,18 +37,6 @@ export type ChatPostPayload = { room_id: Scalars['String']['output']; }; -export type Json_Comparison_Exp = { - _eq?: InputMaybe; - _gt?: InputMaybe; - _gte?: InputMaybe; - _in?: InputMaybe>; - _is_null?: InputMaybe; - _lt?: InputMaybe; - _lte?: InputMaybe; - _neq?: InputMaybe; - _nin?: InputMaybe>; -}; - export type Mutation = { __typename?: 'Mutation'; chat_messages_post: ChatPostPayload; @@ -189,18 +153,6 @@ export type SubscriptionTodosArgs = { where?: InputMaybe; }; -export type Timestamptz_Comparison_Exp = { - _eq?: InputMaybe; - _gt?: InputMaybe; - _gte?: InputMaybe; - _in?: InputMaybe>; - _is_null?: InputMaybe; - _lt?: InputMaybe; - _lte?: InputMaybe; - _neq?: InputMaybe; - _nin?: InputMaybe>; -}; - export type TodoArchiveInput = { todo_id: Scalars['String']['input']; }; diff --git a/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts b/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts index aa7dc4f6..70a81efb 100644 --- a/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts +++ b/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts @@ -58,6 +58,13 @@ export type UseGraphqlOptions = { runEffects?: (effects: Effect[]) => void; }; +/** Identity key for C-U18 cache isolation (token sub or DevHeaders userId+role). */ +function authIdentityKey(auth: import('./types.ts').GqlAuth): string { + const token = auth.accessToken?.trim() || ''; + if (token) return `bearer:${token.slice(0, 24)}`; + return `dev:${auth.userId ?? ''}:${auth.role ?? ''}`; +} + /** * Client bound to same-origin `/graphql`. * @@ -81,10 +88,23 @@ export function useGraphql( getData: () => PageGraphqlData, options: UseGraphqlOptions = {} ): AppGraphqlClient { + // Prefer a fresh QueryCache per binder so identity switches (new page load / + // remount after login) do not reuse another principal's document keys (C-U18). + // Callers may still pass a shared `options.cache` for tests; clear it on auth id change. const cache = options.cache ?? new QueryCache(); + let lastAuthId = authIdentityKey(authFromPageData(getData())); + const getAuth = () => { + const auth = authFromPageData(getData()); + const id = authIdentityKey(auth); + if (id !== lastAuthId) { + cache.clear(); + lastAuthId = id; + } + return auth; + }; const client = createGraphqlClient({ getUrl: () => '/graphql', - getAuth: () => authFromPageData(getData()), + getAuth, cache, writeThrough: true }); diff --git a/tests/e2e-ui/ui/tests/systems-harden-unit.mjs b/tests/e2e-ui/ui/tests/systems-harden-unit.mjs index fa6186a7..49d03849 100644 --- a/tests/e2e-ui/ui/tests/systems-harden-unit.mjs +++ b/tests/e2e-ui/ui/tests/systems-harden-unit.mjs @@ -394,6 +394,47 @@ await checkAsync('B9 policy defaults applied; call-site overrides', async () => assert.ok(e2eCommandPolicies.todosCreate?.reconcile?.kind === 'none'); }); +// --- B16 residual red-team --- +check('C-U2 invalidate exact key does not delete sibling prefix key', () => { + const cache = new QueryCache(); + const short = 'query Q { a }'; + const longer = 'query Q { a b }'; + // Document text of short is prefix of longer string — old startsWith invalidate was unsafe + const k1 = cacheKey(short, {}); + const k2 = cacheKey(longer, {}); + cache.set(k1, { data: 1, updatedAt: 1 }); + cache.set(k2, { data: 2, updatedAt: 1 }); + cache.invalidate(k1); + assert.equal(cache.get(k1), undefined); + assert.equal(cache.get(k2)?.data, 2); +}); + +check('C-U2 invalidatePrefix is explicit for intentional prefix wipe', () => { + const cache = new QueryCache(); + cache.set('docA::', { data: 1, updatedAt: 1 }); + cache.set('docAB::', { data: 2, updatedAt: 1 }); + cache.invalidatePrefix('docA'); + assert.equal(cache.get('docA::'), undefined); + assert.equal(cache.get('docAB::'), undefined); +}); + +check('C-U18 cache.clear drops all entries (identity switch)', () => { + const cache = new QueryCache(); + cache.set(cacheKey(TODOS_DOC, {}), { data: { todos: [{ todo_id: 'x' }] }, updatedAt: 1 }); + cache.clear(); + assert.equal(cache.get(cacheKey(TODOS_DOC, {})), undefined); +}); + +check('C-U18 useGraphql getAuth clears cache when identity changes', async () => { + const fs = await import('node:fs'); + const path = await import('node:path'); + const { fileURLToPath } = await import('node:url'); + const root = path.dirname(fileURLToPath(import.meta.url)); + const src = fs.readFileSync(path.join(root, '../src/lib/gql/use-graphql.ts'), 'utf8'); + assert.match(src, /authIdentityKey|cache\.clear/); + assert.match(src, /lastAuthId/); +}); + // structural: no cache-helpers export check('B14 index does not export seedQueryCache', async () => { const fs = await import('node:fs'); From 70dd6ffbb47996e9462c441e80418415824f73e3 Mon Sep 17 00:00:00 2001 From: Patrick Lee Scott Date: Fri, 17 Jul 2026 00:57:38 -0500 Subject: [PATCH 11/20] fix(e2e-ui): C-U18 identity key uses JWT sub not header prefix MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit authIdentityKey was token.slice(0,24) which is the shared JOSE header for RS256 JWTs — distinct users never cleared the QueryCache. Key on payload.sub (or full-token hash for opaque bearers); unit drives useGraphql getAuth switch. --- tests/e2e-ui/ui/src/lib/gql/use-graphql.ts | 48 ++++++++++- tests/e2e-ui/ui/tests/systems-harden-unit.mjs | 85 ++++++++++++++++--- 2 files changed, 117 insertions(+), 16 deletions(-) diff --git a/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts b/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts index 70a81efb..2033bd7f 100644 --- a/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts +++ b/tests/e2e-ui/ui/src/lib/gql/use-graphql.ts @@ -58,13 +58,55 @@ export type UseGraphqlOptions = { runEffects?: (effects: Effect[]) => void; }; -/** Identity key for C-U18 cache isolation (token sub or DevHeaders userId+role). */ -function authIdentityKey(auth: import('./types.ts').GqlAuth): string { +/** + * Identity key for C-U18 cache isolation. + * Bearer: JWT `payload.sub` when parseable (RS256 JWTs share a header prefix — do **not** + * key on token.slice(0, N)). Non-JWT tokens: hash of the full token string. + * DevHeaders: userId + role. + */ +export function authIdentityKey(auth: import('./types.ts').GqlAuth): string { const token = auth.accessToken?.trim() || ''; - if (token) return `bearer:${token.slice(0, 24)}`; + if (token) { + const sub = jwtPayloadSub(token); + if (sub) return `sub:${sub}`; + return `bearer:${hashString(token)}`; + } return `dev:${auth.userId ?? ''}:${auth.role ?? ''}`; } +/** Decode JWT payload `sub` (middle segment). Null if not a 3-part JWT or no sub. */ +export function jwtPayloadSub(token: string): string | null { + const parts = token.split('.'); + if (parts.length !== 3 || !parts[1]) return null; + try { + const json = base64UrlDecode(parts[1]); + const payload = JSON.parse(json) as { sub?: unknown }; + return typeof payload.sub === 'string' && payload.sub.length > 0 ? payload.sub : null; + } catch { + return null; + } +} + +function base64UrlDecode(segment: string): string { + const pad = segment.length % 4 === 0 ? '' : '='.repeat(4 - (segment.length % 4)); + const b64 = segment.replace(/-/g, '+').replace(/_/g, '/') + pad; + if (typeof atob === 'function') { + return atob(b64); + } + // Node unit tests + return Buffer.from(b64, 'base64').toString('utf8'); +} + +/** FNV-1a 32-bit — enough to distinguish opaque bearer strings without leaking full token in keys. */ +function hashString(s: string): string { + let h = 0x811c9dc5; + for (let i = 0; i < s.length; i++) { + h ^= s.charCodeAt(i); + h = Math.imul(h, 0x01000193); + } + return (h >>> 0).toString(16); +} + /** * Client bound to same-origin `/graphql`. * diff --git a/tests/e2e-ui/ui/tests/systems-harden-unit.mjs b/tests/e2e-ui/ui/tests/systems-harden-unit.mjs index 49d03849..b0ace635 100644 --- a/tests/e2e-ui/ui/tests/systems-harden-unit.mjs +++ b/tests/e2e-ui/ui/tests/systems-harden-unit.mjs @@ -4,6 +4,8 @@ * (from tests/e2e-ui/ui) */ import assert from 'node:assert/strict'; +import path from 'node:path'; +import { fileURLToPath, pathToFileURL } from 'node:url'; import { QueryCache, cacheKey, @@ -19,6 +21,9 @@ import { looksLikeMutation, createGraphqlClient } from '../src/lib/gql/create-cl import { createDocumentStore } from '../src/lib/gql/document-store.ts'; import { e2eCommandPolicies } from '../src/lib/gql/command-policies.ts'; import { bindCommandsPipeline } from '../src/lib/gql/bind-commands-pipeline.ts'; +import { authIdentityKey, useGraphql } from '../src/lib/gql/use-graphql.ts'; + +const uiRoot = path.dirname(fileURLToPath(import.meta.url)); const TODOS_DOC = 'query Todos { todos { todo_id title status } }'; const CREATE_DOC = @@ -425,26 +430,80 @@ check('C-U18 cache.clear drops all entries (identity switch)', () => { assert.equal(cache.get(cacheKey(TODOS_DOC, {})), undefined); }); -check('C-U18 useGraphql getAuth clears cache when identity changes', async () => { - const fs = await import('node:fs'); - const path = await import('node:path'); - const { fileURLToPath } = await import('node:url'); - const root = path.dirname(fileURLToPath(import.meta.url)); - const src = fs.readFileSync(path.join(root, '../src/lib/gql/use-graphql.ts'), 'utf8'); - assert.match(src, /authIdentityKey|cache\.clear/); - assert.match(src, /lastAuthId/); +/** Minimal JWT-shaped token: same RS256 header, different payload.sub (C-U18). */ +function jwtLike(sub) { + const b64url = (obj) => + Buffer.from(JSON.stringify(obj)) + .toString('base64') + .replace(/=/g, '') + .replace(/\+/g, '-') + .replace(/\//g, '_'); + // Shared JOSE header — old buggy key used token.slice(0,24) which is this prefix only + const header = b64url({ alg: 'RS256', typ: 'JWT' }); + const payload = b64url({ sub, iss: 'https://example.test' }); + return `${header}.${payload}.fakesig`; +} + +check('C-U18 authIdentityKey uses JWT sub not shared header prefix', () => { + const tokA = jwtLike('alice'); + const tokB = jwtLike('bob'); + // Same JOSE header bytes — buggy slice(0,24) would collapse these + assert.equal(tokA.slice(0, 24), tokB.slice(0, 24)); + const ka = authIdentityKey({ accessToken: tokA }); + const kb = authIdentityKey({ accessToken: tokB }); + assert.equal(ka, 'sub:alice'); + assert.equal(kb, 'sub:bob'); + assert.notEqual(ka, kb); }); +await checkAsync( + 'C-U18 useGraphql request clears shared cache when JWT sub changes', + async () => { + const tokAlice = jwtLike('alice'); + const tokBob = jwtLike('bob'); + assert.equal(tokAlice.slice(0, 24), tokBob.slice(0, 24), 'fixture: shared header'); + + const cache = new QueryCache(); + let page = { accessToken: tokAlice, session: null, engineRole: 'user' }; + const gql = useGraphql(() => page, { cache }); + + const key = cacheKey(TODOS_DOC, {}); + cache.set(key, { + data: { todos: [{ todo_id: 'alice-secret', title: 'private' }] }, + updatedAt: 1 + }); + assert.ok(cache.get(key), 'seeded alice cache'); + + // Switch principal (same JOSE header, different sub) + page = { accessToken: tokBob, session: null, engineRole: 'user' }; + + const origFetch = globalThis.fetch; + globalThis.fetch = async () => ({ + status: 200, + json: async () => ({ data: { __typename: 'Query' } }) + }); + try { + // request → getAuth → should clear on identity change + await gql.request('query Ping { __typename }'); + } finally { + globalThis.fetch = origFetch; + } + + assert.equal( + cache.get(key), + undefined, + 'alice document must not remain after bob identity switch' + ); + } +); + // structural: no cache-helpers export check('B14 index does not export seedQueryCache', async () => { const fs = await import('node:fs'); - const path = await import('node:path'); - const { fileURLToPath } = await import('node:url'); - const root = path.dirname(fileURLToPath(import.meta.url)); - const idx = fs.readFileSync(path.join(root, '../src/lib/gql/index.ts'), 'utf8'); + const idx = fs.readFileSync(path.join(uiRoot, '../src/lib/gql/index.ts'), 'utf8'); assert.doesNotMatch(idx, /seedQueryCache|cache-helpers/); assert.match(idx, /e2eCommandPolicies/); - assert.ok(!fs.existsSync(path.join(root, '../src/lib/gql/cache-helpers.ts'))); + assert.ok(!fs.existsSync(path.join(uiRoot, '../src/lib/gql/cache-helpers.ts'))); }); console.log(`# tests ${passed}`); From fcbb638a69d894ab1167ddc24e09b77208c0e9f7 Mon Sep 17 00:00:00 2001 From: Patrick Lee Scott Date: Sun, 19 Jul 2026 15:12:51 -0500 Subject: [PATCH 12/20] feat(e2e-ui): blob game, Zitadel ingress/scrape, and auth_users joins MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add CQRS blob game demo (domain, projectors, optimistic UI), custom Login V2 pages, and Zitadel Action ingress plus Management API scrape into auth_users. Chat and blob GraphQL join author/owner; belongs_to is nullable when the target row is missing. Split domain/read models into models/ folders and fix chat “mine” using the access-token sub. --- src/graphql/schema.rs | 16 +- src/graphql/sdl.rs | 14 +- tests/e2e-ui/Cargo.toml | 1 + tests/e2e-ui/Makefile | 11 +- tests/e2e-ui/README.md | 24 +- tests/e2e-ui/crates/blob-domain/Cargo.toml | 16 + tests/e2e-ui/crates/blob-domain/src/levels.rs | 263 ++++++ tests/e2e-ui/crates/blob-domain/src/lib.rs | 13 + .../blob-domain/src/models/blob_error.rs | 27 + .../blob-domain/src/models/blob_game.rs | 437 ++++++++++ .../blob-domain/src/models/blob_game_fact.rs | 23 + .../blob-domain/src/models/direction.rs | 31 + .../crates/blob-domain/src/models/mod.rs | 12 + .../crates/blob-domain/src/models/tile.rs | 8 + tests/e2e-ui/crates/chat-domain/src/lib.rs | 142 +-- .../chat-domain/src/models/chat_error.rs | 17 + .../chat-domain/src/models/chat_message.rs | 105 +++ .../src/models/chat_message_posted.rs | 24 + .../crates/chat-domain/src/models/mod.rs | 9 + tests/e2e-ui/crates/readmodels/Cargo.toml | 2 + tests/e2e-ui/crates/readmodels/src/lib.rs | 97 +-- .../readmodels/src/models/auth_user_view.rs | 141 +++ .../readmodels/src/models/blob_game_view.rs | 40 + .../src/models/chat_message_view.rs | 32 + .../crates/readmodels/src/models/mod.rs | 16 + .../crates/readmodels/src/models/todo_view.rs | 24 + tests/e2e-ui/crates/runner/src/main.rs | 30 + tests/e2e-ui/crates/service/Cargo.toml | 2 + tests/e2e-ui/crates/service/src/deps.rs | 8 + .../service/src/handlers/commands/blob_cmd.rs | 79 ++ .../src/handlers/commands/blob_move.rs | 53 ++ .../src/handlers/commands/blob_start.rs | 64 ++ .../src/handlers/commands/blob_start_level.rs | 44 + .../service/src/handlers/commands/mod.rs | 4 + .../crates/service/src/handlers/events/mod.rs | 2 + .../src/handlers/events/project_auth_user.rs | 57 ++ .../src/handlers/events/project_blob.rs | 49 ++ .../service/src/handlers/ingestors/mod.rs | 6 + .../src/handlers/ingestors/zitadel/auth.rs | 152 ++++ .../src/handlers/ingestors/zitadel/handle.rs | 61 ++ .../src/handlers/ingestors/zitadel/map.rs | 422 +++++++++ .../src/handlers/ingestors/zitadel/mod.rs | 54 ++ .../src/handlers/ingestors/zitadel/publish.rs | 22 + .../src/handlers/ingestors/zitadel/scrape.rs | 490 +++++++++++ .../src/handlers/ingestors/zitadel_scrape.rs | 54 ++ .../e2e-ui/crates/service/src/handlers/mod.rs | 1 + tests/e2e-ui/crates/service/src/lib.rs | 16 +- tests/e2e-ui/crates/service/src/oidc_layer.rs | 16 +- tests/e2e-ui/crates/service/src/service.rs | 71 +- tests/e2e-ui/crates/todo-domain/src/lib.rs | 287 +------ .../crates/todo-domain/src/models/mod.rs | 11 + .../crates/todo-domain/src/models/todo.rs | 227 +++++ .../todo-domain/src/models/todo_error.rs | 25 + .../todo-domain/src/models/todo_fact.rs | 29 + .../todo-domain/src/models/todo_status.rs | 10 + tests/e2e-ui/docker/Caddyfile | 9 +- tests/e2e-ui/docker/docker-compose.yml | 15 +- tests/e2e-ui/docs/blob-game-remake.md | 124 +++ tests/e2e-ui/docs/zitadel-ingestor.md | 144 ++++ tests/e2e-ui/scripts/up.sh | 137 ++- tests/e2e-ui/ui/schema/admin.graphql | 134 +++ tests/e2e-ui/ui/schema/user.graphql | 134 +++ tests/e2e-ui/ui/src/auth.ts | 73 +- tests/e2e-ui/ui/src/hooks.server.ts | 5 +- .../ui/src/lib/api/commands.generated.ts | 117 +++ .../ui/src/lib/api/commands.manifest.json | 222 +++++ .../lib/api/commands.operations.generated.ts | 39 +- .../ui/src/lib/api/commands.operations.gql | 42 + .../lib/components/shared/header/Auth.svelte | 3 +- .../components/shared/header/Navbar.svelte | 6 + .../ui/src/lib/gql/bind-commands-pipeline.ts | 33 +- .../e2e-ui/ui/src/lib/gql/generated/types.ts | 210 +++++ tests/e2e-ui/ui/src/lib/server/oidc-start.ts | 15 +- .../ui/src/lib/server/zitadel-session.ts | 271 ++++++ tests/e2e-ui/ui/src/lib/session.ts | 50 ++ tests/e2e-ui/ui/src/routes/+page.svelte | 6 +- .../e2e-ui/ui/src/routes/blob/+page.server.ts | 14 + tests/e2e-ui/ui/src/routes/blob/+page.svelte | 808 ++++++++++++++++++ .../ui/src/routes/blob/blob.generated.ts | 14 + tests/e2e-ui/ui/src/routes/blob/blob.gql | 19 + .../ui/src/routes/blob/blob.resource.ts | 10 + tests/e2e-ui/ui/src/routes/chat/+page.svelte | 46 +- .../ui/src/routes/chat/chat.generated.ts | 8 +- tests/e2e-ui/ui/src/routes/chat/chat.gql | 13 + .../ui/src/routes/login/+page.server.ts | 56 ++ tests/e2e-ui/ui/src/routes/login/+page.svelte | 204 +++++ tests/e2e-ui/ui/src/routes/signin/+server.ts | 4 + tests/e2e-ui/ui/src/routes/signout/+server.ts | 5 +- .../ui/src/routes/signup/+page.server.ts | 78 ++ .../e2e-ui/ui/src/routes/signup/+page.svelte | 248 ++++++ tests/e2e-ui/ui/src/routes/signup/+server.ts | 11 - 91 files changed, 6605 insertions(+), 613 deletions(-) create mode 100644 tests/e2e-ui/crates/blob-domain/Cargo.toml create mode 100644 tests/e2e-ui/crates/blob-domain/src/levels.rs create mode 100644 tests/e2e-ui/crates/blob-domain/src/lib.rs create mode 100644 tests/e2e-ui/crates/blob-domain/src/models/blob_error.rs create mode 100644 tests/e2e-ui/crates/blob-domain/src/models/blob_game.rs create mode 100644 tests/e2e-ui/crates/blob-domain/src/models/blob_game_fact.rs create mode 100644 tests/e2e-ui/crates/blob-domain/src/models/direction.rs create mode 100644 tests/e2e-ui/crates/blob-domain/src/models/mod.rs create mode 100644 tests/e2e-ui/crates/blob-domain/src/models/tile.rs create mode 100644 tests/e2e-ui/crates/chat-domain/src/models/chat_error.rs create mode 100644 tests/e2e-ui/crates/chat-domain/src/models/chat_message.rs create mode 100644 tests/e2e-ui/crates/chat-domain/src/models/chat_message_posted.rs create mode 100644 tests/e2e-ui/crates/chat-domain/src/models/mod.rs create mode 100644 tests/e2e-ui/crates/readmodels/src/models/auth_user_view.rs create mode 100644 tests/e2e-ui/crates/readmodels/src/models/blob_game_view.rs create mode 100644 tests/e2e-ui/crates/readmodels/src/models/chat_message_view.rs create mode 100644 tests/e2e-ui/crates/readmodels/src/models/mod.rs create mode 100644 tests/e2e-ui/crates/readmodels/src/models/todo_view.rs create mode 100644 tests/e2e-ui/crates/service/src/handlers/commands/blob_cmd.rs create mode 100644 tests/e2e-ui/crates/service/src/handlers/commands/blob_move.rs create mode 100644 tests/e2e-ui/crates/service/src/handlers/commands/blob_start.rs create mode 100644 tests/e2e-ui/crates/service/src/handlers/commands/blob_start_level.rs create mode 100644 tests/e2e-ui/crates/service/src/handlers/events/project_auth_user.rs create mode 100644 tests/e2e-ui/crates/service/src/handlers/events/project_blob.rs create mode 100644 tests/e2e-ui/crates/service/src/handlers/ingestors/mod.rs create mode 100644 tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/auth.rs create mode 100644 tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/handle.rs create mode 100644 tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/map.rs create mode 100644 tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/mod.rs create mode 100644 tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/publish.rs create mode 100644 tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/scrape.rs create mode 100644 tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel_scrape.rs create mode 100644 tests/e2e-ui/crates/todo-domain/src/models/mod.rs create mode 100644 tests/e2e-ui/crates/todo-domain/src/models/todo.rs create mode 100644 tests/e2e-ui/crates/todo-domain/src/models/todo_error.rs create mode 100644 tests/e2e-ui/crates/todo-domain/src/models/todo_fact.rs create mode 100644 tests/e2e-ui/crates/todo-domain/src/models/todo_status.rs create mode 100644 tests/e2e-ui/docs/blob-game-remake.md create mode 100644 tests/e2e-ui/docs/zitadel-ingestor.md create mode 100644 tests/e2e-ui/ui/src/lib/server/zitadel-session.ts create mode 100644 tests/e2e-ui/ui/src/routes/blob/+page.server.ts create mode 100644 tests/e2e-ui/ui/src/routes/blob/+page.svelte create mode 100644 tests/e2e-ui/ui/src/routes/blob/blob.generated.ts create mode 100644 tests/e2e-ui/ui/src/routes/blob/blob.gql create mode 100644 tests/e2e-ui/ui/src/routes/blob/blob.resource.ts create mode 100644 tests/e2e-ui/ui/src/routes/login/+page.server.ts create mode 100644 tests/e2e-ui/ui/src/routes/login/+page.svelte create mode 100644 tests/e2e-ui/ui/src/routes/signup/+page.server.ts create mode 100644 tests/e2e-ui/ui/src/routes/signup/+page.svelte delete mode 100644 tests/e2e-ui/ui/src/routes/signup/+server.ts diff --git a/src/graphql/schema.rs b/src/graphql/schema.rs index c344421f..c5430db0 100644 --- a/src/graphql/schema.rs +++ b/src/graphql/schema.rs @@ -435,20 +435,8 @@ fn ensure_object_type( let key = rel.field_name.clone(); match rel.kind { RelationshipKind::BelongsTo => { - let fk_nullable = schema - .columns - .iter() - .find(|c| { - c.column_name == rel.foreign_key.as_deref().unwrap_or("") - || c.field_name == rel.foreign_key.as_deref().unwrap_or("") - }) - .map(|c| c.nullable) - .unwrap_or(true); - let ty = if fk_nullable { - TypeRef::named(target_obj) - } else { - TypeRef::named_nn(target_obj) - }; + // Always nullable: non-null FK ≠ target RM row present (LEFT JOIN). + let ty = TypeRef::named(target_obj); obj = obj.field(Field::new(rel.field_name.as_str(), ty, move |ctx| { let key = key.clone(); FieldFuture::new(async move { passthrough(&ctx, &key) }) diff --git a/src/graphql/sdl.rs b/src/graphql/sdl.rs index c7c247dd..e950166e 100644 --- a/src/graphql/sdl.rs +++ b/src/graphql/sdl.rs @@ -441,17 +441,9 @@ fn emit_object_type( let target_obj = object_type_name(target); match rel.kind { RelationshipKind::BelongsTo => { - let fk_nullable = schema - .columns - .iter() - .find(|c| { - c.column_name == rel.foreign_key.as_deref().unwrap_or("") - || c.field_name == rel.foreign_key.as_deref().unwrap_or("") - }) - .map(|c| c.nullable) - .unwrap_or(true); - let null = if fk_nullable { "" } else { "!" }; - out.push_str(&format!(" {}: {}{}\n", rel.field_name, target_obj, null)); + // Always nullable: a non-null FK means the source holds an id, not + // that a matching target read-model row exists (LEFT JOIN / Option). + out.push_str(&format!(" {}: {}\n", rel.field_name, target_obj)); } RelationshipKind::HasMany | RelationshipKind::ManyToMany => { let bool_exp = bool_exp_name(target); diff --git a/tests/e2e-ui/Cargo.toml b/tests/e2e-ui/Cargo.toml index 3d3f6b76..21d2b078 100644 --- a/tests/e2e-ui/Cargo.toml +++ b/tests/e2e-ui/Cargo.toml @@ -7,6 +7,7 @@ resolver = "2" members = [ "crates/todo-domain", "crates/chat-domain", + "crates/blob-domain", "crates/readmodels", "crates/service", "crates/runner", diff --git a/tests/e2e-ui/Makefile b/tests/e2e-ui/Makefile index f03ac3a0..872c1a7d 100644 --- a/tests/e2e-ui/Makefile +++ b/tests/e2e-ui/Makefile @@ -15,7 +15,9 @@ BIND ?= 127.0.0.1:8791 API_PORT ?= 8791 BASE_URL ?= http://127.0.0.1:8791 UI_PORT ?= 5180 -UI_URL ?= http://127.0.0.1:5180 +# localhost required for Auth.js cookies over HTTP (SvelteKit Secure default) +UI_URL ?= http://localhost:5180 +UI_HOST ?= localhost ENV_FILE ?= e2e-ui.env NPM ?= npm CARGO_TEST_FLAGS ?= -- --nocapture @@ -40,7 +42,10 @@ run: ui-install _api_port="$${_bind##*:}"; \ _base="$${E2E_API_ORIGIN:-http://$${_bind}}"; \ _ui_port="$(UI_PORT)"; \ - _ui="$${E2E_UI_ORIGIN:-http://127.0.0.1:$${_ui_port}}"; \ + _ui_host="$(UI_HOST)"; \ + _ui="$${E2E_UI_ORIGIN:-http://$${_ui_host}:$${_ui_port}}"; \ + export AUTH_URL="$${_ui}"; \ + export AUTH_USE_SECURE_COOKIES="false"; \ lsof -ti:$${_api_port} 2>/dev/null | xargs kill -9 2>/dev/null || true; \ lsof -ti:$${_ui_port} 2>/dev/null | xargs kill -9 2>/dev/null || true; \ rm -f .make-runner.pid .make-ui.pid .make-runner.log; \ @@ -59,7 +64,7 @@ run: ui-install echo "API failed:"; tail -80 .make-runner.log; exit 1; \ fi; \ echo "API ready (HTTP probe $$code). starting UI …"; \ - cd ui && $(NPM) run dev -- --host 127.0.0.1 --port $$_ui_port & \ + cd ui && $(NPM) run dev -- --host $$_ui_host --port $$_ui_port & \ echo $$! > ../.make-ui.pid; \ cd ..; \ cleanup() { \ diff --git a/tests/e2e-ui/README.md b/tests/e2e-ui/README.md index d49caa0b..b547ce42 100644 --- a/tests/e2e-ui/README.md +++ b/tests/e2e-ui/README.md @@ -4,12 +4,15 @@ A **copyable starting point** for a Distributed service + SvelteKit UI with: | Pattern | Where | |---------|--------| -| Multi-crate domain (todos + chat) | `crates/*-domain`, `readmodels`, `service` | +| Multi-crate domain (todos + chat + blob) | `crates/*-domain`, `readmodels`, `service` | | Projectors-only read models | command handlers never dual-write | -| GraphQL RLS | `owner_id = claim(x-user-id)` on todos | +| GraphQL RLS | `owner_id = claim(x-user-id)` on todos / blob | | Live subscriptions | `subscription { chat_messages }` + ChangeHub | +| **Zitadel ingestor** | `POST /zitadel.ingress.v1` + scrape reconcile → `auth_users` ([docs](docs/zitadel-ingestor.md)) | +| **GraphQL joins** | `chat_messages.author` / `blob_games.owner` → `auth_users` | | **WebSocket auth** | Bearer access token in `connection_init` (OIDC best practice) | -| **Real OIDC** | Zitadel in Docker + Auth.js | +| **Real OIDC** | Zitadel in Docker + Auth.js (PKCE + session cookie) | +| **Login V2** | **Custom** `/login` + `/signup` in this UI (Session API + CreateCallback); not Zitadel’s stock login image | | **Postgres** | event store + bus + locks | | **SSR GraphQL** | `+page.server.ts` loads with session token (no Loading flash) | | Auth routes | sign-in, protected todos/chat, session inspector | @@ -27,11 +30,17 @@ make run # API :8791 + UI :5180 |-----|------| | http://127.0.0.1:5180 | Fieldnote UI | | http://127.0.0.1:5180/todos | SSR todos (auth required) | +| http://127.0.0.1:5180/blob | Blob game — aggregate moves → projected `blob_games` map/score | | http://127.0.0.1:5180/admin | Admin all-owners todos (admin role only) | | http://127.0.0.1:5180/chat | SSR seed + live WS sub | | http://127.0.0.1:5180/session | Session / token inspector | | http://127.0.0.1:8791/graphql | GraphiQL | | `ws://127.0.0.1:8791/graphql/ws` | Subscriptions | +| http://127.0.0.1:5180/login | Custom Login V2 (password form on this app) | +| http://127.0.0.1:5180/signup | Custom registration | +| http://localhost:18080/ui/console | Zitadel console | + +**Auth flow:** Auth.js → Zitadel `/oauth/v2/authorize` → **your** `/login?authRequest=V2_…` (Session API + CreateCallback) → Auth.js `/auth/callback/oidc`. Requires `ZITADEL_SERVICE_USER_TOKEN` from `make up`. After `make up`, always **restart** `make run`. **Demo logins** (Zitadel): `alice` / `bob` / `admin` — password `Password1!` @@ -87,10 +96,16 @@ The SvelteKit chat page uses the session access token in `connection_init`. Do * ```text Browser (SSR + client) - Auth.js → Zitadel OIDC → access_token + Auth.js → Zitadel /oauth/v2/authorize + → UI /login?authRequest=V2_… (Session API + CreateCallback) + → Auth.js /auth/callback/oidc → access_token GraphQL HTTP Authorization: Bearer … GraphQL WS connection_init.authorization +Zitadel edge (:18080) + /oauth/*, /management/*, /v2/*, /ui/console → zitadel + Login V2 baseUri → Fieldnote UI origin (custom pages) + e2e-runner (Distributed) OidcBearer identity PostgresRepository + PostgresBus + PostgresLockManager @@ -106,6 +121,7 @@ e2e-runner (Distributed) | `OIDC_ISSUER` | Zitadel base URL | | `OIDC_AUDIENCE` | Project id (JWT aud) | | `OIDC_CLIENT_ID` / `SECRET` | Auth.js web app | +| `ZITADEL_SERVICE_USER_TOKEN` | IAM_LOGIN_CLIENT PAT for Session API + CreateCallback (server only) | | `AUTH_SECRET` | Auth.js cookie encryption | | `E2E_MACHINE_*` | Suite JWT-bearer keys | diff --git a/tests/e2e-ui/crates/blob-domain/Cargo.toml b/tests/e2e-ui/crates/blob-domain/Cargo.toml new file mode 100644 index 00000000..c6b22f07 --- /dev/null +++ b/tests/e2e-ui/crates/blob-domain/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "blob-domain" +version.workspace = true +edition.workspace = true +license.workspace = true +publish.workspace = true + +[dependencies] +distributed = { workspace = true } +serde = { workspace = true } +serde_json = { workspace = true } +thiserror = { workspace = true } +rand = { workspace = true } + +[dev-dependencies] +serde_json = { workspace = true } diff --git a/tests/e2e-ui/crates/blob-domain/src/levels.rs b/tests/e2e-ui/crates/blob-domain/src/levels.rs new file mode 100644 index 00000000..e5c0af4e --- /dev/null +++ b/tests/e2e-ui/crates/blob-domain/src/levels.rs @@ -0,0 +1,263 @@ +//! Procedural levels inspired by ig-blob-game-model-service `lib/levels.ts`. +//! +//! Holes are placed with spacing heuristics (like the original), then we **prove +//! passability**: there exists a path that visits every non-hole cell exactly once +//! starting from the player (Hamiltonian path on the free-cell graph). Small grids +//! make that check feasible. + +use rand::seq::SliceRandom; +use rand::{Rng, SeedableRng}; +use rand::rngs::StdRng; + +use crate::models::tile; + +/// Playfield size. Original is 12×12; we use 6×6 so Hamiltonian passability +/// checks stay fast on the command path while still varying layouts. +pub const DEFAULT_SIZE: usize = 6; +/// Holes on level 1 (scales up with level index, capped). +pub const DEFAULT_HOLES: usize = 2; + +/// Fixed map used only in unit tests that need determinism without RNG. +pub fn demo_map() -> Vec> { + use tile::*; + vec![ + vec![PLAYER, UNVISITED, UNVISITED, UNVISITED, HOLE], + vec![UNVISITED, UNVISITED, UNVISITED, UNVISITED, UNVISITED], + vec![UNVISITED, UNVISITED, HOLE, UNVISITED, UNVISITED], + vec![UNVISITED, UNVISITED, UNVISITED, UNVISITED, UNVISITED], + vec![UNVISITED, UNVISITED, UNVISITED, UNVISITED, UNVISITED], + ] +} + +/// Generate a random, **solvable** level. Retries until passable or falls back +/// to a dense no-hole grid (always solvable). +pub fn generate_level(level_index: u32) -> Vec> { + let mut rng = StdRng::from_entropy(); + generate_level_with(&mut rng, level_index) +} + +/// Same as [`generate_level`] with an injected RNG (tests / seeds). +pub fn generate_level_with(rng: &mut R, level_index: u32) -> Vec> { + let size = DEFAULT_SIZE; + // Slightly more holes as levels progress (capped). + let holes = (DEFAULT_HOLES + level_index.saturating_sub(1) as usize).min(size / 2); + + for _ in 0..80 { + if let Some(map) = try_generate(rng, size, holes) { + if is_hamiltonian_passable(&map) { + return map; + } + } + } + + // Guaranteed solvable: no holes. + empty_playable(size) +} + +fn empty_playable(size: usize) -> Vec> { + let mut map = vec![vec![tile::UNVISITED; size]; size]; + map[0][0] = tile::PLAYER; + map +} + +fn try_generate(rng: &mut R, size: usize, hole_count: usize) -> Option>> { + let mut map = empty_playable(size); + let mut candidates: Vec<(usize, usize)> = Vec::new(); + for r in 0..size { + for c in 0..size { + // Keep start clear; avoid corner-trapping start neighbors sometimes + if (r, c) == (0, 0) { + continue; + } + // Soft perimeter rule from original: fewer holes on the outer ring + // for the first two rings near start. + if (r == 0 && c == 1) || (r == 1 && c == 0) { + continue; + } + candidates.push((r, c)); + } + } + candidates.shuffle(rng); + + let mut placed: Vec<(usize, usize)> = Vec::new(); + for (r, c) in candidates { + if placed.len() >= hole_count { + break; + } + if hole_ok(&placed, r, c, size) { + map[r][c] = tile::HOLE; + placed.push((r, c)); + } + } + + // Connectivity of free cells (necessary, not sufficient) + if !is_connected_free(&map) { + return None; + } + Some(map) +} + +/// Original-inspired spacing: holes not too close (Manhattan < 3 on small grid). +fn hole_ok(placed: &[(usize, usize)], r: usize, c: usize, size: usize) -> bool { + // Don't block the entire first row/col start corridor + if r == 0 && c < 2 { + return false; + } + if c == 0 && r < 2 { + return false; + } + // Prefer not on absolute outer edge for tiny grids (original avoided perimeter) + if size >= 6 && (r == size - 1 || c == size - 1) && (r == 0 || c == 0) { + // allow but continue checks + } + for &(pr, pc) in placed { + let dist = pr.abs_diff(r) + pc.abs_diff(c); + if dist < 3 { + return false; + } + // Reciprocal / diagonal pattern heuristics (simplified from original) + if pr == c && pc == r { + return false; + } + } + true +} + +fn free_cells(map: &[Vec]) -> Vec<(usize, usize)> { + let mut out = Vec::new(); + for (r, row) in map.iter().enumerate() { + for (c, &t) in row.iter().enumerate() { + if t != tile::HOLE { + out.push((r, c)); + } + } + } + out +} + +fn is_connected_free(map: &[Vec]) -> bool { + let free = free_cells(map); + if free.is_empty() { + return false; + } + let h = map.len(); + let w = map[0].len(); + let mut seen = vec![vec![false; w]; h]; + let mut stack = vec![(0usize, 0usize)]; + if map[0][0] == tile::HOLE { + return false; + } + seen[0][0] = true; + let mut count = 0usize; + while let Some((r, c)) = stack.pop() { + count += 1; + for (nr, nc) in neighbors(r, c, h, w) { + if map[nr][nc] != tile::HOLE && !seen[nr][nc] { + seen[nr][nc] = true; + stack.push((nr, nc)); + } + } + } + count == free.len() +} + +fn neighbors(r: usize, c: usize, h: usize, w: usize) -> Vec<(usize, usize)> { + let mut n = Vec::with_capacity(4); + if r > 0 { + n.push((r - 1, c)); + } + if r + 1 < h { + n.push((r + 1, c)); + } + if c > 0 { + n.push((r, c - 1)); + } + if c + 1 < w { + n.push((r, c + 1)); + } + n +} + +/// True if some path visits every non-hole cell exactly once from the player. +pub fn is_hamiltonian_passable(map: &[Vec]) -> bool { + let free = free_cells(map); + let n = free.len(); + if n == 0 { + return false; + } + let h = map.len(); + let w = map[0].len(); + let mut index = vec![vec![None; w]; h]; + for (i, &(r, c)) in free.iter().enumerate() { + index[r][c] = Some(i); + } + // adjacency list + let mut adj = vec![Vec::new(); n]; + for (i, &(r, c)) in free.iter().enumerate() { + for (nr, nc) in neighbors(r, c, h, w) { + if let Some(j) = index[nr][nc] { + adj[i].push(j); + } + } + } + let start = index[0][0].expect("player at 0,0"); + let mut visited = vec![false; n]; + visited[start] = true; + hamilton_dfs(start, 1, n, &adj, &mut visited) +} + +fn hamilton_dfs( + u: usize, + depth: usize, + n: usize, + adj: &[Vec], + visited: &mut [bool], +) -> bool { + if depth == n { + return true; + } + for &v in &adj[u] { + if !visited[v] { + visited[v] = true; + if hamilton_dfs(v, depth + 1, n, adj, visited) { + return true; + } + visited[v] = false; + } + } + false +} + +#[cfg(test)] +mod tests { + use super::*; + use rand::SeedableRng; + + #[test] + fn generated_maps_differ_and_are_passable() { + let mut rng = StdRng::seed_from_u64(42); + let a = generate_level_with(&mut rng, 1); + let b = generate_level_with(&mut rng, 1); + assert!(is_hamiltonian_passable(&a)); + assert!(is_hamiltonian_passable(&b)); + // Same seed stream still progresses — maps should usually differ + assert_ne!(a, b, "expected variety across sequential generates"); + assert_eq!(a[0][0], tile::PLAYER); + assert_eq!(b[0][0], tile::PLAYER); + } + + #[test] + fn empty_grid_passable() { + assert!(is_hamiltonian_passable(&empty_playable(5))); + } + + #[test] + fn disconnected_not_passable() { + let mut m = empty_playable(3); + // Wall of holes isolating bottom-right + m[0][1] = tile::HOLE; + m[1][0] = tile::HOLE; + m[1][1] = tile::HOLE; + assert!(!is_connected_free(&m) || !is_hamiltonian_passable(&m)); + } +} diff --git a/tests/e2e-ui/crates/blob-domain/src/lib.rs b/tests/e2e-ui/crates/blob-domain/src/lib.rs new file mode 100644 index 00000000..c47e9f86 --- /dev/null +++ b/tests/e2e-ui/crates/blob-domain/src/lib.rs @@ -0,0 +1,13 @@ +//! BlobGame aggregate — grid trail game (remake of ig-blob-game-model-service). +//! +//! Tile ints match JS `constants.ts` (player=9, hole=0, unvisited=1, visited=2, +//! dead_by_suicide=3, dead_by_hole=4). Read models update only from emitted facts. + +pub mod levels; +pub mod models; + +pub use levels::{demo_map, generate_level, generate_level_with, is_hamiltonian_passable}; +pub use models::tile; +pub use models::{ + test_map_no_holes, test_map_with_hole, BlobError, BlobGame, BlobGameFact, Direction, +}; diff --git a/tests/e2e-ui/crates/blob-domain/src/models/blob_error.rs b/tests/e2e-ui/crates/blob-domain/src/models/blob_error.rs new file mode 100644 index 00000000..1f83604c --- /dev/null +++ b/tests/e2e-ui/crates/blob-domain/src/models/blob_error.rs @@ -0,0 +1,27 @@ +use thiserror::Error; + +#[derive(Debug, Error, PartialEq, Eq)] +pub enum BlobError { + #[error("game already exists")] + AlreadyExists, + #[error("game not found / not created")] + NotCreated, + #[error("empty game id")] + EmptyId, + #[error("empty owner id")] + EmptyOwner, + #[error("not the owner")] + NotOwner, + #[error("player is dead")] + PlayerDead, + #[error("current level not completed")] + LevelNotComplete, + #[error("no active level")] + NoActiveLevel, + #[error("invalid map: {0}")] + InvalidMap(String), + #[error("cannot move: {0}")] + CannotMove(String), + #[error(transparent)] + Event(#[from] distributed::EventRecordError), +} diff --git a/tests/e2e-ui/crates/blob-domain/src/models/blob_game.rs b/tests/e2e-ui/crates/blob-domain/src/models/blob_game.rs new file mode 100644 index 00000000..95055b5a --- /dev/null +++ b/tests/e2e-ui/crates/blob-domain/src/models/blob_game.rs @@ -0,0 +1,437 @@ +use distributed::{sourced, Entity}; +use serde::{Deserialize, Serialize}; + +use crate::levels::generate_level; + +use super::tile; +use super::{BlobError, BlobGameFact, Direction}; + +/// Tiny 3×3 map for unit tests (player top-left, no holes). +pub fn test_map_no_holes() -> Vec> { + use tile::*; + vec![ + vec![PLAYER, UNVISITED, UNVISITED], + vec![UNVISITED, UNVISITED, UNVISITED], + vec![UNVISITED, UNVISITED, UNVISITED], + ] +} + +pub fn test_map_with_hole() -> Vec> { + use tile::*; + vec![ + vec![PLAYER, HOLE, UNVISITED], + vec![UNVISITED, UNVISITED, UNVISITED], + vec![UNVISITED, UNVISITED, UNVISITED], + ] +} + +fn validate_map(map: &[Vec]) -> Result<(), BlobError> { + if map.is_empty() || map[0].is_empty() { + return Err(BlobError::InvalidMap("empty map".into())); + } + let w = map[0].len(); + let mut players = 0usize; + for (r, row) in map.iter().enumerate() { + if row.len() != w { + return Err(BlobError::InvalidMap(format!("ragged row {r}"))); + } + for &t in row { + if t == tile::PLAYER { + players += 1; + } + } + } + if players != 1 { + return Err(BlobError::InvalidMap(format!( + "expected exactly one player tile, found {players}" + ))); + } + Ok(()) +} + +fn map_to_json(map: &[Vec]) -> String { + serde_json::to_string(map).unwrap_or_else(|_| "[]".into()) +} + +fn status_of(player_dead: bool, level_complete: bool) -> String { + if player_dead { + "dead".into() + } else if level_complete { + "level_complete".into() + } else { + "active".into() + } +} + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +pub struct BlobGame { + #[serde(skip, default)] + pub entity: Entity, + pub game_id: String, + pub owner_id: String, + pub score: i64, + pub player_dead: bool, + /// 0 = no level yet; 1+ = active level index (1-based like JS). + pub current_level: i64, + pub current_level_completed: bool, + /// Current level map only (demo keeps one active map in state). + pub map: Vec>, +} + +impl BlobGame { + pub fn is_created(&self) -> bool { + !self.game_id.is_empty() + } + + pub fn ensure_owner(&self, owner_id: &str) -> Result<(), BlobError> { + if !self.is_created() { + return Err(BlobError::NotCreated); + } + if self.owner_id != owner_id { + return Err(BlobError::NotOwner); + } + Ok(()) + } + + pub fn fact(&self) -> BlobGameFact { + BlobGameFact { + game_id: self.game_id.clone(), + owner_id: self.owner_id.clone(), + score: self.score, + player_dead: self.player_dead, + current_level: self.current_level, + current_level_completed: self.current_level_completed, + map_json: map_to_json(&self.map), + status: status_of(self.player_dead, self.current_level_completed), + } + } + + fn player_pos(&self) -> Result<(usize, usize), BlobError> { + for (r, row) in self.map.iter().enumerate() { + for (c, &t) in row.iter().enumerate() { + if t == tile::PLAYER { + return Ok((r, c)); + } + } + } + Err(BlobError::NoActiveLevel) + } +} + +#[sourced(entity, events = "BlobGameEvent", aggregate_type = "blob")] +impl BlobGame { + /// Create game shell (no map yet). Level 0 is "completed" so first level can start. + pub fn initialize( + &mut self, + game_id: impl Into, + owner_id: impl Into, + ) -> Result<(), BlobError> { + if self.is_created() { + return Err(BlobError::AlreadyExists); + } + let game_id = game_id.into(); + let owner_id = owner_id.into(); + if game_id.trim().is_empty() { + return Err(BlobError::EmptyId); + } + if owner_id.trim().is_empty() { + return Err(BlobError::EmptyOwner); + } + self.record_initialized(game_id, owner_id)?; + Ok(()) + } + + #[event("blob.initialized")] + fn record_initialized(&mut self, game_id: String, owner_id: String) { + self.entity.set_id(&game_id); + self.game_id = game_id; + self.owner_id = owner_id; + self.score = 0; + self.player_dead = false; + self.current_level = 0; + self.current_level_completed = true; + self.map = Vec::new(); + } + + /// Append/start a level map. Requires current level complete and player alive. + pub fn start_level( + &mut self, + owner_id: &str, + map: Vec>, + ) -> Result<(), BlobError> { + self.ensure_owner(owner_id)?; + if self.player_dead { + return Err(BlobError::PlayerDead); + } + if !self.current_level_completed { + return Err(BlobError::LevelNotComplete); + } + validate_map(&map)?; + let next = self.current_level + 1; + self.record_level_started(next, map)?; + Ok(()) + } + + #[event("blob.level_started")] + fn record_level_started(&mut self, current_level: i64, map: Vec>) { + self.current_level = current_level; + self.map = map; + self.current_level_completed = false; + self.player_dead = false; + } + + /// Create game and start a **generated** passable level (`blob.started`). + pub fn start_with_demo( + &mut self, + game_id: impl Into, + owner_id: impl Into, + ) -> Result<(), BlobError> { + self.start_with_map(game_id, owner_id, generate_level(1)) + } + + /// Create game with an explicit map (tests / fixtures). + pub fn start_with_map( + &mut self, + game_id: impl Into, + owner_id: impl Into, + map: Vec>, + ) -> Result<(), BlobError> { + if self.is_created() { + return Err(BlobError::AlreadyExists); + } + let game_id = game_id.into(); + let owner_id = owner_id.into(); + if game_id.trim().is_empty() { + return Err(BlobError::EmptyId); + } + if owner_id.trim().is_empty() { + return Err(BlobError::EmptyOwner); + } + validate_map(&map)?; + self.record_started(game_id, owner_id, 1, map)?; + Ok(()) + } + + /// Start next level with a freshly generated passable map. + pub fn start_next_generated_level(&mut self, owner_id: &str) -> Result<(), BlobError> { + let next = self.current_level + 1; + let map = generate_level(next as u32); + self.start_level(owner_id, map) + } + + #[event("blob.started")] + fn record_started( + &mut self, + game_id: String, + owner_id: String, + current_level: i64, + map: Vec>, + ) { + self.entity.set_id(&game_id); + self.game_id = game_id; + self.owner_id = owner_id; + self.score = 0; + self.player_dead = false; + self.current_level = current_level; + self.current_level_completed = false; + self.map = map; + } + + pub fn move_dir(&mut self, owner_id: &str, direction: Direction) -> Result<(), BlobError> { + self.ensure_owner(owner_id)?; + if self.player_dead { + return Err(BlobError::PlayerDead); + } + if self.current_level == 0 || self.map.is_empty() { + return Err(BlobError::NoActiveLevel); + } + let (r, c) = self.player_pos()?; + let (nr, nc) = match direction { + Direction::Up => { + if r == 0 { + return Err(BlobError::CannotMove("row already 0".into())); + } + (r - 1, c) + } + Direction::Down => { + if r + 1 >= self.map.len() { + return Err(BlobError::CannotMove("already at bottom edge".into())); + } + (r + 1, c) + } + Direction::Left => { + if c == 0 { + return Err(BlobError::CannotMove("column already 0".into())); + } + (r, c - 1) + } + Direction::Right => { + if c + 1 >= self.map[r].len() { + return Err(BlobError::CannotMove("already at right edge".into())); + } + (r, c + 1) + } + }; + // Capture post-move snapshot via event recorder. + let mut next_map = self.map.clone(); + let mut score = self.score; + let mut player_dead = self.player_dead; + let mut level_complete = self.current_level_completed; + + // Simulate on temps then record once. + next_map[r][c] = tile::VISITED; + match next_map[nr][nc] { + tile::HOLE => next_map[nr][nc] = tile::DEAD_BY_HOLE, + tile::VISITED => next_map[nr][nc] = tile::DEAD_BY_SUICIDE, + tile::UNVISITED | tile::PLAYER => { + score += 1; + next_map[nr][nc] = tile::PLAYER; + } + _ => next_map[nr][nc] = tile::DEAD_BY_SUICIDE, + } + for row in &next_map { + if row.contains(&tile::DEAD_BY_HOLE) || row.contains(&tile::DEAD_BY_SUICIDE) { + player_dead = true; + level_complete = false; + break; + } + } + if !player_dead { + let any_u = next_map.iter().any(|row| row.contains(&tile::UNVISITED)); + level_complete = !any_u; + } + + self.record_moved( + score, + player_dead, + level_complete, + next_map, + direction.as_str().to_string(), + )?; + Ok(()) + } + + #[event("blob.moved")] + fn record_moved( + &mut self, + score: i64, + player_dead: bool, + current_level_completed: bool, + map: Vec>, + _direction: String, + ) { + self.score = score; + self.player_dead = player_dead; + self.current_level_completed = current_level_completed; + self.map = map; + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::levels::{demo_map, is_hamiltonian_passable}; + + fn game_with_map(map: Vec>) -> BlobGame { + let mut g = BlobGame::default(); + g.initialize("g1", "alice").unwrap(); + g.start_level("alice", map).unwrap(); + g + } + + #[test] + fn initialize_and_start_level() { + let mut g = BlobGame::default(); + g.initialize("g1", "alice").unwrap(); + assert!(g.current_level_completed); + assert_eq!(g.current_level, 0); + g.start_level("alice", test_map_no_holes()).unwrap(); + assert_eq!(g.current_level, 1); + assert!(!g.current_level_completed); + assert_eq!(g.player_pos().unwrap(), (0, 0)); + } + + #[test] + fn start_level_requires_complete() { + let mut g = game_with_map(test_map_no_holes()); + let err = g.start_level("alice", test_map_no_holes()).unwrap_err(); + assert_eq!(err, BlobError::LevelNotComplete); + } + + #[test] + fn move_scores_unvisited() { + let mut g = game_with_map(test_map_no_holes()); + g.move_dir("alice", Direction::Right).unwrap(); + assert_eq!(g.score, 1); + assert_eq!(g.player_pos().unwrap(), (0, 1)); + assert_eq!(g.map[0][0], tile::VISITED); + } + + #[test] + fn die_on_hole() { + let mut g = game_with_map(test_map_with_hole()); + g.move_dir("alice", Direction::Right).unwrap(); + assert!(g.player_dead); + assert_eq!(g.map[0][1], tile::DEAD_BY_HOLE); + assert_eq!(g.score, 0); + } + + #[test] + fn die_on_revisit() { + let mut g = game_with_map(test_map_no_holes()); + g.move_dir("alice", Direction::Right).unwrap(); + g.move_dir("alice", Direction::Left).unwrap(); + assert!(g.player_dead); + assert_eq!(g.map[0][0], tile::DEAD_BY_SUICIDE); + } + + #[test] + fn edge_move_rejected() { + let mut g = game_with_map(test_map_no_holes()); + let err = g.move_dir("alice", Direction::Up).unwrap_err(); + assert!(matches!(err, BlobError::CannotMove(_))); + assert_eq!(g.score, 0); + assert_eq!(g.player_pos().unwrap(), (0, 0)); + } + + #[test] + fn complete_level_when_no_unvisited() { + // 2×2: player + 3 unvisited + use tile::*; + let map = vec![ + vec![PLAYER, UNVISITED], + vec![UNVISITED, UNVISITED], + ]; + let mut g = game_with_map(map); + g.move_dir("alice", Direction::Right).unwrap(); + g.move_dir("alice", Direction::Down).unwrap(); + g.move_dir("alice", Direction::Left).unwrap(); + assert!(g.current_level_completed); + assert!(!g.player_dead); + assert_eq!(g.score, 3); + assert_eq!(g.fact().status, "level_complete"); + } + + #[test] + fn not_owner_rejected() { + let mut g = game_with_map(test_map_no_holes()); + assert_eq!( + g.move_dir("bob", Direction::Right).unwrap_err(), + BlobError::NotOwner + ); + } + + #[test] + fn demo_map_valid() { + validate_map(&demo_map()).unwrap(); + } + + #[test] + fn start_with_demo_uses_generated_passable_map() { + let mut g = BlobGame::default(); + g.start_with_demo("g-rand", "alice").unwrap(); + assert_eq!(g.map[0][0], tile::PLAYER); + assert!(is_hamiltonian_passable(&g.map)); + assert!(g.map.len() >= 5); + } +} diff --git a/tests/e2e-ui/crates/blob-domain/src/models/blob_game_fact.rs b/tests/e2e-ui/crates/blob-domain/src/models/blob_game_fact.rs new file mode 100644 index 00000000..33e4f801 --- /dev/null +++ b/tests/e2e-ui/crates/blob-domain/src/models/blob_game_fact.rs @@ -0,0 +1,23 @@ +use serde::{Deserialize, Serialize}; + +use super::BlobGame; + +/// Full snapshot fact written on every blob event (projector upsert source). +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub struct BlobGameFact { + pub game_id: String, + pub owner_id: String, + pub score: i64, + pub player_dead: bool, + pub current_level: i64, + pub current_level_completed: bool, + /// JSON-encoded `number[][]` of tile ints. + pub map_json: String, + pub status: String, +} + +impl BlobGameFact { + pub fn from_game(g: &BlobGame) -> Self { + g.fact() + } +} diff --git a/tests/e2e-ui/crates/blob-domain/src/models/direction.rs b/tests/e2e-ui/crates/blob-domain/src/models/direction.rs new file mode 100644 index 00000000..c2f35d8c --- /dev/null +++ b/tests/e2e-ui/crates/blob-domain/src/models/direction.rs @@ -0,0 +1,31 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)] +#[serde(rename_all = "snake_case")] +pub enum Direction { + Up, + Down, + Left, + Right, +} + +impl Direction { + pub fn parse(s: &str) -> Option { + match s.trim().to_ascii_lowercase().as_str() { + "up" => Some(Self::Up), + "down" => Some(Self::Down), + "left" => Some(Self::Left), + "right" => Some(Self::Right), + _ => None, + } + } + + pub fn as_str(self) -> &'static str { + match self { + Self::Up => "up", + Self::Down => "down", + Self::Left => "left", + Self::Right => "right", + } + } +} diff --git a/tests/e2e-ui/crates/blob-domain/src/models/mod.rs b/tests/e2e-ui/crates/blob-domain/src/models/mod.rs new file mode 100644 index 00000000..cedf497a --- /dev/null +++ b/tests/e2e-ui/crates/blob-domain/src/models/mod.rs @@ -0,0 +1,12 @@ +//! Blob game domain models. + +mod blob_error; +mod blob_game; +mod blob_game_fact; +mod direction; +pub mod tile; + +pub use blob_error::BlobError; +pub use blob_game::{test_map_no_holes, test_map_with_hole, BlobGame}; +pub use blob_game_fact::BlobGameFact; +pub use direction::Direction; diff --git a/tests/e2e-ui/crates/blob-domain/src/models/tile.rs b/tests/e2e-ui/crates/blob-domain/src/models/tile.rs new file mode 100644 index 00000000..5534c1cb --- /dev/null +++ b/tests/e2e-ui/crates/blob-domain/src/models/tile.rs @@ -0,0 +1,8 @@ +//! Canonical tile values (JS parity). + +pub const HOLE: u8 = 0; +pub const UNVISITED: u8 = 1; +pub const VISITED: u8 = 2; +pub const DEAD_BY_SUICIDE: u8 = 3; +pub const DEAD_BY_HOLE: u8 = 4; +pub const PLAYER: u8 = 9; diff --git a/tests/e2e-ui/crates/chat-domain/src/lib.rs b/tests/e2e-ui/crates/chat-domain/src/lib.rs index deea6e7f..d95b33d7 100644 --- a/tests/e2e-ui/crates/chat-domain/src/lib.rs +++ b/tests/e2e-ui/crates/chat-domain/src/lib.rs @@ -1,143 +1,5 @@ //! Chat message aggregate — post to a room; author is the session user. -use distributed::{sourced, Entity}; -use serde::{Deserialize, Serialize}; -use thiserror::Error; +pub mod models; -#[derive(Debug, Error, PartialEq, Eq)] -pub enum ChatError { - #[error("message already exists")] - AlreadyExists, - #[error("empty message id")] - EmptyId, - #[error("empty author id")] - EmptyAuthor, - #[error("empty room id")] - EmptyRoom, - #[error("empty body")] - EmptyBody, - #[error(transparent)] - Event(#[from] distributed::EventRecordError), -} - -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -pub struct ChatMessage { - #[serde(skip, default)] - pub entity: Entity, - pub message_id: String, - pub room_id: String, - pub author_id: String, - pub body: String, - /// RFC3339 timestamp (string for portable projections / SQLite text). - pub created_at: String, -} - -impl ChatMessage { - pub fn is_posted(&self) -> bool { - !self.message_id.is_empty() - } -} - -#[sourced(entity, events = "ChatMessageEvent", aggregate_type = "chat_message")] -impl ChatMessage { - pub fn post( - &mut self, - message_id: impl Into, - room_id: impl Into, - author_id: impl Into, - body: impl Into, - created_at: impl Into, - ) -> Result<(), ChatError> { - if self.is_posted() { - return Err(ChatError::AlreadyExists); - } - let message_id = message_id.into(); - let room_id = room_id.into(); - let author_id = author_id.into(); - let body = body.into(); - let created_at = created_at.into(); - if message_id.trim().is_empty() { - return Err(ChatError::EmptyId); - } - if room_id.trim().is_empty() { - return Err(ChatError::EmptyRoom); - } - if author_id.trim().is_empty() { - return Err(ChatError::EmptyAuthor); - } - let body = body.trim(); - if body.is_empty() { - return Err(ChatError::EmptyBody); - } - self.record_posted( - message_id, - room_id, - author_id, - body.to_string(), - created_at, - )?; - Ok(()) - } - - #[event("chat_message.posted")] - fn record_posted( - &mut self, - message_id: String, - room_id: String, - author_id: String, - body: String, - created_at: String, - ) { - self.entity.set_id(&message_id); - self.message_id = message_id; - self.room_id = room_id; - self.author_id = author_id; - self.body = body; - self.created_at = created_at; - } -} - -#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] -pub struct ChatMessagePosted { - pub message_id: String, - pub room_id: String, - pub author_id: String, - pub body: String, - pub created_at: String, -} - -impl ChatMessagePosted { - pub fn from_message(m: &ChatMessage) -> Self { - Self { - message_id: m.message_id.clone(), - room_id: m.room_id.clone(), - author_id: m.author_id.clone(), - body: m.body.clone(), - created_at: m.created_at.clone(), - } - } -} - -#[cfg(test)] -mod tests { - use super::*; - - #[test] - fn post_sets_fields() { - let mut m = ChatMessage::default(); - m.post("m1", "lobby", "alice", "hello", "2026-01-01T00:00:00Z") - .unwrap(); - assert!(m.is_posted()); - assert_eq!(m.body, "hello"); - assert_eq!(m.author_id, "alice"); - } - - #[test] - fn rejects_empty_body() { - let mut m = ChatMessage::default(); - assert_eq!( - m.post("m1", "lobby", "alice", " ", "t").unwrap_err(), - ChatError::EmptyBody - ); - } -} +pub use models::{ChatError, ChatMessage, ChatMessagePosted}; diff --git a/tests/e2e-ui/crates/chat-domain/src/models/chat_error.rs b/tests/e2e-ui/crates/chat-domain/src/models/chat_error.rs new file mode 100644 index 00000000..a3e68c81 --- /dev/null +++ b/tests/e2e-ui/crates/chat-domain/src/models/chat_error.rs @@ -0,0 +1,17 @@ +use thiserror::Error; + +#[derive(Debug, Error, PartialEq, Eq)] +pub enum ChatError { + #[error("message already exists")] + AlreadyExists, + #[error("empty message id")] + EmptyId, + #[error("empty author id")] + EmptyAuthor, + #[error("empty room id")] + EmptyRoom, + #[error("empty body")] + EmptyBody, + #[error(transparent)] + Event(#[from] distributed::EventRecordError), +} diff --git a/tests/e2e-ui/crates/chat-domain/src/models/chat_message.rs b/tests/e2e-ui/crates/chat-domain/src/models/chat_message.rs new file mode 100644 index 00000000..2ab6ae2e --- /dev/null +++ b/tests/e2e-ui/crates/chat-domain/src/models/chat_message.rs @@ -0,0 +1,105 @@ +use distributed::{sourced, Entity}; +use serde::{Deserialize, Serialize}; + +use super::ChatError; + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +pub struct ChatMessage { + #[serde(skip, default)] + pub entity: Entity, + pub message_id: String, + pub room_id: String, + pub author_id: String, + pub body: String, + /// RFC3339 timestamp (string for portable projections / SQLite text). + pub created_at: String, +} + +impl ChatMessage { + pub fn is_posted(&self) -> bool { + !self.message_id.is_empty() + } +} + +#[sourced(entity, events = "ChatMessageEvent", aggregate_type = "chat_message")] +impl ChatMessage { + pub fn post( + &mut self, + message_id: impl Into, + room_id: impl Into, + author_id: impl Into, + body: impl Into, + created_at: impl Into, + ) -> Result<(), ChatError> { + if self.is_posted() { + return Err(ChatError::AlreadyExists); + } + let message_id = message_id.into(); + let room_id = room_id.into(); + let author_id = author_id.into(); + let body = body.into(); + let created_at = created_at.into(); + if message_id.trim().is_empty() { + return Err(ChatError::EmptyId); + } + if room_id.trim().is_empty() { + return Err(ChatError::EmptyRoom); + } + if author_id.trim().is_empty() { + return Err(ChatError::EmptyAuthor); + } + let body = body.trim(); + if body.is_empty() { + return Err(ChatError::EmptyBody); + } + self.record_posted( + message_id, + room_id, + author_id, + body.to_string(), + created_at, + )?; + Ok(()) + } + + #[event("chat_message.posted")] + fn record_posted( + &mut self, + message_id: String, + room_id: String, + author_id: String, + body: String, + created_at: String, + ) { + self.entity.set_id(&message_id); + self.message_id = message_id; + self.room_id = room_id; + self.author_id = author_id; + self.body = body; + self.created_at = created_at; + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn post_sets_fields() { + let mut m = ChatMessage::default(); + m.post("m1", "lobby", "alice", "hello", "2026-01-01T00:00:00Z") + .unwrap(); + assert!(m.is_posted()); + assert_eq!(m.body, "hello"); + assert_eq!(m.author_id, "alice"); + } + + #[test] + fn rejects_empty_body() { + let mut m = ChatMessage::default(); + assert_eq!( + m.post("m1", "lobby", "alice", " ", "t").unwrap_err(), + ChatError::EmptyBody + ); + } +} diff --git a/tests/e2e-ui/crates/chat-domain/src/models/chat_message_posted.rs b/tests/e2e-ui/crates/chat-domain/src/models/chat_message_posted.rs new file mode 100644 index 00000000..fcac0bc9 --- /dev/null +++ b/tests/e2e-ui/crates/chat-domain/src/models/chat_message_posted.rs @@ -0,0 +1,24 @@ +use serde::{Deserialize, Serialize}; + +use super::ChatMessage; + +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +pub struct ChatMessagePosted { + pub message_id: String, + pub room_id: String, + pub author_id: String, + pub body: String, + pub created_at: String, +} + +impl ChatMessagePosted { + pub fn from_message(m: &ChatMessage) -> Self { + Self { + message_id: m.message_id.clone(), + room_id: m.room_id.clone(), + author_id: m.author_id.clone(), + body: m.body.clone(), + created_at: m.created_at.clone(), + } + } +} diff --git a/tests/e2e-ui/crates/chat-domain/src/models/mod.rs b/tests/e2e-ui/crates/chat-domain/src/models/mod.rs new file mode 100644 index 00000000..6f70110f --- /dev/null +++ b/tests/e2e-ui/crates/chat-domain/src/models/mod.rs @@ -0,0 +1,9 @@ +//! Chat domain models. + +mod chat_error; +mod chat_message; +mod chat_message_posted; + +pub use chat_error::ChatError; +pub use chat_message::ChatMessage; +pub use chat_message_posted::ChatMessagePosted; diff --git a/tests/e2e-ui/crates/readmodels/Cargo.toml b/tests/e2e-ui/crates/readmodels/Cargo.toml index f6f39ce3..33ecdad7 100644 --- a/tests/e2e-ui/crates/readmodels/Cargo.toml +++ b/tests/e2e-ui/crates/readmodels/Cargo.toml @@ -8,5 +8,7 @@ description = "Todo read models (TodoView) + project manifest" [dependencies] distributed = { workspace = true } serde = { workspace = true } +serde_json = { workspace = true } todo-domain = { path = "../todo-domain" } chat-domain = { path = "../chat-domain" } +blob-domain = { path = "../blob-domain" } diff --git a/tests/e2e-ui/crates/readmodels/src/lib.rs b/tests/e2e-ui/crates/readmodels/src/lib.rs index 0084ed5f..b0f29550 100644 --- a/tests/e2e-ui/crates/readmodels/src/lib.rs +++ b/tests/e2e-ui/crates/readmodels/src/lib.rs @@ -1,60 +1,55 @@ -//! Read models for the e2e-ui fixture (todos + chat). -//! Projected only from domain events (never from commands). +//! Read models for the e2e-ui fixture (todos + chat + blob games + auth users). +//! Projected only from domain / provider events (never from commands). -use chat_domain::ChatMessagePosted; -use distributed::ReadModel; -use serde::{Deserialize, Serialize}; -use todo_domain::TodoFact; +pub mod models; -/// Personal todo row. PK: `todo_id`. Isolation key: `owner_id`. -#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize, ReadModel)] -#[table("todos")] -pub struct TodoView { - #[id("todo_id")] - pub todo_id: String, - pub owner_id: String, - pub title: String, - /// `open` | `completed` | `archived` - pub status: String, -} - -/// Chat message row. PK: `message_id`. Live via GraphQL subscription on `chat_messages`. -#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize, ReadModel)] -#[table("chat_messages")] -pub struct ChatMessageView { - #[id("message_id")] - pub message_id: String, - pub room_id: String, - pub author_id: String, - pub body: String, - pub created_at: String, -} - -pub fn map_todo_fact(e: &TodoFact) -> TodoView { - TodoView { - todo_id: e.todo_id.clone(), - owner_id: e.owner_id.clone(), - title: e.title.clone(), - status: e.status.clone(), - } -} - -pub fn map_chat_posted(e: &ChatMessagePosted) -> ChatMessageView { - ChatMessageView { - message_id: e.message_id.clone(), - room_id: e.room_id.clone(), - author_id: e.author_id.clone(), - body: e.body.clone(), - created_at: e.created_at.clone(), - } -} - -// Back-compat alias used by todo projector. -pub use map_todo_fact as map_fact; +pub use models::{ + map_blob_fact, map_chat_posted, map_fact, map_todo_fact, map_zitadel_user_status, + map_zitadel_user_upsert, AuthUserView, BlobGameView, ChatMessageView, TodoView, ZitadelEmail, + ZitadelUserPayload, +}; pub fn distributed_manifest() -> distributed::DistributedProjectManifest { use distributed::RelationalReadModel; distributed::DistributedProjectManifest::new("e2e-ui") .table_schema(TodoView::schema().clone()) .table_schema(ChatMessageView::schema().clone()) + .table_schema(BlobGameView::schema().clone()) + .table_schema(AuthUserView::schema().clone()) +} + +#[cfg(test)] +mod tests { + use super::*; + use blob_domain::{demo_map, BlobGame, BlobGameFact}; + + #[test] + fn projector_map_reflects_post_move_fact() { + let mut g = BlobGame::default(); + g.start_with_demo("g1", "alice").unwrap(); + let before = map_blob_fact(&BlobGameFact::from_game(&g)); + assert_eq!(before.score, 0); + assert!(!before.player_dead); + + g.move_dir("alice", blob_domain::Direction::Right).unwrap(); + let after = map_blob_fact(&BlobGameFact::from_game(&g)); + assert_eq!(after.score, 1); + assert_eq!(after.game_id, "g1"); + assert_eq!(after.owner_id, "alice"); + assert!(after.map_json.contains("2")); // visited tile + // Map JSON must differ from pre-move + assert_ne!(before.map_json, after.map_json); + // Demo map player moved off origin + let map: Vec> = serde_json::from_str(&after.map_json).unwrap(); + assert_eq!(map[0][0], 2); // visited + assert_eq!(map[0][1], 9); // player + } + + #[test] + fn demo_map_json_roundtrip() { + let m = demo_map(); + let s = serde_json::to_string(&m).unwrap(); + let back: Vec> = serde_json::from_str(&s).unwrap(); + assert_eq!(m, back); + } } diff --git a/tests/e2e-ui/crates/readmodels/src/models/auth_user_view.rs b/tests/e2e-ui/crates/readmodels/src/models/auth_user_view.rs new file mode 100644 index 00000000..848e0bc2 --- /dev/null +++ b/tests/e2e-ui/crates/readmodels/src/models/auth_user_view.rs @@ -0,0 +1,141 @@ +//! Auth users imported from Zitadel Action ingress (provider messages → projector). + +use distributed::ReadModel; +use serde::{Deserialize, Serialize}; + +use super::{BlobGameView, ChatMessageView}; + +/// Imported IdP user. PK: `user_id` (= Zitadel subject / OIDC `sub` / session `x-user-id`). +/// +/// Populated only from the Zitadel ingestor projector — never from commands. +#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize, ReadModel)] +#[table("auth_users")] +pub struct AuthUserView { + #[id("user_id")] + pub user_id: String, + pub email: String, + pub display_name: String, + /// `human` | `machine` + pub user_kind: String, + /// `pending` | `approved` | `rejected` + pub approval_status: String, + /// `active` | `deactivated` + pub status: String, + pub updated_at: String, + #[readmodel(has_many = "ChatMessageView", foreign_key = "author_id")] + pub chat_messages: Vec, + #[readmodel(has_many = "BlobGameView", foreign_key = "owner_id")] + pub blob_games: Vec, +} + +/// Provider envelope published by `zitadel.ingress.v1` (fixture + Action shape). +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] +pub struct ZitadelUserPayload { + pub schema_version: u32, + pub source: String, + pub delivery_id: String, + pub provider: String, + pub provider_subject: String, + pub user_kind: String, + pub emails: Vec, + pub display_name: Option, + pub approval_status: String, + pub ingested_at: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] +pub struct ZitadelEmail { + pub address: String, + pub primary: bool, + pub verified: bool, +} + +/// Map a created/updated provider payload into an upsert row. +pub fn map_zitadel_user_upsert(event_name: &str, p: &ZitadelUserPayload) -> AuthUserView { + let email = p + .emails + .iter() + .find(|e| e.primary) + .or_else(|| p.emails.first()) + .map(|e| e.address.clone()) + .unwrap_or_default(); + let display_name = p + .display_name + .clone() + .filter(|s| !s.trim().is_empty()) + .unwrap_or_else(|| { + if email.is_empty() { + p.provider_subject.clone() + } else { + email.clone() + } + }); + let status = if event_name.contains("deactivated") { + "deactivated".into() + } else { + "active".into() + }; + AuthUserView { + user_id: p.provider_subject.clone(), + email, + display_name, + user_kind: p.user_kind.clone(), + approval_status: p.approval_status.clone(), + status, + updated_at: p.ingested_at.clone(), + chat_messages: Vec::new(), + blob_games: Vec::new(), + } +} + +/// Status-only patch for deactivate / reactivate when no profile fields are present. +pub fn map_zitadel_user_status(event_name: &str, p: &ZitadelUserPayload) -> AuthUserView { + let mut row = map_zitadel_user_upsert(event_name, p); + if event_name.contains("reactivated") { + row.status = "active".into(); + } else if event_name.contains("deactivated") { + row.status = "deactivated".into(); + } + row +} + +#[cfg(test)] +mod tests { + use super::*; + + fn payload() -> ZitadelUserPayload { + ZitadelUserPayload { + schema_version: 1, + source: "zitadel".into(), + delivery_id: "d1".into(), + provider: "zitadel".into(), + provider_subject: "user-99".into(), + user_kind: "human".into(), + emails: vec![ZitadelEmail { + address: "ada@example.com".into(), + primary: true, + verified: true, + }], + display_name: Some("Ada".into()), + approval_status: "pending".into(), + ingested_at: "2026-01-01T00:00:00Z".into(), + } + } + + #[test] + fn created_maps_active_user() { + let row = map_zitadel_user_upsert("zitadel.user.human.created.v1", &payload()); + assert_eq!(row.user_id, "user-99"); + assert_eq!(row.email, "ada@example.com"); + assert_eq!(row.display_name, "Ada"); + assert_eq!(row.status, "active"); + assert_eq!(row.approval_status, "pending"); + } + + #[test] + fn deactivated_sets_status() { + let row = map_zitadel_user_status("zitadel.user.human.deactivated.v1", &payload()); + assert_eq!(row.status, "deactivated"); + assert_eq!(row.user_id, "user-99"); + } +} diff --git a/tests/e2e-ui/crates/readmodels/src/models/blob_game_view.rs b/tests/e2e-ui/crates/readmodels/src/models/blob_game_view.rs new file mode 100644 index 00000000..30760228 --- /dev/null +++ b/tests/e2e-ui/crates/readmodels/src/models/blob_game_view.rs @@ -0,0 +1,40 @@ +use blob_domain::BlobGameFact; +use distributed::ReadModel; +use serde::{Deserialize, Serialize}; + +use super::AuthUserView; + +/// Blob game row. PK: `game_id`. Isolation key: `owner_id`. +/// `map_json` is the projected grid (tile ints); updated only from domain events. +/// +/// `owner` is a GraphQL join onto imported [`AuthUserView`] (`owner_id` = `user_id`). +#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize, ReadModel)] +#[table("blob_games")] +pub struct BlobGameView { + #[id("game_id")] + pub game_id: String, + pub owner_id: String, + pub score: i64, + pub player_dead: bool, + pub current_level: i64, + pub current_level_completed: bool, + pub map_json: String, + /// `active` | `dead` | `level_complete` + pub status: String, + #[readmodel(belongs_to = "AuthUserView", foreign_key = "owner_id")] + pub owner: Option, +} + +pub fn map_blob_fact(e: &BlobGameFact) -> BlobGameView { + BlobGameView { + game_id: e.game_id.clone(), + owner_id: e.owner_id.clone(), + score: e.score, + player_dead: e.player_dead, + current_level: e.current_level, + current_level_completed: e.current_level_completed, + map_json: e.map_json.clone(), + status: e.status.clone(), + owner: None, + } +} diff --git a/tests/e2e-ui/crates/readmodels/src/models/chat_message_view.rs b/tests/e2e-ui/crates/readmodels/src/models/chat_message_view.rs new file mode 100644 index 00000000..f733f98d --- /dev/null +++ b/tests/e2e-ui/crates/readmodels/src/models/chat_message_view.rs @@ -0,0 +1,32 @@ +use chat_domain::ChatMessagePosted; +use distributed::ReadModel; +use serde::{Deserialize, Serialize}; + +use super::AuthUserView; + +/// Chat message row. PK: `message_id`. Live via GraphQL subscription on `chat_messages`. +/// +/// `author` is a GraphQL join onto imported [`AuthUserView`] (`author_id` = `user_id`). +#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize, ReadModel)] +#[table("chat_messages")] +pub struct ChatMessageView { + #[id("message_id")] + pub message_id: String, + pub room_id: String, + pub author_id: String, + pub body: String, + pub created_at: String, + #[readmodel(belongs_to = "AuthUserView", foreign_key = "author_id")] + pub author: Option, +} + +pub fn map_chat_posted(e: &ChatMessagePosted) -> ChatMessageView { + ChatMessageView { + message_id: e.message_id.clone(), + room_id: e.room_id.clone(), + author_id: e.author_id.clone(), + body: e.body.clone(), + created_at: e.created_at.clone(), + author: None, + } +} diff --git a/tests/e2e-ui/crates/readmodels/src/models/mod.rs b/tests/e2e-ui/crates/readmodels/src/models/mod.rs new file mode 100644 index 00000000..5ccbef94 --- /dev/null +++ b/tests/e2e-ui/crates/readmodels/src/models/mod.rs @@ -0,0 +1,16 @@ +//! Projected read-model views for e2e-ui. + +mod auth_user_view; +mod blob_game_view; +mod chat_message_view; +mod todo_view; + +pub use auth_user_view::{ + map_zitadel_user_status, map_zitadel_user_upsert, AuthUserView, ZitadelEmail, ZitadelUserPayload, +}; +pub use blob_game_view::{map_blob_fact, BlobGameView}; +pub use chat_message_view::{map_chat_posted, ChatMessageView}; +pub use todo_view::{map_todo_fact, TodoView}; + +// Back-compat alias used by todo projector. +pub use map_todo_fact as map_fact; diff --git a/tests/e2e-ui/crates/readmodels/src/models/todo_view.rs b/tests/e2e-ui/crates/readmodels/src/models/todo_view.rs new file mode 100644 index 00000000..3e31b76a --- /dev/null +++ b/tests/e2e-ui/crates/readmodels/src/models/todo_view.rs @@ -0,0 +1,24 @@ +use distributed::ReadModel; +use serde::{Deserialize, Serialize}; +use todo_domain::TodoFact; + +/// Personal todo row. PK: `todo_id`. Isolation key: `owner_id`. +#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize, ReadModel)] +#[table("todos")] +pub struct TodoView { + #[id("todo_id")] + pub todo_id: String, + pub owner_id: String, + pub title: String, + /// `open` | `completed` | `archived` + pub status: String, +} + +pub fn map_todo_fact(e: &TodoFact) -> TodoView { + TodoView { + todo_id: e.todo_id.clone(), + owner_id: e.owner_id.clone(), + title: e.title.clone(), + status: e.status.clone(), + } +} diff --git a/tests/e2e-ui/crates/runner/src/main.rs b/tests/e2e-ui/crates/runner/src/main.rs index b93a8edb..f8927556 100644 --- a/tests/e2e-ui/crates/runner/src/main.rs +++ b/tests/e2e-ui/crates/runner/src/main.rs @@ -4,6 +4,8 @@ //! - `DATABASE_URL` — `sqlite:…` (default) or `postgres://…` //! - `BIND` (default `127.0.0.1:8791`) //! - `OIDC_ISSUER` / `OIDC_AUDIENCE` / `OIDC_JWKS_URI` → OidcBearer; else DevHeaders +//! - `ZITADEL_SERVICE_USER_TOKEN` + `OIDC_ISSUER`/`ZITADEL_API_URL` → periodic user scrape +//! - `ZITADEL_SCRAPE_INTERVAL_SECS` (default 60; `0` = no background loop) use std::env; use std::sync::Arc; @@ -16,6 +18,7 @@ use distributed::{ }; use e2e_service::{ build_graphql_engine, build_service, distributed_manifest, identity_from_env, serve_with_oidc, + spawn_scrape_loop, ZitadelScrapeConfig, }; const BUS_GROUP: &str = "e2e-ui"; @@ -59,6 +62,7 @@ async fn run_sqlite( spawn_outbox_sqlite(repo.clone()); spawn_consumer_sqlite(repo.clone(), locks); + spawn_zitadel_scrape(repo.clone()); eprintln!("e2e-ui (sqlite) listening on http://{bind}"); serve_with_oidc(http_service, identity, bind).await?; @@ -90,12 +94,38 @@ async fn run_postgres( spawn_outbox_postgres(repo.clone()); spawn_consumer_postgres(repo.clone(), locks); + spawn_zitadel_scrape(repo.clone()); eprintln!("e2e-ui (postgres) listening on http://{bind}"); serve_with_oidc(http_service, identity, bind).await?; Ok(()) } +fn spawn_zitadel_scrape(repo: R) +where + R: distributed::TransactionalCommit + Clone + Send + Sync + 'static, +{ + match ZitadelScrapeConfig::from_env() { + Some(cfg) if cfg.background_enabled() || cfg.on_start => { + eprintln!( + "zitadel scrape: enabled (api={}, interval={}s, on_start={})", + cfg.api_base, + cfg.interval.as_secs(), + cfg.on_start + ); + spawn_scrape_loop(repo, cfg); + } + Some(_) => { + eprintln!("zitadel scrape: credentials present, background off (interval=0); use POST /zitadel.scrape.v1"); + } + None => { + eprintln!( + "zitadel scrape: disabled (set ZITADEL_SERVICE_USER_TOKEN + OIDC_ISSUER/ZITADEL_API_URL)" + ); + } + } +} + fn spawn_outbox_sqlite(repo: SqliteRepository) { tokio::spawn(async move { let bus = Arc::new(SqliteBus::new(repo.pool().clone()).group(BUS_GROUP)); diff --git a/tests/e2e-ui/crates/service/Cargo.toml b/tests/e2e-ui/crates/service/Cargo.toml index 0b06adc2..2231c3f0 100644 --- a/tests/e2e-ui/crates/service/Cargo.toml +++ b/tests/e2e-ui/crates/service/Cargo.toml @@ -12,8 +12,10 @@ serde_json = { workspace = true } tokio = { workspace = true } sqlx = { workspace = true } axum = { workspace = true } +reqwest = { workspace = true } tower = "0.5" futures-util = "0.3" todo-domain = { path = "../todo-domain" } chat-domain = { path = "../chat-domain" } +blob-domain = { path = "../blob-domain" } e2e-readmodels = { path = "../readmodels" } diff --git a/tests/e2e-ui/crates/service/src/deps.rs b/tests/e2e-ui/crates/service/src/deps.rs index e974642f..862ec55f 100644 --- a/tests/e2e-ui/crates/service/src/deps.rs +++ b/tests/e2e-ui/crates/service/src/deps.rs @@ -1,3 +1,4 @@ +use blob_domain::BlobGame; use chat_domain::ChatMessage; use distributed::microsvc::RepoReadModelDependencies; use distributed::{AggregateRepository, QueuedRepository}; @@ -9,3 +10,10 @@ pub type TodoDeps = RepoReadModelDependencies, S>; pub type ChatRepo = AggregateRepository, ChatMessage>; pub type ChatDeps = RepoReadModelDependencies, S>; + +pub type BlobRepo = AggregateRepository, BlobGame>; +pub type BlobDeps = RepoReadModelDependencies, S>; + +/// Zitadel ingress + auth_users projector share the chat aggregate repo for outbox/leaf access +/// (ingestor is leaf-only; no chat stream is written on ingress). +pub type AuthDeps = ChatDeps; diff --git a/tests/e2e-ui/crates/service/src/handlers/commands/blob_cmd.rs b/tests/e2e-ui/crates/service/src/handlers/commands/blob_cmd.rs new file mode 100644 index 00000000..120c9331 --- /dev/null +++ b/tests/e2e-ui/crates/service/src/handlers/commands/blob_cmd.rs @@ -0,0 +1,79 @@ +//! Shared load + commit path for blob game commands. +//! +//! After the aggregate commits, we **upsert the read model in the command path** +//! so the GraphQL mutation response is the live projected row. The UI applies +//! that payload immediately — no waiting on eventual projectors, and no +//! re-implementing domain rules in the browser. + +use blob_domain::{BlobGame, BlobGameFact}; +use distributed::microsvc::{Context, HandlerError}; +use distributed::{OutboxMessage, ReadModelWritePlanBuilder}; +use e2e_readmodels::map_blob_fact; +use serde_json::{json, Value}; + +use crate::bounds::{EventStore, Locks, ReadStore}; +use crate::deps::BlobDeps; +use crate::handlers::util::{read_model_error, rejected}; + +pub async fn load_game( + ctx: &Context<'_, BlobDeps>, + game_id: &str, +) -> Result +where + R: EventStore, + L: Locks, + S: ReadStore, +{ + ctx.repo() + .get(game_id) + .await? + .ok_or_else(|| HandlerError::NotFound(game_id.to_string())) +} + +/// Commit domain event to the event store/outbox, then write the read model +/// so the mutation payload matches what GraphQL queries will see. +pub async fn commit_blob_event( + ctx: &Context<'_, BlobDeps>, + game: &mut BlobGame, + event_name: &str, +) -> Result +where + R: EventStore, + L: Locks, + S: ReadStore, +{ + let fact = BlobGameFact::from_game(game); + let outbox = OutboxMessage::encode( + format!("{}:{}:{}", game.game_id, event_name, game.entity.version()), + event_name, + &fact, + ) + .map_err(|e| HandlerError::Other(Box::new(e)))?; + ctx.repo().outbox(outbox).commit(game).await?; + + // Synchronous RM write for command-response UX (projectors remain idempotent). + let row = map_blob_fact(&fact); + let store = ctx.read_model_store(); + let mut plan = ReadModelWritePlanBuilder::new(); + plan.upsert(&row).map_err(read_model_error)?; + plan.commit(store).await.map_err(read_model_error)?; + + Ok(fact) +} + +pub fn fact_json(fact: &BlobGameFact) -> Value { + json!({ + "game_id": fact.game_id, + "owner_id": fact.owner_id, + "score": fact.score, + "player_dead": fact.player_dead, + "current_level": fact.current_level, + "current_level_completed": fact.current_level_completed, + "map_json": fact.map_json, + "status": fact.status, + }) +} + +pub fn map_domain(err: impl std::fmt::Display) -> HandlerError { + rejected(err) +} diff --git a/tests/e2e-ui/crates/service/src/handlers/commands/blob_move.rs b/tests/e2e-ui/crates/service/src/handlers/commands/blob_move.rs new file mode 100644 index 00000000..1f7e0ab6 --- /dev/null +++ b/tests/e2e-ui/crates/service/src/handlers/commands/blob_move.rs @@ -0,0 +1,53 @@ +//! Command: `blob.move` — direction up|down|left|right. + +use blob_domain::Direction; +use distributed::microsvc::{Context, HandlerError}; +use serde::Deserialize; +use serde_json::Value; + +use crate::deps::BlobDeps; +use crate::handlers::commands::blob_cmd::{ + commit_blob_event, fact_json, load_game, map_domain, +}; +use crate::handlers::util::{require_user, session_has_user}; + +pub const COMMAND: &str = "blob.move"; + +#[derive(Debug, Deserialize, distributed::GraphqlInput)] +pub struct BlobMoveInput { + pub game_id: String, + pub direction: String, +} + +pub fn guard(ctx: &Context>) -> bool +where + R: crate::bounds::EventStore, + L: crate::bounds::Locks, + S: crate::bounds::ReadStore, +{ + ctx.has_fields(&["game_id", "direction"]) && session_has_user(ctx.session()) +} + +pub async fn handle( + ctx: &Context<'_, BlobDeps>, +) -> Result +where + R: crate::bounds::EventStore, + L: crate::bounds::Locks, + S: crate::bounds::ReadStore, +{ + let owner = require_user(ctx.session())?; + let input = ctx.input::()?; + let dir = Direction::parse(&input.direction).ok_or_else(|| { + HandlerError::Rejected(format!( + "invalid direction `{}` (use up|down|left|right)", + input.direction + )) + })?; + + let mut game = load_game(ctx, &input.game_id).await?; + game.move_dir(&owner, dir).map_err(map_domain)?; + + let fact = commit_blob_event(ctx, &mut game, "blob.moved").await?; + Ok(fact_json(&fact)) +} diff --git a/tests/e2e-ui/crates/service/src/handlers/commands/blob_start.rs b/tests/e2e-ui/crates/service/src/handlers/commands/blob_start.rs new file mode 100644 index 00000000..62f60770 --- /dev/null +++ b/tests/e2e-ui/crates/service/src/handlers/commands/blob_start.rs @@ -0,0 +1,64 @@ +//! Command: `blob.start` — create game + demo level. Owner = session user. + +use blob_domain::BlobGame; +use distributed::microsvc::{Context, HandlerError}; +use serde::{Deserialize, Serialize}; +use serde_json::Value; + +use crate::deps::BlobDeps; +use crate::handlers::commands::blob_cmd::{commit_blob_event, fact_json, map_domain}; +use crate::handlers::util::{require_user, session_has_user}; + +pub const COMMAND: &str = "blob.start"; + +#[derive(Debug, Deserialize, distributed::GraphqlInput)] +pub struct BlobStartInput { + pub game_id: String, +} + +#[derive(Debug, Serialize, distributed::GraphqlOutput)] +pub struct BlobGamePayload { + pub game_id: String, + pub owner_id: String, + pub score: i64, + pub player_dead: bool, + pub current_level: i64, + pub current_level_completed: bool, + pub map_json: String, + pub status: String, +} + +pub fn guard(ctx: &Context>) -> bool +where + R: crate::bounds::EventStore, + L: crate::bounds::Locks, + S: crate::bounds::ReadStore, +{ + ctx.has_fields(&["game_id"]) && session_has_user(ctx.session()) +} + +pub async fn handle( + ctx: &Context<'_, BlobDeps>, +) -> Result +where + R: crate::bounds::EventStore, + L: crate::bounds::Locks, + S: crate::bounds::ReadStore, +{ + let owner = require_user(ctx.session())?; + let input = ctx.input::()?; + + if ctx.repo().get(&input.game_id).await?.is_some() { + return Err(HandlerError::Rejected(format!( + "game {} already exists", + input.game_id + ))); + } + + let mut game = BlobGame::default(); + game.start_with_demo(&input.game_id, &owner) + .map_err(map_domain)?; + + let fact = commit_blob_event(ctx, &mut game, "blob.started").await?; + Ok(fact_json(&fact)) +} diff --git a/tests/e2e-ui/crates/service/src/handlers/commands/blob_start_level.rs b/tests/e2e-ui/crates/service/src/handlers/commands/blob_start_level.rs new file mode 100644 index 00000000..ef1ef87d --- /dev/null +++ b/tests/e2e-ui/crates/service/src/handlers/commands/blob_start_level.rs @@ -0,0 +1,44 @@ +//! Command: `blob.start_level` — next level after complete (new generated map). + +use distributed::microsvc::{Context, HandlerError}; +use serde::Deserialize; +use serde_json::Value; + +use crate::deps::BlobDeps; +use crate::handlers::commands::blob_cmd::{ + commit_blob_event, fact_json, load_game, map_domain, +}; +use crate::handlers::util::{require_user, session_has_user}; + +pub const COMMAND: &str = "blob.start_level"; + +#[derive(Debug, Deserialize, distributed::GraphqlInput)] +pub struct BlobStartLevelInput { + pub game_id: String, +} + +pub fn guard(ctx: &Context>) -> bool +where + R: crate::bounds::EventStore, + L: crate::bounds::Locks, + S: crate::bounds::ReadStore, +{ + ctx.has_fields(&["game_id"]) && session_has_user(ctx.session()) +} + +pub async fn handle( + ctx: &Context<'_, BlobDeps>, +) -> Result +where + R: crate::bounds::EventStore, + L: crate::bounds::Locks, + S: crate::bounds::ReadStore, +{ + let owner = require_user(ctx.session())?; + let input = ctx.input::()?; + let mut game = load_game(ctx, &input.game_id).await?; + // Fresh passable layout each level (like original generateLevel) + game.start_next_generated_level(&owner).map_err(map_domain)?; + let fact = commit_blob_event(ctx, &mut game, "blob.level_started").await?; + Ok(fact_json(&fact)) +} diff --git a/tests/e2e-ui/crates/service/src/handlers/commands/mod.rs b/tests/e2e-ui/crates/service/src/handlers/commands/mod.rs index c3942bd3..5087dc26 100644 --- a/tests/e2e-ui/crates/service/src/handlers/commands/mod.rs +++ b/tests/e2e-ui/crates/service/src/handlers/commands/mod.rs @@ -1,4 +1,8 @@ pub mod archive; +pub mod blob_cmd; +pub mod blob_move; +pub mod blob_start; +pub mod blob_start_level; pub mod chat_post; pub mod complete; pub mod create; diff --git a/tests/e2e-ui/crates/service/src/handlers/events/mod.rs b/tests/e2e-ui/crates/service/src/handlers/events/mod.rs index e407d815..d5c8ebc8 100644 --- a/tests/e2e-ui/crates/service/src/handlers/events/mod.rs +++ b/tests/e2e-ui/crates/service/src/handlers/events/mod.rs @@ -1,2 +1,4 @@ +pub mod project_auth_user; +pub mod project_blob; pub mod project_chat; pub mod project_todo; diff --git a/tests/e2e-ui/crates/service/src/handlers/events/project_auth_user.rs b/tests/e2e-ui/crates/service/src/handlers/events/project_auth_user.rs new file mode 100644 index 00000000..3a5c3927 --- /dev/null +++ b/tests/e2e-ui/crates/service/src/handlers/events/project_auth_user.rs @@ -0,0 +1,57 @@ +//! Project `zitadel.user.*.v1` → `auth_users` (join target for chat + blob games). + +use distributed::microsvc::{Context, HandlerError}; +use distributed::ReadModelWritePlanBuilder; +use e2e_readmodels::{ + map_zitadel_user_status, map_zitadel_user_upsert, ZitadelUserPayload, +}; +use serde_json::{json, Value}; + +use crate::deps::AuthDeps; +use crate::handlers::util::{decode_payload, read_model_error}; + +pub const EVENTS: &[&str] = &[ + "zitadel.user.human.created.v1", + "zitadel.user.human.updated.v1", + "zitadel.user.human.deactivated.v1", + "zitadel.user.human.reactivated.v1", + "zitadel.user.machine.created.v1", +]; + +pub fn guard(_ctx: &Context>) -> bool +where + R: crate::bounds::EventStore, + L: crate::bounds::Locks, + S: crate::bounds::ReadStore, +{ + true +} + +pub async fn handle( + ctx: &Context<'_, AuthDeps>, +) -> Result +where + R: crate::bounds::EventStore, + L: crate::bounds::Locks, + S: crate::bounds::ReadStore, +{ + let payload: ZitadelUserPayload = decode_payload(ctx.message())?; + let name = ctx.message().name(); + let row = if name.contains("deactivated") || name.contains("reactivated") { + map_zitadel_user_status(name, &payload) + } else { + map_zitadel_user_upsert(name, &payload) + }; + + let store = ctx.read_model_store(); + let mut plan = ReadModelWritePlanBuilder::new(); + plan.upsert(&row).map_err(read_model_error)?; + plan.commit(store).await.map_err(read_model_error)?; + + Ok(json!({ + "event": name, + "user_id": row.user_id, + "status": row.status, + "display_name": row.display_name, + })) +} diff --git a/tests/e2e-ui/crates/service/src/handlers/events/project_blob.rs b/tests/e2e-ui/crates/service/src/handlers/events/project_blob.rs new file mode 100644 index 00000000..8006fb95 --- /dev/null +++ b/tests/e2e-ui/crates/service/src/handlers/events/project_blob.rs @@ -0,0 +1,49 @@ +//! Project `blob.*` facts → `blob_games` read model. +//! Commands never write this table. + +use blob_domain::BlobGameFact; +use distributed::microsvc::{Context, HandlerError}; +use distributed::ReadModelWritePlanBuilder; +use e2e_readmodels::map_blob_fact; +use serde_json::{json, Value}; + +use crate::deps::BlobDeps; +use crate::handlers::util::{decode_payload, read_model_error}; + +pub const EVENTS: &[&str] = &[ + "blob.started", + "blob.initialized", + "blob.level_started", + "blob.moved", +]; + +pub fn guard(_ctx: &Context>) -> bool +where + R: crate::bounds::EventStore, + L: crate::bounds::Locks, + S: crate::bounds::ReadStore, +{ + true +} + +pub async fn handle( + ctx: &Context<'_, BlobDeps>, +) -> Result +where + R: crate::bounds::EventStore, + L: crate::bounds::Locks, + S: crate::bounds::ReadStore, +{ + let fact: BlobGameFact = decode_payload(ctx.message())?; + let row = map_blob_fact(&fact); + let store = ctx.read_model_store(); + let mut plan = ReadModelWritePlanBuilder::new(); + plan.upsert(&row).map_err(read_model_error)?; + plan.commit(store).await.map_err(read_model_error)?; + Ok(json!({ + "event": ctx.message().name(), + "game_id": fact.game_id, + "score": fact.score, + "status": fact.status, + })) +} diff --git a/tests/e2e-ui/crates/service/src/handlers/ingestors/mod.rs b/tests/e2e-ui/crates/service/src/handlers/ingestors/mod.rs new file mode 100644 index 00000000..b85b44a6 --- /dev/null +++ b/tests/e2e-ui/crates/service/src/handlers/ingestors/mod.rs @@ -0,0 +1,6 @@ +//! External ingress commands (provider webhooks / Actions / scrapes). +//! +//! These publish **provider** bus messages only; projectors map them into read models. + +pub mod zitadel; +pub mod zitadel_scrape; diff --git a/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/auth.rs b/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/auth.rs new file mode 100644 index 00000000..05e2785d --- /dev/null +++ b/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/auth.rs @@ -0,0 +1,152 @@ +//! Authenticity for Zitadel Action → HTTP deliveries. +//! +//! Paths: +//! 1. **Shared secret** header `x-zitadel-ingestor-secret` or `Authorization: Bearer` +//! 2. **Actions v2 event body** when `ZITADEL_INGESTOR_ALLOW_ACTION_EVENTS=1` (local only) + +use std::env; + +use distributed::microsvc::{HandlerError, Session}; + +/// Env var for the shared secret (required for fixture/curl path). +pub const SECRET_ENV: &str = "ZITADEL_INGESTOR_SECRET"; + +/// Preferred Action/HTTP header (lowercase session keys). +pub const SECRET_HEADER: &str = "x-zitadel-ingestor-secret"; + +/// When `1`/`true`, accept native Actions v2 event envelopes without shared secret. +pub const ALLOW_ACTION_EVENTS_ENV: &str = "ZITADEL_INGESTOR_ALLOW_ACTION_EVENTS"; + +pub fn configured_secret() -> Option { + env::var(SECRET_ENV).ok().filter(|s| !s.trim().is_empty()) +} + +pub fn allow_action_events() -> bool { + matches!( + env::var(ALLOW_ACTION_EVENTS_ENV) + .ok() + .as_deref() + .map(str::trim), + Some("1") | Some("true") | Some("TRUE") | Some("yes") + ) +} + +pub fn presented_secret(session: &Session) -> Option { + if let Some(v) = session.get(SECRET_HEADER).filter(|s| !s.is_empty()) { + return Some(v.to_string()); + } + if let Some(auth) = session.get("authorization") { + if let Some(token) = auth + .strip_prefix("Bearer ") + .or_else(|| auth.strip_prefix("bearer ")) + { + let token = token.trim(); + if !token.is_empty() { + return Some(token.to_string()); + } + } + } + None +} + +pub fn verify_authenticity( + session: &Session, + is_action_event: bool, +) -> Result<(), HandlerError> { + if let Some(presented) = presented_secret(session) { + let expected = configured_secret().ok_or_else(|| { + HandlerError::Unauthorized(format!( + "{SECRET_ENV} is not configured; refusing Zitadel ingress" + )) + })?; + if presented != expected { + return Err(HandlerError::Unauthorized( + "invalid Zitadel ingestor secret".into(), + )); + } + return Ok(()); + } + + if is_action_event && allow_action_events() { + return Ok(()); + } + + if is_action_event { + return Err(HandlerError::Unauthorized(format!( + "Action event rejected: set {ALLOW_ACTION_EVENTS_ENV}=1 (local) or send {SECRET_HEADER}" + ))); + } + + let _expected = configured_secret().ok_or_else(|| { + HandlerError::Unauthorized(format!( + "{SECRET_ENV} is not configured; refusing Zitadel ingress" + )) + })?; + Err(HandlerError::Unauthorized(format!( + "missing Zitadel authenticity ({SECRET_HEADER} or Authorization: Bearer)" + ))) +} + +#[cfg(test)] +mod tests { + use super::*; + use std::collections::HashMap; + use std::sync::Mutex; + + static ENV_LOCK: Mutex<()> = Mutex::new(()); + + fn with_env(secret: Option<&str>, allow_actions: bool, f: impl FnOnce()) { + let _g = ENV_LOCK.lock().unwrap(); + let prev_s = env::var(SECRET_ENV).ok(); + let prev_a = env::var(ALLOW_ACTION_EVENTS_ENV).ok(); + match secret { + Some(s) => env::set_var(SECRET_ENV, s), + None => env::remove_var(SECRET_ENV), + } + if allow_actions { + env::set_var(ALLOW_ACTION_EVENTS_ENV, "1"); + } else { + env::remove_var(ALLOW_ACTION_EVENTS_ENV); + } + f(); + match prev_s { + Some(s) => env::set_var(SECRET_ENV, s), + None => env::remove_var(SECRET_ENV), + } + match prev_a { + Some(s) => env::set_var(ALLOW_ACTION_EVENTS_ENV, s), + None => env::remove_var(ALLOW_ACTION_EVENTS_ENV), + } + } + + fn session(pairs: &[(&str, &str)]) -> Session { + let mut m = HashMap::new(); + for (k, v) in pairs { + m.insert((*k).to_string(), (*v).to_string()); + } + Session::from_map(m) + } + + #[test] + fn rejects_when_secret_not_configured() { + with_env(None, false, || { + let err = + verify_authenticity(&session(&[(SECRET_HEADER, "x")]), false).unwrap_err(); + assert!(matches!(err, HandlerError::Unauthorized(_))); + }); + } + + #[test] + fn accepts_matching_header() { + with_env(Some("s3cret"), false, || { + verify_authenticity(&session(&[(SECRET_HEADER, "s3cret")]), false).unwrap(); + }); + } + + #[test] + fn accepts_action_event_when_allowed() { + with_env(None, true, || { + verify_authenticity(&Session::new(), true).unwrap(); + }); + } +} diff --git a/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/handle.rs b/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/handle.rs new file mode 100644 index 00000000..006d61cd --- /dev/null +++ b/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/handle.rs @@ -0,0 +1,61 @@ +//! Command: `zitadel.ingress.v1` — verify + map + publish provider message only. + +use distributed::microsvc::{Context, HandlerError}; +use serde_json::{json, Value}; + +use super::auth::verify_authenticity; +use super::map::{looks_like_action_event, map_action_delivery, normalize_ingress_body}; +use super::publish::publish_mapped_delivery; +use crate::deps::AuthDeps; + +/// Public HTTP command name (POST `/{COMMAND}`). +pub const COMMAND: &str = "zitadel.ingress.v1"; + +pub fn guard(ctx: &Context>) -> bool +where + R: crate::bounds::EventStore, + L: crate::bounds::Locks, + S: Send + Sync + 'static, +{ + !ctx.raw_input().is_null() +} + +pub async fn handle( + ctx: &Context<'_, AuthDeps>, +) -> Result +where + R: crate::bounds::EventStore, + L: crate::bounds::Locks, + S: Send + Sync + 'static, +{ + let raw = ctx.raw_input().clone(); + let is_action_event = looks_like_action_event(&raw); + verify_authenticity(ctx.session(), is_action_event)?; + + let input = normalize_ingress_body(&raw); + let Some(mapped) = map_action_delivery(&input) else { + return Ok(json!({ + "ok": true, + "published": null, + "skipped": "unmapped_event_type", + "event_type": input.event_type, + "action_event": is_action_event, + })); + }; + + // Provider envelope only — projector maps to auth_users. + let leaf = ctx.repo().repo(); + publish_mapped_delivery(leaf, &mapped) + .await + .map_err(|e| HandlerError::Other(Box::new(std::io::Error::other(e))))?; + + Ok(json!({ + "ok": true, + "published": mapped.message_name, + "event_id": mapped.delivery_id, + "provider_subject": mapped.payload.provider_subject, + "user_kind": mapped.payload.user_kind, + "approval_status": mapped.payload.approval_status, + "action_event": is_action_event, + })) +} diff --git a/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/map.rs b/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/map.rs new file mode 100644 index 00000000..9d3e811b --- /dev/null +++ b/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/map.rs @@ -0,0 +1,422 @@ +//! Map Zitadel Action / fixture payloads → provider bus subjects + envelopes. + +use e2e_readmodels::{ZitadelEmail, ZitadelUserPayload}; +use serde::Deserialize; +use serde_json::Value; + +pub const HUMAN_CREATED: &str = "zitadel.user.human.created.v1"; +pub const HUMAN_UPDATED: &str = "zitadel.user.human.updated.v1"; +pub const HUMAN_DEACTIVATED: &str = "zitadel.user.human.deactivated.v1"; +pub const HUMAN_REACTIVATED: &str = "zitadel.user.human.reactivated.v1"; +pub const MACHINE_CREATED: &str = "zitadel.user.machine.created.v1"; + +/// Ingress body accepted from Zitadel Action HTTP or local fixtures. +#[derive(Debug, Clone, Deserialize)] +pub struct ActionDelivery { + #[serde(default, alias = "event_id", alias = "id")] + pub delivery_id: Option, + #[serde(default, alias = "event_type", alias = "action_event", alias = "type")] + pub event_type: Option, + #[serde(default, alias = "user_id", alias = "userId")] + pub provider_subject: Option, + #[serde(default, alias = "user_kind", alias = "kind")] + pub user_kind: Option, + #[serde(default)] + pub email: Option, + #[serde(default)] + pub emails: Option>, + #[serde(default, alias = "display_name", alias = "displayName")] + pub display_name: Option, + #[serde(default, alias = "approval_status")] + pub approval_status: Option, + #[serde(default)] + pub grants: Option>, + #[serde(default)] + pub roles: Option>, + #[serde(default)] + pub payload: Option, +} + +#[derive(Debug, Clone, Deserialize)] +pub struct EmailIn { + pub address: String, + #[serde(default)] + pub primary: bool, + #[serde(default = "default_true")] + pub verified: bool, +} + +fn default_true() -> bool { + true +} + +#[derive(Debug, Clone)] +pub struct MappedDelivery { + pub message_name: String, + pub delivery_id: String, + pub payload: ZitadelUserPayload, +} + +pub fn looks_like_action_event(raw: &Value) -> bool { + raw.get("aggregateID").is_some() + || raw.get("aggregateId").is_some() + || (raw.get("aggregateType").is_some() && raw.get("sequence").is_some()) +} + +pub fn normalize_ingress_body(raw: &Value) -> ActionDelivery { + if looks_like_action_event(raw) { + return action_event_to_delivery(raw); + } + serde_json::from_value(raw.clone()).unwrap_or(ActionDelivery { + delivery_id: None, + event_type: None, + provider_subject: None, + user_kind: None, + email: None, + emails: None, + display_name: None, + approval_status: None, + grants: None, + roles: None, + payload: Some(raw.clone()), + }) +} + +fn action_event_to_delivery(raw: &Value) -> ActionDelivery { + let aggregate_id = raw + .get("aggregateID") + .or_else(|| raw.get("aggregateId")) + .and_then(|v| v.as_str()) + .map(|s| s.to_string()); + let event_type = raw + .get("type") + .or_else(|| raw.get("eventType")) + .or_else(|| raw.get("event_type")) + .and_then(|v| v.as_str()) + .map(|s| s.to_string()); + let sequence = raw + .get("sequence") + .map(|v| match v { + Value::String(s) => s.clone(), + Value::Number(n) => n.to_string(), + _ => String::new(), + }) + .filter(|s| !s.is_empty()); + let delivery_id = match (&aggregate_id, &event_type, &sequence) { + (Some(a), Some(t), Some(s)) => Some(format!("zitadel-action:{t}:{a}:{s}")), + (Some(a), Some(t), None) => Some(format!("zitadel-action:{t}:{a}")), + _ => sequence.clone(), + }; + + let event_payload = raw + .get("event_payload") + .or_else(|| raw.get("eventPayload")) + .or_else(|| raw.get("payload")) + .cloned() + .unwrap_or(Value::Null); + + let email = event_payload + .get("emailAddress") + .or_else(|| event_payload.get("email")) + .or_else(|| event_payload.pointer("/email/email")) + .and_then(|v| v.as_str()) + .map(|s| s.to_string()); + let display_name = event_payload + .get("displayName") + .or_else(|| event_payload.get("display_name")) + .and_then(|v| v.as_str()) + .map(|s| s.to_string()); + let user_name = event_payload + .get("userName") + .or_else(|| event_payload.get("user_name")) + .and_then(|v| v.as_str()) + .map(|s| s.to_string()); + + let grants = event_payload + .get("roleKeys") + .or_else(|| event_payload.get("role_keys")) + .and_then(|v| v.as_array()) + .map(|arr| { + arr.iter() + .filter_map(|x| x.as_str().map(|s| s.to_string())) + .collect::>() + }) + .filter(|v| !v.is_empty()); + + let subject = event_payload + .get("userId") + .or_else(|| event_payload.get("userID")) + .or_else(|| event_payload.get("user_id")) + .and_then(|v| v.as_str()) + .map(|s| s.to_string()) + .or(aggregate_id); + + let kind = if event_type + .as_deref() + .unwrap_or("") + .to_ascii_lowercase() + .contains("machine") + { + Some("machine".into()) + } else { + Some("human".into()) + }; + + ActionDelivery { + delivery_id, + event_type, + provider_subject: subject, + user_kind: kind, + email: email.or(user_name), + emails: None, + display_name, + approval_status: None, + grants, + roles: None, + payload: Some(raw.clone()), + } +} + +pub fn map_action_delivery(input: &ActionDelivery) -> Option { + let subject = input + .provider_subject + .as_deref() + .map(str::trim) + .filter(|s| !s.is_empty())?; + let event_type = input + .event_type + .as_deref() + .map(str::trim) + .filter(|s| !s.is_empty())?; + + let message_name = resolve_message_name(event_type, input.user_kind.as_deref())?; + let user_kind = if message_name == MACHINE_CREATED { + "machine".to_string() + } else { + match input.user_kind.as_deref().map(str::to_ascii_lowercase) { + Some(k) if k == "machine" || k == "service" => "machine".into(), + _ => "human".into(), + } + }; + + let delivery_id = input + .delivery_id + .clone() + .filter(|s| !s.trim().is_empty()) + .unwrap_or_else(|| format!("zitadel:{message_name}:{subject}")); + + let emails = normalize_emails(input); + let approval_status = derive_approval(input, &user_kind); + + let payload = ZitadelUserPayload { + schema_version: 1, + source: "zitadel".into(), + delivery_id: delivery_id.clone(), + provider: "zitadel".into(), + provider_subject: subject.to_string(), + user_kind, + emails, + display_name: input.display_name.clone().filter(|s| !s.trim().is_empty()), + approval_status, + ingested_at: now_rfc3339ish(), + }; + + Some(MappedDelivery { + message_name: message_name.to_string(), + delivery_id, + payload, + }) +} + +fn resolve_message_name(event_type: &str, user_kind: Option<&str>) -> Option<&'static str> { + let t = event_type.to_ascii_lowercase().replace('_', "."); + match t.as_str() { + HUMAN_CREATED | "zitadel.user.human.created" => return Some(HUMAN_CREATED), + HUMAN_UPDATED | "zitadel.user.human.updated" => return Some(HUMAN_UPDATED), + HUMAN_DEACTIVATED | "zitadel.user.human.deactivated" => return Some(HUMAN_DEACTIVATED), + HUMAN_REACTIVATED | "zitadel.user.human.reactivated" => return Some(HUMAN_REACTIVATED), + MACHINE_CREATED | "zitadel.user.machine.created" => return Some(MACHINE_CREATED), + _ => {} + } + + let kind_machine = matches!( + user_kind.map(str::to_ascii_lowercase).as_deref(), + Some("machine") | Some("service") + ); + + if t.contains("machine") && (t.contains("created") || t.ends_with(".added")) { + return Some(MACHINE_CREATED); + } + if t.contains("deactivat") || t.contains(".locked") || t.ends_with(".locked") { + return Some(HUMAN_DEACTIVATED); + } + if t.contains("reactivat") || t.contains(".unlocked") || t.ends_with(".unlocked") { + return Some(HUMAN_REACTIVATED); + } + if t.contains("human") && (t.contains("added") || t.contains("created")) { + return Some(HUMAN_CREATED); + } + if t.contains("created") || t.contains("create") || (t.ends_with(".added") && !t.contains("grant")) + { + return if kind_machine { + Some(MACHINE_CREATED) + } else { + Some(HUMAN_CREATED) + }; + } + if t.contains("updated") + || t.contains("update") + || t.contains("changed") + || t.contains("grant") + || t.contains("role") + || t.contains("profile") + || t.contains("email") + { + return Some(HUMAN_UPDATED); + } + None +} + +fn normalize_emails(input: &ActionDelivery) -> Vec { + if let Some(list) = &input.emails { + if !list.is_empty() { + return list + .iter() + .map(|e| ZitadelEmail { + address: e.address.clone(), + primary: e.primary, + verified: e.verified, + }) + .collect(); + } + } + if let Some(email) = input.email.as_ref().filter(|s| !s.trim().is_empty()) { + return vec![ZitadelEmail { + address: email.clone(), + primary: true, + verified: true, + }]; + } + Vec::new() +} + +fn derive_approval(input: &ActionDelivery, user_kind: &str) -> String { + if user_kind == "machine" { + return "approved".into(); + } + if let Some(status) = input + .approval_status + .as_deref() + .map(str::trim) + .filter(|s| !s.is_empty()) + { + return status.to_ascii_lowercase(); + } + let has_approved = input + .grants + .iter() + .flatten() + .chain(input.roles.iter().flatten()) + .any(|g| g.eq_ignore_ascii_case("approved")); + if has_approved { + "approved".into() + } else { + "pending".into() + } +} + +fn now_rfc3339ish() -> String { + use std::time::{SystemTime, UNIX_EPOCH}; + let d = SystemTime::now() + .duration_since(UNIX_EPOCH) + .unwrap_or_default(); + // Sortable timestamp without chrono dependency. + format!("{}", d.as_millis()) +} + +#[cfg(test)] +mod tests { + use super::*; + use serde_json::json; + + #[test] + fn maps_human_created_with_waitlist_pending() { + let input = ActionDelivery { + delivery_id: Some("d1".into()), + event_type: Some("user.human.created".into()), + provider_subject: Some("sub-1".into()), + user_kind: Some("human".into()), + email: Some("ada@example.com".into()), + emails: None, + display_name: Some("Ada".into()), + approval_status: None, + grants: None, + roles: None, + payload: None, + }; + let m = map_action_delivery(&input).expect("mapped"); + assert_eq!(m.message_name, HUMAN_CREATED); + assert_eq!(m.delivery_id, "d1"); + assert_eq!(m.payload.approval_status, "pending"); + assert_eq!(m.payload.user_kind, "human"); + assert_eq!(m.payload.emails[0].address, "ada@example.com"); + } + + #[test] + fn maps_updated_with_approved_grant() { + let input = ActionDelivery { + delivery_id: Some("d2".into()), + event_type: Some("user.human.updated".into()), + provider_subject: Some("sub-1".into()), + user_kind: None, + email: Some("ada@example.com".into()), + emails: None, + display_name: Some("Ada".into()), + approval_status: None, + grants: Some(vec!["approved".into()]), + roles: None, + payload: None, + }; + let m = map_action_delivery(&input).unwrap(); + assert_eq!(m.message_name, HUMAN_UPDATED); + assert_eq!(m.payload.approval_status, "approved"); + } + + #[test] + fn unmapped_type_returns_none() { + let input = ActionDelivery { + delivery_id: Some("d3".into()), + event_type: Some("org.metadata.set".into()), + provider_subject: Some("sub-1".into()), + user_kind: None, + email: None, + emails: None, + display_name: None, + approval_status: None, + grants: None, + roles: None, + payload: None, + }; + assert!(map_action_delivery(&input).is_none()); + } + + #[test] + fn maps_native_action_event_human_added() { + let raw = json!({ + "aggregateID": "user-99", + "aggregateType": "user", + "sequence": 7, + "type": "user.human.added", + "event_payload": { + "userName": "ada@example.com", + "emailAddress": "ada@example.com", + "displayName": "Ada" + } + }); + let d = normalize_ingress_body(&raw); + assert_eq!(d.provider_subject.as_deref(), Some("user-99")); + let m = map_action_delivery(&d).expect("mapped"); + assert_eq!(m.message_name, HUMAN_CREATED); + assert_eq!(m.payload.provider_subject, "user-99"); + } +} diff --git a/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/mod.rs b/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/mod.rs new file mode 100644 index 00000000..4574ec86 --- /dev/null +++ b/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/mod.rs @@ -0,0 +1,54 @@ +//! Zitadel Action/HTTP ingress + Management API scrape → provider messages only. +//! +//! Teaching fixture (simplified from gitkb domain-service): +//! 1. Authenticity (`auth`) — shared secret header +//! 2. Map (`map`) — Action payload → typed `zitadel.*.v1` subjects +//! 3. Publish (`publish`) — outbox provider message only +//! 4. Projector (`project_auth_user`) — upserts `auth_users` for GraphQL joins +//! 5. Scrape (`scrape`) — periodic Management API reconcile for missed events +//! +//! See `docs/zitadel-ingestor.md`. + +mod auth; +mod handle; +mod map; +mod publish; +pub mod scrape; + +pub use auth::{ + allow_action_events, configured_secret, verify_authenticity, ALLOW_ACTION_EVENTS_ENV, + SECRET_ENV, SECRET_HEADER, +}; +pub use handle::{guard, handle, COMMAND}; +pub use map::{ + looks_like_action_event, map_action_delivery, normalize_ingress_body, ActionDelivery, + MappedDelivery, HUMAN_CREATED, HUMAN_DEACTIVATED, HUMAN_REACTIVATED, HUMAN_UPDATED, + MACHINE_CREATED, +}; +pub use scrape::{ + scrape_users_to_outbox, spawn_scrape_loop, ZitadelScrapeConfig, ScrapeReport, INTERVAL_ENV, + ON_START_ENV, TOKEN_ENV, API_URL_ENV, +}; + +/// Provider event names published by this ingestor (never domain forgeries). +pub fn is_provider_message_name(name: &str) -> bool { + name.starts_with("zitadel.") +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn provider_names_are_zitadel_prefixed() { + for name in [ + HUMAN_CREATED, + HUMAN_UPDATED, + HUMAN_DEACTIVATED, + HUMAN_REACTIVATED, + MACHINE_CREATED, + ] { + assert!(is_provider_message_name(name), "{name}"); + } + } +} diff --git a/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/publish.rs b/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/publish.rs new file mode 100644 index 00000000..cde74935 --- /dev/null +++ b/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/publish.rs @@ -0,0 +1,22 @@ +//! Shared outbox publish for provider messages (ingress + scrape). + +use distributed::{CommitBuilderExt, OutboxMessage, TransactionalCommit}; + +use super::map::MappedDelivery; + +/// Encode + leaf-outbox commit a mapped provider delivery. +pub async fn publish_mapped_delivery( + repo: &R, + mapped: &MappedDelivery, +) -> Result<(), String> { + let outbox = OutboxMessage::encode( + mapped.delivery_id.clone(), + mapped.message_name.as_str(), + &mapped.payload, + ) + .map_err(|e| e.to_string())?; + CommitBuilderExt::outbox(repo, outbox) + .commit_all() + .await + .map_err(|e| e.to_string()) +} diff --git a/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/scrape.rs b/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/scrape.rs new file mode 100644 index 00000000..b413d869 --- /dev/null +++ b/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel/scrape.rs @@ -0,0 +1,490 @@ +//! Periodic / on-demand Zitadel Management API scrape → same provider outbox path. +//! +//! Actions cover the happy path. Scrape reconciles users we never got events for +//! (Action downtime, misconfig, historical backfill). + +use std::env; +use std::time::Duration; + +use distributed::TransactionalCommit; +use e2e_readmodels::{ZitadelEmail, ZitadelUserPayload}; +use serde::Deserialize; +use serde_json::{json, Value}; + +use super::map::{ + MappedDelivery, HUMAN_DEACTIVATED, HUMAN_UPDATED, MACHINE_CREATED, +}; +use super::publish::publish_mapped_delivery; + +/// Env: Management API base (no trailing slash). Falls back to `OIDC_ISSUER`. +pub const API_URL_ENV: &str = "ZITADEL_API_URL"; +/// Env: PAT / service user token (same as Login V2 `ZITADEL_SERVICE_USER_TOKEN`). +pub const TOKEN_ENV: &str = "ZITADEL_SERVICE_USER_TOKEN"; +/// Env: scrape interval seconds. `0` or unset with no token → disabled. +/// Default when token present: `60`. +pub const INTERVAL_ENV: &str = "ZITADEL_SCRAPE_INTERVAL_SECS"; +/// Env: run one scrape immediately on process start (`1`/`true`). Default on when configured. +pub const ON_START_ENV: &str = "ZITADEL_SCRAPE_ON_START"; + +#[derive(Debug, Clone)] +pub struct ZitadelScrapeConfig { + pub api_base: String, + pub token: String, + pub interval: Duration, + pub on_start: bool, + pub page_size: u32, +} + +impl ZitadelScrapeConfig { + /// Load from env. Returns `None` when token or API base is missing, or interval is 0 + /// with scrape explicitly disabled. + pub fn from_env() -> Option { + let token = env::var(TOKEN_ENV) + .or_else(|_| env::var("ZITADEL_MANAGEMENT_PAT")) + .ok() + .map(|s| s.trim().to_string()) + .filter(|s| !s.is_empty())?; + + let api_base = env::var(API_URL_ENV) + .or_else(|_| env::var("OIDC_ISSUER")) + .ok() + .map(|s| s.trim().trim_end_matches('/').to_string()) + .filter(|s| !s.is_empty())?; + + let interval_secs: u64 = env::var(INTERVAL_ENV) + .ok() + .and_then(|s| s.trim().parse().ok()) + .unwrap_or(60); + if interval_secs == 0 { + // Allow on-demand command only; no background loop. + return Some(Self { + api_base, + token, + interval: Duration::ZERO, + on_start: false, + page_size: 100, + }); + } + + let on_start = match env::var(ON_START_ENV).ok().as_deref().map(str::trim) { + Some("0") | Some("false") | Some("FALSE") | Some("off") => false, + _ => true, + }; + + Some(Self { + api_base, + token, + interval: Duration::from_secs(interval_secs), + on_start, + page_size: 100, + }) + } + + pub fn background_enabled(&self) -> bool { + !self.interval.is_zero() + } +} + +#[derive(Debug, Default, Clone)] +pub struct ScrapeReport { + pub listed: usize, + pub published: usize, + pub skipped: usize, + pub errors: Vec, +} + +/// List users from Zitadel Management API and publish provider messages for each. +pub async fn scrape_users_to_outbox( + repo: &R, + cfg: &ZitadelScrapeConfig, +) -> ScrapeReport { + let mut report = ScrapeReport::default(); + let users = match list_all_users(cfg).await { + Ok(u) => u, + Err(e) => { + report.errors.push(e); + return report; + } + }; + report.listed = users.len(); + + for user in users { + let Some(mapped) = map_mgmt_user(&user) else { + report.skipped += 1; + continue; + }; + match publish_mapped_delivery(repo, &mapped).await { + Ok(()) => report.published += 1, + Err(e) => { + // Duplicate outbox ids (unchanged fingerprint) are expected on re-scrape. + if e.contains("UNIQUE") || e.contains("unique") || e.contains("already") { + report.skipped += 1; + } else { + report.errors.push(format!( + "user {}: publish failed: {e}", + mapped.payload.provider_subject + )); + } + } + } + } + report +} + +#[derive(Debug, Clone, Deserialize)] +struct SearchResponse { + #[serde(default)] + result: Vec, +} + +#[derive(Debug, Clone, Deserialize)] +struct MgmtUser { + id: Option, + #[serde(default, rename = "userName")] + user_name: Option, + #[serde(default)] + state: Option, + #[serde(default)] + human: Option, + #[serde(default)] + machine: Option, + #[serde(default, rename = "changeDate")] + change_date: Option, + #[serde(default, rename = "details")] + details: Option, +} + +#[derive(Debug, Clone, Deserialize)] +struct MgmtDetails { + #[serde(default, rename = "changeDate")] + change_date: Option, +} + +#[derive(Debug, Clone, Deserialize)] +struct MgmtHuman { + #[serde(default)] + profile: Option, + #[serde(default)] + email: Option, +} + +#[derive(Debug, Clone, Deserialize)] +struct MgmtProfile { + #[serde(default, rename = "displayName")] + display_name: Option, + #[serde(default, rename = "firstName")] + first_name: Option, + #[serde(default, rename = "lastName")] + last_name: Option, +} + +#[derive(Debug, Clone, Deserialize)] +struct MgmtEmail { + #[serde(default)] + email: Option, + #[serde(default, rename = "isEmailVerified")] + is_email_verified: Option, +} + +#[derive(Debug, Clone, Deserialize)] +struct MgmtMachine { + #[serde(default)] + name: Option, +} + +async fn list_all_users(cfg: &ZitadelScrapeConfig) -> Result, String> { + let client = reqwest::Client::new(); + let mut offset: u64 = 0; + let mut all = Vec::new(); + + loop { + let body = json!({ + "query": { + "offset": offset.to_string(), + "limit": cfg.page_size, + "asc": true + }, + "sortingColumn": "USER_FIELD_NAME_USER_NAME", + "queries": [] + }); + let url = format!("{}/management/v1/users/_search", cfg.api_base); + let resp = client + .post(&url) + .header("Authorization", format!("Bearer {}", cfg.token)) + .header("Content-Type", "application/json") + .json(&body) + .send() + .await + .map_err(|e| format!("zitadel search request: {e}"))?; + + let status = resp.status(); + let text = resp + .text() + .await + .map_err(|e| format!("zitadel search body: {e}"))?; + if !status.is_success() { + return Err(format!("zitadel search HTTP {status}: {text}")); + } + let page: SearchResponse = serde_json::from_str(&text) + .map_err(|e| format!("zitadel search json: {e}; body={text}"))?; + let n = page.result.len(); + all.extend(page.result); + if n < cfg.page_size as usize { + break; + } + offset += n as u64; + if offset > 10_000 { + break; // safety + } + } + Ok(all) +} + +/// Map one Management API user row → provider bus delivery (or None if unusable). +pub fn map_management_user(raw: &Value) -> Option { + let user: MgmtUser = serde_json::from_value(raw.clone()).ok()?; + map_mgmt_user(&user) +} + +fn map_mgmt_user(user: &MgmtUser) -> Option { + let id = user.id.as_deref()?.trim(); + if id.is_empty() { + return None; + } + let state = user.state.as_deref().unwrap_or("USER_STATE_ACTIVE"); + let is_machine = user.machine.is_some() && user.human.is_none(); + let deactivated = state.contains("INACTIVE") + || state.contains("LOCKED") + || state.contains("SUSPEND") + || state.contains("DELETED"); + + let (email, display_name, user_kind) = if is_machine { + let name = user + .machine + .as_ref() + .and_then(|m| m.name.clone()) + .or_else(|| user.user_name.clone()) + .unwrap_or_else(|| id.to_string()); + (String::new(), name, "machine".to_string()) + } else { + let human = user.human.as_ref(); + let email = human + .and_then(|h| h.email.as_ref()) + .and_then(|e| e.email.clone()) + .unwrap_or_default(); + let display = human + .and_then(|h| h.profile.as_ref()) + .and_then(|p| { + p.display_name + .clone() + .or_else(|| match (&p.first_name, &p.last_name) { + (Some(f), Some(l)) => Some(format!("{f} {l}")), + (Some(f), None) => Some(f.clone()), + _ => None, + }) + }) + .or_else(|| user.user_name.clone()) + .unwrap_or_else(|| { + if email.is_empty() { + id.to_string() + } else { + email.clone() + } + }); + (email, display, "human".to_string()) + }; + + let message_name = if is_machine { + MACHINE_CREATED + } else if deactivated { + HUMAN_DEACTIVATED + } else { + // Reconcile as update — projector upserts; works for create + change. + HUMAN_UPDATED + }; + + let change = user + .change_date + .clone() + .or_else(|| { + user.details + .as_ref() + .and_then(|d| d.change_date.clone()) + }) + .unwrap_or_else(|| "0".into()); + // Stable when profile unchanged so re-scrape can skip duplicate outbox ids. + let fingerprint = simple_fingerprint(&[&email, &display_name, state, &user_kind, &change]); + let delivery_id = format!("zitadel-scrape:{id}:{fingerprint}"); + + let emails = if email.is_empty() { + Vec::new() + } else { + vec![ZitadelEmail { + address: email, + primary: true, + verified: user + .human + .as_ref() + .and_then(|h| h.email.as_ref()) + .and_then(|e| e.is_email_verified) + .unwrap_or(true), + }] + }; + + let payload = ZitadelUserPayload { + schema_version: 1, + source: "zitadel-scrape".into(), + delivery_id: delivery_id.clone(), + provider: "zitadel".into(), + provider_subject: id.to_string(), + user_kind, + emails, + display_name: Some(display_name), + approval_status: if is_machine { + "approved".into() + } else { + "approved".into() // scrape treats listed humans as directory members + }, + ingested_at: now_ms(), + }; + + Some(MappedDelivery { + message_name: message_name.to_string(), + delivery_id, + payload, + }) +} + +fn simple_fingerprint(parts: &[&str]) -> String { + // FNV-1a 64 — stable, no extra deps. + let mut hash: u64 = 0xcbf29ce484222325; + for p in parts { + for b in p.as_bytes() { + hash ^= u64::from(*b); + hash = hash.wrapping_mul(0x100000001b3); + } + hash ^= 0xff; + hash = hash.wrapping_mul(0x100000001b3); + } + format!("{hash:016x}") +} + +fn now_ms() -> String { + use std::time::{SystemTime, UNIX_EPOCH}; + let d = SystemTime::now() + .duration_since(UNIX_EPOCH) + .unwrap_or_default(); + format!("{}", d.as_millis()) +} + +/// Background loop: optional immediate scrape, then every `cfg.interval`. +pub fn spawn_scrape_loop(repo: R, cfg: ZitadelScrapeConfig) +where + R: TransactionalCommit + Clone + Send + Sync + 'static, +{ + if !cfg.background_enabled() && !cfg.on_start { + return; + } + tokio::spawn(async move { + if cfg.on_start { + let r = scrape_users_to_outbox(&repo, &cfg).await; + eprintln!( + "zitadel scrape (start): listed={} published={} skipped={} errors={}", + r.listed, + r.published, + r.skipped, + r.errors.len() + ); + for e in &r.errors { + eprintln!("zitadel scrape: {e}"); + } + } + if !cfg.background_enabled() { + return; + } + loop { + tokio::time::sleep(cfg.interval).await; + let r = scrape_users_to_outbox(&repo, &cfg).await; + if r.published > 0 || !r.errors.is_empty() { + eprintln!( + "zitadel scrape: listed={} published={} skipped={} errors={}", + r.listed, + r.published, + r.skipped, + r.errors.len() + ); + } + for e in &r.errors { + eprintln!("zitadel scrape: {e}"); + } + } + }); +} + +#[cfg(test)] +mod tests { + use super::*; + use serde_json::json; + + #[test] + fn maps_active_human() { + let raw = json!({ + "id": "user-1", + "userName": "alice", + "state": "USER_STATE_ACTIVE", + "human": { + "profile": { "displayName": "Alice" }, + "email": { "email": "alice@e2e.local", "isEmailVerified": true } + }, + "changeDate": "2026-01-01T00:00:00Z" + }); + let m = map_management_user(&raw).expect("mapped"); + assert_eq!(m.message_name, HUMAN_UPDATED); + assert_eq!(m.payload.provider_subject, "user-1"); + assert_eq!(m.payload.display_name.as_deref(), Some("Alice")); + assert_eq!(m.payload.emails[0].address, "alice@e2e.local"); + assert!(m.delivery_id.starts_with("zitadel-scrape:user-1:")); + } + + #[test] + fn maps_inactive_as_deactivated() { + let raw = json!({ + "id": "user-2", + "state": "USER_STATE_INACTIVE", + "human": { + "profile": { "displayName": "Bob" }, + "email": { "email": "bob@e2e.local" } + } + }); + let m = map_management_user(&raw).unwrap(); + assert_eq!(m.message_name, HUMAN_DEACTIVATED); + } + + #[test] + fn maps_machine() { + let raw = json!({ + "id": "svc-1", + "state": "USER_STATE_ACTIVE", + "machine": { "name": "bot" } + }); + let m = map_management_user(&raw).unwrap(); + assert_eq!(m.message_name, MACHINE_CREATED); + assert_eq!(m.payload.user_kind, "machine"); + } + + #[test] + fn same_profile_same_fingerprint() { + let raw = json!({ + "id": "user-1", + "state": "USER_STATE_ACTIVE", + "human": { + "profile": { "displayName": "Alice" }, + "email": { "email": "a@x.com" } + }, + "changeDate": "t1" + }); + let a = map_management_user(&raw).unwrap(); + let b = map_management_user(&raw).unwrap(); + assert_eq!(a.delivery_id, b.delivery_id); + } +} diff --git a/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel_scrape.rs b/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel_scrape.rs new file mode 100644 index 00000000..75b1d895 --- /dev/null +++ b/tests/e2e-ui/crates/service/src/handlers/ingestors/zitadel_scrape.rs @@ -0,0 +1,54 @@ +//! Command: `zitadel.scrape.v1` — on-demand Management API reconciliation scrape. +//! +//! Authenticity: same shared secret as Action ingress (`x-zitadel-ingestor-secret`). +//! Requires `ZITADEL_SERVICE_USER_TOKEN` + `ZITADEL_API_URL` / `OIDC_ISSUER` in env. + +use distributed::microsvc::{Context, HandlerError}; +use serde_json::{json, Value}; + +use super::zitadel::scrape::{scrape_users_to_outbox, ZitadelScrapeConfig}; +use super::zitadel::verify_authenticity; +use crate::deps::AuthDeps; + +pub const COMMAND: &str = "zitadel.scrape.v1"; + +pub fn guard(_ctx: &Context>) -> bool +where + R: crate::bounds::EventStore, + L: crate::bounds::Locks, + S: Send + Sync + 'static, +{ + // Empty body is fine; authenticity checked in handle. + true +} + +pub async fn handle( + ctx: &Context<'_, AuthDeps>, +) -> Result +where + R: crate::bounds::EventStore, + L: crate::bounds::Locks, + S: Send + Sync + 'static, +{ + // Not an Action event envelope — require shared secret. + verify_authenticity(ctx.session(), false)?; + + let cfg = ZitadelScrapeConfig::from_env().ok_or_else(|| { + HandlerError::Rejected(format!( + "scrape not configured: set {} and {} (or OIDC_ISSUER)", + super::zitadel::scrape::TOKEN_ENV, + super::zitadel::scrape::API_URL_ENV + )) + })?; + + let leaf = ctx.repo().repo(); + let report = scrape_users_to_outbox(leaf, &cfg).await; + + Ok(json!({ + "ok": report.errors.is_empty(), + "listed": report.listed, + "published": report.published, + "skipped": report.skipped, + "errors": report.errors, + })) +} diff --git a/tests/e2e-ui/crates/service/src/handlers/mod.rs b/tests/e2e-ui/crates/service/src/handlers/mod.rs index 8d6817e0..024f6087 100644 --- a/tests/e2e-ui/crates/service/src/handlers/mod.rs +++ b/tests/e2e-ui/crates/service/src/handlers/mod.rs @@ -1,3 +1,4 @@ pub mod commands; pub mod events; +pub mod ingestors; pub mod util; diff --git a/tests/e2e-ui/crates/service/src/lib.rs b/tests/e2e-ui/crates/service/src/lib.rs index f1230871..7a97b0b4 100644 --- a/tests/e2e-ui/crates/service/src/lib.rs +++ b/tests/e2e-ui/crates/service/src/lib.rs @@ -1,8 +1,9 @@ -//! Todo service library — handlers + GraphQL. +//! e2e-ui service library — handlers + GraphQL. //! -//! Domain logic lives in `todo-domain`. Read models live in `e2e-readmodels`. -//! This crate wires thin command handlers + event projectors. -//! **Commands never write read models** — only projectors do. +//! Domain logic lives in `*-domain`. Read models live in `e2e-readmodels`. +//! This crate wires thin command handlers + event projectors + Zitadel ingress. +//! **Commands never write read models** — only projectors do (including auth_users +//! from provider messages published by the Zitadel ingestor). mod bounds; mod deps; @@ -12,6 +13,11 @@ mod service; pub use oidc_layer::serve_with_oidc; pub use service::{ - build_graphql_engine, build_service, dev_identity, graphql_commands, identity_from_env, oidc_bearer_config, + build_graphql_engine, build_service, dev_identity, graphql_commands, identity_from_env, + oidc_bearer_config, }; pub use e2e_readmodels::distributed_manifest; +/// Zitadel Management API scrape (reconcile missed Action events). +pub use handlers::ingestors::zitadel::{ + scrape_users_to_outbox, spawn_scrape_loop, ZitadelScrapeConfig, ScrapeReport, +}; diff --git a/tests/e2e-ui/crates/service/src/oidc_layer.rs b/tests/e2e-ui/crates/service/src/oidc_layer.rs index 43e3db31..87abd34f 100644 --- a/tests/e2e-ui/crates/service/src/oidc_layer.rs +++ b/tests/e2e-ui/crates/service/src/oidc_layer.rs @@ -47,8 +47,15 @@ pub struct OidcIdentityService { fn skip_oidc_gate(method: &Method, path: &str) -> bool { // Public probes + GraphiQL HTML + WS upgrade (auth on connection_init). - matches!(path, "/health" | "/metrics" | "/graphql/ws") - || (path == "/graphql" && *method == Method::GET) + // Zitadel Action ingress uses shared-secret authenticity (not OIDC bearer). + matches!( + path, + "/health" + | "/metrics" + | "/graphql/ws" + | "/zitadel.ingress.v1" + | "/zitadel.scrape.v1" + ) || (path == "/graphql" && *method == Method::GET) } fn unauthorized_response() -> Response { @@ -154,7 +161,10 @@ mod tests { assert!(skip_oidc_gate(&Method::GET, "/graphql/ws")); assert!(skip_oidc_gate(&Method::GET, "/graphql")); assert!(!skip_oidc_gate(&Method::POST, "/graphql")); - // HTTP command routes are disabled; still treat unknown POSTs as gated. + // Zitadel Action ingress + scrape use shared secret, not OIDC bearer. + assert!(skip_oidc_gate(&Method::POST, "/zitadel.ingress.v1")); + assert!(skip_oidc_gate(&Method::POST, "/zitadel.scrape.v1")); + // Other HTTP command routes still require OIDC under OidcBearer. assert!(!skip_oidc_gate(&Method::POST, "/todo.create")); assert!(!skip_oidc_gate(&Method::POST, "/graphql")); } diff --git a/tests/e2e-ui/crates/service/src/service.rs b/tests/e2e-ui/crates/service/src/service.rs index 43b3c95e..6e24e986 100644 --- a/tests/e2e-ui/crates/service/src/service.rs +++ b/tests/e2e-ui/crates/service/src/service.rs @@ -1,5 +1,6 @@ //! Route bundles + GraphQL engine for the e2e-ui fixture. +use blob_domain::BlobGame; use chat_domain::ChatMessage; use distributed::graphql::{ exposed_command, read, GraphqlCommands, GraphqlEngine, GraphqlPool, IdentityConfig, @@ -9,7 +10,7 @@ use distributed::microsvc::{ ConfigurableOutboxPublisher, HasOutboxStore, HasRepo, Routes, Service, }; use distributed::{AggregateBuilder, AggregateRepository, Queueable, QueuedRepository}; -use e2e_readmodels::{ChatMessageView, TodoView}; +use e2e_readmodels::{AuthUserView, BlobGameView, ChatMessageView, TodoView}; use todo_domain::Todo; use crate::bounds::{EventStore, Locks, ReadStore}; @@ -32,6 +33,8 @@ where HasRepo + HasOutboxStore + ConfigurableOutboxPublisher + Send + Sync + 'static, AggregateRepository, ChatMessage>: HasRepo + HasOutboxStore + ConfigurableOutboxPublisher + Send + Sync + 'static, + AggregateRepository, BlobGame>: + HasRepo + HasOutboxStore + ConfigurableOutboxPublisher + Send + Sync + 'static, { let todos = distributed::routes!( Routes::new() @@ -47,24 +50,38 @@ where ); let chat = distributed::routes!( Routes::new() - .with_repo(repo.queued_with(locks).aggregate::()) - .with_read_model_store(read_models), + .with_repo(repo.clone().queued_with(locks.clone()).aggregate::()) + .with_read_model_store(read_models.clone()), command handlers::commands::chat_post, + // Zitadel Action ingress + on-demand scrape (leaf outbox) + auth_users projector. + command handlers::ingestors::zitadel, + command handlers::ingestors::zitadel_scrape, event handlers::events::project_chat, + events handlers::events::project_auth_user, + ); + let blob = distributed::routes!( + Routes::new() + .with_repo(repo.queued_with(locks).aggregate::()) + .with_read_model_store(read_models), + command handlers::commands::blob_start, + command handlers::commands::blob_move, + command handlers::commands::blob_start_level, + events handlers::events::project_blob, ); - // GraphQL-only public surface — no POST /todo.* or POST /chat.* HTTP routes. + // HTTP command routes enabled for Zitadel ingress; UI still uses GraphQL mutations. Service::new() .named("e2e-ui") - .without_http_command_routes() .routes(todos) .routes(chat) + .routes(blob) } /// GraphQL command registry for this fixture — single source of truth for /// engine mutations **and** `e2e-export-commands` / TypeScript command clients. pub fn graphql_commands() -> GraphqlCommands { use handlers::commands::{ - archive, chat_post, complete, create, force_archive, payloads, rename, reopen, + archive, blob_move, blob_start, blob_start_level, chat_post, complete, create, + force_archive, payloads, rename, reopen, }; let app_roles = ["user", "admin"]; @@ -126,6 +143,30 @@ pub fn graphql_commands() -> GraphqlCommands { .output::() .roles(app_roles), ) + .command( + blob_start::COMMAND, + exposed_command() + .field_name("blob_games_start") + .input::() + .output::() + .roles(app_roles), + ) + .command( + blob_move::COMMAND, + exposed_command() + .field_name("blob_games_move") + .input::() + .output::() + .roles(app_roles), + ) + .command( + blob_start_level::COMMAND, + exposed_command() + .field_name("blob_games_start_level") + .input::() + .output::() + .roles(app_roles), + ) } /// GraphQL over todos (owner-scoped) + chat_messages (shared room, live subscriptions). @@ -158,6 +199,24 @@ pub fn build_graphql_engine( .grant("user", read().all_columns()) .grant("admin", read().all_columns()), ) + .model::( + ModelPermissions::new() + .grant( + "user", + read().all_columns().rows( + distributed::graphql::col("owner_id") + .eq(distributed::graphql::claim("x-user-id")), + ), + ) + .grant("admin", read().all_columns()), + ) + // Imported IdP directory (join target for chat.author / blob.owner). + // Readable by all authenticated roles; writes only via Zitadel projector. + .model::( + ModelPermissions::new() + .grant("user", read().all_columns()) + .grant("admin", read().all_columns()), + ) .commands(commands) .identity(identity) // GraphiQL is a local template convenience. Disable with GRAPHIQL=0 diff --git a/tests/e2e-ui/crates/todo-domain/src/lib.rs b/tests/e2e-ui/crates/todo-domain/src/lib.rs index 4239120c..0e6754a3 100644 --- a/tests/e2e-ui/crates/todo-domain/src/lib.rs +++ b/tests/e2e-ui/crates/todo-domain/src/lib.rs @@ -6,289 +6,6 @@ //! - complete/reopen/rename only while not archived //! - archive is terminal for mutations (except re-open is not allowed after archive) -use distributed::{sourced, Entity}; -use serde::{Deserialize, Serialize}; -use thiserror::Error; +pub mod models; -#[derive(Debug, Error, PartialEq, Eq)] -pub enum TodoError { - #[error("todo already exists")] - AlreadyExists, - #[error("todo not found / not created")] - NotCreated, - #[error("todo is archived")] - Archived, - #[error("todo is already completed")] - AlreadyCompleted, - #[error("todo is not completed")] - NotCompleted, - #[error("empty todo id")] - EmptyId, - #[error("empty owner id")] - EmptyOwner, - #[error("empty title")] - EmptyTitle, - #[error("not the owner")] - NotOwner, - #[error(transparent)] - Event(#[from] distributed::EventRecordError), -} - -#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)] -#[serde(rename_all = "snake_case")] -pub enum TodoStatus { - #[default] - Open, - Completed, - Archived, -} - -#[derive(Debug, Clone, Default, Serialize, Deserialize)] -pub struct Todo { - #[serde(skip, default)] - pub entity: Entity, - pub todo_id: String, - pub owner_id: String, - pub title: String, - pub status: TodoStatus, -} - -impl Todo { - pub fn is_created(&self) -> bool { - !self.todo_id.is_empty() - } - - pub fn ensure_owner(&self, owner_id: &str) -> Result<(), TodoError> { - if !self.is_created() { - return Err(TodoError::NotCreated); - } - if self.owner_id != owner_id { - return Err(TodoError::NotOwner); - } - Ok(()) - } - - fn require_mutable(&self) -> Result<(), TodoError> { - if !self.is_created() { - return Err(TodoError::NotCreated); - } - if matches!(self.status, TodoStatus::Archived) { - return Err(TodoError::Archived); - } - Ok(()) - } -} - -#[sourced(entity, events = "TodoEvent", aggregate_type = "todo")] -impl Todo { - /// Create a new open todo. `owner_id` is the authenticated user (never trusted from peers). - pub fn create( - &mut self, - todo_id: impl Into, - owner_id: impl Into, - title: impl Into, - ) -> Result<(), TodoError> { - if self.is_created() { - return Err(TodoError::AlreadyExists); - } - let todo_id = todo_id.into(); - let owner_id = owner_id.into(); - let title = title.into(); - if todo_id.trim().is_empty() { - return Err(TodoError::EmptyId); - } - if owner_id.trim().is_empty() { - return Err(TodoError::EmptyOwner); - } - let title = title.trim(); - if title.is_empty() { - return Err(TodoError::EmptyTitle); - } - self.record_created(todo_id, owner_id, title.to_string())?; - Ok(()) - } - - #[event("todo.created")] - fn record_created(&mut self, todo_id: String, owner_id: String, title: String) { - self.entity.set_id(&todo_id); - self.todo_id = todo_id; - self.owner_id = owner_id; - self.title = title; - self.status = TodoStatus::Open; - } - - pub fn rename(&mut self, owner_id: &str, title: impl Into) -> Result<(), TodoError> { - self.ensure_owner(owner_id)?; - self.require_mutable()?; - let title = title.into(); - let title = title.trim(); - if title.is_empty() { - return Err(TodoError::EmptyTitle); - } - if title == self.title { - return Ok(()); // no-op: same title - } - self.record_renamed(title.to_string())?; - Ok(()) - } - - #[event("todo.renamed")] - fn record_renamed(&mut self, title: String) { - self.title = title; - } - - pub fn complete(&mut self, owner_id: &str) -> Result<(), TodoError> { - self.ensure_owner(owner_id)?; - self.require_mutable()?; - if matches!(self.status, TodoStatus::Completed) { - return Err(TodoError::AlreadyCompleted); - } - self.record_completed()?; - Ok(()) - } - - #[event("todo.completed")] - fn record_completed(&mut self) { - self.status = TodoStatus::Completed; - } - - pub fn reopen(&mut self, owner_id: &str) -> Result<(), TodoError> { - self.ensure_owner(owner_id)?; - self.require_mutable()?; - if !matches!(self.status, TodoStatus::Completed) { - return Err(TodoError::NotCompleted); - } - self.record_reopened()?; - Ok(()) - } - - #[event("todo.reopened")] - fn record_reopened(&mut self) { - self.status = TodoStatus::Open; - } - - pub fn archive(&mut self, owner_id: &str) -> Result<(), TodoError> { - self.ensure_owner(owner_id)?; - if !self.is_created() { - return Err(TodoError::NotCreated); - } - if matches!(self.status, TodoStatus::Archived) { - return Ok(()); // idempotent archive - } - self.record_archived()?; - Ok(()) - } - - #[event("todo.archived")] - fn record_archived(&mut self) { - self.status = TodoStatus::Archived; - } -} - -// ── Portable outbox / projection DTOs ─────────────────────────────────────── -// Full snapshot fields so projectors can upsert without loading prior rows. - -#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] -pub struct TodoFact { - pub todo_id: String, - pub owner_id: String, - pub title: String, - /// `open` | `completed` | `archived` - pub status: String, -} - -impl TodoFact { - pub fn from_todo(t: &Todo) -> Self { - Self { - todo_id: t.todo_id.clone(), - owner_id: t.owner_id.clone(), - title: t.title.clone(), - status: match t.status { - TodoStatus::Open => "open".into(), - TodoStatus::Completed => "completed".into(), - TodoStatus::Archived => "archived".into(), - }, - } - } -} - -#[cfg(test)] -mod tests { - use super::*; - - fn open_todo() -> Todo { - let mut t = Todo::default(); - t.create("t1", "alice", "Buy milk").unwrap(); - t - } - - #[test] - fn create_sets_owner_and_open_status() { - let t = open_todo(); - assert!(t.is_created()); - assert_eq!(t.owner_id, "alice"); - assert_eq!(t.title, "Buy milk"); - assert_eq!(t.status, TodoStatus::Open); - assert_eq!(t.entity.id(), "t1"); - assert_eq!(t.entity.version(), 1); - } - - #[test] - fn rejects_empty_title_and_double_create() { - let mut t = Todo::default(); - assert_eq!(t.create("t1", "alice", " ").unwrap_err(), TodoError::EmptyTitle); - t.create("t1", "alice", "ok").unwrap(); - assert_eq!( - t.create("t1", "alice", "again").unwrap_err(), - TodoError::AlreadyExists - ); - } - - #[test] - fn only_owner_can_mutate() { - let mut t = open_todo(); - assert_eq!(t.complete("bob").unwrap_err(), TodoError::NotOwner); - t.complete("alice").unwrap(); - assert_eq!(t.status, TodoStatus::Completed); - } - - #[test] - fn complete_reopen_cycle() { - let mut t = open_todo(); - t.complete("alice").unwrap(); - assert_eq!( - t.complete("alice").unwrap_err(), - TodoError::AlreadyCompleted - ); - t.reopen("alice").unwrap(); - assert_eq!(t.status, TodoStatus::Open); - assert_eq!(t.reopen("alice").unwrap_err(), TodoError::NotCompleted); - } - - #[test] - fn rename_trims_and_rejects_empty() { - let mut t = open_todo(); - t.rename("alice", " Eggs ").unwrap(); - assert_eq!(t.title, "Eggs"); - assert_eq!( - t.rename("alice", " ").unwrap_err(), - TodoError::EmptyTitle - ); - // same title is no-op (no extra version if no event — check version stays) - let v = t.entity.version(); - t.rename("alice", "Eggs").unwrap(); - assert_eq!(t.entity.version(), v); - } - - #[test] - fn archive_is_terminal_for_mutations() { - let mut t = open_todo(); - t.archive("alice").unwrap(); - assert_eq!(t.status, TodoStatus::Archived); - assert_eq!(t.complete("alice").unwrap_err(), TodoError::Archived); - assert_eq!(t.rename("alice", "x").unwrap_err(), TodoError::Archived); - // second archive is idempotent - t.archive("alice").unwrap(); - assert_eq!(t.status, TodoStatus::Archived); - } -} +pub use models::{Todo, TodoError, TodoFact, TodoStatus}; diff --git a/tests/e2e-ui/crates/todo-domain/src/models/mod.rs b/tests/e2e-ui/crates/todo-domain/src/models/mod.rs new file mode 100644 index 00000000..2d11a05b --- /dev/null +++ b/tests/e2e-ui/crates/todo-domain/src/models/mod.rs @@ -0,0 +1,11 @@ +//! Todo domain models. + +mod todo; +mod todo_error; +mod todo_fact; +mod todo_status; + +pub use todo::Todo; +pub use todo_error::TodoError; +pub use todo_fact::TodoFact; +pub use todo_status::TodoStatus; diff --git a/tests/e2e-ui/crates/todo-domain/src/models/todo.rs b/tests/e2e-ui/crates/todo-domain/src/models/todo.rs new file mode 100644 index 00000000..29eb8f7e --- /dev/null +++ b/tests/e2e-ui/crates/todo-domain/src/models/todo.rs @@ -0,0 +1,227 @@ +use distributed::{sourced, Entity}; +use serde::{Deserialize, Serialize}; + +use super::{TodoError, TodoStatus}; + +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +pub struct Todo { + #[serde(skip, default)] + pub entity: Entity, + pub todo_id: String, + pub owner_id: String, + pub title: String, + pub status: TodoStatus, +} + +impl Todo { + pub fn is_created(&self) -> bool { + !self.todo_id.is_empty() + } + + pub fn ensure_owner(&self, owner_id: &str) -> Result<(), TodoError> { + if !self.is_created() { + return Err(TodoError::NotCreated); + } + if self.owner_id != owner_id { + return Err(TodoError::NotOwner); + } + Ok(()) + } + + fn require_mutable(&self) -> Result<(), TodoError> { + if !self.is_created() { + return Err(TodoError::NotCreated); + } + if matches!(self.status, TodoStatus::Archived) { + return Err(TodoError::Archived); + } + Ok(()) + } +} + +#[sourced(entity, events = "TodoEvent", aggregate_type = "todo")] +impl Todo { + /// Create a new open todo. `owner_id` is the authenticated user (never trusted from peers). + pub fn create( + &mut self, + todo_id: impl Into, + owner_id: impl Into, + title: impl Into, + ) -> Result<(), TodoError> { + if self.is_created() { + return Err(TodoError::AlreadyExists); + } + let todo_id = todo_id.into(); + let owner_id = owner_id.into(); + let title = title.into(); + if todo_id.trim().is_empty() { + return Err(TodoError::EmptyId); + } + if owner_id.trim().is_empty() { + return Err(TodoError::EmptyOwner); + } + let title = title.trim(); + if title.is_empty() { + return Err(TodoError::EmptyTitle); + } + self.record_created(todo_id, owner_id, title.to_string())?; + Ok(()) + } + + #[event("todo.created")] + fn record_created(&mut self, todo_id: String, owner_id: String, title: String) { + self.entity.set_id(&todo_id); + self.todo_id = todo_id; + self.owner_id = owner_id; + self.title = title; + self.status = TodoStatus::Open; + } + + pub fn rename(&mut self, owner_id: &str, title: impl Into) -> Result<(), TodoError> { + self.ensure_owner(owner_id)?; + self.require_mutable()?; + let title = title.into(); + let title = title.trim(); + if title.is_empty() { + return Err(TodoError::EmptyTitle); + } + if title == self.title { + return Ok(()); // no-op: same title + } + self.record_renamed(title.to_string())?; + Ok(()) + } + + #[event("todo.renamed")] + fn record_renamed(&mut self, title: String) { + self.title = title; + } + + pub fn complete(&mut self, owner_id: &str) -> Result<(), TodoError> { + self.ensure_owner(owner_id)?; + self.require_mutable()?; + if matches!(self.status, TodoStatus::Completed) { + return Err(TodoError::AlreadyCompleted); + } + self.record_completed()?; + Ok(()) + } + + #[event("todo.completed")] + fn record_completed(&mut self) { + self.status = TodoStatus::Completed; + } + + pub fn reopen(&mut self, owner_id: &str) -> Result<(), TodoError> { + self.ensure_owner(owner_id)?; + self.require_mutable()?; + if !matches!(self.status, TodoStatus::Completed) { + return Err(TodoError::NotCompleted); + } + self.record_reopened()?; + Ok(()) + } + + #[event("todo.reopened")] + fn record_reopened(&mut self) { + self.status = TodoStatus::Open; + } + + pub fn archive(&mut self, owner_id: &str) -> Result<(), TodoError> { + self.ensure_owner(owner_id)?; + if !self.is_created() { + return Err(TodoError::NotCreated); + } + if matches!(self.status, TodoStatus::Archived) { + return Ok(()); // idempotent archive + } + self.record_archived()?; + Ok(()) + } + + #[event("todo.archived")] + fn record_archived(&mut self) { + self.status = TodoStatus::Archived; + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn open_todo() -> Todo { + let mut t = Todo::default(); + t.create("t1", "alice", "Buy milk").unwrap(); + t + } + + #[test] + fn create_sets_owner_and_open_status() { + let t = open_todo(); + assert!(t.is_created()); + assert_eq!(t.owner_id, "alice"); + assert_eq!(t.title, "Buy milk"); + assert_eq!(t.status, TodoStatus::Open); + assert_eq!(t.entity.id(), "t1"); + assert_eq!(t.entity.version(), 1); + } + + #[test] + fn rejects_empty_title_and_double_create() { + let mut t = Todo::default(); + assert_eq!(t.create("t1", "alice", " ").unwrap_err(), TodoError::EmptyTitle); + t.create("t1", "alice", "ok").unwrap(); + assert_eq!( + t.create("t1", "alice", "again").unwrap_err(), + TodoError::AlreadyExists + ); + } + + #[test] + fn only_owner_can_mutate() { + let mut t = open_todo(); + assert_eq!(t.complete("bob").unwrap_err(), TodoError::NotOwner); + t.complete("alice").unwrap(); + assert_eq!(t.status, TodoStatus::Completed); + } + + #[test] + fn complete_reopen_cycle() { + let mut t = open_todo(); + t.complete("alice").unwrap(); + assert_eq!( + t.complete("alice").unwrap_err(), + TodoError::AlreadyCompleted + ); + t.reopen("alice").unwrap(); + assert_eq!(t.status, TodoStatus::Open); + assert_eq!(t.reopen("alice").unwrap_err(), TodoError::NotCompleted); + } + + #[test] + fn rename_trims_and_rejects_empty() { + let mut t = open_todo(); + t.rename("alice", " Eggs ").unwrap(); + assert_eq!(t.title, "Eggs"); + assert_eq!( + t.rename("alice", " ").unwrap_err(), + TodoError::EmptyTitle + ); + // same title is no-op (no extra version if no event — check version stays) + let v = t.entity.version(); + t.rename("alice", "Eggs").unwrap(); + assert_eq!(t.entity.version(), v); + } + + #[test] + fn archive_is_terminal_for_mutations() { + let mut t = open_todo(); + t.archive("alice").unwrap(); + assert_eq!(t.status, TodoStatus::Archived); + assert_eq!(t.complete("alice").unwrap_err(), TodoError::Archived); + assert_eq!(t.rename("alice", "x").unwrap_err(), TodoError::Archived); + // second archive is idempotent + t.archive("alice").unwrap(); + assert_eq!(t.status, TodoStatus::Archived); + } +} diff --git a/tests/e2e-ui/crates/todo-domain/src/models/todo_error.rs b/tests/e2e-ui/crates/todo-domain/src/models/todo_error.rs new file mode 100644 index 00000000..e8dd3561 --- /dev/null +++ b/tests/e2e-ui/crates/todo-domain/src/models/todo_error.rs @@ -0,0 +1,25 @@ +use thiserror::Error; + +#[derive(Debug, Error, PartialEq, Eq)] +pub enum TodoError { + #[error("todo already exists")] + AlreadyExists, + #[error("todo not found / not created")] + NotCreated, + #[error("todo is archived")] + Archived, + #[error("todo is already completed")] + AlreadyCompleted, + #[error("todo is not completed")] + NotCompleted, + #[error("empty todo id")] + EmptyId, + #[error("empty owner id")] + EmptyOwner, + #[error("empty title")] + EmptyTitle, + #[error("not the owner")] + NotOwner, + #[error(transparent)] + Event(#[from] distributed::EventRecordError), +} diff --git a/tests/e2e-ui/crates/todo-domain/src/models/todo_fact.rs b/tests/e2e-ui/crates/todo-domain/src/models/todo_fact.rs new file mode 100644 index 00000000..3abd1f4d --- /dev/null +++ b/tests/e2e-ui/crates/todo-domain/src/models/todo_fact.rs @@ -0,0 +1,29 @@ +use serde::{Deserialize, Serialize}; + +use super::{Todo, TodoStatus}; + +/// Portable outbox / projection DTO. +/// Full snapshot fields so projectors can upsert without loading prior rows. +#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] +pub struct TodoFact { + pub todo_id: String, + pub owner_id: String, + pub title: String, + /// `open` | `completed` | `archived` + pub status: String, +} + +impl TodoFact { + pub fn from_todo(t: &Todo) -> Self { + Self { + todo_id: t.todo_id.clone(), + owner_id: t.owner_id.clone(), + title: t.title.clone(), + status: match t.status { + TodoStatus::Open => "open".into(), + TodoStatus::Completed => "completed".into(), + TodoStatus::Archived => "archived".into(), + }, + } + } +} diff --git a/tests/e2e-ui/crates/todo-domain/src/models/todo_status.rs b/tests/e2e-ui/crates/todo-domain/src/models/todo_status.rs new file mode 100644 index 00000000..ca30b867 --- /dev/null +++ b/tests/e2e-ui/crates/todo-domain/src/models/todo_status.rs @@ -0,0 +1,10 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)] +#[serde(rename_all = "snake_case")] +pub enum TodoStatus { + #[default] + Open, + Completed, + Archived, +} diff --git a/tests/e2e-ui/docker/Caddyfile b/tests/e2e-ui/docker/Caddyfile index b3b9d4d0..2cae7727 100644 --- a/tests/e2e-ui/docker/Caddyfile +++ b/tests/e2e-ui/docker/Caddyfile @@ -1,11 +1,14 @@ -# Mirrors sites/the-website/zitadel/Caddyfile — host port 18080 (ExternalPort). +# Host port 18080 (ExternalPort). Self-hosted Login V2 is on the same edge as +# OIDC: authorize → /ui/v2/login/login?authRequest=V2_… Auth.js keeps using +# /oauth/v2/* on this host. (Official login image bakes basePath=/ui/v2/login.) :8080 { - # Zitadel v4 login UI (Next.js) lives behind its own service. + # Login V2 Next.js (Session + User/Auth v2). Pages: /login, /register, + # /password, … under this base path. handle /ui/v2/login* { reverse_proxy zitadel-login:3000 } - # Everything else (console, API, OIDC, .well-known) → Zitadel server. + # Console, management/auth APIs, OIDC, .well-known, /idps/callback, etc. # Pin Host to ExternalDomain so internal callers hit the same instance # the browser hits (Host=localhost:18080). handle { diff --git a/tests/e2e-ui/docker/docker-compose.yml b/tests/e2e-ui/docker/docker-compose.yml index d07e82a1..aae9e6f8 100644 --- a/tests/e2e-ui/docker/docker-compose.yml +++ b/tests/e2e-ui/docker/docker-compose.yml @@ -1,11 +1,12 @@ -# e2e-ui full stack: app Postgres + Zitadel (OIDC). -# Zitadel topology mirrors sites/the-website (API + login UI + Caddy proxy). +# e2e-ui full stack: app Postgres + Zitadel (OIDC + Login V2 UI). +# Zitadel API + self-hosted Login V2 (Session / User v2) + Caddy edge. +# Auth.js still uses OIDC (/oauth/v2/*); authorize lands on /ui/v2/login/login. # # cd tests/e2e-ui && make up # # Ports: # 5433 app Postgres (event store, read models, bus) -# 18080 Zitadel via proxy (OIDC + /ui/v2/login + console) +# 18080 Zitadel via proxy (OIDC + Login V2 /ui/v2/login + console) services: app-db: image: docker.io/library/postgres:16-alpine @@ -55,15 +56,17 @@ services: - ./machinekey:/machinekey networks: [e2e] - # Zitadel v4 ships login UI as a separate Next.js service (the-website pattern). - # PAT at /login-client/pat is written by scripts/up.sh after Zitadel boots — - # container restarts until that file exists. + # Self-hosted Login V2 (Next.js). Session API + User/Auth v2 against Zitadel. + # Official image bakes basePath=/ui/v2/login (pages: …/login, …/register, …). + # PAT written by scripts/up.sh after Zitadel boots. zitadel-login: image: ghcr.io/zitadel/login:v3.0.1 restart: unless-stopped environment: ZITADEL_API_URL: http://zitadel-proxy:8080 + # Must match the baked Next.js basePath in ghcr.io/zitadel/login. NEXT_PUBLIC_BASE_PATH: /ui/v2/login + CUSTOM_REQUEST_HEADERS: "Host:localhost:18080,X-Forwarded-Proto:http,X-Forwarded-Host:localhost:18080" command: - /bin/sh - -c diff --git a/tests/e2e-ui/docs/blob-game-remake.md b/tests/e2e-ui/docs/blob-game-remake.md new file mode 100644 index 00000000..1f731342 --- /dev/null +++ b/tests/e2e-ui/docs/blob-game-remake.md @@ -0,0 +1,124 @@ +# Blob Game remake — e2e-ui CQRS/ES demo + +Remake of **internet-game-meta** `projects/ig-blob-game-model-service` (and Blob UI) as a domain + GraphQL surface + Svelte page inside `tests/e2e-ui`. Goal: show **aggregates emit events → projectors update read models → UI queries/subscribes**. + +## Sources + +| Legacy | Role | +|--------|------| +| `ig-blob-game-model-service/src/models/BlobGame.ts` | Aggregate rules | +| `…/lib/constants.ts` | Tile enum | +| `…/lib/levels.ts` | Level generation (reference only) | +| `…/handlers/blob-game.*.ts` | Commands: initialize, start-next-level, move | +| `internet-game/.../Games/Blob/*` | UI reference only | +| `distributed/tests/blob_game/` | Earlier Rust sketch (tile death values **not** used; see below) | + +## Tile semantics (canonical — match JS) + +| Value | Name | Meaning | +|------:|------|---------| +| `9` | `player` | Current cell | +| `0` | `hole` | Instant death if entered | +| `1` | `unvisited` | Scoring cell; become `visited` after leave | +| `2` | `visited` | Re-entry → death (`dead_by_suicide`) | +| `3` | `dead_by_suicide` | Died by revisit / timeout | +| `4` | `dead_by_hole` | Died by hole | + +> Earlier Rust port used `10`/`11` for death tiles. **This remake uses `3`/`4` like JS.** + +## Domain rules + +1. **Initialize** — set `game_id`, `owner_id` (auth user). Level list empty; `current_level = 0`; `current_level_completed = true` (so first level can start). +2. **Start next level** — only if initialized and `current_level_completed` and not dead. Append map; `current_level += 1`; `current_level_completed = false`. Player must appear exactly once (`tile = 9`). +3. **Move** (up/down/left/right) — only if a level is active and player not dead. + - Edge moves **reject** (no event, no mutation). + - Leave previous cell as `visited` (`2`). + - Enter `hole` → cell becomes `dead_by_hole` (`4`), `player_dead = true`. + - Enter `visited` → cell becomes `dead_by_suicide` (`3`), `player_dead = true`. + - Enter `unvisited` → cell becomes `player` (`9`), **score += 1**. +4. **Level complete** — after a move, if no `unvisited` remains and player not dead: `current_level_completed = true`, level.completed = true. +5. **Timed mode** — optional; not required for e2e demo (omit or default off). + +## Commands (GraphQL mutations) + +| Command | GraphQL field | Input | Notes | +|---------|---------------|-------|--------| +| `blob.start` | `blob_games_start` | `game_id` | Auth owner; creates game + starts **demo level 1** (fixed small map) | +| `blob.move` | `blob_games_move` | `game_id`, `direction` | `up` \| `down` \| `left` \| `right` | +| `blob.start_level` | `blob_games_start_level` | `game_id`, optional map | Next level when previous complete; default demo map if omitted | + +Owner is **always** the session principal (`x-user-id`); never from client for ownership. + +## Events (domain → bus → projector) + +Each successful mutation records a full **fact** snapshot (same pattern as `TodoFact`): + +| Event name | When | +|------------|------| +| `blob.initialized` | After start (init only if split; usually folded into start) | +| `blob.level_started` | Level appended / active | +| `blob.moved` | After a successful move (score/death/complete already applied) | + +**Payload (`BlobGameFact`):** + +```text +game_id, owner_id, score, player_dead, current_level, +current_level_completed, map_json (stringified number[][]), +status: "active" | "dead" | "level_complete" +``` + +**Commands upsert `blob_games` after commit** so the mutation response is the live RM row. +**Client stays optimistic:** paint with local rules first, then reconcile with the command +payload (authoritative RM). Projectors remain idempotent backup — UI does not wait on them. + +## Read model + +**Table:** `blob_games` + +| Column | Type | Notes | +|--------|------|--------| +| `game_id` | text PK | Aggregate id | +| `owner_id` | text | RLS: user sees own rows | +| `score` | integer | | +| `player_dead` | bool / int | | +| `current_level` | integer | | +| `current_level_completed` | bool | | +| `map_json` | text | JSON 2D array of tile ints | +| `status` | text | `active` / `dead` / `level_complete` | + +GraphQL: query `blob_games` (filter by owner for role `user`); optional subscription on same table via ChangeHub. + +## UI page `/blob` + +1. Auth required (same as todos). +2. **New game** → `blob_games_start` with client-generated `game_id`. +3. Render grid from `map_json` (colors by tile value). +4. Arrow buttons / keyboard → `blob_games_move`. +5. Show score, dead banner, level-complete + optional **Next level**. +6. Live list/query store like todos (document store + command pipeline). + +## Differences from legacy JS service + +| Legacy | e2e remake | +|--------|------------| +| sourced JS Entity + Knative bus | Distributed Rust aggregate + outbox bus | +| Hasura session `x-hasura-user-id` | GraphQL OIDC / DevHeaders `x-user-id` | +| Separate denormalizer HTTP | In-process projector | +| 12×12 random holes (heuristic) | **8×8 generated** maps with hole spacing + **Hamiltonian passability** check | +| minigameId / web3 address | `owner_id` = auth user | +| Timed 5-minute death | Not required for demo | + +## Level generation + +- `blob_domain::generate_level(level_index)` builds a **6×6** grid, player at `(0,0)`, + places holes with spacing heuristics (inspired by original `basicHoleValidation`), + then accepts only maps that are **Hamiltonian-passable** (some path visits every + non-hole cell exactly once). Falls back to a no-hole grid if generation fails. +- Each **New game** / **Next level** draws a new map; hole count grows slowly with level. +- Unit tests use fixed maps (`test_map_*`, `demo_map`) for deterministic rules tests. + +## Test plan (in-repo) + +1. **Domain unit** — initialize/start → move score; hole death; revisit death; level complete; edge reject. +2. **Projector unit** — apply `blob.moved` fact → read-model row matches. +3. **Live GraphQL** — `blob_games_start` + `blob_games_move` + query `blob_games` with DevHeaders; assert score/map change. diff --git a/tests/e2e-ui/docs/zitadel-ingestor.md b/tests/e2e-ui/docs/zitadel-ingestor.md new file mode 100644 index 00000000..19cca07c --- /dev/null +++ b/tests/e2e-ui/docs/zitadel-ingestor.md @@ -0,0 +1,144 @@ +# Zitadel Action → e2e-ui ingress + +Teaching fixture for **provider ingress → outbox → projector → read model → GraphQL joins**. + +Simplified cousin of the gitkb domain-service Zitadel ingestor: here we **do not** drive an +`AuthAccount` aggregate. The projector maps `zitadel.*.v1` messages straight into +`auth_users`, which chat and blob games join for display names. + +## Pipeline + +```text + ┌─ Zitadel Action / curl ── POST /zitadel.ingress.v1 + │ +Provider messages ──┼─ Management API scrape ── background loop + POST /zitadel.scrape.v1 + │ (missed events / backfill) + ▼ + outbox zitadel.user.*.v1 + ▼ + project_auth_user → auth_users + ▼ + GraphQL joins: chat.author / blob.owner +``` + +| Layer | Location | +|-------|----------| +| Authenticity | `handlers/ingestors/zitadel/auth.rs` | +| Map Action → subject | `handlers/ingestors/zitadel/map.rs` | +| Outbox publish | `handlers/ingestors/zitadel/publish.rs` | +| Management scrape | `handlers/ingestors/zitadel/scrape.rs` | +| On-demand scrape cmd | `handlers/ingestors/zitadel_scrape.rs` (`zitadel.scrape.v1`) | +| Projector | `handlers/events/project_auth_user.rs` | +| Read model + joins | `e2e-readmodels` `AuthUserView`, `ChatMessageView.author`, `BlobGameView.owner` | + +## Scrape (reconcile) + +Actions can drop events. The scraper lists users from Zitadel Management API and +publishes the **same** provider subjects the Action path uses (`zitadel.user.*.v1`), +so projectors stay single-path. + +| Env | Purpose | +|-----|---------| +| `ZITADEL_SERVICE_USER_TOKEN` | PAT (same as Login V2; written by `make up`) | +| `ZITADEL_API_URL` or `OIDC_ISSUER` | API base (e.g. `http://localhost:18080`) | +| `ZITADEL_SCRAPE_INTERVAL_SECS` | Background period (default **60**; `0` = no loop) | +| `ZITADEL_SCRAPE_ON_START` | Run once at process start (default **on** when configured) | + +Delivery ids are `zitadel-scrape:{userId}:{fingerprint}` so unchanged profiles +do not spam the outbox on every tick. + +```bash +# On-demand (secret header) +curl -sS -X POST "http://127.0.0.1:8791/zitadel.scrape.v1" \ + -H "content-type: application/json" \ + -H "x-zitadel-ingestor-secret: $ZITADEL_INGESTOR_SECRET" \ + -d '{}' +# → { listed, published, skipped, errors } +``` + +## Authenticity + +| Item | Value | +|------|--------| +| Env | `ZITADEL_INGESTOR_SECRET` (required for fixture path) | +| Header | `x-zitadel-ingestor-secret: ` | +| Alt | `Authorization: Bearer ` | +| Local Actions | `ZITADEL_INGESTOR_ALLOW_ACTION_EVENTS=1` accepts native Actions v2 bodies without secret | +| OIDC | Path `/zitadel.ingress.v1` skips the bearer gate (secret is the authn) | + +Missing or invalid secret → **401**. + +## curl fixtures + +```bash +SECRET=dev-secret-change-me +BASE=http://127.0.0.1:8791 +export ZITADEL_INGESTOR_SECRET="$SECRET" + +# Reject without secret +curl -sS -o /dev/null -w "%{http_code}\n" -X POST "$BASE/zitadel.ingress.v1" \ + -H 'content-type: application/json' \ + -d '{"event_type":"user.human.created","provider_subject":"u1","delivery_id":"d0"}' +# → 401 + +# Import a human (provider_subject = OIDC sub = E2E_HUMAN_ALICE_UID from e2e-ui.env) +set -a && source e2e-ui.env && set +a +SECRET="${ZITADEL_INGESTOR_SECRET:-e2e-zitadel-ingestor-secret}" +curl -sS -X POST "$BASE/zitadel.ingress.v1" \ + -H "content-type: application/json" \ + -H "x-zitadel-ingestor-secret: $SECRET" \ + -d "{ + \"delivery_id\": \"local-create-alice\", + \"event_type\": \"user.human.created\", + \"provider_subject\": \"$E2E_HUMAN_ALICE_UID\", + \"email\": \"alice@e2e.local\", + \"display_name\": \"Alice\", + \"approval_status\": \"approved\" + }" +# → published zitadel.user.human.created.v1 +# → after outbox drain: auth_users row (chat/blob joins resolve display_name) +``` + +### GraphQL join (after import) + +```graphql +query { + chat_messages(where: { room_id: { _eq: "lobby" } }) { + body + author_id + author { display_name email status } + } + blob_games { + game_id + owner_id + owner { display_name email } + } + auth_users { + user_id + display_name + chat_messages { body } + blob_games { score } + } +} +``` + +`user_id` on `auth_users` is the Zitadel subject. Chat `author_id` and blob `owner_id` +are the session principal (OIDC `sub`) — they match after you ingest that subject. + +## Local run + +```bash +cd tests/e2e-ui +export ZITADEL_INGESTOR_SECRET=dev-secret-change-me +# optional in e2e-ui.env for make run +make run +``` + +Outbox dispatcher + bus consumers are already spawned by `e2e-runner`. + +## Tests + +```bash +cargo test -p e2e-service --lib +cargo test -p e2e-readmodels --lib +``` diff --git a/tests/e2e-ui/scripts/up.sh b/tests/e2e-ui/scripts/up.sh index e2e5701a..a0014ece 100755 --- a/tests/e2e-ui/scripts/up.sh +++ b/tests/e2e-ui/scripts/up.sh @@ -8,7 +8,9 @@ COMPOSE="$ROOT/docker/docker-compose.yml" MACHINEKEY_DIR="$ROOT/docker/machinekey" ZITADEL_HOST="${ZITADEL_HOST:-http://localhost:18080}" OUT="${E2E_UI_ENV:-$ROOT/e2e-ui.env}" -UI_ORIGIN="${E2E_UI_ORIGIN:-http://127.0.0.1:5180}" +# Prefer localhost (not 127.0.0.1): SvelteKit only skips Secure cookies for +# hostname === "localhost" over http. 127.0.0.1 forces Secure and breaks OIDC. +UI_ORIGIN="${E2E_UI_ORIGIN:-http://localhost:5180}" API_ORIGIN="${E2E_API_ORIGIN:-http://127.0.0.1:8791}" PROJECT_NAME="${E2E_OIDC_PROJECT:-e2e-ui}" APP_NAME="${E2E_OIDC_APP:-e2e-ui-web}" @@ -196,22 +198,46 @@ echo "==> Management API ready" api POST /management/v1/projects/_search '{}' >/dev/null echo " ok" -# ---- login-client PAT (same as sites/the-website/scripts/setup-local-zitadel.sh) ---- -# Zitadel v4 login UI is a separate container; it needs IAM_LOGIN_CLIENT + PAT. -# Always mint a fresh PAT: after compose recreate the DB, an old pat file is -# invalid and zitadel-login returns HTTP 500 (Errors.Token.Invalid AUTH-7fs1e). +# Login V2 base URI: Fieldnote UI origin (custom /login pages), NOT Zitadel's +# stock Next.js login image. Authorize redirects to: +# ${LOGIN_V2_BASE_URI}/login?authRequest=V2_… +# Auth.js still owns OIDC (PKCE + code exchange); Session API finalizes on the app. +LOGIN_V2_BASE_URI="${LOGIN_V2_BASE_URI:-$UI_ORIGIN}" +LOGIN_V2_BASE_URI="${LOGIN_V2_BASE_URI%/}" + +# Instance-wide Login V2. required=true → all apps use Login V2 + baseUri. +echo "==> Instance features: Login V2 custom UI (baseUri=$LOGIN_V2_BASE_URI)" +FEAT_BODY=$(jq -n --arg base "$LOGIN_V2_BASE_URI" '{ + loginV2: { required: true, baseUri: $base }, + consoleUseV2UserApi: true +}') +FEAT_RESP=$(curl -sS --max-time 15 -w '\n%{http_code}' -X PUT "$ZITADEL_HOST/v2/features/instance" \ + -H "Authorization: Bearer $ACCESS_TOKEN" -H 'Content-Type: application/json' \ + -d "$FEAT_BODY" || true) +FEAT_CODE=$(echo "$FEAT_RESP" | tail -n1) +FEAT_OUT=$(echo "$FEAT_RESP" | sed '$d') +if [[ "$FEAT_CODE" == "200" || "$FEAT_CODE" == "201" ]]; then + echo " loginV2 feature set (HTTP $FEAT_CODE)" +else + echo " WARN: set instance features HTTP $FEAT_CODE — $FEAT_OUT" +fi + +# ---- login-client PAT ---- +# IAM_LOGIN_CLIENT PAT for the e2e-ui custom login pages (Session + User v2 + +# OIDC CreateCallback). Also kept for optional stock zitadel-login container. +# Always mint a fresh PAT: after compose recreate the DB, an old pat is invalid. LOGIN_CLIENT_DIR="$ROOT/docker/login-client" LOGIN_CLIENT_PAT_FILE="$LOGIN_CLIENT_DIR/pat" LOGIN_CLIENT_USERNAME="login-client" mkdir -p "$LOGIN_CLIENT_DIR" -echo "==> login-client machine user + fresh PAT (for /ui/v2/login)" +echo "==> login-client machine user + fresh PAT (custom Login V2 pages)" USER_SEARCH=$(api POST /management/v1/users/_search "$(jq -n --arg n "$LOGIN_CLIENT_USERNAME" \ '{queries: [{userNameQuery: {userName: $n, method: "TEXT_QUERY_METHOD_EQUALS"}}]}')") LOGIN_USER_ID=$(echo "$USER_SEARCH" | jq -r '.result[0].id // empty') if [[ -z "$LOGIN_USER_ID" ]]; then LOGIN_USER_RESP=$(api POST /management/v1/users/machine "$(jq -n \ --arg u "$LOGIN_CLIENT_USERNAME" \ - '{userName: $u, name: "Login Client", description: "Service user for zitadel-login", accessTokenType: "ACCESS_TOKEN_TYPE_BEARER"}')") + '{userName: $u, name: "Login Client", description: "Service user for custom Login V2 UI (Session API)", accessTokenType: "ACCESS_TOKEN_TYPE_BEARER"}')") LOGIN_USER_ID=$(echo "$LOGIN_USER_RESP" | jq -r .userId) [[ -n "$LOGIN_USER_ID" && "$LOGIN_USER_ID" != "null" ]] || { echo "ERROR: login-client create failed"; echo "$LOGIN_USER_RESP"; exit 1 @@ -231,24 +257,10 @@ LOGIN_PAT=$(echo "$PAT_RESP" | jq -r .token) umask 077 printf '%s' "$LOGIN_PAT" > "$LOGIN_CLIENT_PAT_FILE" chmod 600 "$LOGIN_CLIENT_PAT_FILE" 2>/dev/null || true -echo " wrote $LOGIN_CLIENT_PAT_FILE" -echo "==> Restarting zitadel-login to pick up PAT" +echo " wrote $LOGIN_CLIENT_PAT_FILE (also exported as ZITADEL_SERVICE_USER_TOKEN)" +# Optional stock login container still mounts the PAT (not used when baseUri is the app). docker compose -f "$COMPOSE" up -d --force-recreate zitadel-login >/dev/null 2>&1 \ || docker compose -f "$COMPOSE" restart zitadel-login >/dev/null 2>&1 || true -echo "==> Wait for login UI (/ui/v2/login)" -for i in $(seq 1 40); do - code=$(curl -s --max-time 3 -o /dev/null -w '%{http_code}' "$ZITADEL_HOST/ui/v2/login" || true) - # Healthy login UI: not 500/502 (empty path may 200/307/404 depending on version) - if [[ "$code" != "000" && "$code" != "500" && "$code" != "502" && "$code" != "503" ]]; then - echo " login UI ready (HTTP $code)" - break - fi - wait_tick "login UI HTTP ${code:-?}" "$i" 5 - sleep 1 - if [[ $i -eq 40 ]]; then - echo " WARN: login UI still HTTP $code — check: docker compose logs zitadel-login" - fi -done echo "==> Project $PROJECT_NAME" PROJECT_SEARCH=$(api POST /management/v1/projects/_search '{}') @@ -270,7 +282,8 @@ for role in user admin; do fi done -echo "==> Web OIDC app $APP_NAME (Auth.js browser login)" +# OIDC app: Login V2 baseUri = Fieldnote UI (custom /login). Auth.js keeps PKCE. +echo "==> Web OIDC app $APP_NAME (Auth.js → authorize → custom /login)" APP_SEARCH=$(api POST "/management/v1/projects/$PROJECT_ID/apps/_search" '{}') APP_ID=$(echo "$APP_SEARCH" | jq -r --arg n "$APP_NAME" '.result[]? | select(.name == $n) | .id' | head -n1) CLIENT_ID="" @@ -279,7 +292,7 @@ if [[ -z "$APP_ID" ]]; then APP_RESP=$(api POST "/management/v1/projects/$PROJECT_ID/apps/oidc" "$(jq -n \ --arg name "$APP_NAME" \ --arg ui "$UI_ORIGIN" \ - --arg api "$API_ORIGIN" \ + --arg base "$LOGIN_V2_BASE_URI" \ '{ name: $name, redirectUris: [ @@ -295,22 +308,71 @@ if [[ -z "$APP_ID" ]]; then ], appType: "OIDC_APP_TYPE_WEB", authMethodType: "OIDC_AUTH_METHOD_TYPE_BASIC", - postLogoutRedirectUris: [$ui + "/", "http://127.0.0.1:5180/", "http://localhost:5180/"], + postLogoutRedirectUris: [ + ($ui + "/"), + $ui, + "http://127.0.0.1:5180/", + "http://127.0.0.1:5180", + "http://localhost:5180/", + "http://localhost:5180" + ], version: "OIDC_VERSION_1_0", devMode: true, accessTokenType: "OIDC_TOKEN_TYPE_JWT", accessTokenRoleAssertion: true, idTokenRoleAssertion: true, - idTokenUserinfoAssertion: true + idTokenUserinfoAssertion: true, + loginVersion: { loginV2: { baseUri: $base } } }')") CLIENT_ID=$(echo "$APP_RESP" | jq -r '.clientId // empty') CLIENT_SECRET=$(echo "$APP_RESP" | jq -r '.clientSecret // empty') APP_ID=$(echo "$APP_RESP" | jq -r '.appId // .id // empty') - echo " created web app clientId=$CLIENT_ID" + echo " created web app clientId=$CLIENT_ID (Login V2)" else CLIENT_ID=$(echo "$APP_SEARCH" | jq -r --arg n "$APP_NAME" \ '.result[]? | select(.name == $n) | .oidcConfig.clientId // empty' | head -n1) echo " existing web app clientId=$CLIENT_ID (secret only on create — re-create stack if missing)" + # Pin Login V2 base URI on re-bootstrap (idempotent). + if [[ -n "$APP_ID" && "$APP_ID" != "null" ]]; then + UPD=$(curl -sS --max-time 15 -w '\n%{http_code}' -X PUT \ + "$ZITADEL_HOST/management/v1/projects/$PROJECT_ID/apps/$APP_ID/oidc_config" \ + -H "Authorization: Bearer $ACCESS_TOKEN" -H 'Content-Type: application/json' \ + -d "$(jq -n --arg base "$LOGIN_V2_BASE_URI" --arg ui "$UI_ORIGIN" '{ + redirectUris: [ + ($ui + "/auth/callback/oidc"), + ($ui + "/auth/callback"), + "http://127.0.0.1:5180/auth/callback/oidc", + "http://localhost:5180/auth/callback/oidc" + ], + responseTypes: ["OIDC_RESPONSE_TYPE_CODE"], + grantTypes: [ + "OIDC_GRANT_TYPE_AUTHORIZATION_CODE", + "OIDC_GRANT_TYPE_REFRESH_TOKEN" + ], + appType: "OIDC_APP_TYPE_WEB", + authMethodType: "OIDC_AUTH_METHOD_TYPE_BASIC", + postLogoutRedirectUris: [ + ($ui + "/"), + $ui, + "http://127.0.0.1:5180/", + "http://127.0.0.1:5180", + "http://localhost:5180/", + "http://localhost:5180" + ], + devMode: true, + accessTokenType: "OIDC_TOKEN_TYPE_JWT", + accessTokenRoleAssertion: true, + idTokenRoleAssertion: true, + idTokenUserinfoAssertion: true, + loginVersion: { loginV2: { baseUri: $base } } + }')" || true) + UPD_CODE=$(echo "$UPD" | tail -n1) + if [[ "$UPD_CODE" == "200" ]]; then + echo " updated OIDC app → Login V2 baseUri=$LOGIN_V2_BASE_URI" + else + echo " WARN: UpdateOIDCAppConfig HTTP $UPD_CODE — $(echo "$UPD" | sed '$d' | head -c 200)" + fi + fi fi if [[ -z "$CLIENT_ID" || "$CLIENT_ID" == "null" ]]; then echo "ERROR: web client id missing"; exit 1 @@ -520,6 +582,9 @@ AUTH_SECRET="$(_dq "$AUTH_SECRET")" AUTH_TRUST_HOST=true OIDC_SCOPES="openid profile email offline_access urn:zitadel:iam:org:project:id:${PROJECT_ID}:aud urn:zitadel:iam:org:project:roles" ZITADEL_PROJECT_ID="$(_dq "$PROJECT_ID")" +# Server-only: custom /login uses Session API + CreateCallback (never expose to browser). +ZITADEL_SERVICE_USER_TOKEN="$(_dq "$LOGIN_PAT")" +LOGIN_V2_BASE_URI="$(_dq "$LOGIN_V2_BASE_URI")" E2E_UI_ORIGIN="$(_dq "$UI_ORIGIN")" E2E_API_ORIGIN="$(_dq "$API_ORIGIN")" E2E_MACHINE_USER_KEY="$(_dq "$USER_M_KEY")" @@ -529,14 +594,22 @@ E2E_MACHINE_ADMIN_ID="$(_dq "$ADMIN_M_UID")" E2E_HUMAN_ALICE=alice E2E_HUMAN_BOB=bob E2E_HUMAN_PASSWORD="Password1!" +# Zitadel user ids (OIDC sub) — use as provider_subject for auth_users joins +E2E_HUMAN_ALICE_UID="$(_dq "$ALICE_UID")" +E2E_HUMAN_BOB_UID="$(_dq "$BOB_UID")" +E2E_HUMAN_ADMIN_UID="$(_dq "$ADMIN_HUMAN_UID")" +# Shared secret for POST /zitadel.ingress.v1 (import IdP users → auth_users RM) +ZITADEL_INGESTOR_SECRET="$(_dq "e2e-zitadel-ingestor-secret")" BIND="127.0.0.1:8791" EOF echo "==> Wrote $OUT" -cat "$OUT" +# Avoid dumping service PAT in terminal (still in file). +grep -v 'ZITADEL_SERVICE_USER_TOKEN\|OIDC_CLIENT_SECRET\|AUTH_SECRET' "$OUT" || true +echo " … secrets redacted in console (present in file)" echo "" echo "Next:" echo " set -a && source $OUT && set +a" -echo " cargo run -p e2e-runner" -echo " cd ui && npm run dev" -echo " Login: alice / Password1! (or bob, admin)" +echo " make run # restart so UI loads OIDC_* + ZITADEL_SERVICE_USER_TOKEN" +echo " Custom login: $LOGIN_V2_BASE_URI/login (Auth.js authorize → your pages → callback)" +echo " Demo users: alice / bob / admin · Password1!" diff --git a/tests/e2e-ui/ui/schema/admin.graphql b/tests/e2e-ui/ui/schema/admin.graphql index db1a5045..cfae6461 100644 --- a/tests/e2e-ui/ui/schema/admin.graphql +++ b/tests/e2e-ui/ui/schema/admin.graphql @@ -8,8 +8,80 @@ # # Spec: specs/query-layer/v1/surface-ir (A11) +type AuthUserView { + user_id: String! + email: String! + display_name: String! + user_kind: String! + approval_status: String! + status: String! + updated_at: String! + chat_messages(where: chat_messages_bool_exp, order_by: [chat_messages_order_by!], limit: Int, offset: Int): [ChatMessageView!]! + blob_games(where: blob_games_bool_exp, order_by: [blob_games_order_by!], limit: Int, offset: Int): [BlobGameView!]! +} + scalar BigInt +input BigInt_comparison_exp { + _eq: BigInt + _neq: BigInt + _gt: BigInt + _gte: BigInt + _lt: BigInt + _lte: BigInt + _in: [BigInt!] + _nin: [BigInt!] + _is_null: Boolean +} + +type BlobGamePayload { + game_id: String! + owner_id: String! + score: BigInt! + player_dead: Boolean! + current_level: BigInt! + current_level_completed: Boolean! + map_json: String! + status: String! +} + +type BlobGameView { + game_id: String! + owner_id: String! + score: BigInt! + player_dead: Boolean! + current_level: BigInt! + current_level_completed: Boolean! + map_json: String! + status: String! + owner: AuthUserView +} + +input BlobMoveInput { + game_id: String! + direction: String! +} + +input BlobStartInput { + game_id: String! +} + +input BlobStartLevelInput { + game_id: String! +} + +input Boolean_comparison_exp { + _eq: Boolean + _neq: Boolean + _gt: Boolean + _gte: Boolean + _lt: Boolean + _lte: Boolean + _in: [Boolean!] + _nin: [Boolean!] + _is_null: Boolean +} + scalar Bytea type ChatMessageView { @@ -18,6 +90,7 @@ type ChatMessageView { author_id: String! body: String! created_at: String! + author: AuthUserView } input ChatPostInput { @@ -44,9 +117,16 @@ type Mutation { todos_rename(input: TodoRenameInput!): TodoRenamePayload! todos_reopen(input: TodoReopenInput!): TodoStatusPayload! chat_messages_post(input: ChatPostInput!): ChatPostPayload! + blob_games_start(input: BlobStartInput!): BlobGamePayload! + blob_games_move(input: BlobMoveInput!): BlobGamePayload! + blob_games_start_level(input: BlobStartLevelInput!): BlobGamePayload! } type Query { + auth_users(where: auth_users_bool_exp, order_by: [auth_users_order_by!], limit: Int, offset: Int): [AuthUserView!]! + auth_users_by_pk(user_id: String!): AuthUserView + blob_games(where: blob_games_bool_exp, order_by: [blob_games_order_by!], limit: Int, offset: Int): [BlobGameView!]! + blob_games_by_pk(game_id: String!): BlobGameView chat_messages(where: chat_messages_bool_exp, order_by: [chat_messages_order_by!], limit: Int, offset: Int): [ChatMessageView!]! chat_messages_by_pk(message_id: String!): ChatMessageView todos(where: todos_bool_exp, order_by: [todos_order_by!], limit: Int, offset: Int): [TodoView!]! @@ -68,6 +148,8 @@ input String_comparison_exp { } type Subscription { + auth_users(where: auth_users_bool_exp, order_by: [auth_users_order_by!], limit: Int, offset: Int): [AuthUserView!]! + blob_games(where: blob_games_bool_exp, order_by: [blob_games_order_by!], limit: Int, offset: Int): [BlobGameView!]! chat_messages(where: chat_messages_bool_exp, order_by: [chat_messages_order_by!], limit: Int, offset: Int): [ChatMessageView!]! todos(where: todos_bool_exp, order_by: [todos_order_by!], limit: Int, offset: Int): [TodoView!]! } @@ -132,6 +214,57 @@ type TodoView { status: String! } +input auth_users_bool_exp { + _and: [auth_users_bool_exp!] + _or: [auth_users_bool_exp!] + _not: auth_users_bool_exp + user_id: String_comparison_exp + email: String_comparison_exp + display_name: String_comparison_exp + user_kind: String_comparison_exp + approval_status: String_comparison_exp + status: String_comparison_exp + updated_at: String_comparison_exp + chat_messages: chat_messages_bool_exp + blob_games: blob_games_bool_exp +} + +input auth_users_order_by { + user_id: order_by + email: order_by + display_name: order_by + user_kind: order_by + approval_status: order_by + status: order_by + updated_at: order_by +} + +input blob_games_bool_exp { + _and: [blob_games_bool_exp!] + _or: [blob_games_bool_exp!] + _not: blob_games_bool_exp + game_id: String_comparison_exp + owner_id: String_comparison_exp + score: BigInt_comparison_exp + player_dead: Boolean_comparison_exp + current_level: BigInt_comparison_exp + current_level_completed: Boolean_comparison_exp + map_json: String_comparison_exp + status: String_comparison_exp + owner: auth_users_bool_exp +} + +input blob_games_order_by { + game_id: order_by + owner_id: order_by + score: order_by + player_dead: order_by + current_level: order_by + current_level_completed: order_by + map_json: order_by + status: order_by +} + input chat_messages_bool_exp { _and: [chat_messages_bool_exp!] _or: [chat_messages_bool_exp!] @@ -141,6 +274,7 @@ input chat_messages_bool_exp { author_id: String_comparison_exp body: String_comparison_exp created_at: String_comparison_exp + author: auth_users_bool_exp } input chat_messages_order_by { diff --git a/tests/e2e-ui/ui/schema/user.graphql b/tests/e2e-ui/ui/schema/user.graphql index ab875564..e28ca8c4 100644 --- a/tests/e2e-ui/ui/schema/user.graphql +++ b/tests/e2e-ui/ui/schema/user.graphql @@ -8,8 +8,80 @@ # # Spec: specs/query-layer/v1/surface-ir (A11) +type AuthUserView { + user_id: String! + email: String! + display_name: String! + user_kind: String! + approval_status: String! + status: String! + updated_at: String! + chat_messages(where: chat_messages_bool_exp, order_by: [chat_messages_order_by!], limit: Int, offset: Int): [ChatMessageView!]! + blob_games(where: blob_games_bool_exp, order_by: [blob_games_order_by!], limit: Int, offset: Int): [BlobGameView!]! +} + scalar BigInt +input BigInt_comparison_exp { + _eq: BigInt + _neq: BigInt + _gt: BigInt + _gte: BigInt + _lt: BigInt + _lte: BigInt + _in: [BigInt!] + _nin: [BigInt!] + _is_null: Boolean +} + +type BlobGamePayload { + game_id: String! + owner_id: String! + score: BigInt! + player_dead: Boolean! + current_level: BigInt! + current_level_completed: Boolean! + map_json: String! + status: String! +} + +type BlobGameView { + game_id: String! + owner_id: String! + score: BigInt! + player_dead: Boolean! + current_level: BigInt! + current_level_completed: Boolean! + map_json: String! + status: String! + owner: AuthUserView +} + +input BlobMoveInput { + game_id: String! + direction: String! +} + +input BlobStartInput { + game_id: String! +} + +input BlobStartLevelInput { + game_id: String! +} + +input Boolean_comparison_exp { + _eq: Boolean + _neq: Boolean + _gt: Boolean + _gte: Boolean + _lt: Boolean + _lte: Boolean + _in: [Boolean!] + _nin: [Boolean!] + _is_null: Boolean +} + scalar Bytea type ChatMessageView { @@ -18,6 +90,7 @@ type ChatMessageView { author_id: String! body: String! created_at: String! + author: AuthUserView } input ChatPostInput { @@ -43,9 +116,16 @@ type Mutation { todos_rename(input: TodoRenameInput!): TodoRenamePayload! todos_reopen(input: TodoReopenInput!): TodoStatusPayload! chat_messages_post(input: ChatPostInput!): ChatPostPayload! + blob_games_start(input: BlobStartInput!): BlobGamePayload! + blob_games_move(input: BlobMoveInput!): BlobGamePayload! + blob_games_start_level(input: BlobStartLevelInput!): BlobGamePayload! } type Query { + auth_users(where: auth_users_bool_exp, order_by: [auth_users_order_by!], limit: Int, offset: Int): [AuthUserView!]! + auth_users_by_pk(user_id: String!): AuthUserView + blob_games(where: blob_games_bool_exp, order_by: [blob_games_order_by!], limit: Int, offset: Int): [BlobGameView!]! + blob_games_by_pk(game_id: String!): BlobGameView chat_messages(where: chat_messages_bool_exp, order_by: [chat_messages_order_by!], limit: Int, offset: Int): [ChatMessageView!]! chat_messages_by_pk(message_id: String!): ChatMessageView todos(where: todos_bool_exp, order_by: [todos_order_by!], limit: Int, offset: Int): [TodoView!]! @@ -67,6 +147,8 @@ input String_comparison_exp { } type Subscription { + auth_users(where: auth_users_bool_exp, order_by: [auth_users_order_by!], limit: Int, offset: Int): [AuthUserView!]! + blob_games(where: blob_games_bool_exp, order_by: [blob_games_order_by!], limit: Int, offset: Int): [BlobGameView!]! chat_messages(where: chat_messages_bool_exp, order_by: [chat_messages_order_by!], limit: Int, offset: Int): [ChatMessageView!]! todos(where: todos_bool_exp, order_by: [todos_order_by!], limit: Int, offset: Int): [TodoView!]! } @@ -120,6 +202,57 @@ type TodoView { status: String! } +input auth_users_bool_exp { + _and: [auth_users_bool_exp!] + _or: [auth_users_bool_exp!] + _not: auth_users_bool_exp + user_id: String_comparison_exp + email: String_comparison_exp + display_name: String_comparison_exp + user_kind: String_comparison_exp + approval_status: String_comparison_exp + status: String_comparison_exp + updated_at: String_comparison_exp + chat_messages: chat_messages_bool_exp + blob_games: blob_games_bool_exp +} + +input auth_users_order_by { + user_id: order_by + email: order_by + display_name: order_by + user_kind: order_by + approval_status: order_by + status: order_by + updated_at: order_by +} + +input blob_games_bool_exp { + _and: [blob_games_bool_exp!] + _or: [blob_games_bool_exp!] + _not: blob_games_bool_exp + game_id: String_comparison_exp + owner_id: String_comparison_exp + score: BigInt_comparison_exp + player_dead: Boolean_comparison_exp + current_level: BigInt_comparison_exp + current_level_completed: Boolean_comparison_exp + map_json: String_comparison_exp + status: String_comparison_exp + owner: auth_users_bool_exp +} + +input blob_games_order_by { + game_id: order_by + owner_id: order_by + score: order_by + player_dead: order_by + current_level: order_by + current_level_completed: order_by + map_json: order_by + status: order_by +} + input chat_messages_bool_exp { _and: [chat_messages_bool_exp!] _or: [chat_messages_bool_exp!] @@ -129,6 +262,7 @@ input chat_messages_bool_exp { author_id: String_comparison_exp body: String_comparison_exp created_at: String_comparison_exp + author: auth_users_bool_exp } input chat_messages_order_by { diff --git a/tests/e2e-ui/ui/src/auth.ts b/tests/e2e-ui/ui/src/auth.ts index cfcb260a..57eafb2d 100644 --- a/tests/e2e-ui/ui/src/auth.ts +++ b/tests/e2e-ui/ui/src/auth.ts @@ -28,10 +28,10 @@ const ACCESS_TOKEN_REFRESH_SKEW_SECONDS = 60; const TOKEN_AUTH_BASIC = 'client_secret_basic'; const TOKEN_AUTH_POST = 'client_secret_post'; const TOKEN_AUTH_NONE = 'none'; -const DEFAULT_SESSION_COOKIE_SAME_SITE = 'strict'; type TokenRecord = Record; type SessionCookieSameSite = 'lax' | 'strict'; +const DEFAULT_SESSION_COOKIE_SAME_SITE: SessionCookieSameSite = 'lax'; function envFirst(names: string[], fallback = '') { for (const name of names) { @@ -86,10 +86,28 @@ function authSessionCookieSameSite(): SessionCookieSameSite { if (value === 'lax' || value === 'strict') return value; if (value) { - console.warn('AUTH_SESSION_COOKIE_SAME_SITE must be lax or strict; defaulting to strict'); + console.warn('AUTH_SESSION_COOKIE_SAME_SITE must be lax or strict; defaulting to lax'); } - return DEFAULT_SESSION_COOKIE_SAME_SITE; + // Lax (not strict): OIDC return from Zitadel is a top-level nav; lax is enough + // and avoids edge cases with local multi-origin setups. + return 'lax'; +} + +/** + * Local e2e is plain http://127.0.0.1 — Secure cookies are dropped by the browser + * and login/session silently fails (every protected page looks "broken"). + * Only enable Secure when AUTH_URL / AUTH_TRUST_SECURE explicitly says https. + */ +function useSecureCookies(): boolean { + const forced = env.AUTH_USE_SECURE_COOKIES?.trim().toLowerCase(); + if (forced === '1' || forced === 'true' || forced === 'yes') return true; + if (forced === '0' || forced === 'false' || forced === 'no') return false; + + const authUrl = envFirst(['AUTH_URL', 'ORIGIN', 'PUBLIC_ORIGIN']); + if (authUrl.startsWith('https://')) return true; + // Default: local fixture is HTTP + return false; } function providerName() { @@ -265,10 +283,57 @@ export const { handle, signIn, signOut } = SvelteKitAuth({ signIn: '/', error: '/' }, + // HARD false for this local fixture. Auth.js defaults secure from request + // protocol / AUTH_URL; on plain http://127.0.0.1 Secure cookies are dropped + // by the browser and every protected page looks broken (session never sticks). + // Production HTTPS deploys must set AUTH_USE_SECURE_COOKIES=true (or AUTH_URL=https…). + useSecureCookies: useSecureCookies(), cookies: { sessionToken: { + name: 'authjs.session-token', + options: { + httpOnly: true, + sameSite: authSessionCookieSameSite(), + path: '/', + secure: false + } + }, + callbackUrl: { + name: 'authjs.callback-url', + options: { + httpOnly: true, + sameSite: authSessionCookieSameSite(), + path: '/', + secure: false + } + }, + csrfToken: { + name: 'authjs.csrf-token', + options: { + httpOnly: true, + sameSite: authSessionCookieSameSite(), + path: '/', + secure: false + } + }, + pkceCodeVerifier: { + name: 'authjs.pkce.code_verifier', + options: { + httpOnly: true, + sameSite: authSessionCookieSameSite(), + path: '/', + secure: false, + maxAge: 60 * 15 + } + }, + state: { + name: 'authjs.state', options: { - sameSite: authSessionCookieSameSite() + httpOnly: true, + sameSite: authSessionCookieSameSite(), + path: '/', + secure: false, + maxAge: 60 * 15 } } }, diff --git a/tests/e2e-ui/ui/src/hooks.server.ts b/tests/e2e-ui/ui/src/hooks.server.ts index e15646b6..85660b3d 100644 --- a/tests/e2e-ui/ui/src/hooks.server.ts +++ b/tests/e2e-ui/ui/src/hooks.server.ts @@ -9,6 +9,8 @@ async function authorizationHandle({ event, resolve }: { event: RequestEvent; re path.startsWith('/admin') || path === '/todos' || path.startsWith('/todos/') || + path === '/blob' || + path.startsWith('/blob/') || path === '/chat' || path.startsWith('/chat/') || path === '/session' || @@ -18,7 +20,8 @@ async function authorizationHandle({ event, resolve }: { event: RequestEvent; re const session = await event.locals.auth(); if (!session?.user) { const callbackUrl = encodeURIComponent(event.url.pathname + event.url.search); - throw redirect(303, `/signin?callbackUrl=${callbackUrl}`); + // Custom Login V2 pages at /login (not Zitadel-hosted UI) + throw redirect(303, `/login?callbackUrl=${callbackUrl}`); } } diff --git a/tests/e2e-ui/ui/src/lib/api/commands.generated.ts b/tests/e2e-ui/ui/src/lib/api/commands.generated.ts index 583b4b9d..9dce1287 100644 --- a/tests/e2e-ui/ui/src/lib/api/commands.generated.ts +++ b/tests/e2e-ui/ui/src/lib/api/commands.generated.ts @@ -84,6 +84,30 @@ export type ChatPostPayload = { created_at: string; }; +export type BlobStartInput = { + game_id: string; +}; + +export type BlobGamePayload = { + game_id: string; + owner_id: string; + score: number; + player_dead: boolean; + current_level: number; + current_level_completed: boolean; + map_json: string; + status: string; +}; + +export type BlobMoveInput = { + game_id: string; + direction: string; +}; + +export type BlobStartLevelInput = { + game_id: string; +}; + /** Field name → roles that may execute (engine ACL; client is not a boundary). */ export const COMMAND_ROLES = { "todos_create": ["user", "admin"] as const, @@ -93,6 +117,9 @@ export const COMMAND_ROLES = { "todos_rename": ["user", "admin"] as const, "todos_reopen": ["user", "admin"] as const, "chat_messages_post": ["user", "admin"] as const, + "blob_games_start": ["user", "admin"] as const, + "blob_games_move": ["user", "admin"] as const, + "blob_games_start_level": ["user", "admin"] as const, } as const; /** GraphQL mutation documents — keep in sync with commands.operations.gql. */ @@ -160,6 +187,48 @@ mutation Command_chat_messages_post($input: ChatPostInput!) { created_at } } +`, + "blob_games_start": ` +mutation Command_blob_games_start($input: BlobStartInput!) { + blob_games_start(input: $input) { + game_id + owner_id + score + player_dead + current_level + current_level_completed + map_json + status + } +} +`, + "blob_games_move": ` +mutation Command_blob_games_move($input: BlobMoveInput!) { + blob_games_move(input: $input) { + game_id + owner_id + score + player_dead + current_level + current_level_completed + map_json + status + } +} +`, + "blob_games_start_level": ` +mutation Command_blob_games_start_level($input: BlobStartLevelInput!) { + blob_games_start_level(input: $input) { + game_id + owner_id + score + player_dead + current_level + current_level_completed + map_json + status + } +} `, } as const; @@ -261,6 +330,48 @@ export async function chatMessagesPost(input: ChatPostInput, client: CommandClie }; } +/** + * blob.start → GraphQL `blob_games_start` + * roles: user, admin + * Prefer `client.commands.blobGamesStart(…)` via `bindCommands` / `useGraphql`. + */ +export async function blobGamesStart(input: BlobStartInput, client: CommandClient): Promise> { + const result = await client.request<{ blob_games_start?: BlobGamePayload }>(COMMAND_DOCS["blob_games_start"], { input }); + return { + data: result.data?.blob_games_start, + errors: result.errors, + status: result.status + }; +} + +/** + * blob.move → GraphQL `blob_games_move` + * roles: user, admin + * Prefer `client.commands.blobGamesMove(…)` via `bindCommands` / `useGraphql`. + */ +export async function blobGamesMove(input: BlobMoveInput, client: CommandClient): Promise> { + const result = await client.request<{ blob_games_move?: BlobGamePayload }>(COMMAND_DOCS["blob_games_move"], { input }); + return { + data: result.data?.blob_games_move, + errors: result.errors, + status: result.status + }; +} + +/** + * blob.start_level → GraphQL `blob_games_start_level` + * roles: user, admin + * Prefer `client.commands.blobGamesStartLevel(…)` via `bindCommands` / `useGraphql`. + */ +export async function blobGamesStartLevel(input: BlobStartLevelInput, client: CommandClient): Promise> { + const result = await client.request<{ blob_games_start_level?: BlobGamePayload }>(COMMAND_DOCS["blob_games_start_level"], { input }); + return { + data: result.data?.blob_games_start_level, + errors: result.errors, + status: result.status + }; +} + /** Commands pre-bound to a GraphQL client (URL + auth already configured). */ export type BoundCommands = { todosCreate: (input: TodoCreateInput) => Promise>; @@ -270,6 +381,9 @@ export type BoundCommands = { todosRename: (input: TodoRenameInput) => Promise>; todosReopen: (input: TodoReopenInput) => Promise>; chatMessagesPost: (input: ChatPostInput) => Promise>; + blobGamesStart: (input: BlobStartInput) => Promise>; + blobGamesMove: (input: BlobMoveInput) => Promise>; + blobGamesStartLevel: (input: BlobStartLevelInput) => Promise>; }; /** @@ -285,5 +399,8 @@ export function bindCommands(client: CommandClient): BoundCommands { todosRename: (input) => todosRename(input, client), todosReopen: (input) => todosReopen(input, client), chatMessagesPost: (input) => chatMessagesPost(input, client), + blobGamesStart: (input) => blobGamesStart(input, client), + blobGamesMove: (input) => blobGamesMove(input, client), + blobGamesStartLevel: (input) => blobGamesStartLevel(input, client), }; } diff --git a/tests/e2e-ui/ui/src/lib/api/commands.manifest.json b/tests/e2e-ui/ui/src/lib/api/commands.manifest.json index 90eb7db3..7bc2e059 100644 --- a/tests/e2e-ui/ui/src/lib/api/commands.manifest.json +++ b/tests/e2e-ui/ui/src/lib/api/commands.manifest.json @@ -323,6 +323,228 @@ } ] } + }, + { + "command_name": "blob.start", + "field_name": "blob_games_start", + "roles": [ + "user", + "admin" + ], + "input": { + "name": "BlobStartInput", + "fields": [ + { + "name": "game_id", + "type_name": "String", + "nullable": false, + "list": false + } + ] + }, + "output": { + "name": "BlobGamePayload", + "fields": [ + { + "name": "game_id", + "type_name": "String", + "nullable": false, + "list": false + }, + { + "name": "owner_id", + "type_name": "String", + "nullable": false, + "list": false + }, + { + "name": "score", + "type_name": "BigInt", + "nullable": false, + "list": false + }, + { + "name": "player_dead", + "type_name": "Boolean", + "nullable": false, + "list": false + }, + { + "name": "current_level", + "type_name": "BigInt", + "nullable": false, + "list": false + }, + { + "name": "current_level_completed", + "type_name": "Boolean", + "nullable": false, + "list": false + }, + { + "name": "map_json", + "type_name": "String", + "nullable": false, + "list": false + }, + { + "name": "status", + "type_name": "String", + "nullable": false, + "list": false + } + ] + } + }, + { + "command_name": "blob.move", + "field_name": "blob_games_move", + "roles": [ + "user", + "admin" + ], + "input": { + "name": "BlobMoveInput", + "fields": [ + { + "name": "game_id", + "type_name": "String", + "nullable": false, + "list": false + }, + { + "name": "direction", + "type_name": "String", + "nullable": false, + "list": false + } + ] + }, + "output": { + "name": "BlobGamePayload", + "fields": [ + { + "name": "game_id", + "type_name": "String", + "nullable": false, + "list": false + }, + { + "name": "owner_id", + "type_name": "String", + "nullable": false, + "list": false + }, + { + "name": "score", + "type_name": "BigInt", + "nullable": false, + "list": false + }, + { + "name": "player_dead", + "type_name": "Boolean", + "nullable": false, + "list": false + }, + { + "name": "current_level", + "type_name": "BigInt", + "nullable": false, + "list": false + }, + { + "name": "current_level_completed", + "type_name": "Boolean", + "nullable": false, + "list": false + }, + { + "name": "map_json", + "type_name": "String", + "nullable": false, + "list": false + }, + { + "name": "status", + "type_name": "String", + "nullable": false, + "list": false + } + ] + } + }, + { + "command_name": "blob.start_level", + "field_name": "blob_games_start_level", + "roles": [ + "user", + "admin" + ], + "input": { + "name": "BlobStartLevelInput", + "fields": [ + { + "name": "game_id", + "type_name": "String", + "nullable": false, + "list": false + } + ] + }, + "output": { + "name": "BlobGamePayload", + "fields": [ + { + "name": "game_id", + "type_name": "String", + "nullable": false, + "list": false + }, + { + "name": "owner_id", + "type_name": "String", + "nullable": false, + "list": false + }, + { + "name": "score", + "type_name": "BigInt", + "nullable": false, + "list": false + }, + { + "name": "player_dead", + "type_name": "Boolean", + "nullable": false, + "list": false + }, + { + "name": "current_level", + "type_name": "BigInt", + "nullable": false, + "list": false + }, + { + "name": "current_level_completed", + "type_name": "Boolean", + "nullable": false, + "list": false + }, + { + "name": "map_json", + "type_name": "String", + "nullable": false, + "list": false + }, + { + "name": "status", + "type_name": "String", + "nullable": false, + "list": false + } + ] + } } ] } diff --git a/tests/e2e-ui/ui/src/lib/api/commands.operations.generated.ts b/tests/e2e-ui/ui/src/lib/api/commands.operations.generated.ts index eac34538..f23a2aa3 100644 --- a/tests/e2e-ui/ui/src/lib/api/commands.operations.generated.ts +++ b/tests/e2e-ui/ui/src/lib/api/commands.operations.generated.ts @@ -5,6 +5,19 @@ export type Incremental = T | { [P in keyof T]?: P extends ' $fragmentName' | import type * as Types from '../gql/generated/types'; import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core'; +export type BlobMoveInput = { + direction: string; + game_id: string; +}; + +export type BlobStartInput = { + game_id: string; +}; + +export type BlobStartLevelInput = { + game_id: string; +}; + export type ChatPostInput = { body: string; message_id: string; @@ -86,6 +99,27 @@ export type Command_Chat_Messages_PostMutationVariables = Exact<{ export type Command_Chat_Messages_PostMutation = { chat_messages_post: { message_id: string, room_id: string, author_id: string, body: string, created_at: string } }; +export type Command_Blob_Games_StartMutationVariables = Exact<{ + input: Types.BlobStartInput; +}>; + + +export type Command_Blob_Games_StartMutation = { blob_games_start: { game_id: string, owner_id: string, score: unknown, player_dead: boolean, current_level: unknown, current_level_completed: boolean, map_json: string, status: string } }; + +export type Command_Blob_Games_MoveMutationVariables = Exact<{ + input: Types.BlobMoveInput; +}>; + + +export type Command_Blob_Games_MoveMutation = { blob_games_move: { game_id: string, owner_id: string, score: unknown, player_dead: boolean, current_level: unknown, current_level_completed: boolean, map_json: string, status: string } }; + +export type Command_Blob_Games_Start_LevelMutationVariables = Exact<{ + input: Types.BlobStartLevelInput; +}>; + + +export type Command_Blob_Games_Start_LevelMutation = { blob_games_start_level: { game_id: string, owner_id: string, score: unknown, player_dead: boolean, current_level: unknown, current_level_completed: boolean, map_json: string, status: string } }; + export const Command_Todos_CreateDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Command_todos_create"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"TodoCreateInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todos_create"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todo_id"}},{"kind":"Field","name":{"kind":"Name","value":"owner_id"}},{"kind":"Field","name":{"kind":"Name","value":"title"}},{"kind":"Field","name":{"kind":"Name","value":"status"}}]}}]}}]} as unknown as DocumentNode; export const Command_Todos_CompleteDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Command_todos_complete"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"TodoCompleteInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todos_complete"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todo_id"}},{"kind":"Field","name":{"kind":"Name","value":"status"}}]}}]}}]} as unknown as DocumentNode; @@ -93,4 +127,7 @@ export const Command_Todos_ArchiveDocument = {"kind":"Document","definitions":[{ export const Command_Todos_Force_ArchiveDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Command_todos_force_archive"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"TodoForceArchiveInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todos_force_archive"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todo_id"}},{"kind":"Field","name":{"kind":"Name","value":"owner_id"}},{"kind":"Field","name":{"kind":"Name","value":"status"}},{"kind":"Field","name":{"kind":"Name","value":"archived_by"}}]}}]}}]} as unknown as DocumentNode; export const Command_Todos_RenameDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Command_todos_rename"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"TodoRenameInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todos_rename"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todo_id"}},{"kind":"Field","name":{"kind":"Name","value":"title"}},{"kind":"Field","name":{"kind":"Name","value":"status"}}]}}]}}]} as unknown as DocumentNode; export const Command_Todos_ReopenDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Command_todos_reopen"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"TodoReopenInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todos_reopen"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todo_id"}},{"kind":"Field","name":{"kind":"Name","value":"status"}}]}}]}}]} as unknown as DocumentNode; -export const Command_Chat_Messages_PostDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Command_chat_messages_post"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"ChatPostInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"chat_messages_post"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"message_id"}},{"kind":"Field","name":{"kind":"Name","value":"room_id"}},{"kind":"Field","name":{"kind":"Name","value":"author_id"}},{"kind":"Field","name":{"kind":"Name","value":"body"}},{"kind":"Field","name":{"kind":"Name","value":"created_at"}}]}}]}}]} as unknown as DocumentNode; \ No newline at end of file +export const Command_Chat_Messages_PostDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Command_chat_messages_post"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"ChatPostInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"chat_messages_post"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"message_id"}},{"kind":"Field","name":{"kind":"Name","value":"room_id"}},{"kind":"Field","name":{"kind":"Name","value":"author_id"}},{"kind":"Field","name":{"kind":"Name","value":"body"}},{"kind":"Field","name":{"kind":"Name","value":"created_at"}}]}}]}}]} as unknown as DocumentNode; +export const Command_Blob_Games_StartDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Command_blob_games_start"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"BlobStartInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"blob_games_start"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"game_id"}},{"kind":"Field","name":{"kind":"Name","value":"owner_id"}},{"kind":"Field","name":{"kind":"Name","value":"score"}},{"kind":"Field","name":{"kind":"Name","value":"player_dead"}},{"kind":"Field","name":{"kind":"Name","value":"current_level"}},{"kind":"Field","name":{"kind":"Name","value":"current_level_completed"}},{"kind":"Field","name":{"kind":"Name","value":"map_json"}},{"kind":"Field","name":{"kind":"Name","value":"status"}}]}}]}}]} as unknown as DocumentNode; +export const Command_Blob_Games_MoveDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Command_blob_games_move"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"BlobMoveInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"blob_games_move"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"game_id"}},{"kind":"Field","name":{"kind":"Name","value":"owner_id"}},{"kind":"Field","name":{"kind":"Name","value":"score"}},{"kind":"Field","name":{"kind":"Name","value":"player_dead"}},{"kind":"Field","name":{"kind":"Name","value":"current_level"}},{"kind":"Field","name":{"kind":"Name","value":"current_level_completed"}},{"kind":"Field","name":{"kind":"Name","value":"map_json"}},{"kind":"Field","name":{"kind":"Name","value":"status"}}]}}]}}]} as unknown as DocumentNode; +export const Command_Blob_Games_Start_LevelDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Command_blob_games_start_level"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"BlobStartLevelInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"blob_games_start_level"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"game_id"}},{"kind":"Field","name":{"kind":"Name","value":"owner_id"}},{"kind":"Field","name":{"kind":"Name","value":"score"}},{"kind":"Field","name":{"kind":"Name","value":"player_dead"}},{"kind":"Field","name":{"kind":"Name","value":"current_level"}},{"kind":"Field","name":{"kind":"Name","value":"current_level_completed"}},{"kind":"Field","name":{"kind":"Name","value":"map_json"}},{"kind":"Field","name":{"kind":"Name","value":"status"}}]}}]}}]} as unknown as DocumentNode; \ No newline at end of file diff --git a/tests/e2e-ui/ui/src/lib/api/commands.operations.gql b/tests/e2e-ui/ui/src/lib/api/commands.operations.gql index c3a24bb5..6ad3d0ee 100644 --- a/tests/e2e-ui/ui/src/lib/api/commands.operations.gql +++ b/tests/e2e-ui/ui/src/lib/api/commands.operations.gql @@ -67,3 +67,45 @@ mutation Command_chat_messages_post($input: ChatPostInput!) { created_at } } + +# blob.start — roles: user, admin +mutation Command_blob_games_start($input: BlobStartInput!) { + blob_games_start(input: $input) { + game_id + owner_id + score + player_dead + current_level + current_level_completed + map_json + status + } +} + +# blob.move — roles: user, admin +mutation Command_blob_games_move($input: BlobMoveInput!) { + blob_games_move(input: $input) { + game_id + owner_id + score + player_dead + current_level + current_level_completed + map_json + status + } +} + +# blob.start_level — roles: user, admin +mutation Command_blob_games_start_level($input: BlobStartLevelInput!) { + blob_games_start_level(input: $input) { + game_id + owner_id + score + player_dead + current_level + current_level_completed + map_json + status + } +} diff --git a/tests/e2e-ui/ui/src/lib/components/shared/header/Auth.svelte b/tests/e2e-ui/ui/src/lib/components/shared/header/Auth.svelte index 64bf2526..643bb027 100644 --- a/tests/e2e-ui/ui/src/lib/components/shared/header/Auth.svelte +++ b/tests/e2e-ui/ui/src/lib/components/shared/header/Auth.svelte @@ -13,8 +13,9 @@ const isAuthenticated = $derived(!!page.data.session?.user); const user = $derived(page.data.session?.user); + // /login starts Auth.js OIDC then shows our password form (Login V2 custom base URI). const signInHref = $derived( - `/signin?callbackUrl=${encodeURIComponent(page.url.pathname + (browser ? page.url.search : ''))}` + `/login?callbackUrl=${encodeURIComponent(page.url.pathname + (browser ? page.url.search : ''))}` ); const toggleMenu = () => { diff --git a/tests/e2e-ui/ui/src/lib/components/shared/header/Navbar.svelte b/tests/e2e-ui/ui/src/lib/components/shared/header/Navbar.svelte index 30259d14..1c34cf00 100644 --- a/tests/e2e-ui/ui/src/lib/components/shared/header/Navbar.svelte +++ b/tests/e2e-ui/ui/src/lib/components/shared/header/Navbar.svelte @@ -68,6 +68,12 @@ class:active={isActive('/todos')} onclick={() => (isMenuOpen = false)}>Todos + (isMenuOpen = false)}>Blob Promise>; + blobGamesStart: ( + input: BlobStartInput, + opts?: CommandCallOptions + ) => Promise>; + blobGamesMove: ( + input: BlobMoveInput, + opts?: CommandCallOptions + ) => Promise>; + blobGamesStartLevel: ( + input: BlobStartLevelInput, + opts?: CommandCallOptions + ) => Promise>; }; type FieldName = keyof typeof COMMAND_DOCS; @@ -82,7 +98,10 @@ const FN_TO_FIELD: Record = { todosForceArchive: 'todos_force_archive', todosRename: 'todos_rename', todosReopen: 'todos_reopen', - chatMessagesPost: 'chat_messages_post' + chatMessagesPost: 'chat_messages_post', + blobGamesStart: 'blob_games_start', + blobGamesMove: 'blob_games_move', + blobGamesStartLevel: 'blob_games_start_level' }; function isBrowser(): boolean { @@ -123,7 +142,10 @@ export function bindCommandsPipeline( todosForceArchive: (input, _opts?) => plain.todosForceArchive(input), todosRename: (input, _opts?) => plain.todosRename(input), todosReopen: (input, _opts?) => plain.todosReopen(input), - chatMessagesPost: (input, _opts?) => plain.chatMessagesPost(input) + chatMessagesPost: (input, _opts?) => plain.chatMessagesPost(input), + blobGamesStart: (input, _opts?) => plain.blobGamesStart(input), + blobGamesMove: (input, _opts?) => plain.blobGamesMove(input), + blobGamesStartLevel: (input, _opts?) => plain.blobGamesStartLevel(input) }; } @@ -180,6 +202,9 @@ export function bindCommandsPipeline( todosForceArchive: wrap('todosForceArchive'), todosRename: wrap('todosRename'), todosReopen: wrap('todosReopen'), - chatMessagesPost: wrap('chatMessagesPost') + chatMessagesPost: wrap('chatMessagesPost'), + blobGamesStart: wrap('blobGamesStart'), + blobGamesMove: wrap('blobGamesMove'), + blobGamesStartLevel: wrap('blobGamesStartLevel') }; } diff --git a/tests/e2e-ui/ui/src/lib/gql/generated/types.ts b/tests/e2e-ui/ui/src/lib/gql/generated/types.ts index 7ca2ac7c..da034c8a 100644 --- a/tests/e2e-ui/ui/src/lib/gql/generated/types.ts +++ b/tests/e2e-ui/ui/src/lib/gql/generated/types.ts @@ -13,8 +13,100 @@ export type Scalars = { Timestamptz: { input: unknown; output: unknown; } }; +export type AuthUserView = { + __typename?: 'AuthUserView'; + approval_status: Scalars['String']['output']; + blob_games: Array; + chat_messages: Array; + display_name: Scalars['String']['output']; + email: Scalars['String']['output']; + status: Scalars['String']['output']; + updated_at: Scalars['String']['output']; + user_id: Scalars['String']['output']; + user_kind: Scalars['String']['output']; +}; + + +export type AuthUserViewBlob_GamesArgs = { + limit?: InputMaybe; + offset?: InputMaybe; + order_by?: InputMaybe>; + where?: InputMaybe; +}; + + +export type AuthUserViewChat_MessagesArgs = { + limit?: InputMaybe; + offset?: InputMaybe; + order_by?: InputMaybe>; + where?: InputMaybe; +}; + +export type BigInt_Comparison_Exp = { + _eq?: InputMaybe; + _gt?: InputMaybe; + _gte?: InputMaybe; + _in?: InputMaybe>; + _is_null?: InputMaybe; + _lt?: InputMaybe; + _lte?: InputMaybe; + _neq?: InputMaybe; + _nin?: InputMaybe>; +}; + +export type BlobGamePayload = { + __typename?: 'BlobGamePayload'; + current_level: Scalars['BigInt']['output']; + current_level_completed: Scalars['Boolean']['output']; + game_id: Scalars['String']['output']; + map_json: Scalars['String']['output']; + owner_id: Scalars['String']['output']; + player_dead: Scalars['Boolean']['output']; + score: Scalars['BigInt']['output']; + status: Scalars['String']['output']; +}; + +export type BlobGameView = { + __typename?: 'BlobGameView'; + current_level: Scalars['BigInt']['output']; + current_level_completed: Scalars['Boolean']['output']; + game_id: Scalars['String']['output']; + map_json: Scalars['String']['output']; + owner?: Maybe; + owner_id: Scalars['String']['output']; + player_dead: Scalars['Boolean']['output']; + score: Scalars['BigInt']['output']; + status: Scalars['String']['output']; +}; + +export type BlobMoveInput = { + direction: Scalars['String']['input']; + game_id: Scalars['String']['input']; +}; + +export type BlobStartInput = { + game_id: Scalars['String']['input']; +}; + +export type BlobStartLevelInput = { + game_id: Scalars['String']['input']; +}; + +export type Boolean_Comparison_Exp = { + _eq?: InputMaybe; + _gt?: InputMaybe; + _gte?: InputMaybe; + _in?: InputMaybe>; + _is_null?: InputMaybe; + _lt?: InputMaybe; + _lte?: InputMaybe; + _neq?: InputMaybe; + _nin?: InputMaybe>; +}; + export type ChatMessageView = { __typename?: 'ChatMessageView'; + author?: Maybe; author_id: Scalars['String']['output']; body: Scalars['String']['output']; created_at: Scalars['String']['output']; @@ -39,6 +131,9 @@ export type ChatPostPayload = { export type Mutation = { __typename?: 'Mutation'; + blob_games_move: BlobGamePayload; + blob_games_start: BlobGamePayload; + blob_games_start_level: BlobGamePayload; chat_messages_post: ChatPostPayload; todos_archive: TodoStatusPayload; todos_complete: TodoStatusPayload; @@ -49,6 +144,21 @@ export type Mutation = { }; +export type MutationBlob_Games_MoveArgs = { + input: BlobMoveInput; +}; + + +export type MutationBlob_Games_StartArgs = { + input: BlobStartInput; +}; + + +export type MutationBlob_Games_Start_LevelArgs = { + input: BlobStartLevelInput; +}; + + export type MutationChat_Messages_PostArgs = { input: ChatPostInput; }; @@ -85,6 +195,10 @@ export type MutationTodos_ReopenArgs = { export type Query = { __typename?: 'Query'; + auth_users: Array; + auth_users_by_pk?: Maybe; + blob_games: Array; + blob_games_by_pk?: Maybe; chat_messages: Array; chat_messages_by_pk?: Maybe; todos: Array; @@ -92,6 +206,32 @@ export type Query = { }; +export type QueryAuth_UsersArgs = { + limit?: InputMaybe; + offset?: InputMaybe; + order_by?: InputMaybe>; + where?: InputMaybe; +}; + + +export type QueryAuth_Users_By_PkArgs = { + user_id: Scalars['String']['input']; +}; + + +export type QueryBlob_GamesArgs = { + limit?: InputMaybe; + offset?: InputMaybe; + order_by?: InputMaybe>; + where?: InputMaybe; +}; + + +export type QueryBlob_Games_By_PkArgs = { + game_id: Scalars['String']['input']; +}; + + export type QueryChat_MessagesArgs = { limit?: InputMaybe; offset?: InputMaybe; @@ -133,11 +273,29 @@ export type String_Comparison_Exp = { export type Subscription = { __typename?: 'Subscription'; + auth_users: Array; + blob_games: Array; chat_messages: Array; todos: Array; }; +export type SubscriptionAuth_UsersArgs = { + limit?: InputMaybe; + offset?: InputMaybe; + order_by?: InputMaybe>; + where?: InputMaybe; +}; + + +export type SubscriptionBlob_GamesArgs = { + limit?: InputMaybe; + offset?: InputMaybe; + order_by?: InputMaybe>; + where?: InputMaybe; +}; + + export type SubscriptionChat_MessagesArgs = { limit?: InputMaybe; offset?: InputMaybe; @@ -216,10 +374,62 @@ export type TodoView = { todo_id: Scalars['String']['output']; }; +export type Auth_Users_Bool_Exp = { + _and?: InputMaybe>; + _not?: InputMaybe; + _or?: InputMaybe>; + approval_status?: InputMaybe; + blob_games?: InputMaybe; + chat_messages?: InputMaybe; + display_name?: InputMaybe; + email?: InputMaybe; + status?: InputMaybe; + updated_at?: InputMaybe; + user_id?: InputMaybe; + user_kind?: InputMaybe; +}; + +export type Auth_Users_Order_By = { + approval_status?: InputMaybe; + display_name?: InputMaybe; + email?: InputMaybe; + status?: InputMaybe; + updated_at?: InputMaybe; + user_id?: InputMaybe; + user_kind?: InputMaybe; +}; + +export type Blob_Games_Bool_Exp = { + _and?: InputMaybe>; + _not?: InputMaybe; + _or?: InputMaybe>; + current_level?: InputMaybe; + current_level_completed?: InputMaybe; + game_id?: InputMaybe; + map_json?: InputMaybe; + owner?: InputMaybe; + owner_id?: InputMaybe; + player_dead?: InputMaybe; + score?: InputMaybe; + status?: InputMaybe; +}; + +export type Blob_Games_Order_By = { + current_level?: InputMaybe; + current_level_completed?: InputMaybe; + game_id?: InputMaybe; + map_json?: InputMaybe; + owner_id?: InputMaybe; + player_dead?: InputMaybe; + score?: InputMaybe; + status?: InputMaybe; +}; + export type Chat_Messages_Bool_Exp = { _and?: InputMaybe>; _not?: InputMaybe; _or?: InputMaybe>; + author?: InputMaybe; author_id?: InputMaybe; body?: InputMaybe; created_at?: InputMaybe; diff --git a/tests/e2e-ui/ui/src/lib/server/oidc-start.ts b/tests/e2e-ui/ui/src/lib/server/oidc-start.ts index acd32545..6b9b2d09 100644 --- a/tests/e2e-ui/ui/src/lib/server/oidc-start.ts +++ b/tests/e2e-ui/ui/src/lib/server/oidc-start.ts @@ -1,9 +1,12 @@ /** - * Shared OIDC start for /signin and /signup. + * Shared OIDC start for /login, /signin, /signup. * Probes the IdP before Auth.js so we never bounce to `/?error=Configuration` * with no explanation (common when Zitadel / Docker is down). + * + * Uses `redirect()` (throws) so it works from page `load`, form actions, and + * +server handlers. Returning a raw Response from `load` is invalid in SvelteKit. */ -import { error } from '@sveltejs/kit'; +import { error, redirect } from '@sveltejs/kit'; import { env } from '$env/dynamic/private'; import { cleanEnvValue } from '$lib/clean-env'; @@ -65,7 +68,7 @@ export async function assertOidcReady(): Promise { export async function startOidcSignIn( event: { fetch: typeof fetch; url: URL }, label: 'sign-in' | 'sign-up' = 'sign-in' -): Promise { +): Promise { await assertOidcReady(); const callbackUrl = safeCallbackUrl(event.url); @@ -86,8 +89,6 @@ export async function startOidcSignIn( ); } - return new Response(null, { - status: 302, - headers: { location: payload.url } - }); + // Throws — valid from load / actions / +server + redirect(302, payload.url); } diff --git a/tests/e2e-ui/ui/src/lib/server/zitadel-session.ts b/tests/e2e-ui/ui/src/lib/server/zitadel-session.ts new file mode 100644 index 00000000..726a8c3c --- /dev/null +++ b/tests/e2e-ui/ui/src/lib/server/zitadel-session.ts @@ -0,0 +1,271 @@ +/** + * Zitadel Login V2 helpers for custom auth pages. + * + * Auth.js still starts OIDC (PKCE). After authorize, Zitadel redirects to our + * /login?authRequest=V2_… We authenticate via Session API v2, then + * CreateCallback to get the OIDC code URL back to Auth.js. + * + * Requires server-only ZITADEL_SERVICE_USER_TOKEN (IAM_LOGIN_CLIENT PAT from make up). + */ +import { env } from '$env/dynamic/private'; +import { cleanEnvValue } from '$lib/clean-env'; + +export class ZitadelAuthError extends Error { + constructor( + message: string, + public readonly status = 400, + public readonly code?: string + ) { + super(message); + this.name = 'ZitadelAuthError'; + } +} + +function issuer(): string { + const raw = + cleanEnvValue(env.OIDC_ISSUER) || + cleanEnvValue(env.ZITADEL_ISSUER) || + ''; + return raw.replace(/\/+$/, ''); +} + +function serviceToken(): string { + return ( + cleanEnvValue(env.ZITADEL_SERVICE_USER_TOKEN) || + cleanEnvValue(env.ZITADEL_LOGIN_CLIENT_TOKEN) || + '' + ); +} + +function projectId(): string { + return cleanEnvValue(env.OIDC_AUDIENCE) || cleanEnvValue(env.ZITADEL_PROJECT_ID) || ''; +} + +export function assertLoginClientConfigured(): void { + if (!issuer()) { + throw new ZitadelAuthError( + 'OIDC_ISSUER is not set. Run make up and source e2e-ui.env.', + 503 + ); + } + if (!serviceToken()) { + throw new ZitadelAuthError( + 'ZITADEL_SERVICE_USER_TOKEN missing. Re-run make up (writes login-client PAT) and restart the UI.', + 503 + ); + } +} + +async function zitadelFetch( + path: string, + init: RequestInit & { method?: string } = {} +): Promise<{ ok: boolean; status: number; body: Record }> { + const base = issuer(); + const token = serviceToken(); + const res = await fetch(`${base}${path}`, { + ...init, + headers: { + Authorization: `Bearer ${token}`, + 'Content-Type': 'application/json', + Accept: 'application/json', + ...(init.headers ?? {}) + }, + signal: AbortSignal.timeout(12_000) + }); + const text = await res.text(); + let body: Record = {}; + if (text) { + try { + body = JSON.parse(text) as Record; + } catch { + body = { message: text.slice(0, 400) }; + } + } + return { ok: res.ok, status: res.status, body }; +} + +function apiErrorMessage(body: Record, fallback: string): string { + const msg = body.message ?? body.error_description ?? body.error; + if (typeof msg === 'string' && msg.trim()) return msg.trim(); + return fallback; +} + +export type PasswordSession = { + sessionId: string; + sessionToken: string; +}; + +/** Create a Zitadel session with login name + password checks (Session API v2). */ +export async function createPasswordSession( + loginName: string, + password: string +): Promise { + assertLoginClientConfigured(); + const name = loginName.trim(); + if (!name || !password) { + throw new ZitadelAuthError('Username and password are required.'); + } + + const { ok, status, body } = await zitadelFetch('/v2/sessions', { + method: 'POST', + body: JSON.stringify({ + checks: { + user: { loginName: name }, + password: { password } + } + }) + }); + + if (!ok) { + // Wrong password / unknown user often 400 or 404 + const hint = + status === 404 || status === 400 + ? 'Invalid username or password.' + : apiErrorMessage(body, `Sign-in failed (HTTP ${status}).`); + throw new ZitadelAuthError(hint, status === 401 || status === 403 ? status : 400); + } + + const sessionId = body.sessionId; + const sessionToken = body.sessionToken; + if (typeof sessionId !== 'string' || typeof sessionToken !== 'string') { + throw new ZitadelAuthError('Session response missing id/token.', 502); + } + return { sessionId, sessionToken }; +} + +/** + * Finalize OIDC auth request with the session → callback URL including code + * for Auth.js (/auth/callback/oidc?code=…&state=…). + */ +export async function finalizeAuthRequest( + authRequestId: string, + session: PasswordSession +): Promise { + assertLoginClientConfigured(); + const id = authRequestId.trim(); + if (!id) { + throw new ZitadelAuthError('Missing authRequest. Start sign-in again.'); + } + + const { ok, status, body } = await zitadelFetch( + `/v2/oidc/auth_requests/${encodeURIComponent(id)}`, + { + method: 'POST', + body: JSON.stringify({ + session: { + sessionId: session.sessionId, + sessionToken: session.sessionToken + } + }) + } + ); + + if (!ok) { + throw new ZitadelAuthError( + apiErrorMessage(body, `Could not complete sign-in (HTTP ${status}).`), + status >= 500 ? 502 : 400 + ); + } + + const callbackUrl = body.callbackUrl; + if (typeof callbackUrl !== 'string' || !callbackUrl) { + throw new ZitadelAuthError('OIDC callback URL missing from Zitadel response.', 502); + } + return callbackUrl; +} + +export type RegisterInput = { + username: string; + email: string; + password: string; + givenName?: string; + familyName?: string; +}; + +/** Create a human user (User v2) and grant the project `user` role. */ +export async function registerHuman(input: RegisterInput): Promise<{ userId: string }> { + assertLoginClientConfigured(); + const username = input.username.trim(); + const email = input.email.trim(); + const password = input.password; + if (!username || !email || !password) { + throw new ZitadelAuthError('Username, email, and password are required.'); + } + if (password.length < 8) { + throw new ZitadelAuthError('Password must be at least 8 characters.'); + } + + const given = (input.givenName?.trim() || username).slice(0, 200); + const family = (input.familyName?.trim() || 'User').slice(0, 200); + + const create = await zitadelFetch('/v2/users/human', { + method: 'POST', + body: JSON.stringify({ + username, + profile: { + givenName: given, + familyName: family, + displayName: username + }, + email: { + email, + isVerified: true + }, + password: { + password, + changeRequired: false + } + }) + }); + + if (!create.ok) { + const msg = apiErrorMessage(create.body, `Registration failed (HTTP ${create.status}).`); + // Duplicate username/email + throw new ZitadelAuthError(msg, create.status === 409 ? 409 : 400); + } + + const userId = create.body.userId; + if (typeof userId !== 'string' || !userId) { + throw new ZitadelAuthError('Registration response missing userId.', 502); + } + + const pid = projectId(); + if (pid) { + const grant = await zitadelFetch(`/management/v1/users/${userId}/grants`, { + method: 'POST', + body: JSON.stringify({ + projectId: pid, + roleKeys: ['user'] + }) + }); + // 409 already granted is fine; other errors are soft (user can still log in) + if (!grant.ok && grant.status !== 409) { + console.warn( + '[zitadel-session] project grant failed', + grant.status, + apiErrorMessage(grant.body, '') + ); + } + } + + return { userId }; +} + +/** Password login + OIDC finalize in one step. */ +export async function loginWithPassword( + authRequestId: string, + loginName: string, + password: string +): Promise { + const session = await createPasswordSession(loginName, password); + return finalizeAuthRequest(authRequestId, session); +} + +/** Register, then password-login into the pending auth request. */ +export async function registerAndLogin( + authRequestId: string, + input: RegisterInput +): Promise { + await registerHuman(input); + return loginWithPassword(authRequestId, input.username, input.password); +} diff --git a/tests/e2e-ui/ui/src/lib/session.ts b/tests/e2e-ui/ui/src/lib/session.ts index 3ac0301d..b10db9dc 100644 --- a/tests/e2e-ui/ui/src/lib/session.ts +++ b/tests/e2e-ui/ui/src/lib/session.ts @@ -7,6 +7,7 @@ type SessionLike = { name?: string | null; email?: string | null; } | null; + accessToken?: string | null; } | null; /** Display label for UI chrome (username → name → email → fallback). */ @@ -15,3 +16,52 @@ export function sessionDisplayName(session: SessionLike, fallback = 'you'): stri session?.user?.username ?? session?.user?.name ?? session?.user?.email ?? fallback ); } + +/** + * Decode JWT `sub` without verification (UI identity only). + * Prefer this over `session.user.id` when matching server `author_id` / + * `owner_id` — commands use the access-token principal, which can diverge + * from Auth.js `token.sub` after refresh or IdP claim quirks. + */ +export function accessTokenSub(accessToken: string | null | undefined): string | null { + if (!accessToken) return null; + const parts = accessToken.split('.'); + if (parts.length < 2) return null; + try { + const b64 = parts[1].replace(/-/g, '+').replace(/_/g, '/'); + const pad = b64.length % 4 === 0 ? '' : '='.repeat(4 - (b64.length % 4)); + const json = JSON.parse(atob(b64 + pad)) as { sub?: unknown }; + return typeof json.sub === 'string' && json.sub.length > 0 ? json.sub : null; + } catch { + return null; + } +} + +/** Principal id used for “is this message mine?” (access token sub → session id). */ +export function sessionPrincipalId( + session: SessionLike, + accessToken?: string | null +): string { + return ( + accessTokenSub(accessToken ?? session?.accessToken) ?? + session?.user?.id?.trim() ?? + '' + ); +} + +/** True when a message/game row belongs to the signed-in principal. */ +export function isOwnAuthor( + authorId: string | null | undefined, + principalId: string, + opts?: { authorUserId?: string | null; username?: string | null; displayName?: string | null } +): boolean { + const me = principalId.trim(); + if (!me) return false; + if (authorId && authorId === me) return true; + if (opts?.authorUserId && opts.authorUserId === me) return true; + // Soft match: joined display name equals preferred_username (scrape / IdP label). + const uname = opts?.username?.trim().toLowerCase(); + const label = opts?.displayName?.trim().toLowerCase(); + if (uname && label && uname === label) return true; + return false; +} diff --git a/tests/e2e-ui/ui/src/routes/+page.svelte b/tests/e2e-ui/ui/src/routes/+page.svelte index 7ebaeeca..18a35f7f 100644 --- a/tests/e2e-ui/ui/src/routes/+page.svelte +++ b/tests/e2e-ui/ui/src/routes/+page.svelte @@ -52,9 +52,9 @@ }> = [ { n: '01', - title: 'Login via Zitadel — session holds the access token', - why: 'Auth.js completes OIDC (PKCE) against Zitadel and stores tokens in an encrypted, httpOnly session cookie. The access token is available to SSR and form actions without putting secrets in localStorage or the page HTML.', - path: 'ui/src/auth.ts · GET /signin → /auth/signin/oidc', + title: 'Login via custom pages + Zitadel — session holds the access token', + why: 'Auth.js starts OIDC (PKCE); Zitadel redirects to our /login form; Session API + CreateCallback return the code; Auth.js stores tokens in an encrypted httpOnly cookie for SSR and GraphQL.', + path: 'ui/src/routes/login · auth.ts · Session API v2', label: 'Auth session', blocks: [ { diff --git a/tests/e2e-ui/ui/src/routes/blob/+page.server.ts b/tests/e2e-ui/ui/src/routes/blob/+page.server.ts new file mode 100644 index 00000000..292b0fd1 --- /dev/null +++ b/tests/e2e-ui/ui/src/routes/blob/+page.server.ts @@ -0,0 +1,14 @@ +import { loadQuery } from '$lib/gql/load-query.server'; +import { blobGames } from './blob.resource'; +import type { BlobGamesQueryData } from './blob.resource'; + +/** + * SSR seed — auth gate is hooks.server.ts (redirects unauthenticated to /login). + * Same pattern as todos: loadQuery always returns session + games for the binder. + */ +export const load = loadQuery( + blobGames.query, + (data) => ({ + games: data?.blob_games ?? [] + }) +); diff --git a/tests/e2e-ui/ui/src/routes/blob/+page.svelte b/tests/e2e-ui/ui/src/routes/blob/+page.svelte new file mode 100644 index 00000000..ca3a0c35 --- /dev/null +++ b/tests/e2e-ui/ui/src/routes/blob/+page.svelte @@ -0,0 +1,808 @@ + + + + Blob Game · e2e-ui + + +
+
+
+ + Optimistic UI · command returns RM row +
+
+
+

Blob Game

+

+ Board updates instantly (optimistic). The command upserts blob_games and + returns that row so we reconcile without waiting on projectors. +

+
+ +
+
+ + {#if data.gqlError} + + {/if} + {#if actionError} + + {/if} + + {#if !hasBoard} +
+ +

+ Start a game, then move with arrows / WASD — paint is optimistic, server confirms via + command payload. +

+ +
+ {:else} +
+
+
+ Score + {score} +
+
+ Level + {currentLevel} +
+
+ Status + {status} +
+ {#if playerDead} + You died — start a new game + {:else if levelComplete} + Level complete + + {/if} +
+ +
+ {#each board as row, r} + {#each row as cell, c} +
+ {tileLabel(cell)} +
+ {/each} + {/each} +
+ + + +
+ +
+ + + +
+
+ +
+ {/if} + + {#if games.length > 1} +
+

Your games

+
    + {#each games as g (g.game_id)} +
  • + +
    • + {/each} +
+
+ {/if} +
+ + diff --git a/tests/e2e-ui/ui/src/routes/blob/blob.generated.ts b/tests/e2e-ui/ui/src/routes/blob/blob.generated.ts new file mode 100644 index 00000000..c75c8562 --- /dev/null +++ b/tests/e2e-ui/ui/src/routes/blob/blob.generated.ts @@ -0,0 +1,14 @@ +/** Internal type. DO NOT USE DIRECTLY. */ +type Exact = { [K in keyof T]: T[K] }; +/** Internal type. DO NOT USE DIRECTLY. */ +export type Incremental = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never }; +import type * as Types from '../../lib/gql/generated/types'; + +import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core'; +export type BlobGamesQueryVariables = Exact<{ [key: string]: never; }>; + + +export type BlobGamesQuery = { blob_games: Array<{ game_id: string, owner_id: string, score: unknown, player_dead: boolean, current_level: unknown, current_level_completed: boolean, map_json: string, status: string, owner: { user_id: string, display_name: string, email: string, status: string } | null }> }; + + +export const BlobGamesDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"BlobGames"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"blob_games"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"game_id"}},{"kind":"Field","name":{"kind":"Name","value":"owner_id"}},{"kind":"Field","name":{"kind":"Name","value":"score"}},{"kind":"Field","name":{"kind":"Name","value":"player_dead"}},{"kind":"Field","name":{"kind":"Name","value":"current_level"}},{"kind":"Field","name":{"kind":"Name","value":"current_level_completed"}},{"kind":"Field","name":{"kind":"Name","value":"map_json"}},{"kind":"Field","name":{"kind":"Name","value":"status"}},{"kind":"Field","name":{"kind":"Name","value":"owner"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"user_id"}},{"kind":"Field","name":{"kind":"Name","value":"display_name"}},{"kind":"Field","name":{"kind":"Name","value":"email"}},{"kind":"Field","name":{"kind":"Name","value":"status"}}]}}]}}]}}]} as unknown as DocumentNode; \ No newline at end of file diff --git a/tests/e2e-ui/ui/src/routes/blob/blob.gql b/tests/e2e-ui/ui/src/routes/blob/blob.gql new file mode 100644 index 00000000..a4575118 --- /dev/null +++ b/tests/e2e-ui/ui/src/routes/blob/blob.gql @@ -0,0 +1,19 @@ +# Blob games — joins `owner` from imported auth_users (Zitadel ingestor). +query BlobGames { + blob_games { + game_id + owner_id + score + player_dead + current_level + current_level_completed + map_json + status + owner { + user_id + display_name + email + status + } + } +} diff --git a/tests/e2e-ui/ui/src/routes/blob/blob.resource.ts b/tests/e2e-ui/ui/src/routes/blob/blob.resource.ts new file mode 100644 index 00000000..58903f06 --- /dev/null +++ b/tests/e2e-ui/ui/src/routes/blob/blob.resource.ts @@ -0,0 +1,10 @@ +import { defineResource } from '$lib/gql/define-resource'; +import { BlobGamesDocument, type BlobGamesQuery } from './blob.generated'; + +export type BlobGameRow = BlobGamesQuery['blob_games'][number]; +export type BlobGamesQueryData = BlobGamesQuery; + +export const blobGames = defineResource({ + query: BlobGamesDocument, + select: (data) => data.blob_games +}); diff --git a/tests/e2e-ui/ui/src/routes/chat/+page.svelte b/tests/e2e-ui/ui/src/routes/chat/+page.svelte index a8340585..a9a087c0 100644 --- a/tests/e2e-ui/ui/src/routes/chat/+page.svelte +++ b/tests/e2e-ui/ui/src/routes/chat/+page.svelte @@ -6,7 +6,7 @@ */ import { onDestroy, tick } from 'svelte'; import { useGraphql, fx } from '$lib/gql'; - import { sessionDisplayName } from '$lib/session'; + import { isOwnAuthor, sessionDisplayName, sessionPrincipalId } from '$lib/session'; import { chat, sortChatMessages } from './chat.resource'; import type { ChatMsg } from './chat.resource'; @@ -16,7 +16,10 @@ let draft = $state(''); let busy = $state(false); - const me = $derived(data.session?.user?.id ?? ''); + /** Same principal the API stamps as author_id (access-token sub). */ + const me = $derived( + sessionPrincipalId(data.session, data.accessToken ?? data.session?.accessToken) + ); const displayName = $derived(sessionDisplayName(data.session)); const gql = useGraphql(() => data, { @@ -61,14 +64,21 @@ return id.slice(0, 6) + '…'; } - function formatWhen(iso: string) { - try { - const d = new Date(iso); - if (Number.isNaN(d.getTime())) return iso; - return d.toLocaleTimeString(undefined, { hour: '2-digit', minute: '2-digit' }); - } catch { - return iso; - } + function formatWhen(raw: string) { + if (!raw) return ''; + // Server may emit unix millis as a decimal string (no chrono in fixture). + const asNum = /^\d{11,16}$/.test(raw.trim()) ? Number(raw) : NaN; + const d = Number.isFinite(asNum) ? new Date(asNum) : new Date(raw); + if (Number.isNaN(d.getTime())) return raw; + return d.toLocaleTimeString(undefined, { hour: '2-digit', minute: '2-digit' }); + } + + function messageIsMine(m: ChatMsg): boolean { + return isOwnAuthor(m.author_id, me, { + authorUserId: m.author?.user_id, + username: data.session?.user?.username, + displayName: m.author?.display_name + }); } async function onSend(e: Event) { @@ -83,7 +93,14 @@ room_id: data.room, author_id: me || 'me', body, - created_at: new Date().toISOString() + created_at: new Date().toISOString(), + // Join target filled by server when auth_users has this user_id. + author: { + user_id: me || 'me', + display_name: displayName || 'You', + email: '', + status: 'active' + } }; const result = await gql.commands.chatMessagesPost( { message_id, body, room_id: data.room }, @@ -161,10 +178,13 @@

{:else} {#each $lobby.data as m, i (m.message_id)} - {@const mine = me && m.author_id === me} + {@const mine = messageIsMine(m)} + {@const authorLabel = mine + ? 'You' + : m.author?.display_name || m.author?.email || shortId(m.author_id)}
- {mine ? 'You' : shortId(m.author_id)} + {authorLabel}

{m.body}

diff --git a/tests/e2e-ui/ui/src/routes/chat/chat.generated.ts b/tests/e2e-ui/ui/src/routes/chat/chat.generated.ts index cdc2b02c..7d4523e8 100644 --- a/tests/e2e-ui/ui/src/routes/chat/chat.generated.ts +++ b/tests/e2e-ui/ui/src/routes/chat/chat.generated.ts @@ -8,13 +8,13 @@ import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document- export type ChatMessagesQueryVariables = Exact<{ [key: string]: never; }>; -export type ChatMessagesQuery = { chat_messages: Array<{ message_id: string, room_id: string, author_id: string, body: string, created_at: string }> }; +export type ChatMessagesQuery = { chat_messages: Array<{ message_id: string, room_id: string, author_id: string, body: string, created_at: string, author: { user_id: string, display_name: string, email: string, status: string } | null }> }; export type ChatMessagesLiveSubscriptionVariables = Exact<{ [key: string]: never; }>; -export type ChatMessagesLiveSubscription = { chat_messages: Array<{ message_id: string, room_id: string, author_id: string, body: string, created_at: string }> }; +export type ChatMessagesLiveSubscription = { chat_messages: Array<{ message_id: string, room_id: string, author_id: string, body: string, created_at: string, author: { user_id: string, display_name: string, email: string, status: string } | null }> }; -export const ChatMessagesDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"ChatMessages"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"chat_messages"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"where"},"value":{"kind":"ObjectValue","fields":[{"kind":"ObjectField","name":{"kind":"Name","value":"room_id"},"value":{"kind":"ObjectValue","fields":[{"kind":"ObjectField","name":{"kind":"Name","value":"_eq"},"value":{"kind":"StringValue","value":"lobby","block":false}}]}}]}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"message_id"}},{"kind":"Field","name":{"kind":"Name","value":"room_id"}},{"kind":"Field","name":{"kind":"Name","value":"author_id"}},{"kind":"Field","name":{"kind":"Name","value":"body"}},{"kind":"Field","name":{"kind":"Name","value":"created_at"}}]}}]}}]} as unknown as DocumentNode; -export const ChatMessagesLiveDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"subscription","name":{"kind":"Name","value":"ChatMessagesLive"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"chat_messages"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"where"},"value":{"kind":"ObjectValue","fields":[{"kind":"ObjectField","name":{"kind":"Name","value":"room_id"},"value":{"kind":"ObjectValue","fields":[{"kind":"ObjectField","name":{"kind":"Name","value":"_eq"},"value":{"kind":"StringValue","value":"lobby","block":false}}]}}]}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"message_id"}},{"kind":"Field","name":{"kind":"Name","value":"room_id"}},{"kind":"Field","name":{"kind":"Name","value":"author_id"}},{"kind":"Field","name":{"kind":"Name","value":"body"}},{"kind":"Field","name":{"kind":"Name","value":"created_at"}}]}}]}}]} as unknown as DocumentNode; \ No newline at end of file +export const ChatMessagesDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"ChatMessages"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"chat_messages"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"where"},"value":{"kind":"ObjectValue","fields":[{"kind":"ObjectField","name":{"kind":"Name","value":"room_id"},"value":{"kind":"ObjectValue","fields":[{"kind":"ObjectField","name":{"kind":"Name","value":"_eq"},"value":{"kind":"StringValue","value":"lobby","block":false}}]}}]}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"message_id"}},{"kind":"Field","name":{"kind":"Name","value":"room_id"}},{"kind":"Field","name":{"kind":"Name","value":"author_id"}},{"kind":"Field","name":{"kind":"Name","value":"body"}},{"kind":"Field","name":{"kind":"Name","value":"created_at"}},{"kind":"Field","name":{"kind":"Name","value":"author"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"user_id"}},{"kind":"Field","name":{"kind":"Name","value":"display_name"}},{"kind":"Field","name":{"kind":"Name","value":"email"}},{"kind":"Field","name":{"kind":"Name","value":"status"}}]}}]}}]}}]} as unknown as DocumentNode; +export const ChatMessagesLiveDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"subscription","name":{"kind":"Name","value":"ChatMessagesLive"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"chat_messages"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"where"},"value":{"kind":"ObjectValue","fields":[{"kind":"ObjectField","name":{"kind":"Name","value":"room_id"},"value":{"kind":"ObjectValue","fields":[{"kind":"ObjectField","name":{"kind":"Name","value":"_eq"},"value":{"kind":"StringValue","value":"lobby","block":false}}]}}]}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"message_id"}},{"kind":"Field","name":{"kind":"Name","value":"room_id"}},{"kind":"Field","name":{"kind":"Name","value":"author_id"}},{"kind":"Field","name":{"kind":"Name","value":"body"}},{"kind":"Field","name":{"kind":"Name","value":"created_at"}},{"kind":"Field","name":{"kind":"Name","value":"author"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"user_id"}},{"kind":"Field","name":{"kind":"Name","value":"display_name"}},{"kind":"Field","name":{"kind":"Name","value":"email"}},{"kind":"Field","name":{"kind":"Name","value":"status"}}]}}]}}]}}]} as unknown as DocumentNode; \ No newline at end of file diff --git a/tests/e2e-ui/ui/src/routes/chat/chat.gql b/tests/e2e-ui/ui/src/routes/chat/chat.gql index f303aa1d..f07e8baf 100644 --- a/tests/e2e-ui/ui/src/routes/chat/chat.gql +++ b/tests/e2e-ui/ui/src/routes/chat/chat.gql @@ -2,6 +2,7 @@ # Room filter is fixed to lobby for the e2e-ui page; variables can expand later. # Post mutation: `$lib/api/commands.operations.gql` (generated). +# Lobby chat — joins `author` from imported auth_users (Zitadel ingestor). query ChatMessages { chat_messages(where: { room_id: { _eq: "lobby" } }) { message_id @@ -9,6 +10,12 @@ query ChatMessages { author_id body created_at + author { + user_id + display_name + email + status + } } } @@ -19,5 +26,11 @@ subscription ChatMessagesLive { author_id body created_at + author { + user_id + display_name + email + status + } } } diff --git a/tests/e2e-ui/ui/src/routes/login/+page.server.ts b/tests/e2e-ui/ui/src/routes/login/+page.server.ts new file mode 100644 index 00000000..f42eb1bf --- /dev/null +++ b/tests/e2e-ui/ui/src/routes/login/+page.server.ts @@ -0,0 +1,56 @@ +import { fail, redirect } from '@sveltejs/kit'; +import type { Actions, PageServerLoad } from './$types'; +import { loginWithPassword, ZitadelAuthError } from '$lib/server/zitadel-session'; +import { startOidcSignIn } from '$lib/server/oidc-start'; + +export const load: PageServerLoad = async (event) => { + const session = await event.locals.auth(); + if (session?.user) { + redirect(303, '/todos'); + } + + const authRequest = event.url.searchParams.get('authRequest')?.trim() ?? ''; + // No pending OIDC auth request → start Auth.js authorize (redirects; lands back with authRequest). + if (!authRequest) { + await startOidcSignIn(event, 'sign-in'); + } + + return { + authRequest, + demoHint: 'Demo: alice / bob / admin · Password1!' + }; +}; + +export const actions: Actions = { + default: async (event) => { + const form = await event.request.formData(); + const authRequest = String(form.get('authRequest') ?? '').trim(); + const loginName = String(form.get('loginName') ?? '').trim(); + const password = String(form.get('password') ?? ''); + + if (!authRequest) { + return fail(400, { + error: 'Sign-in session expired. Click Sign in again.', + loginName + }); + } + if (!loginName || !password) { + return fail(400, { error: 'Username and password are required.', loginName }); + } + + try { + const callbackUrl = await loginWithPassword(authRequest, loginName, password); + redirect(303, callbackUrl); + } catch (e) { + // SvelteKit redirect throws a Response-like object + if (e && typeof e === 'object' && 'status' in e && 'location' in e) { + throw e; + } + const err = e instanceof ZitadelAuthError ? e : null; + return fail(err?.status && err.status < 500 ? err.status : 400, { + error: err?.message ?? 'Sign-in failed. Check credentials and try again.', + loginName + }); + } + } +}; diff --git a/tests/e2e-ui/ui/src/routes/login/+page.svelte b/tests/e2e-ui/ui/src/routes/login/+page.svelte new file mode 100644 index 00000000..54aeef89 --- /dev/null +++ b/tests/e2e-ui/ui/src/routes/login/+page.svelte @@ -0,0 +1,204 @@ + + + + Sign in · e2e-ui + + +
+
+
+ + e2e-ui +
+

Sign in

+

+ Your credentials stay on Fieldnote pages. Zitadel only issues the OIDC tokens after Auth.js + completes the code flow. +

+ + {#if error} + + {/if} + +
+ + + + + + + + + +
+ +

+ Create an account + + Back home +

+ {#if data.demoHint} +

{data.demoHint}

+ {/if} +
+
+ + diff --git a/tests/e2e-ui/ui/src/routes/signin/+server.ts b/tests/e2e-ui/ui/src/routes/signin/+server.ts index 04d082cd..a84594e8 100644 --- a/tests/e2e-ui/ui/src/routes/signin/+server.ts +++ b/tests/e2e-ui/ui/src/routes/signin/+server.ts @@ -1,3 +1,7 @@ +/** + * Legacy entry: start OIDC authorize. Prefer /login (custom Login V2 pages). + * Kept so old links and docs still work. + */ import type { RequestHandler } from './$types'; import { startOidcSignIn } from '$lib/server/oidc-start'; diff --git a/tests/e2e-ui/ui/src/routes/signout/+server.ts b/tests/e2e-ui/ui/src/routes/signout/+server.ts index a49a1f3c..dea12134 100644 --- a/tests/e2e-ui/ui/src/routes/signout/+server.ts +++ b/tests/e2e-ui/ui/src/routes/signout/+server.ts @@ -51,7 +51,10 @@ export const GET: RequestHandler = async (event) => { const endSessionUrl = new URL(logoutEndpoint); if (idToken) endSessionUrl.searchParams.set('id_token_hint', idToken); - endSessionUrl.searchParams.set('post_logout_redirect_uri', event.url.origin); + // Zitadel exact-matches post_logout_redirect_uri against app allowlist + // (bootstrap registers origin + trailing slash, e.g. http://127.0.0.1:5180/). + // event.url.origin has no path/slash — bare origin is rejected as invalid. + endSessionUrl.searchParams.set('post_logout_redirect_uri', `${event.url.origin}/`); redirect(303, endSessionUrl.toString()); }; diff --git a/tests/e2e-ui/ui/src/routes/signup/+page.server.ts b/tests/e2e-ui/ui/src/routes/signup/+page.server.ts new file mode 100644 index 00000000..85362e0e --- /dev/null +++ b/tests/e2e-ui/ui/src/routes/signup/+page.server.ts @@ -0,0 +1,78 @@ +import { fail, redirect } from '@sveltejs/kit'; +import type { Actions, PageServerLoad } from './$types'; +import { + registerAndLogin, + registerHuman, + ZitadelAuthError +} from '$lib/server/zitadel-session'; +import { startOidcSignIn } from '$lib/server/oidc-start'; + +export const load: PageServerLoad = async (event) => { + const session = await event.locals.auth(); + if (session?.user) { + redirect(303, '/todos'); + } + + // Optional: when coming from /login mid-OIDC, preserve authRequest to finalize without a second password entry. + const authRequest = event.url.searchParams.get('authRequest')?.trim() ?? ''; + return { authRequest }; +}; + +export const actions: Actions = { + default: async (event) => { + const form = await event.request.formData(); + const authRequest = String(form.get('authRequest') ?? '').trim(); + const username = String(form.get('username') ?? '').trim(); + const email = String(form.get('email') ?? '').trim(); + const password = String(form.get('password') ?? ''); + const givenName = String(form.get('givenName') ?? '').trim(); + const familyName = String(form.get('familyName') ?? '').trim(); + + const fields = { username, email, givenName, familyName }; + + if (!username || !email || !password) { + return fail(400, { + error: 'Username, email, and password are required.', + ...fields + }); + } + + try { + if (authRequest) { + const callbackUrl = await registerAndLogin(authRequest, { + username, + email, + password, + givenName: givenName || undefined, + familyName: familyName || undefined + }); + redirect(303, callbackUrl); + } + + // Cold signup: create user, then start OIDC → custom /login for password + tokens. + await registerHuman({ + username, + email, + password, + givenName: givenName || undefined, + familyName: familyName || undefined + }); + // Point callback at todos after Auth.js completes. + const url = new URL(event.url); + if (!url.searchParams.get('callbackUrl')) { + url.searchParams.set('callbackUrl', '/todos'); + } + await startOidcSignIn({ fetch: event.fetch, url }, 'sign-up'); + } catch (e) { + // redirect() throws; rethrow so SvelteKit handles it + if (e && typeof e === 'object' && 'status' in e && 'location' in e) { + throw e; + } + const err = e instanceof ZitadelAuthError ? e : null; + return fail(err?.status && err.status < 500 ? err.status : 400, { + error: err?.message ?? 'Could not create account.', + ...fields + }); + } + } +}; diff --git a/tests/e2e-ui/ui/src/routes/signup/+page.svelte b/tests/e2e-ui/ui/src/routes/signup/+page.svelte new file mode 100644 index 00000000..8a205023 --- /dev/null +++ b/tests/e2e-ui/ui/src/routes/signup/+page.svelte @@ -0,0 +1,248 @@ + + + + Create account · e2e-ui + + +
+
+
+ + e2e-ui +
+

Create account

+

+ Register on Fieldnote. Your password is verified via Zitadel Session API; Auth.js still + holds the OIDC session cookie. +

+ + {#if error} + + {/if} + +
+ + + + + + + + +
+
+ + +
+
+ + +
+
+ + + + + +
+ +

+ Already have an account? + + Back home +

+
+
+ + diff --git a/tests/e2e-ui/ui/src/routes/signup/+server.ts b/tests/e2e-ui/ui/src/routes/signup/+server.ts deleted file mode 100644 index c1b90575..00000000 --- a/tests/e2e-ui/ui/src/routes/signup/+server.ts +++ /dev/null @@ -1,11 +0,0 @@ -/** - * Create-account entry. - * - * Requires Zitadel (make up). Bootstrap enables self-registration on the org - * login policy so the hosted login UI shows Register. - * Same OIDC start as /signin — after register, user lands via Auth.js callback. - */ -import type { RequestHandler } from './$types'; -import { startOidcSignIn } from '$lib/server/oidc-start'; - -export const GET: RequestHandler = async (event) => startOidcSignIn(event, 'sign-up'); From f7ce1b14bab6b01f42d82792369a826734d79c3f Mon Sep 17 00:00:00 2001 From: Patrick Lee Scott Date: Sun, 19 Jul 2026 19:27:10 -0500 Subject: [PATCH 13/20] feat(e2e-ui): polish demos, event domains, blob URL routes Teach-first home and cleaned UI across todos/chat/session/admin/blob. Todo/chat use public #[event] command methods; handlers stay thin. Blob moves to [[gameId]] with local board paint so New game updates immediately while history still uses the shared cache. --- src/graphql/commands.rs | 155 ++- src/graphql/mod.rs | 3 +- src/graphql/schema.rs | 16 +- src/graphql/sdl.rs | 14 +- tests/e2e-ui/Makefile | 3 +- .../chat-domain/src/models/chat_message.rs | 73 +- .../service/src/handlers/commands/archive.rs | 3 +- .../src/handlers/commands/chat_post.rs | 14 +- .../service/src/handlers/commands/complete.rs | 3 +- .../service/src/handlers/commands/create.rs | 6 +- .../src/handlers/commands/force_archive.rs | 2 +- .../service/src/handlers/commands/rename.rs | 7 +- .../service/src/handlers/commands/reopen.rs | 3 +- tests/e2e-ui/crates/service/src/service.rs | 39 +- .../crates/todo-domain/src/models/todo.rs | 218 ++- tests/e2e-ui/ui/schema/admin.graphql | 4 +- tests/e2e-ui/ui/schema/user.graphql | 4 +- tests/e2e-ui/ui/scripts/gen-commands.mjs | 56 +- tests/e2e-ui/ui/src/app.css | 333 ++++- .../ui/src/lib/api/commands.manifest.json | 80 ++ .../lib/api/commands.policies.generated.ts | 54 + .../lib/components/shared/ui/Button.svelte | 82 +- .../components/shared/ui/SimplePage.svelte | 29 +- .../e2e-ui/ui/src/lib/gql/command-policies.ts | 44 +- .../e2e-ui/ui/src/lib/gql/generated/types.ts | 4 +- tests/e2e-ui/ui/src/routes/+page.svelte | 1226 +++++++++++++---- .../ui/src/routes/admin/+page.server.ts | 4 +- tests/e2e-ui/ui/src/routes/admin/+page.svelte | 136 +- .../ui/src/routes/admin/admin.generated.ts | 2 +- tests/e2e-ui/ui/src/routes/admin/admin.gql | 3 +- .../ui/src/routes/admin/admin.resource.ts | 25 +- .../blob/{ => [[gameId]]}/+page.server.ts | 0 .../routes/blob/{ => [[gameId]]}/+page.svelte | 204 ++- .../blob/{ => [[gameId]]}/blob.generated.ts | 0 .../src/routes/blob/{ => [[gameId]]}/blob.gql | 0 .../blob/{ => [[gameId]]}/blob.resource.ts | 0 tests/e2e-ui/ui/src/routes/chat/+page.svelte | 172 +-- .../ui/src/routes/chat/chat.generated.ts | 4 +- tests/e2e-ui/ui/src/routes/login/+page.svelte | 5 +- .../e2e-ui/ui/src/routes/session/+page.svelte | 175 ++- .../src/routes/session/TokenInspector.svelte | 132 +- .../e2e-ui/ui/src/routes/signup/+page.svelte | 5 +- .../ui/src/routes/todos/+page.server.ts | 4 +- tests/e2e-ui/ui/src/routes/todos/+page.svelte | 339 +++-- .../ui/src/routes/todos/todos.generated.ts | 2 +- tests/e2e-ui/ui/src/routes/todos/todos.gql | 3 +- .../ui/src/routes/todos/todos.resource.ts | 23 +- tests/e2e-ui/ui/tests/command-client.test.mjs | 30 +- 48 files changed, 2578 insertions(+), 1165 deletions(-) create mode 100644 tests/e2e-ui/ui/src/lib/api/commands.policies.generated.ts rename tests/e2e-ui/ui/src/routes/blob/{ => [[gameId]]}/+page.server.ts (100%) rename tests/e2e-ui/ui/src/routes/blob/{ => [[gameId]]}/+page.svelte (77%) rename tests/e2e-ui/ui/src/routes/blob/{ => [[gameId]]}/blob.generated.ts (100%) rename tests/e2e-ui/ui/src/routes/blob/{ => [[gameId]]}/blob.gql (100%) rename tests/e2e-ui/ui/src/routes/blob/{ => [[gameId]]}/blob.resource.ts (100%) diff --git a/src/graphql/commands.rs b/src/graphql/commands.rs index 9786a0c9..e37e88ae 100644 --- a/src/graphql/commands.rs +++ b/src/graphql/commands.rs @@ -6,11 +6,108 @@ //! [`GraphqlCommands::catalog`] exports a machine-readable registry used by //! TypeScript generators so app code can call `todosCreate(input)` without //! hand-authoring GraphQL mutation documents. GraphQL remains the wire. +//! +//! Optional [`ExposedCommand::client_reconcile`] hints tell generators how the +//! browser command pipeline should treat success payloads (`ack` / `fact` / +//! `projection`) and how to reconcile lists (subscription / none / …). use serde::Serialize; use super::types::{GraphqlInputType, GraphqlOutputType, GraphqlTypeDef, GraphqlTypeField}; +/// How the browser interprets a successful mutation payload. +#[derive(Clone, Copy, Debug, Serialize, PartialEq, Eq)] +#[serde(rename_all = "snake_case")] +pub enum ClientResultKind { + /// Command accepted; payload is not a list row. + Ack, + /// Domain fact fields (id, status, …) — not a full projected row. + Fact, + /// Payload matches the GraphQL/RM row; apply to cache immediately. + Projection, + /// Ignore payload for cache purposes. + None, +} + +/// How the browser refreshes list/query cache after a successful command. +#[derive(Clone, Copy, Debug, Serialize, PartialEq, Eq)] +#[serde(rename_all = "snake_case")] +pub enum ClientReconcileMode { + None, + Subscription, + Refetch, + Invalidate, +} + +/// Client pipeline policy for one command (exported in the command catalog). +#[derive(Clone, Debug, Serialize, PartialEq, Eq)] +pub struct ClientReconcile { + pub result: ClientResultSpec, + pub reconcile: ClientReconcileSpec, +} + +/// Nested `result.kind` shape matching the TS `CommandPolicy` type. +#[derive(Clone, Debug, Serialize, PartialEq, Eq)] +pub struct ClientResultSpec { + pub kind: ClientResultKind, +} + +/// Nested `reconcile.kind` shape matching the TS `CommandPolicy` type. +#[derive(Clone, Debug, Serialize, PartialEq, Eq)] +pub struct ClientReconcileSpec { + pub kind: ClientReconcileMode, +} + +impl ClientReconcile { + /// Async projector topology: fact payload, no immediate refetch. + pub fn fact() -> Self { + Self { + result: ClientResultSpec { + kind: ClientResultKind::Fact, + }, + reconcile: ClientReconcileSpec { + kind: ClientReconcileMode::None, + }, + } + } + + /// Async projector + live subscription owns the list. + pub fn fact_subscription() -> Self { + Self { + result: ClientResultSpec { + kind: ClientResultKind::Fact, + }, + reconcile: ClientReconcileSpec { + kind: ClientReconcileMode::Subscription, + }, + } + } + + /// Same-tx RM write: mutation payload is the projected row. + pub fn projection() -> Self { + Self { + result: ClientResultSpec { + kind: ClientResultKind::Projection, + }, + reconcile: ClientReconcileSpec { + kind: ClientReconcileMode::None, + }, + } + } + + /// Ack-only success (no useful fact fields). + pub fn ack() -> Self { + Self { + result: ClientResultSpec { + kind: ClientResultKind::Ack, + }, + reconcile: ClientReconcileSpec { + kind: ClientReconcileMode::None, + }, + } + } +} + #[derive(Clone, Debug)] pub struct ExposedCommand { pub(crate) command_name: String, @@ -18,6 +115,7 @@ pub struct ExposedCommand { pub(crate) input: CommandInput, pub(crate) output: CommandOutput, pub(crate) roles: Vec, + pub(crate) client_reconcile: Option, } #[derive(Clone, Debug)] @@ -40,6 +138,7 @@ pub fn exposed_command() -> ExposedCommand { input: CommandInput::None, output: CommandOutput::Json, roles: Vec::new(), + client_reconcile: None, } } @@ -69,6 +168,15 @@ impl ExposedCommand { self } + /// Hint for generated TS command policies (result kind + reconcile mode). + /// + /// Omitted from the catalog when unset (backward compatible). Call-site + /// options on the client still win over generated defaults. + pub fn client_reconcile(mut self, policy: ClientReconcile) -> Self { + self.client_reconcile = Some(policy); + self + } + pub(crate) fn resolved_field_name(&self, command_name: &str) -> String { self.field_name.clone().unwrap_or_else(|| { command_name @@ -110,6 +218,9 @@ pub struct CommandCatalogEntry { pub input: Option, #[serde(skip_serializing_if = "Option::is_none")] pub output: Option, + /// Browser pipeline policy (result + reconcile). Omitted when unset. + #[serde(skip_serializing_if = "Option::is_none")] + pub client_reconcile: Option, } /// Versioned command registry export (JSON). @@ -174,6 +285,7 @@ impl GraphqlCommands { roles: cmd.roles.clone(), input, output, + client_reconcile: cmd.client_reconcile.clone(), } }) .collect(); @@ -237,7 +349,8 @@ mod tests { .field_name("todos_create") .input::() .output::() - .roles(["user", "admin"]), + .roles(["user", "admin"]) + .client_reconcile(ClientReconcile::fact()), ) .command( "todo.force_archive", @@ -246,11 +359,20 @@ mod tests { .input::() .output::() .roles(["admin"]), + ) + .command( + "blob.move", + exposed_command() + .field_name("blob_games_move") + .input::() + .output::() + .roles(["user"]) + .client_reconcile(ClientReconcile::projection()), ); let cat = cmds.catalog(); assert_eq!(cat.version, 1); - assert_eq!(cat.commands.len(), 2); + assert_eq!(cat.commands.len(), 3); assert_eq!(cat.commands[0].command_name, "todo.create"); assert_eq!(cat.commands[0].field_name, "todos_create"); assert_eq!(cat.commands[0].roles, vec!["user", "admin"]); @@ -258,11 +380,38 @@ mod tests { cat.commands[0].input.as_ref().unwrap().fields[0].name, "todo_id" ); - assert_eq!(cat.commands[1].roles, vec!["admin"]); + assert_eq!( + cat.commands[0].client_reconcile.as_ref().unwrap().result.kind, + ClientResultKind::Fact + ); + assert!(cat.commands[1].client_reconcile.is_none()); + assert_eq!( + cat.commands[2] + .client_reconcile + .as_ref() + .unwrap() + .result + .kind, + ClientResultKind::Projection + ); let json = cmds.catalog_json_pretty().expect("json"); assert!(json.contains("todos_create")); assert!(json.contains("\"admin\"")); assert!(json.contains("todo_id")); + assert!(json.contains("client_reconcile")); + assert!(json.contains("\"projection\"")); + // Unset policy omitted (backward compatible). + assert!(!json.contains("todos_force_archive") || { + // force_archive entry must not carry client_reconcile + let v: serde_json::Value = serde_json::from_str(&json).unwrap(); + let force = v["commands"] + .as_array() + .unwrap() + .iter() + .find(|c| c["field_name"] == "todos_force_archive") + .unwrap(); + force.get("client_reconcile").is_none() + }); } } diff --git a/src/graphql/mod.rs b/src/graphql/mod.rs index c6c27dbb..f4086b38 100644 --- a/src/graphql/mod.rs +++ b/src/graphql/mod.rs @@ -54,7 +54,8 @@ mod types; #[cfg(feature = "graphql")] pub use commands::{ - exposed_command, CommandCatalog, CommandCatalogEntry, CommandFieldCatalog, CommandTypeCatalog, + exposed_command, ClientReconcile, ClientReconcileMode, ClientReconcileSpec, ClientResultKind, + ClientResultSpec, CommandCatalog, CommandCatalogEntry, CommandFieldCatalog, CommandTypeCatalog, ExposedCommand, GraphqlCommands, }; #[cfg(feature = "graphql")] diff --git a/src/graphql/schema.rs b/src/graphql/schema.rs index c5430db0..c344421f 100644 --- a/src/graphql/schema.rs +++ b/src/graphql/schema.rs @@ -435,8 +435,20 @@ fn ensure_object_type( let key = rel.field_name.clone(); match rel.kind { RelationshipKind::BelongsTo => { - // Always nullable: non-null FK ≠ target RM row present (LEFT JOIN). - let ty = TypeRef::named(target_obj); + let fk_nullable = schema + .columns + .iter() + .find(|c| { + c.column_name == rel.foreign_key.as_deref().unwrap_or("") + || c.field_name == rel.foreign_key.as_deref().unwrap_or("") + }) + .map(|c| c.nullable) + .unwrap_or(true); + let ty = if fk_nullable { + TypeRef::named(target_obj) + } else { + TypeRef::named_nn(target_obj) + }; obj = obj.field(Field::new(rel.field_name.as_str(), ty, move |ctx| { let key = key.clone(); FieldFuture::new(async move { passthrough(&ctx, &key) }) diff --git a/src/graphql/sdl.rs b/src/graphql/sdl.rs index e950166e..c7c247dd 100644 --- a/src/graphql/sdl.rs +++ b/src/graphql/sdl.rs @@ -441,9 +441,17 @@ fn emit_object_type( let target_obj = object_type_name(target); match rel.kind { RelationshipKind::BelongsTo => { - // Always nullable: a non-null FK means the source holds an id, not - // that a matching target read-model row exists (LEFT JOIN / Option). - out.push_str(&format!(" {}: {}\n", rel.field_name, target_obj)); + let fk_nullable = schema + .columns + .iter() + .find(|c| { + c.column_name == rel.foreign_key.as_deref().unwrap_or("") + || c.field_name == rel.foreign_key.as_deref().unwrap_or("") + }) + .map(|c| c.nullable) + .unwrap_or(true); + let null = if fk_nullable { "" } else { "!" }; + out.push_str(&format!(" {}: {}{}\n", rel.field_name, target_obj, null)); } RelationshipKind::HasMany | RelationshipKind::ManyToMany => { let bool_exp = bool_exp_name(target); diff --git a/tests/e2e-ui/Makefile b/tests/e2e-ui/Makefile index 872c1a7d..605377ef 100644 --- a/tests/e2e-ui/Makefile +++ b/tests/e2e-ui/Makefile @@ -164,7 +164,8 @@ check-commands: gen-commands if ! git -C "$$ROOT" diff --exit-code -- \ tests/e2e-ui/ui/src/lib/api/commands.manifest.json \ tests/e2e-ui/ui/src/lib/api/commands.generated.ts \ - tests/e2e-ui/ui/src/lib/api/commands.operations.gql; then \ + tests/e2e-ui/ui/src/lib/api/commands.operations.gql \ + tests/e2e-ui/ui/src/lib/api/commands.policies.generated.ts; then \ echo "ERROR: command client drift — run make gen-commands and commit"; \ git -C "$$ROOT" diff --stat -- tests/e2e-ui/ui/src/lib/api || true; \ exit 1; \ diff --git a/tests/e2e-ui/crates/chat-domain/src/models/chat_message.rs b/tests/e2e-ui/crates/chat-domain/src/models/chat_message.rs index 2ab6ae2e..5bae21ae 100644 --- a/tests/e2e-ui/crates/chat-domain/src/models/chat_message.rs +++ b/tests/e2e-ui/crates/chat-domain/src/models/chat_message.rs @@ -1,8 +1,6 @@ use distributed::{sourced, Entity}; use serde::{Deserialize, Serialize}; -use super::ChatError; - #[derive(Debug, Clone, Default, Serialize, Deserialize)] pub struct ChatMessage { #[serde(skip, default)] @@ -21,49 +19,18 @@ impl ChatMessage { } } +/// One public command with `#[event]`. Callers pass non-empty trimmed fields. #[sourced(entity, events = "ChatMessageEvent", aggregate_type = "chat_message")] impl ChatMessage { + #[event( + "chat_message.posted", + when = !self.is_posted() + && !message_id.is_empty() + && !room_id.is_empty() + && !author_id.is_empty() + && !body.is_empty() + )] pub fn post( - &mut self, - message_id: impl Into, - room_id: impl Into, - author_id: impl Into, - body: impl Into, - created_at: impl Into, - ) -> Result<(), ChatError> { - if self.is_posted() { - return Err(ChatError::AlreadyExists); - } - let message_id = message_id.into(); - let room_id = room_id.into(); - let author_id = author_id.into(); - let body = body.into(); - let created_at = created_at.into(); - if message_id.trim().is_empty() { - return Err(ChatError::EmptyId); - } - if room_id.trim().is_empty() { - return Err(ChatError::EmptyRoom); - } - if author_id.trim().is_empty() { - return Err(ChatError::EmptyAuthor); - } - let body = body.trim(); - if body.is_empty() { - return Err(ChatError::EmptyBody); - } - self.record_posted( - message_id, - room_id, - author_id, - body.to_string(), - created_at, - )?; - Ok(()) - } - - #[event("chat_message.posted")] - fn record_posted( &mut self, message_id: String, room_id: String, @@ -87,19 +54,29 @@ mod tests { #[test] fn post_sets_fields() { let mut m = ChatMessage::default(); - m.post("m1", "lobby", "alice", "hello", "2026-01-01T00:00:00Z") - .unwrap(); + let _ = m.post( + "m1".into(), + "lobby".into(), + "alice".into(), + "hello".into(), + "2026-01-01T00:00:00Z".into(), + ); assert!(m.is_posted()); assert_eq!(m.body, "hello"); assert_eq!(m.author_id, "alice"); } #[test] - fn rejects_empty_body() { + fn empty_body_is_noop() { let mut m = ChatMessage::default(); - assert_eq!( - m.post("m1", "lobby", "alice", " ", "t").unwrap_err(), - ChatError::EmptyBody + let _ = m.post( + "m1".into(), + "lobby".into(), + "alice".into(), + String::new(), + "t".into(), ); + assert!(!m.is_posted()); + assert_eq!(m.entity.version(), 0); } } diff --git a/tests/e2e-ui/crates/service/src/handlers/commands/archive.rs b/tests/e2e-ui/crates/service/src/handlers/commands/archive.rs index efd94319..d4d296c6 100644 --- a/tests/e2e-ui/crates/service/src/handlers/commands/archive.rs +++ b/tests/e2e-ui/crates/service/src/handlers/commands/archive.rs @@ -39,7 +39,8 @@ where let owner = require_user(ctx.session())?; let input = ctx.input::()?; let mut todo = load_todo(ctx, &input.todo_id).await?; - todo.archive(&owner).map_err(map_domain)?; + todo.ensure_owner(&owner).map_err(map_domain)?; + todo.archive(owner).map_err(map_domain)?; let fact = commit_todo_event(ctx, &mut todo, "todo.archived").await?; Ok(status_json(&fact)) } diff --git a/tests/e2e-ui/crates/service/src/handlers/commands/chat_post.rs b/tests/e2e-ui/crates/service/src/handlers/commands/chat_post.rs index 89d17fa7..b2416599 100644 --- a/tests/e2e-ui/crates/service/src/handlers/commands/chat_post.rs +++ b/tests/e2e-ui/crates/service/src/handlers/commands/chat_post.rs @@ -59,14 +59,18 @@ where ))); } + let body = input.body.trim().to_string(); + if body.is_empty() { + return Err(rejected("empty body")); + } let created_at = chrono_lite_now(); let mut msg = ChatMessage::default(); msg.post( - &input.message_id, - &input.room_id, - &author, - &input.body, - &created_at, + input.message_id.clone(), + input.room_id.clone(), + author, + body, + created_at, ) .map_err(rejected)?; diff --git a/tests/e2e-ui/crates/service/src/handlers/commands/complete.rs b/tests/e2e-ui/crates/service/src/handlers/commands/complete.rs index ace70713..e43a4e11 100644 --- a/tests/e2e-ui/crates/service/src/handlers/commands/complete.rs +++ b/tests/e2e-ui/crates/service/src/handlers/commands/complete.rs @@ -35,7 +35,8 @@ where let owner = require_user(ctx.session())?; let input = ctx.input::()?; let mut todo = load_todo(ctx, &input.todo_id).await?; - todo.complete(&owner).map_err(map_domain)?; + todo.ensure_owner(&owner).map_err(map_domain)?; + todo.complete(owner).map_err(map_domain)?; let fact = commit_todo_event(ctx, &mut todo, "todo.completed").await?; Ok(status_json(&fact)) } diff --git a/tests/e2e-ui/crates/service/src/handlers/commands/create.rs b/tests/e2e-ui/crates/service/src/handlers/commands/create.rs index ff986ce7..999376f5 100644 --- a/tests/e2e-ui/crates/service/src/handlers/commands/create.rs +++ b/tests/e2e-ui/crates/service/src/handlers/commands/create.rs @@ -58,8 +58,12 @@ where ))); } + let title = input.title.trim().to_string(); + if title.is_empty() { + return Err(HandlerError::Rejected("empty title".into())); + } let mut todo = Todo::default(); - todo.create(&input.todo_id, &owner, &input.title) + todo.create(input.todo_id.clone(), owner, title) .map_err(map_domain)?; let fact = commit_todo_event(ctx, &mut todo, "todo.created").await?; diff --git a/tests/e2e-ui/crates/service/src/handlers/commands/force_archive.rs b/tests/e2e-ui/crates/service/src/handlers/commands/force_archive.rs index da599a9a..3db0169f 100644 --- a/tests/e2e-ui/crates/service/src/handlers/commands/force_archive.rs +++ b/tests/e2e-ui/crates/service/src/handlers/commands/force_archive.rs @@ -56,7 +56,7 @@ where // Domain archive is owner-scoped; use the aggregate's real owner (not admin id). let owner = todo.owner_id.clone(); - todo.archive(&owner).map_err(map_domain)?; + todo.archive(owner).map_err(map_domain)?; let fact = commit_todo_event(ctx, &mut todo, FORCE_ARCHIVED_EVENT).await?; Ok(json!({ diff --git a/tests/e2e-ui/crates/service/src/handlers/commands/rename.rs b/tests/e2e-ui/crates/service/src/handlers/commands/rename.rs index 3409edc9..aeeee2e6 100644 --- a/tests/e2e-ui/crates/service/src/handlers/commands/rename.rs +++ b/tests/e2e-ui/crates/service/src/handlers/commands/rename.rs @@ -43,7 +43,12 @@ where let owner = require_user(ctx.session())?; let input = ctx.input::()?; let mut todo = load_todo(ctx, &input.todo_id).await?; - todo.rename(&owner, &input.title).map_err(map_domain)?; + let title = input.title.trim().to_string(); + if title.is_empty() { + return Err(HandlerError::Rejected("empty title".into())); + } + todo.ensure_owner(&owner).map_err(map_domain)?; + todo.rename(owner, title).map_err(map_domain)?; let fact = commit_todo_event(ctx, &mut todo, "todo.renamed").await?; Ok(json!({ "todo_id": fact.todo_id, diff --git a/tests/e2e-ui/crates/service/src/handlers/commands/reopen.rs b/tests/e2e-ui/crates/service/src/handlers/commands/reopen.rs index 820ec6e9..92faf182 100644 --- a/tests/e2e-ui/crates/service/src/handlers/commands/reopen.rs +++ b/tests/e2e-ui/crates/service/src/handlers/commands/reopen.rs @@ -38,7 +38,8 @@ where let owner = require_user(ctx.session())?; let input = ctx.input::()?; let mut todo = load_todo(ctx, &input.todo_id).await?; - todo.reopen(&owner).map_err(map_domain)?; + todo.ensure_owner(&owner).map_err(map_domain)?; + todo.reopen(owner).map_err(map_domain)?; let fact = commit_todo_event(ctx, &mut todo, "todo.reopened").await?; Ok(status_json(&fact)) } diff --git a/tests/e2e-ui/crates/service/src/service.rs b/tests/e2e-ui/crates/service/src/service.rs index 6e24e986..f8be95b4 100644 --- a/tests/e2e-ui/crates/service/src/service.rs +++ b/tests/e2e-ui/crates/service/src/service.rs @@ -3,8 +3,8 @@ use blob_domain::BlobGame; use chat_domain::ChatMessage; use distributed::graphql::{ - exposed_command, read, GraphqlCommands, GraphqlEngine, GraphqlPool, IdentityConfig, - ModelPermissions, OidcConfig, + exposed_command, read, ClientReconcile, GraphqlCommands, GraphqlEngine, GraphqlPool, + IdentityConfig, ModelPermissions, OidcConfig, }; use distributed::microsvc::{ ConfigurableOutboxPublisher, HasOutboxStore, HasRepo, Routes, Service, @@ -85,6 +85,11 @@ pub fn graphql_commands() -> GraphqlCommands { }; let app_roles = ["user", "admin"]; + // Eventual (async projectors) vs same-tx (blob returns projected row). + let fact = ClientReconcile::fact(); + let fact_sub = ClientReconcile::fact_subscription(); + let projection = ClientReconcile::projection(); + GraphqlCommands::new() .command( create::COMMAND, @@ -92,7 +97,8 @@ pub fn graphql_commands() -> GraphqlCommands { .field_name("todos_create") .input::() .output::() - .roles(app_roles), + .roles(app_roles) + .client_reconcile(fact.clone()), ) .command( complete::COMMAND, @@ -100,7 +106,8 @@ pub fn graphql_commands() -> GraphqlCommands { .field_name("todos_complete") .input::() .output::() - .roles(app_roles), + .roles(app_roles) + .client_reconcile(fact.clone()), ) .command( archive::COMMAND, @@ -108,7 +115,8 @@ pub fn graphql_commands() -> GraphqlCommands { .field_name("todos_archive") .input::() .output::() - .roles(app_roles), + .roles(app_roles) + .client_reconcile(fact.clone()), ) .command( // Admin-only mutation: appears in admin SDL, not user SDL. @@ -117,7 +125,8 @@ pub fn graphql_commands() -> GraphqlCommands { .field_name("todos_force_archive") .input::() .output::() - .roles(["admin"]), + .roles(["admin"]) + .client_reconcile(fact.clone()), ) .command( rename::COMMAND, @@ -125,7 +134,8 @@ pub fn graphql_commands() -> GraphqlCommands { .field_name("todos_rename") .input::() .output::() - .roles(app_roles), + .roles(app_roles) + .client_reconcile(fact.clone()), ) .command( reopen::COMMAND, @@ -133,7 +143,8 @@ pub fn graphql_commands() -> GraphqlCommands { .field_name("todos_reopen") .input::() .output::() - .roles(app_roles), + .roles(app_roles) + .client_reconcile(fact), ) .command( chat_post::COMMAND, @@ -141,7 +152,8 @@ pub fn graphql_commands() -> GraphqlCommands { .field_name("chat_messages_post") .input::() .output::() - .roles(app_roles), + .roles(app_roles) + .client_reconcile(fact_sub), ) .command( blob_start::COMMAND, @@ -149,7 +161,8 @@ pub fn graphql_commands() -> GraphqlCommands { .field_name("blob_games_start") .input::() .output::() - .roles(app_roles), + .roles(app_roles) + .client_reconcile(projection.clone()), ) .command( blob_move::COMMAND, @@ -157,7 +170,8 @@ pub fn graphql_commands() -> GraphqlCommands { .field_name("blob_games_move") .input::() .output::() - .roles(app_roles), + .roles(app_roles) + .client_reconcile(projection.clone()), ) .command( blob_start_level::COMMAND, @@ -165,7 +179,8 @@ pub fn graphql_commands() -> GraphqlCommands { .field_name("blob_games_start_level") .input::() .output::() - .roles(app_roles), + .roles(app_roles) + .client_reconcile(projection), ) } diff --git a/tests/e2e-ui/crates/todo-domain/src/models/todo.rs b/tests/e2e-ui/crates/todo-domain/src/models/todo.rs index 29eb8f7e..a118f4e5 100644 --- a/tests/e2e-ui/crates/todo-domain/src/models/todo.rs +++ b/tests/e2e-ui/crates/todo-domain/src/models/todo.rs @@ -28,119 +28,75 @@ impl Todo { Ok(()) } - fn require_mutable(&self) -> Result<(), TodoError> { - if !self.is_created() { - return Err(TodoError::NotCreated); - } - if matches!(self.status, TodoStatus::Archived) { - return Err(TodoError::Archived); - } - Ok(()) + fn is_open(&self) -> bool { + matches!(self.status, TodoStatus::Open) + } + + fn is_completed(&self) -> bool { + matches!(self.status, TodoStatus::Completed) + } + + fn is_archived(&self) -> bool { + matches!(self.status, TodoStatus::Archived) } } +/// One public function per command. `#[event]` records history and applies state. +/// `when =` skips recording when the command must not fire (invalid / no-op). #[sourced(entity, events = "TodoEvent", aggregate_type = "todo")] impl Todo { - /// Create a new open todo. `owner_id` is the authenticated user (never trusted from peers). - pub fn create( - &mut self, - todo_id: impl Into, - owner_id: impl Into, - title: impl Into, - ) -> Result<(), TodoError> { - if self.is_created() { - return Err(TodoError::AlreadyExists); - } - let todo_id = todo_id.into(); - let owner_id = owner_id.into(); - let title = title.into(); - if todo_id.trim().is_empty() { - return Err(TodoError::EmptyId); - } - if owner_id.trim().is_empty() { - return Err(TodoError::EmptyOwner); - } - let title = title.trim(); - if title.is_empty() { - return Err(TodoError::EmptyTitle); - } - self.record_created(todo_id, owner_id, title.to_string())?; - Ok(()) - } - - #[event("todo.created")] - fn record_created(&mut self, todo_id: String, owner_id: String, title: String) { + /// Create a new open todo. Callers should pass trimmed, non-empty fields. + #[event( + "todo.created", + when = !self.is_created() + && !todo_id.trim().is_empty() + && !owner_id.trim().is_empty() + && !title.trim().is_empty() + )] + pub fn create(&mut self, todo_id: String, owner_id: String, title: String) { self.entity.set_id(&todo_id); self.todo_id = todo_id; self.owner_id = owner_id; - self.title = title; + self.title = title.trim().to_string(); self.status = TodoStatus::Open; } - pub fn rename(&mut self, owner_id: &str, title: impl Into) -> Result<(), TodoError> { - self.ensure_owner(owner_id)?; - self.require_mutable()?; - let title = title.into(); - let title = title.trim(); - if title.is_empty() { - return Err(TodoError::EmptyTitle); - } - if title == self.title { - return Ok(()); // no-op: same title - } - self.record_renamed(title.to_string())?; - Ok(()) - } - - #[event("todo.renamed")] - fn record_renamed(&mut self, title: String) { - self.title = title; - } - - pub fn complete(&mut self, owner_id: &str) -> Result<(), TodoError> { - self.ensure_owner(owner_id)?; - self.require_mutable()?; - if matches!(self.status, TodoStatus::Completed) { - return Err(TodoError::AlreadyCompleted); - } - self.record_completed()?; - Ok(()) - } - - #[event("todo.completed")] - fn record_completed(&mut self) { + /// Rename. No-ops when title is empty, unchanged, or todo is archived / not owned. + #[event( + "todo.renamed", + when = self.owner_id == owner_id + && !self.is_archived() + && !title.trim().is_empty() + && title.trim() != self.title + )] + pub fn rename(&mut self, owner_id: String, title: String) { + self.title = title.trim().to_string(); + } + + /// Mark completed. No-ops unless open and owned by `owner_id`. + #[event( + "todo.completed", + when = self.owner_id == owner_id && self.is_open() + )] + pub fn complete(&mut self, owner_id: String) { self.status = TodoStatus::Completed; } - pub fn reopen(&mut self, owner_id: &str) -> Result<(), TodoError> { - self.ensure_owner(owner_id)?; - self.require_mutable()?; - if !matches!(self.status, TodoStatus::Completed) { - return Err(TodoError::NotCompleted); - } - self.record_reopened()?; - Ok(()) - } - - #[event("todo.reopened")] - fn record_reopened(&mut self) { + /// Reopen a completed todo. No-ops unless completed and owned by `owner_id`. + #[event( + "todo.reopened", + when = self.owner_id == owner_id && self.is_completed() + )] + pub fn reopen(&mut self, owner_id: String) { self.status = TodoStatus::Open; } - pub fn archive(&mut self, owner_id: &str) -> Result<(), TodoError> { - self.ensure_owner(owner_id)?; - if !self.is_created() { - return Err(TodoError::NotCreated); - } - if matches!(self.status, TodoStatus::Archived) { - return Ok(()); // idempotent archive - } - self.record_archived()?; - Ok(()) - } - - #[event("todo.archived")] - fn record_archived(&mut self) { + /// Archive. Idempotent: no-ops if already archived. No-ops if not owned. + #[event( + "todo.archived", + when = self.owner_id == owner_id && self.is_created() && !self.is_archived() + )] + pub fn archive(&mut self, owner_id: String) { self.status = TodoStatus::Archived; } } @@ -151,7 +107,7 @@ mod tests { fn open_todo() -> Todo { let mut t = Todo::default(); - t.create("t1", "alice", "Buy milk").unwrap(); + let _ = t.create("t1".into(), "alice".into(), "Buy milk".into()); t } @@ -167,61 +123,71 @@ mod tests { } #[test] - fn rejects_empty_title_and_double_create() { + fn create_noops_on_empty_or_duplicate() { let mut t = Todo::default(); - assert_eq!(t.create("t1", "alice", " ").unwrap_err(), TodoError::EmptyTitle); - t.create("t1", "alice", "ok").unwrap(); - assert_eq!( - t.create("t1", "alice", "again").unwrap_err(), - TodoError::AlreadyExists - ); + let _ = t.create("t1".into(), "alice".into(), " ".into()); + assert!(!t.is_created()); + assert_eq!(t.entity.version(), 0); + + let _ = t.create("t1".into(), "alice".into(), "ok".into()); + assert!(t.is_created()); + let v = t.entity.version(); + let _ = t.create("t1".into(), "alice".into(), "again".into()); + assert_eq!(t.entity.version(), v); + assert_eq!(t.title, "ok"); } #[test] fn only_owner_can_mutate() { let mut t = open_todo(); - assert_eq!(t.complete("bob").unwrap_err(), TodoError::NotOwner); - t.complete("alice").unwrap(); + let _ = t.complete("bob".into()); + assert_eq!(t.status, TodoStatus::Open); + assert_eq!(t.entity.version(), 1); + + let _ = t.complete("alice".into()); assert_eq!(t.status, TodoStatus::Completed); + assert_eq!(t.entity.version(), 2); } #[test] fn complete_reopen_cycle() { let mut t = open_todo(); - t.complete("alice").unwrap(); - assert_eq!( - t.complete("alice").unwrap_err(), - TodoError::AlreadyCompleted - ); - t.reopen("alice").unwrap(); + let _ = t.complete("alice".into()); + assert_eq!(t.status, TodoStatus::Completed); + let v = t.entity.version(); + let _ = t.complete("alice".into()); + assert_eq!(t.entity.version(), v); + + let _ = t.reopen("alice".into()); assert_eq!(t.status, TodoStatus::Open); - assert_eq!(t.reopen("alice").unwrap_err(), TodoError::NotCompleted); + let v = t.entity.version(); + let _ = t.reopen("alice".into()); + assert_eq!(t.entity.version(), v); } #[test] - fn rename_trims_and_rejects_empty() { + fn rename_trims_via_caller_and_noops_empty() { let mut t = open_todo(); - t.rename("alice", " Eggs ").unwrap(); + let _ = t.rename("alice".into(), "Eggs".into()); assert_eq!(t.title, "Eggs"); - assert_eq!( - t.rename("alice", " ").unwrap_err(), - TodoError::EmptyTitle - ); - // same title is no-op (no extra version if no event — check version stays) let v = t.entity.version(); - t.rename("alice", "Eggs").unwrap(); + let _ = t.rename("alice".into(), String::new()); + assert_eq!(t.entity.version(), v); + assert_eq!(t.title, "Eggs"); + let _ = t.rename("alice".into(), "Eggs".into()); assert_eq!(t.entity.version(), v); } #[test] fn archive_is_terminal_for_mutations() { let mut t = open_todo(); - t.archive("alice").unwrap(); + let _ = t.archive("alice".into()); assert_eq!(t.status, TodoStatus::Archived); - assert_eq!(t.complete("alice").unwrap_err(), TodoError::Archived); - assert_eq!(t.rename("alice", "x").unwrap_err(), TodoError::Archived); - // second archive is idempotent - t.archive("alice").unwrap(); + let v = t.entity.version(); + let _ = t.complete("alice".into()); + let _ = t.rename("alice".into(), "x".into()); + let _ = t.archive("alice".into()); + assert_eq!(t.entity.version(), v); assert_eq!(t.status, TodoStatus::Archived); } } diff --git a/tests/e2e-ui/ui/schema/admin.graphql b/tests/e2e-ui/ui/schema/admin.graphql index cfae6461..cb9b2c86 100644 --- a/tests/e2e-ui/ui/schema/admin.graphql +++ b/tests/e2e-ui/ui/schema/admin.graphql @@ -54,7 +54,7 @@ type BlobGameView { current_level_completed: Boolean! map_json: String! status: String! - owner: AuthUserView + owner: AuthUserView! } input BlobMoveInput { @@ -90,7 +90,7 @@ type ChatMessageView { author_id: String! body: String! created_at: String! - author: AuthUserView + author: AuthUserView! } input ChatPostInput { diff --git a/tests/e2e-ui/ui/schema/user.graphql b/tests/e2e-ui/ui/schema/user.graphql index e28ca8c4..624f36ec 100644 --- a/tests/e2e-ui/ui/schema/user.graphql +++ b/tests/e2e-ui/ui/schema/user.graphql @@ -54,7 +54,7 @@ type BlobGameView { current_level_completed: Boolean! map_json: String! status: String! - owner: AuthUserView + owner: AuthUserView! } input BlobMoveInput { @@ -90,7 +90,7 @@ type ChatMessageView { author_id: String! body: String! created_at: String! - author: AuthUserView + author: AuthUserView! } input ChatPostInput { diff --git a/tests/e2e-ui/ui/scripts/gen-commands.mjs b/tests/e2e-ui/ui/scripts/gen-commands.mjs index 055ab9af..c0a4dc07 100644 --- a/tests/e2e-ui/ui/scripts/gen-commands.mjs +++ b/tests/e2e-ui/ui/scripts/gen-commands.mjs @@ -1,9 +1,10 @@ /** * Generate command client artifacts from commands.manifest.json. * - * Outputs (single source of mutation text): - * 1. commands.operations.gql — GraphiQL / human copy-paste - * 2. commands.generated.ts — same documents + typed functions + * Outputs (single source of mutation text + pipeline policies): + * 1. commands.operations.gql — GraphiQL / human copy-paste + * 2. commands.generated.ts — same documents + typed functions + * 3. commands.policies.generated.ts — client_reconcile → CommandPolicy map * * Functions take the bound GraphQL client (`useGraphql(() => data)`), which * already owns URL + auth headers — no { url, auth } boilerplate. @@ -218,6 +219,48 @@ export function generateCommandsTs(catalog) { return lines.join('\n'); } +/** + * Generate TS command pipeline policies from catalog `client_reconcile` hints. + * Keys are bound function names (`todosCreate`), matching `CommandPolicyMap`. + * + * @param {object} catalog + * @returns {string} + */ +export function generateCommandPoliciesTs(catalog) { + assertCatalog(catalog); + + const lines = []; + lines.push('/**'); + lines.push(' * GENERATED — do not edit by hand.'); + lines.push(' * Source: e2e_service::graphql_commands() → client_reconcile → commands.manifest.json'); + lines.push(' * Regenerate: `make gen-commands` (from tests/e2e-ui)'); + lines.push(' * Spec: distributed GitKB tasks/graphql-qs-command-return-4 (D3)'); + lines.push(' */'); + lines.push(`import type { CommandPolicyMap } from '../gql/bind-commands-pipeline.ts';`); + lines.push(''); + lines.push('/**'); + lines.push(' * Default result/reconcile policies from the Rust command registry.'); + lines.push(' * Call-site options on `gql.commands.*(input, opts)` still win.'); + lines.push(' */'); + lines.push('export const e2eCommandPolicies: CommandPolicyMap = {'); + + for (const cmd of catalog.commands) { + const cr = cmd.client_reconcile; + if (!cr?.result?.kind) continue; + const fn = fieldToFnName(cmd.field_name); + const resultKind = String(cr.result.kind); + const reconcileKind = cr.reconcile?.kind ? String(cr.reconcile.kind) : 'none'; + lines.push(`\t${fn}: {`); + lines.push(`\t\tresult: { kind: ${JSON.stringify(resultKind)} },`); + lines.push(`\t\treconcile: { kind: ${JSON.stringify(reconcileKind)} }`); + lines.push(`\t},`); + } + + lines.push('};'); + lines.push(''); + return lines.join('\n'); +} + function assertCatalog(catalog) { if (!catalog || catalog.version !== 1 || !Array.isArray(catalog.commands)) { throw new Error('invalid command catalog: expected { version: 1, commands: [...] }'); @@ -278,16 +321,21 @@ function main() { process.argv[3] || path.join(uiRoot, 'src/lib/api/commands.generated.ts'); const outGql = process.argv[4] || path.join(uiRoot, 'src/lib/api/commands.operations.gql'); + const outPolicies = + process.argv[5] || path.join(uiRoot, 'src/lib/api/commands.policies.generated.ts'); const catalog = JSON.parse(fs.readFileSync(inPath, 'utf8')); const ts = generateCommandsTs(catalog); const gql = generateOperationsGql(catalog); + const policies = generateCommandPoliciesTs(catalog); fs.mkdirSync(path.dirname(outTs), { recursive: true }); fs.writeFileSync(outTs, ts.endsWith('\n') ? ts : ts + '\n'); fs.writeFileSync(outGql, gql.endsWith('\n') ? gql : gql + '\n'); + fs.writeFileSync(outPolicies, policies.endsWith('\n') ? policies : policies + '\n'); + const withPolicy = catalog.commands.filter((c) => c.client_reconcile).length; console.error( - `gen-commands: wrote ${path.relative(uiRoot, outTs)} + ${path.relative(uiRoot, outGql)} (${catalog.commands.length} commands)` + `gen-commands: wrote ${path.relative(uiRoot, outTs)} + ${path.relative(uiRoot, outGql)} + ${path.relative(uiRoot, outPolicies)} (${catalog.commands.length} commands, ${withPolicy} policies)` ); } diff --git a/tests/e2e-ui/ui/src/app.css b/tests/e2e-ui/ui/src/app.css index 9ff1d92d..fb1345d4 100644 --- a/tests/e2e-ui/ui/src/app.css +++ b/tests/e2e-ui/ui/src/app.css @@ -774,6 +774,281 @@ main { border-radius: 3px; } +.wf-card-list { + margin: 0; + padding-left: 1.1rem; + display: grid; + gap: 0.45rem; + font-size: 0.9rem; + line-height: 1.5; + color: var(--wf-ink-soft); +} + +.wf-card-list li::marker { + color: var(--wf-ink-muted); +} + +/* —— Home field guide (long-form index) —— */ +.wf-toc { + display: flex; + flex-wrap: wrap; + gap: 0.35rem 0.15rem; + margin-top: 2.25rem; + padding-top: 1.35rem; + border-top: 1px solid var(--wf-line); + max-width: none; +} + +.wf-toc a { + font-family: var(--wf-mono); + font-size: 0.68rem; + font-weight: 500; + letter-spacing: 0.04em; + text-transform: uppercase; + text-decoration: none; + color: var(--wf-ink-muted); + padding: 0.35rem 0.55rem; + border-radius: 4px; + border: 1px solid transparent; + transition: + color 0.15s var(--ease), + background 0.15s var(--ease), + border-color 0.15s var(--ease); +} + +.wf-toc a:hover { + color: var(--wf-ink); + background: rgba(28, 28, 26, 0.04); + border-color: var(--wf-line); +} + +.wf-section-head-wide { + max-width: min(48rem, 100%); +} + +.wf-principles { + list-style: none; + margin: 0; + padding: 0; + display: flex; + flex-direction: column; + border-top: 1px solid var(--wf-line); +} + +.wf-principle { + display: grid; + grid-template-columns: 2.5rem minmax(0, 1fr); + gap: 0.85rem 1.25rem; + padding: 1.35rem 0; + border-bottom: 1px solid var(--wf-line); +} + +@media (min-width: 768px) { + .wf-principle { + grid-template-columns: 3rem minmax(0, 1fr); + gap: 1rem 1.75rem; + padding: 1.55rem 0; + } +} + +.wf-principle-n { + font-family: var(--wf-mono); + font-size: 0.72rem; + font-weight: 500; + letter-spacing: 0.06em; + color: var(--wf-ink-muted); + padding-top: 0.2rem; +} + +.wf-principle h3 { + margin: 0 0 0.4rem; + font-family: var(--wf-serif); + font-size: 1.12rem; + font-weight: 500; + letter-spacing: -0.02em; + line-height: 1.25; + color: var(--wf-ink); +} + +.wf-principle p { + margin: 0; + max-width: 44rem; + font-size: 0.95rem; + line-height: 1.6; + color: var(--wf-ink-soft); +} + +.wf-subhead { + margin: 3.25rem 0 1.35rem; + max-width: var(--wf-measure); + padding-top: 0.25rem; + border-top: 1px solid var(--wf-line); + padding-top: 1.75rem; +} + +.wf-subhead h3 { + margin: 0 0 0.55rem; + font-family: var(--wf-serif); + font-size: clamp(1.2rem, 2.2vw, 1.45rem); + font-weight: 500; + letter-spacing: -0.02em; + line-height: 1.25; + color: var(--wf-ink); +} + +.wf-subhead p { + margin: 0; + font-size: 0.98rem; + line-height: 1.6; + color: var(--wf-ink-soft); +} + +.wf-subhead code { + font-size: 0.88em; + background: rgba(28, 28, 26, 0.05); + padding: 0.1em 0.3em; + border-radius: 3px; +} + +.wf-layers { + display: grid; + gap: 1rem; +} + +@media (min-width: 900px) { + .wf-layers { + grid-template-columns: repeat(3, 1fr); + gap: 1.15rem; + } +} + +.wf-layer { + position: relative; + padding: 1.35rem 1.25rem 1.4rem; + background: var(--wf-bg-elevated); + border: 1px solid var(--wf-line); + border-radius: var(--wf-radius); + border-top: 2px solid var(--wf-ink); +} + +.wf-layer-n { + display: block; + font-family: var(--wf-mono); + font-size: 0.68rem; + letter-spacing: 0.1em; + color: var(--wf-ink-muted); + margin-bottom: 0.65rem; +} + +.wf-layer h4 { + margin: 0 0 0.75rem; + font-size: 1.02rem; + font-weight: 600; + letter-spacing: -0.015em; + line-height: 1.3; + color: var(--wf-ink); +} + +.wf-layer-body { + margin: 0; + font-size: 0.92rem; + line-height: 1.6; + color: var(--wf-ink-soft); +} + +.wf-cards-tight { + gap: 1rem; +} + +.wf-card-kicker { + display: block; + font-family: var(--wf-mono); + font-size: 0.65rem; + font-weight: 500; + letter-spacing: 0.1em; + text-transform: uppercase; + color: var(--wf-ink-muted); + margin-bottom: 0.55rem; +} + +.wf-card-accent { + border-top: 2px solid var(--wf-accent); +} + +.wf-code-lead { + margin-bottom: 0.25rem; +} + +.wf-code-follow { + margin-top: 1.5rem; +} + +.wf-crate-map { + margin: 0; + padding: 0; + border-top: 1px solid var(--wf-line); +} + +.wf-crate { + display: grid; + gap: 0.25rem; + padding: 0.95rem 0; + border-bottom: 1px solid var(--wf-line); +} + +@media (min-width: 720px) { + .wf-crate { + grid-template-columns: minmax(12rem, 0.42fr) minmax(0, 1fr); + gap: 1.25rem 2rem; + align-items: baseline; + padding: 1.05rem 0; + } +} + +.wf-crate dt { + margin: 0; + font-family: var(--wf-mono); + font-size: 0.78rem; + font-weight: 500; + letter-spacing: 0.02em; + color: var(--wf-ink); +} + +.wf-crate dd { + margin: 0; + font-size: 0.92rem; + line-height: 1.5; + color: var(--wf-ink-soft); +} + +.wf-chapter { + margin-top: 2.75rem; + display: flex; + flex-direction: column; + gap: 0; + border-top: 1px solid var(--wf-line); +} + +.wf-chapter .wf-story-step { + padding: 2.25rem 0; + border-bottom: 1px solid var(--wf-line); +} + +.wf-chapter .wf-story-step:last-child { + border-bottom: none; + padding-bottom: 0.5rem; +} + +.wf-step-title { + margin: 0 0 0.85rem; + font-family: var(--wf-serif); + font-size: clamp(1.25rem, 2.4vw, 1.55rem); + font-weight: 500; + letter-spacing: -0.02em; + line-height: 1.22; + color: var(--wf-ink); +} + /* Run steps */ .wf-run { background: var(--wf-bg-elevated); @@ -1065,8 +1340,14 @@ main { .wf-band-dark .wf-step p, .wf-band-dark .wf-demo p, .wf-band-dark .wf-card p, +.wf-band-dark .wf-card-list, +.wf-band-dark .wf-layer-body, .wf-band-dark .wf-flow-map, -.wf-band-dark .wf-cta p { +.wf-band-dark .wf-cta p, +.wf-band-dark .wf-principle p, +.wf-band-dark .wf-subhead p, +.wf-band-dark .wf-crate dd, +.wf-band-dark .wf-why { color: var(--wf-band-dark-soft); } @@ -1074,18 +1355,62 @@ main { .wf-band-dark .wf-sample-path, .wf-band-dark .wf-demo-i, .wf-band-dark .wf-meta, -.wf-band-dark .wf-step::before { +.wf-band-dark .wf-step::before, +.wf-band-dark .wf-principle-n, +.wf-band-dark .wf-layer-n, +.wf-band-dark .wf-card-kicker, +.wf-band-dark .wf-toc a { color: var(--wf-band-dark-muted); } -.wf-band-dark .wf-card { +.wf-band-dark .wf-card, +.wf-band-dark .wf-layer { background: var(--wf-band-dark-elev); border-color: var(--wf-band-dark-line); } +.wf-band-dark .wf-layer { + border-top-color: var(--wf-band-dark-ink); +} + +.wf-band-dark .wf-card-accent { + border-top-color: #9ec5e8; +} + .wf-band-dark .wf-card h3, .wf-band-dark .wf-step h3, -.wf-band-dark .wf-demo h3 { +.wf-band-dark .wf-demo h3, +.wf-band-dark .wf-principle h3, +.wf-band-dark .wf-subhead h3, +.wf-band-dark .wf-layer h4, +.wf-band-dark .wf-step-title, +.wf-band-dark .wf-crate dt { + color: var(--wf-band-dark-ink); +} + +.wf-band-dark .wf-principles, +.wf-band-dark .wf-principle, +.wf-band-dark .wf-crate-map, +.wf-band-dark .wf-crate, +.wf-band-dark .wf-subhead, +.wf-band-dark .wf-chapter, +.wf-band-dark .wf-chapter .wf-story-step { + border-color: var(--wf-band-dark-line); +} + +.wf-band-dark .wf-toc { + border-top-color: var(--wf-band-dark-line); +} + +.wf-band-dark .wf-toc a:hover { + color: var(--wf-band-dark-ink); + background: rgba(255, 255, 255, 0.05); + border-color: var(--wf-band-dark-line); +} + +.wf-band-dark .wf-subhead code { + background: rgba(255, 255, 255, 0.07); + border: 1px solid var(--wf-band-dark-line); color: var(--wf-band-dark-ink); } diff --git a/tests/e2e-ui/ui/src/lib/api/commands.manifest.json b/tests/e2e-ui/ui/src/lib/api/commands.manifest.json index 7bc2e059..99f6e3b7 100644 --- a/tests/e2e-ui/ui/src/lib/api/commands.manifest.json +++ b/tests/e2e-ui/ui/src/lib/api/commands.manifest.json @@ -53,6 +53,14 @@ "list": false } ] + }, + "client_reconcile": { + "result": { + "kind": "fact" + }, + "reconcile": { + "kind": "none" + } } }, { @@ -89,6 +97,14 @@ "list": false } ] + }, + "client_reconcile": { + "result": { + "kind": "fact" + }, + "reconcile": { + "kind": "none" + } } }, { @@ -125,6 +141,14 @@ "list": false } ] + }, + "client_reconcile": { + "result": { + "kind": "fact" + }, + "reconcile": { + "kind": "none" + } } }, { @@ -172,6 +196,14 @@ "list": false } ] + }, + "client_reconcile": { + "result": { + "kind": "fact" + }, + "reconcile": { + "kind": "none" + } } }, { @@ -220,6 +252,14 @@ "list": false } ] + }, + "client_reconcile": { + "result": { + "kind": "fact" + }, + "reconcile": { + "kind": "none" + } } }, { @@ -256,6 +296,14 @@ "list": false } ] + }, + "client_reconcile": { + "result": { + "kind": "fact" + }, + "reconcile": { + "kind": "none" + } } }, { @@ -322,6 +370,14 @@ "list": false } ] + }, + "client_reconcile": { + "result": { + "kind": "fact" + }, + "reconcile": { + "kind": "subscription" + } } }, { @@ -394,6 +450,14 @@ "list": false } ] + }, + "client_reconcile": { + "result": { + "kind": "projection" + }, + "reconcile": { + "kind": "none" + } } }, { @@ -472,6 +536,14 @@ "list": false } ] + }, + "client_reconcile": { + "result": { + "kind": "projection" + }, + "reconcile": { + "kind": "none" + } } }, { @@ -544,6 +616,14 @@ "list": false } ] + }, + "client_reconcile": { + "result": { + "kind": "projection" + }, + "reconcile": { + "kind": "none" + } } } ] diff --git a/tests/e2e-ui/ui/src/lib/api/commands.policies.generated.ts b/tests/e2e-ui/ui/src/lib/api/commands.policies.generated.ts new file mode 100644 index 00000000..5e7f9dc7 --- /dev/null +++ b/tests/e2e-ui/ui/src/lib/api/commands.policies.generated.ts @@ -0,0 +1,54 @@ +/** + * GENERATED — do not edit by hand. + * Source: e2e_service::graphql_commands() → client_reconcile → commands.manifest.json + * Regenerate: `make gen-commands` (from tests/e2e-ui) + * Spec: distributed GitKB tasks/graphql-qs-command-return-4 (D3) + */ +import type { CommandPolicyMap } from '../gql/bind-commands-pipeline.ts'; + +/** + * Default result/reconcile policies from the Rust command registry. + * Call-site options on `gql.commands.*(input, opts)` still win. + */ +export const e2eCommandPolicies: CommandPolicyMap = { + todosCreate: { + result: { kind: "fact" }, + reconcile: { kind: "none" } + }, + todosComplete: { + result: { kind: "fact" }, + reconcile: { kind: "none" } + }, + todosArchive: { + result: { kind: "fact" }, + reconcile: { kind: "none" } + }, + todosForceArchive: { + result: { kind: "fact" }, + reconcile: { kind: "none" } + }, + todosRename: { + result: { kind: "fact" }, + reconcile: { kind: "none" } + }, + todosReopen: { + result: { kind: "fact" }, + reconcile: { kind: "none" } + }, + chatMessagesPost: { + result: { kind: "fact" }, + reconcile: { kind: "subscription" } + }, + blobGamesStart: { + result: { kind: "projection" }, + reconcile: { kind: "none" } + }, + blobGamesMove: { + result: { kind: "projection" }, + reconcile: { kind: "none" } + }, + blobGamesStartLevel: { + result: { kind: "projection" }, + reconcile: { kind: "none" } + }, +}; diff --git a/tests/e2e-ui/ui/src/lib/components/shared/ui/Button.svelte b/tests/e2e-ui/ui/src/lib/components/shared/ui/Button.svelte index 82f9fb04..df86ca98 100644 --- a/tests/e2e-ui/ui/src/lib/components/shared/ui/Button.svelte +++ b/tests/e2e-ui/ui/src/lib/components/shared/ui/Button.svelte @@ -62,37 +62,35 @@ align-items: center; justify-content: center; gap: 0.5rem; - font-family: var(--font-body); + font-family: var(--wf-sans, var(--font-body)); font-weight: 600; - font-size: 1rem; - padding: 0.875rem 1.75rem; - border-radius: 8px; + font-size: 0.95rem; + padding: 0.7rem 1.25rem; + border-radius: var(--wf-radius, 6px); border: none; cursor: pointer; text-decoration: none; - transition: all 0.3s var(--ease-out-expo); + transition: background 0.15s ease, border-color 0.15s ease, color 0.15s ease; position: relative; - overflow: hidden; &:disabled { - opacity: 0.6; + opacity: 0.55; cursor: not-allowed; - transform: none !important; } } /* Sizes */ .button-lg { - padding: 1.125rem 2.25rem; - font-size: 1.125rem; + padding: 0.85rem 1.5rem; + font-size: 1rem; @media (--tablet) { - padding: 1rem 1.5rem; - font-size: 1rem; + padding: 0.75rem 1.25rem; + font-size: 0.95rem; } @media (--mobile) { - padding: 0.875rem 1.25rem; + padding: 0.75rem 1.1rem; font-size: 0.95rem; width: 100%; } @@ -100,69 +98,45 @@ /* Primary variant */ .button-primary { - background: var(--hops-orange); - color: var(--hops-text-inverse); - box-shadow: var(--shadow-orange); + background: var(--wf-accent, var(--hops-orange)); + color: #fff; &:hover:not(:disabled) { - background: var(--hops-orange-light); - transform: translateY(-3px); - box-shadow: 0 12px 40px rgba(230, 154, 45, 0.45); - } - - &:active:not(:disabled) { - transform: translateY(-1px); - } - - /* Motion streak on hover */ - &::after { - content: ''; - position: absolute; - top: 50%; - left: -100%; - width: 60px; - height: 3px; - background: linear-gradient(90deg, transparent, rgba(255,255,255,0.8), transparent); - transform: translateY(-50%) skewX(-20deg); - transition: left 0.5s var(--ease-out-expo); - } - - &:hover:not(:disabled)::after { - left: 120%; + background: var(--hops-orange-light, #5a7a9e); } } /* Secondary variant */ .button-secondary { - background: var(--hops-navy); - color: var(--hops-text-inverse); + background: var(--wf-ink, var(--hops-navy)); + color: var(--wf-bg, #f6f5f2); &:hover:not(:disabled) { - background: var(--hops-navy-light); - transform: translateY(-3px); + background: var(--hops-navy-light, #2a2a28); } } /* Outlined variant */ .button-outlined { background: transparent; - border: 2px solid var(--hops-navy); - color: var(--hops-navy); + border: 1px solid var(--wf-line-strong, var(--hops-navy)); + color: var(--wf-ink, var(--hops-navy)); &:hover:not(:disabled) { - background: var(--hops-navy); - color: var(--hops-text-inverse); - transform: translateY(-3px); + background: var(--wf-ink, var(--hops-navy)); + border-color: var(--wf-ink, var(--hops-navy)); + color: var(--wf-bg, #f6f5f2); } /* Light mode for dark backgrounds */ &.light { - border-color: rgba(255,255,255,0.5); - color: var(--hops-text-inverse); + border-color: rgba(255, 255, 255, 0.45); + color: var(--hops-text-inverse, #f6f5f2); &:hover:not(:disabled) { - background: rgba(255,255,255,0.15); - border-color: rgba(255,255,255,0.8); + background: rgba(255, 255, 255, 0.12); + border-color: rgba(255, 255, 255, 0.75); + color: var(--hops-text-inverse, #f6f5f2); } } } @@ -170,7 +144,7 @@ /* Touch target for mobile */ @media (--mobile) { .button { - min-height: 48px; + min-height: 44px; } } diff --git a/tests/e2e-ui/ui/src/lib/components/shared/ui/SimplePage.svelte b/tests/e2e-ui/ui/src/lib/components/shared/ui/SimplePage.svelte index abcfbf0d..5b6a5fe2 100644 --- a/tests/e2e-ui/ui/src/lib/components/shared/ui/SimplePage.svelte +++ b/tests/e2e-ui/ui/src/lib/components/shared/ui/SimplePage.svelte @@ -33,7 +33,7 @@ .simple-page { padding: 7rem 0 4rem; min-height: 100vh; - background: var(--hops-bg-light); + background: var(--wf-bg, var(--hops-bg-light)); } .simple-page-container { @@ -65,25 +65,26 @@ /* Typography defaults for simple pages */ .simple-page-container :global(h1) { - font-family: var(--font-display); - font-size: clamp(2rem, 5vw, 3rem); - font-weight: 800; - color: var(--hops-navy); - margin-bottom: 1rem; + font-family: var(--wf-serif, var(--font-display)); + font-size: clamp(1.65rem, 4vw, 2.15rem); + font-weight: 500; + letter-spacing: -0.02em; + color: var(--wf-ink, var(--hops-navy)); + margin-bottom: 0.85rem; } .simple-page-container :global(p) { - font-size: 1.125rem; - color: var(--hops-text-secondary); - margin-bottom: 2rem; + font-size: 1.02rem; + color: var(--wf-ink-soft, var(--hops-text-secondary)); + margin-bottom: 1.75rem; } .simple-page-container :global(code) { - font-family: var(--font-mono); - font-size: 0.9em; - background: var(--hops-navy); - color: var(--hops-orange-light); - padding: 0.2em 0.5em; + font-family: var(--wf-mono, var(--font-mono)); + font-size: 0.88em; + background: var(--wf-accent-soft, rgba(61, 90, 128, 0.08)); + color: var(--wf-ink, #1c1c1a); + padding: 0.15em 0.4em; border-radius: 4px; } diff --git a/tests/e2e-ui/ui/src/lib/gql/command-policies.ts b/tests/e2e-ui/ui/src/lib/gql/command-policies.ts index d544f137..e9307719 100644 --- a/tests/e2e-ui/ui/src/lib/gql/command-policies.ts +++ b/tests/e2e-ui/ui/src/lib/gql/command-policies.ts @@ -1,38 +1,10 @@ /** - * Default command result/reconcile policies for e2e-ui. - * Async projectors → fact + reconcile none (no immediate refetch). - * Call sites override with optimistic / onError only. + * Command pipeline policies for e2e-ui. + * + * **Source of truth:** Rust `exposed_command().client_reconcile(...)` in + * `e2e_service::graphql_commands()`, exported via `commands.manifest.json`, + * generated into `commands.policies.generated.ts` by `make gen-commands`. + * + * Do not hand-edit the generated file — change the Rust registry instead. */ -import type { CommandPolicyMap } from './bind-commands-pipeline.ts'; - -/** Shared defaults for todos + chat (async projector topology). */ -export const e2eCommandPolicies: CommandPolicyMap = { - todosCreate: { - result: { kind: 'fact' }, - reconcile: { kind: 'none' } - }, - todosComplete: { - result: { kind: 'fact' }, - reconcile: { kind: 'none' } - }, - todosArchive: { - result: { kind: 'fact' }, - reconcile: { kind: 'none' } - }, - todosForceArchive: { - result: { kind: 'fact' }, - reconcile: { kind: 'none' } - }, - todosRename: { - result: { kind: 'fact' }, - reconcile: { kind: 'none' } - }, - todosReopen: { - result: { kind: 'fact' }, - reconcile: { kind: 'none' } - }, - chatMessagesPost: { - result: { kind: 'fact' }, - reconcile: { kind: 'subscription' } - } -}; +export { e2eCommandPolicies } from '../api/commands.policies.generated.ts'; diff --git a/tests/e2e-ui/ui/src/lib/gql/generated/types.ts b/tests/e2e-ui/ui/src/lib/gql/generated/types.ts index da034c8a..5c9dede0 100644 --- a/tests/e2e-ui/ui/src/lib/gql/generated/types.ts +++ b/tests/e2e-ui/ui/src/lib/gql/generated/types.ts @@ -72,7 +72,7 @@ export type BlobGameView = { current_level_completed: Scalars['Boolean']['output']; game_id: Scalars['String']['output']; map_json: Scalars['String']['output']; - owner?: Maybe; + owner: AuthUserView; owner_id: Scalars['String']['output']; player_dead: Scalars['Boolean']['output']; score: Scalars['BigInt']['output']; @@ -106,7 +106,7 @@ export type Boolean_Comparison_Exp = { export type ChatMessageView = { __typename?: 'ChatMessageView'; - author?: Maybe; + author: AuthUserView; author_id: Scalars['String']['output']; body: Scalars['String']['output']; created_at: Scalars['String']['output']; diff --git a/tests/e2e-ui/ui/src/routes/+page.svelte b/tests/e2e-ui/ui/src/routes/+page.svelte index 18a35f7f..4c681214 100644 --- a/tests/e2e-ui/ui/src/routes/+page.svelte +++ b/tests/e2e-ui/ui/src/routes/+page.svelte @@ -1,8 +1,8 @@
-
{#if authConfigError} @@ -385,20 +490,23 @@ subscription { {/if} Distributed · e2e-ui template

- A framework template you run as full e2e tests — kept honest by the library. + A framework template you run as full e2e tests — a map you can learn from.

- Multi-crate CQRS, GraphQL with row-level filters, WebSocket subscriptions, real OIDC. The - same folder is the living suite — make test offline, - make test-live against Postgres + Zitadel. + Simplest DX is the goal. You should not re-implement event history, + repositories, and GraphQL wiring for every feature. Distributed carries that weight so you + can focus on domain rules and a clear UI. This folder is a living suite you can click + through and copy — sign-in, personal lists, live chat, a game with strong command returns — + proved by make test offline and make test-live with real OIDC.

{#if signedIn} Open todos - Lobby chat + Blob game + Framework principles {:else} Sign in with OIDC - Unidirectional story + Framework principles {/if}
@@ -407,46 +515,228 @@ subscription { UI :5180 Zitadel :18080
+
-
Why this exists

Template first. Product later.

- Not a product marketing site — the UI face of a fixture that ships with Distributed. When - patterns change, the suite and this app move with them. + This is not a product marketing site. It is the face of a fixture that ships with + Distributed — so when the library’s recommended patterns change, you can see and test them + here. Copy the folder when you start a service; keep the boundaries that keep you sane.

-

Full e2e path

+

Something you can actually run

- make up boots Postgres + Zitadel. make run serves API + UI. - Humans alice/bob for login; machine keys for suite JWT-bearer. + make up starts the database and identity provider. + make run starts API and UI. Log in as alice, bob, or admin and click + around.

-

Updated with the library

+

Kept honest by tests

- Behavioral + gated OIDC tests live beside the service. Offline SQLite or live stack. - OidcBearer, projectors, ChangeHub track framework defaults. + The same folder has behavioral tests and gated OIDC checks. Offline for day-to-day; + live stack when you need the real token path. The demos are not slides — they break if + the library lies.

-

Copy and extend

+

A map you can extend

- todo-domain, chat-domain, readmodels, service, runner, suite. Swap DATABASE_URL / OIDC - env; keep handlers and routes as the map. + Domain crates, read models, thin handlers, suite, Svelte UI. Point env at your database + and IdP when you are ready; the shape of “command → history → query” stays the same.

+
+
+
+ Distributed · framework principles +

What we are optimizing for

+

+ Distributed is a CQRS and event-sourcing framework for Rust people who still want to ship. + The north star is not “more infrastructure.” It is the + simplest developer experience that keeps write history, queries, and + published messages honest — so you can grow later without rewriting the domain you already + proved. +

+
+
    + {#each frameworkPrinciples as p, i} +
  1. + +
    +

    {p.title}

    +

    {p.body}

    +
    +
    2. + {/each} +
+ +
+ How DX stays simple +

Three ways the stack carries weight for you

+

+ You should not re-implement “save history,” “sync three schemas,” or “build a mini + framework” for every feature. Three layers share that work. You write intent; the stack + expands it. +

+
+
+ {#each dxStack as col, i} +
+ +

{col.title}

+

{col.body}

+
+ {/each} +
+ +
+ When you are ready for the code +

Domain first — macros fill the seams

+

+ Below is what “plain domain + less noise” looks like in this fixture. Read the method + bodies as the product rules; the attributes are how history gets recorded and replayed + without you writing that plumbing twice. +

+
+
+
+
+ todo-domain · models/todo.rs + one command, one function +
+ 
{`// One function. #[event] records history and applies state.
+// when = skips the command when it must not fire (wrong owner / not open).
+#[event("todo.completed", when = self.owner_id == owner_id && self.is_open())]
+pub fn complete(&mut self, owner_id: String) {
+  self.status = TodoStatus::Completed;
+}
+// Unit tests call complete() directly — red/green before any handler exists.`}
+
+
+
+ e2e-readmodels · TodoView + #[derive(ReadModel)] +
+ 
{`#[derive(Clone, Debug, Default, Serialize, Deserialize, ReadModel)]
+#[table("todos")]
+pub struct TodoView {
+  #[id("todo_id")]
+  pub todo_id: String,
+  pub owner_id: String,
+  pub title: String,
+  pub status: String,
+}
+// GraphQL can list and filter this table — you did not hand-write resolvers.`}
+
+
+
+ handlers · command input + GraphqlInput +
+ 
{`#[derive(Debug, Deserialize, distributed::GraphqlInput)]
+pub struct TodoCompleteInput {
+  pub todo_id: String,
+}
+// Same type for GraphQL input and the handler. Register once; codegen follows.`}
+
+
+ +
+ Patterns you already know +

Short verbs you can swap under the hood

+

+ You do not need a new vocabulary for every service. Load something from history, apply a + command, save events and “please publish this,” turn events into query rows, expose + handlers. Same ideas as textbooks — thin APIs, backends you can change later. +

+
+
+
+
+ Load → decide → save history + repository +
+ 
{`// Load from event history (not from a mutable "current row" only)
+let mut todo = ctx.repo().get(todo_id).await?
+  .ok_or_else(|| HandlerError::NotFound(todo_id.into()))?;
+
+todo.complete(&owner)?; // domain rules only
+
+// One commit: new events + "please publish this fact"
+let fact = TodoFact::from_todo(&todo);
+let outbox = OutboxMessage::encode(
+  format!("{}:todo.completed:{}", todo.todo_id, todo.entity.version()),
+  "todo.completed",
+  &fact,
+)?;
+ctx.repo().outbox(outbox).commit(&mut todo).await?;
+// Memory, SQLite, or Postgres — same handler shape.`}
+
+
+
+ Turn a fact into something you can query + projection +
+ 
{`// After (or with) the event: upsert a row shaped for reads
+let row = map_todo_fact(&fact);
+let mut plan = ReadModelWritePlanBuilder::new();
+plan.upsert(&row)?;
+plan.commit(ctx.read_model_store()).await?;
+// Same idea for "eventually" (projector) and "right now" (blob).`}
+
+
+
+ One handler, many doors + service +
+ 
{`// This fixture exposes commands over GraphQL only (no raw POST /todo.*)
+Service::new()
+  .named("e2e-ui")
+  .without_http_command_routes()
+  // … register handlers + readable models …
+// Later you can also hang the same work off a bus or gRPC
+// without rewriting Todo::complete.`}
+
+
+ +
+ A calm order of work +

Prove the domain before the plumbing

+
+
    +
  1. Write tests for what the model should allow and refuse
    2. +
  2. Implement the plain type until those tests pass
    3. +
  3. Add a thin handler: who is calling → load → domain → save history
    4. +
  4. Project into query tables (or same-request for strong UX)
    5. +
  5. Expose reads and commands with the right permissions
    6. +
  6. Regenerate the client helpers and wire a small UI path
    7. +
  7. Swap storage or messaging when you outgrow the laptop setup
    8. +
+
+
+
@@ -454,7 +744,8 @@ subscription {

Three commands. Full stack.

From tests/e2e-ui. Demo password: Password1! (alice / bob / - admin). + admin). After make up, always restart make run so the process + picks up e2e-ui.env.

@@ -464,11 +755,44 @@ subscription {

API + UI

-

make run — GraphQL :8791, SvelteKit :5180.

+

+ set -a && source e2e-ui.env && set +a && make run — GraphQL :8791, + SvelteKit :5180. +

Prove it

-

make test · make test-live.

+

+ make test · make test-live · + make check-gql && make check-commands +

+
+
+
+ Two ways the API knows who you are +

Pick the profile that matches how you started the process

+
+
+
+

Local tests (headers)

+

+ When OIDC env is unset, the suite can send simple identity headers. Fast offline + behavioral tests — that is what make test expects. +

+
+
+

Real login (Bearer tokens)

+

+ After make up and sourcing env, the API wants real tokens. Browser sessions + and make test-live use this path. Ambient “I am alice” headers are ignored. +

+
+
+

Do not mix them

+

+ Hitting an OIDC-only process with header-style tests looks like a wall of 401s. That is + usually the wrong profile — not a broken product. +

@@ -478,8 +802,12 @@ subscription {
Live demos -

What is demonstrated — and where

-

Open after make up && make run.

+

Practice arenas, not slides

+

+ After make up && make run, sign in and click. Each route is a small story about + one way the stack behaves — personal data, live rooms, strong returns, admin power, + identity. +

{#each demos as d, i} @@ -497,73 +825,385 @@ subscription {
-
+
- Todos · unidirectional system -

What this is demonstrating

+ Architecture +

One direction — with two ways to “see the result”

- A single feature path from login to live reads — one direction only. Each step below is - grounded in this fixture’s real files. + The UI never “updates the todos table” as if GraphQL were a database. It asks for work + (commands) and reads query-shaped data (lists, joins). Most features let query data catch + up a moment later; the game can return the full board in the same request on purpose. +

+
+
+
+ Mental model + system +
+ 
{`You (browser)
+  Sign in → cookie with access token
+  Load pages with GraphQL (Bearer)
+  Live rooms over WebSocket (token in first message)
+
+Service
+  Knows who you are and which role you have
+  Commands: change domain history (+ optional “publish this”)
+       ├─ todos / chat: project into query tables shortly after  (eventual)
+       └─ blob:         also write query row before responding   (strong)
+  Queries / live updates: filtered by who you are
+  People directory imported from Zitadel for display names`}
+
+
+ Crate map +

Where to look when you open the folder

+
+
+ {#each crates as c} +
+
{c.name}
+
{c.role}
+
+ {/each} +
+
+
+ +
+
+
+ Template success rules +

Habits that keep this demo (and your copy of it) healthy

+

+ The principles above are Distributed as a whole. These are the extra habits + this fixture teaches for GraphQL, sign-in, and the Svelte client. Follow + them and the demos feel calm; fight them and you spend the day on thrash and spoofing. +

+
+
    + {#each principles as p, i} +
  1. + +
    +

    {p.title}

    +

    {p.body}

    +
    +
    2. + {/each} +
+
+
+ +
+
+
+ Client GraphQL DX +

How the browser is supposed to feel

+

+ You should not wire a new HTTP client per page. Bind once from the page’s session, seed + lists so the first paint matches the server, open a live room when you need push, and call + typed commands that update the same cache the list already uses. Query documents live next + to the route; commands are generated from the server so you do not hand-copy mutation + strings forever.

    -
  1. Login (Zitadel + Auth.js session)
    2. -
  2. SSR GraphQL query + RBAC + Bearer
    3. -
  3. Hydrate client = SSR HTML
    4. -
  4. Optional: subscription on the same fields
    5. -
  5. Command (not RM mutation) + RBAC
    6. -
  6. Handler → aggregate → domain event
    7. -
  7. Projector → read model
    8. -
  8. Queries & subscriptions observe
    9. +
  9. Bind the page from session data once
    10. +
  10. Seed lists so SSR HTML and client state match
    11. +
  11. Use a live subscription for rooms that must push
    12. +
  12. Write through typed commands + optimistic rows
    13. +
  13. Share the same query document between server and browser
    14. +
  14. One cache for a list — not a second parallel array
+ +
+ {#each clientSteps as step} +
+
+ Client {step.n} +

{step.title}

+

{step.why}

+ {step.path} +
+
+ {#each step.blocks as block} +
+
+ {block.file} + {block.label} +
+ 
{block.code}
+
+ {/each} +
+
+ {/each} +
+
+
+ +
+
+
+ When should the answer be “now”? +

Two honest styles — pick per feature

+

+ Not every screen needs the same consistency story. This fixture shows both on purpose so + you can feel the tradeoff instead of arguing in the abstract. +

+
+
+
+ Strong +

Blob — the board is the truth of the response

+

+ After a move, the mutation comes back with the full board. Waiting on a background + projector would feel like lag. The UI keeps one cache for board and history so they + cannot disagree. +

+
+
+ Eventual +

Todos — feel instant, settle a moment later

+

+ Completing a note can paint as done immediately. The server still records history first; + the query table catches up shortly. A soft refresh lines the cache up with the + projector without fighting the optimistic row. +

+
+
+ Eventual + live +

Chat — other people are the clock

+

+ Your post can show immediately; everyone else’s posts arrive over a live subscription. + That open connection is how the room converges — not a frantic poll loop. +

+
+
- - {#each steps as step, i} -
-
-
- Step {step.n} -

{step.title}

-

{step.why}

- {step.path} -
-
- {#each step.blocks as block} -
-
- {block.file} - {block.label} -
- 
{block.code}
+
+
+
+ Server path +

From “I signed in” to “I can see my data”

+

+ Walk this when you are implementing a new feature. The client steps above are how the UI + consumes the same loop. +

+
+
    +
  1. Person signs in; session holds a token
    2. +
  2. Page load queries with that token (only their rows)
    3. +
  3. UI sends a command, not a free-form table update
    4. +
  4. Handler loads history, applies domain rules, saves events
    5. +
  5. Query tables update eventually — or immediately for strong UX
    6. +
  6. Display names join from the identity directory
    7. +
  7. Queries and live rooms show the new world
    8. +
+ +
+ {#each serverSteps as step} +
+
+ Server {step.n} +

{step.title}

+

{step.why}

+ {step.path} +
+
+ {#each step.blocks as block} +
+
+ {block.file} + {block.label} +
+ 
{block.code}
+
+ {/each}
- {/each} +
+ {/each} +
+
+
+ +
+
+
+ Keeping the UI honest +

Regenerate so humans do not dual-maintain contracts

+

+ The GraphQL the browser sees should come from the same engine the API runs — including + which mutations exist for which role. When you change a command or a query document, + regenerate. Drift should fail a check, not surprise you in production. +

+
+
+
+

Readable schema for each role

+

+ Export what a normal user may call vs what an admin may call. After you edit + co-located query files, regenerate typed documents so the UI and the engine agree. +

+
+
+

Commands as functions, not copy-paste

+

+ Register the command on the server once. Generation gives the UI typed helpers and + default “how do we catch up?” policies so screens do not invent their own. +

+
+
+

After you change the contract

+

+ Run the check targets, commit the generated files, move on. Do not hand-edit generated + artifacts as if they were source — the next regeneration will fight you. +

+
+
+
+
+ What a day-to-day write looks like + UI +
+ 
{`const gql = useGraphql(() => data);
+await gql.commands.todosCreate({ todo_id, title });
+await gql.commands.todosReopen({ todo_id });
+await gql.commands.chatMessagesPost({ message_id, body, room_id });
+await gql.commands.blobGamesMove({ game_id, direction: 'up' });
+// Only when signed in as admin:
+await gql.commands.todosForceArchive({ todo_id });`}
+
+
+
+ +
+
+
+ People have names +

Import identity once, join everywhere

+

+ Do not stamp a free-form display name onto every chat message forever. Import people from + the IdP into a directory table, then join. Fix missing people at the source (ingest / + scrape), not by inventing a second source of truth on each aggregate. +

+
+
+
+

Bring users in

+

+ Zitadel can push or you can scrape; either way facts land as directory rows. See + docs/zitadel-ingestor.md when you need the exact endpoints. +

+
+
+

Join for labels

+

+ Chat shows an author; blob can show an owner. Those are relationships to the directory + — so a rename or status change does not require rewriting history. +

+
+
+

Roles in practice

+

+ alice and bob are normal users (their own todos). admin sees everyone and can + force-archive. Groups on the session map into those engine roles. +

+
+
+
+
+ +
+
+
+ Traps +

Things that feel clever and then hurt

+
+
+
+

GraphQL as a free-form table editor

+

+ If the UI can UPDATE the todos table directly, you have two write paths and no single + history. Prefer commands that go through the domain. +

+
+
+

Two lists for the same data

+

+ A local array “for convenience” plus the shared cache for the same list is how board + and history disagree. One document store per list. +

+
+
+

Hard refetch that yanks the optimistic UI

+

+ Blasting a full reload the instant a command returns can flash, reorder, or erase the + row you just painted. Optimistic patch, then soft catch-up or a live room. +

+
+
+

Believing the client about who they are

+

+ Owner and author come from the session. Client-supplied “I am alice” fields are how + multi-tenant bugs are born. +

+
+
+

Hand-editing generated files

+

+ Change the real source (Rust registry or co-located query), regenerate, commit. CI + checks exist so drift does not wait for a human on-call. +

+
+
+

Tokens in the wrong place on WebSockets

+

+ Browsers cannot set Authorization on the upgrade the way they do on HTTP. Put the + token in the first connection message — never in a long-lived URL query string. +

-
- {/each} +
+
+ +
+
+
+ Extend the template +

Adding a feature without losing the plot

+
+
    +
  1. Model the rules in a pure domain crate with tests
    2. +
  2. Describe how those facts look when queried (and any joins)
    3. +
  3. Thin command handler + register it with a catch-up policy
    4. +
  4. Projector — unless you deliberately write the query row in-request
    5. +
  5. Permissions: who may read which rows
    6. +
  6. Regenerate client helpers and schemas
    7. +
  7. Small UI path: seed, command, optimistic update
    8. +
  8. A test that would fail if you regressed the story
    9. +
+
+
-
-

Exercise the live demos

+

Go click around

- Sign in (alice / bob / admin · Password1!), open todos or chat, then inspect the session. + Sign in (alice / bob / admin · Password1!). Feel todos settle after a moment, blob answer + immediately, chat fill from others, admin see everyone, session explain who you are.

{#if signedIn} Todos + Blob Chat Session {:else} Sign in - Session + Success rules {/if}
diff --git a/tests/e2e-ui/ui/src/routes/admin/+page.server.ts b/tests/e2e-ui/ui/src/routes/admin/+page.server.ts index c8e751e0..f391f275 100644 --- a/tests/e2e-ui/ui/src/routes/admin/+page.server.ts +++ b/tests/e2e-ui/ui/src/routes/admin/+page.server.ts @@ -1,7 +1,7 @@ import { error } from '@sveltejs/kit'; import { loadQuery } from '$lib/gql/load-query.server'; import { engineRoleFromGroups, isAdminEngineRole } from '$lib/roles'; -import { adminTodos } from './admin.resource'; +import { adminTodos, sortAdminTodos } from './admin.resource'; import type { AdminAllTodosData } from './admin.resource'; import type { PageServerLoad } from './$types'; @@ -20,7 +20,7 @@ export const load: PageServerLoad = async (event) => { const seeded = await loadQuery( adminTodos.query, (data) => ({ - todos: data?.todos ?? [] + todos: sortAdminTodos(data?.todos ?? []) }) )(event); diff --git a/tests/e2e-ui/ui/src/routes/admin/+page.svelte b/tests/e2e-ui/ui/src/routes/admin/+page.svelte index 6b031b3e..2f99e12a 100644 --- a/tests/e2e-ui/ui/src/routes/admin/+page.svelte +++ b/tests/e2e-ui/ui/src/routes/admin/+page.svelte @@ -5,7 +5,7 @@ import { onDestroy } from 'svelte'; import { useGraphql, fx } from '$lib/gql'; import { sessionDisplayName } from '$lib/session'; - import { adminTodos } from './admin.resource'; + import { adminTodos, sortAdminTodos } from './admin.resource'; import type { AdminTodoRow } from './admin.resource'; let { data } = $props(); @@ -27,12 +27,12 @@ const list = gql.store({ document: adminTodos.query, list: { at: 'todos', by: 'todo_id' }, - initialData: { todos: data.todos ?? [] }, - select: (d: { todos?: AdminTodoRow[] }) => d?.todos ?? [] + initialData: { todos: sortAdminTodos(data.todos ?? []) }, + select: (d: { todos?: AdminTodoRow[] }) => sortAdminTodos(d?.todos ?? []) }); $effect(() => { - list.seed({ todos: data.todos ?? [] }); + list.seed({ todos: sortAdminTodos(data.todos ?? []) }); }); onDestroy(() => list.destroy()); @@ -172,12 +172,14 @@ diff --git a/tests/e2e-ui/ui/src/routes/admin/admin.generated.ts b/tests/e2e-ui/ui/src/routes/admin/admin.generated.ts index bb63f629..632f4d6e 100644 --- a/tests/e2e-ui/ui/src/routes/admin/admin.generated.ts +++ b/tests/e2e-ui/ui/src/routes/admin/admin.generated.ts @@ -11,4 +11,4 @@ export type AdminAllTodosQueryVariables = Exact<{ [key: string]: never; }>; export type AdminAllTodosQuery = { todos: Array<{ todo_id: string, owner_id: string, title: string, status: string }> }; -export const AdminAllTodosDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"AdminAllTodos"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todos"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"limit"},"value":{"kind":"IntValue","value":"100"}},{"kind":"Argument","name":{"kind":"Name","value":"order_by"},"value":{"kind":"ListValue","values":[{"kind":"ObjectValue","fields":[{"kind":"ObjectField","name":{"kind":"Name","value":"todo_id"},"value":{"kind":"EnumValue","value":"asc"}}]}]}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todo_id"}},{"kind":"Field","name":{"kind":"Name","value":"owner_id"}},{"kind":"Field","name":{"kind":"Name","value":"title"}},{"kind":"Field","name":{"kind":"Name","value":"status"}}]}}]}}]} as unknown as DocumentNode; \ No newline at end of file +export const AdminAllTodosDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"AdminAllTodos"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todos"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"limit"},"value":{"kind":"IntValue","value":"100"}},{"kind":"Argument","name":{"kind":"Name","value":"order_by"},"value":{"kind":"ListValue","values":[{"kind":"ObjectValue","fields":[{"kind":"ObjectField","name":{"kind":"Name","value":"status"},"value":{"kind":"EnumValue","value":"asc"}}]},{"kind":"ObjectValue","fields":[{"kind":"ObjectField","name":{"kind":"Name","value":"owner_id"},"value":{"kind":"EnumValue","value":"asc"}}]},{"kind":"ObjectValue","fields":[{"kind":"ObjectField","name":{"kind":"Name","value":"todo_id"},"value":{"kind":"EnumValue","value":"asc"}}]}]}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"todo_id"}},{"kind":"Field","name":{"kind":"Name","value":"owner_id"}},{"kind":"Field","name":{"kind":"Name","value":"title"}},{"kind":"Field","name":{"kind":"Name","value":"status"}}]}}]}}]} as unknown as DocumentNode; \ No newline at end of file diff --git a/tests/e2e-ui/ui/src/routes/admin/admin.gql b/tests/e2e-ui/ui/src/routes/admin/admin.gql index 1121229c..ab7e0ff2 100644 --- a/tests/e2e-ui/ui/src/routes/admin/admin.gql +++ b/tests/e2e-ui/ui/src/routes/admin/admin.gql @@ -4,7 +4,8 @@ # Force-archive mutation: `$lib/api/commands.operations.gql` (generated). query AdminAllTodos { - todos(limit: 100, order_by: [{ todo_id: asc }]) { + # Deterministic: status buckets then owner then id + todos(limit: 100, order_by: [{ status: asc }, { owner_id: asc }, { todo_id: asc }]) { todo_id owner_id title diff --git a/tests/e2e-ui/ui/src/routes/admin/admin.resource.ts b/tests/e2e-ui/ui/src/routes/admin/admin.resource.ts index 26d9ec0f..ee239802 100644 --- a/tests/e2e-ui/ui/src/routes/admin/admin.resource.ts +++ b/tests/e2e-ui/ui/src/routes/admin/admin.resource.ts @@ -8,7 +8,30 @@ import { AdminAllTodosDocument, type AdminAllTodosQuery } from './admin.generate export type AdminTodoRow = AdminAllTodosQuery['todos'][number]; export type AdminAllTodosData = AdminAllTodosQuery; +/** open → completed → archived, then owner_id, then todo_id (stable). */ +export function sortAdminTodos(list: AdminTodoRow[]): AdminTodoRow[] { + const rank = (s: string) => { + switch (s) { + case 'open': + return 0; + case 'completed': + return 1; + case 'archived': + return 2; + default: + return 3; + } + }; + return [...list].sort((a, b) => { + const byStatus = rank(a.status) - rank(b.status); + if (byStatus !== 0) return byStatus; + if (a.owner_id !== b.owner_id) return a.owner_id < b.owner_id ? -1 : 1; + return a.todo_id < b.todo_id ? -1 : a.todo_id > b.todo_id ? 1 : 0; + }); +} + export const adminTodos = defineResource({ query: AdminAllTodosDocument, - select: (data) => data.todos + select: (data) => sortAdminTodos(data.todos ?? []) }); + diff --git a/tests/e2e-ui/ui/src/routes/blob/+page.server.ts b/tests/e2e-ui/ui/src/routes/blob/[[gameId]]/+page.server.ts similarity index 100% rename from tests/e2e-ui/ui/src/routes/blob/+page.server.ts rename to tests/e2e-ui/ui/src/routes/blob/[[gameId]]/+page.server.ts diff --git a/tests/e2e-ui/ui/src/routes/blob/+page.svelte b/tests/e2e-ui/ui/src/routes/blob/[[gameId]]/+page.svelte similarity index 77% rename from tests/e2e-ui/ui/src/routes/blob/+page.svelte rename to tests/e2e-ui/ui/src/routes/blob/[[gameId]]/+page.svelte index ca3a0c35..17ee29c8 100644 --- a/tests/e2e-ui/ui/src/routes/blob/+page.svelte +++ b/tests/e2e-ui/ui/src/routes/blob/[[gameId]]/+page.svelte @@ -1,14 +1,18 @@