@reventlessdev/reventless-aws 3.0.0-alpha.302 → 3.0.0-alpha.304

package/src/adapter/StateTopic/StateTopic_AppSync.res

@@ -92,6 +92,10 @@ type streamEntry = {
   tableName: Pulumi.Output.t<string>,
   streamArn: Pulumi.Output.t<string>,
   topicName: string,
+  // The read model's `@retired` field, resolved at deploy time because the relay
+  // Lambda has no plugin registry in process to resolve it at request time.
+  retiredField: option<string>,
+  retiredValues: option<array<string>>,
 }
 
 // One registry per events API, keyed by `eventsApi.name` (the static Pulumi
@@ -134,6 +138,8 @@ let makeForTable = (
   ~streamArn: Pulumi.Output.t<string>,
   ~partitionKeyName: Pulumi.Output.t<string>,
   ~topicName: string,
+  ~retiredField: option<string>=?,
+  ~retiredValues: option<array<string>>=?,
   ~eventsApi: AppSync_EventsApi.t,
   ~opts as _: Pulumi.CustomResourceOptions.t,
 ) => {
@@ -150,7 +156,12 @@ let makeForTable = (
 
   let key = eventsApi.name
   let entries = registry->Dict.get(key)->Option.getOr([])
-  registry->Dict.set(key, entries->Array.concat([{tableName: checkedTableName, streamArn, topicName}]))
+  registry->Dict.set(
+    key,
+    entries->Array.concat([
+      {tableName: checkedTableName, streamArn, topicName, retiredField, retiredValues},
+    ]),
+  )
 }
 
 let make = (
@@ -176,6 +187,18 @@ let make = (
     // `makeForTable` and can be keyed anything.
     ~partitionKeyName=StateTopic_AppSync_Helpers.entityKeyPartitionAttribute->Pulumi.Output.make,
     ~topicName,
+    // Resolved here, where the read model's name is known and its spec is
+    // registered in this process. The relay Lambda has neither.
+    ~retiredField=?ReventlessCore.Plugin_Helpers.stateSchemaRegistry
+    ->Dict.get(readModelName)
+    ->Option.flatMap(Reventless.StateAnnotations.getSpec)
+    ->Option.flatMap(spec => spec.retired)
+    ->Option.map(r => r.field),
+    ~retiredValues=?ReventlessCore.Plugin_Helpers.stateSchemaRegistry
+    ->Dict.get(readModelName)
+    ->Option.flatMap(Reventless.StateAnnotations.getSpec)
+    ->Option.flatMap(spec => spec.retired)
+    ->Option.flatMap(r => r.values),
     ~eventsApi,
     ~opts,
   )
@@ -270,6 +293,30 @@ let finish = (
         dict->JSON.Encode.object->JSON.stringify
       })
 
+    // STATE_RETIRED_MAP env var — `{ <tableName>: {field, values?} }`, carrying
+    // only the tables that declare retirement. Built from the same awaited table
+    // names as the topic map so the two cannot describe different sets of tables.
+    // The whole predicate travels: the relay Lambda has no plugin registry, so a
+    // field without its states would leave it unable to tell the two forms apart.
+    let retiredMapJson =
+      entries
+      ->Array.map(e => e.tableName)
+      ->Pulumi.Output.all
+      ->Pulumi.Output.apply(tableNames => {
+        let dict = Dict.make()
+        tableNames->Array.forEachWithIndex((tableName, i) => {
+          let entry = entries->Array.getUnsafe(i)
+          entry.retiredField->Option.forEach(f => {
+            let obj = Dict.fromArray([("field", f->JSON.Encode.string)])
+            entry.retiredValues->Option.forEach(vs =>
+              obj->Dict.set("values", vs->Array.map(JSON.Encode.string)->JSON.Encode.array)
+            )
+            dict->Dict.set(tableName, obj->JSON.Encode.object)
+          })
+        })
+        dict->JSON.Encode.object->JSON.stringify
+      })
+
     // Shared Lambda — the compiled `_Ops` handler is identical for every
     // stream-enabled RM; routing is per-record via STATE_TOPIC_MAP env var.
     // Bundle reventless-aws (the handler + its node:crypto signer + the
@@ -325,6 +372,7 @@ let finish = (
               ("Environment", Pulumi.Pulumi.getStackName()->Pulumi.Input.make),
               ("APPSYNC_ENDPOINT", appsyncEndpoint->Pulumi.Output.asInput),
               ("STATE_TOPIC_MAP", topicMapJson->Pulumi.Output.asInput),
+              ("STATE_RETIRED_MAP", retiredMapJson->Pulumi.Output.asInput),
               ("NODE_OPTIONS", Util_Bundle.esmLoaderNodeOptions->Pulumi.Input.make),
               ("ESM_FALLBACK_DIRS", Util_Bundle.esmFallbackDirs->Pulumi.Input.make),
               Util_LambdaLogging.logLevelEntry(),

package/src/adapter/StateTopic/StateTopic_AppSync.res.mjs

@@ -10,6 +10,8 @@ import * as AWS_Tags$ReventlessAws from "../AWS_Tags.res.mjs";
 import * as QueryDb$ReventlessCore from "@reventlessdev/reventless-core/src/components/QueryDb/QueryDb.res.mjs";
 import * as PolicyDocument$PulumiAws from "@reventlessdev/rescript-pulumi-aws/src/IAM/PolicyDocument.res.mjs";
 import * as Util_Bundle$ReventlessAws from "../../util/Util_Bundle.res.mjs";
+import * as StateAnnotations$Reventless from "@reventlessdev/reventless-spec/src/components/StateAnnotations.res.mjs";
+import * as Plugin_Helpers$ReventlessCore from "@reventlessdev/reventless-core/src/plugin/component/Plugin_Helpers.res.mjs";
 import * as Util_ReadModel$ReventlessCore from "@reventlessdev/reventless-core/src/util/Util_ReadModel.res.mjs";
 import * as AppSync_EventsApi$ReventlessAws from "../Api/AppSync_EventsApi.res.mjs";
 import * as Util_LambdaLogging$ReventlessAws from "../../util/Util_LambdaLogging.res.mjs";
@@ -18,7 +20,7 @@ import * as StateTopic_AppSync_Helpers$ReventlessAws from "./StateTopic_AppSync_
 
 let registry = {};
 
-function makeForTable(tableName, streamArn, partitionKeyName, topicName, eventsApi, param) {
+function makeForTable(tableName, streamArn, partitionKeyName, topicName, retiredField, retiredValues, eventsApi, param) {
   let checkedTableName = Pulumi.all([
     tableName,
     partitionKeyName
@@ -32,13 +34,15 @@ function makeForTable(tableName, streamArn, partitionKeyName, topicName, eventsA
   registry[key] = entries.concat([{
       tableName: checkedTableName,
       streamArn: streamArn,
-      topicName: topicName
+      topicName: topicName,
+      retiredField: retiredField,
+      retiredValues: retiredValues
     }]);
 }
 
 function make(readModelName, topicName, allQueryDbs, eventsApi, opts) {
   let streamResource = Util_DynamoDbStream$ReventlessAws.findResource(Util_ReadModel$ReventlessCore.queryDbStorageResources(allQueryDbs, readModelName));
-  makeForTable(streamResource.name, Util_DynamoDbStream$ReventlessAws.streamArnFromDynamoDbTableResource(streamResource), Pulumi.output(StateTopic_AppSync_Helpers$ReventlessAws.entityKeyPartitionAttribute), topicName, eventsApi, opts);
+  makeForTable(streamResource.name, Util_DynamoDbStream$ReventlessAws.streamArnFromDynamoDbTableResource(streamResource), Pulumi.output(StateTopic_AppSync_Helpers$ReventlessAws.entityKeyPartitionAttribute), topicName, Stdlib_Option.map(Stdlib_Option.flatMap(Stdlib_Option.flatMap(Plugin_Helpers$ReventlessCore.stateSchemaRegistry[readModelName], StateAnnotations$Reventless.getSpec), spec => spec.retired), r => r.field), Stdlib_Option.flatMap(Stdlib_Option.flatMap(Stdlib_Option.flatMap(Plugin_Helpers$ReventlessCore.stateSchemaRegistry[readModelName], StateAnnotations$Reventless.getSpec), spec => spec.retired), r => r.values), eventsApi, opts);
 }
 
 function finish(eventsApi, opts) {
@@ -94,6 +98,23 @@ function finish(eventsApi, opts) {
     });
     return JSON.stringify(dict);
   });
+  let retiredMapJson = Pulumi.all(entries.map(e => e.tableName)).apply(tableNames => {
+    let dict = {};
+    tableNames.forEach((tableName, i) => {
+      let entry = entries[i];
+      Stdlib_Option.forEach(entry.retiredField, f => {
+        let obj = Object.fromEntries([[
+            "field",
+            f
+          ]]);
+        Stdlib_Option.forEach(entry.retiredValues, vs => {
+          obj["values"] = vs.map(prim => prim);
+        });
+        dict[tableName] = obj;
+      });
+    });
+    return JSON.stringify(dict);
+  });
   let packageDirs = Object.fromEntries([[
       "@reventlessdev/reventless-aws",
       Util_Bundle$ReventlessAws.resolvePackageRoot(undefined, "@reventlessdev/reventless-aws")
@@ -125,6 +146,10 @@ function finish(eventsApi, opts) {
           "STATE_TOPIC_MAP",
           topicMapJson
         ],
+        [
+          "STATE_RETIRED_MAP",
+          retiredMapJson
+        ],
         [
           "NODE_OPTIONS",
           Util_Bundle$ReventlessAws.esmLoaderNodeOptions

package/src/adapter/StateTopic/StateTopic_AppSync_Ops.res

@@ -53,6 +53,55 @@ type event = {@as("Records") records: array<record>}
 
 // ── Per-record derivations (ports of the former inline JS helpers) ───────────
 
+// STATE_RETIRED_MAP: `{ <tableName>: {field, values?} }`, injected at deploy time
+// beside STATE_TOPIC_MAP. This handler runs with no plugin registry in process —
+// there is nothing here that could read a state schema — so the whole predicate
+// has to arrive the same way the topic routing does. A table absent from the map
+// declares no retirement, which is every table until one does.
+//
+// `values` absent is the boolean form. Carried as an object rather than as an
+// encoded string because a `field=Value` convention is a parser this side and a
+// writer the other, and the two drift the first time a state name contains the
+// separator — an argument that only gets stronger now that a lifecycle can name
+// several states.
+let retiredMap: dict<Reventless.OwnerScope.retiredScope> =
+  switch NodeProcess.env
+  ->Dict.get("STATE_RETIRED_MAP")
+  ->Option.getOr("{}")
+  ->JSON.parseOrThrow
+  ->JSON.Decode.object {
+  | Some(d) =>
+    let out = Dict.make()
+    d->Dict.forEachWithKey((v, k) =>
+      v
+      ->JSON.Decode.object
+      ->Option.flatMap(o =>
+        o
+        ->Dict.get("field")
+        ->Option.flatMap(JSON.Decode.string)
+        ->Option.map(field => {
+          Reventless.OwnerScope.field,
+          values: o
+          ->Dict.get("values")
+          ->Option.flatMap(JSON.Decode.array)
+          ->Option.map(vs => vs->Array.filterMap(JSON.Decode.string)),
+        })
+      )
+      ->Option.forEach(scope => out->Dict.set(k, scope))
+    )
+    out
+  | None => Dict.make()
+  }
+
+let tableNameFromEventSourceArn = (arn: string): option<string> => {
+  let parts = arn->String.split("/")
+  switch (parts->Array.get(0), parts->Array.get(1), parts->Array.get(2)) {
+  | (Some(prefix), Some(tableName), Some("stream")) if prefix->String.endsWith(":table") =>
+    Some(tableName)
+  | _ => None
+  }
+}
+
 // Map record.eventSourceARN → topicRoot via STATE_TOPIC_MAP. Stream ARNs look
 // like arn:aws:dynamodb:<region>:<acct>:table/<TableName>/stream/<ts>; split on
 // "/" gives [ "...:table", "<TableName>", "stream", "<ts>" ].
@@ -131,18 +180,34 @@ let makeDescriptor = (
   ~entityKey: string,
   ~image: dict<JSON.t>,
   ~seq: option<string>,
+  ~retiredField: option<string>=?,
+  ~retiredValues: option<array<string>>=?,
 ): JSON.t => {
   let removed = changeKind == "Removed"
+  // A retired row publishes as metadata only, for the reason the other two
+  // implementations do it: this channel reaches every subscriber of the view,
+  // and a payload would deliver the row to the callers the resolvers refuse it
+  // to. `Updated` with no state is the shape an oversized row already takes.
+  // Both forms are the one question `isRetiredValue` answers, so nothing here
+  // branches on which the view declared.
+  let retired = switch retiredField {
+  | Some(field) =>
+    !removed &&
+    {Reventless.OwnerScope.field, values: retiredValues}->Reventless.OwnerScope.isRetiredValue(
+      image->Dict.get(field),
+    )
+  | None => false
+  }
   let descriptor = Dict.make()
   descriptor->Dict.set("changeKind", JSON.Encode.string(changeKind))
   descriptor->Dict.set("id", JSON.Encode.string(entityKey))
-  if !removed {
+  if !removed && !retired {
     pickSortKeyValue(image)->Option.forEach(v =>
       descriptor->Dict.set("sortKeyValue", JSON.Encode.string(v))
     )
   }
   seq->Option.forEach(s => descriptor->Dict.set("seq", JSON.Encode.string(s)))
-  if !removed {
+  if !removed && !retired {
     let state = image->JSON.Encode.object
     let encoded = state->JSON.stringify
     if encoded->String.length <= maxStateChars {
@@ -191,6 +256,12 @@ let processRecord = async (
           ~entityKey,
           ~image=unmarshalled,
           ~seq=dynamodb.sequenceNumber,
+          ~retiredField=?tableNameFromEventSourceArn(record.eventSourceARN)
+          ->Option.flatMap(t => retiredMap->Dict.get(t))
+          ->Option.map(scope => scope.Reventless.OwnerScope.field),
+          ~retiredValues=?tableNameFromEventSourceArn(record.eventSourceARN)
+          ->Option.flatMap(t => retiredMap->Dict.get(t))
+          ->Option.flatMap(scope => scope.Reventless.OwnerScope.values),
         )
         let body =
           Dict.fromArray([

package/src/adapter/StateTopic/StateTopic_AppSync_Ops.res.mjs

@@ -1,5 +1,6 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
+import * as Stdlib_Dict from "@rescript/runtime/lib/es6/Stdlib_Dict.js";
 import * as Stdlib_JSON from "@rescript/runtime/lib/es6/Stdlib_JSON.js";
 import * as Stdlib_Array from "@rescript/runtime/lib/es6/Stdlib_Array.js";
 import * as Stdlib_JsExn from "@rescript/runtime/lib/es6/Stdlib_JsExn.js";
@@ -7,6 +8,7 @@ import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
 import * as Stdlib_JsError from "@rescript/runtime/lib/es6/Stdlib_JsError.js";
 import * as Primitive_string from "@rescript/runtime/lib/es6/Primitive_string.js";
 import * as Primitive_exceptions from "@rescript/runtime/lib/es6/Primitive_exceptions.js";
+import * as OwnerScope$Reventless from "@reventlessdev/reventless-spec/src/types/OwnerScope.res.mjs";
 import * as DynamoDb_Util_Helpers$AwsSdk from "@reventlessdev/rescript-aws-sdk/src/DynamoDb_Util_Helpers.res.mjs";
 import * as AppSyncEventsSigner_Ops$ReventlessAws from "../Api/AppSyncEventsSigner_Ops.res.mjs";
 
@@ -22,6 +24,33 @@ let topicMap = obj !== undefined ? Object.fromEntries(Stdlib_Array.filterMap(Obj
     ]);
   })) : ({});
 
+let d = Stdlib_JSON.Decode.object(JSON.parse(Stdlib_Option.getOr(process.env["STATE_RETIRED_MAP"], "{}")));
+
+let retiredMap;
+
+if (d !== undefined) {
+  let out = {};
+  Stdlib_Dict.forEachWithKey(d, (v, k) => Stdlib_Option.forEach(Stdlib_Option.flatMap(Stdlib_JSON.Decode.object(v), o => Stdlib_Option.map(Stdlib_Option.flatMap(o["field"], Stdlib_JSON.Decode.string), field => ({
+    field: field,
+    values: Stdlib_Option.map(Stdlib_Option.flatMap(o["values"], Stdlib_JSON.Decode.array), vs => Stdlib_Array.filterMap(vs, Stdlib_JSON.Decode.string))
+  }))), scope => {
+    out[k] = scope;
+  }));
+  retiredMap = out;
+} else {
+  retiredMap = {};
+}
+
+function tableNameFromEventSourceArn(arn) {
+  let parts = arn.split("/");
+  let match = parts[0];
+  let match$1 = parts[1];
+  let match$2 = parts[2];
+  if (match !== undefined && match$1 !== undefined && match$2 !== undefined && match$2 === "stream" && match.endsWith(":table")) {
+    return match$1;
+  }
+}
+
 function topicRootFromEventSourceArn(arn) {
   let parts = arn.split("/");
   let match = parts[0];
@@ -89,12 +118,16 @@ function pickSortKeyValue(image) {
   }
 }
 
-function makeDescriptor(changeKind, entityKey, image, seq) {
+function makeDescriptor(changeKind, entityKey, image, seq, retiredField, retiredValues) {
   let removed = changeKind === "Removed";
+  let retired = retiredField !== undefined ? !removed && OwnerScope$Reventless.isRetiredValue({
+      field: retiredField,
+      values: retiredValues
+    }, image[retiredField]) : false;
   let descriptor = {};
   descriptor["changeKind"] = changeKind;
   descriptor["id"] = entityKey;
-  if (!removed) {
+  if (!removed && !retired) {
     Stdlib_Option.forEach(pickSortKeyValue(image), v => {
       descriptor["sortKeyValue"] = v;
     });
@@ -102,7 +135,7 @@ function makeDescriptor(changeKind, entityKey, image, seq) {
   Stdlib_Option.forEach(seq, s => {
     descriptor["seq"] = s;
   });
-  if (!removed) {
+  if (!removed && !retired) {
     let encoded = JSON.stringify(image);
     if (encoded.length <= 61440) {
       descriptor["state"] = image;
@@ -127,7 +160,7 @@ async function processRecord(record, region, creds) {
     let entityKey = entityKeyFromRecord(dynamodb);
     let channel = `/default/` + topicRoot + `/` + AppSyncEventsSigner_Ops$ReventlessAws.pathSegment(entityKey);
     let unmarshalled = DynamoDb_Util_Helpers$AwsSdk.unmarshallDict(undefined, image);
-    let descriptor = makeDescriptor(changeKindFor(record.eventName), entityKey, unmarshalled, dynamodb.SequenceNumber);
+    let descriptor = makeDescriptor(changeKindFor(record.eventName), entityKey, unmarshalled, dynamodb.SequenceNumber, Stdlib_Option.map(Stdlib_Option.flatMap(tableNameFromEventSourceArn(record.eventSourceARN), t => retiredMap[t]), scope => scope.field), Stdlib_Option.flatMap(Stdlib_Option.flatMap(tableNameFromEventSourceArn(record.eventSourceARN), t => retiredMap[t]), scope => scope.values));
     let body = JSON.stringify(Object.fromEntries([
       [
         "id",
@@ -193,6 +226,8 @@ let maxStateChars = 61440;
 export {
   endpoint,
   topicMap,
+  retiredMap,
+  tableNameFromEventSourceArn,
   topicRootFromEventSourceArn,
   jsonToString,
   entityKeyFromRecord,

package/tests/PgQueryResolver_LambdaTest.res

@@ -52,6 +52,8 @@ let ops: QueryDb_Adapter.operations = {
   deleteBatch: Obj.magic(0),
 }
 
+let lastRetiredScope: ref<option<Reventless.OwnerScope.retiredScope>> = ref(None)
+
 let pushdowns: PgQueryResolver_Lambda.pushdowns = {
   indexLookup: async (~readModelName as _, field, value) =>
     allItems()->Array.filter(i => fieldEq(i, field, value)),
@@ -63,11 +65,20 @@ let pushdowns: PgQueryResolver_Lambda.pushdowns = {
     ~capability as _,
     ~labelField as _,
     ~ownerScope: option<(string, string)>=?,
+    ~retiredScope: option<Reventless.OwnerScope.retiredScope>=?,
   ) => {
     lastOwnerScope := ownerScope
+    lastRetiredScope := retiredScope
     listPageReturn.contents
   },
-  itemsPage: async (~readModelName as _, ~subIdField as _, ~id, ~argsDict as _, ~ownerScope as _=?) =>
+  itemsPage: async (
+    ~readModelName as _,
+    ~subIdField as _,
+    ~id,
+    ~argsDict as _,
+    ~ownerScope as _=?,
+    ~retiredScope as _=?,
+  ) =>
     // Sentinel echoing the requested id, so the dispatch routing is observable.
     JSON.Encode.object(Dict.fromArray([("itemsFor", JSON.Encode.string(id))])),
   scanAll: async (~readModelName as _) => allItems(),
@@ -82,6 +93,8 @@ let makeBinding = (
   ~authorization=Reventless.Authorization.AllowAnonymous,
   ~subIdField=None,
   ~ownerField=None,
+  ~retiredField=None,
+  ~retiredValues=None,
   (),
 ): PgQueryResolver_Lambda.binding => {
   ops,
@@ -96,6 +109,8 @@ let makeBinding = (
   includeIdParam: true,
   authorization,
   ownerField,
+  retiredField,
+  retiredValues,
 }
 
 let mkPayload = (