From a82ca47f09e26cf6e8fc9f2bd4693442596a9bf6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Kaan=20=C3=87ayl=C4=B1?=
 <38523756+kaancayli@users.noreply.github.com>
Date: Mon, 2 Dec 2024 11:56:19 +0100
Subject: [PATCH] Iris: Hide suggestions during response generation (#9919)

---
 .../iris-base-chatbot.component.html          |  9 +-
 .../ui/iris-base-chatbot.component.spec.ts    | 90 +++++++++++++++++++
 2 files changed, 98 insertions(+), 1 deletion(-)

diff --git a/src/main/webapp/app/iris/base-chatbot/iris-base-chatbot.component.html b/src/main/webapp/app/iris/base-chatbot/iris-base-chatbot.component.html
index 9734b552d14d..56e5d8b39559 100644
--- a/src/main/webapp/app/iris/base-chatbot/iris-base-chatbot.component.html
+++ b/src/main/webapp/app/iris/base-chatbot/iris-base-chatbot.component.html
@@ -60,7 +60,14 @@ <h4 class="modal-title">
 <div class="chat-body" [class.not-accepted]="!userAccepted" #chatBody>
     @if (messages?.length) {
         <div class="messages" #messagesElement (scroll)="checkChatScroll()">
-            @if (suggestions?.length) {
+            @if (
+                suggestions?.length &&
+                userAccepted &&
+                !this.isLoading &&
+                this.active &&
+                (!this.rateLimitInfo?.rateLimit || this.rateLimitInfo?.currentMessageCount !== this.rateLimitInfo?.rateLimit) &&
+                !this.hasActiveStage
+            ) {
                 <div @suggestionAnimation class="suggestions-container">
                     @for (suggestion of suggestions; track suggestion) {
                         <button class="suggestion-button" (click)="onSuggestionClick(suggestion)" [innerHTML]="suggestion"></button>
diff --git a/src/test/javascript/spec/component/iris/ui/iris-base-chatbot.component.spec.ts b/src/test/javascript/spec/component/iris/ui/iris-base-chatbot.component.spec.ts
index 1bad06bcbba7..a5a0334dbc33 100644
--- a/src/test/javascript/spec/component/iris/ui/iris-base-chatbot.component.spec.ts
+++ b/src/test/javascript/spec/component/iris/ui/iris-base-chatbot.component.spec.ts
@@ -480,6 +480,96 @@ describe('IrisBaseChatbotComponent', () => {
         expect(suggestionButtons).toHaveLength(0);
     });
 
+    it('should not render suggestions if isLoading is true', () => {
+        // Arrange
+        const expectedSuggestions = ['suggestion1', 'suggestion2'];
+        const mockMessages = [mockClientMessage, mockServerMessage];
+
+        jest.spyOn(chatService, 'currentSuggestions').mockReturnValue(of(expectedSuggestions));
+        jest.spyOn(chatService, 'currentMessages').mockReturnValue(of(mockMessages));
+
+        // Act
+        component.ngOnInit();
+        component.isLoading = true;
+        fixture.detectChanges();
+
+        // Assert
+        const suggestionButtons = fixture.nativeElement.querySelectorAll('.suggestion-button');
+        expect(suggestionButtons).toHaveLength(0);
+    });
+
+    it('should not render suggestions if userAccepted is false', () => {
+        // Arrange
+        const expectedSuggestions = ['suggestion1', 'suggestion2'];
+        const mockMessages = [mockClientMessage, mockServerMessage];
+
+        jest.spyOn(chatService, 'currentSuggestions').mockReturnValue(of(expectedSuggestions));
+        jest.spyOn(chatService, 'currentMessages').mockReturnValue(of(mockMessages));
+
+        // Act
+        component.ngOnInit();
+        component.userAccepted = false;
+        fixture.detectChanges();
+
+        // Assert
+        const suggestionButtons = fixture.nativeElement.querySelectorAll('.suggestion-button');
+        expect(suggestionButtons).toHaveLength(0);
+    });
+
+    it('should not render suggestions if the rate limit is exceeded', () => {
+        // Arrange
+        const expectedSuggestions = ['suggestion1', 'suggestion2'];
+        const mockMessages = [mockClientMessage, mockServerMessage];
+
+        jest.spyOn(chatService, 'currentSuggestions').mockReturnValue(of(expectedSuggestions));
+        jest.spyOn(chatService, 'currentMessages').mockReturnValue(of(mockMessages));
+
+        // Act
+        component.ngOnInit();
+        component.rateLimitInfo = { currentMessageCount: 100, rateLimit: 100, rateLimitTimeframeHours: 1 };
+        fixture.detectChanges();
+
+        // Assert
+        const suggestionButtons = fixture.nativeElement.querySelectorAll('.suggestion-button');
+        expect(suggestionButtons).toHaveLength(0);
+    });
+
+    it('should not render suggestions if the user is not active', () => {
+        // Arrange
+        const expectedSuggestions = ['suggestion1', 'suggestion2'];
+        const mockMessages = [mockClientMessage, mockServerMessage];
+
+        jest.spyOn(chatService, 'currentSuggestions').mockReturnValue(of(expectedSuggestions));
+        jest.spyOn(chatService, 'currentMessages').mockReturnValue(of(mockMessages));
+
+        // Act
+        component.ngOnInit();
+        component.active = false;
+        fixture.detectChanges();
+
+        // Assert
+        const suggestionButtons = fixture.nativeElement.querySelectorAll('.suggestion-button');
+        expect(suggestionButtons).toHaveLength(0);
+    });
+
+    it('should not render suggestions if hasActiveStage is true', () => {
+        // Arrange
+        const expectedSuggestions = ['suggestion1', 'suggestion2'];
+        const mockMessages = [mockClientMessage, mockServerMessage];
+
+        jest.spyOn(chatService, 'currentSuggestions').mockReturnValue(of(expectedSuggestions));
+        jest.spyOn(chatService, 'currentMessages').mockReturnValue(of(mockMessages));
+
+        // Act
+        component.ngOnInit();
+        component.hasActiveStage = true;
+        fixture.detectChanges();
+
+        // Assert
+        const suggestionButtons = fixture.nativeElement.querySelectorAll('.suggestion-button');
+        expect(suggestionButtons).toHaveLength(0);
+    });
+
     describe('clear chat session', () => {
         it('should open confirm modal when click on the clear button', fakeAsync(() => {
             jest.spyOn(httpService, 'getCurrentSessionOrCreateIfNotExists').mockReturnValueOnce(of(mockServerSessionHttpResponse));