feat: add form experiment badge

.github/workflows/backport.yml

@@ -0,0 +1,43 @@
+name: Backport
+on:
+  pull_request_target:
+    types:
+      - closed
+      - labeled
+
+jobs:
+  backport:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    name: Backport
+    # Only react to merged PRs for security reasons.
+    # See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target.
+    if: >
+      github.event.pull_request.merged
+      && (
+        github.event.action == 'closed'
+        || (
+          github.event.action == 'labeled'
+          && contains(github.event.label.name, 'backport')
+        )
+      )
+    steps:
+      - name: GitHub App token
+        id: github_app_token
+        uses: tibdex/[email protected]
+        with:
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.APP_PRIVATE_KEY }}
+          # opensearch-trigger-bot installation ID
+          installation_id: 22958780
+
+      - name: Backport
+        uses: VachaShah/[email protected]
+        with:
+          github_token: ${{ steps.github_app_token.outputs.token }}
+          head_template: backport/backport-<%= number %>-to-<%= base %>
+          files_to_skip: "CHANGELOG.md"
+          labels_template: "<%= JSON.stringify([...labels, 'autocut']) %>"
+          failure_labels: "failed backport"

.github/workflows/changelog_verifier.yml

@@ -0,0 +1,19 @@
+name: "Changelog Verifier"
+on:
+  pull_request:
+    branches: [ '**' ]
+    types: [opened, edited, review_requested, synchronize, reopened, ready_for_review, labeled, unlabeled]
+
+jobs:
+  # Enforces the update of a changelog file on every pull request
+  verify-changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - uses: dangoslen/changelog-enforcer@v3
+        with:
+          skipLabels: "autocut, Skip-Changelog"

.github/workflows/links_checker.yml

@@ -0,0 +1,37 @@
+# Copyright OpenSearch Contributors
+# SPDX-License-Identifier: Apache-2.0
+
+name: Link Checker
+
+on:
+  push:
+    branches: [ "**" ]
+  pull_request:
+    branches: [ "**" ]
+
+jobs:
+  linkchecker:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Checkout OpenSearch-Dashboards
+      uses: actions/checkout@v2
+      with:
+        repository: opensearch-project/OpenSearch-Dashboards
+        ref: main
+        path: OpenSearch-Dashboards
+    - name: Load Excludes
+      run: |
+        LYCHEE_EXCLUDE=$(sed -e :a  -e 'N;s/\n/ --exclude /;ta' OpenSearch-Dashboards/.lycheeexclude)
+        echo "LYCHEE_EXCLUDE=$LYCHEE_EXCLUDE" >> $GITHUB_ENV
+    - name: Lychee Link Checker
+      id: lychee
+      uses: lycheeverse/[email protected]
+      with:
+        args: --accept=200,403,429 --exclude ${{ env.LYCHEE_EXCLUDE }} --exclude-mail "**/*.html" "**/*.md" "**/*.txt" "**/*.json" "**/*.js" "**/*.ts" "**/*.tsx"
+      env:
+        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+    - name: Fail if there were link errors
+      run: exit ${{ steps.lychee.outputs.exit_code }}

.github/workflows/unit_test_workflow.yml

@@ -0,0 +1,98 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Build and test
+
+# trigger on every commit push and PR for all branches except pushes for backport branches
+on:
+  pull_request:
+    branches: ["**"]
+  push:
+    branches: ["**"]
+env:
+  OPENSEARCH_DASHBOARDS_VERSION: '2.x'
+  NODE_OPTIONS: "--max-old-space-size=6144 --dns-result-order=ipv4first"
+
+jobs:
+  Get-CI-Image-Tag:
+    uses: opensearch-project/opensearch-build/.github/workflows/get-ci-image-tag.yml@main
+    with:
+      product: opensearch-dashboards
+
+  tests-linux:
+    needs: Get-CI-Image-Tag
+    name: Run unit tests
+    runs-on: ubuntu-latest
+    container:
+      # using the same image which is used by opensearch-build team to build the OpenSearch Distribution
+      # this image tag is subject to change as more dependencies and updates will arrive over time
+      image: ${{ needs.Get-CI-Image-Tag.outputs.ci-image-version-linux }}
+      # need to switch to root so that github actions can install runner binary on container without permission issues.
+      options: --user root
+
+    steps:
+      # Enable longer filenames for windows
+      - name: Checkout OpenSearch-Dashboards
+        uses: actions/checkout@v2
+        with:
+          repository: opensearch-project/OpenSearch-Dashboards
+          ref: ${{ env.OPENSEARCH_DASHBOARDS_VERSION }}
+          path: OpenSearch-Dashboards
+      - name: Checkout dashboards-assistant plugin
+        uses: actions/checkout@v2
+        with:
+          path: OpenSearch-Dashboards/plugins/dashboards-assistant
+      - name: Bootstrap / Run tests
+        run: |
+          chown -R 1000:1000 `pwd`
+          cd ./OpenSearch-Dashboards/
+          su `id -un 1000` -c "source $NVM_DIR/nvm.sh && nvm use && node -v && yarn -v &&
+                               cd ./plugins/dashboards-assistant &&
+                               whoami && yarn osd bootstrap && yarn run test:jest --coverage"
+
+      - name: Uploads coverage
+        uses: codecov/codecov-action@v1
+
+  tests-windows-macos:
+    name: Run unit tests
+    strategy:
+      matrix:
+        os: [macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      # Enable longer filenames for windows
+      - name: Enable longer filenames
+        if: ${{ matrix.os == 'windows-latest' }}
+        run: git config --system core.longpaths true
+      - name: Checkout OpenSearch-Dashboards
+        uses: actions/checkout@v2
+        with:
+          repository: opensearch-project/OpenSearch-Dashboards
+          ref: ${{ env.OPENSEARCH_DASHBOARDS_VERSION }}
+          path: OpenSearch-Dashboards
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: './OpenSearch-Dashboards/.nvmrc'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install Yarn
+        # Need to use bash to avoid having a windows/linux specific step
+        shell: bash
+        run: |
+          YARN_VERSION=$(node -p "require('./OpenSearch-Dashboards/package.json').engines.yarn")
+          echo "Installing yarn@$YARN_VERSION"
+          npm i -g yarn@$YARN_VERSION
+      - run: node -v
+      - run: yarn -v
+      - name: Checkout dashboards-assistant plugin
+        uses: actions/checkout@v2
+        with:
+          path: OpenSearch-Dashboards/plugins/dashboards-assistant
+      - name: Bootstrap plugin/dashboards-assistant
+        run: |
+          cd OpenSearch-Dashboards/plugins/dashboards-assistant
+          yarn osd bootstrap
+      - name: Run tests
+        run: |
+          cd OpenSearch-Dashboards/plugins/dashboards-assistant
+          yarn run test:jest --coverage

CHANGELOG.md

@@ -0,0 +1,10 @@
+# CHANGELOG
+
+Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+
+### 📈 Features/Enhancements
+
+- Add support for registerMessageParser ([#5](https://github.com/opensearch-project/dashboards-assistant/pull/5))
+- Change implementation of basic_input_output to built-in parser ([#10](https://github.com/opensearch-project/dashboards-assistant/pull/10))
+- Add interactions into ChatState and pass specific interaction into message_bubble ([#12](https://github.com/opensearch-project/dashboards-assistant/pull/12))
+- Add experimental badge to chat window header ([#13](https://github.com/opensearch-project/dashboards-assistant/pull/13))

babel.config.js

@@ -0,0 +1,26 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+// babelrc doesn't respect NODE_PATH anymore but using require does.
+// Alternative to install them locally in node_modules
+module.exports = function (api) {
+  // ensure env is test so that this config won't impact build or dev server
+  if (api.env('test')) {
+    return {
+      presets: [
+        require('@babel/preset-env'),
+        require('@babel/preset-react'),
+        require('@babel/preset-typescript'),
+      ],
+      plugins: [
+        [require('@babel/plugin-transform-runtime'), { regenerator: true }],
+        require('@babel/plugin-transform-class-properties'),
+        require('@babel/plugin-transform-object-rest-spread'),
+        [require('@babel/plugin-transform-modules-commonjs'), { allowTopLevelThis: true }],
+      ],
+    };
+  }
+  return {};
+};

common/types/chat_saved_object_attributes.ts

@@ -6,12 +6,23 @@
 export const CHAT_SAVED_OBJECT = 'assistant-chat';
 export const SAVED_OBJECT_VERSION = 1;
 
+export interface Interaction {
+  input: string;
+  response: string;
+  conversation_id: string;
+  interaction_id: string;
+  create_time: string;
+  additional_info?: Record<string, unknown>;
+  parent_interaction_id?: string;
+}
+
 export interface ISession {
   title: string;
   version: number;
   createdTimeMs: number;
   updatedTimeMs: number;
   messages: IMessage[];
+  interactions: Interaction[];
 }
 
 export interface ISessionFindResponse {

package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "osd": "node ../../scripts/osd",
     "build": "yarn plugin-helpers build",
-    "test": "../../node_modules/.bin/jest --config ./test/jest.config.js",
+    "test:jest": "../../node_modules/.bin/jest --config ./test/jest.config.js",
     "plugin-helpers": "node ../../scripts/plugin_helpers",
     "prepare": "husky install",
     "lint:es": "node ../../scripts/eslint",
@@ -19,6 +19,7 @@
   },
   "dependencies": {
     "autosize": "^6.0.1",
+    "csv-parser": "^3.0.0",
     "dompurify": "^2.4.1",
     "jsdom": "^22.1.0",
     "langchain": "^0.0.164",

public/chat_header_button.tsx

@@ -41,6 +41,9 @@ export const HeaderChatButton: React.FC<HeaderChatButtonProps> = (props) => {
   const [inputFocus, setInputFocus] = useState(false);
   const flyoutFullScreen = chatSize === 'fullscreen';
   const inputRef = useRef<HTMLInputElement>(null);
+  const [rootAgentId, setRootAgentId] = useState<string>(
+    new URL(window.location.href).searchParams.get('agent_id') || ''
+  );
 
   if (!flyoutLoaded && flyoutVisible) flyoutLoaded = true;
 
@@ -76,6 +79,7 @@ export const HeaderChatButton: React.FC<HeaderChatButtonProps> = (props) => {
       setTitle,
       traceId,
       setTraceId,
+      rootAgentId,
     }),
     [
       appId,

public/components/chat_experimental_badge.tsx

@@ -0,0 +1,53 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import React, { useState } from 'react';
+import {
+  EuiPopover,
+  EuiButtonIcon,
+  EuiTitle,
+  EuiHorizontalRule,
+  EuiText,
+  EuiLink,
+} from '@elastic/eui';
+
+interface ChatExperimentalBadgeProps {
+  onClick?: React.MouseEventHandler<HTMLDivElement>;
+}
+
+export const ChatExperimentalBadge = ({ onClick }: ChatExperimentalBadgeProps) => {
+  const [visible, setVisible] = useState(false);
+
+  const closePopover = () => {
+    setVisible(false);
+  };
+
+  const handleIconClick = () => {
+    setVisible((flag) => !flag);
+  };
+
+  return (
+    <EuiPopover
+      isOpen={visible}
+      button={<EuiButtonIcon color="text" iconType="beaker" onClick={handleIconClick} />}
+      closePopover={closePopover}
+      onClick={onClick}
+    >
+      <EuiTitle size="xs">
+        <h4>Experimental</h4>
+      </EuiTitle>
+      <EuiHorizontalRule margin="s" />
+      <EuiText>
+        This is an experimental feature.
+        <br />
+        Send feedback via{' '}
+        <EuiLink href="https://forum.opensearch.org/t/feedback-opensearch-assistant/16741">
+          Forum
+        </EuiLink>{' '}
+        or <EuiLink href="https://opensearch.slack.com/channels/assistant-feedback">Slack</EuiLink>.
+      </EuiText>
+    </EuiPopover>
+  );
+};