Vault workspace suggested question (#7903)

* chore: return suggested question when ai say i don't know

* chore: new message type

* chore: implement uI

* chore: implement UI

* fix: assertion in local ai chat

* chore: implement UI

* chore: update prompt

* chore: update logs

* chore: add tests

* chore: message id

* fix: local ai page animation issue

* chore: remove debug log

* fix: remove repeated setState

* chore: add test

* chore: test

* fix: compile

---------

Co-authored-by: Lucas.Xu <lucas.xu@appflowy.io>

Author: appflowy

frontend/appflowy_flutter/lib/ai/service/ai_entities.dart

@@ -15,11 +15,12 @@ class AIStreamEventPrefix {
   static const start = 'start:';
   static const finish = 'finish:';
   static const comment = 'comment:';
-  static const aiResponseLimit = 'AI_RESPONSE_LIMIT';
-  static const aiImageResponseLimit = 'AI_IMAGE_RESPONSE_LIMIT';
-  static const aiMaxRequired = 'AI_MAX_REQUIRED:';
-  static const localAINotReady = 'LOCAL_AI_NOT_READY';
-  static const localAIDisabled = 'LOCAL_AI_DISABLED';
+  static const aiResponseLimit = 'ai_response_limit:';
+  static const aiImageResponseLimit = 'ai_image_response_limit:';
+  static const aiMaxRequired = 'ai_max_required:';
+  static const localAINotReady = 'local_ai_not_ready:';
+  static const localAIDisabled = 'local_ai_disabled:';
+  static const aiFollowUp = 'ai_follow_up:';
 }
 
 enum AiType {

frontend/appflowy_flutter/lib/plugins/ai_chat/application/chat_ai_message_bloc.dart

@@ -117,6 +117,14 @@ class ChatAIMessageBloc extends Bloc<ChatAIMessageEvent, ChatAIMessageState> {
         ),
       );
     });
+
+    on<_OnAIFollowUp>((event, emit) {
+      emit(
+        state.copyWith(
+          messageState: MessageState.aiFollowUp(event.followUpData),
+        ),
+      );
+    });
   }
 
   void _initializeStreamListener() {
@@ -137,6 +145,9 @@ class ChatAIMessageBloc extends Bloc<ChatAIMessageEvent, ChatAIMessageState> {
         },
         onLocalAIInitializing: () =>
             _safeAdd(const ChatAIMessageEvent.onLocalAIInitializing()),
+        onAIFollowUp: (data) {
+          _safeAdd(ChatAIMessageEvent.onAIFollowUp(data));
+        },
       );
     }
   }
@@ -174,6 +185,9 @@ class ChatAIMessageEvent with _$ChatAIMessageEvent {
   const factory ChatAIMessageEvent.receiveMetadata(
     MetadataCollection metadata,
   ) = _ReceiveMetadata;
+  const factory ChatAIMessageEvent.onAIFollowUp(
+    AIFollowUpData followUpData,
+  ) = _OnAIFollowUp;
 }
 
 @freezed
@@ -209,4 +223,6 @@ class MessageState with _$MessageState {
   const factory MessageState.onInitializingLocalAI() = _LocalAIInitializing;
   const factory MessageState.ready() = _Ready;
   const factory MessageState.loading() = _Loading;
+  const factory MessageState.aiFollowUp(AIFollowUpData followUpData) =
+      _AIFollowUp;
 }

frontend/appflowy_flutter/lib/plugins/ai_chat/application/chat_bloc.dart

@@ -24,6 +24,11 @@ import 'chat_message_stream.dart';
 
 part 'chat_bloc.freezed.dart';
 
+/// Returns current Unix timestamp (seconds since epoch)
+int timestamp() {
+  return DateTime.now().millisecondsSinceEpoch ~/ 1000;
+}
+
 class ChatBloc extends Bloc<ChatEvent, ChatState> {
   ChatBloc({
     required this.chatId,
@@ -277,6 +282,10 @@ class ChatBloc extends Bloc<ChatEvent, ChatState> {
           deleteMessage: (mesesage) async {
             await chatController.remove(mesesage);
           },
+          onAIFollowUp: (followUpData) {
+            shouldFetchRelatedQuestions =
+                followUpData.shouldGenerateRelatedQuestion;
+          },
         );
       },
     );
@@ -560,8 +569,7 @@ class ChatBloc extends Bloc<ChatEvent, ChatState> {
     Map<String, dynamic>? sentMetadata,
   ) {
     final now = DateTime.now();
-
-    questionStreamMessageId = (now.millisecondsSinceEpoch ~/ 1000).toString();
+    questionStreamMessageId = timestamp().toString();
 
     return TextMessage(
       author: User(id: userId),
@@ -674,6 +682,9 @@ class ChatEvent with _$ChatEvent {
   ) = _DidReceiveRelatedQueston;
 
   const factory ChatEvent.deleteMessage(Message message) = _DeleteMessage;
+
+  const factory ChatEvent.onAIFollowUp(AIFollowUpData followUpData) =
+      _OnAIFollowUp;
 }
 
 @freezed

frontend/appflowy_flutter/lib/plugins/ai_chat/application/chat_message_stream.dart

@@ -1,9 +1,14 @@
 import 'dart:async';
+import 'dart:convert';
 import 'dart:ffi';
 import 'dart:isolate';
 
 import 'package:appflowy/ai/service/ai_entities.dart';
 import 'package:appflowy/plugins/ai_chat/application/chat_message_service.dart';
+import 'package:appflowy_backend/log.dart';
+import 'package:json_annotation/json_annotation.dart';
+
+part 'chat_message_stream.g.dart';
 
 /// A stream that receives answer events from an isolate or external process.
 /// It caches events that might occur before a listener is attached.
@@ -37,7 +42,7 @@ class AnswerStream {
   void Function()? _onAIImageResponseLimit;
   void Function(String message)? _onAIMaxRequired;
   void Function(MetadataCollection metadata)? _onMetadata;
-
+  void Function(AIFollowUpData)? _onAIFollowUp;
   // Caches for events that occur before listen() is called.
   final List<String> _pendingAIMaxRequiredEvents = [];
   bool _pendingLocalAINotReady = false;
@@ -88,6 +93,15 @@ class AnswerStream {
       } else {
         _pendingLocalAINotReady = true;
       }
+    } else if (event.startsWith(AIStreamEventPrefix.aiFollowUp)) {
+      final s = event.substring(AIStreamEventPrefix.aiFollowUp.length);
+      try {
+        final dynamic jsonData = jsonDecode(s);
+        final data = AIFollowUpData.fromJson(jsonData);
+        _onAIFollowUp?.call(data);
+      } catch (e) {
+        Log.error('Error deserializing AIFollowUp data: $e\nRaw JSON: $s');
+      }
     }
   }
 
@@ -114,6 +128,7 @@ class AnswerStream {
     void Function(String message)? onAIMaxRequired,
     void Function(MetadataCollection metadata)? onMetadata,
     void Function()? onLocalAIInitializing,
+    void Function(AIFollowUpData)? onAIFollowUp,
   }) {
     _onData = onData;
     _onStart = onStart;
@@ -124,7 +139,7 @@ class AnswerStream {
     _onAIMaxRequired = onAIMaxRequired;
     _onMetadata = onMetadata;
     _onLocalAIInitializing = onLocalAIInitializing;
-
+    _onAIFollowUp = onAIFollowUp;
     // Flush pending AI_MAX_REQUIRED events.
     if (_onAIMaxRequired != null && _pendingAIMaxRequiredEvents.isNotEmpty) {
       for (final msg in _pendingAIMaxRequiredEvents) {
@@ -205,7 +220,6 @@ class QuestionStream {
   void Function()? _onIndexStart;
   void Function()? _onIndexEnd;
   void Function()? _onDone;
-
   int get nativePort => _port.sendPort.nativePort;
   bool get hasStarted => _hasStarted;
   String? get error => _error;
@@ -241,3 +255,18 @@ class QuestionStream {
     _onDone = onDone;
   }
 }
+
+@JsonSerializable()
+class AIFollowUpData {
+  AIFollowUpData({
+    required this.shouldGenerateRelatedQuestion,
+  });
+
+  factory AIFollowUpData.fromJson(Map<String, dynamic> json) =>
+      _$AIFollowUpDataFromJson(json);
+
+  @JsonKey(name: 'should_generate_related_question')
+  final bool shouldGenerateRelatedQuestion;
+
+  Map<String, dynamic> toJson() => _$AIFollowUpDataToJson(this);
+}

frontend/appflowy_flutter/lib/plugins/ai_chat/presentation/animated_chat_list.dart

@@ -152,6 +152,8 @@ class ChatAnimatedListState extends State<ChatAnimatedList>
     itemPositionsListener.itemPositions.addListener(() {
       _handleLoadPreviousMessages();
     });
+
+    // A trick to avoid the first message being scrolled to the top
   }
 
   @override
@@ -167,8 +169,8 @@ class ChatAnimatedListState extends State<ChatAnimatedList>
   Widget build(BuildContext context) {
     final builders = context.watch<Builders>();
     final height = MediaQuery.of(context).size.height;
-
     // A trick to avoid the first message being scrolled to the top
+
     initialScrollIndex = messages.length;
     initialAlignment = 1.0;
     if (messages.length <= 2) {

frontend/appflowy_flutter/lib/plugins/ai_chat/presentation/chat_page/text_message_widget.dart

@@ -79,6 +79,8 @@ class TextMessageWidget extends StatelessWidget {
       selector: (state) => state.isSelectingMessages,
       builder: (context, isSelectingMessages) {
         return BlocBuilder<ChatBloc, ChatState>(
+          buildWhen: (previous, current) =>
+              previous.promptResponseState != current.promptResponseState,
           builder: (context, state) {
             final chatController = context.read<ChatBloc>().chatController;
             final messages = chatController.messages