pi-openai-toolkit 0.14.5 → 0.14.7

package/src/context-management/codex-provider.ts

@@ -1,7 +1,14 @@
 import type { Api, Model, ProviderHeaders } from "@earendil-works/pi-ai";
 import type { ExtensionContext } from "@earendil-works/pi-coding-agent";
 import { mergeProviderHeaders } from "../provider-headers";
-import { CODEX_CLIENT_VERSION } from "../responses-headers";
+import {
+	CODEX_AFFINITY_SCOPE,
+	CODEX_CLIENT_VERSION,
+	CODEX_GATEWAY_ORIGINATOR,
+	buildCodexCliUserAgent,
+	filterCodexGatewayHeaders,
+} from "../responses-headers";
+export { CODEX_AFFINITY_SCOPE } from "../responses-headers";
 import { normalizeBaseUrl } from "../runtime";
 import { isExactModelAllowed } from "../model-scope";
 import {
@@ -13,13 +20,10 @@ import {
 const CODEX_PROVIDER = "openai-codex";
 const CODEX_API = "openai-codex-responses";
 const GATEWAY_API = "openai-responses";
-const CODEX_TOOL_ORIGINATOR = "codex_cli_rs";
-const CODEX_GATEWAY_ORIGINATOR = "codex_cli_rs";
+const CODEX_TOOL_ORIGINATOR = CODEX_GATEWAY_ORIGINATOR;
 const CODEX_TOOL_VERSION = "0.0.0";
 const CODEX_SESSION_ID_MAX_LENGTH = 64;
 
-export const CODEX_AFFINITY_SCOPE = "codex-session-v1";
-
 export const CODEX_CONTEXT_PROVIDER_ERROR =
 	"Remote Context management requires a configured Codex-compatible backend";
 
@@ -103,9 +107,7 @@ function accountIdFromToken(token: string): string | undefined {
 }
 
 function userAgent(version: string): string {
-	const platform = typeof process !== "undefined" ? process.platform : "unknown";
-	const arch = typeof process !== "undefined" ? process.arch : "unknown";
-	return `codex_cli_rs/${version} (${platform}; ${arch})`;
+	return buildCodexCliUserAgent(version);
 }
 
 function clampSessionId(value: string | undefined): string | undefined {
@@ -117,17 +119,12 @@ function clampSessionId(value: string | undefined): string | undefined {
 		: chars.slice(0, CODEX_SESSION_ID_MAX_LENGTH).join("");
 }
 
-function removeSensitiveGatewayHeaders(headers: ProviderHeaders): Record<string, string> {
-	const result: Record<string, string> = {};
-	for (const [name, value] of Object.entries(headers)) {
-		if (typeof value !== "string") continue;
-		const lower = name.toLowerCase();
-		if (lower === "authorization" || lower === "cookie" || lower === "chatgpt-account-id" || lower === "x-api-key") {
-			continue;
-		}
-		result[name] = value;
+function resolveContextSessionId(ctx: ExtensionContext): string | undefined {
+	try {
+		return clampSessionId(ctx.sessionManager.getSessionId());
+	} catch {
+		return undefined;
 	}
-	return result;
 }
 
 export type CodexContextProviderHeaderOptions = {
@@ -164,7 +161,7 @@ export function codexContextProviderHeaders(
 	const sessionId = clampSessionId(options.sessionId);
 	if (sessionId) {
 		headers.set("Session-Id", sessionId);
-		headers.set("X-Client-Request-Id", options.clientRequestId?.trim() || sessionId);
+		headers.set("X-Client-Request-Id", clampSessionId(options.clientRequestId) ?? sessionId);
 	}
 	headers.set("content-type", "application/json");
 	return headers;
@@ -208,6 +205,9 @@ export async function resolveCodexContextProvider(
 	if (!rawBaseUrl) return { ok: false, reason: "missing-base-url", ...descriptor };
 
 	if (isGateway) {
+		if (!resolveContextSessionId(ctx)) {
+			return { ok: false, reason: "missing-session-id", ...descriptor, baseUrl: rawBaseUrl };
+		}
 		const apiKey = bearerToken(auth.apiKey) ?? bearerToken(headerValue(auth.headers, "authorization"));
 		if (!apiKey) return { ok: false, reason: "missing-api-key", ...descriptor, baseUrl: rawBaseUrl };
 		return {
@@ -220,7 +220,7 @@ export async function resolveCodexContextProvider(
 				model: model.id,
 				baseUrl: rawBaseUrl,
 				apiKey,
-				headers: removeSensitiveGatewayHeaders(mergeProviderHeaders(model.headers, auth.headers)),
+				headers: filterCodexGatewayHeaders(mergeProviderHeaders(model.headers, auth.headers)),
 			},
 		};
 	}

package/src/context-management/history-notes.ts

@@ -37,6 +37,11 @@ export const NOTES_ENDPOINTS = {
 	write_file: "alpha/notes/v2/write_file",
 } as const satisfies Record<NotesAction, string>;
 
+const NOTES_WRITE_ENDPOINTS = new Set<string>([
+	NOTES_ENDPOINTS.append_to_file,
+	NOTES_ENDPOINTS.write_file,
+]);
+
 export const ENCRYPTED_ARGUMENT_ENDPOINTS = new Set<string>([
 	HISTORY_ENDPOINTS.search_contents,
 	NOTES_ENDPOINTS.search_contents,
@@ -69,6 +74,28 @@ export interface CodexHistoryNotesDetails {
 	codexHistoryNotes: Record<string, unknown>;
 }
 
+/**
+ * Optional backend status flags are accepted only when explicitly affirmative;
+ * an omitted flag is compatible with older response shapes.
+ */
+export function isSuccessfulHistoryNotesResponse(value: unknown): value is HistoryNotesResponse {
+	return isRecord(value) && isAffirmativeOptionalBoolean(value.ok) && isAffirmativeOptionalBoolean(value.success);
+}
+
+/** Validate persisted tool-result details before using them as a checkpoint. */
+export function isSuccessfulHistoryNotesToolResult(details: unknown): details is CodexHistoryNotesDetails {
+	if (!isRecord(details) || !isRecord(details.codexHistoryNotes)) return false;
+	return isSuccessfulHistoryNotesResponse(details.codexHistoryNotes);
+}
+
+function isAffirmativeOptionalBoolean(value: unknown): boolean {
+	return value === undefined || value === true;
+}
+
+function isRejectedNotesWriteResponse(value: HistoryNotesResponse): boolean {
+	return value.ok === false || value.success === false;
+}
+
 export async function callHistoryNotesBackend(
 	endpoint: string,
 	arguments_: Record<string, unknown>,
@@ -172,6 +199,7 @@ export async function loadHistoryNotesThreadHint(
 		if (result.reason === "aborted") throw new Error("Remote context hint request was aborted");
 		return undefined;
 	}
+	if (!isSuccessfulHistoryNotesResponse(result.value)) return undefined;
 	const text = result.value.text;
 	return typeof text === "string" && Buffer.byteLength(text, "utf8") <= THREAD_HINT_MAX_BYTES ? text : undefined;
 }
@@ -198,6 +226,9 @@ export async function executeHistoryNotesTool(
 		gatewayModels,
 	);
 	if (!result.ok) throw new Error(formatHistoryNotesFailure(result.reason, result.status));
+	if (NOTES_WRITE_ENDPOINTS.has(endpoint) && isRejectedNotesWriteResponse(result.value)) {
+		throw new Error("Remote notes write was rejected");
+	}
 	const modelResult = { ...result.value };
 	delete modelResult.images;
 	const content: AgentToolResult<CodexHistoryNotesDetails>["content"] = [
@@ -227,6 +258,7 @@ export function formatHistoryNotesFailure(
 		case "missing-api-key": return "Remote history/notes gateway authentication is missing an API key";
 		case "missing-account-id": return "Remote history/notes authentication is missing an account id";
 		case "missing-base-url": return "Remote history/notes backend is missing a base URL";
+		case "missing-session-id": return "Remote history/notes request is missing a session id";
 		case "unsupported-backend": return "Remote history/notes require the native Codex backend";
 		case "protocol-error": return "Remote history/notes request failed";
 		case "invalid-account-token": return "Remote history/notes authentication token is invalid";

package/src/context-management/messages.ts

@@ -1,106 +1,112 @@
-import { randomUUID } from "node:crypto";
-import type { AgentMessage } from "@earendil-works/pi-agent-core";
-import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
-import {
-	CODEX_CONTEXT_WINDOW_MESSAGE_TYPE,
-	CONTEXT_MANAGEMENT_PROTOCOL,
-	CONTEXT_WINDOW_COMPACTION_STRATEGY,
-	CONTEXT_WINDOW_FALLBACK_BUFFER,
-	CONTEXT_WINDOW_REMINDER_THRESHOLD,
-	type CodexContextManagementMessageDetails,
-	type ContextManagementMessageKind,
-	type ContextWindowCompactionDetails,
-	type ContextWindowIdentity,
-	isCodexContextManagementMessageDetails,
-	isContextWindowCompactionDetails,
-} from "./types";
-
-export {
-	CODEX_CONTEXT_WINDOW_MESSAGE_TYPE,
-	CONTEXT_WINDOW_COMPACTION_STRATEGY,
-	CONTEXT_WINDOW_FALLBACK_BUFFER,
-	CONTEXT_WINDOW_REMINDER_THRESHOLD,
-	isCodexContextManagementMessageDetails,
-	isContextWindowCompactionDetails,
-};
-export type {
-	CodexContextManagementMessageDetails,
-	ContextManagementMessageKind,
-	ContextWindowCompactionDetails,
-	ContextWindowIdentity,
-};
-
-export const CONTEXT_WINDOW_COMPACTION_SUMMARY =
-	"[Pi Codex context-window boundary; no conversation summary was generated.]";
-
-const CONTEXT_WINDOW_GUIDANCE = `<context_window_guidance>
-Checkpoint the active request, known history IDs, decisions, progress, learnings and next steps in notes before new_context; no summary carries over. After rollover, read hinted notes. Use history only for a missing detail.
-</context_window_guidance>`;
-
-export function renderContextWindowMessage(
-	identity: ContextWindowIdentity,
-	threadHint?: string,
-): string {
-	const lines = [
-		"<context_window>",
-		"Agent name: /root",
-		`First context window id: ${identity.firstWindowId}`,
-		`Current context window id: ${identity.currentWindowId}`,
-	];
-	if (identity.previousWindowId) lines.push(`Previous context window id: ${identity.previousWindowId}`);
-	if (threadHint) lines.push(threadHint);
-	lines.push("</context_window>");
-	return `${CONTEXT_WINDOW_GUIDANCE}\n\n${lines.join("\n")}`;
-}
-
-export function renderContextWindowReminder(remainingTokens: number): string {
-	return `<context_window_reminder>
-Only ${Math.max(0, Math.floor(remainingTokens))} context tokens remain. Checkpoint the active request, state and known history IDs in notes, then call new_context; no conversation summary carries over.
-</context_window_reminder>`;
-}
-
-export const CONTEXT_WINDOW_FALLBACK_MESSAGE = `<context_window_reminder>
-Context exhausted. Do not continue or answer. Make exactly one notes write or append call that checkpoints the active request, state and known history IDs, then call new_context. Use no other tools before rollover.
-</context_window_reminder>`;
-
-export function isContextWindowBoundary(
-	message: AgentMessage,
-): message is Extract<AgentMessage, { role: "custom" }> & {
-	details: CodexContextManagementMessageDetails;
-} {
-	return (
-		message.role === "custom" &&
-		message.customType === CODEX_CONTEXT_WINDOW_MESSAGE_TYPE &&
-		isCodexContextManagementMessageDetails(message.details) &&
-		message.details.contextManagement.kind === "window"
-	);
-}
-
-export function sendContextWindowMessage(
-	pi: ExtensionAPI,
-	content: string,
-	kind: ContextManagementMessageKind,
-	identity: ContextWindowIdentity,
-	options: { triggerTurn: boolean; sessionId?: string },
-	trimPreviousWindow = false,
-): void {
-	const details: CodexContextManagementMessageDetails = {
-		protocol: CONTEXT_MANAGEMENT_PROTOCOL,
-		id: randomUUID(),
-		...(options.sessionId ? { sessionId: options.sessionId } : {}),
-		contextManagement: {
-			protocol: CONTEXT_MANAGEMENT_PROTOCOL,
-			kind,
-			...identity,
-			...(trimPreviousWindow ? { trimPreviousWindow: true as const } : {}),
-		},
-	};
-	pi.sendMessage({
-		customType: CODEX_CONTEXT_WINDOW_MESSAGE_TYPE,
-		content,
-		display: true,
-		details,
-	}, options.triggerTurn
-		? { deliverAs: "steer", triggerTurn: true }
-		: { triggerTurn: false });
-}
+import { randomUUID } from "node:crypto";
+import type { AgentMessage } from "@earendil-works/pi-agent-core";
+import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
+import {
+	CODEX_CONTEXT_WINDOW_MESSAGE_TYPE,
+	CONTEXT_MANAGEMENT_PROTOCOL,
+	CONTEXT_WINDOW_COMPACTION_STRATEGY,
+	CONTEXT_WINDOW_FALLBACK_BUFFER,
+	CONTEXT_WINDOW_REMINDER_THRESHOLD,
+	type CodexContextManagementMessageDetails,
+	type ContextManagementMessageKind,
+	type ContextWindowCompactionDetails,
+	type ContextWindowIdentity,
+	type NotesCheckpointReceipt,
+	isCodexContextManagementMessageDetails,
+	isContextWindowCompactionDetails,
+} from "./types";
+
+export {
+	CODEX_CONTEXT_WINDOW_MESSAGE_TYPE,
+	CONTEXT_WINDOW_COMPACTION_STRATEGY,
+	CONTEXT_WINDOW_FALLBACK_BUFFER,
+	CONTEXT_WINDOW_REMINDER_THRESHOLD,
+	isCodexContextManagementMessageDetails,
+	isContextWindowCompactionDetails,
+};
+export type {
+	CodexContextManagementMessageDetails,
+	ContextManagementMessageKind,
+	ContextWindowCompactionDetails,
+	ContextWindowIdentity,
+};
+
+export const CONTEXT_WINDOW_COMPACTION_SUMMARY =
+	"[Pi Codex context-window boundary; no conversation summary was generated.]";
+
+const CONTEXT_WINDOW_GUIDANCE = `<context_window_guidance>
+Checkpoint the active request, known history IDs, decisions, progress, learnings and next steps in notes before new_context; no summary carries over. After rollover, read the checkpoint receipt note first when present; use a thread hint only as supplemental guidance. Use history only for a missing detail.
+</context_window_guidance>`;
+
+export function renderContextWindowMessage(
+	identity: ContextWindowIdentity,
+	threadHint?: string,
+	checkpoint?: NotesCheckpointReceipt,
+): string {
+	const lines = [
+		"<context_window>",
+		"Agent name: /root",
+		`First context window id: ${identity.firstWindowId}`,
+		`Current context window id: ${identity.currentWindowId}`,
+	];
+	if (identity.previousWindowId) lines.push(`Previous context window id: ${identity.previousWindowId}`);
+	if (checkpoint) {
+		lines.push("Checkpoint successfully written:");
+		lines.push(`  Read this note before doing anything else with notes action "read_file": ${JSON.stringify(checkpoint.path)}`);
+	}
+	if (threadHint) lines.push(threadHint);
+	lines.push("</context_window>");
+	return `${CONTEXT_WINDOW_GUIDANCE}\n\n${lines.join("\n")}`;
+}
+
+export function renderContextWindowReminder(remainingTokens: number): string {
+	return `<context_window_reminder>
+Only ${Math.max(0, Math.floor(remainingTokens))} context tokens remain. Checkpoint the active request, state and known history IDs in notes, then call new_context; no conversation summary carries over.
+</context_window_reminder>`;
+}
+
+export const CONTEXT_WINDOW_FALLBACK_MESSAGE = `<context_window_reminder>
+Context exhausted. Do not continue or answer. Make exactly one notes write or append call that checkpoints the active request, state and known history IDs, then call new_context. Use no other tools before rollover.
+</context_window_reminder>`;
+
+export function isContextWindowBoundary(
+	message: AgentMessage,
+): message is Extract<AgentMessage, { role: "custom" }> & {
+	details: CodexContextManagementMessageDetails;
+} {
+	return (
+		message.role === "custom" &&
+		message.customType === CODEX_CONTEXT_WINDOW_MESSAGE_TYPE &&
+		isCodexContextManagementMessageDetails(message.details) &&
+		message.details.contextManagement.kind === "window"
+	);
+}
+
+export function sendContextWindowMessage(
+	pi: ExtensionAPI,
+	content: string,
+	kind: ContextManagementMessageKind,
+	identity: ContextWindowIdentity,
+	options: { triggerTurn: boolean; sessionId?: string },
+	trimPreviousWindow = false,
+): void {
+	const details: CodexContextManagementMessageDetails = {
+		protocol: CONTEXT_MANAGEMENT_PROTOCOL,
+		id: randomUUID(),
+		...(options.sessionId ? { sessionId: options.sessionId } : {}),
+		contextManagement: {
+			protocol: CONTEXT_MANAGEMENT_PROTOCOL,
+			kind,
+			...identity,
+			...(trimPreviousWindow ? { trimPreviousWindow: true as const } : {}),
+		},
+	};
+	pi.sendMessage({
+		customType: CODEX_CONTEXT_WINDOW_MESSAGE_TYPE,
+		content,
+		display: true,
+		details,
+	}, options.triggerTurn
+		? { deliverAs: "steer", triggerTurn: true }
+		: { triggerTurn: false });
+}