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
27 changes: 27 additions & 0 deletions apps/server/openapi.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -1300,6 +1300,33 @@
},
"required": ["type", "name", "provider"]
},
"previousAddress": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"environment",
"vault",
"memory_store",
"skill",
"agent",
"template",
"deployment",
"file",
"identity",
"channel"
]
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
}
},
"required": ["type", "name", "provider"]
},
"reason": {
"type": "string"
},
Expand Down
16 changes: 16 additions & 0 deletions apps/webui/src/lib/api/generated/schema.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -731,6 +731,22 @@ export interface paths {
name: string;
provider: string;
};
previousAddress?: {
/** @enum {string} */
type:
| "environment"
| "vault"
| "memory_store"
| "skill"
| "agent"
| "template"
| "deployment"
| "file"
| "identity"
| "channel";
name: string;
provider: string;
};
reason: string;
/** @enum {string} */
driftKind?: "none" | "local" | "remote" | "both";
Expand Down
23 changes: 18 additions & 5 deletions packages/sdk/src/internal/executor/executor.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { dirname, resolve } from "node:path";
import { UserError } from "../errors.ts";
import { computeComparableDesiredHash } from "../planner/comparable.ts";
import { getResourceDeclaration } from "../planner/declaration.ts";
import { computeResourceHash } from "../planner/hasher.ts";
import { computeReplacementFingerprint, computeResourceHash } from "../planner/hasher.ts";
import { buildReadinessBaseline } from "../planner/plan-semantics.ts";
import { ApiError, ConflictError } from "../providers/base-client.ts";
import { readComparableIfSupported } from "../providers/drift-support.ts";
Expand DownExpand Up@@ -229,8 +229,8 @@ async function executeAction(action: PlannedAction, provider: ResourceExecAdapte
resource: action.address,
message: `update ${action.address.type}.${action.address.name} (${action.address.provider}) — not found remotely, recreating`,
});
ctx.state.removeResource(action.address);
return executeActionInner({ ...action, action: "create" }, provider, ctx);
ctx.state.removeResource(action.previousAddress ?? action.address);
return executeActionInner({ ...action, action: "create", previousAddress: undefined }, provider, ctx);
}
}

Expand DownExpand Up@@ -317,7 +317,8 @@ async function executeActionInner(
}

const isUpdate = action.action === "update";
const existingId = isUpdate ? ctx.state.getResource(address)?.remote_id : undefined;
const priorAddress = action.previousAddress ?? address;
const existingId = isUpdate ? ctx.state.getResource(priorAddress)?.remote_id : undefined;

let result: RemoteResource;

Expand DownExpand Up@@ -652,7 +653,7 @@ async function executeActionInner(

// The externally-managed marker is sticky: it survives applies and is only
// cleared by removing the resource from state (`agents state rm` / destroy).
const priorResource = ctx.state.getResource(address);
const priorResource = ctx.state.getResource(priorAddress);
ctx.state.setResource({
address,
remote_id: result.id,
Expand All@@ -669,9 +670,11 @@ async function executeActionInner(
desired_readiness_baseline: buildReadinessBaseline(getResourceDeclaration(address, ctx.config)),
remote_hash: remoteHash,
remote_snapshot: remoteSnapshot,
replacement_fingerprint: computeReplacementFingerprint(address, ctx.config),
drift_paths: [],
drift_status: remoteHash ? "in_sync" : undefined,
});
if (action.previousAddress) ctx.state.removeResource(action.previousAddress);
return adopted;
}

Expand DownExpand Up@@ -719,6 +722,16 @@ async function adoptOnConflict(
// command, so fail with actionable guidance instead of the raw wire error.
function nameReservedError(err: unknown, address: ResourceAddress, searchName: string): UserError {
const detail = err instanceof ApiError ? err.message : String(err);
if (
address.type === "channel" &&
err instanceof ApiError &&
err.responseBody.includes("CHANNEL_CREDENTIAL_CONFLICT")
) {
return new UserError(
`${address.provider} rejected channel.${address.name} because its credentials are already used by another Channel. ` +
`Keep the existing Channel address so it can be updated in place, remove the old Channel first, or use a different credential set. (${detail})`,
);
}
return new UserError(
`${address.provider} reported ${address.type} "${searchName}" already exists, but it could not be found remotely to adopt. ` +
`This usually means it was recently deleted and the provider still reserves the name. ` +
Expand Down
8 changes: 8 additions & 0 deletions packages/sdk/src/internal/planner/hasher.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,14 @@ export async function computeResourceHash(
return contentHash(decl);
}

/** Stable, non-reversible identity hint for resources whose YAML key may change. */
export function computeReplacementFingerprint(address: ResourceAddress, config: ProjectConfig): string | undefined {
if (address.type !== "channel") return undefined;
const decl = config.channels?.[address.name];
if (!decl) return undefined;
return contentHash({ channel_type: decl.type, credentials: decl.credentials ?? {} });
}

function resolveChannelReferenceIds(
decl: { agent: string; identity?: string },
config: ProjectConfig,
Expand Down
85 changes: 84 additions & 1 deletion packages/sdk/src/internal/planner/planner.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import type { ExecutionPlan, PlannedAction } from "../types/plan.ts";
import type { ResourceAddress, StateFile } from "../types/state.ts";
import { addressKey } from "../types/state.ts";
import { getResourceDeclaration } from "./declaration.ts";
import { computeResourceHash } from "./hasher.ts";
import { computeReplacementFingerprint, computeResourceHash } from "./hasher.ts";
import { buildReadinessBaseline, classifyReadinessImpact, diffReadinessBaseline } from "./plan-semantics.ts";

export interface PlanOptions {
Expand DownExpand Up@@ -218,9 +218,92 @@ export async function buildPlan(
});
}

coalesceChannelRenames(actions, config, state);
return { actions, diagnostics: diagnostics.getAll() };
}

/**
* A YAML key is a resource address, but changing that key should not force a
* remote Channel replacement when the old and new declarations form one
* unambiguous same-type pair. Retaining the remote id is especially important
* for messaging providers that allow a credential set to belong to only one
* Channel at a time.
*/
function coalesceChannelRenames(actions: PlannedAction[], config: ProjectConfig, state: StateFile): void {
const creates = actions.filter((action) => action.action === "create" && action.address.type === "channel");
const deletes = actions.filter((action) => action.action === "delete" && action.address.type === "channel");
const stateByAddress = new Map(state.resources.map((resource) => [addressKey(resource.address), resource]));
const matchedDeletes = new Set<PlannedAction>();

for (const create of creates) {
const desiredType = config.channels?.[create.address.name]?.type;
if (!desiredType) continue;
const desiredFingerprint = computeReplacementFingerprint(create.address, config);
const candidates = deletes.filter((deletion) => {
if (matchedDeletes.has(deletion) || deletion.address.provider !== create.address.provider) return false;
const prior = stateByAddress.get(addressKey(deletion.address));
const snapshot = prior?.remote_snapshot as { channel_type?: unknown } | undefined;
if (snapshot?.channel_type !== desiredType) return false;
return !prior?.replacement_fingerprint || prior.replacement_fingerprint === desiredFingerprint;
});
if (candidates.length !== 1) continue;

const deletion = candidates[0]!;
const prior = stateByAddress.get(addressKey(deletion.address));
const competingCreates = creates.filter(
(candidate) =>
candidate !== create &&
candidate.address.provider === create.address.provider &&
config.channels?.[candidate.address.name]?.type === desiredType &&
(!prior?.replacement_fingerprint ||
computeReplacementFingerprint(candidate.address, config) === prior.replacement_fingerprint),
);
if (competingCreates.length > 0) continue;

create.action = "update";
create.previousAddress = deletion.address;
create.before = deletion.before;
create.driftKind = "local";
create.reason = `Channel key renamed from '${deletion.address.name}' (remote resource retained)`;
protectRenamedChannelDependencies(actions, stateByAddress, deletion, create);
matchedDeletes.add(deletion);
}

for (let index = actions.length - 1; index >= 0; index--) {
if (matchedDeletes.has(actions[index]!)) actions.splice(index, 1);
}
}

/** Do not delete the old Identity/Template when the Channel migration that releases it fails. */
function protectRenamedChannelDependencies(
actions: PlannedAction[],
stateByAddress: Map<string, StateFile["resources"][number]>,
deletion: PlannedAction,
replacement: PlannedAction,
): void {
const prior = stateByAddress.get(addressKey(deletion.address));
const snapshot = prior?.remote_snapshot as { identity_id?: unknown; template_id?: unknown } | undefined;
const referencedIds = new Set(
[snapshot?.identity_id, snapshot?.template_id].filter((id): id is string => typeof id === "string"),
);
if (referencedIds.size === 0) return;

for (const action of actions) {
if (
action.action !== "delete" ||
(action.address.type !== "identity" && action.address.type !== "template") ||
action.address.provider !== replacement.address.provider
) {
continue;
}
const dependency = stateByAddress.get(addressKey(action.address));
if (!dependency?.remote_id || !referencedIds.has(dependency.remote_id)) continue;
if (!action.dependencies.some((address) => addressKey(address) === addressKey(replacement.address))) {
action.dependencies.push(replacement.address);
}
}
}

/** Keep the old delivery resource alive when creating its new materialization fails. */
function deliveryReplacementAddress(address: ResourceAddress, graph: DependencyGraph): ResourceAddress | undefined {
if (address.type !== "agent" && address.type !== "template") return undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/sdk/src/internal/state/state-manager.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ export class StateManager implements IStateManager {
desired_readiness_baseline: r.desired_readiness_baseline as ResourceState["desired_readiness_baseline"],
remote_hash: r.remote_hash as string | undefined,
remote_snapshot: r.remote_snapshot,
replacement_fingerprint: r.replacement_fingerprint as string | undefined,
drift_paths: r.drift_paths as string[] | undefined,
drift_status: r.drift_status as ResourceState["drift_status"],
}));
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk/src/internal/types/dto.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,8 @@ export type PlanReadinessImpact = z.infer<typeof PlanReadinessImpactSchema>;
export const PlannedActionSchema = z.object({
action: ActionTypeSchema,
address: ResourceAddressSchema,
/** Existing state address to retain when this action is an inferred logical rename. */
previousAddress: ResourceAddressSchema.optional(),
reason: z.string(),
driftKind: DriftKindSchema.optional(),
readinessImpact: PlanReadinessImpactSchema.optional(),
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk/src/internal/types/state.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ export interface ResourceState {
desired_readiness_baseline?: ResourceReadinessBaseline;
remote_hash?: string;
remote_snapshot?: unknown;
/** Non-reversible declaration fingerprint used to infer safe logical renames. */
replacement_fingerprint?: string;
drift_paths?: string[];
drift_status?: "in_sync" | "drifted" | "missing" | "unchecked";
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix: migrate renamed channels in place by heimanba · Pull Request #78 · modelstudioai/OpenAgentPack · GitHub
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
27 changes: 27 additions & 0 deletions apps/server/openapi.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -1300,6 +1300,33 @@
},
"required": ["type", "name", "provider"]
},
"previousAddress": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"environment",
"vault",
"memory_store",
"skill",
"agent",
"template",
"deployment",
"file",
"identity",
"channel"
]
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
}
},
"required": ["type", "name", "provider"]
},
"reason": {
"type": "string"
},
Expand Down
16 changes: 16 additions & 0 deletions apps/webui/src/lib/api/generated/schema.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -731,6 +731,22 @@ export interface paths {
name: string;
provider: string;
};
previousAddress?: {
/** @enum {string} */
type:
| "environment"
| "vault"
| "memory_store"
| "skill"
| "agent"
| "template"
| "deployment"
| "file"
| "identity"
| "channel";
name: string;
provider: string;
};
reason: string;
/** @enum {string} */
driftKind?: "none" | "local" | "remote" | "both";
Expand Down
23 changes: 18 additions & 5 deletions packages/sdk/src/internal/executor/executor.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { dirname, resolve } from "node:path";
import { UserError } from "../errors.ts";
import { computeComparableDesiredHash } from "../planner/comparable.ts";
import { getResourceDeclaration } from "../planner/declaration.ts";
import { computeResourceHash } from "../planner/hasher.ts";
import { computeReplacementFingerprint, computeResourceHash } from "../planner/hasher.ts";
import { buildReadinessBaseline } from "../planner/plan-semantics.ts";
import { ApiError, ConflictError } from "../providers/base-client.ts";
import { readComparableIfSupported } from "../providers/drift-support.ts";
Expand DownExpand Up@@ -229,8 +229,8 @@ async function executeAction(action: PlannedAction, provider: ResourceExecAdapte
resource: action.address,
message: `update ${action.address.type}.${action.address.name} (${action.address.provider}) — not found remotely, recreating`,
});
ctx.state.removeResource(action.address);
return executeActionInner({ ...action, action: "create" }, provider, ctx);
ctx.state.removeResource(action.previousAddress ?? action.address);
return executeActionInner({ ...action, action: "create", previousAddress: undefined }, provider, ctx);
}
}

Expand DownExpand Up@@ -317,7 +317,8 @@ async function executeActionInner(
}

const isUpdate = action.action === "update";
const existingId = isUpdate ? ctx.state.getResource(address)?.remote_id : undefined;
const priorAddress = action.previousAddress ?? address;
const existingId = isUpdate ? ctx.state.getResource(priorAddress)?.remote_id : undefined;

let result: RemoteResource;

Expand DownExpand Up@@ -652,7 +653,7 @@ async function executeActionInner(

// The externally-managed marker is sticky: it survives applies and is only
// cleared by removing the resource from state (`agents state rm` / destroy).
const priorResource = ctx.state.getResource(address);
const priorResource = ctx.state.getResource(priorAddress);
ctx.state.setResource({
address,
remote_id: result.id,
Expand All@@ -669,9 +670,11 @@ async function executeActionInner(
desired_readiness_baseline: buildReadinessBaseline(getResourceDeclaration(address, ctx.config)),
remote_hash: remoteHash,
remote_snapshot: remoteSnapshot,
replacement_fingerprint: computeReplacementFingerprint(address, ctx.config),
drift_paths: [],
drift_status: remoteHash ? "in_sync" : undefined,
});
if (action.previousAddress) ctx.state.removeResource(action.previousAddress);
return adopted;
}

Expand DownExpand Up@@ -719,6 +722,16 @@ async function adoptOnConflict(
// command, so fail with actionable guidance instead of the raw wire error.
function nameReservedError(err: unknown, address: ResourceAddress, searchName: string): UserError {
const detail = err instanceof ApiError ? err.message : String(err);
if (
address.type === "channel" &&
err instanceof ApiError &&
err.responseBody.includes("CHANNEL_CREDENTIAL_CONFLICT")
) {
return new UserError(
`${address.provider} rejected channel.${address.name} because its credentials are already used by another Channel. ` +
`Keep the existing Channel address so it can be updated in place, remove the old Channel first, or use a different credential set. (${detail})`,
);
}
return new UserError(
`${address.provider} reported ${address.type} "${searchName}" already exists, but it could not be found remotely to adopt. ` +
`This usually means it was recently deleted and the provider still reserves the name. ` +
Expand Down
8 changes: 8 additions & 0 deletions packages/sdk/src/internal/planner/hasher.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,14 @@ export async function computeResourceHash(
return contentHash(decl);
}

/** Stable, non-reversible identity hint for resources whose YAML key may change. */
export function computeReplacementFingerprint(address: ResourceAddress, config: ProjectConfig): string | undefined {
if (address.type !== "channel") return undefined;
const decl = config.channels?.[address.name];
if (!decl) return undefined;
return contentHash({ channel_type: decl.type, credentials: decl.credentials ?? {} });
}

function resolveChannelReferenceIds(
decl: { agent: string; identity?: string },
config: ProjectConfig,
Expand Down
85 changes: 84 additions & 1 deletion packages/sdk/src/internal/planner/planner.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import type { ExecutionPlan, PlannedAction } from "../types/plan.ts";
import type { ResourceAddress, StateFile } from "../types/state.ts";
import { addressKey } from "../types/state.ts";
import { getResourceDeclaration } from "./declaration.ts";
import { computeResourceHash } from "./hasher.ts";
import { computeReplacementFingerprint, computeResourceHash } from "./hasher.ts";
import { buildReadinessBaseline, classifyReadinessImpact, diffReadinessBaseline } from "./plan-semantics.ts";

export interface PlanOptions {
Expand DownExpand Up@@ -218,9 +218,92 @@ export async function buildPlan(
});
}

coalesceChannelRenames(actions, config, state);
return { actions, diagnostics: diagnostics.getAll() };
}

/**
* A YAML key is a resource address, but changing that key should not force a
* remote Channel replacement when the old and new declarations form one
* unambiguous same-type pair. Retaining the remote id is especially important
* for messaging providers that allow a credential set to belong to only one
* Channel at a time.
*/
function coalesceChannelRenames(actions: PlannedAction[], config: ProjectConfig, state: StateFile): void {
const creates = actions.filter((action) => action.action === "create" && action.address.type === "channel");
const deletes = actions.filter((action) => action.action === "delete" && action.address.type === "channel");
const stateByAddress = new Map(state.resources.map((resource) => [addressKey(resource.address), resource]));
const matchedDeletes = new Set<PlannedAction>();

for (const create of creates) {
const desiredType = config.channels?.[create.address.name]?.type;
if (!desiredType) continue;
const desiredFingerprint = computeReplacementFingerprint(create.address, config);
const candidates = deletes.filter((deletion) => {
if (matchedDeletes.has(deletion) || deletion.address.provider !== create.address.provider) return false;
const prior = stateByAddress.get(addressKey(deletion.address));
const snapshot = prior?.remote_snapshot as { channel_type?: unknown } | undefined;
if (snapshot?.channel_type !== desiredType) return false;
return !prior?.replacement_fingerprint || prior.replacement_fingerprint === desiredFingerprint;
});
if (candidates.length !== 1) continue;

const deletion = candidates[0]!;
const prior = stateByAddress.get(addressKey(deletion.address));
const competingCreates = creates.filter(
(candidate) =>
candidate !== create &&
candidate.address.provider === create.address.provider &&
config.channels?.[candidate.address.name]?.type === desiredType &&
(!prior?.replacement_fingerprint ||
computeReplacementFingerprint(candidate.address, config) === prior.replacement_fingerprint),
);
if (competingCreates.length > 0) continue;

create.action = "update";
create.previousAddress = deletion.address;
create.before = deletion.before;
create.driftKind = "local";
create.reason = `Channel key renamed from '${deletion.address.name}' (remote resource retained)`;
protectRenamedChannelDependencies(actions, stateByAddress, deletion, create);
matchedDeletes.add(deletion);
}

for (let index = actions.length - 1; index >= 0; index--) {
if (matchedDeletes.has(actions[index]!)) actions.splice(index, 1);
}
}

/** Do not delete the old Identity/Template when the Channel migration that releases it fails. */
function protectRenamedChannelDependencies(
actions: PlannedAction[],
stateByAddress: Map<string, StateFile["resources"][number]>,
deletion: PlannedAction,
replacement: PlannedAction,
): void {
const prior = stateByAddress.get(addressKey(deletion.address));
const snapshot = prior?.remote_snapshot as { identity_id?: unknown; template_id?: unknown } | undefined;
const referencedIds = new Set(
[snapshot?.identity_id, snapshot?.template_id].filter((id): id is string => typeof id === "string"),
);
if (referencedIds.size === 0) return;

for (const action of actions) {
if (
action.action !== "delete" ||
(action.address.type !== "identity" && action.address.type !== "template") ||
action.address.provider !== replacement.address.provider
) {
continue;
}
const dependency = stateByAddress.get(addressKey(action.address));
if (!dependency?.remote_id || !referencedIds.has(dependency.remote_id)) continue;
if (!action.dependencies.some((address) => addressKey(address) === addressKey(replacement.address))) {
action.dependencies.push(replacement.address);
}
}
}

/** Keep the old delivery resource alive when creating its new materialization fails. */
function deliveryReplacementAddress(address: ResourceAddress, graph: DependencyGraph): ResourceAddress | undefined {
if (address.type !== "agent" && address.type !== "template") return undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/sdk/src/internal/state/state-manager.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ export class StateManager implements IStateManager {
desired_readiness_baseline: r.desired_readiness_baseline as ResourceState["desired_readiness_baseline"],
remote_hash: r.remote_hash as string | undefined,
remote_snapshot: r.remote_snapshot,
replacement_fingerprint: r.replacement_fingerprint as string | undefined,
drift_paths: r.drift_paths as string[] | undefined,
drift_status: r.drift_status as ResourceState["drift_status"],
}));
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk/src/internal/types/dto.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,8 @@ export type PlanReadinessImpact = z.infer<typeof PlanReadinessImpactSchema>;
export const PlannedActionSchema = z.object({
action: ActionTypeSchema,
address: ResourceAddressSchema,
/** Existing state address to retain when this action is an inferred logical rename. */
previousAddress: ResourceAddressSchema.optional(),
reason: z.string(),
driftKind: DriftKindSchema.optional(),
readinessImpact: PlanReadinessImpactSchema.optional(),
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk/src/internal/types/state.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ export interface ResourceState {
desired_readiness_baseline?: ResourceReadinessBaseline;
remote_hash?: string;
remote_snapshot?: unknown;
/** Non-reversible declaration fingerprint used to infer safe logical renames. */
replacement_fingerprint?: string;
drift_paths?: string[];
drift_status?: "in_sync" | "drifted" | "missing" | "unchecked";
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix: migrate renamed channels in place by heimanba · Pull Request #78 · modelstudioai/OpenAgentPack · GitHub
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
27 changes: 27 additions & 0 deletions apps/server/openapi.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -1300,6 +1300,33 @@
},
"required": ["type", "name", "provider"]
},
"previousAddress": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"environment",
"vault",
"memory_store",
"skill",
"agent",
"template",
"deployment",
"file",
"identity",
"channel"
]
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
}
},
"required": ["type", "name", "provider"]
},
"reason": {
"type": "string"
},
Expand Down
16 changes: 16 additions & 0 deletions apps/webui/src/lib/api/generated/schema.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -731,6 +731,22 @@ export interface paths {
name: string;
provider: string;
};
previousAddress?: {
/** @enum {string} */
type:
| "environment"
| "vault"
| "memory_store"
| "skill"
| "agent"
| "template"
| "deployment"
| "file"
| "identity"
| "channel";
name: string;
provider: string;
};
reason: string;
/** @enum {string} */
driftKind?: "none" | "local" | "remote" | "both";
Expand Down
23 changes: 18 additions & 5 deletions packages/sdk/src/internal/executor/executor.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { dirname, resolve } from "node:path";
import { UserError } from "../errors.ts";
import { computeComparableDesiredHash } from "../planner/comparable.ts";
import { getResourceDeclaration } from "../planner/declaration.ts";
import { computeResourceHash } from "../planner/hasher.ts";
import { computeReplacementFingerprint, computeResourceHash } from "../planner/hasher.ts";
import { buildReadinessBaseline } from "../planner/plan-semantics.ts";
import { ApiError, ConflictError } from "../providers/base-client.ts";
import { readComparableIfSupported } from "../providers/drift-support.ts";
Expand DownExpand Up@@ -229,8 +229,8 @@ async function executeAction(action: PlannedAction, provider: ResourceExecAdapte
resource: action.address,
message: `update ${action.address.type}.${action.address.name} (${action.address.provider}) — not found remotely, recreating`,
});
ctx.state.removeResource(action.address);
return executeActionInner({ ...action, action: "create" }, provider, ctx);
ctx.state.removeResource(action.previousAddress ?? action.address);
return executeActionInner({ ...action, action: "create", previousAddress: undefined }, provider, ctx);
}
}

Expand DownExpand Up@@ -317,7 +317,8 @@ async function executeActionInner(
}

const isUpdate = action.action === "update";
const existingId = isUpdate ? ctx.state.getResource(address)?.remote_id : undefined;
const priorAddress = action.previousAddress ?? address;
const existingId = isUpdate ? ctx.state.getResource(priorAddress)?.remote_id : undefined;

let result: RemoteResource;

Expand DownExpand Up@@ -652,7 +653,7 @@ async function executeActionInner(

// The externally-managed marker is sticky: it survives applies and is only
// cleared by removing the resource from state (`agents state rm` / destroy).
const priorResource = ctx.state.getResource(address);
const priorResource = ctx.state.getResource(priorAddress);
ctx.state.setResource({
address,
remote_id: result.id,
Expand All@@ -669,9 +670,11 @@ async function executeActionInner(
desired_readiness_baseline: buildReadinessBaseline(getResourceDeclaration(address, ctx.config)),
remote_hash: remoteHash,
remote_snapshot: remoteSnapshot,
replacement_fingerprint: computeReplacementFingerprint(address, ctx.config),
drift_paths: [],
drift_status: remoteHash ? "in_sync" : undefined,
});
if (action.previousAddress) ctx.state.removeResource(action.previousAddress);
return adopted;
}

Expand DownExpand Up@@ -719,6 +722,16 @@ async function adoptOnConflict(
// command, so fail with actionable guidance instead of the raw wire error.
function nameReservedError(err: unknown, address: ResourceAddress, searchName: string): UserError {
const detail = err instanceof ApiError ? err.message : String(err);
if (
address.type === "channel" &&
err instanceof ApiError &&
err.responseBody.includes("CHANNEL_CREDENTIAL_CONFLICT")
) {
return new UserError(
`${address.provider} rejected channel.${address.name} because its credentials are already used by another Channel. ` +
`Keep the existing Channel address so it can be updated in place, remove the old Channel first, or use a different credential set. (${detail})`,
);
}
return new UserError(
`${address.provider} reported ${address.type} "${searchName}" already exists, but it could not be found remotely to adopt. ` +
`This usually means it was recently deleted and the provider still reserves the name. ` +
Expand Down
8 changes: 8 additions & 0 deletions packages/sdk/src/internal/planner/hasher.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,14 @@ export async function computeResourceHash(
return contentHash(decl);
}

/** Stable, non-reversible identity hint for resources whose YAML key may change. */
export function computeReplacementFingerprint(address: ResourceAddress, config: ProjectConfig): string | undefined {
if (address.type !== "channel") return undefined;
const decl = config.channels?.[address.name];
if (!decl) return undefined;
return contentHash({ channel_type: decl.type, credentials: decl.credentials ?? {} });
}

function resolveChannelReferenceIds(
decl: { agent: string; identity?: string },
config: ProjectConfig,
Expand Down
85 changes: 84 additions & 1 deletion packages/sdk/src/internal/planner/planner.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import type { ExecutionPlan, PlannedAction } from "../types/plan.ts";
import type { ResourceAddress, StateFile } from "../types/state.ts";
import { addressKey } from "../types/state.ts";
import { getResourceDeclaration } from "./declaration.ts";
import { computeResourceHash } from "./hasher.ts";
import { computeReplacementFingerprint, computeResourceHash } from "./hasher.ts";
import { buildReadinessBaseline, classifyReadinessImpact, diffReadinessBaseline } from "./plan-semantics.ts";

export interface PlanOptions {
Expand DownExpand Up@@ -218,9 +218,92 @@ export async function buildPlan(
});
}

coalesceChannelRenames(actions, config, state);
return { actions, diagnostics: diagnostics.getAll() };
}

/**
* A YAML key is a resource address, but changing that key should not force a
* remote Channel replacement when the old and new declarations form one
* unambiguous same-type pair. Retaining the remote id is especially important
* for messaging providers that allow a credential set to belong to only one
* Channel at a time.
*/
function coalesceChannelRenames(actions: PlannedAction[], config: ProjectConfig, state: StateFile): void {
const creates = actions.filter((action) => action.action === "create" && action.address.type === "channel");
const deletes = actions.filter((action) => action.action === "delete" && action.address.type === "channel");
const stateByAddress = new Map(state.resources.map((resource) => [addressKey(resource.address), resource]));
const matchedDeletes = new Set<PlannedAction>();

for (const create of creates) {
const desiredType = config.channels?.[create.address.name]?.type;
if (!desiredType) continue;
const desiredFingerprint = computeReplacementFingerprint(create.address, config);
const candidates = deletes.filter((deletion) => {
if (matchedDeletes.has(deletion) || deletion.address.provider !== create.address.provider) return false;
const prior = stateByAddress.get(addressKey(deletion.address));
const snapshot = prior?.remote_snapshot as { channel_type?: unknown } | undefined;
if (snapshot?.channel_type !== desiredType) return false;
return !prior?.replacement_fingerprint || prior.replacement_fingerprint === desiredFingerprint;
});
if (candidates.length !== 1) continue;

const deletion = candidates[0]!;
const prior = stateByAddress.get(addressKey(deletion.address));
const competingCreates = creates.filter(
(candidate) =>
candidate !== create &&
candidate.address.provider === create.address.provider &&
config.channels?.[candidate.address.name]?.type === desiredType &&
(!prior?.replacement_fingerprint ||
computeReplacementFingerprint(candidate.address, config) === prior.replacement_fingerprint),
);
if (competingCreates.length > 0) continue;

create.action = "update";
create.previousAddress = deletion.address;
create.before = deletion.before;
create.driftKind = "local";
create.reason = `Channel key renamed from '${deletion.address.name}' (remote resource retained)`;
protectRenamedChannelDependencies(actions, stateByAddress, deletion, create);
matchedDeletes.add(deletion);
}

for (let index = actions.length - 1; index >= 0; index--) {
if (matchedDeletes.has(actions[index]!)) actions.splice(index, 1);
}
}

/** Do not delete the old Identity/Template when the Channel migration that releases it fails. */
function protectRenamedChannelDependencies(
actions: PlannedAction[],
stateByAddress: Map<string, StateFile["resources"][number]>,
deletion: PlannedAction,
replacement: PlannedAction,
): void {
const prior = stateByAddress.get(addressKey(deletion.address));
const snapshot = prior?.remote_snapshot as { identity_id?: unknown; template_id?: unknown } | undefined;
const referencedIds = new Set(
[snapshot?.identity_id, snapshot?.template_id].filter((id): id is string => typeof id === "string"),
);
if (referencedIds.size === 0) return;

for (const action of actions) {
if (
action.action !== "delete" ||
(action.address.type !== "identity" && action.address.type !== "template") ||
action.address.provider !== replacement.address.provider
) {
continue;
}
const dependency = stateByAddress.get(addressKey(action.address));
if (!dependency?.remote_id || !referencedIds.has(dependency.remote_id)) continue;
if (!action.dependencies.some((address) => addressKey(address) === addressKey(replacement.address))) {
action.dependencies.push(replacement.address);
}
}
}

/** Keep the old delivery resource alive when creating its new materialization fails. */
function deliveryReplacementAddress(address: ResourceAddress, graph: DependencyGraph): ResourceAddress | undefined {
if (address.type !== "agent" && address.type !== "template") return undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/sdk/src/internal/state/state-manager.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ export class StateManager implements IStateManager {
desired_readiness_baseline: r.desired_readiness_baseline as ResourceState["desired_readiness_baseline"],
remote_hash: r.remote_hash as string | undefined,
remote_snapshot: r.remote_snapshot,
replacement_fingerprint: r.replacement_fingerprint as string | undefined,
drift_paths: r.drift_paths as string[] | undefined,
drift_status: r.drift_status as ResourceState["drift_status"],
}));
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk/src/internal/types/dto.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,8 @@ export type PlanReadinessImpact = z.infer<typeof PlanReadinessImpactSchema>;
export const PlannedActionSchema = z.object({
action: ActionTypeSchema,
address: ResourceAddressSchema,
/** Existing state address to retain when this action is an inferred logical rename. */
previousAddress: ResourceAddressSchema.optional(),
reason: z.string(),
driftKind: DriftKindSchema.optional(),
readinessImpact: PlanReadinessImpactSchema.optional(),
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk/src/internal/types/state.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ export interface ResourceState {
desired_readiness_baseline?: ResourceReadinessBaseline;
remote_hash?: string;
remote_snapshot?: unknown;
/** Non-reversible declaration fingerprint used to infer safe logical renames. */
replacement_fingerprint?: string;
drift_paths?: string[];
drift_status?: "in_sync" | "drifted" | "missing" | "unchecked";
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix: migrate renamed channels in place by heimanba · Pull Request #78 · modelstudioai/OpenAgentPack · GitHub
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
27 changes: 27 additions & 0 deletions apps/server/openapi.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -1300,6 +1300,33 @@
},
"required": ["type", "name", "provider"]
},
"previousAddress": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"environment",
"vault",
"memory_store",
"skill",
"agent",
"template",
"deployment",
"file",
"identity",
"channel"
]
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
}
},
"required": ["type", "name", "provider"]
},
"reason": {
"type": "string"
},
Expand Down
16 changes: 16 additions & 0 deletions apps/webui/src/lib/api/generated/schema.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -731,6 +731,22 @@ export interface paths {
name: string;
provider: string;
};
previousAddress?: {
/** @enum {string} */
type:
| "environment"
| "vault"
| "memory_store"
| "skill"
| "agent"
| "template"
| "deployment"
| "file"
| "identity"
| "channel";
name: string;
provider: string;
};
reason: string;
/** @enum {string} */
driftKind?: "none" | "local" | "remote" | "both";
Expand Down
23 changes: 18 additions & 5 deletions packages/sdk/src/internal/executor/executor.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { dirname, resolve } from "node:path";
import { UserError } from "../errors.ts";
import { computeComparableDesiredHash } from "../planner/comparable.ts";
import { getResourceDeclaration } from "../planner/declaration.ts";
import { computeResourceHash } from "../planner/hasher.ts";
import { computeReplacementFingerprint, computeResourceHash } from "../planner/hasher.ts";
import { buildReadinessBaseline } from "../planner/plan-semantics.ts";
import { ApiError, ConflictError } from "../providers/base-client.ts";
import { readComparableIfSupported } from "../providers/drift-support.ts";
Expand DownExpand Up@@ -229,8 +229,8 @@ async function executeAction(action: PlannedAction, provider: ResourceExecAdapte
resource: action.address,
message: `update ${action.address.type}.${action.address.name} (${action.address.provider}) — not found remotely, recreating`,
});
ctx.state.removeResource(action.address);
return executeActionInner({ ...action, action: "create" }, provider, ctx);
ctx.state.removeResource(action.previousAddress ?? action.address);
return executeActionInner({ ...action, action: "create", previousAddress: undefined }, provider, ctx);
}
}

Expand DownExpand Up@@ -317,7 +317,8 @@ async function executeActionInner(
}

const isUpdate = action.action === "update";
const existingId = isUpdate ? ctx.state.getResource(address)?.remote_id : undefined;
const priorAddress = action.previousAddress ?? address;
const existingId = isUpdate ? ctx.state.getResource(priorAddress)?.remote_id : undefined;

let result: RemoteResource;

Expand DownExpand Up@@ -652,7 +653,7 @@ async function executeActionInner(

// The externally-managed marker is sticky: it survives applies and is only
// cleared by removing the resource from state (`agents state rm` / destroy).
const priorResource = ctx.state.getResource(address);
const priorResource = ctx.state.getResource(priorAddress);
ctx.state.setResource({
address,
remote_id: result.id,
Expand All@@ -669,9 +670,11 @@ async function executeActionInner(
desired_readiness_baseline: buildReadinessBaseline(getResourceDeclaration(address, ctx.config)),
remote_hash: remoteHash,
remote_snapshot: remoteSnapshot,
replacement_fingerprint: computeReplacementFingerprint(address, ctx.config),
drift_paths: [],
drift_status: remoteHash ? "in_sync" : undefined,
});
if (action.previousAddress) ctx.state.removeResource(action.previousAddress);
return adopted;
}

Expand DownExpand Up@@ -719,6 +722,16 @@ async function adoptOnConflict(
// command, so fail with actionable guidance instead of the raw wire error.
function nameReservedError(err: unknown, address: ResourceAddress, searchName: string): UserError {
const detail = err instanceof ApiError ? err.message : String(err);
if (
address.type === "channel" &&
err instanceof ApiError &&
err.responseBody.includes("CHANNEL_CREDENTIAL_CONFLICT")
) {
return new UserError(
`${address.provider} rejected channel.${address.name} because its credentials are already used by another Channel. ` +
`Keep the existing Channel address so it can be updated in place, remove the old Channel first, or use a different credential set. (${detail})`,
);
}
return new UserError(
`${address.provider} reported ${address.type} "${searchName}" already exists, but it could not be found remotely to adopt. ` +
`This usually means it was recently deleted and the provider still reserves the name. ` +
Expand Down
8 changes: 8 additions & 0 deletions packages/sdk/src/internal/planner/hasher.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,14 @@ export async function computeResourceHash(
return contentHash(decl);
}

/** Stable, non-reversible identity hint for resources whose YAML key may change. */
export function computeReplacementFingerprint(address: ResourceAddress, config: ProjectConfig): string | undefined {
if (address.type !== "channel") return undefined;
const decl = config.channels?.[address.name];
if (!decl) return undefined;
return contentHash({ channel_type: decl.type, credentials: decl.credentials ?? {} });
}

function resolveChannelReferenceIds(
decl: { agent: string; identity?: string },
config: ProjectConfig,
Expand Down
85 changes: 84 additions & 1 deletion packages/sdk/src/internal/planner/planner.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import type { ExecutionPlan, PlannedAction } from "../types/plan.ts";
import type { ResourceAddress, StateFile } from "../types/state.ts";
import { addressKey } from "../types/state.ts";
import { getResourceDeclaration } from "./declaration.ts";
import { computeResourceHash } from "./hasher.ts";
import { computeReplacementFingerprint, computeResourceHash } from "./hasher.ts";
import { buildReadinessBaseline, classifyReadinessImpact, diffReadinessBaseline } from "./plan-semantics.ts";

export interface PlanOptions {
Expand DownExpand Up@@ -218,9 +218,92 @@ export async function buildPlan(
});
}

coalesceChannelRenames(actions, config, state);
return { actions, diagnostics: diagnostics.getAll() };
}

/**
* A YAML key is a resource address, but changing that key should not force a
* remote Channel replacement when the old and new declarations form one
* unambiguous same-type pair. Retaining the remote id is especially important
* for messaging providers that allow a credential set to belong to only one
* Channel at a time.
*/
function coalesceChannelRenames(actions: PlannedAction[], config: ProjectConfig, state: StateFile): void {
const creates = actions.filter((action) => action.action === "create" && action.address.type === "channel");
const deletes = actions.filter((action) => action.action === "delete" && action.address.type === "channel");
const stateByAddress = new Map(state.resources.map((resource) => [addressKey(resource.address), resource]));
const matchedDeletes = new Set<PlannedAction>();

for (const create of creates) {
const desiredType = config.channels?.[create.address.name]?.type;
if (!desiredType) continue;
const desiredFingerprint = computeReplacementFingerprint(create.address, config);
const candidates = deletes.filter((deletion) => {
if (matchedDeletes.has(deletion) || deletion.address.provider !== create.address.provider) return false;
const prior = stateByAddress.get(addressKey(deletion.address));
const snapshot = prior?.remote_snapshot as { channel_type?: unknown } | undefined;
if (snapshot?.channel_type !== desiredType) return false;
return !prior?.replacement_fingerprint || prior.replacement_fingerprint === desiredFingerprint;
});
if (candidates.length !== 1) continue;

const deletion = candidates[0]!;
const prior = stateByAddress.get(addressKey(deletion.address));
const competingCreates = creates.filter(
(candidate) =>
candidate !== create &&
candidate.address.provider === create.address.provider &&
config.channels?.[candidate.address.name]?.type === desiredType &&
(!prior?.replacement_fingerprint ||
computeReplacementFingerprint(candidate.address, config) === prior.replacement_fingerprint),
);
if (competingCreates.length > 0) continue;

create.action = "update";
create.previousAddress = deletion.address;
create.before = deletion.before;
create.driftKind = "local";
create.reason = `Channel key renamed from '${deletion.address.name}' (remote resource retained)`;
protectRenamedChannelDependencies(actions, stateByAddress, deletion, create);
matchedDeletes.add(deletion);
}

for (let index = actions.length - 1; index >= 0; index--) {
if (matchedDeletes.has(actions[index]!)) actions.splice(index, 1);
}
}

/** Do not delete the old Identity/Template when the Channel migration that releases it fails. */
function protectRenamedChannelDependencies(
actions: PlannedAction[],
stateByAddress: Map<string, StateFile["resources"][number]>,
deletion: PlannedAction,
replacement: PlannedAction,
): void {
const prior = stateByAddress.get(addressKey(deletion.address));
const snapshot = prior?.remote_snapshot as { identity_id?: unknown; template_id?: unknown } | undefined;
const referencedIds = new Set(
[snapshot?.identity_id, snapshot?.template_id].filter((id): id is string => typeof id === "string"),
);
if (referencedIds.size === 0) return;

for (const action of actions) {
if (
action.action !== "delete" ||
(action.address.type !== "identity" && action.address.type !== "template") ||
action.address.provider !== replacement.address.provider
) {
continue;
}
const dependency = stateByAddress.get(addressKey(action.address));
if (!dependency?.remote_id || !referencedIds.has(dependency.remote_id)) continue;
if (!action.dependencies.some((address) => addressKey(address) === addressKey(replacement.address))) {
action.dependencies.push(replacement.address);
}
}
}

/** Keep the old delivery resource alive when creating its new materialization fails. */
function deliveryReplacementAddress(address: ResourceAddress, graph: DependencyGraph): ResourceAddress | undefined {
if (address.type !== "agent" && address.type !== "template") return undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/sdk/src/internal/state/state-manager.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ export class StateManager implements IStateManager {
desired_readiness_baseline: r.desired_readiness_baseline as ResourceState["desired_readiness_baseline"],
remote_hash: r.remote_hash as string | undefined,
remote_snapshot: r.remote_snapshot,
replacement_fingerprint: r.replacement_fingerprint as string | undefined,
drift_paths: r.drift_paths as string[] | undefined,
drift_status: r.drift_status as ResourceState["drift_status"],
}));
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk/src/internal/types/dto.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,8 @@ export type PlanReadinessImpact = z.infer<typeof PlanReadinessImpactSchema>;
export const PlannedActionSchema = z.object({
action: ActionTypeSchema,
address: ResourceAddressSchema,
/** Existing state address to retain when this action is an inferred logical rename. */
previousAddress: ResourceAddressSchema.optional(),
reason: z.string(),
driftKind: DriftKindSchema.optional(),
readinessImpact: PlanReadinessImpactSchema.optional(),
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk/src/internal/types/state.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ export interface ResourceState {
desired_readiness_baseline?: ResourceReadinessBaseline;
remote_hash?: string;
remote_snapshot?: unknown;
/** Non-reversible declaration fingerprint used to infer safe logical renames. */
replacement_fingerprint?: string;
drift_paths?: string[];
drift_status?: "in_sync" | "drifted" | "missing" | "unchecked";
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' fix: migrate renamed channels in place by heimanba · Pull Request #78 · modelstudioai/OpenAgentPack · GitHub
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
27 changes: 27 additions & 0 deletions apps/server/openapi.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -1300,6 +1300,33 @@
},
"required": ["type", "name", "provider"]
},
"previousAddress": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"environment",
"vault",
"memory_store",
"skill",
"agent",
"template",
"deployment",
"file",
"identity",
"channel"
]
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
}
},
"required": ["type", "name", "provider"]
},
"reason": {
"type": "string"
},
Expand Down
16 changes: 16 additions & 0 deletions apps/webui/src/lib/api/generated/schema.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -731,6 +731,22 @@ export interface paths {
name: string;
provider: string;
};
previousAddress?: {
/** @enum {string} */
type:
| "environment"
| "vault"
| "memory_store"
| "skill"
| "agent"
| "template"
| "deployment"
| "file"
| "identity"
| "channel";
name: string;
provider: string;
};
reason: string;
/** @enum {string} */
driftKind?: "none" | "local" | "remote" | "both";
Expand Down
23 changes: 18 additions & 5 deletions packages/sdk/src/internal/executor/executor.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { dirname, resolve } from "node:path";
import { UserError } from "../errors.ts";
import { computeComparableDesiredHash } from "../planner/comparable.ts";
import { getResourceDeclaration } from "../planner/declaration.ts";
import { computeResourceHash } from "../planner/hasher.ts";
import { computeReplacementFingerprint, computeResourceHash } from "../planner/hasher.ts";
import { buildReadinessBaseline } from "../planner/plan-semantics.ts";
import { ApiError, ConflictError } from "../providers/base-client.ts";
import { readComparableIfSupported } from "../providers/drift-support.ts";
Expand DownExpand Up@@ -229,8 +229,8 @@ async function executeAction(action: PlannedAction, provider: ResourceExecAdapte
resource: action.address,
message: `update ${action.address.type}.${action.address.name} (${action.address.provider}) — not found remotely, recreating`,
});
ctx.state.removeResource(action.address);
return executeActionInner({ ...action, action: "create" }, provider, ctx);
ctx.state.removeResource(action.previousAddress ?? action.address);
return executeActionInner({ ...action, action: "create", previousAddress: undefined }, provider, ctx);
}
}

Expand DownExpand Up@@ -317,7 +317,8 @@ async function executeActionInner(
}

const isUpdate = action.action === "update";
const existingId = isUpdate ? ctx.state.getResource(address)?.remote_id : undefined;
const priorAddress = action.previousAddress ?? address;
const existingId = isUpdate ? ctx.state.getResource(priorAddress)?.remote_id : undefined;

let result: RemoteResource;

Expand DownExpand Up@@ -652,7 +653,7 @@ async function executeActionInner(

// The externally-managed marker is sticky: it survives applies and is only
// cleared by removing the resource from state (`agents state rm` / destroy).
const priorResource = ctx.state.getResource(address);
const priorResource = ctx.state.getResource(priorAddress);
ctx.state.setResource({
address,
remote_id: result.id,
Expand All@@ -669,9 +670,11 @@ async function executeActionInner(
desired_readiness_baseline: buildReadinessBaseline(getResourceDeclaration(address, ctx.config)),
remote_hash: remoteHash,
remote_snapshot: remoteSnapshot,
replacement_fingerprint: computeReplacementFingerprint(address, ctx.config),
drift_paths: [],
drift_status: remoteHash ? "in_sync" : undefined,
});
if (action.previousAddress) ctx.state.removeResource(action.previousAddress);
return adopted;
}

Expand DownExpand Up@@ -719,6 +722,16 @@ async function adoptOnConflict(
// command, so fail with actionable guidance instead of the raw wire error.
function nameReservedError(err: unknown, address: ResourceAddress, searchName: string): UserError {
const detail = err instanceof ApiError ? err.message : String(err);
if (
address.type === "channel" &&
err instanceof ApiError &&
err.responseBody.includes("CHANNEL_CREDENTIAL_CONFLICT")
) {
return new UserError(
`${address.provider} rejected channel.${address.name} because its credentials are already used by another Channel. ` +
`Keep the existing Channel address so it can be updated in place, remove the old Channel first, or use a different credential set. (${detail})`,
);
}
return new UserError(
`${address.provider} reported ${address.type} "${searchName}" already exists, but it could not be found remotely to adopt. ` +
`This usually means it was recently deleted and the provider still reserves the name. ` +
Expand Down
8 changes: 8 additions & 0 deletions packages/sdk/src/internal/planner/hasher.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,14 @@ export async function computeResourceHash(
return contentHash(decl);
}

/** Stable, non-reversible identity hint for resources whose YAML key may change. */
export function computeReplacementFingerprint(address: ResourceAddress, config: ProjectConfig): string | undefined {
if (address.type !== "channel") return undefined;
const decl = config.channels?.[address.name];
if (!decl) return undefined;
return contentHash({ channel_type: decl.type, credentials: decl.credentials ?? {} });
}

function resolveChannelReferenceIds(
decl: { agent: string; identity?: string },
config: ProjectConfig,
Expand Down
85 changes: 84 additions & 1 deletion packages/sdk/src/internal/planner/planner.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import type { ExecutionPlan, PlannedAction } from "../types/plan.ts";
import type { ResourceAddress, StateFile } from "../types/state.ts";
import { addressKey } from "../types/state.ts";
import { getResourceDeclaration } from "./declaration.ts";
import { computeResourceHash } from "./hasher.ts";
import { computeReplacementFingerprint, computeResourceHash } from "./hasher.ts";
import { buildReadinessBaseline, classifyReadinessImpact, diffReadinessBaseline } from "./plan-semantics.ts";

export interface PlanOptions {
Expand DownExpand Up@@ -218,9 +218,92 @@ export async function buildPlan(
});
}

coalesceChannelRenames(actions, config, state);
return { actions, diagnostics: diagnostics.getAll() };
}

/**
* A YAML key is a resource address, but changing that key should not force a
* remote Channel replacement when the old and new declarations form one
* unambiguous same-type pair. Retaining the remote id is especially important
* for messaging providers that allow a credential set to belong to only one
* Channel at a time.
*/
function coalesceChannelRenames(actions: PlannedAction[], config: ProjectConfig, state: StateFile): void {
const creates = actions.filter((action) => action.action === "create" && action.address.type === "channel");
const deletes = actions.filter((action) => action.action === "delete" && action.address.type === "channel");
const stateByAddress = new Map(state.resources.map((resource) => [addressKey(resource.address), resource]));
const matchedDeletes = new Set<PlannedAction>();

for (const create of creates) {
const desiredType = config.channels?.[create.address.name]?.type;
if (!desiredType) continue;
const desiredFingerprint = computeReplacementFingerprint(create.address, config);
const candidates = deletes.filter((deletion) => {
if (matchedDeletes.has(deletion) || deletion.address.provider !== create.address.provider) return false;
const prior = stateByAddress.get(addressKey(deletion.address));
const snapshot = prior?.remote_snapshot as { channel_type?: unknown } | undefined;
if (snapshot?.channel_type !== desiredType) return false;
return !prior?.replacement_fingerprint || prior.replacement_fingerprint === desiredFingerprint;
});
if (candidates.length !== 1) continue;

const deletion = candidates[0]!;
const prior = stateByAddress.get(addressKey(deletion.address));
const competingCreates = creates.filter(
(candidate) =>
candidate !== create &&
candidate.address.provider === create.address.provider &&
config.channels?.[candidate.address.name]?.type === desiredType &&
(!prior?.replacement_fingerprint ||
computeReplacementFingerprint(candidate.address, config) === prior.replacement_fingerprint),
);
if (competingCreates.length > 0) continue;

create.action = "update";
create.previousAddress = deletion.address;
create.before = deletion.before;
create.driftKind = "local";
create.reason = `Channel key renamed from '${deletion.address.name}' (remote resource retained)`;
protectRenamedChannelDependencies(actions, stateByAddress, deletion, create);
matchedDeletes.add(deletion);
}

for (let index = actions.length - 1; index >= 0; index--) {
if (matchedDeletes.has(actions[index]!)) actions.splice(index, 1);
}
}

/** Do not delete the old Identity/Template when the Channel migration that releases it fails. */
function protectRenamedChannelDependencies(
actions: PlannedAction[],
stateByAddress: Map<string, StateFile["resources"][number]>,
deletion: PlannedAction,
replacement: PlannedAction,
): void {
const prior = stateByAddress.get(addressKey(deletion.address));
const snapshot = prior?.remote_snapshot as { identity_id?: unknown; template_id?: unknown } | undefined;
const referencedIds = new Set(
[snapshot?.identity_id, snapshot?.template_id].filter((id): id is string => typeof id === "string"),
);
if (referencedIds.size === 0) return;

for (const action of actions) {
if (
action.action !== "delete" ||
(action.address.type !== "identity" && action.address.type !== "template") ||
action.address.provider !== replacement.address.provider
) {
continue;
}
const dependency = stateByAddress.get(addressKey(action.address));
if (!dependency?.remote_id || !referencedIds.has(dependency.remote_id)) continue;
if (!action.dependencies.some((address) => addressKey(address) === addressKey(replacement.address))) {
action.dependencies.push(replacement.address);
}
}
}

/** Keep the old delivery resource alive when creating its new materialization fails. */
function deliveryReplacementAddress(address: ResourceAddress, graph: DependencyGraph): ResourceAddress | undefined {
if (address.type !== "agent" && address.type !== "template") return undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/sdk/src/internal/state/state-manager.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ export class StateManager implements IStateManager {
desired_readiness_baseline: r.desired_readiness_baseline as ResourceState["desired_readiness_baseline"],
remote_hash: r.remote_hash as string | undefined,
remote_snapshot: r.remote_snapshot,
replacement_fingerprint: r.replacement_fingerprint as string | undefined,
drift_paths: r.drift_paths as string[] | undefined,
drift_status: r.drift_status as ResourceState["drift_status"],
}));
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk/src/internal/types/dto.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,8 @@ export type PlanReadinessImpact = z.infer<typeof PlanReadinessImpactSchema>;
export const PlannedActionSchema = z.object({
action: ActionTypeSchema,
address: ResourceAddressSchema,
/** Existing state address to retain when this action is an inferred logical rename. */
previousAddress: ResourceAddressSchema.optional(),
reason: z.string(),
driftKind: DriftKindSchema.optional(),
readinessImpact: PlanReadinessImpactSchema.optional(),
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk/src/internal/types/state.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ export interface ResourceState {
desired_readiness_baseline?: ResourceReadinessBaseline;
remote_hash?: string;
remote_snapshot?: unknown;
/** Non-reversible declaration fingerprint used to infer safe logical renames. */
replacement_fingerprint?: string;
drift_paths?: string[];
drift_status?: "in_sync" | "drifted" | "missing" | "unchecked";
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix: migrate renamed channels in place by heimanba · Pull Request #78 · modelstudioai/OpenAgentPack · GitHub
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
27 changes: 27 additions & 0 deletions apps/server/openapi.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -1300,6 +1300,33 @@
},
"required": ["type", "name", "provider"]
},
"previousAddress": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"environment",
"vault",
"memory_store",
"skill",
"agent",
"template",
"deployment",
"file",
"identity",
"channel"
]
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
}
},
"required": ["type", "name", "provider"]
},
"reason": {
"type": "string"
},
Expand Down
16 changes: 16 additions & 0 deletions apps/webui/src/lib/api/generated/schema.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -731,6 +731,22 @@ export interface paths {
name: string;
provider: string;
};
previousAddress?: {
/** @enum {string} */
type:
| "environment"
| "vault"
| "memory_store"
| "skill"
| "agent"
| "template"
| "deployment"
| "file"
| "identity"
| "channel";
name: string;
provider: string;
};
reason: string;
/** @enum {string} */
driftKind?: "none" | "local" | "remote" | "both";
Expand Down
23 changes: 18 additions & 5 deletions packages/sdk/src/internal/executor/executor.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { dirname, resolve } from "node:path";
import { UserError } from "../errors.ts";
import { computeComparableDesiredHash } from "../planner/comparable.ts";
import { getResourceDeclaration } from "../planner/declaration.ts";
import { computeResourceHash } from "../planner/hasher.ts";
import { computeReplacementFingerprint, computeResourceHash } from "../planner/hasher.ts";
import { buildReadinessBaseline } from "../planner/plan-semantics.ts";
import { ApiError, ConflictError } from "../providers/base-client.ts";
import { readComparableIfSupported } from "../providers/drift-support.ts";
Expand DownExpand Up@@ -229,8 +229,8 @@ async function executeAction(action: PlannedAction, provider: ResourceExecAdapte
resource: action.address,
message: `update ${action.address.type}.${action.address.name} (${action.address.provider}) — not found remotely, recreating`,
});
ctx.state.removeResource(action.address);
return executeActionInner({ ...action, action: "create" }, provider, ctx);
ctx.state.removeResource(action.previousAddress ?? action.address);
return executeActionInner({ ...action, action: "create", previousAddress: undefined }, provider, ctx);
}
}

Expand DownExpand Up@@ -317,7 +317,8 @@ async function executeActionInner(
}

const isUpdate = action.action === "update";
const existingId = isUpdate ? ctx.state.getResource(address)?.remote_id : undefined;
const priorAddress = action.previousAddress ?? address;
const existingId = isUpdate ? ctx.state.getResource(priorAddress)?.remote_id : undefined;

let result: RemoteResource;

Expand DownExpand Up@@ -652,7 +653,7 @@ async function executeActionInner(

// The externally-managed marker is sticky: it survives applies and is only
// cleared by removing the resource from state (`agents state rm` / destroy).
const priorResource = ctx.state.getResource(address);
const priorResource = ctx.state.getResource(priorAddress);
ctx.state.setResource({
address,
remote_id: result.id,
Expand All@@ -669,9 +670,11 @@ async function executeActionInner(
desired_readiness_baseline: buildReadinessBaseline(getResourceDeclaration(address, ctx.config)),
remote_hash: remoteHash,
remote_snapshot: remoteSnapshot,
replacement_fingerprint: computeReplacementFingerprint(address, ctx.config),
drift_paths: [],
drift_status: remoteHash ? "in_sync" : undefined,
});
if (action.previousAddress) ctx.state.removeResource(action.previousAddress);
return adopted;
}

Expand DownExpand Up@@ -719,6 +722,16 @@ async function adoptOnConflict(
// command, so fail with actionable guidance instead of the raw wire error.
function nameReservedError(err: unknown, address: ResourceAddress, searchName: string): UserError {
const detail = err instanceof ApiError ? err.message : String(err);
if (
address.type === "channel" &&
err instanceof ApiError &&
err.responseBody.includes("CHANNEL_CREDENTIAL_CONFLICT")
) {
return new UserError(
`${address.provider} rejected channel.${address.name} because its credentials are already used by another Channel. ` +
`Keep the existing Channel address so it can be updated in place, remove the old Channel first, or use a different credential set. (${detail})`,
);
}
return new UserError(
`${address.provider} reported ${address.type} "${searchName}" already exists, but it could not be found remotely to adopt. ` +
`This usually means it was recently deleted and the provider still reserves the name. ` +
Expand Down
8 changes: 8 additions & 0 deletions packages/sdk/src/internal/planner/hasher.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,14 @@ export async function computeResourceHash(
return contentHash(decl);
}

/** Stable, non-reversible identity hint for resources whose YAML key may change. */
export function computeReplacementFingerprint(address: ResourceAddress, config: ProjectConfig): string | undefined {
if (address.type !== "channel") return undefined;
const decl = config.channels?.[address.name];
if (!decl) return undefined;
return contentHash({ channel_type: decl.type, credentials: decl.credentials ?? {} });
}

function resolveChannelReferenceIds(
decl: { agent: string; identity?: string },
config: ProjectConfig,
Expand Down
85 changes: 84 additions & 1 deletion packages/sdk/src/internal/planner/planner.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import type { ExecutionPlan, PlannedAction } from "../types/plan.ts";
import type { ResourceAddress, StateFile } from "../types/state.ts";
import { addressKey } from "../types/state.ts";
import { getResourceDeclaration } from "./declaration.ts";
import { computeResourceHash } from "./hasher.ts";
import { computeReplacementFingerprint, computeResourceHash } from "./hasher.ts";
import { buildReadinessBaseline, classifyReadinessImpact, diffReadinessBaseline } from "./plan-semantics.ts";

export interface PlanOptions {
Expand DownExpand Up@@ -218,9 +218,92 @@ export async function buildPlan(
});
}

coalesceChannelRenames(actions, config, state);
return { actions, diagnostics: diagnostics.getAll() };
}

/**
* A YAML key is a resource address, but changing that key should not force a
* remote Channel replacement when the old and new declarations form one
* unambiguous same-type pair. Retaining the remote id is especially important
* for messaging providers that allow a credential set to belong to only one
* Channel at a time.
*/
function coalesceChannelRenames(actions: PlannedAction[], config: ProjectConfig, state: StateFile): void {
const creates = actions.filter((action) => action.action === "create" && action.address.type === "channel");
const deletes = actions.filter((action) => action.action === "delete" && action.address.type === "channel");
const stateByAddress = new Map(state.resources.map((resource) => [addressKey(resource.address), resource]));
const matchedDeletes = new Set<PlannedAction>();

for (const create of creates) {
const desiredType = config.channels?.[create.address.name]?.type;
if (!desiredType) continue;
const desiredFingerprint = computeReplacementFingerprint(create.address, config);
const candidates = deletes.filter((deletion) => {
if (matchedDeletes.has(deletion) || deletion.address.provider !== create.address.provider) return false;
const prior = stateByAddress.get(addressKey(deletion.address));
const snapshot = prior?.remote_snapshot as { channel_type?: unknown } | undefined;
if (snapshot?.channel_type !== desiredType) return false;
return !prior?.replacement_fingerprint || prior.replacement_fingerprint === desiredFingerprint;
});
if (candidates.length !== 1) continue;

const deletion = candidates[0]!;
const prior = stateByAddress.get(addressKey(deletion.address));
const competingCreates = creates.filter(
(candidate) =>
candidate !== create &&
candidate.address.provider === create.address.provider &&
config.channels?.[candidate.address.name]?.type === desiredType &&
(!prior?.replacement_fingerprint ||
computeReplacementFingerprint(candidate.address, config) === prior.replacement_fingerprint),
);
if (competingCreates.length > 0) continue;

create.action = "update";
create.previousAddress = deletion.address;
create.before = deletion.before;
create.driftKind = "local";
create.reason = `Channel key renamed from '${deletion.address.name}' (remote resource retained)`;
protectRenamedChannelDependencies(actions, stateByAddress, deletion, create);
matchedDeletes.add(deletion);
}

for (let index = actions.length - 1; index >= 0; index--) {
if (matchedDeletes.has(actions[index]!)) actions.splice(index, 1);
}
}

/** Do not delete the old Identity/Template when the Channel migration that releases it fails. */
function protectRenamedChannelDependencies(
actions: PlannedAction[],
stateByAddress: Map<string, StateFile["resources"][number]>,
deletion: PlannedAction,
replacement: PlannedAction,
): void {
const prior = stateByAddress.get(addressKey(deletion.address));
const snapshot = prior?.remote_snapshot as { identity_id?: unknown; template_id?: unknown } | undefined;
const referencedIds = new Set(
[snapshot?.identity_id, snapshot?.template_id].filter((id): id is string => typeof id === "string"),
);
if (referencedIds.size === 0) return;

for (const action of actions) {
if (
action.action !== "delete" ||
(action.address.type !== "identity" && action.address.type !== "template") ||
action.address.provider !== replacement.address.provider
) {
continue;
}
const dependency = stateByAddress.get(addressKey(action.address));
if (!dependency?.remote_id || !referencedIds.has(dependency.remote_id)) continue;
if (!action.dependencies.some((address) => addressKey(address) === addressKey(replacement.address))) {
action.dependencies.push(replacement.address);
}
}
}

/** Keep the old delivery resource alive when creating its new materialization fails. */
function deliveryReplacementAddress(address: ResourceAddress, graph: DependencyGraph): ResourceAddress | undefined {
if (address.type !== "agent" && address.type !== "template") return undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/sdk/src/internal/state/state-manager.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ export class StateManager implements IStateManager {
desired_readiness_baseline: r.desired_readiness_baseline as ResourceState["desired_readiness_baseline"],
remote_hash: r.remote_hash as string | undefined,
remote_snapshot: r.remote_snapshot,
replacement_fingerprint: r.replacement_fingerprint as string | undefined,
drift_paths: r.drift_paths as string[] | undefined,
drift_status: r.drift_status as ResourceState["drift_status"],
}));
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk/src/internal/types/dto.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,8 @@ export type PlanReadinessImpact = z.infer<typeof PlanReadinessImpactSchema>;
export const PlannedActionSchema = z.object({
action: ActionTypeSchema,
address: ResourceAddressSchema,
/** Existing state address to retain when this action is an inferred logical rename. */
previousAddress: ResourceAddressSchema.optional(),
reason: z.string(),
driftKind: DriftKindSchema.optional(),
readinessImpact: PlanReadinessImpactSchema.optional(),
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk/src/internal/types/state.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ export interface ResourceState {
desired_readiness_baseline?: ResourceReadinessBaseline;
remote_hash?: string;
remote_snapshot?: unknown;
/** Non-reversible declaration fingerprint used to infer safe logical renames. */
replacement_fingerprint?: string;
drift_paths?: string[];
drift_status?: "in_sync" | "drifted" | "missing" | "unchecked";
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix: migrate renamed channels in place by heimanba · Pull Request #78 · modelstudioai/OpenAgentPack · GitHub
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
27 changes: 27 additions & 0 deletions apps/server/openapi.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -1300,6 +1300,33 @@
},
"required": ["type", "name", "provider"]
},
"previousAddress": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"environment",
"vault",
"memory_store",
"skill",
"agent",
"template",
"deployment",
"file",
"identity",
"channel"
]
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
}
},
"required": ["type", "name", "provider"]
},
"reason": {
"type": "string"
},
Expand Down
16 changes: 16 additions & 0 deletions apps/webui/src/lib/api/generated/schema.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -731,6 +731,22 @@ export interface paths {
name: string;
provider: string;
};
previousAddress?: {
/** @enum {string} */
type:
| "environment"
| "vault"
| "memory_store"
| "skill"
| "agent"
| "template"
| "deployment"
| "file"
| "identity"
| "channel";
name: string;
provider: string;
};
reason: string;
/** @enum {string} */
driftKind?: "none" | "local" | "remote" | "both";
Expand Down
23 changes: 18 additions & 5 deletions packages/sdk/src/internal/executor/executor.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { dirname, resolve } from "node:path";
import { UserError } from "../errors.ts";
import { computeComparableDesiredHash } from "../planner/comparable.ts";
import { getResourceDeclaration } from "../planner/declaration.ts";
import { computeResourceHash } from "../planner/hasher.ts";
import { computeReplacementFingerprint, computeResourceHash } from "../planner/hasher.ts";
import { buildReadinessBaseline } from "../planner/plan-semantics.ts";
import { ApiError, ConflictError } from "../providers/base-client.ts";
import { readComparableIfSupported } from "../providers/drift-support.ts";
Expand DownExpand Up@@ -229,8 +229,8 @@ async function executeAction(action: PlannedAction, provider: ResourceExecAdapte
resource: action.address,
message: `update ${action.address.type}.${action.address.name} (${action.address.provider}) — not found remotely, recreating`,
});
ctx.state.removeResource(action.address);
return executeActionInner({ ...action, action: "create" }, provider, ctx);
ctx.state.removeResource(action.previousAddress ?? action.address);
return executeActionInner({ ...action, action: "create", previousAddress: undefined }, provider, ctx);
}
}

Expand DownExpand Up@@ -317,7 +317,8 @@ async function executeActionInner(
}

const isUpdate = action.action === "update";
const existingId = isUpdate ? ctx.state.getResource(address)?.remote_id : undefined;
const priorAddress = action.previousAddress ?? address;
const existingId = isUpdate ? ctx.state.getResource(priorAddress)?.remote_id : undefined;

let result: RemoteResource;

Expand DownExpand Up@@ -652,7 +653,7 @@ async function executeActionInner(

// The externally-managed marker is sticky: it survives applies and is only
// cleared by removing the resource from state (`agents state rm` / destroy).
const priorResource = ctx.state.getResource(address);
const priorResource = ctx.state.getResource(priorAddress);
ctx.state.setResource({
address,
remote_id: result.id,
Expand All@@ -669,9 +670,11 @@ async function executeActionInner(
desired_readiness_baseline: buildReadinessBaseline(getResourceDeclaration(address, ctx.config)),
remote_hash: remoteHash,
remote_snapshot: remoteSnapshot,
replacement_fingerprint: computeReplacementFingerprint(address, ctx.config),
drift_paths: [],
drift_status: remoteHash ? "in_sync" : undefined,
});
if (action.previousAddress) ctx.state.removeResource(action.previousAddress);
return adopted;
}

Expand DownExpand Up@@ -719,6 +722,16 @@ async function adoptOnConflict(
// command, so fail with actionable guidance instead of the raw wire error.
function nameReservedError(err: unknown, address: ResourceAddress, searchName: string): UserError {
const detail = err instanceof ApiError ? err.message : String(err);
if (
address.type === "channel" &&
err instanceof ApiError &&
err.responseBody.includes("CHANNEL_CREDENTIAL_CONFLICT")
) {
return new UserError(
`${address.provider} rejected channel.${address.name} because its credentials are already used by another Channel. ` +
`Keep the existing Channel address so it can be updated in place, remove the old Channel first, or use a different credential set. (${detail})`,
);
}
return new UserError(
`${address.provider} reported ${address.type} "${searchName}" already exists, but it could not be found remotely to adopt. ` +
`This usually means it was recently deleted and the provider still reserves the name. ` +
Expand Down
8 changes: 8 additions & 0 deletions packages/sdk/src/internal/planner/hasher.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,14 @@ export async function computeResourceHash(
return contentHash(decl);
}

/** Stable, non-reversible identity hint for resources whose YAML key may change. */
export function computeReplacementFingerprint(address: ResourceAddress, config: ProjectConfig): string | undefined {
if (address.type !== "channel") return undefined;
const decl = config.channels?.[address.name];
if (!decl) return undefined;
return contentHash({ channel_type: decl.type, credentials: decl.credentials ?? {} });
}

function resolveChannelReferenceIds(
decl: { agent: string; identity?: string },
config: ProjectConfig,
Expand Down
85 changes: 84 additions & 1 deletion packages/sdk/src/internal/planner/planner.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import type { ExecutionPlan, PlannedAction } from "../types/plan.ts";
import type { ResourceAddress, StateFile } from "../types/state.ts";
import { addressKey } from "../types/state.ts";
import { getResourceDeclaration } from "./declaration.ts";
import { computeResourceHash } from "./hasher.ts";
import { computeReplacementFingerprint, computeResourceHash } from "./hasher.ts";
import { buildReadinessBaseline, classifyReadinessImpact, diffReadinessBaseline } from "./plan-semantics.ts";

export interface PlanOptions {
Expand DownExpand Up@@ -218,9 +218,92 @@ export async function buildPlan(
});
}

coalesceChannelRenames(actions, config, state);
return { actions, diagnostics: diagnostics.getAll() };
}

/**
* A YAML key is a resource address, but changing that key should not force a
* remote Channel replacement when the old and new declarations form one
* unambiguous same-type pair. Retaining the remote id is especially important
* for messaging providers that allow a credential set to belong to only one
* Channel at a time.
*/
function coalesceChannelRenames(actions: PlannedAction[], config: ProjectConfig, state: StateFile): void {
const creates = actions.filter((action) => action.action === "create" && action.address.type === "channel");
const deletes = actions.filter((action) => action.action === "delete" && action.address.type === "channel");
const stateByAddress = new Map(state.resources.map((resource) => [addressKey(resource.address), resource]));
const matchedDeletes = new Set<PlannedAction>();

for (const create of creates) {
const desiredType = config.channels?.[create.address.name]?.type;
if (!desiredType) continue;
const desiredFingerprint = computeReplacementFingerprint(create.address, config);
const candidates = deletes.filter((deletion) => {
if (matchedDeletes.has(deletion) || deletion.address.provider !== create.address.provider) return false;
const prior = stateByAddress.get(addressKey(deletion.address));
const snapshot = prior?.remote_snapshot as { channel_type?: unknown } | undefined;
if (snapshot?.channel_type !== desiredType) return false;
return !prior?.replacement_fingerprint || prior.replacement_fingerprint === desiredFingerprint;
});
if (candidates.length !== 1) continue;

const deletion = candidates[0]!;
const prior = stateByAddress.get(addressKey(deletion.address));
const competingCreates = creates.filter(
(candidate) =>
candidate !== create &&
candidate.address.provider === create.address.provider &&
config.channels?.[candidate.address.name]?.type === desiredType &&
(!prior?.replacement_fingerprint ||
computeReplacementFingerprint(candidate.address, config) === prior.replacement_fingerprint),
);
if (competingCreates.length > 0) continue;

create.action = "update";
create.previousAddress = deletion.address;
create.before = deletion.before;
create.driftKind = "local";
create.reason = `Channel key renamed from '${deletion.address.name}' (remote resource retained)`;
protectRenamedChannelDependencies(actions, stateByAddress, deletion, create);
matchedDeletes.add(deletion);
}

for (let index = actions.length - 1; index >= 0; index--) {
if (matchedDeletes.has(actions[index]!)) actions.splice(index, 1);
}
}

/** Do not delete the old Identity/Template when the Channel migration that releases it fails. */
function protectRenamedChannelDependencies(
actions: PlannedAction[],
stateByAddress: Map<string, StateFile["resources"][number]>,
deletion: PlannedAction,
replacement: PlannedAction,
): void {
const prior = stateByAddress.get(addressKey(deletion.address));
const snapshot = prior?.remote_snapshot as { identity_id?: unknown; template_id?: unknown } | undefined;
const referencedIds = new Set(
[snapshot?.identity_id, snapshot?.template_id].filter((id): id is string => typeof id === "string"),
);
if (referencedIds.size === 0) return;

for (const action of actions) {
if (
action.action !== "delete" ||
(action.address.type !== "identity" && action.address.type !== "template") ||
action.address.provider !== replacement.address.provider
) {
continue;
}
const dependency = stateByAddress.get(addressKey(action.address));
if (!dependency?.remote_id || !referencedIds.has(dependency.remote_id)) continue;
if (!action.dependencies.some((address) => addressKey(address) === addressKey(replacement.address))) {
action.dependencies.push(replacement.address);
}
}
}

/** Keep the old delivery resource alive when creating its new materialization fails. */
function deliveryReplacementAddress(address: ResourceAddress, graph: DependencyGraph): ResourceAddress | undefined {
if (address.type !== "agent" && address.type !== "template") return undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/sdk/src/internal/state/state-manager.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ export class StateManager implements IStateManager {
desired_readiness_baseline: r.desired_readiness_baseline as ResourceState["desired_readiness_baseline"],
remote_hash: r.remote_hash as string | undefined,
remote_snapshot: r.remote_snapshot,
replacement_fingerprint: r.replacement_fingerprint as string | undefined,
drift_paths: r.drift_paths as string[] | undefined,
drift_status: r.drift_status as ResourceState["drift_status"],
}));
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk/src/internal/types/dto.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,8 @@ export type PlanReadinessImpact = z.infer<typeof PlanReadinessImpactSchema>;
export const PlannedActionSchema = z.object({
action: ActionTypeSchema,
address: ResourceAddressSchema,
/** Existing state address to retain when this action is an inferred logical rename. */
previousAddress: ResourceAddressSchema.optional(),
reason: z.string(),
driftKind: DriftKindSchema.optional(),
readinessImpact: PlanReadinessImpactSchema.optional(),
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk/src/internal/types/state.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ export interface ResourceState {
desired_readiness_baseline?: ResourceReadinessBaseline;
remote_hash?: string;
remote_snapshot?: unknown;
/** Non-reversible declaration fingerprint used to infer safe logical renames. */
replacement_fingerprint?: string;
drift_paths?: string[];
drift_status?: "in_sync" | "drifted" | "missing" | "unchecked";
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); fix: migrate renamed channels in place by heimanba · Pull Request #78 · modelstudioai/OpenAgentPack · GitHub
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
27 changes: 27 additions & 0 deletions apps/server/openapi.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -1300,6 +1300,33 @@
},
"required": ["type", "name", "provider"]
},
"previousAddress": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"environment",
"vault",
"memory_store",
"skill",
"agent",
"template",
"deployment",
"file",
"identity",
"channel"
]
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
}
},
"required": ["type", "name", "provider"]
},
"reason": {
"type": "string"
},
Expand Down
16 changes: 16 additions & 0 deletions apps/webui/src/lib/api/generated/schema.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -731,6 +731,22 @@ export interface paths {
name: string;
provider: string;
};
previousAddress?: {
/** @enum {string} */
type:
| "environment"
| "vault"
| "memory_store"
| "skill"
| "agent"
| "template"
| "deployment"
| "file"
| "identity"
| "channel";
name: string;
provider: string;
};
reason: string;
/** @enum {string} */
driftKind?: "none" | "local" | "remote" | "both";
Expand Down
23 changes: 18 additions & 5 deletions packages/sdk/src/internal/executor/executor.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { dirname, resolve } from "node:path";
import { UserError } from "../errors.ts";
import { computeComparableDesiredHash } from "../planner/comparable.ts";
import { getResourceDeclaration } from "../planner/declaration.ts";
import { computeResourceHash } from "../planner/hasher.ts";
import { computeReplacementFingerprint, computeResourceHash } from "../planner/hasher.ts";
import { buildReadinessBaseline } from "../planner/plan-semantics.ts";
import { ApiError, ConflictError } from "../providers/base-client.ts";
import { readComparableIfSupported } from "../providers/drift-support.ts";
Expand DownExpand Up@@ -229,8 +229,8 @@ async function executeAction(action: PlannedAction, provider: ResourceExecAdapte
resource: action.address,
message: `update ${action.address.type}.${action.address.name} (${action.address.provider}) — not found remotely, recreating`,
});
ctx.state.removeResource(action.address);
return executeActionInner({ ...action, action: "create" }, provider, ctx);
ctx.state.removeResource(action.previousAddress ?? action.address);
return executeActionInner({ ...action, action: "create", previousAddress: undefined }, provider, ctx);
}
}

Expand DownExpand Up@@ -317,7 +317,8 @@ async function executeActionInner(
}

const isUpdate = action.action === "update";
const existingId = isUpdate ? ctx.state.getResource(address)?.remote_id : undefined;
const priorAddress = action.previousAddress ?? address;
const existingId = isUpdate ? ctx.state.getResource(priorAddress)?.remote_id : undefined;

let result: RemoteResource;

Expand DownExpand Up@@ -652,7 +653,7 @@ async function executeActionInner(

// The externally-managed marker is sticky: it survives applies and is only
// cleared by removing the resource from state (`agents state rm` / destroy).
const priorResource = ctx.state.getResource(address);
const priorResource = ctx.state.getResource(priorAddress);
ctx.state.setResource({
address,
remote_id: result.id,
Expand All@@ -669,9 +670,11 @@ async function executeActionInner(
desired_readiness_baseline: buildReadinessBaseline(getResourceDeclaration(address, ctx.config)),
remote_hash: remoteHash,
remote_snapshot: remoteSnapshot,
replacement_fingerprint: computeReplacementFingerprint(address, ctx.config),
drift_paths: [],
drift_status: remoteHash ? "in_sync" : undefined,
});
if (action.previousAddress) ctx.state.removeResource(action.previousAddress);
return adopted;
}

Expand DownExpand Up@@ -719,6 +722,16 @@ async function adoptOnConflict(
// command, so fail with actionable guidance instead of the raw wire error.
function nameReservedError(err: unknown, address: ResourceAddress, searchName: string): UserError {
const detail = err instanceof ApiError ? err.message : String(err);
if (
address.type === "channel" &&
err instanceof ApiError &&
err.responseBody.includes("CHANNEL_CREDENTIAL_CONFLICT")
) {
return new UserError(
`${address.provider} rejected channel.${address.name} because its credentials are already used by another Channel. ` +
`Keep the existing Channel address so it can be updated in place, remove the old Channel first, or use a different credential set. (${detail})`,
);
}
return new UserError(
`${address.provider} reported ${address.type} "${searchName}" already exists, but it could not be found remotely to adopt. ` +
`This usually means it was recently deleted and the provider still reserves the name. ` +
Expand Down
8 changes: 8 additions & 0 deletions packages/sdk/src/internal/planner/hasher.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,14 @@ export async function computeResourceHash(
return contentHash(decl);
}

/** Stable, non-reversible identity hint for resources whose YAML key may change. */
export function computeReplacementFingerprint(address: ResourceAddress, config: ProjectConfig): string | undefined {
if (address.type !== "channel") return undefined;
const decl = config.channels?.[address.name];
if (!decl) return undefined;
return contentHash({ channel_type: decl.type, credentials: decl.credentials ?? {} });
}

function resolveChannelReferenceIds(
decl: { agent: string; identity?: string },
config: ProjectConfig,
Expand Down
85 changes: 84 additions & 1 deletion packages/sdk/src/internal/planner/planner.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import type { ExecutionPlan, PlannedAction } from "../types/plan.ts";
import type { ResourceAddress, StateFile } from "../types/state.ts";
import { addressKey } from "../types/state.ts";
import { getResourceDeclaration } from "./declaration.ts";
import { computeResourceHash } from "./hasher.ts";
import { computeReplacementFingerprint, computeResourceHash } from "./hasher.ts";
import { buildReadinessBaseline, classifyReadinessImpact, diffReadinessBaseline } from "./plan-semantics.ts";

export interface PlanOptions {
Expand DownExpand Up@@ -218,9 +218,92 @@ export async function buildPlan(
});
}

coalesceChannelRenames(actions, config, state);
return { actions, diagnostics: diagnostics.getAll() };
}

/**
* A YAML key is a resource address, but changing that key should not force a
* remote Channel replacement when the old and new declarations form one
* unambiguous same-type pair. Retaining the remote id is especially important
* for messaging providers that allow a credential set to belong to only one
* Channel at a time.
*/
function coalesceChannelRenames(actions: PlannedAction[], config: ProjectConfig, state: StateFile): void {
const creates = actions.filter((action) => action.action === "create" && action.address.type === "channel");
const deletes = actions.filter((action) => action.action === "delete" && action.address.type === "channel");
const stateByAddress = new Map(state.resources.map((resource) => [addressKey(resource.address), resource]));
const matchedDeletes = new Set<PlannedAction>();

for (const create of creates) {
const desiredType = config.channels?.[create.address.name]?.type;
if (!desiredType) continue;
const desiredFingerprint = computeReplacementFingerprint(create.address, config);
const candidates = deletes.filter((deletion) => {
if (matchedDeletes.has(deletion) || deletion.address.provider !== create.address.provider) return false;
const prior = stateByAddress.get(addressKey(deletion.address));
const snapshot = prior?.remote_snapshot as { channel_type?: unknown } | undefined;
if (snapshot?.channel_type !== desiredType) return false;
return !prior?.replacement_fingerprint || prior.replacement_fingerprint === desiredFingerprint;
});
if (candidates.length !== 1) continue;

const deletion = candidates[0]!;
const prior = stateByAddress.get(addressKey(deletion.address));
const competingCreates = creates.filter(
(candidate) =>
candidate !== create &&
candidate.address.provider === create.address.provider &&
config.channels?.[candidate.address.name]?.type === desiredType &&
(!prior?.replacement_fingerprint ||
computeReplacementFingerprint(candidate.address, config) === prior.replacement_fingerprint),
);
if (competingCreates.length > 0) continue;

create.action = "update";
create.previousAddress = deletion.address;
create.before = deletion.before;
create.driftKind = "local";
create.reason = `Channel key renamed from '${deletion.address.name}' (remote resource retained)`;
protectRenamedChannelDependencies(actions, stateByAddress, deletion, create);
matchedDeletes.add(deletion);
}

for (let index = actions.length - 1; index >= 0; index--) {
if (matchedDeletes.has(actions[index]!)) actions.splice(index, 1);
}
}

/** Do not delete the old Identity/Template when the Channel migration that releases it fails. */
function protectRenamedChannelDependencies(
actions: PlannedAction[],
stateByAddress: Map<string, StateFile["resources"][number]>,
deletion: PlannedAction,
replacement: PlannedAction,
): void {
const prior = stateByAddress.get(addressKey(deletion.address));
const snapshot = prior?.remote_snapshot as { identity_id?: unknown; template_id?: unknown } | undefined;
const referencedIds = new Set(
[snapshot?.identity_id, snapshot?.template_id].filter((id): id is string => typeof id === "string"),
);
if (referencedIds.size === 0) return;

for (const action of actions) {
if (
action.action !== "delete" ||
(action.address.type !== "identity" && action.address.type !== "template") ||
action.address.provider !== replacement.address.provider
) {
continue;
}
const dependency = stateByAddress.get(addressKey(action.address));
if (!dependency?.remote_id || !referencedIds.has(dependency.remote_id)) continue;
if (!action.dependencies.some((address) => addressKey(address) === addressKey(replacement.address))) {
action.dependencies.push(replacement.address);
}
}
}

/** Keep the old delivery resource alive when creating its new materialization fails. */
function deliveryReplacementAddress(address: ResourceAddress, graph: DependencyGraph): ResourceAddress | undefined {
if (address.type !== "agent" && address.type !== "template") return undefined;
Expand Down
1 change: 1 addition & 0 deletions packages/sdk/src/internal/state/state-manager.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,7 @@ export class StateManager implements IStateManager {
desired_readiness_baseline: r.desired_readiness_baseline as ResourceState["desired_readiness_baseline"],
remote_hash: r.remote_hash as string | undefined,
remote_snapshot: r.remote_snapshot,
replacement_fingerprint: r.replacement_fingerprint as string | undefined,
drift_paths: r.drift_paths as string[] | undefined,
drift_status: r.drift_status as ResourceState["drift_status"],
}));
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk/src/internal/types/dto.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,8 @@ export type PlanReadinessImpact = z.infer<typeof PlanReadinessImpactSchema>;
export const PlannedActionSchema = z.object({
action: ActionTypeSchema,
address: ResourceAddressSchema,
/** Existing state address to retain when this action is an inferred logical rename. */
previousAddress: ResourceAddressSchema.optional(),
reason: z.string(),
driftKind: DriftKindSchema.optional(),
readinessImpact: PlanReadinessImpactSchema.optional(),
Expand Down
2 changes: 2 additions & 0 deletions packages/sdk/src/internal/types/state.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,8 @@ export interface ResourceState {
desired_readiness_baseline?: ResourceReadinessBaseline;
remote_hash?: string;
remote_snapshot?: unknown;
/** Non-reversible declaration fingerprint used to infer safe logical renames. */
replacement_fingerprint?: string;
drift_paths?: string[];
drift_status?: "in_sync" | "drifted" | "missing" | "unchecked";
}
Expand Down
Loading