@ibgib/core-gib 0.1.23 → 0.1.26

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;
 
@@ -111,13 +112,13 @@ export async function parseSyncSagaContextIb({
 /**
  * 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}. 
+ * put/registered in {@link localSpace}.
  */
 export async function createSyncSagaContext({
     sagaFrame,
@@ -138,7 +139,7 @@ export async function createSyncSagaContext({
             timestampMs,
         };
 
-        // Domain Payloads 
+        // Domain Payloads
         const payloadAddrsDomain = payloadIbGibsDomain ?
             payloadIbGibsDomain?.map(x => getIbGibAddr({ ibGib: x })) :
             undefined;
@@ -189,10 +190,19 @@ export async function createSyncSagaContext({
 }
 
 /**
- * move to sync-peer-helpers.mts as a pure function?
+ * 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 validateContext({ context }: { context: SyncSagaContextIbGib_V1 }): Promise<string[]> {
-    const lc = `[${validateContext.name}]`;
+export async function validateContextAndSagaFrame({ context }: { context: SyncSagaContextIbGib_V1 }): Promise<string[]> {
+    const lc = `[${validateContextAndSagaFrame.name}]`;
     try {
         if (logalot) { console.log(`${lc} starting... (I: 7797f8294bd8f7e5089cb722ad468226)`); }
 
@@ -206,20 +216,87 @@ export async function validateContext({ context }: { context: SyncSagaContextIbG
         }
 
         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)`);
         }
 
+        // 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
+        // that are not ib, gib, data, or rel8ns) match the data in the
+        // context object~~ NO. THIS WILL BE IN A SEPARATE FUNCTION.
+        // See `validateContextDomainPayloadIbGibs`
 
+        // throw new Error(`not implemented (E: cb639658e1183fa6c8a4ebca023ba926)`);
 
-        // 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
+        console.error(`${lc} NAG ERROR MSG (NOT THROWN): not fully implemented yet (E: d574d85cb578637648ed403857f7a826)`);
+        return [];
+    } catch (error) {
+        console.error(`${lc} ${extractErrorMsg(error)}`);
+        throw error;
+    } finally {
+        if (logalot) { console.log(`${lc} complete.`); }
+    }
+}
+
+
+/**
+ * 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
+ */
+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.`); }
+    }
+}
+
+/**
+ * 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)`);
 
-        throw new Error(`not implemented (E: cb639658e1183fa6c8a4ebca023ba926)`);
+        return [];
     } catch (error) {
         console.error(`${lc} ${extractErrorMsg(error)}`);
         throw error;