[codex] Move instance settings under company settings (#7680)
## 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>
This commit is contained in:
Dotta
@@ -21,6 +21,7 @@ const BOARD_ROUTE_ROOTS = new Set([
|
||||
"u",
|
||||
"design-guide",
|
||||
"search",
|
||||
"settings",
|
||||
]);
|
||||
|
||||
const GLOBAL_ROUTE_ROOTS = new Set(["auth", "invite", "board-claim", "cli-auth", "docs", "instance"]);
|
||||
|
||||
@@ -5,15 +5,30 @@ import {
|
||||
} from "./instance-settings";
|
||||
|
||||
describe("normalizeRememberedInstanceSettingsPath", () => {
|
||||
it("keeps known instance settings pages", () => {
|
||||
it("canonicalizes known instance settings pages under company settings", () => {
|
||||
expect(normalizeRememberedInstanceSettingsPath("/instance/settings/general")).toBe(
|
||||
"/instance/settings/general",
|
||||
"/company/settings/instance/general",
|
||||
);
|
||||
expect(normalizeRememberedInstanceSettingsPath("/instance/settings/experimental")).toBe(
|
||||
"/instance/settings/experimental",
|
||||
"/company/settings/instance/experimental",
|
||||
);
|
||||
expect(normalizeRememberedInstanceSettingsPath("/instance/settings/plugins/example?tab=config#logs")).toBe(
|
||||
"/instance/settings/plugins/example?tab=config#logs",
|
||||
"/company/settings/instance/plugins/example?tab=config#logs",
|
||||
);
|
||||
expect(normalizeRememberedInstanceSettingsPath("/PAP/company/settings/instance/adapters")).toBe(
|
||||
"/company/settings/instance/adapters",
|
||||
);
|
||||
expect(normalizeRememberedInstanceSettingsPath("/company/settings/instance/general")).toBe(
|
||||
"/company/settings/instance/general",
|
||||
);
|
||||
expect(normalizeRememberedInstanceSettingsPath("/company/settings/instance/plugins/example?tab=config#logs")).toBe(
|
||||
"/company/settings/instance/plugins/example?tab=config#logs",
|
||||
);
|
||||
expect(normalizeRememberedInstanceSettingsPath("/settings/access?tab=users#admins")).toBe(
|
||||
"/company/settings/instance/access?tab=users#admins",
|
||||
);
|
||||
expect(normalizeRememberedInstanceSettingsPath("/PAP/settings/plugins/example")).toBe(
|
||||
"/company/settings/instance/plugins/example",
|
||||
);
|
||||
});
|
||||
|
||||
|
||||
@@ -1,24 +1,77 @@
|
||||
export const DEFAULT_INSTANCE_SETTINGS_PATH = "/instance/settings/general";
|
||||
export const INSTANCE_SETTINGS_PATH_PREFIX = "/company/settings/instance";
|
||||
export const DEFAULT_INSTANCE_SETTINGS_PATH = `${INSTANCE_SETTINGS_PATH_PREFIX}/general`;
|
||||
|
||||
const LEGACY_INSTANCE_SETTINGS_PATH_PREFIX = "/instance/settings";
|
||||
const LEGACY_SETTINGS_PATH_PREFIX = "/settings";
|
||||
|
||||
function splitPath(rawPath: string): { pathname: string; search: string; hash: string } {
|
||||
const match = rawPath.match(/^([^?#]*)(\?[^#]*)?(#.*)?$/);
|
||||
return {
|
||||
pathname: match?.[1] ?? rawPath,
|
||||
search: match?.[2] ?? "",
|
||||
hash: match?.[3] ?? "",
|
||||
};
|
||||
}
|
||||
|
||||
function normalizePathForMatching(rawPath: string): { pathname: string; search: string; hash: string } {
|
||||
const { pathname, search, hash } = splitPath(rawPath);
|
||||
const segments = pathname.split("/").filter(Boolean);
|
||||
const first = segments[0]?.toLowerCase();
|
||||
const second = segments[1]?.toLowerCase();
|
||||
|
||||
if (first === "company") {
|
||||
return { pathname: `/${segments.join("/")}`, search, hash };
|
||||
}
|
||||
|
||||
if (second === "company" || second === "settings" || second === "instance") {
|
||||
return { pathname: `/${segments.slice(1).join("/")}`, search, hash };
|
||||
}
|
||||
|
||||
return { pathname, search, hash };
|
||||
}
|
||||
|
||||
function instanceSettingsSuffix(pathname: string): string | null {
|
||||
if (pathname === INSTANCE_SETTINGS_PATH_PREFIX) return "/general";
|
||||
if (pathname.startsWith(`${INSTANCE_SETTINGS_PATH_PREFIX}/`)) {
|
||||
return pathname.slice(INSTANCE_SETTINGS_PATH_PREFIX.length);
|
||||
}
|
||||
|
||||
if (pathname === LEGACY_INSTANCE_SETTINGS_PATH_PREFIX || pathname === "/instance") {
|
||||
return "/general";
|
||||
}
|
||||
if (pathname.startsWith(`${LEGACY_INSTANCE_SETTINGS_PATH_PREFIX}/`)) {
|
||||
return pathname.slice(LEGACY_INSTANCE_SETTINGS_PATH_PREFIX.length);
|
||||
}
|
||||
|
||||
if (pathname === LEGACY_SETTINGS_PATH_PREFIX) return "/general";
|
||||
if (pathname.startsWith(`${LEGACY_SETTINGS_PATH_PREFIX}/`)) {
|
||||
return pathname.slice(LEGACY_SETTINGS_PATH_PREFIX.length);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
export function normalizeRememberedInstanceSettingsPath(rawPath: string | null): string {
|
||||
if (!rawPath) return DEFAULT_INSTANCE_SETTINGS_PATH;
|
||||
|
||||
const match = rawPath.match(/^([^?#]*)(\?[^#]*)?(#.*)?$/);
|
||||
const pathname = match?.[1] ?? rawPath;
|
||||
const search = match?.[2] ?? "";
|
||||
const hash = match?.[3] ?? "";
|
||||
const { pathname, search, hash } = normalizePathForMatching(rawPath);
|
||||
const suffix = instanceSettingsSuffix(pathname);
|
||||
if (!suffix) return DEFAULT_INSTANCE_SETTINGS_PATH;
|
||||
|
||||
if (
|
||||
pathname === "/instance/settings/general" ||
|
||||
pathname === "/instance/settings/heartbeats" ||
|
||||
pathname === "/instance/settings/plugins" ||
|
||||
pathname === "/instance/settings/experimental"
|
||||
suffix === "/profile" ||
|
||||
suffix === "/general" ||
|
||||
suffix === "/access" ||
|
||||
suffix === "/heartbeats" ||
|
||||
suffix === "/plugins" ||
|
||||
suffix === "/experimental" ||
|
||||
suffix === "/adapters"
|
||||
) {
|
||||
return `${pathname}${search}${hash}`;
|
||||
return `${INSTANCE_SETTINGS_PATH_PREFIX}${suffix}${search}${hash}`;
|
||||
}
|
||||
|
||||
if (/^\/instance\/settings\/plugins\/[^/?#]+$/.test(pathname)) {
|
||||
return `${pathname}${search}${hash}`;
|
||||
if (/^\/plugins\/[^/?#]+$/.test(suffix)) {
|
||||
return `${INSTANCE_SETTINGS_PATH_PREFIX}${suffix}${search}${hash}`;
|
||||
}
|
||||
|
||||
return DEFAULT_INSTANCE_SETTINGS_PATH;
|
||||
|
||||
Reference in New Issue
Block a user