@ibgib/core-gib 0.1.26 → 0.1.28

package/src/sync/sync-helpers.mts

@@ -1,16 +1,18 @@
-import { extractErrorMsg, getUUID } from "@ibgib/helper-gib/dist/helpers/utils-helper.mjs";
+import { extractErrorMsg, getUUID, pretty } from "@ibgib/helper-gib/dist/helpers/utils-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 { isDna, isPrimitive } from "@ibgib/ts-gib/dist/V1/transforms/transform-helper.mjs";
+import { getIbGibAddr } from "@ibgib/ts-gib/dist/helper.mjs";
 
 import { GLOBAL_LOG_A_LOT } from "../core-constants.mjs";
 import { SYNC_ATOM, SYNC_MSG_REL8N_NAME } from "./sync-constants.mjs";
-import { isValidSyncConflictStrategy, SYNC_CONFLICT_STRATEGY_VALID_VALUES, SyncData_V1, SyncIb_V1, SyncIbGib_V1, SyncSagaFrameDependencyGraph } from "./sync-types.mjs";
+import { isValidSyncConflictStrategy, SYNC_CONFLICT_STRATEGY_VALID_VALUES, SyncData_V1, SyncExecutionContext, SyncIb_V1, SyncIbGib_V1, SyncSagaFrameDependencyGraph } from "./sync-types.mjs";
 import { IbGibSpaceAny } from "../witness/space/space-base-v1.mjs";
 import { getFromSpace, putInSpace } from "../witness/space/space-helper.mjs";
 import { IbGibSpaceResultData, IbGibSpaceResultIbGib, IbGibSpaceResultRel8ns } from "../witness/space/space-types.mjs";
 import { KeystoneIbGib_V1 } from "../keystone/keystone-types.mjs";
-import { isDna, isPrimitive } from "@ibgib/ts-gib/dist/V1/transforms/transform-helper.mjs";
+import { SyncSagaMessageCommitData_V1, SyncSagaMessageIbGib_V1 } from "./sync-saga-message/sync-saga-message-types.mjs";
 
 const logalot = GLOBAL_LOG_A_LOT;
 
@@ -178,7 +180,7 @@ export async function getSyncSagaFrameDependencyGraph({
             const resIbGib =
                 resGet.rawResultIbGib as IbGibSpaceResultIbGib<IbGib_V1, IbGibSpaceResultData, IbGibSpaceResultRel8ns>
             if (!resIbGib.data) { throw new Error(`(UNEXPECTED) resGet.rawResultIbGib.data falsy? (E: c26c681d2f831fc537ba6f48fee36d26)`); }
-            throw new Error(`(UNEXPECTED) couldn't find addrs? addrsNotFound: ${resIbGib.data.addrsNotFound}? (E: 43b7b5a6ad982715c8f3eed69bfa0d26)`);
+            throw new Error(`(UNEXPECTED) couldn't find addrs? addrsNotFound: ${resIbGib.data.addrsNotFound}? space.ib: ${localSpace.ib} (E: 43b7b5a6ad982715c8f3eed69bfa0d26)`);
         }
     };
 
@@ -191,7 +193,7 @@ export async function getSyncSagaFrameDependencyGraph({
 
     // msg stones
     const msgStoneAddrs = sagaIbGib.rel8ns[SYNC_MSG_REL8N_NAME]!;
-    const msgStones = await fnGet(msgStoneAddrs);
+    const msgStones = await fnGet(msgStoneAddrs) as SyncSagaMessageIbGib_V1[];
 
     // identities
     const identities = sagaIbGib.rel8ns.identity && sagaIbGib.rel8ns.identity.length > 0 ?
@@ -201,6 +203,58 @@ export async function getSyncSagaFrameDependencyGraph({
     return { sagaIbGib, msgStones, identities, };
 }
 
+/**
+ * gets the {@link SyncSagaFrameDependencyGraph} for each step in the saga,
+ * including the {@link sagaIbGib} passed in.
+ * @returns ordered array of saga frame dependency graphs
+ */
+export async function getFullSyncSagaHistory({
+    sagaIbGib,
+    space,
+}: {
+    sagaIbGib: SyncIbGib_V1,
+    space: IbGibSpaceAny,
+}): Promise<SyncSagaFrameDependencyGraph[]> {
+    const lc = `[${getFullSyncSagaHistory.name}]`;
+    try {
+        if (logalot) { console.log(`${lc} starting... (I: 1ea3f804dd07d1e917a2afaaad497826)`); }
+        if (!sagaIbGib.data) { throw new Error(`(UNEXPECTED) sagaIbGib.data falsy? (E: fe0a0d0965e87ac852fe7ba4710cc826)`); }
+        if (!sagaIbGib.rel8ns) { throw new Error(`(UNEXPECTED) sagaIbGib.rel8ns falsy? (E: b79ff82a732346bdf8a9e1eb9ac96826)`); }
+
+        const sagaAddr = getIbGibAddr({ ibGib: sagaIbGib });
+
+        const addrs = sagaIbGib.rel8ns.past && sagaIbGib.rel8ns.past.length > 0 ?
+            [...sagaIbGib.rel8ns.past, sagaAddr] :
+            [sagaAddr];
+
+        const resGraphs: SyncSagaFrameDependencyGraph[] = [];
+        for (const addr of addrs) {
+            let sagaFrame: SyncIbGib_V1;
+            let resGet = await getFromSpace({ addr, space });
+            if (resGet.success && resGet.ibGibs && resGet.ibGibs.length === 1) {
+                sagaFrame = resGet.ibGibs[0] as SyncIbGib_V1;
+            } else {
+                if (logalot) { console.log(`${lc} failed getting full history of sagaIbGib:\n${pretty(sagaIbGib)} (I: 2a35685bfe038f63182c7db39b44c826)`); }
+                throw new Error(`couldn't get saga addr (${addr}) from space (${space.ib}) (E: 865b78ecd918c244158813650bea7d26)`);
+            }
+            const graph = await getSyncSagaFrameDependencyGraph({
+                sagaIbGib: sagaFrame, localSpace: space,
+            });
+            resGraphs.push(graph);
+        }
+
+        // the \n are my my attempt at lining up an indent
+        if (logalot) { console.log(`${lc} resGraphs:...\n  ${pretty(resGraphs).split('\n').join('\n  ')}\n...(I: d8e11827d88a3454d887ff05fb4ff526)`); }
+
+        return resGraphs;
+    } catch (error) {
+        console.error(`${lc} ${extractErrorMsg(error)}`);
+        throw error;
+    } finally {
+        if (logalot) { console.log(`${lc} complete.`); }
+    }
+}
+
 /**
  * only validates this single frame. does not validate any dependencies or past.
  * @returns array of errors, empty if valid
@@ -282,6 +336,23 @@ export async function validateSyncSagaFrame({
     }
 }
 
+export async function validateFullSyncSagaHistory({
+    history,
+}: {
+    history: SyncSagaFrameDependencyGraph[],
+}): Promise<string[]> {
+    const lc = `[${validateFullSyncSagaHistory.name}]`;
+    try {
+        if (logalot) { console.log(`${lc} starting... (I: df02b802f6989096b8d8f728e2c0a526)`); }
+        console.error(`${lc} NAG ERROR (NOT THROWN) need to implement more validation on full saga history. (E: 9bfcc9247a1c783fd361a4a8216fef26)`)
+        return [];
+    } catch (error) {
+        console.error(`${lc} ${extractErrorMsg(error)}`);
+        throw error;
+    } finally {
+        if (logalot) { console.log(`${lc} complete.`); }
+    }
+}
 
 export async function putInSpace_dnasThenNonDnas({
     ibGibs,
@@ -289,7 +360,7 @@ export async function putInSpace_dnasThenNonDnas({
 }: {
     ibGibs: IbGib_V1[],
     space: IbGibSpaceAny,
-}): Promise<void> {
+}): Promise<{ payload_Dnas: IbGib_V1[], payload_NonDnas: IbGib_V1[] }> {
     const lc = `[${putInSpace_dnasThenNonDnas.name}]`;
     try {
         if (logalot) { console.log(`${lc} starting... (I: aa3ab828402836b3914800a8ffa1b826)`); }
@@ -313,6 +384,42 @@ export async function putInSpace_dnasThenNonDnas({
 
         // then put all non-dnas ("regular" ibgibs) in the space
         await putInSpace({ ibGibs: payload_NonDnas, isDna: false, space, });
+
+        return { payload_Dnas, payload_NonDnas };
+    } catch (error) {
+        console.error(`${lc} ${extractErrorMsg(error)}`);
+        throw error;
+    } finally {
+        if (logalot) { console.log(`${lc} complete.`); }
+    }
+}
+
+/**
+ * @see {@link SyncExecutionContext}
+ */
+export function getExecutionContext({
+    sagaFrame,
+}: {
+    sagaFrame: SyncIbGib_V1,
+}): SyncExecutionContext {
+    const lc = `[${getExecutionContext.name}]`;
+    try {
+        if (logalot) { console.log(`${lc} starting... (I: 93521332d0dd2f5e88398b7db95e8126)`); }
+        if (!sagaFrame) { throw new Error(`(UNEXPECTED) sagaFrame falsy? (E: 01fb28be6668d88ea49bb298c739c926)`); }
+        if (!sagaFrame.data) { throw new Error(`(UNEXPECTED) sagaFrame.data falsy? (E: 998298eb17685bdb9a85b46488ccd826)`); }
+        if (!sagaFrame.data.n && sagaFrame.data.n !== 0) { throw new Error(`(UNEXPECTED) sagaFrame.data.n falsy and not 0? (E: 0394919d5b58300ceb09ba6a264ad826)`); }
+
+        const modulo = sagaFrame.data.n % 2;
+        // even => sender
+        // odd => receiver
+
+        if (modulo === 0) {
+            return SyncExecutionContext.sender;
+        } else if (modulo === 1) {
+            return SyncExecutionContext.receiver;
+        } else {
+            throw new Error(`(UNEXPECTED) modulo is neither 0 nor 1? my logic sucks! This was way too defensive on my part... (E: 559488a2eef8d17b57079ca8886ee826)`);
+        }
     } catch (error) {
         console.error(`${lc} ${extractErrorMsg(error)}`);
         throw error;

package/src/sync/sync-peer/sync-peer-innerspace/sync-peer-innerspace-v1.mts

@@ -2,7 +2,7 @@
  * @module SyncPeerInnerspace_V1
  */
 
-import { delay, extractErrorMsg, unique } from '@ibgib/helper-gib/dist/helpers/utils-helper.mjs';
+import { delay, extractErrorMsg, pretty, unique } from '@ibgib/helper-gib/dist/helpers/utils-helper.mjs';
 import { getIbGibAddr } from '@ibgib/ts-gib/dist/helper.mjs';
 import { IbGibAddr } from '@ibgib/ts-gib/dist/types.mjs';
 import { IbGib_V1, IbGibData_V1 } from '@ibgib/ts-gib/dist/V1/types.mjs';
@@ -21,8 +21,9 @@ import { InitializeSyncPeerOpts } from '../sync-peer-types.mjs';
 import { getSyncSagaMessageFromFrame } from '../../sync-saga-message/sync-saga-message-helpers.mjs';
 import { SYNC_STAGE_VALID_VALUES, SyncStage } from '../../sync-constants.mjs';
 import { SyncSagaMessageAckData_V1, SyncSagaMessageCommitData_V1, SyncSagaMessageData_V1, SyncSagaMessageDeltaData_V1, SyncSagaMessageInitData_V1 } from '../../sync-saga-message/sync-saga-message-types.mjs';
-import { getSyncSagaFrameDependencyGraph, putInSpace_dnasThenNonDnas } from '../../sync-helpers.mjs';
+import { getExecutionContext, getSyncSagaFrameDependencyGraph, putInSpace_dnasThenNonDnas } from '../../sync-helpers.mjs';
 import { splitPerTjpAndOrDna, toDto } from '../../../common/other/ibgib-helper.mjs';
+import { SyncExecutionContext } from '../../sync-types.mjs';
 
 
 const logalot = GLOBAL_LOG_A_LOT || true;
@@ -133,8 +134,25 @@ export class SyncPeerInnerspace_V1 extends SyncPeer_V1<InitializeSyncPeerInnersp
             if (!sagaFrame.data) { throw new Error(`(UNEXPECTED) sagaFrame.data falsy? (E: f30e290a8b770e1b387377420ea73a26)`); }
             if (!sagaFrame.rel8ns) { throw new Error(`(UNEXPECTED) sagaFrame.rel8ns falsy? (E: f888caa698b8cf6b4893b7fd6df09726)`); }
             if (!receiverTempSpace) { throw new Error(`(UNEXPECTED) receiverTempSpace falsy? (E: 3b46d838f6fc645c58b29215bfddb826)`); }
+            if (!senderTempSpace) { throw new Error(`(UNEXPECTED) senderTempSpace falsy? (E: b187a8f913c2295ae90d7ae2b47b6a26)`); }
             // #endregion sanity validation assertions
 
+            // let localSpace: IbGibSpaceAny;
+            // let localTempSpace: IbGibSpaceAny;
+            // let remoteSpace: IbGibSpaceAny;
+            // let remoteTempSpace: IbGibSpaceAny;
+            // if (getExecutionContext({ sagaFrame: context.sagaFrame }) === SyncExecutionContext.sender) {
+            //     localSpace = senderSpace;
+            //     localTempSpace = senderTempSpace;
+            //     remoteSpace = receiverSpace;
+            //     remoteTempSpace = receiverTempSpace;
+            // } else {
+            //     localSpace = receiverSpace;
+            //     localTempSpace = receiverTempSpace;
+            //     remoteSpace = senderSpace;
+            //     remoteTempSpace = senderSpace;
+            // }
+
             const { sagaIbGib: _alreadyHave, msgStones, identities } = await getSyncSagaFrameDependencyGraph({
                 sagaIbGib: sagaFrame,
                 localSpace: senderSpace,
@@ -184,27 +202,31 @@ export class SyncPeerInnerspace_V1 extends SyncPeer_V1<InitializeSyncPeerInnersp
             // the payload ibgibs. so the receiver coordinator should be ready
             // to do its thing.
 
-            const responseCtx = await receiverCoordinator.receiverContinueSync({
+            const responseCtx = await receiverCoordinator.continueSync({
                 sagaContext: context,
                 metaspace: receiverMetaspace,
                 mySpace: receiverSpace,
                 myTempSpace: receiverTempSpace,
             });
 
+            if (logalot) { console.log(`${lc} receiverCoordinator.continueSync responseCtx: ${responseCtx ? pretty(responseCtx) : 'undefined'} (I: fb2831decde1f2b3589021f85ab19126)`); }
+
             if (!responseCtx) {
                 if (logalot) { console.log(`${lc} receiver produced undefined response context. (I: 2e1888ffc9e836689d5b171887c36d26)`); }
                 return undefined; /* <<<< returns early */
             }
 
             // at this point, we have received the full response from the
-            // receiver coordinator. Put the response's control ibgibs in the
-            // sender's durable space (but don't register them), spin off the
-            // process of any response payloads, and return the context.
+            // receiver coordinator. That coordinator has put the control ibgibs
+            // in its durable space. Now we need to put the response's control
+            // ibgibs in the sender's durable space (register them??), spin off
+            // the process of any response payloads, and return the context.
 
+            // get control ibgibs from the receiver space...
             const { msgStones: msgStonesResponse, identities: identitiesResponse } =
                 await getSyncSagaFrameDependencyGraph({
                     sagaIbGib: responseCtx.sagaFrame,
-                    localSpace: senderSpace,
+                    localSpace: receiverSpace,
                 });
             if (msgStonesResponse.length !== 1) { throw new Error(`(UNEXPECTED) msgStonesResponse.length !== 1? we're only geared for a single msg stone that is always present (not 0, not greater than 1) (E: 2d3138ed130f1aca116551889483e826)`); }
             const msgResponse = msgStonesResponse[0];
@@ -212,6 +234,7 @@ export class SyncPeerInnerspace_V1 extends SyncPeer_V1<InitializeSyncPeerInnersp
             const responsePayloadIbGibsControl = [
                 ...identities, msgResponse, responseCtx.sagaFrame, context
             ].map(x => toDto({ ibGib: x }));
+            // ...put into sender's durable space
             await putInSpace({
                 ibGibs: responsePayloadIbGibsControl,
                 space: senderSpace,
@@ -240,7 +263,6 @@ export class SyncPeerInnerspace_V1 extends SyncPeer_V1<InitializeSyncPeerInnersp
                             await delay(delayMs);
                         }
 
-                        if (!senderTempSpace) { throw new Error(`(UNEXPECTED) senderTempSpace falsy? (E: b187a8f913c2295ae90d7ae2b47b6a26)`); }
 
                         await putInSpace_dnasThenNonDnas({
                             ibGibs: payloadIbGibsDomain_response,

package/src/sync/sync-peer/sync-peer-v1.mts

@@ -189,6 +189,8 @@ export abstract class SyncPeer_V1<TInitializeOpts extends InitializeSyncPeerOpts
 
             // at this point, we have a valid, authenticated, authorized context
 
+            await this.ensureReceiverTempSpace();
+
             // execute the transfer of control domain ibgibs & outgoing payload
             // ibgibs...
             const response = await this.sendContextRequest(context);

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

@@ -60,9 +60,10 @@ export async function getSyncSagaContextIb({
         if (!data) { throw new Error(`data required (E: 839d82138c234b3e89582855594191fe)`); }
 
         const payloadCount = data['@payloadAddrsDomain'] ? data['@payloadAddrsDomain'].length : 0;
-        // sync_sagacontext cmd
+
         const ib = [
             SYNC_SAGA_CONTEXT_ATOM,
+            data.sagaN,
             payloadCount,
         ].join(' ');
 
@@ -89,6 +90,7 @@ export async function parseSyncSagaContextIb({
         }
         const [
             atom,
+            sagaNStr,
             payloadCountStr,
         ] = parts;
 
@@ -96,13 +98,19 @@ export async function parseSyncSagaContextIb({
             throw new Error(`Atom mismatch. Expected ${SYNC_SAGA_CONTEXT_ATOM}. Got ${atom}. (E: 67d71fc0f8d04840b178652309f471f5)`);
         }
 
+        if (!sagaNStr) { throw new Error(`invalid ib. second piece should be sagaN but is falsy (E: 081ed475aeb8fe25a66f60466b2e5826)`); }
+        const sagaN = parseInt(sagaNStr);
+        if (isNaN(sagaN)) {
+            throw new Error(`sagaNStr is not a number. (E: 3d6b580d5a48c5e03ecec288896e2826)`);
+        }
+
         if (!payloadCountStr) { throw new Error(`invalid ib. second piece should be payloadCount but is falsy (E: 0bb7580793d800ca02227828a7294826)`); }
         const payloadCount = parseInt(payloadCountStr);
         if (isNaN(payloadCount)) {
             throw new Error(`payloadCountStr is not a number. (E: 49457814282a44069871630987588722)`);
         }
 
-        return { atom, payloadCount };
+        return { atom, sagaN, payloadCount };
     } catch (error) {
         console.error(`${lc} ${extractErrorMsg(error)}`);
         throw error;
@@ -130,6 +138,9 @@ export async function createSyncSagaContext({
     try {
         if (logalot) { console.log(`${lc} starting... (I: 6b87bee313e811d1d2fc90e87fbec826)`); }
 
+        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)`); }
+
         const date = new Date();
         const timestamp = getTimestamp(date);
         const timestampMs = date.getMilliseconds();
@@ -137,6 +148,7 @@ export async function createSyncSagaContext({
         const data: SyncSagaContextData_V1 = {
             timestamp,
             timestampMs,
+            sagaN: sagaFrame.data.n,
         };
 
         // Domain Payloads

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

@@ -11,6 +11,10 @@ import { SYNC_SAGA_CONTEXT_ATOM } from './sync-saga-context-constants.mjs';
 
 export interface SyncSagaContextIb_V1 {
     atom: typeof SYNC_SAGA_CONTEXT_ATOM;
+    /**
+     * sagaFrame.data.n value
+     */
+    sagaN: number;
     /**
      * simple metadata count of data["@payloadAddrsDomain"]
      */
@@ -21,6 +25,10 @@ export interface SyncSagaContextIb_V1 {
  * Data payload for the Sync Saga Context.
  */
 export interface SyncSagaContextData_V1 extends IbGibData_V1 {
+    /**
+     * context's sagaFrame.data.n value
+     */
+    sagaN: number;
     /**
      * Payload data addresses for DOMAIN ibGibs (Timeline frames, user content).
      * Soft-linked via data property to avoid hard-linking graph dependencies.
@@ -35,7 +43,7 @@ export interface SyncSagaContextData_V1 extends IbGibData_V1 {
 export interface SyncSagaContextRel8ns_V1 extends IbGibRel8ns_V1 {
     /**
      * The primary Saga Frame being transported (Init, Ack, Delta, etc.).
-     * 
+     *
      * Should be a single addr.
      */
     sagaFrame: IbGibAddr[];
@@ -43,9 +51,9 @@ 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.
      */
@@ -59,7 +67,7 @@ export interface SyncSagaContextRel8ns_V1 extends IbGibRel8ns_V1 {
 export interface SyncSagaContextIbGib_V1 extends IbGib_V1<SyncSagaContextData_V1, SyncSagaContextRel8ns_V1> {
     /**
      * Domain ibgibs - OUTBOUND only.
-     * 
+     *
      * For inbound, the domain payload ibgibs are streamed via observable in the
      * peer.
      */
@@ -67,7 +75,7 @@ export interface SyncSagaContextIbGib_V1 extends IbGib_V1<SyncSagaContextData_V1
 
     /**
      * Reference to the actual sync saga frame that this context conveys.
-     * 
+     *
      * This frame's addr should be {@link SyncSagaContextRel8ns_V1.sagaFrame}.
      */
     sagaFrame: SyncIbGib_V1;