Skip to content

Commit 4f555c7

Browse files
AlexSandilandsmaria-rcksjuliusmarminge
authored
fix(web): choosing a project icon again re-reads it from disk (#28584)
Co-authored-by: maria-rcks <[email protected]> Co-authored-by: Julius Marminge <[email protected]>
1 parent 96aa40e commit 4f555c7

6 files changed

Lines changed: 128 additions & 5 deletions

File tree

‎apps/server/src/project/ProjectService.test.ts‎

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import { CommandId, type Project, ProjectId, ProviderInstanceId } from "@t3tools
99
import * as Deferred from "effect/Deferred";
1010
import * as Effect from "effect/Effect";
1111
import * as Fiber from "effect/Fiber";
12+
import * as FileSystem from "effect/FileSystem";
1213
import * as Layer from "effect/Layer";
1314
import * as Metric from "effect/Metric";
1415
import * as Option from "effect/Option";
@@ -36,6 +37,7 @@ import * as ProjectEnrichmentService from "./ProjectEnrichmentService.ts";
3637
import * as ProjectFaviconResolver from "./ProjectFaviconResolver.ts";
3738
import * as ProjectService from "./ProjectService.ts";
3839
import * as RepositoryIdentityResolver from "./RepositoryIdentityResolver.ts";
40+
import * as T3ProjectFileLoader from "./T3ProjectFileLoader.ts";
3941

4042
const layerWorkspacePaths = Layer.succeed(WorkspacePaths.WorkspacePaths, {
4143
normalizeWorkspaceRoot: (workspaceRoot) => Effect.succeed(workspaceRoot.replace(/\/$/, "")),
@@ -300,7 +302,14 @@ it.layer(layerTest)("ProjectService", (it) => {
300302
});
301303
assert.isFalse(reset.autoPull);
302304
assert.isNull(reset.projectIcon);
303-
assert.equal(reset.faviconPath, hydratedCreated.faviconPath);
305+
assert.equal(
306+
(yield* waitForProject(
307+
service,
308+
projectId,
309+
(project) => project.faviconPath === hydratedCreated.faviconPath,
310+
)).faviconPath,
311+
hydratedCreated.faviconPath,
312+
);
304313
assert.isNull(reset.defaultThreadEnvMode);
305314
assert.deepEqual(
306315
(yield* service.snapshot).projects.map((project) => project.id),
@@ -725,6 +734,49 @@ it.effect("invalidates workspace-derived metadata when a project moves", () =>
725734
}),
726735
);
727736

737+
it.effect("resolves a restored icon immediately after reselecting its saved path", () =>
738+
Effect.gen(function* () {
739+
const fileSystem = yield* FileSystem.FileSystem;
740+
const cwd = yield* fileSystem.makeTempDirectoryScoped({ prefix: "project-icon-reselect-" });
741+
const iconPath = `${cwd}/icon.svg`;
742+
const metadata = Layer.merge(
743+
Layer.succeed(RepositoryIdentityResolver.RepositoryIdentityResolver, {
744+
resolve: () => Effect.succeed(null),
745+
}),
746+
ProjectFaviconResolver.layer.pipe(
747+
Layer.provide(layerWorkspacePaths),
748+
Layer.provide(T3ProjectFileLoader.layer),
749+
Layer.provide(NodeServices.layer),
750+
),
751+
);
752+
yield* Effect.gen(function* () {
753+
const service = yield* ProjectService.ProjectService;
754+
const resolver = yield* ProjectFaviconResolver.ProjectFaviconResolver;
755+
const projectId = ProjectId.make("project:icon-reselect");
756+
yield* service.create({
757+
commandId: CommandId.make("command:icon-reselect:create"),
758+
projectId,
759+
title: "Icon reselection",
760+
workspaceRoot: cwd,
761+
});
762+
yield* service.update({
763+
commandId: CommandId.make("command:icon-reselect:missing"),
764+
projectId,
765+
faviconPath: "icon.svg",
766+
});
767+
assert.isNull(yield* resolver.resolvePath(cwd, "icon.svg"));
768+
yield* fileSystem.writeFileString(iconPath, '<svg xmlns="http://www.w3.org/2000/svg"/>');
769+
assert.isNull(yield* resolver.resolvePath(cwd, "icon.svg"));
770+
yield* service.update({
771+
commandId: CommandId.make("command:icon-reselect:restored"),
772+
projectId,
773+
faviconPath: "icon.svg",
774+
});
775+
assert.equal(yield* resolver.resolvePath(cwd, "icon.svg"), iconPath);
776+
}).pipe(Effect.provide(layerTestFor(metadata)));
777+
}).pipe(Effect.provide(NodeServices.layer)),
778+
);
779+
728780
it.effect("serializes two projects claiming the same workspace root", () =>
729781
Effect.gen(function* () {
730782
const eventSink = yield* EventSink.EventSinkV2;

‎apps/server/src/project/ProjectService.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ export const make = Effect.gen(function* () {
429429
...(input.pinned === undefined ? {} : { pinned: input.pinned }),
430430
...(input.archived === undefined ? {} : { archived: input.archived }),
431431
});
432-
if (workspaceRoot !== previousRoot) {
432+
if (workspaceRoot !== previousRoot || input.faviconPath !== undefined) {
433433
yield* projectEnrichment.invalidate([previousRoot, workspaceRoot]);
434434
}
435435
return yield* readCommitted(input.projectId);

‎apps/web/src/components/settings/ProjectSettingsPanel.browser.test.tsx‎

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ const state = vi.hoisted(() => ({
3939
(request: {
4040
environmentId: EnvironmentId;
4141
input: UpdateProjectInput;
42-
}) => Promise<AsyncResult.Success<void>>
42+
}) => Promise<AsyncResult.Success<void> | AsyncResult.Failure<void, Error>>
4343
>(),
4444
delete:
4545
vi.fn<
@@ -134,6 +134,7 @@ vi.mock(import("../files/projectFilesQueryState"), async (original) => ({
134134

135135
import { useComposerDraftStore } from "../../composerDraftStore";
136136
import { appAtomRegistry } from "../../rpc/atomRegistry";
137+
import { assetEnvironment } from "../../state/assets";
137138
import { buildSidebarProjectSnapshots } from "../../sidebarProjectGrouping";
138139
import { ProjectSettingsPanel } from "./ProjectSettingsPanel";
139140
import { ProjectsSettings } from "./ProjectsSettings";
@@ -532,6 +533,40 @@ describe("project identity reset", () => {
532533
},
533534
]);
534535
});
536+
537+
it("refreshes a saved checkout's icon when a later checkout update fails", async () => {
538+
setup();
539+
state.projects = state.projects.map((project) => ({ ...project, faviconPath: "logo.png" }));
540+
let iconExists = false;
541+
const iconUrl = Atom.make(() =>
542+
AsyncResult.success({
543+
expiresAt: 4_000_000_000_000,
544+
relativeUrl: iconExists ? "/restored-icon.svg" : "/project-favicon-missing",
545+
}),
546+
);
547+
using _mount = { [Symbol.dispose]: appAtomRegistry.mount(iconUrl) };
548+
const createUrl = assetEnvironment.createUrl;
549+
using _createUrl = vi
550+
.spyOn(assetEnvironment, "createUrl")
551+
.mockImplementation((target) =>
552+
target.environmentId === primaryId ? iconUrl : createUrl(target),
553+
);
554+
state.update
555+
.mockResolvedValueOnce(AsyncResult.success(undefined))
556+
.mockResolvedValueOnce(AsyncResult.failure(Cause.fail(new Error("Save failed"))));
557+
await using screen = await mountPanel();
558+
expect(appAtomRegistry.get(iconUrl).value.relativeUrl).toBe("/project-favicon-missing");
559+
560+
iconExists = true;
561+
await userEvent.click(resetButton(screen, "project icon")!);
562+
563+
await vi.waitFor(() =>
564+
expect(appAtomRegistry.get(iconUrl).value.relativeUrl).toBe("/restored-icon.svg"),
565+
);
566+
expect(state.toast).toHaveBeenCalledWith(
567+
expect.objectContaining({ title: "Failed to update project icon on remote" }),
568+
);
569+
});
535570
});
536571

537572
it("opens the fallback search target across all environments from a checkout", async () => {

‎apps/web/src/components/settings/ProjectSettingsPanel.tsx‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ import {
2929
} from "../../sidebarProjectGrouping";
3030
import { useEnvironments, usePrimaryEnvironmentId } from "../../state/environments";
3131
import { useThreadShells, waitForProjectRemoval } from "../../state/entities";
32+
import { refreshProjectFaviconUrl } from "../../state/assets";
3233
import { projectEnvironment } from "../../state/projects";
3334
import { ProjectFavicon } from "../ProjectFavicon";
3435
import { Alert, AlertDescription } from "../ui/alert";
@@ -331,6 +332,15 @@ function ProjectDetail({
331332
savingFaviconRef.current = true;
332333
setIsSavingFavicon(true);
333334
await updateAllMembers(input, "Failed to update project icon");
335+
for (const member of group.memberProjects) {
336+
const update = typeof input === "function" ? input(member) : input;
337+
if (update.faviconPath === undefined || update.projectIcon) continue;
338+
refreshProjectFaviconUrl({
339+
environmentId: member.environmentId,
340+
cwd: member.workspaceRoot,
341+
faviconPath: update.faviconPath,
342+
});
343+
}
334344
savingFaviconRef.current = false;
335345
setIsSavingFavicon(false);
336346
};

‎apps/web/src/state/assets.ts‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1+
import type { ProjectFaviconTarget } from "@t3tools/client-runtime/project-favicon-cache";
12
import {
23
createAssetEnvironmentAtoms,
34
createProjectFaviconUrlAtomFamily,
5+
projectFaviconResource,
46
} from "@t3tools/client-runtime/state/assets";
57
import { Atom } from "effect/reactivity";
68

79
import { connectionAtomRuntime } from "../connection/runtime";
10+
import { appAtomRegistry } from "../rpc/atomRegistry";
811
import { projectFaviconCache } from "../assets/projectFaviconCache";
912
import { isElectron } from "../env";
1013
import { primaryEnvironmentIdAtom } from "./primaryEnvironment";
@@ -33,3 +36,16 @@ export const projectFaviconUrlAtom = createProjectFaviconUrlAtomFamily({
3336
preparedConnection: environmentSession.preparedConnectionValueAtom,
3437
projectClones: environmentProjectClonesAtom,
3538
});
39+
40+
/**
41+
* Asks the server for a project's icon again. Choosing the icon path a project had before would
42+
* otherwise reuse that path's cached URL, which says "missing" if the file did not exist then.
43+
*/
44+
export function refreshProjectFaviconUrl(target: ProjectFaviconTarget) {
45+
appAtomRegistry.refresh(
46+
assetEnvironment.createUrl({
47+
environmentId: target.environmentId,
48+
input: { resource: projectFaviconResource(target.cwd, target.faviconPath) },
49+
}),
50+
);
51+
}

‎packages/client-runtime/src/state/assets.ts‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,14 @@ export function createAssetEnvironmentAtoms<R, E>(
323323
};
324324
}
325325

326+
/**
327+
* The resource a project's icon URL is minted for. Refreshing the `createUrl` query for it makes
328+
* the server resolve the icon again instead of serving a cached answer.
329+
*/
330+
export function projectFaviconResource(cwd: string, path: string | null | undefined) {
331+
return { _tag: "project-favicon" as const, cwd, ...(path ? { path } : {}) };
332+
}
333+
326334
export function createProjectFaviconUrlAtomFamily(input: {
327335
readonly imageCache?: ProjectFaviconCache;
328336
readonly createUrl: (target: {
@@ -342,8 +350,10 @@ export function createProjectFaviconUrlAtomFamily(input: {
342350
const projectClones = input.projectClones;
343351
const family = Atom.family((key: string) => {
344352
const [environmentId, cwd, path] = decodeKey(JSON.parse(key));
345-
const resource = { _tag: "project-favicon" as const, cwd, ...(path ? { path } : {}) };
346-
const query = input.createUrl({ environmentId, input: { resource } });
353+
const query = input.createUrl({
354+
environmentId,
355+
input: { resource: projectFaviconResource(cwd, path) },
356+
});
347357
// A cloned project exists before its files do, and the server reports its
348358
// icon missing until the clone lands. Ask again whenever the clone's phase
349359
// changes: the first list a client sees may already say done.

0 commit comments

Comments
 (0)