76c88e5855
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Operators manage both company-scoped configuration and instance-level runtime/admin settings from the board UI > - Instance settings previously lived as their own top-level sidebar area, separate from the company settings context operators already use > - That split made settings navigation feel heavier and made instance configuration less discoverable from the settings tab > - This pull request moves instance settings under company settings while preserving the existing instance settings routes and plugin/admin surfaces > - The benefit is a smaller primary sidebar and a more coherent settings hierarchy for operators ## Linked Issues or Issue Description - Refs #338 - Internal: PAP-10491, PAP-10538 ## What Changed - Moved instance settings navigation under the company settings area. - Added route helpers and sidebar entries for nested instance settings paths. - Updated plugin/admin settings routes to use the company settings instance scope. - Preserved legacy instance-settings bookmarks through compatibility redirects that keep the active company prefix. - Updated focused UI and plugin tests for the new navigation shape. - Stabilized the process-loss retry test that was failing the serialized server shard in CI. - Rebased the branch onto current `paperclipai/paperclip` `master` and pushed the current head. ## Verification - `pnpm exec vitest run ui/src/components/CompanySettingsSidebar.test.tsx ui/src/components/access/CompanySettingsNav.test.tsx ui/src/lib/instance-settings.test.ts ui/src/components/InstanceSidebar.test.tsx ui/src/components/Layout.test.tsx ui/src/components/SidebarAccountMenu.test.tsx ui/src/pages/PluginPage.test.tsx ui/src/plugins/bridge.test.ts packages/shared/src/validators/plugin.test.ts` - `pnpm exec vitest run ui/src/lib/instance-settings.test.ts ui/src/components/CompanySettingsSidebar.test.tsx ui/src/components/access/CompanySettingsNav.test.tsx ui/src/components/Layout.test.tsx ui/src/plugins/bridge.test.ts` - `pnpm exec vitest run server/src/__tests__/heartbeat-process-recovery.test.ts -t "queues exactly one retry when the recorded local pid is dead"` - `pnpm test:run:serialized -- --shard-index 0 --shard-count 4` - GitHub PR checks are green on head `fe7b0955169dcae55cbe10889c1876a70ab0b80c`, including `verify`, `General tests (server)`, all serialized server shards, build, e2e, policy, security checks, and Greptile. - Confirmed the PR diff does not include `pnpm-lock.yaml` or `.github/workflows` changes. ## Risks - Medium UI/navigation risk: instance settings links are intentionally moving under company settings, so stale external bookmarks to legacy paths rely on the compatibility routing in this branch. - Low test-only risk from the CI stabilization commit: it makes the recovery assertion select the actual retry run by `retryOfRunId` instead of whichever non-original run appears first. - No database migrations. - No dependency lockfile or workflow changes. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI Codex coding agent based on GPT-5, with shell/tool execution in a local repository worktree. Exact context window was not exposed by the runtime. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [ ] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
212 lines
7.4 KiB
TypeScript
212 lines
7.4 KiB
TypeScript
import { useQuery } from "@tanstack/react-query";
|
|
import {
|
|
ChevronLeft,
|
|
Clock3,
|
|
CloudUpload,
|
|
Cpu,
|
|
FlaskConical,
|
|
KeyRound,
|
|
MailPlus,
|
|
MonitorCog,
|
|
Puzzle,
|
|
Settings,
|
|
Shield,
|
|
SlidersHorizontal,
|
|
UserRoundPen,
|
|
Users,
|
|
} from "lucide-react";
|
|
import type { PluginRecord } from "@paperclipai/shared";
|
|
import { sidebarBadgesApi } from "@/api/sidebarBadges";
|
|
import { instanceSettingsApi } from "@/api/instanceSettings";
|
|
import { pluginsApi } from "@/api/plugins";
|
|
import { ApiError } from "@/api/client";
|
|
import { Link, NavLink } from "@/lib/router";
|
|
import { INSTANCE_SETTINGS_PATH_PREFIX } from "@/lib/instance-settings";
|
|
import { SIDEBAR_SCROLL_RESET_STATE } from "@/lib/navigation-scroll";
|
|
import { queryKeys } from "@/lib/queryKeys";
|
|
import { useCompany } from "@/context/CompanyContext";
|
|
import { useSidebar } from "@/context/SidebarContext";
|
|
import { usePluginSlots } from "@/plugins/slots";
|
|
import { SidebarNavItem } from "./SidebarNavItem";
|
|
|
|
/**
|
|
* Sandbox-provider-only plugins (e.g. E2B, exe.dev, Modal) have no per-plugin
|
|
* settings page, so a sidebar entry would lead nowhere useful. Filter them out
|
|
* here. Plugins that mix a sandbox provider with other contributions still
|
|
* appear.
|
|
*/
|
|
function isSandboxProviderOnly(plugin: PluginRecord): boolean {
|
|
const drivers = plugin.manifestJson.environmentDrivers ?? [];
|
|
if (drivers.length === 0) return false;
|
|
return drivers.every((d) => d.kind === "sandbox_provider");
|
|
}
|
|
|
|
export function CompanySettingsSidebar() {
|
|
const { selectedCompany, selectedCompanyId } = useCompany();
|
|
const { isMobile, setSidebarOpen } = useSidebar();
|
|
const { slots: companySettingsPluginSlots } = usePluginSlots({
|
|
slotTypes: ["companySettingsPage"],
|
|
companyId: selectedCompanyId,
|
|
enabled: !!selectedCompanyId,
|
|
});
|
|
const { data: badges } = useQuery({
|
|
queryKey: selectedCompanyId
|
|
? queryKeys.sidebarBadges(selectedCompanyId)
|
|
: ["sidebar-badges", "__disabled__"] as const,
|
|
queryFn: async () => {
|
|
try {
|
|
return await sidebarBadgesApi.get(selectedCompanyId!);
|
|
} catch (error) {
|
|
if (error instanceof ApiError && (error.status === 401 || error.status === 403)) {
|
|
return null;
|
|
}
|
|
throw error;
|
|
}
|
|
},
|
|
enabled: !!selectedCompanyId,
|
|
retry: false,
|
|
refetchInterval: 15_000,
|
|
});
|
|
const { data: experimentalSettings } = useQuery({
|
|
queryKey: queryKeys.instance.experimentalSettings,
|
|
queryFn: () => instanceSettingsApi.getExperimental(),
|
|
});
|
|
const { data: plugins } = useQuery({
|
|
queryKey: queryKeys.plugins.all,
|
|
queryFn: () => pluginsApi.list(),
|
|
});
|
|
const showCloudUpstream = experimentalSettings?.enableCloudSync === true;
|
|
const sidebarPlugins = (plugins ?? []).filter((plugin) => !isSandboxProviderOnly(plugin));
|
|
|
|
return (
|
|
<aside className="w-full h-full min-h-0 border-r border-border bg-background flex flex-col">
|
|
<div className="flex flex-col gap-1 px-3 py-3 shrink-0">
|
|
<Link
|
|
to="/dashboard"
|
|
onClick={() => {
|
|
if (isMobile) setSidebarOpen(false);
|
|
}}
|
|
className="flex items-center gap-1.5 rounded-md px-2 py-1 text-xs text-muted-foreground transition-colors hover:bg-accent/50 hover:text-foreground"
|
|
>
|
|
<ChevronLeft className="h-3.5 w-3.5 shrink-0" />
|
|
<span className="truncate">{selectedCompany?.name ?? "Company"}</span>
|
|
</Link>
|
|
<div className="flex items-center gap-2 px-2 py-1">
|
|
<Settings className="h-4 w-4 text-muted-foreground shrink-0" />
|
|
<span className="flex-1 truncate text-sm font-bold text-foreground">
|
|
Company Settings
|
|
</span>
|
|
</div>
|
|
</div>
|
|
|
|
<nav className="flex-1 min-h-0 overflow-y-auto scrollbar-auto-hide px-3 py-2">
|
|
<div className="px-3 pb-1 text-[11px] font-semibold uppercase tracking-wide text-muted-foreground">
|
|
Company settings
|
|
</div>
|
|
<div className="flex flex-col gap-0.5">
|
|
<SidebarNavItem to="/company/settings" label="General" icon={SlidersHorizontal} end />
|
|
<SidebarNavItem
|
|
to="/company/settings/environments"
|
|
label="Environments"
|
|
icon={MonitorCog}
|
|
end
|
|
/>
|
|
{showCloudUpstream ? (
|
|
<SidebarNavItem
|
|
to="/company/settings/cloud-upstream"
|
|
label="Cloud upstream"
|
|
icon={CloudUpload}
|
|
end
|
|
/>
|
|
) : null}
|
|
<SidebarNavItem
|
|
to="/company/settings/members"
|
|
label="Members"
|
|
icon={Users}
|
|
badge={badges?.joinRequests ?? 0}
|
|
end
|
|
/>
|
|
{companySettingsPluginSlots
|
|
.filter((slot) => slot.routePath)
|
|
.map((slot) => (
|
|
<SidebarNavItem
|
|
key={`${slot.pluginKey}:${slot.id}`}
|
|
to={`/company/settings/${slot.routePath}`}
|
|
label={slot.displayName}
|
|
icon={Puzzle}
|
|
end
|
|
/>
|
|
))}
|
|
<SidebarNavItem to="/company/settings/invites" label="Invites" icon={MailPlus} end />
|
|
<SidebarNavItem to="/company/settings/secrets" label="Secrets" icon={KeyRound} end />
|
|
</div>
|
|
<div className="mt-5 px-3 pb-1 text-[11px] font-semibold uppercase tracking-wide text-muted-foreground">
|
|
Instance settings
|
|
</div>
|
|
<div className="flex flex-col gap-0.5">
|
|
<SidebarNavItem
|
|
to={`${INSTANCE_SETTINGS_PATH_PREFIX}/profile`}
|
|
label="Profile"
|
|
icon={UserRoundPen}
|
|
end
|
|
/>
|
|
<SidebarNavItem
|
|
to={`${INSTANCE_SETTINGS_PATH_PREFIX}/general`}
|
|
label="General"
|
|
icon={SlidersHorizontal}
|
|
end
|
|
/>
|
|
<SidebarNavItem
|
|
to={`${INSTANCE_SETTINGS_PATH_PREFIX}/access`}
|
|
label="Access"
|
|
icon={Shield}
|
|
end
|
|
/>
|
|
<SidebarNavItem
|
|
to={`${INSTANCE_SETTINGS_PATH_PREFIX}/heartbeats`}
|
|
label="Heartbeats"
|
|
icon={Clock3}
|
|
end
|
|
/>
|
|
<SidebarNavItem
|
|
to={`${INSTANCE_SETTINGS_PATH_PREFIX}/experimental`}
|
|
label="Experimental"
|
|
icon={FlaskConical}
|
|
/>
|
|
<SidebarNavItem
|
|
to={`${INSTANCE_SETTINGS_PATH_PREFIX}/plugins`}
|
|
label="Plugins"
|
|
icon={Puzzle}
|
|
/>
|
|
{sidebarPlugins.length > 0 ? (
|
|
<div className="ml-4 mt-1 flex flex-col gap-0.5 border-l border-border/70 pl-3">
|
|
{sidebarPlugins.map((plugin) => (
|
|
<NavLink
|
|
key={plugin.id}
|
|
to={`${INSTANCE_SETTINGS_PATH_PREFIX}/plugins/${plugin.id}`}
|
|
state={SIDEBAR_SCROLL_RESET_STATE}
|
|
className={({ isActive }) =>
|
|
[
|
|
"rounded-md px-2 py-1.5 text-xs transition-colors",
|
|
isActive
|
|
? "bg-accent text-foreground"
|
|
: "text-muted-foreground hover:bg-accent/50 hover:text-foreground",
|
|
].join(" ")
|
|
}
|
|
>
|
|
{plugin.manifestJson.displayName ?? plugin.packageName}
|
|
</NavLink>
|
|
))}
|
|
</div>
|
|
) : null}
|
|
<SidebarNavItem
|
|
to={`${INSTANCE_SETTINGS_PATH_PREFIX}/adapters`}
|
|
label="Adapters"
|
|
icon={Cpu}
|
|
/>
|
|
</div>
|
|
</nav>
|
|
</aside>
|
|
);
|
|
}
|