Skip to content

Commit b48befb

Browse files
committed
fix(server): missing project folders no longer log favicon warnings
A moved or deleted project checkout has no icon to find, so failing to resolve one is expected and not worth a server warning. Signed-off-by: Yordis Prieto <[email protected]>
1 parent a183091 commit b48befb

3 files changed

Lines changed: 68 additions & 0 deletions

File tree

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

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,13 @@ import type { RepositoryIdentity } from "@t3tools/contracts";
33
import * as Deferred from "effect/Deferred";
44
import * as Effect from "effect/Effect";
55
import * as Layer from "effect/Layer";
6+
import * as Logger from "effect/Logger";
67
import * as PubSub from "effect/PubSub";
78
import * as Ref from "effect/Ref";
89
import { TestClock } from "effect/testing";
910

11+
import * as WorkspacePaths from "../workspace/WorkspacePaths.ts";
12+
1013
import * as ProjectEnrichment from "./ProjectEnrichmentService.ts";
1114
import * as ProjectFaviconResolver from "./ProjectFaviconResolver.ts";
1215
import * as RepositoryIdentityResolver from "./RepositoryIdentityResolver.ts";
@@ -95,6 +98,58 @@ it.effect("preserves either enrichment field when the other resolver fails", ()
9598
}),
9699
);
97100

101+
it.effect("does not warn about favicons for workspace roots that no longer exist", () =>
102+
Effect.gen(function* () {
103+
const warnings: Array<unknown> = [];
104+
const logger = Logger.make(({ message }) => {
105+
warnings.push(message);
106+
});
107+
const metadataLayer = Layer.merge(
108+
Layer.succeed(RepositoryIdentityResolver.RepositoryIdentityResolver, {
109+
resolve: (workspaceRoot) => Effect.succeed(identity(workspaceRoot)),
110+
}),
111+
Layer.succeed(ProjectFaviconResolver.ProjectFaviconResolver, {
112+
resolvePath: (workspaceRoot) =>
113+
Effect.fail(
114+
workspaceRoot === "/missing"
115+
? new ProjectFaviconResolver.ProjectFaviconResolutionError({
116+
operation: "normalize-workspace",
117+
workspaceRoot,
118+
cause: new WorkspacePaths.WorkspaceRootNotExistsError({
119+
workspaceRoot,
120+
normalizedWorkspaceRoot: workspaceRoot,
121+
}),
122+
})
123+
: new ProjectFaviconResolver.ProjectFaviconResolutionError({
124+
operation: "stat-candidate",
125+
workspaceRoot,
126+
cause: "favicon resolver failed",
127+
}),
128+
),
129+
}),
130+
);
131+
132+
yield* Effect.gen(function* () {
133+
const service = yield* ProjectEnrichment.ProjectEnrichmentService;
134+
yield* service.request("/missing");
135+
yield* service.request("/broken");
136+
137+
for (let attempt = 0; attempt < 100 && warnings.length === 0; attempt += 1) {
138+
yield* Effect.yieldNow;
139+
}
140+
141+
assert.lengthOf(warnings, 1);
142+
assert.nestedPropertyVal(warnings[0], "[1].workspaceRoot", "/broken");
143+
}).pipe(
144+
Effect.provide(
145+
layer(metadataLayer, { concurrency: 1 }).pipe(
146+
Layer.provide(Logger.layer([logger], { mergeWithExisting: false })),
147+
),
148+
),
149+
);
150+
}),
151+
);
152+
98153
it.effect("publishes repository completion while favicon enrichment is still pending", () =>
99154
Effect.gen(function* () {
100155
const releaseFavicon = yield* Deferred.make<void>();

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,13 @@ export const make = Effect.fn("ProjectEnrichmentService.make")(function* (
192192
workspaceRoot: string,
193193
) {
194194
const faviconPath = yield* Cache.get(faviconCache, workspaceRoot);
195+
const isMissingWorkspaceRoot = Option.exists(
196+
Exit.findErrorOption(faviconPath),
197+
ProjectFaviconResolver.isMissingWorkspaceRoot,
198+
);
199+
if (isMissingWorkspaceRoot) {
200+
return;
201+
}
195202
yield* logFailure(workspaceRoot, "faviconPath", faviconPath);
196203
});
197204

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,12 @@ export class ProjectFaviconResolutionError extends Schema.TaggedError<ProjectFav
111111
}
112112
}
113113

114+
const isWorkspaceRootNotExistsError = Schema.is(WorkspacePaths.WorkspaceRootNotExistsError);
115+
116+
/** True when the workspace root itself is gone, e.g. a moved or deleted checkout. */
117+
export const isMissingWorkspaceRoot = (error: ProjectFaviconResolutionError): boolean =>
118+
error.operation === "normalize-workspace" && isWorkspaceRootNotExistsError(error.cause);
119+
114120
/** Service tag for project favicon resolution. */
115121
export class ProjectFaviconResolver extends Context.Service<
116122
ProjectFaviconResolver,

0 commit comments

Comments
 (0)