@ibgib/core-gib 0.1.21 → 0.1.23

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

@@ -0,0 +1,72 @@
+/**
+ * @module sync peer innerspace helpers
+ */
+
+import { extractErrorMsg } from '@ibgib/helper-gib/dist/helpers/utils-helper.mjs';
+import { Ib } from '@ibgib/ts-gib/dist/types.mjs';
+
+import { SYNC_PEER_INNERSPACE_ATOM } from './sync-peer-innerspace-constants.mjs';
+import { SyncPeerInnerspaceIb_V1, SyncPeerInnerspaceData_V1 } from './sync-peer-innerspace-types.mjs';
+
+/**
+ * Constructs the standard 'ib' string for a Sync Peer Innerspace stone.
+ */
+export async function getSyncPeerInnerspaceIb({
+    data,
+}: {
+    data: SyncPeerInnerspaceData_V1,
+}): Promise<Ib> {
+    const lc = `[${getSyncPeerInnerspaceIb.name}]`;
+    try {
+        if (!data) { throw new Error(`data required (E: 7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d)`); }
+
+        if (!data.classname) { throw new Error(`invalid data. data.classname required. (E: 3aad38bfe23866c2d8c1ca66b03d9126)`); }
+
+        // sync_peer_innerspace
+        const ib = [
+            SYNC_PEER_INNERSPACE_ATOM,
+            data.classname,
+        ].join(' ');
+
+        return ib;
+    } catch (error) {
+        console.error(`${lc} ${extractErrorMsg(error)}`);
+        throw error;
+    }
+}
+
+/**
+ * Parses a standard Sync Peer Innerspace 'ib' string.
+ */
+export async function parseSyncPeerInnerspaceIb({
+    ib,
+}: {
+    ib: Ib,
+}): Promise<SyncPeerInnerspaceIb_V1> {
+    const lc = `[${parseSyncPeerInnerspaceIb.name}]`;
+    try {
+        if (ib !== SYNC_PEER_INNERSPACE_ATOM) {
+            throw new Error(`Atom mismatch. Expected ${SYNC_PEER_INNERSPACE_ATOM}. Got ${ib}. (E: 8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e)`);
+        }
+
+        const pieces = ib.split(' ');
+
+        if (pieces.length !== 2) {
+            throw new Error(`invalid ib. expected 2 pieces: atom and classname (E: f9c0c8067368444bac69f5777eeaa826)`);
+        }
+
+        const [
+            atom,
+            classname
+        ] = pieces;
+
+        if (atom !== SYNC_PEER_INNERSPACE_ATOM) {
+            throw new Error(`invalid ib. atom (${atom}) is expected to be ${SYNC_PEER_INNERSPACE_ATOM} (E: fda078ef3a0853629eb22e48a01a8826)`);
+        }
+
+        return { atom, classname };
+    } catch (error) {
+        console.error(`${lc} ${extractErrorMsg(error)}`);
+        throw error;
+    }
+}

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

@@ -0,0 +1,72 @@
+/**
+ * @module sync peer innerspace types
+ */
+
+import { IbGibData_V1, IbGibRel8ns_V1, IbGib_V1 } from '@ibgib/ts-gib/dist/V1/types.mjs';
+
+import { MetaspaceService } from "../../../witness/space/metaspace/metaspace-types.mjs";
+import { IbGibSpaceAny } from "../../../witness/space/space-base-v1.mjs";
+import { SyncSagaCoordinator } from "../../sync-saga-coordinator.mjs";
+import { SYNC_PEER_INNERSPACE_ATOM } from './sync-peer-innerspace-constants.mjs';
+import { SyncPeerData_V1, SyncPeerRel8ns_V1 } from '../sync-peer-types.mjs';
+
+/**
+ * Options for creating a SyncPeerInnerspace instance.
+ */
+export interface SyncPeerInnerspaceOptions {
+    /**
+     * The "receiver" durable space (not temp). 
+     * 
+     * ## notes
+     * 
+     * when syncing/merging locally, we are working with two spaces and this
+     * acts as the "remote" space even though it's technically still local.
+     */
+    receiverSpace: IbGibSpaceAny;
+    /**
+     * Coordinator for the "receiver". 
+     * 
+     * @see {@link receiverSpace} notes.
+     */
+    receiverCoordinator: SyncSagaCoordinator;
+    /**
+     * Metaspace for the "receiver". 
+     * 
+     * @see {@link receiverSpace} notes.
+     */
+    receiverMetaspace: MetaspaceService;
+    /**
+     * Temporary sync transaction space for the "receiver", for storage of
+     * domain ibgibs created/received throughout the sync saga until commit.
+     * 
+     * @see {@link receiverSpace} notes.
+     */
+    receiverTempSpace: IbGibSpaceAny;
+}
+
+export interface SyncPeerInnerspaceIb_V1 {
+    atom: typeof SYNC_PEER_INNERSPACE_ATOM;
+    /**
+     * @see {@link SyncPeerInnerspaceData_V1.classname}
+     */
+    classname: string;
+}
+
+/**
+ * Data payload for the Sync Peer Innerspace.
+ */
+export interface SyncPeerInnerspaceData_V1 extends SyncPeerData_V1 {
+}
+
+/**
+ * Relationships for the Sync Peer Innerspace.
+ */
+export interface SyncPeerInnerspaceRel8ns_V1 extends SyncPeerRel8ns_V1 {
+    // Currently no specific rel8ns needed beyond base
+}
+
+/**
+ * The SyncPeerInnerspace ibGib.
+ */
+export interface SyncPeerInnerspaceIbGib_V1 extends IbGib_V1<SyncPeerInnerspaceData_V1, SyncPeerInnerspaceRel8ns_V1> {
+}

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

@@ -0,0 +1,193 @@
+/**
+ * @module SyncPeerInnerspace_V1
+ */
+
+import { extractErrorMsg, 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 { GLOBAL_LOG_A_LOT } from '../../../core-constants.mjs';
+import { IbGibSpaceAny } from '../../../witness/space/space-base-v1.mjs';
+import { SyncPeer_V1 } from '../sync-peer-v1.mjs';
+import { getFromSpace, putInSpace } from '../../../witness/space/space-helper.mjs';
+import { SyncSagaContextIbGib_V1, } from '../../sync-saga-context/sync-saga-context-types.mjs';
+import { SyncPeerInnerspaceData_V1, SyncPeerInnerspaceIbGib_V1, SyncPeerInnerspaceOptions, SyncPeerInnerspaceRel8ns_V1 } from './sync-peer-innerspace-types.mjs';
+import { MetaspaceService } from '../../../witness/space/metaspace/metaspace-types.mjs';
+import { SyncSagaCoordinator } from '../../sync-saga-coordinator.mjs';
+import { IbGibSpaceResultData } from '../../../witness/space/space-types.mjs';
+
+
+const logalot = GLOBAL_LOG_A_LOT || true;
+const logalotControlDomain = true;
+const lcControlDomain = '[ControlDomain]';
+
+/**
+ * Concrete implementation of SyncPeer for local in-memory simulation (Innerspace to Innerspace).
+ * 
+ * Acts as the "Network" layer, transferring data between two local spaces and 
+ * executing the receiver's coordinator logic.
+ */
+export class SyncPeerInnerspace_V1 extends SyncPeer_V1 implements SyncPeerInnerspaceIbGib_V1 {
+
+    protected lc: string = `[${SyncPeerInnerspace_V1.name}]`;
+
+    /**
+     * specific to innerspace
+     */
+    protected receiverCoordinator: SyncSagaCoordinator;
+    /**
+     * specific to innerspace
+     */
+    protected receiverMetaspace: MetaspaceService;
+    public receiverSpace: IbGibSpaceAny;
+    public receiverTempSpace: IbGibSpaceAny;
+
+    override get classname(): string {
+        return SyncPeerInnerspace_V1.name;
+    }
+
+    constructor(
+        senderSpace: IbGibSpaceAny,
+        senderTempSpace: IbGibSpaceAny,
+        opts: SyncPeerInnerspaceOptions,
+        initialData: SyncPeerInnerspaceData_V1,
+        initialRel8ns?: SyncPeerInnerspaceRel8ns_V1,
+    ) {
+        super(senderSpace, senderTempSpace, initialData, initialRel8ns);
+        const {
+            receiverCoordinator,
+            receiverMetaspace, receiverSpace, receiverTempSpace
+        } = opts;
+
+        this.receiverCoordinator = receiverCoordinator;
+        this.receiverMetaspace = receiverMetaspace;
+        this.receiverSpace = receiverSpace;
+        this.receiverTempSpace = receiverTempSpace;
+    }
+
+    protected override async ensureReceiverTempSpace(): Promise<IbGibSpaceAny> {
+        if (!this.receiverTempSpace) {
+            const { receiverMetaspace } = this;
+
+            const uuid = crypto.randomUUID ? crypto.randomUUID() : Math.random().toString(36);
+            const tempSpaceName = `tmp_sync_recv_${uuid.substring(0, 8)}`;
+            const receiverTempSpace = await this.receiverMetaspace.createNewLocalSpace({
+                opts: {
+                    allowCancel: false,
+                    spaceName: tempSpaceName,
+                    getFnPrompt: this.receiverMetaspace.getFnPrompt!,
+                    logalot
+                }
+            });
+            if (!receiverTempSpace) { throw new Error(`(UNEXPECTED) receiverTempSpace falsy? couldn't create a temp space? (E: a6b8f86b0f58384b884a33b82924b826)`); }
+            await receiverTempSpace.initialized;
+            this.receiverTempSpace = receiverTempSpace;
+        }
+        return this.receiverTempSpace;
+    }
+
+
+    protected async push(addrs: IbGibAddr[]): Promise<void> {
+        const lc = `${this.lc}[${this.push.name}]`;
+        try {
+            if (logalot) { console.log(`${lc} starting... (I: 07bce80be18f3259b8a311ed9c4da926)`); }
+
+            // silly defensive checks because this has been a ridiculous development cycle
+            if (!this.senderSpace) { throw new Error(`(UNEXPECTED) this.senderSpace falsy? (E: 503e288168f5d297f4d4e028bc538826)`); }
+            if (!this.receiverSpace) { throw new Error(`(UNEXPECTED) this.receiverSpace falsy? (E: 0bd7c1a0ba4868ac7a260e15b504e826)`); }
+
+            await this.transfer({ addrs, from: this.senderSpace, to: this.receiverSpace });
+        } catch (error) {
+            console.error(`${lc} ${extractErrorMsg(error)}`);
+            throw error;
+        } finally {
+            if (logalot) { console.log(`${lc} complete.`); }
+        }
+    }
+
+    protected async pull(addrs: IbGibAddr[]): Promise<void> {
+        const lc = `${this.lc}[${this.pull.name}]`;
+        try {
+            if (logalot) { console.log(`${lc} starting... (I: b16a28ed0dc8f52f1838ee257d9b1126)`); }
+
+            // silly defensive checks because this has been a ridiculous development cycle
+            if (!this.receiverSpace) { throw new Error(`(UNEXPECTED) this.receiverSpace falsy? (E: bd2fdfa89ba4c89a185b68e9bb1f1c26)`); }
+            if (!this.senderTempSpace) { throw new Error(`(UNEXPECTED) this.senderTempSpace falsy? (E: b23fa55713f881493dac4a9835ac7326)`); }
+
+            await this.transfer({ addrs, from: this.receiverSpace, to: this.senderTempSpace });
+        } catch (error) {
+            console.error(`${lc} ${extractErrorMsg(error)}`);
+            throw error;
+        } finally {
+            if (logalot) { console.log(`${lc} complete.`); }
+        }
+    }
+
+    protected async sendContextRequest(context: SyncSagaContextIbGib_V1): Promise<SyncSagaContextIbGib_V1 | undefined> {
+        const lc = `${this.lc}[${this.sendContextRequest.name}]`;
+        const { receiverSpace, receiverCoordinator, receiverMetaspace } = this;
+
+        try {
+            if (logalot) { console.log(`${lc} starting...Context: ${getIbGibAddr({ ibGib: context })}`); }
+
+            // 0. Validate context (naive, not business logic validation)
+            if (!context.data) { throw new Error(`(UNEXPECTED) context.data falsy? (E: 1d2ac8a9b991d451e8900588057fe626)`); }
+            if (!context.rel8ns) { throw new Error(`(UNEXPECTED) context.rel8ns falsy? (E: 3508786f0d8880bcadd346282a807826)`); }
+            if (!context.rel8ns.sagaFrame) { throw new Error(`(UNEXPECTED) context.rel8ns.sagaFrame falsy? (E: ac06782ad538be406882605f0a83aa26)`); }
+            if (!context.sagaFrame) { throw new Error(`(UNEXPECTED) context.sagaFrame falsy? (E: 79cd98a6d9b88a591f4596c8bc58ff26)`); }
+
+
+
+            throw new Error(`not implemented (E: 72840872e252d9f7380f1998b5a0c826)`);
+        } catch (error) {
+            console.error(`${lc} ${extractErrorMsg(error)}`);
+            throw error;
+        }
+    }
+
+    /**
+     * Helper to copy single ibgib from A to B.
+     */
+    protected async transfer({
+        addrs,
+        from,
+        to
+    }: {
+        addrs: IbGibAddr[],
+        from: IbGibSpaceAny,
+        to: IbGibSpaceAny
+    }): Promise<void> {
+        const lc = `${this.lc}[${this.transfer.name}]`;
+        try {
+            if (logalot) { console.log(`${lc} starting... (I: f1145dc75a461afc885efe984f08d426)`); }
+
+            console.error(`${lc} NAG ERROR (DOES NOT THROW): This needs to be adapted to be able to pull from multiple spaces. IOW, the 'from' param should be an array of spaces. This is because we need to be checking both durable and temp spaces when querying. (E: 823f3856b8b82ece080868e85ded0826)`)
+
+            // 1. Get from Source
+            const resGet = await getFromSpace({ space: from, addrs });
+            if (!resGet.success || !resGet.ibGibs || resGet.ibGibs.length !== addrs.length) {
+                if (!resGet.rawResultIbGib) { throw new Error(`(UNEXPECTED) resGet.rawResultIbGib falsy? (E: b829f827a378890bcf7dc3d41c908826)`); }
+                if (!resGet.rawResultIbGib.data) { throw new Error(`(UNEXPECTED) resGet.rawResultIbGib.data falsy? (E: 8d15341d8fa8fc96297425e3c6e39226)`); }
+                const data = resGet.rawResultIbGib.data as IbGibSpaceResultData;
+
+                throw new Error(`${lc} Failed to get all ${addrs} from source space ${from.ib}. resGet.errorMsg: ${resGet.errorMsg}. failed info: ${JSON.stringify(data)} (E: 4ed3383573382920c80054d7c1024626)`);
+            }
+            const ibGibs = resGet.ibGibs.concat();
+
+            // 2. Put in Dest
+            // Note: putInSpace handles existence check usually, or we can check.
+            const resPut = await putInSpace({ space: to, ibGibs });
+            if (resPut.success) {
+                console.error(`${lc} NAG ERROR: (SORT OF AN ERROR, DID NOT THROW): is the sync peer responsible for calling registerNewIbGib?? I'm not sure at this point if that is true, rather, I think that it probably is NOT responsible for this. But I'm putting this error msg as a nag message until this is resolved. (E: 00086833e294ee834800046801c47826) `);
+            } else {
+                throw new Error(`ERROR: successfully got addrs (${addrs}) from space (${from.ib}), BUT failed to put into space (${to.ib}). resPut.errorMsg: ${resPut.errorMsg}. timedOut: ${resPut.timedOut}. (E: c1044e14cc1db72d28a2240819dab826)`);
+            }
+        } catch (error) {
+            console.error(`${lc} ${extractErrorMsg(error)}`);
+            throw error;
+        } finally {
+            if (logalot) { console.log(`${lc} complete.`); }
+        }
+
+    }
+}

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

@@ -3,15 +3,20 @@
  */
 
 import { IbGibData_V1, IbGibRel8ns_V1, IbGib_V1 } from '@ibgib/ts-gib/dist/V1/types.mjs';
+import { SubjectWitness } from '../../common/pubsub/subject/subject-types.mjs';
 
 import { SyncSagaContextData_V1, SyncSagaContextIbGib_V1, SyncSagaContextRel8ns_V1 } from '../sync-saga-context/sync-saga-context-types.mjs';
 import { Witness_V1 } from '../../witness/witness-types.mjs';
+import { IbGibSpaceAny } from '../../witness/space/space-base-v1.mjs';
 
 /**
  * Data for the SyncPeer witness.
  */
 export interface SyncPeerData_V1 extends IbGibData_V1 {
-    // Add specific settings for Sync Peer if needed (e.g. timeout, retry policy)
+    /**
+     * Concrete peer instance
+     */
+    classname: string;
 }
 
 /**
@@ -40,4 +45,28 @@ export interface SyncPeerWitness extends Witness_V1<
     SyncPeerRel8ns_V1
 > {
     // witness(arg: SyncSagaContextIbGib_V1): Promise<SyncSagaContextIbGib_V1 | undefined>;
+
+    /**
+     * sender's durable space.
+     * 
+     * will store control ibgibs (context, sync saga ibgib, control msg stones)
+     * here (and in {@link senderTempSpace}) throughout the process for audit trail.
+     */
+    senderSpace: IbGibSpaceAny;
+    /**
+     * sender's temporary space for the entire sync transaction.
+     * 
+     * In addition to control ibgibs which are stored in both temp and durable
+     * spaces, this temp space will be where domain ibgibs are stored that are
+     * received/created throughout the transaction until commit.
+     */
+    senderTempSpace: IbGibSpaceAny;
+
+    /**
+     * Observable for streaming large domain payloads asynchronously.
+     * 
+     * Implementations should publish domain ibgibs to this observable as they are received.
+     * The handling code (e.g. SyncSagaCoordinator) will subscribe to this.
+     */
+    payloadIbGibsDomainReceived$: SubjectWitness<IbGib_V1>;
 }