@gitlab/ui 78.0.0 → 78.1.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [78.1.1](https://gitlab.com/gitlab-org/gitlab-ui/compare/v78.1.0...v78.1.1) (2024-03-05)
+
+
+### Bug Fixes
+
+* **GlDuoChat:** allow typing prompt while streaming ([bc107bf](https://gitlab.com/gitlab-org/gitlab-ui/commit/bc107bf7b4e84ec787142ed5b43f299ec6c7ea0b))
+
+# [78.1.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v78.0.0...v78.1.0) (2024-03-05)
+
+
+### Features
+
+* **GlDuoChat:** explicitly disable Experimental Badge ([d701cc9](https://gitlab.com/gitlab-org/gitlab-ui/commit/d701cc95e9af956ce17c3b4c75ea4d481cadde59))
+
 # [78.0.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v77.7.0...v78.0.0) (2024-03-05)
 
 

package/dist/components/experimental/duo/chat/duo_chat.js

@@ -119,7 +119,7 @@ var script = {
      * The type of the badge. This is passed down to the `GlExperimentBadge` component. Refer that component for more information.
      */
     badgeType: {
-      type: String,
+      type: String || null,
       required: false,
       default: badgeTypes[0],
       validator: badgeTypeValidator
@@ -201,12 +201,22 @@ var script = {
         return acc;
       }, [[]]);
     },
+    lastMessage() {
+      return this.messages[this.messages.length - 1];
+    },
     resetDisabled() {
+      var _this$lastMessage;
       if (this.isLoading || !this.hasMessages) {
         return true;
       }
-      const lastMessage = this.messages[this.messages.length - 1];
-      return lastMessage.content === CHAT_RESET_MESSAGE;
+      return ((_this$lastMessage = this.lastMessage) === null || _this$lastMessage === void 0 ? void 0 : _this$lastMessage.content) === CHAT_RESET_MESSAGE;
+    },
+    submitDisabled() {
+      return this.isLoading || this.isStreaming;
+    },
+    isStreaming() {
+      var _this$lastMessage2, _this$lastMessage2$ch, _this$lastMessage3;
+      return Boolean(((_this$lastMessage2 = this.lastMessage) === null || _this$lastMessage2 === void 0 ? void 0 : (_this$lastMessage2$ch = _this$lastMessage2.chunks) === null || _this$lastMessage2$ch === void 0 ? void 0 : _this$lastMessage2$ch.length) > 0 && !((_this$lastMessage3 = this.lastMessage) !== null && _this$lastMessage3 !== void 0 && _this$lastMessage3.content));
     },
     filteredSlashCommands() {
       const caseInsensitivePrompt = this.prompt.toLowerCase();
@@ -227,12 +237,13 @@ var script = {
     }
   },
   watch: {
-    isLoading() {
+    isLoading(newVal) {
       this.isHidden = false;
       this.scrollToBottom();
-    },
-    messages() {
-      this.prompt = '';
+      if (newVal) {
+        // We reset the prompt when we start getting the response and focus in the prompt field
+        this.setPromptAndFocus();
+      }
     }
   },
   created() {
@@ -250,6 +261,9 @@ var script = {
       this.$emit('chat-hidden');
     },
     sendChatPrompt() {
+      if (this.submitDisabled) {
+        return;
+      }
       if (this.prompt) {
         if (this.prompt === CHAT_RESET_MESSAGE && this.resetDisabled) {
           return;
@@ -324,14 +338,19 @@ var script = {
         this.activeCommandIndex = 0;
       }
     },
+    async setPromptAndFocus() {
+      let prompt = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
+      this.prompt = prompt;
+      await this.$nextTick();
+      this.$refs.prompt.$el.focus();
+    },
     selectSlashCommand(index) {
       const command = this.filteredSlashCommands[index];
       if (command.shouldSubmit) {
         this.prompt = command.name;
         this.sendChatPrompt();
       } else {
-        this.prompt = `${command.name} `;
-        this.$refs.prompt.$el.focus();
+        this.setPromptAndFocus(`${command.name} `);
       }
     }
   },
@@ -343,11 +362,11 @@ var script = {
 const __vue_script__ = script;
 
 /* template */
-var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return (!_vm.isHidden)?_c('aside',{staticClass:"markdown-code-block gl-drawer gl-max-h-full gl-bottom-0 gl-shadow-none gl-border-l gl-border-t duo-chat",attrs:{"id":"chat-component","role":"complementary","data-testid":"chat-component"}},[(_vm.showHeader)?_c('header',{staticClass:"gl-drawer-header gl-drawer-header-sticky gl-z-index-200 gl-p-0! gl-border-b-0",attrs:{"data-testid":"chat-header"}},[_c('div',{staticClass:"drawer-title gl-display-flex gl-justify-content-start gl-align-items-center gl-p-5"},[_c('h3',{staticClass:"gl-my-0 gl-font-size-h2"},[_vm._v(_vm._s(_vm.title))]),_vm._v(" "),_c('gl-experiment-badge',{attrs:{"help-page-url":_vm.badgeHelpPageUrl,"type":_vm.badgeType,"container-id":"chat-component"}}),_vm._v(" "),_c('gl-button',{staticClass:"gl-p-0! gl-ml-auto",attrs:{"category":"tertiary","variant":"default","icon":"close","size":"small","data-testid":"chat-close-button","aria-label":_vm.$options.i18n.CHAT_CLOSE_LABEL},on:{"click":_vm.hideChat}})],1),_vm._v(" "),_c('gl-alert',{staticClass:"gl-text-center gl-border-t gl-p-4 gl-text-gray-700 gl-bg-gray-50 legal-warning gl-max-w-full",attrs:{"dismissible":false,"variant":"tip","show-icon":false,"role":"alert","data-testid":"chat-legal-warning"}},[_vm._v(_vm._s(_vm.$options.i18n.CHAT_LEGAL_GENERATED_BY_AI))]),_vm._v(" "),_vm._t("subheader"),_vm._v(" "),(_vm.error)?_c('gl-alert',{key:"error",staticClass:"gl-pl-9!",attrs:{"dismissible":false,"variant":"danger","role":"alert","data-testid":"chat-error"}},[_c('span',{directives:[{name:"safe-html",rawName:"v-safe-html",value:(_vm.error),expression:"error"}]})]):_vm._e()],2):_vm._e(),_vm._v(" "),_c('div',{staticClass:"gl-drawer-body",attrs:{"data-testid":"chat-history"},on:{"scroll":_vm.handleScrollingTrottled}},[_c('transition-group',{staticClass:"duo-chat-history gl-display-flex gl-flex-direction-column gl-justify-content-end gl-bg-gray-10",class:[
+var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return (!_vm.isHidden)?_c('aside',{staticClass:"markdown-code-block gl-drawer gl-max-h-full gl-bottom-0 gl-shadow-none gl-border-l gl-border-t duo-chat",attrs:{"id":"chat-component","role":"complementary","data-testid":"chat-component"}},[(_vm.showHeader)?_c('header',{staticClass:"gl-drawer-header gl-drawer-header-sticky gl-z-index-200 gl-p-0! gl-border-b-0",attrs:{"data-testid":"chat-header"}},[_c('div',{staticClass:"drawer-title gl-display-flex gl-justify-content-start gl-align-items-center gl-p-5"},[_c('h3',{staticClass:"gl-my-0 gl-font-size-h2"},[_vm._v(_vm._s(_vm.title))]),_vm._v(" "),(_vm.badgeType)?_c('gl-experiment-badge',{attrs:{"help-page-url":_vm.badgeHelpPageUrl,"type":_vm.badgeType,"container-id":"chat-component"}}):_vm._e(),_vm._v(" "),_c('gl-button',{staticClass:"gl-p-0! gl-ml-auto",attrs:{"category":"tertiary","variant":"default","icon":"close","size":"small","data-testid":"chat-close-button","aria-label":_vm.$options.i18n.CHAT_CLOSE_LABEL},on:{"click":_vm.hideChat}})],1),_vm._v(" "),_c('gl-alert',{staticClass:"gl-text-center gl-border-t gl-p-4 gl-text-gray-700 gl-bg-gray-50 legal-warning gl-max-w-full",attrs:{"dismissible":false,"variant":"tip","show-icon":false,"role":"alert","data-testid":"chat-legal-warning"}},[_vm._v(_vm._s(_vm.$options.i18n.CHAT_LEGAL_GENERATED_BY_AI))]),_vm._v(" "),_vm._t("subheader"),_vm._v(" "),(_vm.error)?_c('gl-alert',{key:"error",staticClass:"gl-pl-9!",attrs:{"dismissible":false,"variant":"danger","role":"alert","data-testid":"chat-error"}},[_c('span',{directives:[{name:"safe-html",rawName:"v-safe-html",value:(_vm.error),expression:"error"}]})]):_vm._e()],2):_vm._e(),_vm._v(" "),_c('div',{staticClass:"gl-drawer-body",attrs:{"data-testid":"chat-history"},on:{"scroll":_vm.handleScrollingTrottled}},[_c('transition-group',{staticClass:"duo-chat-history gl-display-flex gl-flex-direction-column gl-justify-content-end gl-bg-gray-10",class:[
         {
           'gl-h-full': !_vm.hasMessages,
           'force-scroll-bar': _vm.hasMessages,
-        } ],attrs:{"tag":"section","name":"message"}},[_vm._l((_vm.conversations),function(conversation,index){return _c('gl-duo-chat-conversation',{key:("conversation-" + index),attrs:{"messages":conversation,"show-delimiter":index > 0},on:{"track-feedback":_vm.onTrackFeedback}})}),_vm._v(" "),(!_vm.hasMessages && !_vm.isLoading)?[_c('gl-empty-state',{key:"empty-state",staticClass:"gl-flex-grow gl-justify-content-center",attrs:{"svg-path":_vm.$options.emptySvg,"svg-height":145,"title":_vm.emptyStateTitle,"description":_vm.emptyStateDescription}}),_vm._v(" "),_c('gl-duo-chat-predefined-prompts',{key:"predefined-prompts",attrs:{"prompts":_vm.predefinedPrompts},on:{"click":_vm.sendPredefinedPrompt}})]:_vm._e(),_vm._v(" "),(_vm.isLoading)?_c('gl-duo-chat-loader',{key:"loader",attrs:{"tool-name":_vm.toolName}}):_vm._e(),_vm._v(" "),_c('div',{key:"anchor",ref:"anchor",staticClass:"scroll-anchor"})],2)],1),_vm._v(" "),(_vm.isChatAvailable)?_c('footer',{staticClass:"gl-drawer-footer gl-drawer-footer-sticky gl-p-5 gl-border-t gl-bg-gray-10",class:{ 'gl-drawer-body-scrim-on-footer': !_vm.scrolledToBottom },attrs:{"data-testid":"chat-footer"}},[_c('gl-form',{attrs:{"data-testid":"chat-prompt-form"},on:{"submit":function($event){$event.stopPropagation();$event.preventDefault();return _vm.sendChatPrompt.apply(null, arguments)}}},[_c('gl-form-input-group',{scopedSlots:_vm._u([{key:"append",fn:function(){return [_c('gl-button',{staticClass:"!gl-absolute gl-bottom-2 gl-right-2 gl-rounded-base!",attrs:{"icon":"paper-airplane","category":"primary","variant":"confirm","type":"submit","aria-label":_vm.$options.i18n.CHAT_SUBMIT_LABEL,"disabled":_vm.isLoading}})]},proxy:true}],null,false,3929529036)},[_c('div',{staticClass:"duo-chat-input gl-flex-grow-1 gl-vertical-align-top gl-max-w-full gl-min-h-8 gl-inset-border-1-gray-400 gl-rounded-base gl-bg-white",attrs:{"data-value":_vm.prompt}},[(_vm.shouldShowSlashCommands)?_c('gl-card',{ref:"commands",staticClass:"slash-commands !gl-absolute gl-translate-y-n100 gl-list-style-none gl-pl-0 gl-w-full gl-shadow-md",attrs:{"body-class":"gl-p-2!"}},_vm._l((_vm.filteredSlashCommands),function(command,index){return _c('gl-dropdown-item',{key:command.name,class:{ 'active-command': index === _vm.activeCommandIndex },on:{"click":function($event){return _vm.selectSlashCommand(index)}},nativeOn:{"mouseenter":function($event){_vm.activeCommandIndex = index;}}},[_c('span',{staticClass:"gl-display-flex gl-justify-content-space-between"},[_c('span',{staticClass:"gl-display-block"},[_vm._v(_vm._s(command.name))]),_vm._v(" "),_c('small',{staticClass:"gl-text-gray-500 gl-font-style-italic gl-text-right gl-pl-3"},[_vm._v(_vm._s(command.description))])])])}),1):_vm._e(),_vm._v(" "),_c('gl-form-textarea',{ref:"prompt",staticClass:"gl-absolute gl-h-full! gl-py-4! gl-bg-transparent! gl-rounded-top-right-none gl-rounded-bottom-right-none gl-shadow-none!",class:{ 'gl-text-truncate': !_vm.prompt },attrs:{"data-testid":"chat-prompt-input","placeholder":_vm.inputPlaceholder,"disabled":_vm.isLoading,"autofocus":""},nativeOn:{"keydown":function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"enter",13,$event.key,"Enter")){ return null; }if($event.ctrlKey||$event.shiftKey||$event.altKey||$event.metaKey){ return null; }$event.preventDefault();},"keyup":function($event){return _vm.onInputKeyup.apply(null, arguments)}},model:{value:(_vm.prompt),callback:function ($$v) {_vm.prompt=$$v;},expression:"prompt"}})],1)]),_vm._v(" "),_c('gl-form-text',{staticClass:"gl-text-gray-400 gl-line-height-20 gl-mt-3",attrs:{"data-testid":"chat-legal-disclaimer"}},[_vm._v(_vm._s(_vm.$options.i18n.CHAT_LEGAL_DISCLAIMER))])],1)],1):_vm._e()]):_vm._e()};
+        } ],attrs:{"tag":"section","name":"message"}},[_vm._l((_vm.conversations),function(conversation,index){return _c('gl-duo-chat-conversation',{key:("conversation-" + index),attrs:{"messages":conversation,"show-delimiter":index > 0},on:{"track-feedback":_vm.onTrackFeedback}})}),_vm._v(" "),(!_vm.hasMessages && !_vm.isLoading)?[_c('gl-empty-state',{key:"empty-state",staticClass:"gl-flex-grow gl-justify-content-center",attrs:{"svg-path":_vm.$options.emptySvg,"svg-height":145,"title":_vm.emptyStateTitle,"description":_vm.emptyStateDescription}}),_vm._v(" "),_c('gl-duo-chat-predefined-prompts',{key:"predefined-prompts",attrs:{"prompts":_vm.predefinedPrompts},on:{"click":_vm.sendPredefinedPrompt}})]:_vm._e(),_vm._v(" "),(_vm.isLoading)?_c('gl-duo-chat-loader',{key:"loader",attrs:{"tool-name":_vm.toolName}}):_vm._e(),_vm._v(" "),_c('div',{key:"anchor",ref:"anchor",staticClass:"scroll-anchor"})],2)],1),_vm._v(" "),(_vm.isChatAvailable)?_c('footer',{staticClass:"gl-drawer-footer gl-drawer-footer-sticky gl-p-5 gl-border-t gl-bg-gray-10",class:{ 'gl-drawer-body-scrim-on-footer': !_vm.scrolledToBottom },attrs:{"data-testid":"chat-footer"}},[_c('gl-form',{attrs:{"data-testid":"chat-prompt-form"},on:{"submit":function($event){$event.stopPropagation();$event.preventDefault();return _vm.sendChatPrompt.apply(null, arguments)}}},[_c('gl-form-input-group',{scopedSlots:_vm._u([{key:"append",fn:function(){return [_c('gl-button',{staticClass:"!gl-absolute gl-bottom-2 gl-right-2 gl-rounded-base!",attrs:{"icon":"paper-airplane","category":"primary","variant":"confirm","type":"submit","data-testid":"chat-prompt-submit-button","aria-label":_vm.$options.i18n.CHAT_SUBMIT_LABEL,"disabled":_vm.submitDisabled}})]},proxy:true}],null,false,3132459889)},[_c('div',{staticClass:"duo-chat-input gl-flex-grow-1 gl-vertical-align-top gl-max-w-full gl-min-h-8 gl-inset-border-1-gray-400 gl-rounded-base gl-bg-white",attrs:{"data-value":_vm.prompt}},[(_vm.shouldShowSlashCommands)?_c('gl-card',{ref:"commands",staticClass:"slash-commands !gl-absolute gl-translate-y-n100 gl-list-style-none gl-pl-0 gl-w-full gl-shadow-md",attrs:{"body-class":"gl-p-2!"}},_vm._l((_vm.filteredSlashCommands),function(command,index){return _c('gl-dropdown-item',{key:command.name,class:{ 'active-command': index === _vm.activeCommandIndex },on:{"click":function($event){return _vm.selectSlashCommand(index)}},nativeOn:{"mouseenter":function($event){_vm.activeCommandIndex = index;}}},[_c('span',{staticClass:"gl-display-flex gl-justify-content-space-between"},[_c('span',{staticClass:"gl-display-block"},[_vm._v(_vm._s(command.name))]),_vm._v(" "),_c('small',{staticClass:"gl-text-gray-500 gl-font-style-italic gl-text-right gl-pl-3"},[_vm._v(_vm._s(command.description))])])])}),1):_vm._e(),_vm._v(" "),_c('gl-form-textarea',{ref:"prompt",staticClass:"gl-absolute gl-h-full! gl-py-4! gl-bg-transparent! gl-rounded-top-right-none gl-rounded-bottom-right-none gl-shadow-none!",class:{ 'gl-text-truncate': !_vm.prompt },attrs:{"data-testid":"chat-prompt-input","placeholder":_vm.inputPlaceholder,"autofocus":""},nativeOn:{"keydown":function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"enter",13,$event.key,"Enter")){ return null; }if($event.ctrlKey||$event.shiftKey||$event.altKey||$event.metaKey){ return null; }$event.preventDefault();},"keyup":function($event){return _vm.onInputKeyup.apply(null, arguments)}},model:{value:(_vm.prompt),callback:function ($$v) {_vm.prompt=$$v;},expression:"prompt"}})],1)]),_vm._v(" "),_c('gl-form-text',{staticClass:"gl-text-gray-400 gl-line-height-20 gl-mt-3",attrs:{"data-testid":"chat-legal-disclaimer"}},[_vm._v(_vm._s(_vm.$options.i18n.CHAT_LEGAL_DISCLAIMER))])],1)],1):_vm._e()]):_vm._e()};
 var __vue_staticRenderFns__ = [];
 
   /* style */

package/dist/components/experimental/duo/chat/mock_data.js

@@ -1,3 +1,4 @@
+import { setStoryTimeout } from '../../../../utils/test_utils';
 import { DOCUMENTATION_SOURCE_TYPES, MESSAGE_MODEL_ROLES } from './constants';
 
 const MOCK_SOURCES = [{
@@ -57,21 +58,47 @@ const MOCK_RESPONSE_MESSAGE_FOR_STREAMING = {
   errors: [],
   timestamp: '2021-04-21T12:00:00.000Z'
 };
-const generateMockResponseChunks = requestId => {
-  const chunks = [];
-  const chunkSize = 5;
-  const chunkCount = Math.ceil(MOCK_RESPONSE_MESSAGE_FOR_STREAMING.content.length / chunkSize);
-  for (let i = 0; i < chunkCount; i += 1) {
-    const chunk = {
-      ...MOCK_RESPONSE_MESSAGE_FOR_STREAMING,
-      requestId,
-      content: MOCK_RESPONSE_MESSAGE_FOR_STREAMING.content.substring(i * chunkSize, (i + 1) * chunkSize),
-      chunkId: i
-    };
-    chunks.push(chunk);
+
+// Utility function for delay
+async function delayRandom() {
+  let min = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 16;
+  let max = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 267;
+  const delay = Math.floor(Math.random() * (max - min + 1)) + min;
+  // eslint-disable-next-line no-promise-executor-return
+  return new Promise(resolve => setStoryTimeout(resolve, delay));
+}
+function generateMockResponseChunks() {
+  try {
+    let requestId = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1;
+    return async function* () {
+      const chunkSize = 5;
+      const contentLength = MOCK_RESPONSE_MESSAGE_FOR_STREAMING.content.length;
+      const chunkCount = Math.ceil(contentLength / chunkSize);
+      for (let chunkId = 0; chunkId < chunkCount; chunkId += 1) {
+        const start = chunkId * chunkSize;
+        const end = Math.min((chunkId + 1) * chunkSize, contentLength);
+        const chunk = {
+          ...MOCK_RESPONSE_MESSAGE_FOR_STREAMING,
+          requestId,
+          content: MOCK_RESPONSE_MESSAGE_FOR_STREAMING.content.substring(start, end),
+          chunkId
+        };
+
+        // eslint-disable-next-line no-await-in-loop
+        await delayRandom();
+        yield chunk;
+      }
+      yield {
+        ...MOCK_RESPONSE_MESSAGE_FOR_STREAMING,
+        requestId,
+        content: MOCK_RESPONSE_MESSAGE_FOR_STREAMING.content,
+        chunkId: null
+      };
+    }();
+  } catch (e) {
+    return Promise.reject(e);
   }
-  return chunks;
-};
+}
 const MOCK_USER_PROMPT_MESSAGE = {
   id: '456',
   content: 'How to create a new template?',

package/dist/components/experimental/experiment_badge/constants.js

@@ -1,4 +1,4 @@
-const badgeTypes = ['experiment', 'beta'];
+const badgeTypes = ['experiment', 'beta', null];
 const badgeTypeValidator = value => badgeTypes.includes(value);
 
 export { badgeTypeValidator, badgeTypes };

package/dist/tokens/css/tokens.css

@@ -1,6 +1,6 @@
 /**
  * Do not edit directly
- * Generated on Tue, 05 Mar 2024 10:22:05 GMT
+ * Generated on Tue, 05 Mar 2024 16:29:47 GMT
  */
 
 :root {

package/dist/tokens/css/tokens.dark.css

@@ -1,6 +1,6 @@
 /**
  * Do not edit directly
- * Generated on Tue, 05 Mar 2024 10:22:05 GMT
+ * Generated on Tue, 05 Mar 2024 16:29:47 GMT
  */
 
 :root.gl-dark {

package/dist/tokens/js/tokens.dark.js

@@ -1,6 +1,6 @@
 /**
  * Do not edit directly
- * Generated on Tue, 05 Mar 2024 10:22:05 GMT
+ * Generated on Tue, 05 Mar 2024 16:29:47 GMT
  */
 
 export const DATA_VIZ_GREEN_50 = "#133a03";

package/dist/tokens/js/tokens.js

@@ -1,6 +1,6 @@
 /**
  * Do not edit directly
- * Generated on Tue, 05 Mar 2024 10:22:05 GMT
+ * Generated on Tue, 05 Mar 2024 16:29:47 GMT
  */
 
 export const DATA_VIZ_GREEN_50 = "#ddfab7";

package/dist/tokens/scss/_tokens.dark.scss

@@ -1,6 +1,6 @@
 
 // Do not edit directly
-// Generated on Tue, 05 Mar 2024 10:22:06 GMT
+// Generated on Tue, 05 Mar 2024 16:29:47 GMT
 
 $gl-text-tertiary: #737278 !default;
 $gl-text-secondary: #89888d !default;

package/dist/tokens/scss/_tokens.scss

@@ -1,6 +1,6 @@
 
 // Do not edit directly
-// Generated on Tue, 05 Mar 2024 10:22:05 GMT
+// Generated on Tue, 05 Mar 2024 16:29:47 GMT
 
 $gl-text-tertiary: #89888d !default;
 $gl-text-secondary: #737278 !default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "78.0.0",
+  "version": "78.1.1",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",

package/src/components/experimental/duo/chat/duo_chat.spec.js

@@ -8,6 +8,7 @@ import DuoChatLoader from './components/duo_chat_loader/duo_chat_loader.vue';
 import DuoChatPredefinedPrompts from './components/duo_chat_predefined_prompts/duo_chat_predefined_prompts.vue';
 import DuoChatConversation from './components/duo_chat_conversation/duo_chat_conversation.vue';
 import GlDuoChat from './duo_chat.vue';
+import { MOCK_RESPONSE_MESSAGE, MOCK_USER_PROMPT_MESSAGE } from './mock_data';
 
 import { MESSAGE_MODEL_ROLES, CHAT_RESET_MESSAGE } from './constants';
 
@@ -126,6 +127,15 @@ describe('GlDuoChat', () => {
       expect(component().exists()).toBe(shouldRender);
     });
 
+    it('does not render the experimental label if it is explicitely disabled', () => {
+      createComponent({
+        propsData: {
+          badgeType: null,
+        },
+      });
+      expect(findBadge().exists()).toBe(false);
+    });
+
     describe('when messages exist', () => {
       it('scrolls to the bottom on load', async () => {
         const scrollIntoViewMock = jest.fn();
@@ -330,11 +340,38 @@ describe('GlDuoChat', () => {
           data: { prompt: promptStr },
         });
         trigger();
-        if (expectEmitted) {
-          expect(wrapper.emitted('send-chat-prompt')).toEqual(expectEmitted);
-        } else {
-          expect(wrapper.emitted('send-chat-prompt')).toBe(undefined);
-        }
+        expect(wrapper.emitted('send-chat-prompt')).toEqual(expectEmitted);
+      });
+
+      it.each`
+        desc                                              | msgs
+        ${''}                                             | ${[]}
+        ${'with just a user message'}                     | ${[MOCK_USER_PROMPT_MESSAGE]}
+        ${'with a user message, and a complete response'} | ${[MOCK_USER_PROMPT_MESSAGE, MOCK_RESPONSE_MESSAGE]}
+      `('prevents submission when loading $desc', ({ msgs } = {}) => {
+        createComponent({
+          propsData: { isChatAvailable: true, isLoading: true, messages: msgs },
+          data: { prompt: promptStr },
+        });
+        clickSubmit();
+        expect(wrapper.emitted('send-chat-prompt')).toBe(undefined);
+      });
+
+      it.each([
+        [[{ ...MOCK_RESPONSE_MESSAGE, content: undefined, chunks: [''] }]],
+        [
+          [
+            MOCK_USER_PROMPT_MESSAGE,
+            { ...MOCK_RESPONSE_MESSAGE, content: undefined, chunks: [''] },
+          ],
+        ],
+      ])('prevents submission when streaming (messages = "%o")', (msgs = []) => {
+        createComponent({
+          propsData: { isChatAvailable: true, messages: msgs },
+          data: { prompt: promptStr },
+        });
+        clickSubmit();
+        expect(wrapper.emitted('send-chat-prompt')).toBe(undefined);
       });
     });
 
@@ -419,7 +456,7 @@ describe('GlDuoChat', () => {
       expect(findChatComponent().exists()).toBe(true);
     });
 
-    it('resets the prompt when new messages are added', async () => {
+    it('resets the prompt when a message is loaded', async () => {
       const prompt = 'foo';
       createComponent({ data: { prompt } });
       expect(findChatInput().props('value')).toBe(prompt);
@@ -427,7 +464,7 @@ describe('GlDuoChat', () => {
       // reactive behavior which consistutes an exception
       // See https://docs.gitlab.com/ee/development/fe_guide/style/vue.html#setting-component-state
       wrapper.setProps({
-        messages,
+        isLoading: true,
       });
       await nextTick();
       expect(findChatInput().props('value')).toBe('');

package/src/components/experimental/duo/chat/duo_chat.stories.js

@@ -1,6 +1,5 @@
 import GlButton from '../../../base/button/button.vue';
 import GlAlert from '../../../base/alert/alert.vue';
-import { setStoryTimeout } from '../../../../utils/test_utils';
 import { makeContainer } from '../../../../utils/story_decorators/container';
 import GlDuoChat from './duo_chat.vue';
 import readme from './duo_chat.md';
@@ -132,32 +131,52 @@ export const Interactive = (args, { argTypes }) => ({
       this.isHidden = false;
       this.loggerInfo += `Chat opened\n\n`;
     },
-    onResponseRequested() {
+    async onResponseRequested() {
       this.timeout = null;
-      this.chunks = generateMockResponseChunks(this.requestId);
-      this.mockResponseFromAi();
+      await this.mockResponseFromAi();
       this.requestId += 1;
     },
-    mockResponseFromAi() {
-      this.promptInFlight = false;
-      if (this.chunks.length) {
-        const newResponse = this.chunks.shift();
+    async mockResponseFromAi() {
+      const generator = generateMockResponseChunks(this.requestId);
+
+      for await (const result of generator) {
+        const { chunkId, content, ...messageAttributes } = result;
         const existingMessageIndex = this.msgs.findIndex(
-          (msg) => msg.requestId === newResponse.requestId && msg.role === newResponse.role
+          (msg) => msg.requestId === result.requestId && msg.role === result.role
         );
-        const existingMessage = this.msgs[existingMessageIndex];
-        if (existingMessage) {
-          this.msgs.splice(existingMessageIndex, 1, {
-            ...existingMessage,
-            content: existingMessage.content + newResponse.content,
-          });
+
+        if (existingMessageIndex === -1) {
+          this.addNewMessage(messageAttributes, content);
+        } else {
+          this.updateExistingMessage(existingMessageIndex, content, chunkId);
+        }
+      }
+    },
+    addNewMessage(messageAttributes, content) {
+      this.promptInFlight = false;
+      this.$set(this.msgs, this.msgs.length, {
+        ...messageAttributes,
+        chunks: [content],
+      });
+    },
+    updateExistingMessage(index, content, chunkId) {
+      const message = this.msgs[index];
+
+      if (chunkId != null) {
+        // Ensure the chunks array exists
+        if (!message.chunks) {
+          this.$set(message, 'chunks', []);
         } else {
-          this.msgs.push(newResponse);
+          this.$set(message.chunks, chunkId, content);
+        }
+      } else {
+        // Update for final message
+        this.$set(message, 'content', content);
+
+        // Remove chunks if they are not needed anymore
+        if (message.chunks) {
+          this.$delete(message, 'chunks');
         }
-        this.logerInfo += `New response: ${JSON.stringify(newResponse)}\n\n`;
-        this.timeout = setStoryTimeout(() => {
-          this.mockResponseFromAi();
-        }, Math.floor(Math.random() * 251) + 16);
       }
     },
   },

package/src/components/experimental/duo/chat/duo_chat.vue

@@ -127,7 +127,7 @@ export default {
      * The type of the badge. This is passed down to the `GlExperimentBadge` component. Refer that component for more information.
      */
     badgeType: {
-      type: String,
+      type: String || null,
       required: false,
       default: badgeTypes[0],
       validator: badgeTypeValidator,
@@ -212,13 +212,20 @@ export default {
         [[]]
       );
     },
+    lastMessage() {
+      return this.messages[this.messages.length - 1];
+    },
     resetDisabled() {
       if (this.isLoading || !this.hasMessages) {
         return true;
       }
-
-      const lastMessage = this.messages[this.messages.length - 1];
-      return lastMessage.content === CHAT_RESET_MESSAGE;
+      return this.lastMessage?.content === CHAT_RESET_MESSAGE;
+    },
+    submitDisabled() {
+      return this.isLoading || this.isStreaming;
+    },
+    isStreaming() {
+      return Boolean(this.lastMessage?.chunks?.length > 0 && !this.lastMessage?.content);
     },
     filteredSlashCommands() {
       const caseInsensitivePrompt = this.prompt.toLowerCase();
@@ -246,12 +253,13 @@ export default {
     },
   },
   watch: {
-    isLoading() {
+    isLoading(newVal) {
       this.isHidden = false;
       this.scrollToBottom();
-    },
-    messages() {
-      this.prompt = '';
+      if (newVal) {
+        // We reset the prompt when we start getting the response and focus in the prompt field
+        this.setPromptAndFocus();
+      }
     },
   },
   created() {
@@ -269,6 +277,9 @@ export default {
       this.$emit('chat-hidden');
     },
     sendChatPrompt() {
+      if (this.submitDisabled) {
+        return;
+      }
       if (this.prompt) {
         if (this.prompt === CHAT_RESET_MESSAGE && this.resetDisabled) {
           return;
@@ -336,14 +347,18 @@ export default {
         this.activeCommandIndex = 0;
       }
     },
+    async setPromptAndFocus(prompt = '') {
+      this.prompt = prompt;
+      await this.$nextTick();
+      this.$refs.prompt.$el.focus();
+    },
     selectSlashCommand(index) {
       const command = this.filteredSlashCommands[index];
       if (command.shouldSubmit) {
         this.prompt = command.name;
         this.sendChatPrompt();
       } else {
-        this.prompt = `${command.name} `;
-        this.$refs.prompt.$el.focus();
+        this.setPromptAndFocus(`${command.name} `);
       }
     },
   },
@@ -369,6 +384,7 @@ export default {
       >
         <h3 class="gl-my-0 gl-font-size-h2">{{ title }}</h3>
         <gl-experiment-badge
+          v-if="badgeType"
           :help-page-url="badgeHelpPageUrl"
           :type="badgeType"
           container-id="chat-component"
@@ -493,7 +509,6 @@ export default {
               class="gl-absolute gl-h-full! gl-py-4! gl-bg-transparent! gl-rounded-top-right-none gl-rounded-bottom-right-none gl-shadow-none!"
               :class="{ 'gl-text-truncate': !prompt }"
               :placeholder="inputPlaceholder"
-              :disabled="isLoading"
               autofocus
               @keydown.enter.exact.native.prevent
               @keyup.native="onInputKeyup"
@@ -506,8 +521,9 @@ export default {
               variant="confirm"
               class="!gl-absolute gl-bottom-2 gl-right-2 gl-rounded-base!"
               type="submit"
+              data-testid="chat-prompt-submit-button"
               :aria-label="$options.i18n.CHAT_SUBMIT_LABEL"
-              :disabled="isLoading"
+              :disabled="submitDisabled"
             />
           </template>
         </gl-form-input-group>

package/src/components/experimental/duo/chat/mock_data.js

@@ -1,3 +1,4 @@
+import { setStoryTimeout } from '../../../../utils/test_utils';
 import { DOCUMENTATION_SOURCE_TYPES, MESSAGE_MODEL_ROLES } from './constants';
 
 const MOCK_SOURCES = [
@@ -66,24 +67,39 @@ export const MOCK_RESPONSE_MESSAGE_FOR_STREAMING = {
   timestamp: '2021-04-21T12:00:00.000Z',
 };
 
-export const generateMockResponseChunks = (requestId) => {
-  const chunks = [];
+// Utility function for delay
+async function delayRandom(min = 16, max = 267) {
+  const delay = Math.floor(Math.random() * (max - min + 1)) + min;
+  // eslint-disable-next-line no-promise-executor-return
+  return new Promise((resolve) => setStoryTimeout(resolve, delay));
+}
+
+export async function* generateMockResponseChunks(requestId = 1) {
   const chunkSize = 5;
-  const chunkCount = Math.ceil(MOCK_RESPONSE_MESSAGE_FOR_STREAMING.content.length / chunkSize);
-  for (let i = 0; i < chunkCount; i += 1) {
+  const contentLength = MOCK_RESPONSE_MESSAGE_FOR_STREAMING.content.length;
+  const chunkCount = Math.ceil(contentLength / chunkSize);
+
+  for (let chunkId = 0; chunkId < chunkCount; chunkId += 1) {
+    const start = chunkId * chunkSize;
+    const end = Math.min((chunkId + 1) * chunkSize, contentLength);
     const chunk = {
       ...MOCK_RESPONSE_MESSAGE_FOR_STREAMING,
       requestId,
-      content: MOCK_RESPONSE_MESSAGE_FOR_STREAMING.content.substring(
-        i * chunkSize,
-        (i + 1) * chunkSize
-      ),
-      chunkId: i,
+      content: MOCK_RESPONSE_MESSAGE_FOR_STREAMING.content.substring(start, end),
+      chunkId,
     };
-    chunks.push(chunk);
+
+    // eslint-disable-next-line no-await-in-loop
+    await delayRandom();
+    yield chunk;
   }
-  return chunks;
-};
+  yield {
+    ...MOCK_RESPONSE_MESSAGE_FOR_STREAMING,
+    requestId,
+    content: MOCK_RESPONSE_MESSAGE_FOR_STREAMING.content,
+    chunkId: null,
+  };
+}
 
 export const MOCK_USER_PROMPT_MESSAGE = {
   id: '456',

package/src/components/experimental/experiment_badge/constants.js

@@ -1,2 +1,2 @@
-export const badgeTypes = ['experiment', 'beta'];
+export const badgeTypes = ['experiment', 'beta', null];
 export const badgeTypeValidator = (value) => badgeTypes.includes(value);