@ibgib/core-gib 0.1.25 → 0.1.26

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

@@ -18,7 +18,7 @@ import { InitializeSyncPeerOpts, SyncPeerData_V1, SyncPeerRel8ns_V1, SyncPeerWit
 import { LightWitnessBase_V1 } from '../../witness/light-witness-base-v1.mjs';
 import { IbGibSpaceAny } from '../../witness/space/space-base-v1.mjs';
 import { newupSubject } from '../../common/pubsub/subject/subject-helper.mjs';
-import { validateContextAndSagaFrame } from '../sync-saga-context/sync-saga-context-helpers.mjs';
+import { authenticateContext, authorizeContext, validateContextAndSagaFrame } from '../sync-saga-context/sync-saga-context-helpers.mjs';
 import { getFromSpace } from '../../witness/space/space-helper.mjs';
 
 const logalot = GLOBAL_LOG_A_LOT || true;
@@ -178,34 +178,36 @@ export abstract class SyncPeer_V1<TInitializeOpts extends InitializeSyncPeerOpts
             if (validationErrors.length > 0) {
                 throw new Error(`invalid context received. validationErrors: ${validationErrors} (E: 8b34c875c968af29bc433138e57a7826)`);
             }
-            const authenticationErrors = await this.authenticateContext({ context });
+            const authenticationErrors = await authenticateContext({ context });
             if (authenticationErrors.length > 0) {
                 throw new Error(`invalid context authentication. authenticationErrors: ${authenticationErrors} (E: da89da5ee1269aeb78952d475d607526)`);
             }
-            const authorizationErrors = await this.authorizeContext({ context });
+            const authorizationErrors = await authorizeContext({ context });
             if (authorizationErrors.length > 0) {
                 throw new Error(`invalid context authorization. authorizationErrors: ${authorizationErrors} (E: 8ddc284a758cf10ba829334c1babb826)`);
             }
 
             // at this point, we have a valid, authenticated, authorized context
 
-            // 2. EXECUTE: Trigger Remote Processing
+            // execute the transfer of control domain ibgibs & outgoing payload
+            // ibgibs...
             const response = await this.sendContextRequest(context);
 
-            if (!response) {
-                if (logalot) { console.log(`${lc} No response from peer.`); }
-                return undefined;
-            }
-
-            // at this point, all outgoing payload domain ibgibs have been sent.
-            // we have received the response context, wherein the sync saga
-            // frame/msg stone(s) and any keystones should be evolved. Depending
-            // on the concrete implementation, if there are domain ibgibs to
-            // receive, they may still be transferring. These will be published
-            // to this.payloadIbGibsDomainReceived$
+            if (response) {
+                // at this point, all outgoing payload domain ibgibs have been sent.
+                // we have received the response context, wherein the sync saga
+                // frame/msg stone(s) and any keystones should be evolved. Depending
+                // on the concrete implementation, if there are domain ibgibs to
+                // receive, they may still be transferring. These will be published
+                // to this.payloadIbGibsDomainReceived$
 
-            return response;
+                return response;
+            } else {
+                // response falsy. we could be done, or this could be an error.
+                if (logalot) { console.log(`${lc} No response from peer. this may be normal if we just sent the very last commit frame. (I: 1855b7728c8898e1f9c001f8170ba826)`); }
 
+                return undefined;
+            }
         } catch (error) {
             console.error(`${lc} ${extractErrorMsg(error)}`);
             throw error;
@@ -215,75 +217,30 @@ export abstract class SyncPeer_V1<TInitializeOpts extends InitializeSyncPeerOpts
     }
 
     /**
+     * At this point, this is a validated, authenticated and authorized context
+     * to send.
+     *
      * This is responsible for:
      *
-     * * sending outgoing {@link context}, the sync saga frame and msg stone(s),
-     *   and identities...
+     * * physical sending outgoing {@link context}, the sync saga frame and msg
+     *   stone(s), and identities...
      * * AND sending OUTGOING domain ibgibs
      *   {@link SyncSagaContextIbGib_V1.payloadIbGibsDomain}
      * * getting back the other end's resultant context ibgib, sync saga frame
      *   and msg stone(s), and identities in their entirety...
      * * AND stream/receiving the RESPONSE payload domain ibgibs, publishing
      *   these to this.payloadIbGibsDomainReceived$.
+     *   * BUT this should return as soon as the resultant context ibgib comes
+     *     back.
      *
-     * So this returns the RESPONSE context, possibly BEFORE the RESPONSE domain
-     * ibgibs have been completely received/streamed. The coordinator is responsible
-     */
-    protected abstract sendContextRequest(context: SyncSagaContextIbGib_V1): Promise<SyncSagaContextIbGib_V1 | undefined>;
-
-    /**
-     * Pushes specific IbGib(s) (by address) from Local to Remote.
+     * So this returns the RESPONSE context, possibly BEFORE the response DOMAIN
+     * ibgibs have been completely received/streamed. The coordinator is
+     * responsible for awaiting this stream.
      *
-     * Should NOT have to handle identifying if the remote already has it
-     * (optimization), because the sync coordinator should be doing this in
-     * its diffing algorithm.
+     * @returns next sync saga context if another round, or undefined if we're
+     * done. (might throw if there's an error?)
      */
-    protected abstract push(addrs: IbGibAddr[]): Promise<void>;
-
-    /**
-     * Primitive: Pulls specific IbGib(s) (by address) from Remote to Local.
-     */
-    protected abstract pull(addrs: IbGibAddr[]): Promise<void>;
-
-
-
-    /**
-     * move to sync-peer-helpers.mts as a pure function?
-     */
-    protected async authenticateContext({ context }: { context: SyncSagaContextIbGib_V1 }): Promise<string[]> {
-        const lc = `${this.lc}[${this.authenticateContext.name}]`;
-        try {
-            if (logalot) { console.log(`${lc} starting... (I: 2677a482dfa873dcd1aa04a3031ff826)`); }
-
-            console.error(`${lc} NAG ERROR (NOT THROWN): not implemented. // todo: authenticate  (v1 must have this after we get merge logic workflow going) (E: bc3a78f2dab18ab64c36d055a4b50526)`);
-
-            return [];
-        } catch (error) {
-            console.error(`${lc} ${extractErrorMsg(error)}`);
-            throw error;
-        } finally {
-            if (logalot) { console.log(`${lc} complete.`); }
-        }
-    }
-
-    /**
-     * move to sync-peer-helpers.mts as a pure function?
-     */
-    protected async authorizeContext({ context }: { context: SyncSagaContextIbGib_V1 }): Promise<string[]> {
-        const lc = `${this.lc}[${this.authorizeContext.name}]`;
-        try {
-            if (logalot) { console.log(`${lc} starting... (I: 48c918b41ceec0cd489ca3b8819e6826)`); }
-
-            console.error(`${lc} NAG ERROR (NOT THROWN): not implemented. authorize business logic (v1 must have this, but later when we are working on admin vs. student)(E: bc3a78f2dab18ab64c36d055a4b50526)`);
-
-            return [];
-        } catch (error) {
-            console.error(`${lc} ${extractErrorMsg(error)}`);
-            throw error;
-        } finally {
-            if (logalot) { console.log(`${lc} complete.`); }
-        }
-    }
+    protected abstract sendContextRequest(context: SyncSagaContextIbGib_V1): Promise<SyncSagaContextIbGib_V1 | undefined>;
 
     /**
      * Abstract accessor to get an IbGib from the Local space/store.

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

@@ -19,6 +19,7 @@ import {
 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';
+import { validateSyncSagaFrame } from '../sync-helpers.mjs';
 
 const logalot = GLOBAL_LOG_A_LOT;
 
@@ -215,20 +216,27 @@ export async function validateContextAndSagaFrame({ context }: { context: SyncSa
         }
 
         if (context.sagaFrame) {
-
+            const sagaFrameErrors =
+                await validateSyncSagaFrame({ sagaIbGib: context.sagaFrame });
+            sagaFrameErrors.forEach(x => errors.push(x));
         } 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)
-
+        // if this is already invalid, we could have intrinsic validation errors, which are a non-starter.
+        if (errors.length > 0) { return errors; /* <<<< returns early */ }
 
+        // 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)
 
-        // ensure the non-dto properties on the context object (i.e. props
+        // ~~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
+        // context object~~ NO. THIS WILL BE IN A SEPARATE FUNCTION.
+        // See `validateContextDomainPayloadIbGibs`
+
+        // throw new Error(`not implemented (E: cb639658e1183fa6c8a4ebca023ba926)`);
 
-        throw new Error(`not implemented (E: cb639658e1183fa6c8a4ebca023ba926)`);
+        console.error(`${lc} NAG ERROR MSG (NOT THROWN): not fully implemented yet (E: d574d85cb578637648ed403857f7a826)`);
+        return [];
     } catch (error) {
         console.error(`${lc} ${extractErrorMsg(error)}`);
         throw error;
@@ -239,7 +247,9 @@ export async function validateContextAndSagaFrame({ context }: { context: SyncSa
 
 
 /**
- * validates the payload ibgibs ({@link SyncSagaContextIbGib_V1.payloadIbGibsDomain}) intrinsically
+ * validates {@link SyncSagaContextIbGib_V1.payloadIbGibsDomain} intrinsically,
+ * and ensures that these payloadIbGibs also match the expected addrs in
+ * {@link SyncSagaContextData_V1}[{@link SYNC_SAGA_PAYLOAD_ADDRS_DOMAIN}].
  *
  * @returns empty array if valid, else validation errors
  */
@@ -248,6 +258,44 @@ export async function validateContextDomainPayloadIbGibs({ context }: { context:
     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.`); }
+    }
+}
+
+/**
+ * move to sync-peer-helpers.mts as a pure function?
+ */
+export async function authenticateContext({ context }: { context: SyncSagaContextIbGib_V1 }): Promise<string[]> {
+    const lc = `[${authenticateContext.name}]`;
+    try {
+        if (logalot) { console.log(`${lc} starting... (I: 2677a482dfa873dcd1aa04a3031ff826)`); }
+
+        console.error(`${lc} NAG ERROR (NOT THROWN): not implemented. // todo: authenticate  (v1 must have this after we get merge logic workflow going) (E: bc3a78f2dab18ab64c36d055a4b50526)`);
+
+        return [];
+    } catch (error) {
+        console.error(`${lc} ${extractErrorMsg(error)}`);
+        throw error;
+    } finally {
+        if (logalot) { console.log(`${lc} complete.`); }
+    }
+}
+
+/**
+ * move to sync-peer-helpers.mts as a pure function?
+ */
+export async function authorizeContext({ context }: { context: SyncSagaContextIbGib_V1 }): Promise<string[]> {
+    const lc = `[${authorizeContext.name}]`;
+    try {
+        if (logalot) { console.log(`${lc} starting... (I: 48c918b41ceec0cd489ca3b8819e6826)`); }
+
+        console.error(`${lc} NAG ERROR (NOT THROWN): not implemented. authorize business logic (v1 must have this, but later when we are working on admin vs. student)(E: bc3a78f2dab18ab64c36d055a4b50526)`);
+
         return [];
     } catch (error) {
         console.error(`${lc} ${extractErrorMsg(error)}`);