mirror of
https://github.com/coder/coder.git
synced 2026-11-19 18:51:12 +08:00
feat: group apps together on workspace page (#18018)
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
import type { Meta, StoryObj } from "@storybook/react";
|
||||
import { spyOn } from "@storybook/test";
|
||||
import { spyOn, userEvent, within } from "@storybook/test";
|
||||
import { API } from "api/api";
|
||||
import { getPreferredProxy } from "contexts/ProxyContext";
|
||||
import { chromatic } from "testHelpers/chromatic";
|
||||
@@ -265,3 +265,22 @@ export const HideApp: Story = {
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
export const GroupApp: Story = {
|
||||
args: {
|
||||
agent: {
|
||||
...M.MockWorkspaceAgent,
|
||||
apps: [
|
||||
{
|
||||
...M.MockWorkspaceApp,
|
||||
group: "group",
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
|
||||
play: async ({ canvasElement }) => {
|
||||
const canvas = within(canvasElement);
|
||||
await userEvent.click(canvas.getByText("group"));
|
||||
},
|
||||
};
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
import { MockWorkspaceApp } from "testHelpers/entities";
|
||||
import { organizeAgentApps } from "./AgentRow";
|
||||
|
||||
describe("organizeAgentApps", () => {
|
||||
test("returns one ungrouped app", () => {
|
||||
const result = organizeAgentApps([{ ...MockWorkspaceApp }]);
|
||||
|
||||
expect(result).toEqual([{ apps: [MockWorkspaceApp] }]);
|
||||
});
|
||||
|
||||
test("handles ordering correctly", () => {
|
||||
const bugApp = { ...MockWorkspaceApp, slug: "bug", group: "creatures" };
|
||||
const birdApp = { ...MockWorkspaceApp, slug: "bird", group: "creatures" };
|
||||
const fishApp = { ...MockWorkspaceApp, slug: "fish", group: "creatures" };
|
||||
const riderApp = { ...MockWorkspaceApp, slug: "rider" };
|
||||
const zedApp = { ...MockWorkspaceApp, slug: "zed" };
|
||||
const result = organizeAgentApps([
|
||||
bugApp,
|
||||
riderApp,
|
||||
birdApp,
|
||||
zedApp,
|
||||
fishApp,
|
||||
]);
|
||||
|
||||
expect(result).toEqual([
|
||||
{ group: "creatures", apps: [bugApp, birdApp, fishApp] },
|
||||
{ apps: [riderApp] },
|
||||
{ apps: [zedApp] },
|
||||
]);
|
||||
});
|
||||
});
|
||||
@@ -9,12 +9,19 @@ import type {
|
||||
Workspace,
|
||||
WorkspaceAgent,
|
||||
WorkspaceAgentMetadata,
|
||||
WorkspaceApp,
|
||||
} from "api/typesGenerated";
|
||||
import { isAxiosError } from "axios";
|
||||
import { DropdownArrow } from "components/DropdownArrow/DropdownArrow";
|
||||
import type { Line } from "components/Logs/LogLine";
|
||||
import {
|
||||
DropdownMenu,
|
||||
DropdownMenuContent,
|
||||
DropdownMenuItem,
|
||||
DropdownMenuTrigger,
|
||||
} from "components/DropdownMenu/DropdownMenu";
|
||||
import { Stack } from "components/Stack/Stack";
|
||||
import { useProxy } from "contexts/ProxyContext";
|
||||
import { Folder } from "lucide-react";
|
||||
import { useFeatureVisibility } from "modules/dashboard/useFeatureVisibility";
|
||||
import { AppStatuses } from "pages/WorkspacePage/AppStatuses";
|
||||
import {
|
||||
@@ -29,6 +36,7 @@ import {
|
||||
import { useQuery } from "react-query";
|
||||
import AutoSizer from "react-virtualized-auto-sizer";
|
||||
import type { FixedSizeList as List, ListOnScrollProps } from "react-window";
|
||||
import { AgentButton } from "./AgentButton";
|
||||
import { AgentDevcontainerCard } from "./AgentDevcontainerCard";
|
||||
import { AgentLatency } from "./AgentLatency";
|
||||
import { AGENT_LOG_LINE_HEIGHT } from "./AgentLogs/AgentLogLine";
|
||||
@@ -59,10 +67,10 @@ export const AgentRow: FC<AgentRowProps> = ({
|
||||
onUpdateAgent,
|
||||
initialMetadata,
|
||||
}) => {
|
||||
// Apps visibility
|
||||
const { browser_only } = useFeatureVisibility();
|
||||
const visibleApps = agent.apps.filter((app) => !app.hidden);
|
||||
const hasAppsToDisplay = !browser_only && visibleApps.length > 0;
|
||||
const appSections = organizeAgentApps(agent.apps);
|
||||
const hasAppsToDisplay =
|
||||
!browser_only || appSections.some((it) => it.apps.length > 0);
|
||||
const shouldDisplayApps =
|
||||
(agent.status === "connected" && hasAppsToDisplay) ||
|
||||
agent.status === "connecting";
|
||||
@@ -223,10 +231,10 @@ export const AgentRow: FC<AgentRowProps> = ({
|
||||
displayApps={agent.display_apps}
|
||||
/>
|
||||
)}
|
||||
{visibleApps.map((app) => (
|
||||
<AppLink
|
||||
key={app.slug}
|
||||
app={app}
|
||||
{appSections.map((section, i) => (
|
||||
<Apps
|
||||
key={section.group ?? i}
|
||||
section={section}
|
||||
agent={agent}
|
||||
workspace={workspace}
|
||||
/>
|
||||
@@ -296,7 +304,7 @@ export const AgentRow: FC<AgentRowProps> = ({
|
||||
width={width}
|
||||
css={styles.startupLogs}
|
||||
onScroll={handleLogScroll}
|
||||
logs={startupLogs.map<Line>((l) => ({
|
||||
logs={startupLogs.map((l) => ({
|
||||
id: l.id,
|
||||
level: l.level,
|
||||
output: l.output,
|
||||
@@ -327,6 +335,93 @@ export const AgentRow: FC<AgentRowProps> = ({
|
||||
);
|
||||
};
|
||||
|
||||
type AppSection = {
|
||||
/**
|
||||
* If there is no `group`, just render all of the apps inline. If there is a
|
||||
* group name, show them all in a dropdown.
|
||||
*/
|
||||
group?: string;
|
||||
|
||||
apps: WorkspaceApp[];
|
||||
};
|
||||
|
||||
/**
|
||||
* organizeAgentApps returns an ordering of agent apps that accounts for
|
||||
* grouping. When we receive the list of apps from the backend, they have
|
||||
* already been "ordered" by their `order` attribute, but we are not given that
|
||||
* value. We must be careful to preserve that ordering, while also properly
|
||||
* grouping together all apps of any given group.
|
||||
*
|
||||
* The position of the group overall is determined by the `order` position of
|
||||
* the first app in the group. There may be several sections returned without
|
||||
* a group name, to allow placing grouped apps in between non-grouped apps. Not
|
||||
* every ungrouped section is expected to have a group in between, to make the
|
||||
* algorithm a little simpler to implement.
|
||||
*/
|
||||
export function organizeAgentApps(apps: readonly WorkspaceApp[]): AppSection[] {
|
||||
let currentSection: AppSection | undefined = undefined;
|
||||
const appGroups: AppSection[] = [];
|
||||
const groupsByName = new Map<string, AppSection>();
|
||||
|
||||
for (const app of apps) {
|
||||
if (app.hidden) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (!currentSection || app.group !== currentSection.group) {
|
||||
const existingSection = groupsByName.get(app.group!);
|
||||
if (existingSection) {
|
||||
currentSection = existingSection;
|
||||
} else {
|
||||
currentSection = {
|
||||
group: app.group,
|
||||
apps: [],
|
||||
};
|
||||
appGroups.push(currentSection);
|
||||
if (app.group) {
|
||||
groupsByName.set(app.group, currentSection);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
currentSection.apps.push(app);
|
||||
}
|
||||
|
||||
return appGroups;
|
||||
}
|
||||
|
||||
type AppsProps = {
|
||||
section: AppSection;
|
||||
agent: WorkspaceAgent;
|
||||
workspace: Workspace;
|
||||
};
|
||||
|
||||
const Apps: FC<AppsProps> = ({ section, agent, workspace }) => {
|
||||
return section.group ? (
|
||||
<DropdownMenu>
|
||||
<DropdownMenuTrigger asChild>
|
||||
<AgentButton>
|
||||
<Folder />
|
||||
{section.group}
|
||||
</AgentButton>
|
||||
</DropdownMenuTrigger>
|
||||
<DropdownMenuContent align="start">
|
||||
{section.apps.map((app) => (
|
||||
<DropdownMenuItem key={app.slug}>
|
||||
<AppLink grouped app={app} agent={agent} workspace={workspace} />
|
||||
</DropdownMenuItem>
|
||||
))}
|
||||
</DropdownMenuContent>
|
||||
</DropdownMenu>
|
||||
) : (
|
||||
<>
|
||||
{section.apps.map((app) => (
|
||||
<AppLink key={app.slug} app={app} agent={agent} workspace={workspace} />
|
||||
))}
|
||||
</>
|
||||
);
|
||||
};
|
||||
|
||||
const styles = {
|
||||
agentRow: (theme) => ({
|
||||
fontSize: 14,
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
import { useTheme } from "@emotion/react";
|
||||
import type * as TypesGen from "api/typesGenerated";
|
||||
import { DropdownMenuItem } from "components/DropdownMenu/DropdownMenu";
|
||||
import { Spinner } from "components/Spinner/Spinner";
|
||||
import {
|
||||
Tooltip,
|
||||
@@ -28,9 +29,15 @@ interface AppLinkProps {
|
||||
workspace: TypesGen.Workspace;
|
||||
app: TypesGen.WorkspaceApp;
|
||||
agent: TypesGen.WorkspaceAgent;
|
||||
grouped?: boolean;
|
||||
}
|
||||
|
||||
export const AppLink: FC<AppLinkProps> = ({ app, workspace, agent }) => {
|
||||
export const AppLink: FC<AppLinkProps> = ({
|
||||
app,
|
||||
workspace,
|
||||
agent,
|
||||
grouped,
|
||||
}) => {
|
||||
const { proxy } = useProxy();
|
||||
const host = proxy.preferredWildcardHostname;
|
||||
const [iconError, setIconError] = useState(false);
|
||||
@@ -90,7 +97,15 @@ export const AppLink: FC<AppLinkProps> = ({ app, workspace, agent }) => {
|
||||
|
||||
const canShare = app.sharing_level !== "owner";
|
||||
|
||||
const button = (
|
||||
const button = grouped ? (
|
||||
<DropdownMenuItem asChild>
|
||||
<a href={canClick ? link.href : undefined} onClick={link.onClick}>
|
||||
{icon}
|
||||
{link.label}
|
||||
{canShare && <ShareIcon app={app} />}
|
||||
</a>
|
||||
</DropdownMenuItem>
|
||||
) : (
|
||||
<AgentButton asChild>
|
||||
<a href={canClick ? link.href : undefined} onClick={link.onClick}>
|
||||
{icon}
|
||||
|
||||
Reference in New Issue
Block a user