@reventlessdev/reventless-core 3.0.0-alpha.198 → 3.0.0-alpha.200

package/tests/plugin/PluginLifecycleCorpusTest.res

@@ -0,0 +1,50 @@
+// Frozen-payload compatibility corpus for the Plugin lifecycle aggregate.
+//
+// The Plugin aggregate replays its own event log before every decision, so ONE
+// undecodable stored event freezes Heartbeat / Redetect / Connect for that plugin
+// permanently — and it does so silently, surfacing only as a registration that
+// stops tracking deploys. See docs/analysis/plugin-definition-schema-evolution-wedge.md.
+//
+// The two hand-constructed cases in MessageTest build a `pluginDefinition` from the
+// CURRENT ReScript type and then strip keys. That literal recompiles with every
+// schema change, so it can only test the fields whoever wrote it thought to strip —
+// which is why it did not catch `annotation: string`. These fixtures are frozen JSON
+// captured off a deployed log and are never regenerated; see the corpus README.
+//
+// What turns this suite red is a change no amount of healing can absorb: a field
+// whose TYPE changed under stored data (`float` → an object, say), a `bigint`, or a
+// genuinely corrupt payload. It names the fixture and the sury field path. The fix is
+// to make the change decodable — never to re-cut the fixtures.
+//
+// A newly added required *scalar* does NOT land here: `fillMissingDefaults` invents a
+// value for it, so these still decode. That case is caught by the sibling
+// PluginDefinitionRequiredScalarsTest, at the declaration site.
+
+open JestGlobals
+
+let entries = PluginLifecycleCorpus.entries
+
+// Mirrors EventLog_Operations.decodeEvent: reassemble the stored `{event, data}`
+// pair into a variant and decode it — the exact call replay makes.
+let decodeStored = (entry: PluginLifecycleCorpus.entry) =>
+  Message.combineMessage(entry.event, entry.data)->Message.decode(PluginSpec.eventSchema)
+
+describe("The stored plugin-lifecycle payload corpus", () => {
+  testSync("is not empty (a corpus that loaded nothing would pass vacuously)", () =>
+    expect(entries->Array.length > 0)->toBe(true)
+  )
+
+  entries->Array.forEach(entry =>
+    testSync(`still decodes: ${entry.name}`, () => {
+      // Sury's own exception carries the field path, which is the whole value of
+      // this suite's failure message — report it verbatim rather than "it threw".
+      let outcome = switch decodeStored(entry) {
+      | _ => "decodes"
+      | exception S.Error(err) => err.message
+      | exception JsExn(e) => `threw: ${JsExn.message(e)->Option.getOr("no message")}`
+      | exception _ => "threw a non-JS exception"
+      }
+      expect(outcome)->toBe("decodes")
+    })
+  )
+})

package/tests/plugin/PluginLifecycleCorpusTest.res.mjs

@@ -0,0 +1,42 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as S from "sury/src/S.res.mjs";
+import * as Stdlib_JsExn from "@rescript/runtime/lib/es6/Stdlib_JsExn.js";
+import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
+import * as Primitive_exceptions from "@rescript/runtime/lib/es6/Primitive_exceptions.js";
+import * as Message$ReventlessCore from "../../src/Message.res.mjs";
+import * as PluginSpec$ReventlessCore from "../../src/plugin/lifecycle/PluginSpec.res.mjs";
+import * as PluginLifecycleCorpus$ReventlessCore from "./PluginLifecycleCorpus.res.mjs";
+
+function decodeStored(entry) {
+  return Message$ReventlessCore.decode(Message$ReventlessCore.combineMessage(entry.event, entry.data), PluginSpec$ReventlessCore.eventSchema);
+}
+
+globalThis.describe("The stored plugin-lifecycle payload corpus", () => {
+  globalThis.test("is not empty (a corpus that loaded nothing would pass vacuously)", () => {
+    globalThis.expect(PluginLifecycleCorpus$ReventlessCore.entries.length !== 0).toBe(true);
+  });
+  PluginLifecycleCorpus$ReventlessCore.entries.forEach(entry => {
+    globalThis.test(`still decodes: ` + entry.name, () => {
+      let outcome;
+      try {
+        decodeStored(entry);
+        outcome = "decodes";
+      } catch (raw_err) {
+        let err = Primitive_exceptions.internalToException(raw_err);
+        outcome = err.RE_EXN_ID === S.$$Error ? err._1.message : (
+            err.RE_EXN_ID === "JsExn" ? `threw: ` + Stdlib_Option.getOr(Stdlib_JsExn.message(err._1), "no message") : "threw a non-JS exception"
+          );
+      }
+      globalThis.expect(outcome).toBe("decodes");
+    });
+  });
+});
+
+let entries = PluginLifecycleCorpus$ReventlessCore.entries;
+
+export {
+  entries,
+  decodeStored,
+}
+/*  Not a pure module */

package/tests/plugin/PluginStructureTest.res

@@ -718,13 +718,13 @@ describe("Plugin_Structure.make — Phase 2 graph fields", () => {
           store: "TestPlugin.documents",
           component: "AttachInvoice",
           field: "documentUrl",
-          annotation: "documents",
+          annotation: Some("documents"),
         },
         {
           store: "branding.logos",
           component: "AttachInvoice",
           field: "logoUrl",
-          annotation: "branding.logos",
+          annotation: Some("branding.logos"),
         },
       ]
       expect(withStores.requiredStoreDeclarations)->toEqual(Some(expected))
@@ -815,7 +815,7 @@ describe("Plugin_Structure.make — Phase 2 graph fields", () => {
           store: "TestPlugin.avatars",
           component: "UploadAvatar",
           field: "avatarUrl",
-          annotation: "avatars",
+          annotation: Some("avatars"),
         },
       ]
       expect(withOptional.requiredStoreDeclarations)->toEqual(Some(expected))

package/tests/plugin/pluginDefinitionRequiredScalars.txt

@@ -0,0 +1,103 @@
+# Every bare required scalar reachable from `pluginDefinition`, sorted.
+#
+# This file is a tripwire, not an inventory to keep tidy. Everything reachable from
+# `pluginDefinition` is persisted in the Plugin lifecycle aggregate's event log, and a
+# scalar is the one shape `Message.fillMissingDefaults` cannot derive a value for: adding
+# one means every message stored before it decodes with a value this framework invented
+# (`""` / `0` / `false`), reported at runtime as a warning and nowhere else.
+#
+# So a diff here is a design decision, not a chore. If your new field can be absent, give
+# it the `js_nullable` (`T | null`) shape and this list does not change. If it genuinely
+# must be a required scalar, add the line and accept that older payloads carry a fabricated
+# value for it.
+#
+# Regenerate ONLY after making that call — never to make a red build green.
+# See docs/analysis/plugin-definition-schema-evolution-wedge.md.
+#
+# A `js_nullable` (`T | null`) scalar is NOT listed: absent heals to null, which is the
+# shape the rule asks for. A scalar nested inside a nullable object or array IS listed —
+# when an old payload carries the parent, the new field still has to be invented. That is
+# how requiredStoreDeclarations[].annotation, a required string inside a nullable array,
+# froze a plugin's registration for two days; it is absent from this list because it has
+# since been made `js_nullable`.
+.apiSchemaFragment.encoded: string
+.apiSchemaFragment.protocol: string
+.dcbEventLog.eventTopicArn: string
+.dcbEventLog.name: string
+.eventCollector: string
+.extensionPoints[].commandTopic: string
+.extensionPoints[].eventTopic: string
+.extensionPoints[].name: string
+.extensionProtocols[].commandVersion: string
+.extensionProtocols[].eventVersion: string
+.extensionProtocols[].extensionPointName: string
+.extensions[].dcbSources[]: string
+.extensions[].extensionPointName: string
+.extensions[].name: string
+.id: string
+.name: string
+.structure.aggregates[].commands[].allowedStates[]: string
+.structure.aggregates[].commands[].mutationField: string
+.structure.aggregates[].commands[].name: string
+.structure.aggregates[].commands[].references[].entity: string
+.structure.aggregates[].commands[].references[].fieldName: string
+.structure.aggregates[].commands[].schema: string
+.structure.aggregates[].consumedEventTypes[]: string
+.structure.aggregates[].events[].name: string
+.structure.aggregates[].events[].references[].entity: string
+.structure.aggregates[].events[].references[].fieldName: string
+.structure.aggregates[].events[].schema: string
+.structure.aggregates[].linkedViews[]: string
+.structure.aggregates[].name: string
+.structure.aggregates[].producedEventTypes[]: string
+.structure.automationSlices[].consumedEventTypes[]: string
+.structure.automationSlices[].name: string
+.structure.automationSlices[].producedCommandTypes[]: string
+.structure.automationSlices[].targetName: string
+.structure.extensionPoints[].commandTypes[]: string
+.structure.extensionPoints[].delegateNames[]: string
+.structure.extensionPoints[].name: string
+.structure.extensionPoints[].sourceEventTypes[]: string
+.structure.extensions[].commandTypes[]: string
+.structure.extensions[].delegateNames[]: string
+.structure.extensions[].eventTypes[]: string
+.structure.extensions[].name: string
+.structure.inboundTranslationSlices[].commandTypes[]: string
+.structure.inboundTranslationSlices[].name: string
+.structure.inboundTranslationSlices[].targetName: string
+.structure.outboundTranslationSlices[].consumedEventTypes[]: string
+.structure.outboundTranslationSlices[].inboundCommandTypes[]: string
+.structure.outboundTranslationSlices[].name: string
+.structure.readModels[].consumedEventTypes[]: string
+.structure.readModels[].labelField: string
+.structure.readModels[].linkedWriteSide[]: string
+.structure.readModels[].name: string
+.structure.readModels[].queryField: string
+.structure.readModels[].schema: string
+.structure.readModels[].searchableFields[]: string
+.structure.requiredStoreDeclarations[].component: string
+.structure.requiredStoreDeclarations[].field: string
+.structure.requiredStoreDeclarations[].store: string
+.structure.requiredStores[]: string
+.structure.stateChangeSlices[].commands[].allowedStates[]: string
+.structure.stateChangeSlices[].commands[].mutationField: string
+.structure.stateChangeSlices[].commands[].name: string
+.structure.stateChangeSlices[].commands[].references[].entity: string
+.structure.stateChangeSlices[].commands[].references[].fieldName: string
+.structure.stateChangeSlices[].commands[].schema: string
+.structure.stateChangeSlices[].consumedEventTypes[]: string
+.structure.stateChangeSlices[].events[].name: string
+.structure.stateChangeSlices[].events[].references[].entity: string
+.structure.stateChangeSlices[].events[].references[].fieldName: string
+.structure.stateChangeSlices[].events[].schema: string
+.structure.stateChangeSlices[].linkedViews[]: string
+.structure.stateChangeSlices[].name: string
+.structure.stateChangeSlices[].producedEventTypes[]: string
+.structure.stateViewSlices[].consumedEventTypes[]: string
+.structure.stateViewSlices[].labelField: string
+.structure.stateViewSlices[].linkedWriteSide[]: string
+.structure.stateViewSlices[].name: string
+.structure.stateViewSlices[].queryField: string
+.structure.stateViewSlices[].schema: string
+.structure.stateViewSlices[].searchableFields[]: string
+.version: string