@ibgib/core-gib 0.1.22 → 0.1.25

package/src/sync/sync-saga-context/sync-saga-context-helpers.mts

@@ -7,14 +7,20 @@ import { Factory_V1 } from '@ibgib/ts-gib/dist/V1/factory.mjs';
 import { getIbGibAddr } from '@ibgib/ts-gib/dist/helper.mjs';
 import { IbGib_V1, } from '@ibgib/ts-gib/dist/V1/types.mjs';
 import { Ib } from '@ibgib/ts-gib/dist/types.mjs';
+import { validateIbGibIntrinsically } from '@ibgib/ts-gib/dist/V1/validate-helper.mjs';
 
+import { GLOBAL_LOG_A_LOT } from '../../core-constants.mjs';
 import { SYNC_SAGA_CONTEXT_ATOM } from './sync-saga-context-constants.mjs';
 import { SYNC_SAGA_PAYLOAD_ADDRS_DOMAIN } from '../sync-constants.mjs';
 import {
-    SyncSagaContextData_V1, SyncSagaContextIbGib_V1,
-    SyncSagaContextIb_V1, SyncSagaContextRel8ns_V1
+    SyncSagaContextData_V1, SyncSagaContextIbGib_V1, SyncSagaContextIb_V1,
+    SyncSagaContextRel8ns_V1,
 } from './sync-saga-context-types.mjs';
-import { getTimestampInfo } from '../../common/other/ibgib-helper.mjs';
+import { IbGibSpaceAny } from '../../witness/space/space-base-v1.mjs';
+import { putInSpace, registerNewIbGib } from '../../witness/space/space-helper.mjs';
+import { SyncIbGib_V1 } from '../sync-types.mjs';
+
+const logalot = GLOBAL_LOG_A_LOT;
 
 /**
  * Options for creating a SyncSagaContext ibgib.
@@ -23,7 +29,7 @@ export interface CreateSyncSagaContextOptions {
     /**
      * The main saga frame (Init, Ack, etc.).
      */
-    sagaFrame: IbGib_V1;
+    sagaFrame: SyncIbGib_V1;
     /**
      * Session identity keystones.
      */
@@ -33,6 +39,11 @@ export interface CreateSyncSagaContextOptions {
      * payloads to send, e.g., in a Delta frame.
      */
     payloadIbGibsDomain?: IbGib_V1[];
+    /**
+     * we persist the context in the local/sender space (relative to our
+     * execution POV) right when we create it.
+     */
+    localSpace: IbGibSpaceAny;
 }
 
 /**
@@ -98,53 +109,150 @@ export async function parseSyncSagaContextIb({
 }
 
 /**
- * Creates a new SyncSagaContext ibGib stone.
- * 
+ * 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}.
  */
 export async function createSyncSagaContext({
     sagaFrame,
     sessionKeystones,
     payloadIbGibsDomain,
+    localSpace,
 }: CreateSyncSagaContextOptions): Promise<SyncSagaContextIbGib_V1> {
+    const lc = `[${createSyncSagaContext.name}]`;
+    try {
+        if (logalot) { console.log(`${lc} starting... (I: 6b87bee313e811d1d2fc90e87fbec826)`); }
 
-    const date = new Date();
-    const timestamp = getTimestamp(date);
-    const timestampMs = date.getMilliseconds();
+        const date = new Date();
+        const timestamp = getTimestamp(date);
+        const timestampMs = date.getMilliseconds();
 
-    const data: SyncSagaContextData_V1 = {
-        timestamp,
-        timestampMs,
-    };
+        const data: SyncSagaContextData_V1 = {
+            timestamp,
+            timestampMs,
+        };
 
-    // Domain Payloads 
-    const payloadAddrsDomain = payloadIbGibsDomain ? payloadIbGibsDomain?.map(x => getIbGibAddr({ ibGib: x })) : undefined;
-    if (payloadAddrsDomain && payloadAddrsDomain.length > 0) {
-        data[SYNC_SAGA_PAYLOAD_ADDRS_DOMAIN] = payloadAddrsDomain;
-    }
+        // 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 (sessionKeystones && sessionKeystones.length > 0) {
-        rel8ns.sessionKeystone = sessionKeystones.map(x => getIbGibAddr({ ibGib: x }));
-    }
+        // rel8ns should always have saga frame, sometimes have keystone
+        const rel8ns: SyncSagaContextRel8ns_V1 = {
+            sagaFrame: [getIbGibAddr({ ibGib: sagaFrame })],
+        };
+        if (sessionKeystones && sessionKeystones.length > 0) {
+            rel8ns.sessionKeystone = sessionKeystones.map(x => getIbGibAddr({ ibGib: x }));
+        }
+
+        // Generate standard ib
+        const ib = await getSyncSagaContextIb({ data });
 
-    // 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;
 
-    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;
+        }
 
-    // Attach actual ibgibs for transport 
-    if (payloadIbGibsDomain && payloadIbGibsDomain.length > 0) {
-        contextIbGib.payloadIbGibsDomain = payloadIbGibsDomain;
+        return contextIbGib;
+    } catch (error) {
+        console.error(`${lc} ${extractErrorMsg(error)}`);
+        throw error;
+    } finally {
+        if (logalot) { console.log(`${lc} complete.`); }
     }
+}
+
+/**
+ * Validates ONLY the {@link context} ibgib itself and saga frame/msg stone(s)
+ * ({@link SyncSagaContextIbGib_V1.sagaFrame}).
+ *
+ * Does NOT...
+ * * validate keystones (authn or authz)
+ * * validate domain payload ibgibs...
+ *   * intrinsically
+ *   * in relation to this context (addrs match up)
+ *
+ * @returns empty array if valid, else validation errors
+ */
+export async function validateContextAndSagaFrame({ context }: { context: SyncSagaContextIbGib_V1 }): Promise<string[]> {
+    const lc = `[${validateContextAndSagaFrame.name}]`;
+    try {
+        if (logalot) { console.log(`${lc} starting... (I: 7797f8294bd8f7e5089cb722ad468226)`); }
+
+        const errors: string[] = [];
+
+        // validate just the context first. if this fails we return early.
+        const intrinsicErrors = await validateIbGibIntrinsically({ ibGib: context });
+        if (intrinsicErrors && intrinsicErrors.length > 0) {
+            intrinsicErrors.forEach(x => errors.push(x));
+            return errors; /* <<<< returns early */
+        }
+
+        if (context.sagaFrame) {
+
+        } else {
+            errors.push(`context.sagaFrame is falsy. (E: b4edd88f4963f493789f83b29ba2df26)`);
+        }
+
+        // validate the entire context graph intrinsically, including saga frame, stones, identity(s) (if applicable but not authentication, that will be done in a separate step)
+
 
-    return contextIbGib;
+
+        // ensure the non-dto properties on the context object (i.e. props
+        // that are not ib, gib, data, or rel8ns) match the data in the
+        // context object
+
+        throw new Error(`not implemented (E: cb639658e1183fa6c8a4ebca023ba926)`);
+    } catch (error) {
+        console.error(`${lc} ${extractErrorMsg(error)}`);
+        throw error;
+    } finally {
+        if (logalot) { console.log(`${lc} complete.`); }
+    }
 }
+
+
+/**
+ * validates the payload ibgibs ({@link SyncSagaContextIbGib_V1.payloadIbGibsDomain}) intrinsically
+ *
+ * @returns empty array if valid, else validation errors
+ */
+export async function validateContextDomainPayloadIbGibs({ context }: { context: SyncSagaContextIbGib_V1 }): Promise<string[]> {
+    const lc = `[${validateContextDomainPayloadIbGibs.name}]`;
+    try {
+        if (logalot) { console.log(`${lc} starting... (I: 9f9fe835bcc80c75aa7fd6d887fc0826)`); }
+        console.error(`${lc} NAG MESSAGE (NOT THROWN). not implemented (E: bfe02ab36a227291a8f17ffc08f2ef26)`)
+        return [];
+    } catch (error) {
+        console.error(`${lc} ${extractErrorMsg(error)}`);
+        throw error;
+    } finally {
+        if (logalot) { console.log(`${lc} complete.`); }
+    }
+}

package/src/sync/sync-saga-context/sync-saga-context-types.mts

@@ -43,6 +43,11 @@ export interface SyncSagaContextRel8ns_V1 extends IbGibRel8ns_V1 {
     /**
      * The Ephemeral Session Keystone Identity used for this saga.
      * Required for validating the saga frame signature.
+     * 
+     * ## notes
+     * 
+     * This will be different for the sender and receiver, yes? hmm...
+     * I think I need to put "sender" or "receiver" in the session keystone ib.
      */
     sessionKeystone?: IbGibAddr[];
 }