Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions apps/server/src/project/ProjectFaviconResolver.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,75 @@ it.layer(TestLayer)("ProjectFaviconResolverLive", (it) => {
}),
);

it.effect("probes well-known candidates concurrently", () =>
Effect.gen(function* () {
const fileSystem = yield* FileSystem.FileSystem;
const cwd = yield* makeTempDir;
let inFlight = 0;
let peakInFlight = 0;
const resolver = yield* makeResolverWithFileSystem(
FileSystem.FileSystem.of({
...fileSystem,
stat: (filePath) =>
Effect.suspend(() => {
inFlight += 1;
peakInFlight = Math.max(peakInFlight, inFlight);
return Effect.yieldNow.pipe(Effect.andThen(fileSystem.stat(filePath)));
}).pipe(Effect.ensuring(Effect.sync(() => (inFlight -= 1)))),
}),
);

expect(yield* resolver.resolvePath(cwd)).toBeNull();
expect(peakInFlight).toBeGreaterThan(1);
}),
);

it.effect("returns a found favicon without waiting for lower-ranked probes", () =>
Effect.gen(function* () {
const fileSystem = yield* FileSystem.FileSystem;
const path = yield* Path.Path;
const cwd = yield* makeTempDir;
yield* writeTextFile(cwd, "favicon.svg", "<svg>root</svg>");
const stuckPath = path.join(cwd, "favicon.ico");
const resolver = yield* makeResolverWithFileSystem(
FileSystem.FileSystem.of({
...fileSystem,
stat: (filePath) => (filePath === stuckPath ? Effect.never : fileSystem.stat(filePath)),
}),
);

expect(yield* resolver.resolvePath(cwd)).toBe(path.join(cwd, "favicon.svg"));
}),
);

it.effect("ignores a failing candidate that ranks below a found favicon", () =>
Effect.gen(function* () {
const fileSystem = yield* FileSystem.FileSystem;
const path = yield* Path.Path;
const cwd = yield* makeTempDir;
yield* writeTextFile(cwd, "favicon.svg", "<svg>root</svg>");
const failingPath = path.join(cwd, "favicon.ico");
const resolver = yield* makeResolverWithFileSystem(
FileSystem.FileSystem.of({
...fileSystem,
stat: (filePath) =>
filePath === failingPath
? Effect.fail(
PlatformError.systemError({
_tag: "PermissionDenied",
module: "FileSystem",
method: "stat",
pathOrDescriptor: failingPath,
}),
)
: fileSystem.stat(filePath),
}),
);

expect(yield* resolver.resolvePath(cwd)).toBe(path.join(cwd, "favicon.svg"));
}),
);

it.effect("preserves icon source read failures", () =>
Effect.gen(function* () {
const fileSystem = yield* FileSystem.FileSystem;
Expand Down
126 changes: 74 additions & 52 deletions apps/server/src/project/ProjectFaviconResolver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import * as Context from "effect/Context";
import * as Duration from "effect/Duration";
import * as Effect from "effect/Effect";
import * as Exit from "effect/Exit";
import * as Fiber from "effect/Fiber";
import * as FileSystem from "effect/FileSystem";
import * as Layer from "effect/Layer";
import * as Option from "effect/Option";
Expand All @@ -21,8 +22,8 @@ import * as Schema from "effect/Schema";
import * as WorkspacePaths from "../workspace/WorkspacePaths.ts";
import * as T3ProjectFileLoader from "./T3ProjectFileLoader.ts";

// Resolution walks up to 12 well-known paths plus 7 source files, so a miss
// costs ~20 filesystem probes. AssetAccess resolves on every project-favicon
// Resolution probes 21 well-known paths plus 7 source files, so a miss
// costs ~30 filesystem probes. AssetAccess resolves on every project-favicon
// asset URL, and a project's icon does not move, so the answer is cached.
const FAVICON_CACHE_CAPACITY = 512;
const FAVICON_POSITIVE_CACHE_TTL = Duration.minutes(10);
Expand Down Expand Up @@ -205,6 +206,69 @@ export const make = Effect.gen(function* () {
return null;
});

// Reads one source file and resolves the icon it declares, if any.
const findIconFromSource = Effect.fn("ProjectFaviconResolver.findIconFromSource")(function* (
projectCwd: string,
sourceFile: string,
): Effect.fn.Return<string | null, ProjectFaviconResolutionError> {
const sourcePath = yield* workspacePaths
.resolveRelativePathWithinRoot({
workspaceRoot: projectCwd,
relativePath: sourceFile,
})
.pipe(
Effect.mapError(
(cause) =>
new ProjectFaviconResolutionError({
operation: "resolve-path",
workspaceRoot: projectCwd,
relativePath: sourceFile,
cause,
}),
),
);
const source = yield* optionOnNotFound(fileSystem.readFileString(sourcePath.absolutePath)).pipe(
Effect.mapError(
(cause) =>
new ProjectFaviconResolutionError({
operation: "read-source",
workspaceRoot: projectCwd,
relativePath: sourceFile,
absolutePath: sourcePath.absolutePath,
cause,
}),
),
);
if (Option.isNone(source)) {
return null;
}
const href = extractIconHref(source.value);
if (!href) {
return null;
}
return yield* findExistingFile(projectCwd, resolveIconHref(href), "workspace");
});

// Starts every probe at once and returns the first hit in list order. A miss
// costs one round of filesystem latency instead of one per probe, which
// matters when the disk is slow. Fibers are joined in order, so a hit returns
// without waiting for lower-ranked probes (the scope interrupts them), and a
// failure surfaces only when no earlier probe found a file.
const firstInOrder = <A>(
items: ReadonlyArray<A>,
probe: (item: A) => Effect.Effect<string | null, ProjectFaviconResolutionError>,
) =>
Effect.gen(function* () {
const fibers = yield* Effect.forEach(items, (item) => Effect.forkScoped(probe(item)));
for (const fiber of fibers) {
const found = yield* Fiber.join(fiber);
if (found) {
return found;
}
}
return null;
}).pipe(Effect.scoped);

const resolvePathUncached = Effect.fn("ProjectFaviconResolver.resolvePathUncached")(function* (
cwd: string,
faviconPath?: string,
Expand Down Expand Up @@ -241,58 +305,16 @@ export const make = Effect.gen(function* () {
}
}

for (const candidate of FAVICON_CANDIDATES) {
const existing = yield* findExistingFile(projectCwd, [candidate], "workspace");
if (existing) {
return existing;
}
}

for (const sourceFile of ICON_SOURCE_FILES) {
const sourcePath = yield* workspacePaths
.resolveRelativePathWithinRoot({
workspaceRoot: projectCwd,
relativePath: sourceFile,
})
.pipe(
Effect.mapError(
(cause) =>
new ProjectFaviconResolutionError({
operation: "resolve-path",
workspaceRoot: projectCwd,
relativePath: sourceFile,
cause,
}),
),
);
const source = yield* optionOnNotFound(
fileSystem.readFileString(sourcePath.absolutePath),
).pipe(
Effect.mapError(
(cause) =>
new ProjectFaviconResolutionError({
operation: "read-source",
workspaceRoot: projectCwd,
relativePath: sourceFile,
absolutePath: sourcePath.absolutePath,
cause,
}),
),
);
if (Option.isNone(source)) {
continue;
}
const href = extractIconHref(source.value);
if (!href) {
continue;
}
const existing = yield* findExistingFile(projectCwd, resolveIconHref(href), "workspace");
if (existing) {
return existing;
}
const wellKnown = yield* firstInOrder(FAVICON_CANDIDATES, (candidate) =>
findExistingFile(projectCwd, [candidate], "workspace"),
);
if (wellKnown) {
return wellKnown;
}

return null;
return yield* firstInOrder(ICON_SOURCE_FILES, (sourceFile) =>
findIconFromSource(projectCwd, sourceFile),
);
});

const faviconCache = yield* Cache.makeWith<string, string | null, ProjectFaviconResolutionError>(
Expand Down
Loading