Skip to content

Preserve tool catalogs when a sync cannot read its source #1335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RhysSullivan merged 1 commit into from
Jul 7, 2026
Merged

Preserve tool catalogs when a sync cannot read its source #1335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
261 changes: 260 additions & 1 deletion packages/core/sdk/src/connections.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ import {
ToolAddress,
ToolName,
} from "./ids";
import { createExecutor } from "./executor";
import { definePlugin } from "./plugin";
import type { CredentialProvider } from "./provider";
import { makeTestExecutor } from "./testing";
import { makeTestConfig, makeTestExecutor } from "./testing";

// removed: v1 connection-refresh lifecycle, ConnectionProvider.refresh,
// SecretProvider, accessToken token-refresh + in-flight dedup tests — the v2
Expand Down Expand Up @@ -359,6 +360,264 @@ describe("connections.refresh", () => {
);
});

describe("tool catalog sync safety", () => {
it.effect(
"background sync preserves a nonzero catalog when a plugin returns authoritative empty",
() =>
Effect.scoped(
Effect.gen(function* () {
let empty = false;
const guardedPlugin = definePlugin(() => ({
id: "guarded" as const,
credentialProviders: [memoryProvider()],
storage: () => ({}),
resolveTools: () =>
Effect.sync(() => ({
tools: empty
? []
: [
{ name: ToolName.make("deploy"), description: "deploy" },
{ name: ToolName.make("list"), description: "list" },
],
})),
invokeTool: ({ toolRow }) => Effect.succeed({ ran: toolRow.name }),
extension: (ctx) => ({
seed: () =>
ctx.core.integrations.register({
slug: INTEG,
description: "Vercel",
config: {},
}),
}),
}))();
const config = makeTestConfig({ plugins: [guardedPlugin] as const });
const executor = yield* createExecutor(config);
yield* executor.guarded.seed();
yield* executor.connections.create({
owner: "org",
name: ConnectionName.make("main"),
integration: INTEG,
template: TEMPLATE,
value: "secret-token",
});

empty = true;
yield* Effect.promise(() =>
config.db.updateMany("connection", {
where: (b) => b.and(b("integration", "=", String(INTEG)), b("name", "=", "main")),
set: { tools_synced_at: null },
}),
);
const tools = yield* executor.tools.list({ integration: INTEG });
const connection = yield* executor.connections.get({
owner: "org",
integration: INTEG,
name: ConnectionName.make("main"),
});

expect(tools.map((tool) => String(tool.name)).sort()).toEqual(["deploy", "list"]);
expect(connection?.lastHealth).toMatchObject({
status: "degraded",
detail: expect.stringContaining("authoritative empty catalog"),
});
}),
),
);

it.effect("explicit refresh accepts an authoritative empty catalog", () =>
Effect.scoped(
Effect.gen(function* () {
let empty = false;
const guardedPlugin = definePlugin(() => ({
id: "guarded" as const,
credentialProviders: [memoryProvider()],
storage: () => ({}),
resolveTools: () =>
Effect.sync(() => ({
tools: empty
? []
: [
{ name: ToolName.make("deploy"), description: "deploy" },
{ name: ToolName.make("list"), description: "list" },
],
})),
invokeTool: ({ toolRow }) => Effect.succeed({ ran: toolRow.name }),
extension: (ctx) => ({
seed: () =>
ctx.core.integrations.register({
slug: INTEG,
description: "Vercel",
config: {},
}),
}),
}))();
const executor = yield* createExecutor(
makeTestConfig({ plugins: [guardedPlugin] as const }),
);
yield* executor.guarded.seed();
yield* executor.connections.create({
owner: "org",
name: ConnectionName.make("main"),
integration: INTEG,
template: TEMPLATE,
value: "secret-token",
});

empty = true;
const refreshed = yield* executor.connections.refresh({
owner: "org",
integration: INTEG,
name: ConnectionName.make("main"),
});
const tools = yield* executor.tools.list({ integration: INTEG });

expect(refreshed).toEqual([]);
expect(tools).toEqual([]);
}),
),
);

it.effect("successful sync clears a prior tool-sync failure health record", () =>
Effect.scoped(
Effect.gen(function* () {
let incomplete = false;
const guardedPlugin = definePlugin(() => ({
id: "guarded" as const,
credentialProviders: [memoryProvider()],
storage: () => ({}),
resolveTools: () =>
Effect.sync(() =>
incomplete
? {
tools: [],
incomplete: true,
incompleteReason: "temporary catalog outage",
}
: {
tools: [
{ name: ToolName.make("deploy"), description: "deploy" },
{ name: ToolName.make("list"), description: "list" },
],
},
),
invokeTool: ({ toolRow }) => Effect.succeed({ ran: toolRow.name }),
extension: (ctx) => ({
seed: () =>
ctx.core.integrations.register({
slug: INTEG,
description: "Vercel",
config: {},
}),
}),
}))();
const config = makeTestConfig({ plugins: [guardedPlugin] as const });
const executor = yield* createExecutor(config);
yield* executor.guarded.seed();
yield* executor.connections.create({
owner: "org",
name: ConnectionName.make("main"),
integration: INTEG,
template: TEMPLATE,
value: "secret-token",
});

incomplete = true;
yield* Effect.promise(() =>
config.db.updateMany("connection", {
where: (b) => b.and(b("integration", "=", String(INTEG)), b("name", "=", "main")),
set: { tools_synced_at: null },
}),
);
yield* executor.tools.list({ integration: INTEG });
expect(
(yield* executor.connections.get({
owner: "org",
integration: INTEG,
name: ConnectionName.make("main"),
}))?.lastHealth,
).toMatchObject({
status: "degraded",
detail: expect.stringContaining("temporary catalog outage"),
});

incomplete = false;
yield* Effect.promise(() =>
config.db.updateMany("connection", {
where: (b) => b.and(b("integration", "=", String(INTEG)), b("name", "=", "main")),
set: { tools_synced_at: null },
}),
);
yield* executor.tools.list({ integration: INTEG });
const connection = yield* executor.connections.get({
owner: "org",
integration: INTEG,
name: ConnectionName.make("main"),
});

expect(connection?.lastHealth).toBeNull();
}),
),
);

it.effect("successful sync preserves genuine health-check records", () =>
Effect.scoped(
Effect.gen(function* () {
const guardedPlugin = definePlugin(() => ({
id: "guarded" as const,
credentialProviders: [memoryProvider()],
storage: () => ({}),
resolveTools: () =>
Effect.succeed({
tools: [
{ name: ToolName.make("deploy"), description: "deploy" },
{ name: ToolName.make("list"), description: "list" },
],
}),
invokeTool: ({ toolRow }) => Effect.succeed({ ran: toolRow.name }),
extension: (ctx) => ({
seed: () =>
ctx.core.integrations.register({
slug: INTEG,
description: "Vercel",
config: {},
}),
}),
}))();
const config = makeTestConfig({ plugins: [guardedPlugin] as const });
const executor = yield* createExecutor(config);
yield* executor.guarded.seed();
yield* executor.connections.create({
owner: "org",
name: ConnectionName.make("main"),
integration: INTEG,
template: TEMPLATE,
value: "secret-token",
});

const health = {
status: "degraded" as const,
checkedAt: Date.now(),
detail: "health check returned HTTP 503",
};
yield* Effect.promise(() =>
config.db.updateMany("connection", {
where: (b) => b.and(b("integration", "=", String(INTEG)), b("name", "=", "main")),
set: { tools_synced_at: null, last_health: health },
}),
);
yield* executor.tools.list({ integration: INTEG });
const connection = yield* executor.connections.get({
owner: "org",
integration: INTEG,
name: ConnectionName.make("main"),
});

expect(connection?.lastHealth).toMatchObject(health);
}),
),
);
});

describe("execute over a connection", () => {
it.effect("resolves the credential value and hands it to invokeTool", () =>
Effect.gen(function* () {
Expand Down
Loading
Loading