Skip to content

Commit eb11506

Browse files
t3dotggclaude
andauthored
refactor(web): pass the project record to ProjectFavicon so icons cannot drift (#10714)
Co-authored-by: Claude Fable 5.1 <[email protected]>
1 parent d7a59c6 commit eb11506

12 files changed

Lines changed: 126 additions & 342 deletions

‎apps/web/src/components/ChatView.tsx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8093,10 +8093,7 @@ export default function ChatView(props: ChatViewProps) {
80938093
{...(routeKind === "draft" && draftId ? { draftId } : {})}
80948094
activeThreadTitle={activeThread.title}
80958095
isServerThread={isServerThread}
8096-
activeProjectName={activeProject?.title}
8097-
activeProjectCwd={activeProject?.workspaceRoot ?? null}
8098-
activeProjectFaviconPath={activeProject?.faviconPath ?? null}
8099-
activeProjectIcon={activeProject?.projectIcon ?? null}
8096+
activeProject={activeProject}
81008097
openInCwd={gitCwd}
81018098
activeProjectScripts={activeProjectScripts}
81028099
preferredScriptId={

‎apps/web/src/components/CommandPalette.tsx‎

Lines changed: 5 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -178,16 +178,7 @@ import type { Project } from "../types";
178178
const EMPTY_BROWSE_ENTRIES: FilesystemBrowseResult["entries"] = [];
179179

180180
function projectFavicon(project: Project) {
181-
return (
182-
<ProjectFavicon
183-
environmentId={project.environmentId}
184-
cwd={project.workspaceRoot}
185-
projectName={project.title}
186-
faviconPath={project.faviconPath}
187-
projectIcon={project.projectIcon}
188-
className="size-4"
189-
/>
190-
);
181+
return <ProjectFavicon project={project} className="size-4" />;
191182
}
192183

193184
function getEnvironmentBrowsePlatform(os: string | null | undefined): string {
@@ -927,18 +918,8 @@ function OpenCommandPaletteDialog(props: {
927918
new Map<ProjectId, string>(projects.map((project) => [project.id, project.workspaceRoot])),
928919
[projects],
929920
);
930-
const projectFaviconPathById = useMemo(
931-
() => new Map(projects.map((project) => [project.id, project.faviconPath ?? null] as const)),
932-
[projects],
933-
);
934-
const projectIconByKey = useMemo(
935-
() =>
936-
new Map(
937-
projects.map(
938-
(project) =>
939-
[`${project.environmentId}:${project.id}`, project.projectIcon ?? null] as const,
940-
),
941-
),
921+
const projectByKey = useMemo(
922+
() => new Map(projects.map((project) => [`${project.environmentId}:${project.id}`, project])),
942923
[projects],
943924
);
944925
const projectTitleById = useMemo(
@@ -1174,12 +1155,7 @@ function OpenCommandPaletteDialog(props: {
11741155
) ?? null;
11751156
return (
11761157
<ThreadCommandSubtitle
1177-
environmentId={thread.environmentId}
1178-
projectCwd={projectCwdById.get(thread.projectId) ?? null}
1179-
projectFaviconPath={projectFaviconPathById.get(thread.projectId) ?? null}
1180-
projectIcon={
1181-
projectIconByKey.get(`${thread.environmentId}:${thread.projectId}`) ?? null
1182-
}
1158+
project={projectByKey.get(`${thread.environmentId}:${thread.projectId}`) ?? null}
11831159
projectTitle={projectTitle ?? null}
11841160
branch={thread.branch}
11851161
worktreePath={thread.worktreePath}
@@ -1217,9 +1193,7 @@ function OpenCommandPaletteDialog(props: {
12171193
activeThreadId,
12181194
clientSettings.sidebarThreadSortOrder,
12191195
navigate,
1220-
projectCwdById,
1221-
projectFaviconPathById,
1222-
projectIconByKey,
1196+
projectByKey,
12231197
projectTitleById,
12241198
providerEntryByEnvironmentAndInstanceId,
12251199
threadContentMatchByKey,

‎apps/web/src/components/LegacySidebar.tsx‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2322,13 +2322,7 @@ const SidebarProjectItem = memo(function SidebarProjectItem(props: SidebarProjec
23222322
/>
23232323
)}
23242324
<span className="flex shrink-0">
2325-
<ProjectFavicon
2326-
environmentId={project.environmentId}
2327-
cwd={project.workspaceRoot}
2328-
projectName={project.title}
2329-
faviconPath={project.faviconPath}
2330-
projectIcon={project.projectIcon}
2331-
/>
2325+
<ProjectFavicon project={project} />
23322326
</span>
23332327
<span className="flex min-w-0 flex-1 items-center gap-2">
23342328
<span className="truncate text-sm font-medium text-sidebar-foreground/90">

‎apps/web/src/components/ProjectFavicon.test.tsx‎

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,14 @@ vi.mock("../state/assets", () => ({
6666
},
6767
}));
6868

69-
import { ProjectFavicon } from "./ProjectFavicon";
69+
import { ProjectFavicon, type ProjectFaviconProject } from "./ProjectFavicon";
70+
71+
function makeProject(
72+
overrides: Partial<ProjectFaviconProject> &
73+
Pick<ProjectFaviconProject, "workspaceRoot" | "title">,
74+
): ProjectFaviconProject {
75+
return { environmentId: "environment-test" as EnvironmentId, ...overrides };
76+
}
7077

7178
type ProjectFaviconImageProps = {
7279
readonly cacheKey: string;
@@ -91,9 +98,7 @@ function resolveImageComponent(): {
9198
} {
9299
hooks.beginRender();
93100
const element = ProjectFavicon({
94-
environmentId: "environment-test" as EnvironmentId,
95-
cwd: "/workspace-test",
96-
projectName: "workspace-test",
101+
project: makeProject({ workspaceRoot: "/workspace-test", title: "workspace-test" }),
97102
}) as ReactElement<ProjectFaviconImageProps>;
98103
hooks.reset();
99104

@@ -121,9 +126,7 @@ describe("ProjectFavicon", () => {
121126
testState.faviconUrl = `https://environment.test/api/assets/token/${PROJECT_FAVICON_FALLBACK_MARKER}`;
122127

123128
const element = ProjectFavicon({
124-
environmentId: "environment-test" as EnvironmentId,
125-
cwd: "/workspace/analytics-db",
126-
projectName: "analytics-db",
129+
project: makeProject({ workspaceRoot: "/workspace/analytics-db", title: "analytics-db" }),
127130
}) as ReactElement<{
128131
readonly colorClassName?: string;
129132
readonly emoji?: string;
@@ -139,9 +142,7 @@ describe("ProjectFavicon", () => {
139142
testState.faviconUrl = `https://environment.test/api/assets/token/${PROJECT_FAVICON_FALLBACK_MARKER}`;
140143

141144
const element = ProjectFavicon({
142-
environmentId: "environment-test" as EnvironmentId,
143-
cwd: "/workspace/agent-runtime",
144-
projectName: "agent-runtime",
145+
project: makeProject({ workspaceRoot: "/workspace/agent-runtime", title: "agent-runtime" }),
145146
}) as ReactElement<{
146147
readonly colorClassName?: string;
147148
readonly emoji?: string;
@@ -155,11 +156,12 @@ describe("ProjectFavicon", () => {
155156

156157
it("renders a saved Lucide icon and color ahead of an uploaded favicon", () => {
157158
const element = ProjectFavicon({
158-
environmentId: "environment-test" as EnvironmentId,
159-
cwd: "/workspace/test",
160-
projectName: "test",
161-
faviconPath: "brand/icon.svg",
162-
projectIcon: { kind: "lucide", name: "alarm-clock", color: "violet" },
159+
project: makeProject({
160+
workspaceRoot: "/workspace/test",
161+
title: "test",
162+
faviconPath: "brand/icon.svg",
163+
projectIcon: { kind: "lucide", name: "alarm-clock", color: "violet" },
164+
}),
163165
}) as ReactElement<{
164166
readonly children: ReactElement<{
165167
readonly children: ReactElement<{ readonly name: string; readonly className: string }>;
@@ -174,11 +176,12 @@ describe("ProjectFavicon", () => {
174176

175177
it("renders a saved emoji ahead of an uploaded favicon", () => {
176178
const element = ProjectFavicon({
177-
environmentId: "environment-test" as EnvironmentId,
178-
cwd: "/workspace/test",
179-
projectName: "test",
180-
faviconPath: "brand/icon.svg",
181-
projectIcon: { kind: "emoji", emoji: "🦄" },
179+
project: makeProject({
180+
workspaceRoot: "/workspace/test",
181+
title: "test",
182+
faviconPath: "brand/icon.svg",
183+
projectIcon: { kind: "emoji", emoji: "🦄" },
184+
}),
182185
}) as ReactElement<{ readonly emoji: string }>;
183186

184187
expect(element.props.emoji).toBe("🦄");
@@ -208,10 +211,11 @@ describe("ProjectFavicon", () => {
208211

209212
it("requests a saved favicon path when one is set", () => {
210213
ProjectFavicon({
211-
environmentId: "environment-test" as EnvironmentId,
212-
cwd: "/workspace-test",
213-
projectName: "workspace-test",
214-
faviconPath: "brand/icon.svg",
214+
project: makeProject({
215+
workspaceRoot: "/workspace-test",
216+
title: "workspace-test",
217+
faviconPath: "brand/icon.svg",
218+
}),
215219
});
216220

217221
expect(testState.lastTarget).toMatchObject({

‎apps/web/src/components/ProjectFavicon.tsx‎

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
import type { EnvironmentId, ProjectIconColor, ProjectIconOverride } from "@t3tools/contracts";
1+
import type { ProjectIconColor } from "@t3tools/contracts";
2+
import type { EnvironmentProject } from "@t3tools/client-runtime/state/shell";
23
import {
34
getProjectFaviconResourceKey,
45
isProjectFaviconFallbackUrl,
@@ -94,21 +95,33 @@ const PROJECT_ICON_COLOR_BY_NAME: Record<ProjectIconName, ProjectIconColor> = {
9495
web: "sky",
9596
};
9697

98+
// The slice of a project that decides its icon. Every surface must pass the
99+
// project record itself (or a snapshot spread from it) so the saved title, favicon
100+
// and icon override always travel together. Passing a display label as the title
101+
// changes the automatic icon, which is how the command palette drifted once.
102+
export type ProjectFaviconProject = Pick<
103+
EnvironmentProject,
104+
"environmentId" | "workspaceRoot" | "title" | "faviconPath" | "projectIcon"
105+
>;
106+
97107
export function ProjectFavicon(input: {
98-
environmentId: EnvironmentId;
99-
cwd: string;
100-
projectName: string;
101-
faviconPath?: string | null | undefined;
102-
projectIcon?: ProjectIconOverride | null | undefined;
108+
project: ProjectFaviconProject;
103109
className?: string | undefined;
104110
fallbackIcon?: ComponentType<{ className?: string }>;
105111
}) {
106-
const src = useAtomValue(projectFaviconUrlAtom(input));
107-
if (input.projectIcon?.kind === "emoji") {
108-
return <ProjectFaviconFallback className={input.className} emoji={input.projectIcon.emoji} />;
112+
const { project } = input;
113+
const src = useAtomValue(
114+
projectFaviconUrlAtom({
115+
environmentId: project.environmentId,
116+
cwd: project.workspaceRoot,
117+
faviconPath: project.faviconPath,
118+
}),
119+
);
120+
if (project.projectIcon?.kind === "emoji") {
121+
return <ProjectFaviconFallback className={input.className} emoji={project.projectIcon.emoji} />;
109122
}
110-
if (input.projectIcon?.kind === "lucide") {
111-
const colorClassName = projectIconColorClassName(input.projectIcon.color);
123+
if (project.projectIcon?.kind === "lucide") {
124+
const colorClassName = projectIconColorClassName(project.projectIcon.color);
112125
const iconClassName = cn(
113126
"inline-flex size-3.5 shrink-0 items-center justify-center",
114127
colorClassName,
@@ -118,7 +131,7 @@ export function ProjectFavicon(input: {
118131
<span aria-hidden="true" className={iconClassName}>
119132
<Suspense fallback={<DynamicProjectIconFallback />}>
120133
<DynamicIcon
121-
name={input.projectIcon.name as IconName}
134+
name={project.projectIcon.name as IconName}
122135
className={cn("size-full", colorClassName)}
123136
fallback={DynamicProjectIconFallback}
124137
/>
@@ -128,7 +141,7 @@ export function ProjectFavicon(input: {
128141
}
129142
const automaticIconName = input.fallbackIcon
130143
? null
131-
: selectProjectIcon(input.projectName, input.cwd);
144+
: selectProjectIcon(project.title, project.workspaceRoot);
132145
const FallbackIcon =
133146
input.fallbackIcon ??
134147
(automaticIconName?.kind === "lucide" ? PROJECT_ICONS[automaticIconName.icon] : undefined);
@@ -149,7 +162,11 @@ export function ProjectFavicon(input: {
149162
);
150163
}
151164

152-
const cacheKey = getProjectFaviconResourceKey(input.environmentId, input.cwd, input.faviconPath);
165+
const cacheKey = getProjectFaviconResourceKey(
166+
project.environmentId,
167+
project.workspaceRoot,
168+
project.faviconPath,
169+
);
153170

154171
return (
155172
<ProjectFaviconImage

0 commit comments

Comments
 (0)