@ibgib/core-gib 0.1.44 → 0.1.47

package/src/sync/sync-saga-coordinator.mts

@@ -50,8 +50,8 @@ import { SYNC_SAGA_MSG_ATOM } from "./sync-saga-message/sync-saga-message-consta
 import { SyncSagaInfo } from "./sync-types.mjs";
 import { splitPerTjpAndOrDna, getTimelinesGroupedByTjp, isIbGib, getIbGibsFromCache_fallbackToSpaces } from "../common/other/ibgib-helper.mjs";
 import { SyncPeerWitness } from "./sync-peer/sync-peer-types.mjs";
-import { SyncSagaContextIbGib_V1, } from "./sync-saga-context/sync-saga-context-types.mjs";
-import { createSyncSagaContext, validateContextAndSagaFrame } from "./sync-saga-context/sync-saga-context-helpers.mjs";
+import { SyncSagaContextData_V1, SyncSagaContextIbGib_V1, SyncSagaContextRel8ns_V1, } from "./sync-saga-context/sync-saga-context-types.mjs";
+import { getSyncSagaContextIb, validateContextAndSagaFrame } from "./sync-saga-context/sync-saga-context-helpers.mjs";
 import { newupSubject, } from "../common/pubsub/subject/subject-helper.mjs";
 import { SubjectWitness } from "../common/pubsub/subject/subject-types.mjs";
 import { getSyncSagaMessageFromFrame } from "./sync-saga-message/sync-saga-message-helpers.mjs";
@@ -64,6 +64,8 @@ import { GRAFT_INFO_REL8N_NAME } from "./graft-info/graft-info-constants.mjs";
 import { GraftInfoIbGib_V1 } from "./graft-info/graft-info-types.mjs";
 import { validateIbGibIntrinsically } from "@ibgib/ts-gib/dist/V1/validate-helper.mjs";
 import { KEYSTONE_VERB_MANAGE } from "../keystone/keystone-constants.mjs";
+import { validateKeystoneGraph } from "../keystone/keystone-helpers.mjs";
+import { SYNC_SAGA_CONTEXT_ATOM } from "./sync-saga-context/sync-saga-context-constants.mjs";
 
 
 const logalot = GLOBAL_LOG_A_LOT;
@@ -87,7 +89,7 @@ export class SyncSagaCoordinator {
     private lc: string = `[${SyncSagaCoordinator.name}]`;
 
     constructor(
-        private keystone: KeystoneService_V1
+        private keystoneSvc: KeystoneService_V1
     ) {
 
     }
@@ -209,6 +211,9 @@ export class SyncSagaCoordinator {
 
                 if (useSessionIdentity) {
                     if (!identitySecret) { throw new Error(`useSessionIdentity is true, but identitySecret is falsy. Must provide a secret if you want to use a session identity. (E: 81915860c4dd3ea4dfd81825fa74c126)`); }
+                    // creates the initial session identity (keystone). the flow
+                    // (i think) will go: evolve saga frame, then sign keystone,
+                    // then create/send context.
                     sessionIdentity = await this.getSessionIdentity({ sagaId, identitySecret, metaspace, localSpace });
                 }
 
@@ -322,12 +327,13 @@ export class SyncSagaCoordinator {
             // create the return context
             const { frame, payloadIbGibsDomain } = contextResult.nextFrameInfo;
 
-            const responseCtx = await createSyncSagaContext({
+            const responseCtx = await this.createSyncSagaContext({
                 sagaFrame: frame,
                 localSpace: mySpace,
                 payloadIbGibsDomain,
-                // todo: we need to thoroughly go through the identity per each step after getting basic merging
-                sessionKeystones: identity ? [identity] : undefined, // ??
+                sessionKeystone: identity,
+                sessionSecret: identitySecret,
+                metaspace,
             });
 
             const immediateValidationErrors = await validateContextAndSagaFrame({
@@ -461,7 +467,7 @@ export class SyncSagaCoordinator {
             // Generate keystone with DUAL pools. We have to first genesis with
             // one and then add the other, because we have two distinct
             // secrets.
-            const sessionIdentity = await this.keystone.genesis({
+            const sessionIdentity = await this.keystoneSvc.genesis({
                 masterSecret: sessionSecret,
                 configs: [primaryPoolConfig],
                 metaspace,
@@ -569,9 +575,10 @@ export class SyncSagaCoordinator {
             // #endregion set up peer observable for any domainPayloadsMap
 
             // ...create/compose the Request Context itself...
-            const requestCtx = await createSyncSagaContext({
+            const requestCtx = await this.createSyncSagaContext({
                 sagaFrame: currentFrame,
-                sessionKeystones: sessionIdentity ? [sessionIdentity] : undefined,
+                sessionKeystone: sessionIdentity,
+                sessionSecret: identitySecret,
                 /**
                  * init frame: empty
                  * ack frame: possible push offers
@@ -580,6 +587,7 @@ export class SyncSagaCoordinator {
                  */
                 payloadIbGibsDomain: nextDomainIbGibs,
                 localSpace,
+                metaspace,
             });
 
             // #region Log what we're sending
@@ -707,6 +715,148 @@ export class SyncSagaCoordinator {
         }
     }
 
+
+    /**
+     * Creates new SyncSagaContext stone. Puts/registers in {@link localSpace}
+     * immediately after creation.
+     *
+     * @returns The context ibGib.
+     *
+     * ## notes
+     *
+     * the other ibgibs that are related to this context stone should already be
+     * put/registered in {@link localSpace}.
+     */
+    private async createSyncSagaContext({
+        sagaFrame,
+        sessionKeystone,
+        sessionSecret,
+        payloadIbGibsDomain,
+        metaspace,
+        localSpace,
+    }: {
+        /**
+         * The main saga frame (Init, Ack, etc.).
+         */
+        sagaFrame: SyncIbGib_V1;
+        /**
+         * Session identity keystone.
+         */
+        sessionKeystone: KeystoneIbGib_V1 | undefined;
+        /**
+         * If using session ({@link sessionKeystone} is truthy), this must be
+         * provided in order to sign it.
+         */
+        sessionSecret: string | undefined;
+        /**
+         * Domain payload ibgibs when the sync saga frame includes actual domain
+         * payloads to send, e.g., in a Delta frame.
+         */
+        payloadIbGibsDomain?: IbGib_V1[];
+        /**
+         * reference to the current metaspace
+         */
+        metaspace: MetaspaceService,
+        /**
+         * we persist the context in the local/sender space (relative to our
+         * execution POV) right when we create it.
+         */
+        localSpace: IbGibSpaceAny;
+    }): Promise<SyncSagaContextIbGib_V1> {
+        const lc = `[${this.createSyncSagaContext.name}]`;
+        try {
+            if (logalot) { console.log(`${lc} starting... (I: 6b87bee313e811d1d2fc90e87fbec826)`); }
+
+            // #region sanity/validation
+            if (!sagaFrame.data) { throw new Error(`(UNEXPECTED) sagaFrame.data falsy? (E: 04c49b4cccba6842a8b52e4c6f570726)`); }
+            if (!sagaFrame.data.n && sagaFrame.data.n !== 0) { throw new Error(`(UNEXPECTED) sagaFrame.data.n falsy and not 0? (E: 45b508da64a8b28428b11765d684b826)`); }
+            if (sessionKeystone && !sessionSecret) { throw new Error(`(UNEXPECTED) sessionKeystone truthy but sessionSecret falsy? (E: 705ecc25038b12df0e94c90c5561e426)`); }
+            // #endregion sanity/validation
+
+            const date = new Date();
+            const timestamp = getTimestamp(date);
+            const timestampMs = date.getMilliseconds();
+
+            const data: SyncSagaContextData_V1 = {
+                timestamp,
+                timestampMs,
+                sagaN: sagaFrame.data.n,
+            };
+
+            // Domain Payloads
+            const payloadAddrsDomain = payloadIbGibsDomain ?
+                payloadIbGibsDomain?.map(x => getIbGibAddr({ ibGib: x })) :
+                undefined;
+            if (payloadAddrsDomain && payloadAddrsDomain.length > 0) {
+                data[SYNC_SAGA_PAYLOAD_ADDRS_DOMAIN] = payloadAddrsDomain;
+            }
+
+            // rel8ns should always have saga frame, sometimes have keystone
+            const rel8ns: SyncSagaContextRel8ns_V1 = {
+                sagaFrame: [getIbGibAddr({ ibGib: sagaFrame })],
+            };
+            if (sessionKeystone) {
+                const keystoneErrors = await validateKeystoneGraph({
+                    keystoneIbGib: sessionKeystone,
+                    space: localSpace,
+                    getLatest: true,
+                    invalidIfMoreRecentKeystoneFoundInSpace: true,
+                });
+                if (keystoneErrors.length > 0) {
+                    throw new Error(`invalid sessionKeystone. errors: ${keystoneErrors} (E: 3881b8caf2d803767a331e1141e84826)`);
+                }
+                // this addr is BEFORE we sign. So each context ibgib itself will
+                // point to the frame of the keystone just before that keystone
+                // signs with this context as its target.
+                rel8ns.sessionKeystone = [getIbGibAddr({ ibGib: sessionKeystone })];
+            }
+
+            // Generate standard ib
+            const ib = await getSyncSagaContextIb({ data });
+
+            const contextIbGib = await Factory_V1.stone<SyncSagaContextData_V1, SyncSagaContextRel8ns_V1>({
+                parentPrimitiveIb: SYNC_SAGA_CONTEXT_ATOM,
+                ib,
+                data,
+                rel8ns,
+            }) as SyncSagaContextIbGib_V1;
+
+            // put/register immediately. Note that contextIbGib at this point is
+            // pure DTO, i.e., only ib, gib, data, rel8ns props.
+            await putInSpace({ ibGib: contextIbGib, space: localSpace, });
+            await registerNewIbGib({
+                ibGib: contextIbGib,
+                space: localSpace,
+                fnBroadcast: undefined,
+            });
+
+            // Attach actual ibgibs for transport (not pure DTO now)
+            contextIbGib.sagaFrame = sagaFrame;
+            if (payloadIbGibsDomain && payloadIbGibsDomain.length > 0) {
+                contextIbGib.payloadIbGibsDomain = payloadIbGibsDomain;
+            }
+
+            if (sessionKeystone) {
+                if (!sessionSecret) { throw new Error(`(UNEXPECTED) sessionKeystone truthy but sessionSecret falsy? we should have thrown before now (E: a2b0517a37b559543968b888f2067826)`); }
+                const contextAddr = getIbGibAddr({ ibGib: contextIbGib });
+                contextIbGib.signedSessionKeystone = await this.keystoneSvc.sign({
+                    latestKeystone: sessionKeystone,
+                    claim: { target: contextAddr, }, // verb?
+                    space: localSpace,
+                    masterSecret: sessionSecret,
+                    metaspace,
+                });
+            }
+
+            return contextIbGib;
+        } catch (error) {
+            console.error(`${lc} ${extractErrorMsg(error)}`);
+            throw error;
+        } finally {
+            if (logalot) { console.log(`${lc} complete.`); }
+        }
+    }
+
     /**
      * Helper to get Knowledge Map for specific domain ibGibs or TJPs.
      * Useful for testing and external validation.