feat: POST /conversations to companion backend by chriskari · Pull Request #3691 · kyma-project/busola

chriskari · 2025-02-12T09:33:14Z

Description

Changes proposed in this pull request:

track currently opened resource through columnLayoutState (added startColumn)
adjusted format of API request
API request is proxied through our backend
TokenManager (refetching etc.) added to backend
suggestions will refresh when changing resource
use correct Authorization headers (token vs. client-certificate and client-key)

Related issue(s)
#3602

Definition of done

The PR's title starts with one of the following prefixes:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- refactor: A code change that neither fixes a bug nor adds a feature
- test: Adding tests
- revert: Revert commit
- chore: Maintainance changes to the build process or auxiliary tools, libraries, workflows, etc.
Related issues are linked. To link internal trackers, use the issue IDs like backlog#4567
Explain clearly why you created the PR and what changes it introduces
All necessary steps are delivered, for example, tests, documentation, merging

…st-conversations

dbadura · 2025-02-21T14:53:44Z

I started it, use local k3d and got errors when opening the companion chat.

[backend]   const clusterToken = req.headers['x-k8s-authorization'].replace(/^Bearer\s+/i, '');
[backend]                                                           ^
[backend] 
[backend] TypeError: Cannot read properties of undefined (reading 'replace')
[backend]     at handleAIChatRequest (/home/damian/Workspace/kyma/busola/backend/companion/companionRouter.js:15:59)

Probably, the backend couldn't use credentials to backend, but it shouldn't break like that.

Small update:
After opening the chat, the whole communication with backend is broken:

dbadura · 2025-02-21T14:57:04Z

backend/companion/TokenManager.js

+    try {
+      // Split the token and get the payload
+      const payload = JSON.parse(
+        Buffer.from(token.split('.')[1], 'base64').toString(),


Use const like PAYLOAD_INDEX instead of magic number?

dbadura · 2025-02-21T15:01:57Z

backend/companion/companionRouter.js

+    req.body.toString(),
+  );
+  const clusterUrl = req.headers['x-cluster-url'];
+  const clusterToken = req.headers['x-k8s-authorization'].replace(


Is regex required to use?

yes this is the cleanest approach

src/sidebar/SidebarNavigation.tsx

chriskari · 2025-02-23T23:56:44Z

Hey Damian, thanks for the review.
The reason why your API requests to the companion backend are failing is that when connecting to your local k3d cluster, you are authenticating using x-client-key-data instead of a x-k8s-authorization token. Currently the companion backend however expects us to send a token to authenticate to the Kubernetes cluster. They do not handle the case where users authenticate without an authentication token but with key-data. Because of that I have not yet implemented this either.
Apart from that fact, because your cluster is hosted locally, the companion backend can not access any cluster information as the x-cluster-url points to localhost.

mrCherry97

It will be nice to have some Loader/Spinner when Busola is loading suggestions, because I was confused in first couple seconds that it's not working.

is it intended, that if I go on PersistentVolumes -> Open AI -> I have suggestions for PV -> Go to StorageClasses or somewhere else -> suggestions are not refreshed, shouldn't suggestions get refreshed on the screen change?

mrCherry97

Could you also change js files to ts? like TokenManager, router and gettoken?

akucharska

Suggestions are only refreshed when you close and open joule again. It should refresh if you go to different page. If it is not possible to start/change resource then maybe close joule?
It would be good to have some indicator if suggestions are loading, and some message if there is no suggestions to show (on modules).
On the button opening Joule we popup saying what this button is about. It would be good to have the same on buttons in Joule window

dbadura · 2025-02-27T14:21:26Z

Hey Damian, thanks for the review. The reason why your API requests to the companion backend are failing is that when connecting to your local k3d cluster, you are authenticating using x-client-key-data instead of a x-k8s-authorization token. Currently the companion backend however expects us to send a token to authenticate to the Kubernetes cluster. They do not handle the case where users authenticate without an authentication token but with key-data. Because of that I have not yet implemented this either. Apart from that fact, because your cluster is hosted locally, the companion backend can not access any cluster information as the x-cluster-url points to localhost.

I understand that the companion can't access the local cluster, but the request from the bottom of the screenshot to normal backend fails after opening a chat.

…st-conversations

…esource

…st-conversations

Requested changes are adjusted.

feat: track currently opened resource in ResourceDetails

73f8fe0

chriskari requested review from OliwiaGowor, akucharska, dbadura and mrCherry97 as code owners February 12, 2025 09:33

kyma-bot added the cla: yes Indicates the PR's author has signed the CLA. label Feb 12, 2025

chriskari linked an issue Feb 12, 2025 that may be closed by this pull request

Integrate and adjust POST /conversations endpoint #3602

Closed

6 tasks

kyma-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 12, 2025

feat: use columnLayoutState to track currentResource

332059b

kyma-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 13, 2025

chriskari added 8 commits February 13, 2025 14:14

Merge branch 'main' of https://github.com/kyma-project/busola into po…

f0392fb

…st-conversations

feat: update structure of api call

9c803ac

Merge branch 'main' of https://github.com/kyma-project/busola into po…

fb6c722

…st-conversations

feat: proxy API request through our backend

d5193c0

Merge branch 'main' of https://github.com/kyma-project/busola into po…

74fa194

…st-conversations

Merge branch 'main' of https://github.com/kyma-project/busola into po…

701547f

…st-conversations

feat: automate token fetching in the backend

47fc2e4

feat: enhance columnLayouState to also track the start column resource

4a614e8

kyma-bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 19, 2025

chriskari added 4 commits February 19, 2025 12:49

feat: adjust resourcetype of cluster overview

fb7da47

Merge branch 'main' of https://github.com/kyma-project/busola into po…

6edb6f0

…st-conversations

feat: improve initial layout

4716f7a

feat: adjust column state for cluster overview

102719b

mrCherry97 assigned dbadura, mrCherry97 and akucharska Feb 21, 2025

dbadura reviewed Feb 21, 2025

View reviewed changes

src/sidebar/SidebarNavigation.tsx Show resolved Hide resolved

mrCherry97 requested changes Feb 25, 2025

View reviewed changes

mrCherry97 assigned KonradPietocha Feb 25, 2025

mrCherry97 requested changes Feb 25, 2025

View reviewed changes

akucharska previously requested changes Feb 26, 2025

View reviewed changes

chriskari added 8 commits February 27, 2025 23:50

Merge branch 'main' of https://github.com/kyma-project/busola into po…

55fd928

…st-conversations

feat: add loading indicator, and refresh when navigate to different r…

6bff107

…esource

feat: handle different auth method and fix errors regarding this

0d1f772

feat: skip request if conversation has started

c98b2b8

feat: add properly cased resourceType to navigation nodes

837f50b

feat: adjustments regarding previous commit

d7bdadc

Merge branch 'main' of https://github.com/kyma-project/busola into po…

0441366

…st-conversations

feat: adjust introductory message based on existence of suggestions

4c56eb6

chriskari requested a review from a team as a code owner March 3, 2025 14:54

Merge branch 'main' of https://github.com/kyma-project/busola into po…

e0cd17b

…st-conversations

mrCherry97 approved these changes Mar 4, 2025

View reviewed changes

kyma-bot added the lgtm Looks good to me! label Mar 4, 2025

mrCherry97 enabled auto-merge (squash) March 4, 2025 10:28

grego952 approved these changes Mar 4, 2025

View reviewed changes

kyma-bot assigned grego952 Mar 4, 2025

mrCherry97 merged commit 7733af6 into kyma-project:main Mar 4, 2025
36 checks passed

chriskari mentioned this pull request Mar 4, 2025

fix: Column layout bug when create is opened #3745

Merged

4 tasks

chriskari deleted the post-conversations branch March 10, 2025 14:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: POST /conversations to companion backend#3691

feat: POST /conversations to companion backend#3691
mrCherry97 merged 23 commits intokyma-project:mainfrom
chriskari:post-conversations

chriskari commented Feb 12, 2025 •

edited

Loading

Uh oh!

dbadura commented Feb 21, 2025 •

edited

Loading

Uh oh!

dbadura Feb 21, 2025

Uh oh!

chriskari Feb 28, 2025

Uh oh!

dbadura Feb 21, 2025

Uh oh!

chriskari Feb 28, 2025 •

edited

Loading

Uh oh!

Uh oh!

chriskari commented Feb 23, 2025 •

edited

Loading

Uh oh!

mrCherry97 left a comment

Uh oh!

mrCherry97 left a comment

Uh oh!

akucharska left a comment •

edited

Loading

Uh oh!

dbadura commented Feb 27, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Conversation

chriskari commented Feb 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dbadura commented Feb 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dbadura Feb 21, 2025

Choose a reason for hiding this comment

Uh oh!

chriskari Feb 28, 2025

Choose a reason for hiding this comment

Uh oh!

dbadura Feb 21, 2025

Choose a reason for hiding this comment

Uh oh!

chriskari Feb 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

chriskari commented Feb 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mrCherry97 left a comment

Choose a reason for hiding this comment

Uh oh!

mrCherry97 left a comment

Choose a reason for hiding this comment

Uh oh!

akucharska left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dbadura commented Feb 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

chriskari commented Feb 12, 2025 •

edited

Loading

dbadura commented Feb 21, 2025 •

edited

Loading

chriskari Feb 28, 2025 •

edited

Loading

chriskari commented Feb 23, 2025 •

edited

Loading

akucharska left a comment •

edited

Loading

dbadura commented Feb 27, 2025 •

edited

Loading