feat(machine-id): Add bot instance details page (web) by nicholasmarais1158 · Pull Request #55055 · gravitational/teleport

nicholasmarais1158 · 2025-05-22T15:36:27Z

Description

The change adds a details page for bot instances. Clicking a row on the bot instance list opens the details page. This page can be deep linked from other parts of the app (if necessary) with a bot name and instance id.

Updates #53584

Changelog: View details for a bot instance

Changes

Add non-navigation route for new page
New webapi endpoint at GET /webapi/sites/:site/machine-id/bot/:name/bot-instance/:id - also returns the yaml representation
Link from Instances List on row click
Add "copy" Aria label to shared CopyButton component

Demo (network throttled)

Screen.Recording.2025-05-22.at.16.41.37.mov

zmb3 · 2025-05-23T19:39:28Z

 	"strconv"
 	"time"

+	yaml "github.com/ghodss/yaml"


I can't keep track of which YAML package to use anymore, and I see this package is already a dependency of lib/web so I think you got it right. Worth noting that ghodss/yaml seems less common in our codebase though.

teleport on master [$!] ➜ ag --go -Q --count 'gopkg.in/yaml' | wc -l 58 teleport on master [$!] ➜ ag --go -Q --count 'ghodss/yaml' | wc -l 21

zmb3 · 2025-05-23T19:40:21Z

+	clusterName := env.server.ClusterName()
+
+	botName := "test-bot"
+	instanceId := uuid.New().String()


Suggested change

instanceId := uuid.New().String()

instanceID := uuid.New().String()

Renamed in b732185.

zmb3 · 2025-05-23T19:41:04Z

+		},
+		Status: &machineidv1.BotInstanceStatus{},
+	}, protocmp.Transform(), protocmp.IgnoreFields(&machineidv1.BotInstance{}, "metadata")))
+	assert.Equal(t, resp.Yaml, fmt.Sprintf("kind: bot_instance\nmetadata:\n  name: %[1]s\n  revision: %[2]s\nspec:\n  bot_name: test-bot\n  instance_id: %[1]s\nstatus: {}\nversion: v1\n", instanceId, resp.BotInstance.Metadata.Revision))


Suggested change

assert.Equal(t, resp.Yaml, fmt.Sprintf("kind: bot_instance\nmetadata:\n name: %[1]s\n revision: %[2]s\nspec:\n bot_name: test-bot\n instance_id: %[1]s\nstatus: {}\nversion: v1\n", instanceId, resp.BotInstance.Metadata.Revision))

assert.YAMLEq(t, resp.Yaml, fmt.Sprintf("kind: bot_instance\nmetadata:\n name: %[1]s\n revision: %[2]s\nspec:\n bot_name: test-bot\n instance_id: %[1]s\nstatus: {}\nversion: v1\n", instanceId, resp.BotInstance.Metadata.Revision))

This will be slightly more robust.

Thanks. Done in b7ef4a9.

zmb3 · 2025-05-23T19:42:25Z

+
+import { useGetBotInstance } from '../hooks';
+
+const docsURL =


Suggested change

const docsURL =

const docsUrl =

I know it's confusing, but our convention is for acronyms to be all caps in Go, and first-letter caps in Typescript.

Renamed in b732185.

…-details # Conflicts: # lib/web/apiserver.go # lib/web/machineid.go # lib/web/machineid_test.go # web/packages/teleport/src/BotInstances/BotInstances.tsx # web/packages/teleport/src/BotInstances/List/BotInstancesList.tsx # web/packages/teleport/src/config.ts # web/packages/teleport/src/features.tsx # web/packages/teleport/src/services/bot/bot.ts # web/packages/teleport/src/services/bot/consts.ts # web/packages/teleport/src/services/bot/types.ts # web/packages/teleport/src/test/helpers/botInstances.ts

…-details

backport-bot-workflows · 2025-05-27T14:42:58Z

@nicholasmarais1158 See the table below for backport results.

Branch	Result
branch/v17	Failed

* Add navigation item * Add bot instances page * Populate page info * Add missing license header * Update bot instance nav icon * Reword hint text * Add active at timestamp tooltip * Rename active at header * Remove copy and sort * Lint and test fixes * Support backend search term filtering * Simplify code * Add search term filter auth tests * Allow disabling `<Table />` loading indicator * Rework frontend to use backend paging and filter (remove sort) * Fix lint (ts) * Remove unused BotInstances icon * Add URL state (page and search) * Use nil-safe getters on protos * Fix crash on items w/o heartbeat data * Add bot instance details page * Fix lint (ts) * Fix formatting (prettier) * Fix yaml time serialisation * Rename ButtonIcon from jsx to tsx * Convert ButtonIcon to tsx * Fix copy button on row * Correct casing * Use `assert.YAMLEq` * Revert changes to ButtonIcon - too big for this PR

* feat(machine-id): Bot instances list (web) (#54925) * Add navigation item * Add bot instances page * Populate page info * Add missing license header * Update bot instance nav icon * Reword hint text * Add active at timestamp tooltip * Rename active at header * Remove copy and sort * Lint and test fixes * Support backend search term filtering * Simplify code * Add search term filter auth tests * Allow disabling `<Table />` loading indicator * Rework frontend to use backend paging and filter (remove sort) * Fix lint (ts) * Remove unused BotInstances icon * Add URL state (page and search) * Use nil-safe getters on protos * Fix crash on items w/o heartbeat data # Conflicts: # api/gen/proto/go/teleport/machineid/v1/bot_instance_service.pb.go * Update protos grpc * feat(machine-id): Add bot instance details page (web) (#55055) * Add navigation item * Add bot instances page * Populate page info * Add missing license header * Update bot instance nav icon * Reword hint text * Add active at timestamp tooltip * Rename active at header * Remove copy and sort * Lint and test fixes * Support backend search term filtering * Simplify code * Add search term filter auth tests * Allow disabling `<Table />` loading indicator * Rework frontend to use backend paging and filter (remove sort) * Fix lint (ts) * Remove unused BotInstances icon * Add URL state (page and search) * Use nil-safe getters on protos * Fix crash on items w/o heartbeat data * Add bot instance details page * Fix lint (ts) * Fix formatting (prettier) * Fix yaml time serialisation * Rename ButtonIcon from jsx to tsx * Convert ButtonIcon to tsx * Fix copy button on row * Correct casing * Use `assert.YAMLEq` * Revert changes to ButtonIcon - too big for this PR * chore: Export feature for enterprise (bot instance details) (#55177)

nicholasmarais1158 added 27 commits May 19, 2025 13:54

Add navigation item

67b01af

Add bot instances page

95a3582

Populate page info

83fc0e1

Add missing license header

e638e5f

Update bot instance nav icon

43dc733

Reword hint text

e6eaa19

Add active at timestamp tooltip

335b6ab

Rename active at header

1066813

Remove copy and sort

7c4123e

Merge branch 'master' into nickmarais/feat/53584-bot-instances-list

dc08014

Lint and test fixes

153fa1a

Merge branch 'master' into nickmarais/feat/53584-bot-instances-list

d7099f3

Merge branch 'master' into nickmarais/feat/53584-bot-instances-list

271078c

Support backend search term filtering

8bad36a

Simplify code

a34457c

Add search term filter auth tests

b0a0943

Merge branch 'master' into nickmarais/feat/53584-bot-instances-list

f546d13

Allow disabling <Table /> loading indicator

fa97b72

Rework frontend to use backend paging and filter (remove sort)

2b1a95d

Merge branch 'master' into nickmarais/feat/53584-bot-instances-list

b057e28

Fix lint (ts)

dbdc06a

Remove unused BotInstances icon

423f2f8

Add URL state (page and search)

07d219e

Use nil-safe getters on protos

9b4f244

Fix crash on items w/o heartbeat data

320e80e

Merge branch 'master' into nickmarais/feat/53584-bot-instances-list

9d410f6

Add bot instance details page

e9de9cf

nicholasmarais1158 self-assigned this May 22, 2025

nicholasmarais1158 added machine-id backport/branch/v17 labels May 22, 2025

Fix formatting (prettier)

6746534

nicholasmarais1158 marked this pull request as ready for review May 22, 2025 16:27

github-actions Bot added size/md ui labels May 22, 2025

github-actions Bot requested review from kiosion and ravicious May 22, 2025 16:28

strideynet reviewed May 23, 2025

View reviewed changes

Comment thread lib/web/machineid.go Outdated

strideynet reviewed May 23, 2025

View reviewed changes

Comment thread lib/web/machineid.go Outdated

Fix yaml time serialisation

be6c3d4

zmb3 approved these changes May 23, 2025

View reviewed changes

Base automatically changed from nickmarais/feat/53584-bot-instances-list to master May 27, 2025 08:22

nicholasmarais1158 added 8 commits May 27, 2025 09:36

Rename ButtonIcon from jsx to tsx

ad997fc

Convert ButtonIcon to tsx

396f262

Fix copy button on row

ad411fd

Correct casing

b732185

Use assert.YAMLEq

b7ef4a9

Revert changes to ButtonIcon - too big for this PR

af34a84

Merge branch 'master' into nicholasmarais1158/feat/53584-bot-instance…

d718080

…-details

strideynet approved these changes May 27, 2025

View reviewed changes

public-teleport-github-review-bot Bot removed request for kiosion and ravicious May 27, 2025 12:37

nicholasmarais1158 added this pull request to the merge queue May 27, 2025

Merged via the queue into master with commit e271f9b May 27, 2025
44 checks passed

nicholasmarais1158 deleted the nicholasmarais1158/feat/53584-bot-instance-details branch May 27, 2025 14:41

nicholasmarais1158 mentioned this pull request Jun 2, 2025

[v17] feat(machine-id): Add bot instance details page (web) #55347

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(machine-id): Add bot instance details page (web)#55055

feat(machine-id): Add bot instance details page (web)#55055
nicholasmarais1158 merged 38 commits intomasterfrom
nicholasmarais1158/feat/53584-bot-instance-details

nicholasmarais1158 commented May 22, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

zmb3 May 23, 2025

Uh oh!

zmb3 May 23, 2025

Uh oh!

nicholasmarais1158 May 27, 2025

Uh oh!

zmb3 May 23, 2025

Uh oh!

nicholasmarais1158 May 27, 2025

Uh oh!

zmb3 May 23, 2025

Uh oh!

nicholasmarais1158 May 27, 2025

Uh oh!

Uh oh!

backport-bot-workflows Bot commented May 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	instanceId := uuid.New().String()
	instanceID := uuid.New().String()

	assert.Equal(t, resp.Yaml, fmt.Sprintf("kind: bot_instance\nmetadata:\n name: %[1]s\n revision: %[2]s\nspec:\n bot_name: test-bot\n instance_id: %[1]s\nstatus: {}\nversion: v1\n", instanceId, resp.BotInstance.Metadata.Revision))
	assert.YAMLEq(t, resp.Yaml, fmt.Sprintf("kind: bot_instance\nmetadata:\n name: %[1]s\n revision: %[2]s\nspec:\n bot_name: test-bot\n instance_id: %[1]s\nstatus: {}\nversion: v1\n", instanceId, resp.BotInstance.Metadata.Revision))


		import { useGetBotInstance } from '../hooks';

		const docsURL =

Conversation

nicholasmarais1158 commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes

Demo (network throttled)

Uh oh!

Uh oh!

Uh oh!

zmb3 May 23, 2025

Choose a reason for hiding this comment

Uh oh!

zmb3 May 23, 2025

Choose a reason for hiding this comment

Uh oh!

nicholasmarais1158 May 27, 2025

Choose a reason for hiding this comment

Uh oh!

zmb3 May 23, 2025

Choose a reason for hiding this comment

Uh oh!

nicholasmarais1158 May 27, 2025

Choose a reason for hiding this comment

Uh oh!

zmb3 May 23, 2025

Choose a reason for hiding this comment

Uh oh!

nicholasmarais1158 May 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

backport-bot-workflows Bot commented May 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nicholasmarais1158 commented May 22, 2025 •

edited

Loading