Skip to content

Connect: refresh resources when access changes and add tests for ClusterLifecycleManager#61479

Merged
gzdunek merged 6 commits intomasterfrom
gzdunek/refresh-resources-when-access-changes
Nov 21, 2025
Merged

Connect: refresh resources when access changes and add tests for ClusterLifecycleManager#61479
gzdunek merged 6 commits intomasterfrom
gzdunek/refresh-resources-when-access-changes

Conversation

@gzdunek
Copy link
Copy Markdown
Contributor

@gzdunek gzdunek commented Nov 18, 2025

Contributes to #25806

Currently, when the user assumes or drops a request through the UI, we send that request to tshd, synchronize the root cluster, and request a refresh of resource tabs.
It would be great to have the same behavior (refreshing the resources) when a request is assumed through tsh.

My initial idea was to check if active requests of the logged in user has changed. This approach would work, but it would be prone to false positives. For example, this property would change when the user logs in as a different user, who doesn't have any assumed requests.

This wouldn't be a major issue, but I thought we could turn this bug into a feature. Instead of comparing only the active requests, we also check the username and roles of the logged-in user. When we detect that any of these have changed, we can assume with high probability that the user should see different resources.

I also added tests for ClusterLifecycleManager.

@gzdunek gzdunek requested review from avatus and ravicious November 18, 2025 15:01
@gzdunek gzdunek added the no-changelog Indicates that a PR does not require a changelog entry label Nov 18, 2025
@gzdunek gzdunek removed the request for review from flyinghermit November 18, 2025 15:02
Copy link
Copy Markdown
Member

@ravicious ravicious left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll review the ClusterLifecycleManager tests and QA the change tomorrow.

op: 'did-add-cluster' | 'will-logout' | 'will-logout-and-remove';
op:
| 'did-add-cluster'
| 'did-change-access'
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add a JSDoc explaining what it means for access to be changed? Right now it requires looking up the relevant source code that sets this value.

import { AccessRequestsContextProvider } from './AccessRequestsContext';

test('assuming or dropping a request refreshes resources', async () => {
test('assuming or dropping a request calls API', async () => {
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This tests dropping only, no?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I expanded the test to verify assuming the request too.

@ravicious ravicious self-requested a review November 19, 2025 17:33
Copy link
Copy Markdown
Member

@ravicious ravicious left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

},
},
{
name: 'when cluster is removed, it removes it and notifies renderer',
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
name: 'when cluster is removed, it removes it and notifies renderer',
name: 'when cluster is removed, it removes cluster and notifies renderer',

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, in other tests we say 'when cluster is *, it updates state and notifies renderer`, so I updated this one to follow the same pattern.

@gzdunek gzdunek enabled auto-merge November 21, 2025 08:05
@gzdunek gzdunek added this pull request to the merge queue Nov 21, 2025
Merged via the queue into master with commit 4b00520 Nov 21, 2025
42 checks passed
@gzdunek gzdunek deleted the gzdunek/refresh-resources-when-access-changes branch November 21, 2025 08:26
gzdunek added a commit that referenced this pull request Nov 28, 2025
…sterLifecycleManager` (#61479)

* Detect when user's access changes

* Refresh resources in UI when `did-change-access` is received

* Add tests for `ClusterLifecycleManager`

* Add better docs for ClusterLifecycleEvent

* Test assuming requests too

* Improve test names

(cherry picked from commit 4b00520)
github-merge-queue bot pushed a commit that referenced this pull request Dec 4, 2025
* Combine `ClustersService` logout functions (#59539)

* Remove clusters immediately after a logout, move `useClusterLogout` to `AppContext`

* Review callsites to ensure cluster is properly checked before being accessed

* Revert "Review callsites to ensure cluster is properly checked before being accessed"

This reverts commit 8343c3c.

* Switch to removing the cluster at the end of logout sequence

* Lint

* Move `logoutWithCleanup` to `ui/ClusterLogout`

(cherry picked from commit de6b4ed)

* Enable sending messages from main to renderer with acknowledgments (#59642)

* Create awaitable sender

* Review comments

* Fix test and lint

(cherry picked from commit 5dc76fe)

* Move cluster state to main process (#59643)

* Create `ClusterStore` that manages cluster state

* Fix tests that mocked tshd directly

* Remove IPC to notify the main process about cluster list changes

* Load immer plugins in `MainProcess`

* Improve comments

* Refactor `useSender`

* Get rid of unnecessary Map and try/catch around send

* Get rid of `MainProcess.create`

* Do not return early `c.proxyHost` is falsy

* Add more context to test

* Add missing logout handler in main process

* Fix applying patches

* Adjust `subscribeToClusterStore` to updated `startAwaitableSenderListener`

* Crash window when sending state update fails

* Extract WebContents navigation handlers and add tests for opening links

* Improve error message

* Initialize `ClusterStore` synchronously

* Convert `lazyTshdClient` field to `getTshdClient` function, add docs

* Remove unused eslint directive

(cherry picked from commit a41d021)

* Connect: make logout function idempotent (#60553)

* Remove `ClusterRemove` RPC, make logging out idempotent

* Move calling `removeKubeConfig` and `maybeRemoveAppUpdatesManagingCluster` to main process

The main process should not depend on the renderer to clean up its own resources.

* Remove cleaning up kube dir

* Lint

(cherry picked from commit 2d1bc7b)

* Connect: add profile watcher (#60622)

* Add profile watcher

* Move `makeClusterWithOnlyProfileProperties` to `profileWatcher.ts`, improve test

* Handle watched directory removal

* Improve comments

* Make tests faster, pass abort signal everywhere

* Improve docs

* Make `removing tsh directory does not break watcher` easier to understand

* Make test dir per test

* Improve timing in tests

* Add a limit of how many events can be emitted by `fs.watch` (to break the endless stream of events on Windows when watched dir is removed), go into the polling mode only when it's expected that the watched dir was removed

* Use `expect().rejects.toThrow` correctly

* Deflake 'max file system events count is restricted'

* Replace `makeClusterWithOnlyProfileProperties` with `mergeClusterProfileWithDetails`, move it back to `cluster.ts`

* Attempt to fix tests

* Clarify comment

(cherry picked from commit d4e6f19)

* Initialize tshdClients in MainProcess constructor (#61044)

(cherry picked from commit c7a4233)

* Connect: react to tsh actions by watching tsh dir (#60884)

* Add `ClusterLifecycleManager`

* Register handlers for adding, removing and logging out from cluster

* Provide `rootCluster` in `useWorkspaceContext`

The handlers in the profile watcher will proceed with updating the cluster store, even if the renderer handlers returned errors.
This check protects us from a runtime error if the renderer fails to remove the workspace.

* Improve docs

* Move processing queue to listener

* Make `will-` operations always interrupt main process actions

* Improve error messages

* Do not remove managing cluster when **only** logging out

The app updater displays all clusters, not just those the user is logged into.

* Revert "Provide `rootCluster` in `useWorkspaceContext`"

This reverts commit cf76d2b.

* Rename `logoutWithCleanup` to `cleanUpBeforeLogout`

* Do not pass `AbortSignal` to `this.mainProcessClient.syncRootClusters`

* Lint

* Fix types issues

* Do not stack watcher notifications

(cherry picked from commit 5fa8249)

* Connect: close cluster clients when profile changes (#61090)

* Include expiration time in `LoggedInUser`

This will allow the profile watcher to detect when the user relogged.

* Display expiration time in UI

* Add `ClearStaleClusterClients` RPC

* Implement `ClearStaleClusterClients`

* Clear stale clients when profile changes

* Improve session expiration component

* Move refresh button back to top

* `ClearCachedStaleClientsForRoot` -> `ClearStaleCachedClientsForRoot`

* `unchanged` -> `stale`

* Make "closing stale clients" a subtest

* Add `clientcache` test

* Remove `getProfile` error wrapping

* Improve comment

* Convert story to controls

(cherry picked from commit 6615e42)

* Gracefully handle missing `current-profile` and respect `TELEPORT_PROXY` in `tsh status`  (#61295)

* Respect `TELEPORT_PROXY` env var in `tsh status`

* Enable listing profiles if there is no active profile

* Add test

* Define `err` within the block where it's actually used

* Handle missing current profile in `tsh logout`

* Make check more explicit

* Revert mistakenly commited change

(cherry picked from commit 95bec3a)

* Connect: switch tsh home directory to ~/.tsh (#61352)

* Switch tsh home directory to ~/.tsh

* Migrate old tsh home to new location, disallow updating fields outside the `state` key in app_state.json from the renderer process

* Show banner about migrated tsh home

* `promoteMigratedTshHome` -> `showTshHomeMigrationBanner`

* `MigratedTshHomeBanner` -> `TshHomeMigrationBanner`

* 'Profiles are' -> 'Profiles are now', remove unnecessary space

* Fix assigning colors for new workspaces

* Improve logs

(cherry picked from commit 54b5f6c)

* Connect: refresh resources when access changes and add tests for `ClusterLifecycleManager` (#61479)

* Detect when user's access changes

* Refresh resources in UI when `did-change-access` is received

* Add tests for `ClusterLifecycleManager`

* Add better docs for ClusterLifecycleEvent

* Test assuming requests too

* Improve test names

(cherry picked from commit 4b00520)

* Set up deep links as soon as possible (#61668)

(cherry picked from commit 0b5ab6b)

* Serialize IPC errors  (#61665)

* Serialize all enumerable error fields

* Add wrappers around `ipcMain.handle` and `ipcRenderer.invoke`

* Fix `Method Error.prototype.toString called on incompatible receiver undefined`

* Improve docs

* Lint

(cherry picked from commit a1f2ae0)

* Fix unrecoverable ssh cert errors in tsh/Connect (#61322)

* Initialize default Username/HostLogin only in tsh

* Move `Username()` from `api.go` to `tsh.go`

* Remove wrong `Profile.SiteName` default

* Remove resetting `SiteName`

Not sure why it was needed. Perhaps to clear the default that we just removed? But even if add the default back and remove this fix, everything works.

* Gracefully handle missing SSH/TLS certs

* Remove unused `TeleportClient.LoadKeyForClusterWithReissue`

* Revert "Move `Username()` from `api.go` to `tsh.go`"

This reverts commit f7ff0ff.

* Revert "Initialize default Username/HostLogin only in tsh"

This reverts commit ed38bab.

* When any of SSH/TLS cert is missing, return partial profile

* Only log non-nil errors

* Revert "Remove wrong `Profile.SiteName` default"

* Revert "Remove resetting `SiteName`"

This reverts commit f54ab3f.

* Set `SiteName` when adding cluster

* Improve comments

* Add test

* Fix test

* Add myself to TODO

* Add test for logging out with missing SSH cert

* Lint

(cherry picked from commit cd3c8f8)

* Connect: update docs for sharing ~/.tsh directory (#61467)

* Update docs for sharing ~/.tsh directory

* Review comments

* Lint

(cherry picked from commit 19533bf)

---------

Co-authored-by: ravicious <rafal.cieslak@goteleport.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog Indicates that a PR does not require a changelog entry size/md ui

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants