@memberjunction/server 2.14.0 → 2.16.0

package/src/generic/ResolverBase.ts

@@ -1,18 +1,34 @@
-import { BaseEntity, CompositeKey, EntityFieldTSType, EntityPermissionType, LogError, Metadata, RunView, RunViewParams, RunViewResult, UserInfo } from '@memberjunction/core';
+import {
+  BaseEntity,
+  BaseEntityEvent,
+  CompositeKey,
+  EntityFieldTSType,
+  EntityPermissionType,
+  LogError,
+  Metadata,
+  RunView,
+  RunViewParams,
+  RunViewResult,
+  UserInfo,
+} from '@memberjunction/core';
 import { AuditLogEntity, UserViewEntity } from '@memberjunction/core-entities';
 import { UserCache } from '@memberjunction/sqlserver-dataprovider';
 import { PubSubEngine } from 'type-graphql';
 import { GraphQLError } from 'graphql';
 import { DataSource } from 'typeorm';
+import { httpTransport, CloudEvent, emitterFor } from 'cloudevents';
 
 import { RunViewGenericParams, UserPayload } from '../types.js';
 import { RunDynamicViewInput, RunViewByIDInput, RunViewByNameInput } from './RunViewResolver.js';
 import { DeleteOptionsInput } from './DeleteOptionsInput.js';
-import { MJGlobal } from '@memberjunction/global';
+import { MJEvent, MJEventType, MJGlobal } from '@memberjunction/global';
 import { PUSH_STATUS_UPDATES_TOPIC } from './PushStatusResolver.js';
 import { FieldMapper } from '@memberjunction/graphql-dataprovider';
 
 export class ResolverBase {
+  private _emit = process.env.CLOUDEVENTS_HTTP_TRANSPORT ? emitterFor(httpTransport(process.env.CLOUDEVENTS_HTTP_TRANSPORT)) : null;
+  private _cloudeventsHeaders = process.env.CLOUDEVENTS_HTTP_HEADERS ? JSON.parse(process.env.CLOUDEVENTS_HTTP_HEADERS) : {};
+
   protected MapFieldNamesToCodeNames(entityName: string, dataObject: any) {
     // 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
@@ -28,7 +44,7 @@ export class ResolverBase {
       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)
+          const mappedFieldName = mapper.MapFieldName(f.CodeName);
           if (mappedFieldName !== f.Name) {
             dataObject[mappedFieldName] = dataObject[f.Name];
             delete dataObject[f.Name];
@@ -134,7 +150,7 @@ export class ResolverBase {
       if (!entity) throw new Error(`Entity ${viewInput.EntityName} not found in metadata`);
 
       const viewInfo: UserViewEntity = {
-        ID: "",
+        ID: '',
         Entity: viewInput.EntityName,
         EntityID: entity.ID,
         EntityBaseView: entity.BaseView as string,
@@ -164,22 +180,23 @@ export class ResolverBase {
     }
   }
 
-  async RunViewsGeneric(viewInputs: (RunViewByNameInput & RunViewByIDInput & RunDynamicViewInput)[], dataSource: DataSource, userPayload: UserPayload, pubSub: PubSubEngine) {
+  async RunViewsGeneric(
+    viewInputs: (RunViewByNameInput & RunViewByIDInput & RunDynamicViewInput)[],
+    dataSource: DataSource,
+    userPayload: UserPayload,
+    pubSub: PubSubEngine
+  ) {
     let md: Metadata | null = null;
     let params: RunViewGenericParams[] = [];
-    for(const viewInput of viewInputs) {
+    for (const viewInput of viewInputs) {
       try {
         let viewInfo: UserViewEntity | null = null;
 
-        if(viewInput.ViewName) {
-          viewInfo = this.safeFirstArrayElement(
-            await this.findBy(dataSource, 'User Views', { Name: viewInput.ViewName })
-          );
-        }
-        else if(viewInput.ViewID) {
+        if (viewInput.ViewName) {
+          viewInfo = this.safeFirstArrayElement(await this.findBy(dataSource, 'User Views', { Name: viewInput.ViewName }));
+        } else if (viewInput.ViewID) {
           viewInfo = this.safeFirstArrayElement(await this.findBy(dataSource, 'User Views', { ID: viewInput.ViewID }));
-        }
-        else if(viewInput.EntityName) {
+        } else if (viewInput.EntityName) {
           md = md || new Metadata();
           const entity = md.Entities.find((e) => e.Name === viewInput.EntityName);
           if (!entity) {
@@ -188,14 +205,13 @@ export class ResolverBase {
 
           // only providing a few bits of data here, but it's enough to get the view to run
           viewInfo = {
-            ID: "",
+            ID: '',
             Entity: viewInput.EntityName,
             EntityID: entity.ID,
             EntityBaseView: entity.BaseView,
           } as UserViewEntity;
-        }
-        else{
-          throw new Error("Unable to determine input type");
+        } else {
+          throw new Error('Unable to determine input type');
         }
 
         params.push({
@@ -214,9 +230,8 @@ export class ResolverBase {
           auditLogDescription: viewInput.AuditLogDescription,
           resultType: viewInput.ResultType,
           userPayload,
-          pubSub
+          pubSub,
         });
-
       } catch (err) {
         LogError(err);
         return null;
@@ -227,7 +242,26 @@ export class ResolverBase {
     return results;
   }
 
+  protected async EmitCloudEvent({ component, event, eventCode, args }: MJEvent) {
+    if (this._emit && event === MJEventType.ComponentEvent && eventCode === BaseEntity.BaseEventCode) {
+      const extendedType = args instanceof BaseEntityEvent ? `.${args.type}` : '';
+      const type = `MemberJunction.${event}${extendedType}`;
+      const source = `${process.env.CLOUDEVENTS_SOURCE ?? 'MemberJunction'}`;
+      const [subject, rawData] = args instanceof BaseEntityEvent ? [args.baseEntity.EntityInfo.CodeName, args.payload] : [undefined, args];
+      const data = (typeof rawData === 'object' ? rawData : { payload: rawData }) ?? {};
+      const cloudEvent = new CloudEvent({ source, subject, type, data });
 
+      try {
+        const cloudeventTransportResponse = await this._emit(cloudEvent, { headers: this._cloudeventsHeaders });
+        const cloudeventResponse = JSON.stringify(cloudeventTransportResponse);
+        if (/error/i.test(cloudeventResponse)) {
+          console.error('CloudEvent ERROR', cloudeventResponse);
+        }
+      } catch (e) {
+        console.error('CloudEvent ERROR', JSON.stringify(e));
+      }
+    }
+  }
 
   protected CheckUserReadPermissions(entityName: string, userPayload: UserPayload | null) {
     const md = new Metadata();
@@ -326,10 +360,12 @@ export class ResolverBase {
       const rv = new RunView();
       let RunViewParams: RunViewParams[] = [];
       let contextUser: UserInfo | null = null;
-      for(const param of params){
+      for (const param of params) {
         if (param.viewInfo && param.userPayload) {
           md = md || new Metadata();
-          const user: UserInfo = UserCache.Users.find((u) => u.Email.toLowerCase().trim() === param.userPayload?.email.toLowerCase().trim());
+          const user: UserInfo = UserCache.Users.find(
+            (u) => u.Email.toLowerCase().trim() === param.userPayload?.email.toLowerCase().trim()
+          );
           if (!user) {
             throw new Error(`User ${param.userPayload?.email} not found in metadata`);
           }
@@ -337,7 +373,7 @@ export class ResolverBase {
           contextUser = contextUser || user;
 
           const entityInfo = md.Entities.find((e) => e.Name === param.viewInfo.Entity);
-          if (!entityInfo){
+          if (!entityInfo) {
             throw new Error(`Entity ${param.viewInfo.Entity} not found in metadata`);
           }
         }
@@ -381,7 +417,7 @@ export class ResolverBase {
 
       // go through the result and convert all fields that start with __mj_*** to _mj__*** for GraphQL transport
       const mapper = new FieldMapper();
-      for(const runViewResult of runViewResults){
+      for (const runViewResult of runViewResults) {
         if (runViewResult && runViewResult.Success) {
           for (const result of runViewResult.Results) {
             mapper.MapFields(result);
@@ -390,8 +426,7 @@ export class ResolverBase {
       }
 
       return runViewResults;
-    }
-    catch (err) {
+    } catch (err) {
       console.log(err);
       throw err;
     }
@@ -453,8 +488,9 @@ export class ResolverBase {
       auditLog.UserID = userInfo.ID;
       auditLog.AuditLogTypeID = auditLogType.ID;
 
-      if (authorization)
+      if (authorization) {
         auditLog.AuthorizationID = authorization.ID;
+      }
 
       if (status?.trim().toLowerCase() === 'success') auditLog.Status = 'Success';
       else auditLog.Status = 'Failed';
@@ -501,8 +537,10 @@ export class ResolverBase {
 
   protected ListenForEntityMessages(entityObject: BaseEntity, pubSub: PubSubEngine, userPayload: UserPayload) {
     // 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
-    MJGlobal.Instance.GetEventListener(false).subscribe((event) => {
+    MJGlobal.Instance.GetEventListener(false).subscribe(async (event) => {
       if (event) {
+        await this.EmitCloudEvent(event);
+
         if (event.component === entityObject && event.args && event.args.message) {
           // message from our entity object, relay it to the client
           pubSub.publish(PUSH_STATUS_UPDATES_TOPIC, {
@@ -554,8 +592,9 @@ export class ResolverBase {
       const entityInfo = entityObject.EntityInfo;
       const clientNewValues = {};
       Object.keys(input).forEach((key) => {
-        if (key !== 'OldValues___')
+        if (key !== 'OldValues___') {
           clientNewValues[key] = input[key];
+        }
       }); // grab all the props except for the OldValues property
 
       if (entityInfo.TrackRecordChanges || !input.OldValues___) {
@@ -574,8 +613,7 @@ export class ResolverBase {
           if (input.OldValues___) {
             // we DO have OldValues, so we need to do a more in depth analysis
             this.TestAndSetClientOldValuesToDBValues(input, clientNewValues, entityObject);
-          } 
-          else {
+          } else {
             // no OldValues, so we can just set the new values from input
             entityObject.SetMany(input);
           }
@@ -585,8 +623,7 @@ export class ResolverBase {
             extensions: { code: 'LOAD_ENTITY_ERROR', entityName },
           });
         }
-      } 
-      else {
+      } 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

package/src/resolvers/AskSkipResolver.ts

@@ -18,6 +18,7 @@ import {
   SkipAPIRunScriptRequest,
   SkipAPIRequestAPIKey,
   SkipRequestPhase,
+  SkipAPIAgentNote,
 } from '@memberjunction/skip-types';
 
 import { PUSH_STATUS_UPDATES_TOPIC } from '../generic/PushStatusResolver.js';
@@ -75,7 +76,7 @@ export class AskSkipResultType {
 @Resolver(AskSkipResultType)
 export class AskSkipResolver {
   private static _defaultNewChatName = 'New Chat';
-  private static _maxHistoricalMessages = 20;
+  private static _maxHistoricalMessages = 30;
 
   /**
    * Handles a simple chat request from a user to Skip, using a particular data record
@@ -146,7 +147,7 @@ export class AskSkipResolver {
       }
     }
 
-    const input = this.buildSkipAPIRequest(messages, ConversationId, dataContext, 'chat_with_a_record', false, false);
+    const input = await this.buildSkipAPIRequest(messages, ConversationId, dataContext, 'chat_with_a_record', false, false, false, user);
     messages.push({
       content: UserQuestion,
       role: 'user',
@@ -219,16 +220,19 @@ export class AskSkipResolver {
     }
   }
 
-  protected buildSkipAPIRequest(
+  protected async buildSkipAPIRequest(
     messages: SkipMessage[],
     conversationId: string,
     dataContext: DataContext,
     requestPhase: SkipRequestPhase,
     includeEntities: boolean,
-    includeQueries: boolean
-  ): SkipAPIRequest {
+    includeQueries: boolean,
+    includeNotes: boolean,
+    contextUser: UserInfo
+  ): Promise<SkipAPIRequest> {
     const entities = includeEntities ? this.BuildSkipEntities() : [];
     const queries = includeQueries ? this.BuildSkipQueries() : [];
+    const notes = includeNotes ? await this.BuildSkipAgentNotes(contextUser) : [];
     const input: SkipAPIRequest = {
       apiKeys: this.buildSkipAPIKeys(),
       organizationInfo: configInfo?.askSkip?.organizationInfo,
@@ -239,6 +243,7 @@ export class AskSkipResolver {
       requestPhase: requestPhase,
       entities: entities,
       queries: queries,
+      notes: notes
     };
     return input;
   }
@@ -260,7 +265,7 @@ export class AskSkipResolver {
     if (!user) throw new Error(`User ${userPayload.email} not found in UserCache`);
     const dataContext: DataContext = new DataContext();
     await dataContext.Load(DataContextId, dataSource, true, false, 0, user);
-    const input = this.buildSkipAPIRequest([], '', dataContext, 'run_existing_script', false, false);
+    const input = await this.buildSkipAPIRequest([], '', dataContext, 'run_existing_script', false, false, false, user);
     return this.handleSimpleSkipPostRequest(input);
   }
 
@@ -318,7 +323,8 @@ export class AskSkipResolver {
       AskSkipResolver._maxHistoricalMessages
     );
 
-    const input = this.buildSkipAPIRequest(messages, ConversationId, dataContext, 'initial_request', true, true);
+    const conversationDetailCount = 1
+    const input = await this.buildSkipAPIRequest(messages, ConversationId, dataContext, 'initial_request', true, true, true, user);
 
     return this.HandleSkipRequest(
       input,
@@ -332,7 +338,8 @@ export class AskSkipResolver {
       convoEntity,
       convoDetailEntity,
       dataContext,
-      dataContextEntity
+      dataContextEntity,
+      conversationDetailCount,
     );
   }
 
@@ -376,6 +383,44 @@ export class AskSkipResolver {
     });
   }
 
+  /**
+   * Builds up the array of notes that are applicable for Skip to receive from MJAPI
+   */
+  protected async BuildSkipAgentNotes(contextUser: UserInfo): Promise<SkipAPIAgentNote[]> {
+    try {
+      const md = new Metadata();
+      if (md.EntityByName('AI Agent Notes')) {
+        const rv = new RunView();
+        const result = await rv.RunView({
+          EntityName: "AI Agent Notes",
+          ExtraFilter: "Agent='Skip'"
+        }, contextUser)
+        if (result && result.Success) {
+          return result.Results.map((r) => {
+            return {
+              id: r.ID,
+              typeId: r.TypeID,
+              type: r.Type,
+              note: r.Note,
+              createdAt: r.__mj_CreatedAt,
+              updatedAt: r.__mj_UpdatedAt,
+            }
+          });
+        }
+        else 
+          return [];    
+      }
+      else {
+        console.warn(`No AI Agent Notes entity found in the metadata, so no notes will be sent to Skip`);
+        return []; // no agent notes configured in this MJ system, so not an error, just return empty array
+      }
+    }
+    catch (e) {
+      LogError(e);
+      return []; // non- fatal error just return an empty array
+    }
+  }
+
   protected BuildSkipEntities(): SkipEntityInfo[] {
     // build the entity info for skip in its format which is
     // narrower in scope than our native MJ metadata
@@ -677,10 +722,34 @@ export class AskSkipResolver {
     convoEntity: ConversationEntity,
     convoDetailEntity: ConversationDetailEntity,
     dataContext: DataContext,
-    dataContextEntity: DataContextEntity
+    dataContextEntity: DataContextEntity, 
+    conversationDetailCount: number
   ): Promise<AskSkipResultType> {
     LogStatus(`   >>> HandleSkipRequest: Sending request to Skip API: ${___skipAPIurl}`);
 
+    if (conversationDetailCount > 10) {
+      // At this point it is likely that we are stuck in a loop, so we stop here
+      pubSub.publish(PUSH_STATUS_UPDATES_TOPIC, {
+        message: JSON.stringify({
+          type: 'AskSkip',
+          status: 'Error',
+          conversationID: ConversationId,
+          message: 'Analysis failed to run, please try again later and if this continues, contact your support desk.',
+        }),
+        sessionId: userPayload.sessionId,
+      });
+
+      return {
+        Success: false,
+        Status: 'Error',
+        Result: `Exceeded maximum attempts to answer the question ${UserQuestion}`,
+        ResponsePhase: SkipResponsePhase.AnalysisComplete,
+        ConversationId: ConversationId,
+        UserMessageConversationDetailId: '',
+        AIMessageConversationDetailId: '',
+      };
+    }
+
     const response = await sendPostRequest(
       ___skipAPIurl,
       input,
@@ -736,7 +805,8 @@ export class AskSkipResolver {
           convoEntity,
           convoDetailEntity,
           dataContext,
-          dataContextEntity
+          dataContextEntity, 
+          conversationDetailCount
         );
       } else if (apiResponse.responsePhase === 'clarifying_question') {
         // need to send the request back to the user for a clarifying question
@@ -925,7 +995,8 @@ export class AskSkipResolver {
     convoEntity: ConversationEntity,
     convoDetailEntity: ConversationDetailEntity,
     dataContext: DataContext,
-    dataContextEntity: DataContextEntity
+    dataContextEntity: DataContextEntity, 
+    conversationDetailCount: number
   ): Promise<AskSkipResultType> {
     // our job in this method is to go through each of the data requests from the Skip API, get the data, and then go back to the Skip API again and to the next phase
     try {
@@ -1039,6 +1110,7 @@ export class AskSkipResolver {
         apiRequest.dataContext = <DataContext>CopyScalarsAndArrays(dataContext); // we are casting this to DataContext as we're pushing this to the Skip API, and we don't want to send the real DataContext object, just a copy of the scalar and array properties
         apiRequest.requestPhase = 'data_gathering_response';
       }
+      conversationDetailCount++;
       // we have all of the data now, add it to the data context and then submit it back to the Skip API
       return this.HandleSkipRequest(
         apiRequest,
@@ -1052,7 +1124,8 @@ export class AskSkipResolver {
         convoEntity,
         convoDetailEntity,
         dataContext,
-        dataContextEntity
+        dataContextEntity, 
+        conversationDetailCount
       );
     } catch (e) {
       LogError(e);

package/src/resolvers/InfoResolver.ts

@@ -0,0 +1,19 @@
+import { Field, ObjectType, Query, Resolver } from 'type-graphql';
+import { Public } from '../directives/index.js';
+import packageJson from '../../package.json' assert { type: 'json' };
+
+@ObjectType()
+export class Info {
+  @Field(() => String)
+  @Public()
+  Version: string;
+}
+
+@Resolver(Info)
+export class InfoResolver {
+  @Query(() => Info)
+  @Public()
+  async Info() {
+    return { Version: packageJson.version };
+  }
+}