-
Notifications
You must be signed in to change notification settings - Fork 974
feat(site): add support for external agents in the UI and extend CodeExample #19288
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
a0be6c2
feat: add support for external agents in the UI and extend CodeExample
kacpersaw ceec966
hide AgentExternal if feature is disabled
kacpersaw 1245e0b
Fix AgentExternal story
kacpersaw f7ac4c0
Handle errors when fetching external agent credentials in AgentExtern…
kacpersaw 73049f3
Fix lint
kacpersaw 29e2625
use useQuery to get external agent credentials
kacpersaw 044076a
Fix lint
kacpersaw File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
import { chromatic } from "testHelpers/chromatic"; | ||
import { MockWorkspace, MockWorkspaceAgent } from "testHelpers/entities"; | ||
import { withDashboardProvider } from "testHelpers/storybook"; | ||
import type { Meta, StoryObj } from "@storybook/react-vite"; | ||
import { AgentExternal } from "./AgentExternal"; | ||
|
||
const meta: Meta<typeof AgentExternal> = { | ||
title: "modules/resources/AgentExternal", | ||
component: AgentExternal, | ||
args: { | ||
agent: { | ||
...MockWorkspaceAgent, | ||
status: "connecting", | ||
operating_system: "linux", | ||
architecture: "amd64", | ||
}, | ||
workspace: MockWorkspace, | ||
}, | ||
decorators: [withDashboardProvider], | ||
parameters: { | ||
chromatic, | ||
}, | ||
}; | ||
|
||
export default meta; | ||
type Story = StoryObj<typeof AgentExternal>; | ||
|
||
export const Connecting: Story = { | ||
args: { | ||
agent: { | ||
...MockWorkspaceAgent, | ||
status: "connecting", | ||
operating_system: "linux", | ||
architecture: "amd64", | ||
}, | ||
}, | ||
}; | ||
|
||
export const Timeout: Story = { | ||
args: { | ||
agent: { | ||
...MockWorkspaceAgent, | ||
status: "timeout", | ||
operating_system: "linux", | ||
architecture: "amd64", | ||
}, | ||
}, | ||
}; | ||
|
||
export const DifferentOS: Story = { | ||
args: { | ||
agent: { | ||
...MockWorkspaceAgent, | ||
status: "connecting", | ||
operating_system: "darwin", | ||
architecture: "arm64", | ||
}, | ||
}, | ||
}; | ||
|
||
export const NotExternalAgent: Story = { | ||
args: { | ||
agent: { | ||
...MockWorkspaceAgent, | ||
status: "connecting", | ||
operating_system: "linux", | ||
architecture: "amd64", | ||
}, | ||
}, | ||
}; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
import { workspaceAgentCredentials } from "api/queries/workspaces"; | ||
import type { Workspace, WorkspaceAgent } from "api/typesGenerated"; | ||
import { ErrorAlert } from "components/Alert/ErrorAlert"; | ||
import { CodeExample } from "components/CodeExample/CodeExample"; | ||
import { Loader } from "components/Loader/Loader"; | ||
import type { FC } from "react"; | ||
import { useQuery } from "react-query"; | ||
|
||
interface AgentExternalProps { | ||
agent: WorkspaceAgent; | ||
workspace: Workspace; | ||
} | ||
|
||
export const AgentExternal: FC<AgentExternalProps> = ({ agent, workspace }) => { | ||
const { | ||
data: credentials, | ||
error, | ||
isLoading, | ||
isError, | ||
} = useQuery(workspaceAgentCredentials(workspace.id, agent.name)); | ||
|
||
if (isLoading) { | ||
return <Loader />; | ||
} | ||
|
||
if (isError) { | ||
return <ErrorAlert error={error} />; | ||
} | ||
|
||
return ( | ||
<section className="text-base text-muted-foreground pb-2 leading-relaxed"> | ||
<p> | ||
Please run the following command to attach an agent to the{" "} | ||
{workspace.name} workspace: | ||
</p> | ||
<CodeExample | ||
code={credentials?.command ?? ""} | ||
secret={false} | ||
redactPattern={/CODER_AGENT_TOKEN="([^"]+)"/g} | ||
redactReplacement={`CODER_AGENT_TOKEN="********"`} | ||
showRevealButton={true} | ||
/> | ||
</section> | ||
); | ||
}; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why do we only hide them while connecting?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I hid the apps when connecting to have a clear view with external agent credentials. The apps would only be installed when the agent is connected, so having them visible doesn’t make sense imo.