@memberjunction/server 3.4.0 → 4.0.0

package/dist/generic/ResolverBase.js

@@ -9,10 +9,12 @@ import { EncryptionEngine } from '@memberjunction/encryption';
 import { PUSH_STATUS_UPDATES_TOPIC } from './PushStatusResolver.js';
 import { FieldMapper } from '@memberjunction/graphql-dataprovider';
 export class ResolverBase {
-    static _emit = process.env.CLOUDEVENTS_HTTP_TRANSPORT ? emitterFor(httpTransport(process.env.CLOUDEVENTS_HTTP_TRANSPORT)) : null;
-    static _cloudeventsHeaders = process.env.CLOUDEVENTS_HTTP_HEADERS ? JSON.parse(process.env.CLOUDEVENTS_HTTP_HEADERS) : {};
-    static _eventSubscriptionKey = '___MJServer___ResolverBase___EventSubscriptions';
+    static { this._emit = process.env.CLOUDEVENTS_HTTP_TRANSPORT ? emitterFor(httpTransport(process.env.CLOUDEVENTS_HTTP_TRANSPORT)) : null; }
+    static { this._cloudeventsHeaders = process.env.CLOUDEVENTS_HTTP_HEADERS ? JSON.parse(process.env.CLOUDEVENTS_HTTP_HEADERS) : {}; }
+    static { this._eventSubscriptionKey = '___MJServer___ResolverBase___EventSubscriptions'; }
     get EventSubscriptions() {
+        // here we use the global object store instead of a static member becuase in some cases based on import code paths/bundling/etc, the static member
+        // could actually be duplicated and we'd end up with multiple instances of the same map, which would be bad.
         const g = MJGlobal.Instance.GetGlobalObjectStore();
         if (!g[ResolverBase._eventSubscriptionKey]) {
             LogDebug(`>>>>> MJServer.ResolverBase.EventSubscriptions: Creating new Map - this should only happen once per server instance <<<<<<`);
@@ -20,15 +22,35 @@ export class ResolverBase {
         }
         return g[ResolverBase._eventSubscriptionKey];
     }
+    /**
+     * Maps field names to their GraphQL-safe CodeNames and handles encryption for API responses.
+     *
+     * For encrypted fields coming from raw SQL queries (not entity objects):
+     * - AllowDecryptInAPI=true: Decrypt the value before sending to client
+     * - AllowDecryptInAPI=false + SendEncryptedValue=true: Keep encrypted ciphertext
+     * - AllowDecryptInAPI=false + SendEncryptedValue=false: Replace with sentinel
+     *
+     * @param entityName - The entity name
+     * @param dataObject - The data object with field values
+     * @param contextUser - Optional user context for decryption (required for encrypted fields)
+     * @returns The processed data object
+     */
     async MapFieldNamesToCodeNames(entityName, dataObject, contextUser) {
+        // for the given entity name provided, check to see if there are any fields
+        // where the code name is different from the field name, and for just those
+        // fields, iterate through the dataObject and REPLACE the property that has the field name
+        // with the CodeName, because we can't transfer those via GraphQL as they are not
+        // valid property names in GraphQL
         if (dataObject) {
             const md = new Metadata();
             const entityInfo = md.Entities.find((e) => e.Name === entityName);
             if (!entityInfo)
                 throw new Error(`Entity ${entityName} not found in metadata`);
+            // const fields = entityInfo.Fields.filter((f) => f.Name !== f.CodeName || f.Name.startsWith('__mj_'));
             const mapper = new FieldMapper();
             entityInfo.Fields.forEach((f) => {
                 if (dataObject.hasOwnProperty(f.Name)) {
+                    // GraphQL doesn't allow us to pass back fields with __ so we are mapping our special field cases that start with __mj_ to _mj__ for transport - they are converted back on the other side automatically
                     const mappedFieldName = mapper.MapFieldName(f.CodeName);
                     if (mappedFieldName !== f.Name) {
                         dataObject[mappedFieldName] = dataObject[f.Name];
@@ -36,18 +58,22 @@ export class ResolverBase {
                     }
                 }
             });
+            // Handle encrypted fields - data from raw SQL queries is still encrypted
             const encryptedFields = entityInfo.EncryptedFields;
             if (encryptedFields.length > 0) {
                 for (const field of encryptedFields) {
                     const fieldName = field.CodeName;
                     const value = dataObject[fieldName];
+                    // Skip null/undefined values
                     if (value === null || value === undefined)
                         continue;
+                    // Check if value is encrypted (raw SQL returns encrypted values)
                     const engine = EncryptionEngine.Instance;
                     await engine.Config(false, contextUser);
                     const keyMarker = field.EncryptionKeyID ? engine.GetKeyByID(field.EncryptionKeyID)?.Marker : undefined;
                     if (typeof value === 'string' && IsValueEncrypted(value, keyMarker)) {
                         if (field.AllowDecryptInAPI) {
+                            // Decrypt the value for the client
                             if (contextUser) {
                                 try {
                                     const decryptedValue = await engine.Decrypt(value, contextUser);
@@ -55,16 +81,20 @@ export class ResolverBase {
                                 }
                                 catch (err) {
                                     LogError(`Failed to decrypt field ${fieldName} for API response: ${err}`);
+                                    // On decryption failure, use sentinel for safety
                                     dataObject[fieldName] = ENCRYPTED_SENTINEL;
                                 }
                             }
                             else {
+                                // No context user, can't decrypt - use sentinel
                                 dataObject[fieldName] = ENCRYPTED_SENTINEL;
                             }
                         }
                         else if (!field.SendEncryptedValue) {
+                            // AllowDecryptInAPI=false and SendEncryptedValue=false - use sentinel
                             dataObject[fieldName] = ENCRYPTED_SENTINEL;
                         }
+                        // else: AllowDecryptInAPI=false and SendEncryptedValue=true - keep encrypted value as-is
                     }
                 }
             }
@@ -72,6 +102,7 @@ export class ResolverBase {
         return dataObject;
     }
     async ArrayMapFieldNamesToCodeNames(entityName, dataObjectArray, contextUser) {
+        // iterate through the array and call MapFieldNamesToCodeNames for each element
         if (dataObjectArray && dataObjectArray.length > 0) {
             for (const element of dataObjectArray) {
                 await this.MapFieldNamesToCodeNames(entityName, element, contextUser);
@@ -79,6 +110,20 @@ export class ResolverBase {
         }
         return dataObjectArray;
     }
+    /**
+     * Filters encrypted field values before sending to the API client.
+     *
+     * For each encrypted field in the entity:
+     * - If AllowDecryptInAPI is true: value passes through unchanged (already decrypted by data provider)
+     * - If AllowDecryptInAPI is false and SendEncryptedValue is true: re-encrypt and send ciphertext
+     * - If AllowDecryptInAPI is false and SendEncryptedValue is false: replace with sentinel value
+     *
+     * @param entityName - Name of the entity
+     * @param dataObject - The data object containing field values
+     * @param encryptionEngine - Optional encryption engine for re-encryption (lazy loaded if needed)
+     * @param contextUser - User context for encryption operations
+     * @returns The filtered data object
+     */
     async FilterEncryptedFieldsForAPI(entityName, dataObject, contextUser) {
         if (!dataObject)
             return dataObject;
@@ -86,40 +131,54 @@ export class ResolverBase {
         const entityInfo = md.Entities.find((e) => e.Name === entityName);
         if (!entityInfo)
             return dataObject;
+        // Find all encrypted fields that need filtering
         const encryptedFields = entityInfo.EncryptedFields;
         if (encryptedFields.length === 0)
             return dataObject;
+        // Process each encrypted field
         for (const field of encryptedFields) {
             const fieldName = field.CodeName;
             const value = dataObject[fieldName];
+            // Skip null/undefined values
             if (value === null || value === undefined)
                 continue;
+            // If AllowDecryptInAPI is true, the decrypted value passes through
             if (field.AllowDecryptInAPI)
                 continue;
+            // AllowDecryptInAPI is false - we need to filter the value
             const engine = EncryptionEngine.Instance;
             await engine.Config(false, contextUser);
             const keyMarker = field.EncryptionKeyID ? engine.GetKeyByID(field.EncryptionKeyID)?.Marker : undefined;
             if (field.SendEncryptedValue) {
+                // Re-encrypt the value before sending
+                // Only re-encrypt if it's not already encrypted (data provider decrypted it)
                 if (typeof value === 'string' && !IsValueEncrypted(value, keyMarker)) {
                     try {
                         const encryptedValue = await engine.Encrypt(value, field.EncryptionKeyID, contextUser);
                         dataObject[fieldName] = encryptedValue;
                     }
                     catch (err) {
+                        // If re-encryption fails, use sentinel for safety
                         LogError(`Failed to re-encrypt field ${fieldName} for API response: ${err}`);
                         dataObject[fieldName] = ENCRYPTED_SENTINEL;
                     }
                 }
+                // If already encrypted (shouldn't happen normally), keep as-is
             }
             else {
+                // SendEncryptedValue is false - replace with sentinel
                 dataObject[fieldName] = ENCRYPTED_SENTINEL;
             }
         }
         return dataObject;
     }
+    /**
+     * Filters encrypted fields for an array of data objects
+     */
     async ArrayFilterEncryptedFieldsForAPI(entityName, dataObjectArray, contextUser) {
         if (!dataObjectArray || dataObjectArray.length === 0)
             return dataObjectArray;
+        // Check if entity has any encrypted fields first to avoid unnecessary processing
         const md = new Metadata();
         const entityInfo = md.Entities.find((e) => e.Name === entityName);
         if (!entityInfo)
@@ -127,27 +186,33 @@ export class ResolverBase {
         const encryptedFields = entityInfo.Fields.filter(f => f.Encrypt && !f.AllowDecryptInAPI);
         if (encryptedFields.length === 0)
             return dataObjectArray;
+        // Process each element
         for (const element of dataObjectArray) {
             await this.FilterEncryptedFieldsForAPI(entityName, element, contextUser);
         }
         return dataObjectArray;
     }
     async findBy(provider, entity, params, contextUser) {
+        // build the SQL query based on the params passed in
         const rv = provider;
         const e = provider.Entities.find((e) => e.Name === entity);
         if (!e)
             throw new Error(`Entity ${entity} not found in metadata`);
+        // now build a SQL string using the entityInfo and using the properties in the params object
         let extraFilter = "";
         const keys = Object.keys(params);
         keys.forEach((k, i) => {
             if (i > 0)
                 extraFilter += ' AND ';
+            // look up the field in the entityInfo to see if it needs quotes
             const field = e.Fields.find((f) => f.Name === k);
             if (!field)
                 throw new Error(`Field ${k} not found in entity ${entity}`);
             const quotes = field.NeedsQuotes ? "'" : '';
             extraFilter += `${k} = ${quotes}${params[k]}${quotes}`;
         });
+        // ok, now we have a SQL string, run it and return the results
+        // use the SQLServerDataProvider
         const result = await rv.RunView({
             EntityName: entity,
             ExtraFilter: extraFilter,
@@ -161,6 +226,7 @@ export class ResolverBase {
     }
     async RunViewByNameGeneric(viewInput, provider, userPayload, pubSub) {
         try {
+            // Log aggregate input for debugging
             if (viewInput.Aggregates?.length) {
                 LogStatus(`[ResolverBase] RunViewByNameGeneric received aggregates: viewName=${viewInput.ViewName}, aggregateCount=${viewInput.Aggregates.length}, aggregates=${JSON.stringify(viewInput.Aggregates.map(a => ({ expression: a.expression, alias: a.alias })))}`);
             }
@@ -185,6 +251,7 @@ export class ResolverBase {
     }
     async RunViewByIDGeneric(viewInput, provider, userPayload, pubSub) {
         try {
+            // Log aggregate input for debugging
             if (viewInput.Aggregates?.length) {
                 LogStatus(`[ResolverBase] RunViewByIDGeneric received aggregates: viewID=${viewInput.ViewID}, aggregateCount=${viewInput.Aggregates.length}, aggregates=${JSON.stringify(viewInput.Aggregates.map(a => ({ expression: a.expression, alias: a.alias })))}`);
             }
@@ -200,6 +267,7 @@ export class ResolverBase {
     }
     async RunDynamicViewGeneric(viewInput, provider, userPayload, pubSub) {
         try {
+            // Log aggregate input for debugging
             if (viewInput.Aggregates?.length) {
                 LogStatus(`[ResolverBase] RunDynamicViewGeneric received aggregates: entityName=${viewInput.EntityName}, aggregateCount=${viewInput.Aggregates.length}, aggregates=${JSON.stringify(viewInput.Aggregates.map(a => ({ expression: a.expression, alias: a.alias })))}`);
             }
@@ -212,7 +280,7 @@ export class ResolverBase {
                 Entity: viewInput.EntityName,
                 EntityID: entity.ID,
                 EntityBaseView: entity.BaseView,
-            };
+            }; // only providing a few bits of data here, but it's enough to get the view to run
             return this.RunViewGenericInternal(provider, viewInfo, viewInput.ExtraFilter, viewInput.OrderBy, viewInput.UserSearchString, viewInput.ExcludeUserViewRunID, viewInput.OverrideExcludeFilter, false, viewInput.Fields, viewInput.IgnoreMaxRows, false, viewInput.ForceAuditLog, viewInput.AuditLogDescription, viewInput.ResultType, userPayload, viewInput.MaxRows, viewInput.StartRow, viewInput.Aggregates);
         }
         catch (err) {
@@ -239,6 +307,7 @@ export class ResolverBase {
                     if (!entity) {
                         throw new Error(`Entity ${viewInput.EntityName} not found in metadata`);
                     }
+                    // only providing a few bits of data here, but it's enough to get the view to run
                     viewInfo = {
                         ID: '',
                         Entity: viewInput.EntityName,
@@ -278,7 +347,7 @@ export class ResolverBase {
         let results = await this.RunViewsGenericInternal(params);
         return results;
     }
-    static _priorEmittedData = [];
+    static { this._priorEmittedData = []; }
     async EmitCloudEvent({ component, event, eventCode, args }) {
         if (ResolverBase._emit && event === MJEventType.ComponentEvent && eventCode === BaseEntity.BaseEventCode) {
             const extendedType = args instanceof BaseEntityEvent ? `.${args.type}` : '';
@@ -288,20 +357,23 @@ export class ResolverBase {
             const data = args?.baseEntity?.GetAll() ?? {};
             const cloudEvent = new CloudEvent({ type, source, subject, data });
             try {
+                // check to see if the combination of Entity and pkey was already emitted, if so, Log that condtion next
                 const pkey = args.baseEntity.PrimaryKeys;
                 const emittedData = { Entity: args.baseEntity.EntityInfo.Name, PKey: pkey };
                 if (ResolverBase._priorEmittedData.find((e) => {
                     if (e.Entity !== emittedData.Entity)
                         return false;
+                    // if we get here compare the pkeys
                     const pkey2 = e.PKey;
                     if (pkey.KeyValuePairs.length !== pkey2.KeyValuePairs.length)
                         return false;
                     for (const kv of pkey.KeyValuePairs) {
+                        // find the match by field name
                         const kv2 = pkey2.KeyValuePairs.find((k) => k.FieldName === kv.FieldName);
                         if (!kv2 || kv2.Value !== kv.Value)
                             return false;
                     }
-                    return true;
+                    return true; // if we get here, all the keys matched
                 })) {
                     console.log(`IMPORTANT: CloudEvent already emitted for ${JSON.stringify(emittedData)}`);
                 }
@@ -323,8 +395,9 @@ export class ResolverBase {
         if (!userPayload) {
             throw new Error(`userPayload is null`);
         }
+        // first check permissions, the logged in user must have read permissions on the entity to run the view
         if (entityInfo) {
-            const userInfo = UserCache.Users.find((u) => u.Email.toLowerCase().trim() === userPayload.email.toLowerCase().trim());
+            const userInfo = UserCache.Users.find((u) => u.Email.toLowerCase().trim() === userPayload.email.toLowerCase().trim()); // get the user record from MD so we have ROLES attached, don't use the one from payload directly
             if (!userInfo) {
                 throw new Error(`User ${userPayload.email} not found in metadata`);
             }
@@ -337,34 +410,62 @@ export class ResolverBase {
             throw new Error(`Entity not found in metadata`);
         }
     }
+    /**
+     * Checks API key scope authorization. Only performs check if request
+     * was authenticated via API key (apiKeyHash present in userPayload).
+     * For OAuth/JWT auth, this is a no-op.
+     *
+     * @param scopePath - The scope path (e.g., 'entity:read', 'agent:execute')
+     * @param resource - The resource name (e.g., entity name, agent name)
+     * @param userPayload - The user payload from context
+     * @throws AuthorizationError if API key lacks required scope
+     */
     async CheckAPIKeyScopeAuthorization(scopePath, resource, userPayload) {
+        // Skip scope check for OAuth/JWT auth (no API key)
         if (!userPayload.apiKeyHash) {
             return;
         }
+        // Get system user for authorization call
+        // NOTE: We use system user here because Authorize() needs to run internal
+        // database queries (loading scope rules, logging decisions). The system user
+        // ensures these queries work regardless of what permissions the API key's
+        // user has. The API key's associated user (in userPayload.userRecord) is
+        // used later when the actual operation executes - their permissions are
+        // the ultimate ceiling that scopes can only narrow, never expand.
         const systemUser = UserCache.Instance.Users.find(u => u.Type === 'System');
         if (!systemUser) {
             throw new Error('System user not found');
         }
         const apiKeyEngine = GetAPIKeyEngine();
+        // Check for full_access scope first (god power - bypasses all other checks)
         const fullAccessResult = await apiKeyEngine.Authorize(userPayload.apiKeyHash, 'MJAPI', 'full_access', '*', systemUser, { endpoint: '/graphql', method: 'POST' });
         if (fullAccessResult.Allowed) {
+            // full_access granted - skip specific scope check
             return;
         }
+        // Check specific scope
         const result = await apiKeyEngine.Authorize(userPayload.apiKeyHash, 'MJAPI', scopePath, resource, systemUser, {
             endpoint: '/graphql',
             method: 'POST'
         });
         if (!result.Allowed) {
+            // Provide specific, actionable error message
             throw new AuthorizationError(`Access denied. This API key requires the '${scopePath}' scope ` +
                 `for resource '${resource}' to perform this operation. ` +
                 `Please update the API key's scopes or use an API key with appropriate permissions. ` +
                 `Denial reason: ${result.Reason}`);
         }
     }
+    /**
+     * Optimized RunViewGenericInternal implementation with:
+     * - Field filtering at source (Fix #7)
+     * - Improved error handling (Fix #9)
+     */
     async RunViewGenericInternal(provider, viewInfo, extraFilter, orderBy, userSearchString, excludeUserViewRunID, overrideExcludeFilter, saveViewResults, fields, ignoreMaxRows, excludeDataFromAllPriorViewRuns, forceAuditLog, auditLogDescription, resultType, userPayload, maxRows, startRow, aggregates) {
         try {
             if (!viewInfo || !userPayload)
                 return null;
+            // Check API key scope authorization for view operations
             await this.CheckAPIKeyScopeAuthorization('view:run', viewInfo.Entity, userPayload);
             const md = provider;
             const user = UserCache.Users.find((u) => u.Email.toLowerCase().trim() === userPayload?.email.toLowerCase().trim());
@@ -374,18 +475,23 @@ export class ResolverBase {
             if (!entityInfo)
                 throw new Error(`Entity ${viewInfo.Entity} not found in metadata`);
             const rv = md;
+            // Determine result type
             let rt = 'simple';
             if (resultType?.trim().toLowerCase() === 'count_only') {
                 rt = 'count_only';
             }
+            // Fix #7: Implement field filtering - preprocess fields for more efficient field selection
+            // This is passed to RunView() which uses it to optimize the SQL query
             let optimizedFields = fields;
             if (fields?.length) {
+                // Always ensure primary keys are included for proper record handling
                 const primaryKeys = entityInfo.PrimaryKeys.map(pk => pk.Name);
                 const missingPrimaryKeys = primaryKeys.filter(pk => !fields.find(f => f.toLowerCase() === pk.toLowerCase()));
                 if (missingPrimaryKeys.length) {
                     optimizedFields = [...fields, ...missingPrimaryKeys];
                 }
             }
+            // Log aggregate request for debugging
             if (aggregates?.length) {
                 LogStatus(`[ResolverBase] RunViewGenericInternal with aggregates: entityName=${viewInfo.Entity}, viewName=${viewInfo.Name}, aggregateCount=${aggregates.length}, aggregates=${JSON.stringify(aggregates.map(a => ({ expression: a.expression, alias: a.alias })))}`);
             }
@@ -395,7 +501,7 @@ export class ResolverBase {
                 EntityName: viewInfo.Entity,
                 ExtraFilter: extraFilter,
                 OrderBy: orderBy,
-                Fields: optimizedFields,
+                Fields: optimizedFields, // Use optimized fields list
                 UserSearchString: userSearchString,
                 ExcludeUserViewRunID: excludeUserViewRunID,
                 OverrideExcludeFilter: overrideExcludeFilter,
@@ -409,19 +515,23 @@ export class ResolverBase {
                 ResultType: rt,
                 Aggregates: aggregates,
             }, user);
+            // Log aggregate results for debugging
             if (aggregates?.length) {
                 LogStatus(`[ResolverBase] RunView result aggregate info: entityName=${viewInfo.Entity}, hasAggregateResults=${!!result?.AggregateResults}, aggregateResultCount=${result?.AggregateResults?.length || 0}, aggregateExecutionTime=${result?.AggregateExecutionTime}, aggregateResults=${JSON.stringify(result?.AggregateResults)}`);
             }
+            // Process results for GraphQL transport
             const mapper = new FieldMapper();
             if (result?.Success && result.Results?.length) {
                 for (const r of result.Results) {
                     mapper.MapFields(r);
                 }
+                // Filter encrypted fields before sending to API client
                 await this.ArrayFilterEncryptedFieldsForAPI(viewInfo.Entity, result.Results, user);
             }
             return result;
         }
         catch (err) {
+            // Fix #9: Improved error handling with structured logging
             const error = err;
             LogError({
                 service: 'RunView',
@@ -429,18 +539,27 @@ export class ResolverBase {
                 error: error.message,
                 entityName: viewInfo?.Entity,
                 errorType: error.constructor.name,
+                // Only include stack trace for non-validation errors
                 stack: error.message?.includes('not found in metadata') ? undefined : error.stack
             });
             throw err;
         }
     }
+    /**
+     * Optimized implementation that:
+     * 1. Fetches user info only once (fixes N+1 query)
+     * 2. Processes views in parallel for independent operations
+     * 3. Implements structured error logging
+     */
     async RunViewsGenericInternal(params) {
         try {
+            // Skip processing if no params
             if (!params.length)
                 return [];
             let md = null;
             const rv = params[0].provider;
             let runViewParams = [];
+            // Fix #1: Get user info only once for all queries
             let contextUser = null;
             if (params[0]?.userPayload?.email) {
                 const userEmail = params[0].userPayload.email.toLowerCase().trim();
@@ -450,10 +569,13 @@ export class ResolverBase {
                 }
                 contextUser = user;
             }
+            // Create a map of entities to validate only once per entity
             const validatedEntities = new Set();
             md = new Metadata();
+            // Transform parameters
             for (const param of params) {
                 if (param.viewInfo) {
+                    // Validate entity only once per entity type
                     const entityName = param.viewInfo.Entity;
                     if (!validatedEntities.has(entityName)) {
                         const entityInfo = md.Entities.find(e => e.Name === entityName);
@@ -463,10 +585,12 @@ export class ResolverBase {
                         validatedEntities.add(entityName);
                     }
                 }
+                // Determine result type
                 let rt = 'simple';
                 if (param.resultType?.trim().toLowerCase() === 'count_only') {
                     rt = 'count_only';
                 }
+                // Build parameters
                 runViewParams.push({
                     ViewID: param.viewInfo.ID,
                     ViewName: param.viewInfo.Name,
@@ -488,7 +612,9 @@ export class ResolverBase {
                     Aggregates: param.aggregates,
                 });
             }
+            // Fix #4: Run views in a single batch through RunViews
             const runViewResults = await rv.RunViews(runViewParams, contextUser);
+            // Process results
             const mapper = new FieldMapper();
             for (let i = 0; i < runViewResults.length; i++) {
                 const runViewResult = runViewResults[i];
@@ -496,6 +622,8 @@ export class ResolverBase {
                     for (const result of runViewResult.Results) {
                         mapper.MapFields(result);
                     }
+                    // Filter encrypted fields before sending to API client
+                    // Use the corresponding param's entity name
                     const entityName = params[i]?.viewInfo?.Entity;
                     if (entityName && contextUser) {
                         await this.ArrayFilterEncryptedFieldsForAPI(entityName, runViewResult.Results, contextUser);
@@ -505,6 +633,7 @@ export class ResolverBase {
             return runViewResults;
         }
         catch (err) {
+            // Fix #9: Structured error logging with less verbosity
             console.log(err);
             throw err;
         }
@@ -552,7 +681,7 @@ export class ResolverBase {
                 throw new Error(`User ${userPayload?.email} not found in metadata`);
             if (!auditLogType)
                 throw new Error(`Audit Log Type ${auditLogTypeName} not found in metadata`);
-            const auditLog = await md.GetEntityObject('Audit Logs', userInfo);
+            const auditLog = await md.GetEntityObject('Audit Logs', userInfo); // must pass user context on back end as we're not authenticated the same way as the front end
             auditLog.NewRecord();
             auditLog.UserID = userInfo.ID;
             auditLog.AuditLogTypeID = auditLogType.ID;
@@ -594,7 +723,7 @@ export class ResolverBase {
         if (!userPayload)
             return undefined;
         if (userPayload.userRecord)
-            return userPayload.userRecord;
+            return userPayload.userRecord; // if we have a user record, use that directly
         if (!userPayload.email)
             return undefined;
         return UserCache.Users.find((u) => u.Email.toLowerCase().trim() === userPayload.email.toLowerCase().trim());
@@ -603,12 +732,18 @@ export class ResolverBase {
         return Metadata.Provider.ConfigData.MJCoreSchemaName;
     }
     ListenForEntityMessages(entityObject, pubSub, userPayload) {
+        // The unique key is set up for each entity object via it's primary key to ensure that we only have one listener at most for each unique
+        // entity in the system. This is important because we don't want to have multiple listeners for the same entity as it could
+        // cause issues with multiple messages for the same event.
         const uniqueKey = entityObject.EntityInfo.Name;
         if (!this.EventSubscriptions.has(uniqueKey)) {
+            // listen for events from the entityObject in case it is a long running task and we can push messages back to the client via pubSub
             LogDebug(`ResolverBase.ListenForEntityMessages: About to call MJGlobal.Instance.GetEventListener() to get the event listener subscription for ${uniqueKey}`);
             const theSub = MJGlobal.Instance.GetEventListener(false).subscribe(async (event) => {
                 if (event) {
                     const baseEntity = event.args?.baseEntity;
+                    // Only process events for the entity type this subscription was created for
+                    // This prevents duplicate CloudEvents when multiple entity types have active subscriptions
                     if (baseEntity?.EntityInfo?.Name !== uniqueKey) {
                         return;
                     }
@@ -619,6 +754,7 @@ export class ResolverBase {
                     LogDebug(`ResolverBase.ListenForEntityMessages: EmitCloudEvent() completed successfully`);
                     if (event.args && event.args instanceof BaseEntityEvent) {
                         const baseEntityEvent = event.args;
+                        // message from our entity object, relay it to the client
                         LogDebug('ResolverBase.ListenForEntityMessages: About to publish PUSH_STATUS_UPDATES_TOPIC');
                         pubSub.publish(PUSH_STATUS_UPDATES_TOPIC, {
                             message: JSON.stringify({
@@ -637,17 +773,23 @@ export class ResolverBase {
         }
     }
     async CreateRecord(entityName, input, provider, userPayload, pubSub) {
+        // Check API key scope authorization for entity create operations
         await this.CheckAPIKeyScopeAuthorization('entity:create', entityName, userPayload);
         if (await this.BeforeCreate(provider, input)) {
+            // fire event and proceed if it wasn't cancelled
             const entityObject = await provider.GetEntityObject(entityName, this.GetUserFromPayload(userPayload));
             entityObject.NewRecord();
             entityObject.SetMany(input);
             this.ListenForEntityMessages(entityObject, pubSub, userPayload);
+            // Pass the transactionScopeId from the user payload to the save operation
             if (await entityObject.Save()) {
-                await this.AfterCreate(provider, input);
+                // save worked, fire the AfterCreate event and then return all the data
+                await this.AfterCreate(provider, input); // fire event
                 const contextUser = this.GetUserFromPayload(userPayload);
+                // MapFieldNamesToCodeNames now handles encryption filtering as well
                 return await this.MapFieldNamesToCodeNames(entityName, entityObject.GetAll(), contextUser);
             }
+            // save failed, throw error with message
             else {
                 throw new GraphQLError(entityObject.LatestResult?.CompleteMessage ?? 'Unknown error creating record', {
                     extensions: { code: 'CREATE_ENTITY_ERROR', entityName },
@@ -657,13 +799,16 @@ export class ResolverBase {
         else
             return null;
     }
+    // Before/After CREATE Event Hooks for Sub-Classes to Override
     async BeforeCreate(provider, input) {
         return true;
     }
     async AfterCreate(provider, input) { }
     async UpdateRecord(entityName, input, provider, userPayload, pubSub) {
+        // Check API key scope authorization for entity update operations
         await this.CheckAPIKeyScopeAuthorization('entity:update', entityName, userPayload);
         if (await this.BeforeUpdate(provider, input)) {
+            // fire event and proceed if it wasn't cancelled
             const userInfo = this.GetUserFromPayload(userPayload);
             const entityObject = await provider.GetEntityObject(entityName, userInfo);
             const entityInfo = entityObject.EntityInfo;
@@ -672,8 +817,9 @@ export class ResolverBase {
                 if (key !== 'OldValues___') {
                     clientNewValues[key] = input[key];
                 }
-            });
+            }); // grab all the props except for the OldValues property
             if (entityInfo.TrackRecordChanges || !input.OldValues___) {
+                // We get here because EITHER the entity tracks record changes OR the client did not provide OldValues, so we need to load the old values from the DB
                 const cKey = new CompositeKey(entityInfo.PrimaryKeys.map((pk) => {
                     return {
                         FieldName: pk.Name,
@@ -681,28 +827,38 @@ export class ResolverBase {
                     };
                 }));
                 if (await entityObject.InnerLoad(cKey)) {
+                    // load worked, now, only IF we have OldValues, we need to check them against the values in the DB we just loaded.
                     if (input.OldValues___) {
+                        // we DO have OldValues, so we need to do a more in depth analysis
                         await this.TestAndSetClientOldValuesToDBValues(input, clientNewValues, entityObject, userInfo);
                     }
                     else {
+                        // no OldValues, so we can just set the new values from input
                         entityObject.SetMany(input);
                     }
                 }
                 else {
+                    // save failed, return null
                     throw new GraphQLError(`Record not found for ${entityName} with key ${JSON.stringify(cKey)}`, {
                         extensions: { code: 'LOAD_ENTITY_ERROR', entityName },
                     });
                 }
             }
             else {
+                // we get here if we are NOT tracking changes and we DO have OldValues, so we can load from them
                 const oldValues = {};
+                // for each item in the oldValues array, add it to the oldValues object
                 input.OldValues___?.forEach((item) => (oldValues[item.Key] = item.Value));
+                // 1) load the old values, this will be the initial state of the object
                 await entityObject.LoadFromData(oldValues);
+                // 2) set the new values from the input, not including the OldValues property
                 entityObject.SetMany(clientNewValues);
             }
             this.ListenForEntityMessages(entityObject, pubSub, userPayload);
             if (await entityObject.Save()) {
-                await this.AfterUpdate(provider, input);
+                // save worked, fire afterevent and return all the data
+                await this.AfterUpdate(provider, input); // fire event
+                // MapFieldNamesToCodeNames now handles encryption filtering as well
                 return await this.MapFieldNamesToCodeNames(entityName, entityObject.GetAll(), userInfo);
             }
             else {
@@ -716,13 +872,23 @@ export class ResolverBase {
                 extensions: { code: 'SAVE_ENTITY_ERROR', entityName },
             });
     }
+    /**
+     * This routine compares the OldValues property in the input object to the values in the DB that we just loaded. If there are differences, we need to check to see if the client
+     * is trying to update any of those fields (e.g. overlap). If there is overlap, we throw an error. If there is no overlap, we can proceed with the update even if the DB Values
+     * and the ClientOldValues are not 100% the same, so long as there is no overlap in the specific FIELDS that are different.
+     *
+     * ASSUMES: input object has an OldValues___ property that is an array of Key/Value pairs that represent the old values of the record that the client is trying to update.
+     */
     async TestAndSetClientOldValuesToDBValues(input, clientNewValues, entityObject, contextUser) {
+        // we have OldValues, so we need to compare them to the values we just loaded from the DB
         const clientOldValues = {};
+        // for each item in the oldValues array, add it to the clientOldValues object
         input.OldValues___.forEach((item) => {
+            // we need to do a quick transform on the values to make sure they match the TS Type for the given field because item.Value will always be a string
             const field = entityObject.EntityInfo.Fields.find((f) => f.CodeName === item.Key);
             let val = item.Value;
             if ((val === null || val === undefined) && field.DefaultValue !== null && field.DefaultValue !== undefined && !field.AllowsNull)
-                val = field.DefaultValue;
+                val = field.DefaultValue; // set default value as the field was never set and it does NOT allow nulls
             if (field) {
                 switch (field.TSType) {
                     case EntityFieldTSType.Number:
@@ -755,17 +921,21 @@ export class ResolverBase {
                         val = val === null || val === undefined || val === 'false' || val === '0' || parseInt(val) === 0 ? false : true;
                         break;
                     case EntityFieldTSType.Date:
+                        // first, if val is a string and it is actually a number (milliseconds since epoch), convert it to a number.
                         if (val !== null && val !== undefined && val.toString().trim() !== '' && !isNaN(val))
                             val = parseInt(val);
                         val = val !== null && val !== undefined ? new Date(val) : null;
                         break;
                     default:
-                        break;
+                        break; // already a string
                 }
             }
             clientOldValues[item.Key] = val;
         });
+        // clientOldValues now has all of the oldValues the CLIENT passed us. Now we need to build the same kind of object
+        // with the DB values
         const dbValues = entityObject.GetAll();
+        // now we need to compare clientOldValues and dbValues and have a new array that has entries for any differences and have FieldName, clientOldValue and dbValue as properties
         const dbDifferences = [];
         Object.keys(clientOldValues).forEach((key) => {
             const f = entityObject.EntityInfo.Fields.find((f) => f.CodeName === key);
@@ -785,12 +955,13 @@ export class ResolverBase {
                             different = true;
                         }
                         else if (clientDate.getTime() !== dbDate.getTime()) {
+                            // Check if this is a datetime/datetime2 field with only a timezone hour shift
                             const sqlType = f?.SQLFullType?.trim().toLowerCase() || '';
                             if (sqlType !== 'datetimeoffset' && IsOnlyTimezoneShift(clientDate, dbDate)) {
                                 console.warn(`Timezone hour shift detected on field "${key}" (${sqlType || 'datetime'}). ` +
                                     `Client: ${clientDate.toISOString()}, DB: ${dbDate.toISOString()}. ` +
                                     `Consider using datetimeoffset to avoid timezone ambiguity.`);
-                                different = false;
+                                different = false; // Allow timezone shifts through for non-datetimeoffset fields
                             }
                             else {
                                 different = true;
@@ -806,6 +977,7 @@ export class ResolverBase {
                     break;
             }
             if (different && f && !f.ReadOnly) {
+                // only include updateable fields
                 dbDifferences.push({
                     FieldName: key,
                     ClientOldValue: clientOldValues[key],
@@ -814,10 +986,13 @@ export class ResolverBase {
             }
         });
         if (dbDifferences.length > 0) {
+            // now we have an array of any dbDifferences with length > 0, between the clientOldValues and the dbValues, we need to check to see if any of the differences are on fields that the client is trying to update
+            // first step is to get clientNewValues into an object that is like clientOldValues, get the diff and then compare that diff to the differences array that shows diff between DB and ClientOld
             const clientDifferences = [];
             Object.keys(clientOldValues).forEach((key) => {
                 const f = entityObject.EntityInfo.Fields.find((f) => f.CodeName === key);
                 if (clientOldValues[key] !== clientNewValues[key] && f && f.AllowUpdateAPI && !f.IsPrimaryKey) {
+                    // only include updateable fields
                     clientDifferences.push({
                         FieldName: key,
                         ClientOldValue: clientOldValues[key],
@@ -825,6 +1000,8 @@ export class ResolverBase {
                     });
                 }
             });
+            // now we have clientDifferences which shows what the client thinks they are changing. And, we have the dbDifferences array that shows changes between the clientOldValues and the dbValues
+            // if there is ANY overlap in the FIELDS that appear in both arrays, we need to log a warning but allow the save to continue
             const overlap = clientDifferences.filter((cd) => dbDifferences.find((dd) => dd.FieldName === cd.FieldName));
             if (overlap.length > 0) {
                 const msg = {
@@ -833,6 +1010,7 @@ export class ResolverBase {
                     DBDifferences: dbDifferences,
                     Overlap: overlap,
                 };
+                // Log as warning to console and ErrorLog table instead of throwing error
                 console.warn('Entity save inconsistency detected but allowing save to continue:', JSON.stringify(msg));
                 LogError({
                     service: 'ResolverBase',
@@ -845,6 +1023,7 @@ export class ResolverBase {
                         overlap: overlap
                     }
                 });
+                // Create ErrorLog record in the database
                 try {
                     const md = new Metadata();
                     const errorLogEntity = await md.GetEntityObject('Error Logs', contextUser);
@@ -863,17 +1042,21 @@ export class ResolverBase {
                 }
             }
         }
+        // If we get here that means we've not thrown an exception, so there is
+        // NO OVERLAP, so we can set the new values from the data provided from the client now...
         entityObject.SetMany(clientNewValues);
     }
     async DeleteRecord(entityName, key, options, provider, userPayload, pubSub) {
+        // Check API key scope authorization for entity delete operations
         await this.CheckAPIKeyScopeAuthorization('entity:delete', entityName, userPayload);
         if (await this.BeforeDelete(provider, key)) {
+            // fire event and proceed if it wasn't cancelled
             const entityObject = await provider.GetEntityObject(entityName, this.GetUserFromPayload(userPayload));
             await entityObject.InnerLoad(key);
-            const returnValue = entityObject.GetAll();
+            const returnValue = entityObject.GetAll(); // grab the values before we delete so we can return last state before delete if we are successful.
             this.ListenForEntityMessages(entityObject, pubSub, userPayload);
             if (await entityObject.Delete(options)) {
-                await this.AfterDelete(provider, key);
+                await this.AfterDelete(provider, key); // fire event
                 return returnValue;
             }
             else {
@@ -888,10 +1071,12 @@ export class ResolverBase {
             });
         }
     }
+    // Before/After DELETE Event Hooks for Sub-Classes to Override
     async BeforeDelete(provider, key) {
         return true;
     }
     async AfterDelete(provider, key) { }
+    // Before/After UPDATE Event Hooks for Sub-Classes to Override
     async BeforeUpdate(provider, input) {
         return true;
     }