-
Notifications
You must be signed in to change notification settings - Fork 962
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
Open
kacpersaw
wants to merge
5
commits into
kacpersaw/feat-coder-attach-cli
Choose a base branch
from
kacpersaw/feat-coder-attach-ui
base: kacpersaw/feat-coder-attach-cli
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+231
−10
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
45735b8
feat: add support for external agents in the UI and extend CodeExample
kacpersaw 50bfa36
hide AgentExternal if feature is disabled
kacpersaw 45ca610
Fix AgentExternal story
kacpersaw 956e5fb
Handle errors when fetching external agent credentials in AgentExtern…
kacpersaw bf67f24
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
import type { Meta, StoryObj } from "@storybook/react-vite"; | ||
import { chromatic } from "testHelpers/chromatic"; | ||
import { MockWorkspace, MockWorkspaceAgent } from "testHelpers/entities"; | ||
import { withDashboardProvider } from "testHelpers/storybook"; | ||
import { AgentExternal } from "./AgentExternal"; | ||
|
||
const meta: Meta<typeof AgentExternal> = { | ||
title: "modules/resources/AgentExternal", | ||
component: AgentExternal, | ||
args: { | ||
isExternalAgent: true, | ||
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: { | ||
isExternalAgent: false, | ||
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,59 @@ | ||
import { API } from "api/api"; | ||
import { getErrorMessage } from "api/errors"; | ||
import type { Workspace, WorkspaceAgent } from "api/typesGenerated"; | ||
import isChromatic from "chromatic/isChromatic"; | ||
import { CodeExample } from "components/CodeExample/CodeExample"; | ||
import { displayError } from "components/GlobalSnackbar/utils"; | ||
import { type FC, useEffect, useState } from "react"; | ||
|
||
interface AgentExternalProps { | ||
isExternalAgent: boolean; | ||
agent: WorkspaceAgent; | ||
workspace: Workspace; | ||
} | ||
|
||
export const AgentExternal: FC<AgentExternalProps> = ({ | ||
isExternalAgent, | ||
agent, | ||
workspace, | ||
}) => { | ||
const [externalAgentToken, setExternalAgentToken] = useState<string | null>( | ||
null, | ||
); | ||
const [command, setCommand] = useState<string | null>(null); | ||
|
||
const origin = isChromatic() ? "https://example.com" : window.location.origin; | ||
useEffect(() => { | ||
if ( | ||
isExternalAgent && | ||
(agent.status === "timeout" || agent.status === "connecting") | ||
) { | ||
API.getWorkspaceAgentCredentials(workspace.id, agent.name) | ||
.then((res) => { | ||
setExternalAgentToken(res.agent_token); | ||
setCommand(res.command); | ||
}) | ||
.catch((err) => { | ||
displayError( | ||
getErrorMessage(err, "Failed to get external agent credentials"), | ||
); | ||
}); | ||
} | ||
}, [isExternalAgent, agent.status, workspace.id, agent.name]); | ||
Comment on lines
+26
to
+42
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. use |
||
|
||
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={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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,6 +27,7 @@ import AutoSizer from "react-virtualized-auto-sizer"; | |
import type { FixedSizeList as List, ListOnScrollProps } from "react-window"; | ||
import { AgentApps, organizeAgentApps } from "./AgentApps/AgentApps"; | ||
import { AgentDevcontainerCard } from "./AgentDevcontainerCard"; | ||
import { AgentExternal } from "./AgentExternal"; | ||
import { AgentLatency } from "./AgentLatency"; | ||
import { AGENT_LOG_LINE_HEIGHT } from "./AgentLogs/AgentLogLine"; | ||
import { AgentLogs } from "./AgentLogs/AgentLogs"; | ||
|
@@ -58,13 +59,14 @@ export const AgentRow: FC<AgentRowProps> = ({ | |
onUpdateAgent, | ||
initialMetadata, | ||
}) => { | ||
const { browser_only } = useFeatureVisibility(); | ||
const { browser_only, workspace_external_agent } = useFeatureVisibility(); | ||
const appSections = organizeAgentApps(agent.apps); | ||
const hasAppsToDisplay = | ||
!browser_only || appSections.some((it) => it.apps.length > 0); | ||
const isExternalAgent = workspace.latest_build.has_external_agent; | ||
const shouldDisplayAgentApps = | ||
(agent.status === "connected" && hasAppsToDisplay) || | ||
agent.status === "connecting"; | ||
(agent.status === "connecting" && !isExternalAgent); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. why do we only hide them while connecting? |
||
const hasVSCodeApp = | ||
agent.display_apps.includes("vscode") || | ||
agent.display_apps.includes("vscode_insiders"); | ||
|
@@ -258,7 +260,7 @@ export const AgentRow: FC<AgentRowProps> = ({ | |
</section> | ||
)} | ||
|
||
{agent.status === "connecting" && ( | ||
{agent.status === "connecting" && !isExternalAgent && ( | ||
<section css={styles.apps}> | ||
<Skeleton | ||
width={80} | ||
|
@@ -293,6 +295,16 @@ export const AgentRow: FC<AgentRowProps> = ({ | |
</section> | ||
)} | ||
|
||
{isExternalAgent && | ||
(agent.status === "timeout" || agent.status === "connecting") && | ||
workspace_external_agent && ( | ||
<AgentExternal | ||
isExternalAgent={isExternalAgent} | ||
agent={agent} | ||
workspace={workspace} | ||
/> | ||
)} | ||
|
||
<AgentMetadata initialMetadata={initialMetadata} agent={agent} /> | ||
</div> | ||
|
||
|
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.
we should use the deployment config value here instead