[AI Tutor] CT-253: Teachers can view flagged chats (#57669)

* controller method to fetch single student's AiTutorInteractions * add endpoint to interactionsApi * refactor api routes for ai tutor interactions * refactor to more RESTful single route * remove puts * fix querystring logic and autocorrect ruby linting * refactor ai tutor constants * resolve type issues * populate dropdown * add filters for status, student, and time * add enum for time filters * missed usage of enum * loosen type checking * use AITutorInteractionStatusValue over string * remove errant semicolon --------- Co-authored-by: Erin Bond <erin.bond@code.org>
code-dot-org · Apr 9, 2024 · 9a4ae51 · 9a4ae51
1 parent 0fcdaa8
commit 9a4ae51
Show file tree

Hide file tree

Showing 25 changed files with 310 additions and 110 deletions.
diff --git a/apps/script/generateSharedConstants.rb b/apps/script/generateSharedConstants.rb
@@ -96,8 +96,9 @@ def main
     CHILD_ACCOUNT_COMPLIANCE_STATES
     CENSUS_CONSTANTS
     DANCE_SONG_MANIFEST_FILENAME
-    AI_TUTOR_INTERACTION_SAVE_STATUS
+    AI_TUTOR_INTERACTION_STATUS
     AI_TUTOR_TYPES
+    PII_TYPES
     FEATURED_PROJECT_STATUS
     FEATURED_PROJECT_CONSTANTS
     LMS_LINKS

diff --git a/apps/src/aiTutor/constants.ts b/apps/src/aiTutor/constants.ts
@@ -1,4 +1,7 @@
-import {Role, Status} from '@cdo/apps/aiTutor/types';
+import {
+  Role,
+  AITutorInteractionStatus as Status,
+} from '@cdo/apps/aiTutor/types';
 
 export const compilationSystemPrompt =
   'You are a tutor in a high school computer science class. Students in the class are studying Java and they would like to know in age-appropriate, clear language why their code does not compile. Do not write any code.';

diff --git a/apps/src/aiTutor/redux/aiTutorRedux.ts b/apps/src/aiTutor/redux/aiTutorRedux.ts
@@ -7,18 +7,20 @@ import {
 } from '@cdo/apps/aiTutor/constants';
 import {savePromptAndResponse} from '../interactionsApi';
 import {
-  TutorType,
   Role,
-  Status,
+  AITutorInteractionStatus as Status,
   ChatCompletionMessage,
   Level,
   ChatContext,
+  AITutorTypesValue,
+  AITutorTypes as TutorTypes,
+  AITutorInteractionStatusValue,
 } from '../types';
 
 const registerReducers = require('@cdo/apps/redux').registerReducers;
 
 export interface AITutorState {
-  selectedTutorType: TutorType | undefined;
+  selectedTutorType: AITutorTypesValue | undefined;
   level: Level | undefined;
   scriptId: number | undefined;
   aiResponse: string | undefined;
@@ -58,9 +60,9 @@ export const askAITutor = createAsyncThunk(
     };
 
     const tutorType = chatContext.tutorType;
-    const generalChat = tutorType === TutorType.GENERAL_CHAT;
-    const compilation = tutorType === TutorType.COMPILATION;
-    const validation = tutorType === TutorType.VALIDATION;
+    const generalChat = tutorType === TutorTypes.GENERAL_CHAT;
+    const compilation = tutorType === TutorTypes.COMPILATION;
+    const validation = tutorType === TutorTypes.VALIDATION;
 
     let systemPrompt;
     if (validation) {
@@ -129,7 +131,7 @@ const aiTutorSlice = createSlice({
   reducers: {
     setSelectedTutorType: (
       state,
-      action: PayloadAction<TutorType | undefined>
+      action: PayloadAction<AITutorTypesValue | undefined>
     ) => {
       state.selectedTutorType = action.payload;
     },
@@ -159,7 +161,7 @@ const aiTutorSlice = createSlice({
     },
     updateChatMessageStatus: (
       state,
-      action: PayloadAction<{id: number; status: Status}>
+      action: PayloadAction<{id: number; status: AITutorInteractionStatusValue}>
     ) => {
       const {id, status} = action.payload;
       const chatMessage = state.chatMessages.find(msg => msg.id === id);

diff --git a/apps/src/aiTutor/types.ts b/apps/src/aiTutor/types.ts
@@ -1,63 +1,76 @@
 import {
-  AiTutorInteractionSaveStatus,
-  AiTutorTypes,
+  AiTutorInteractionStatus as AITutorInteractionStatus,
+  AiTutorTypes as AITutorTypes,
+  PiiTypes as PII,
 } from '@cdo/apps/util/sharedConstants';
 
-export type ChatCompletionMessage = {
+// TODO: Update this once https://codedotorg.atlassian.net/browse/CT-471 is resolved
+export type AITutorTypesValue = string;
+export type AITutorInteractionStatusValue = string;
+
+export {AITutorInteractionStatus, AITutorTypes, PII};
+
+export interface ChatCompletionMessage {
   id: number;
   role: Role;
   chatMessageText: string;
-  status: Status;
+  status: string;
   timestamp?: string;
-};
+}
 
-export type AITutorInteraction = {
+export interface AITutorInteraction {
   userId?: number;
   levelId?: number;
   scriptId?: number;
-  type: TutorType | undefined;
+  type: AITutorTypesValue | undefined;
   isProjectBacked?: boolean;
   prompt: string;
-  status: string;
+  status: AITutorInteractionStatusValue;
   aiResponse?: string;
-};
+}
 
-export type StudentChatRow = {
-  id: number;
-  studentName: string;
-  type: TutorType;
-  prompt: string;
-  status: string;
+export interface StudentChatRow {
+  aiModelVersion: string;
   aiResponse?: string;
   createdAt: string;
-};
+  id: number;
+  levelId?: number;
+  projectId?: string;
+  prompt: string;
+  scriptId?: number;
+  status: AITutorInteractionStatusValue;
+  studentName: string;
+  type: AITutorTypesValue;
+  updatedAt?: string;
+  userId: number;
+}
 
-export type StudentServerData = {
+export interface StudentServerData {
   id: number;
   name: string;
   ai_tutor_access_denied: boolean;
-};
+}
 
-export type StudentAccessData = {
+export interface StudentAccessData {
   id: number;
   name: string;
   aiTutorAccessDenied: boolean;
-};
+}
 
-export type Level = {
+export interface Level {
   id: number;
   type: string;
   hasValidation: boolean;
   isProjectBacked: boolean;
   aiTutorAvailable: boolean;
   isAssessment: boolean;
-};
+}
 
 export interface ChatContext {
   // studentInput is the last user message for general chat
   // or the student's code for compilation and validaiton.
   studentInput: string;
-  tutorType: TutorType | undefined;
+  tutorType: AITutorTypesValue | undefined;
 }
 
 export enum Role {
@@ -67,10 +80,3 @@ export enum Role {
   // only used in Aichat, but our types are currently tangled up :)
   MODEL_UPDATE = 'update',
 }
-export type Status =
-  (typeof AiTutorInteractionSaveStatus)[keyof typeof AiTutorInteractionSaveStatus];
-export const Status = AiTutorInteractionSaveStatus;
-export const PII = [Status.EMAIL, Status.ADDRESS, Status.PHONE];
-
-export type TutorType = (typeof AiTutorTypes)[keyof typeof AiTutorTypes];
-export const TutorType = AiTutorTypes;
diff --git a/apps/src/aichat/chatApi.ts b/apps/src/aichat/chatApi.ts
@@ -1,21 +1,21 @@
 import {
   Role,
-  Status,
+  AITutorInteractionStatus as Status,
+  AITutorInteractionStatusValue,
+  AITutorTypesValue,
   ChatCompletionMessage,
-  PII,
 } from '@cdo/apps/aiTutor/types';
 import HttpClient from '@cdo/apps/util/HttpClient';
 import {CHAT_COMPLETION_URL} from './constants';
 import Lab2Registry from '../lab2/Lab2Registry';
-import {TutorType} from '../aiTutor/types';
 
 /**
  * This function sends a POST request to the chat completion backend controller.
  */
 export async function postOpenaiChatCompletion(
   messagesToSend: OpenaiChatCompletionMessage[],
   levelId?: number,
-  tutorType?: TutorType
+  tutorType?: AITutorTypesValue
 ): Promise<OpenaiChatCompletionMessage | null> {
   const payload = levelId
     ? {levelId: levelId, messages: messagesToSend, type: tutorType}
@@ -54,7 +54,7 @@ export async function getChatCompletionMessage(
   newMessage: string,
   chatMessages: ChatCompletionMessage[],
   levelId?: number,
-  tutorType?: TutorType
+  tutorType?: AITutorTypesValue
 ): Promise<ChatCompletionResponse> {
   const messagesToSend = [
     {role: Role.SYSTEM, content: systemPrompt},
@@ -77,16 +77,16 @@ export async function getChatCompletionMessage(
   // For now, response will be null if there was an error.
   if (!response) {
     return {status: Status.ERROR, id: userMessageId};
-  } else if (response.status === Status.PROFANITY) {
+  } else if (response?.status === Status.PROFANITY_VIOLATION) {
     return {
-      status: Status.PROFANITY,
+      status: Status.PROFANITY_VIOLATION,
       id: userMessageId,
       assistantResponse:
         "I can't respond because your message is inappropriate. Please don't use profanity.",
     };
-  } else if (response && response.status && PII.includes(response.status)) {
+  } else if (response?.status === Status.PII_VIOLATION) {
     return {
-      status: Status.PERSONAL,
+      status: Status.PII_VIOLATION,
       id: userMessageId,
       assistantResponse: `I can't respond because your message is inappropriate. Please don't include personal information like your ${response.status}.`,
     };
@@ -99,12 +99,12 @@ export async function getChatCompletionMessage(
 }
 
 type OpenaiChatCompletionMessage = {
-  status?: Status;
+  status?: AITutorInteractionStatusValue;
   role: Role;
   content: string;
 };
 type ChatCompletionResponse = {
-  status: Status;
+  status: AITutorInteractionStatusValue;
   id: number;
   assistantResponse?: string;
 };
diff --git a/apps/src/aichat/constants.ts b/apps/src/aichat/constants.ts
@@ -1,5 +1,9 @@
 export const CHAT_COMPLETION_URL = '/openai/chat_completion';
-import {ChatCompletionMessage, Role, Status} from './types';
+import {
+  ChatCompletionMessage,
+  Role,
+  AITutorInteractionStatus as Status,
+} from './types';
 
 const initialChatMessages: ChatCompletionMessage[] = [
   {

diff --git a/apps/src/aichat/redux/aichatRedux.ts b/apps/src/aichat/redux/aichatRedux.ts
@@ -15,7 +15,8 @@ import {
   ChatCompletionMessage,
   AichatLevelProperties,
   Role,
-  Status,
+  AITutorInteractionStatus as Status,
+  AITutorInteractionStatusType,
   AiCustomizations,
   ModelCardInfo,
   Visibility,
@@ -215,7 +216,7 @@ const aichatSlice = createSlice({
     },
     updateChatMessageStatus: (
       state,
-      action: PayloadAction<{id: number; status: Status}>
+      action: PayloadAction<{id: number; status: AITutorInteractionStatusType}>
     ) => {
       const {id, status} = action.payload;
       const chatMessage = state.chatMessages.find(msg => msg.id === id);

diff --git a/apps/src/aichat/types.ts b/apps/src/aichat/types.ts
@@ -1,11 +1,19 @@
 import {LevelProperties} from '@cdo/apps/lab2/types';
-import {AiTutorInteractionSaveStatus} from '@cdo/apps/util/sharedConstants';
+import {
+  AiTutorInteractionStatus as AITutorInteractionStatus,
+  PiiTypes as PII,
+} from '@cdo/apps/util/sharedConstants';
+
+// TODO: Update this once https://codedotorg.atlassian.net/browse/CT-471 is resolved
+export type AITutorInteractionStatusType = string;
+
+export {PII, AITutorInteractionStatus};
 
 export type ChatCompletionMessage = {
   id: number;
   role: Role;
   chatMessageText: string;
-  status: Status;
+  status: AITutorInteractionStatusType;
   timestamp?: string;
 };
 
@@ -16,11 +24,6 @@ export enum Role {
   MODEL_UPDATE = 'update',
 }
 
-export type Status =
-  (typeof AiTutorInteractionSaveStatus)[keyof typeof AiTutorInteractionSaveStatus];
-export const Status = AiTutorInteractionSaveStatus;
-export const PII = [Status.EMAIL, Status.ADDRESS, Status.PHONE];
-
 export enum ViewMode {
   EDIT = 'edit-mode',
   PRESENTATION = 'presentation-mode',

diff --git a/apps/src/aichat/views/ChatMessage.tsx b/apps/src/aichat/views/ChatMessage.tsx
@@ -14,7 +14,7 @@ import {
   AichatLevelProperties,
   ChatCompletionMessage,
   Role,
-  Status,
+  AITutorInteractionStatus as Status,
 } from '../types';
 import aichatI18n from '../locale';
 import moduleStyles from './chatMessage.module.scss';
@@ -39,7 +39,7 @@ const displayUserMessage = (status: string, chatMessageText: string) => {
         {chatMessageText}
       </div>
     );
-  } else if (status === Status.INAPPROPRIATE) {
+  } else if (status === Status.PROFANITY_VIOLATION) {
     return (
       <div
         className={classNames(
@@ -50,7 +50,7 @@ const displayUserMessage = (status: string, chatMessageText: string) => {
         {INAPPROPRIATE_MESSAGE}
       </div>
     );
-  } else if (status === Status.PERSONAL) {
+  } else if (status === Status.PII_VIOLATION) {
     return (
       <div
         className={classNames(

diff --git a/apps/src/code-studio/components/aiTutor/aiTutor.tsx b/apps/src/code-studio/components/aiTutor/aiTutor.tsx
@@ -2,7 +2,7 @@ import React, {useCallback, useEffect} from 'react';
 import style from './ai-tutor.module.scss';
 import ChatWorkspace from './chatWorkspace';
 import {useAppDispatch, useAppSelector} from '@cdo/apps/util/reduxHooks';
-import {TutorType} from '@cdo/apps/aiTutor/types';
+import {AITutorTypes as TutorTypes} from '@cdo/apps/aiTutor/types';
 import {
   compilationError,
   compilationErrorFirst,
@@ -74,13 +74,13 @@ const AITutor: React.FunctionComponent = () => {
   }, [dispatch]);
 
   useEffect(() => {
-    if (tutorType === TutorType.COMPILATION) {
+    if (tutorType === TutorTypes.COMPILATION) {
       setCompilationChatMessages();
     }
-    if (tutorType === TutorType.GENERAL_CHAT) {
+    if (tutorType === TutorTypes.GENERAL_CHAT) {
       setGeneralChatMessages();
     }
-    if (tutorType === TutorType.VALIDATION) {
+    if (tutorType === TutorTypes.VALIDATION) {
       setValidationChatMessages();
     }
   }, [

diff --git a/apps/src/code-studio/components/aiTutor/aiTutorChatMessageTableRow.tsx b/apps/src/code-studio/components/aiTutor/aiTutorChatMessageTableRow.tsx
@@ -1,6 +1,9 @@
 import React from 'react';
 import style from './chat-messages-table.module.scss';
-import {StudentChatRow, TutorType} from '@cdo/apps/aiTutor/types';
+import {
+  StudentChatRow,
+  AITutorTypes as TutorTypes,
+} from '@cdo/apps/aiTutor/types';
 import {
   genericCompilation,
   genericValidation,
@@ -18,9 +21,9 @@ const AITutorChatMessagesTableRow: React.FunctionComponent<
   };
 
   const getPrompt = (chatMessage: StudentChatRow) => {
-    if (chatMessage.type === TutorType.COMPILATION) {
+    if (chatMessage.type === TutorTypes.COMPILATION) {
       return genericCompilation;
-    } else if (chatMessage.type === TutorType.VALIDATION) {
+    } else if (chatMessage.type === TutorTypes.VALIDATION) {
       return genericValidation;
     } else {
       return chatMessage.prompt;