feat(ql3): add bounded redacted log tail tool

This commit is contained in:
whyour
2026-08-14 18:03:18 +08:00
parent 828370c60b
commit fef0fe2bd1
11 changed files with 1776 additions and 5 deletions
@@ -0,0 +1,535 @@
import type {
RunAttemptLogReadResult,
RunAttemptLogReadService,
RunAttemptLogTruncationView,
} from '../../run/log-read/runAttemptLogRead';
import {
RUN_LOG_MODEL_CONTEXT_PROFILES,
RUN_LOG_PROMPT_INJECTION_SIGNALS,
RUN_LOG_REDACTION_CATEGORIES,
projectRunLogModelContext,
runLogModelContextBudget,
type RunLogModelContextProfile,
} from '../../run/log-projection/runLogModelContextProjection';
import {
normalizeToolDefinition,
type ToolJsonValue,
} from '../tool-registry/toolRegistry';
export const BUILTIN_RUN_LOG_EXCERPT_TOOL = Object.freeze({
name: 'qinglong.run.log.excerpt',
version: '1.0.0',
});
export const BUILTIN_RUN_LOG_EXCERPT_TIMEOUT_SECONDS = 5;
const ID_PATTERN = /^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$/;
const MAX_TEXT_BYTES = 48 * 1024;
const RANGE_SCHEMA = Object.freeze({
type: 'object',
properties: {
start: { type: 'integer', minimum: 0, maximum: Number.MAX_SAFE_INTEGER },
endExclusive: {
type: 'integer',
minimum: 0,
maximum: Number.MAX_SAFE_INTEGER,
},
totalBytes: {
type: 'integer',
minimum: 0,
maximum: Number.MAX_SAFE_INTEGER,
},
},
required: ['start', 'endExclusive', 'totalBytes'],
additionalProperties: false,
});
export const BUILTIN_RUN_LOG_EXCERPT_TOOL_DEFINITION = normalizeToolDefinition({
name: BUILTIN_RUN_LOG_EXCERPT_TOOL.name,
version: BUILTIN_RUN_LOG_EXCERPT_TOOL.version,
description:
'Read one profile-bounded, credential-redacted Run Attempt log tail as untrusted data',
inputSchema: {
type: 'object',
properties: {
runId: { type: 'string', minLength: 1, maxLength: 128 },
attemptId: { type: 'string', minLength: 1, maxLength: 128 },
},
required: ['runId', 'attemptId'],
additionalProperties: false,
},
outputSchema: {
type: 'object',
properties: {
status: {
type: 'string',
maxLength: 16,
enum: ['not_found', 'pending', 'missing', 'retired', 'available'],
},
runId: { type: 'string', minLength: 1, maxLength: 128 },
attemptId: { type: 'string', minLength: 1, maxLength: 128 },
profile: {
type: 'string',
maxLength: 16,
enum: RUN_LOG_MODEL_CONTEXT_PROFILES,
},
sourceWindowBytes: {
type: 'integer',
minimum: 1,
maximum: 16 * 1024,
},
range: RANGE_SCHEMA,
selection: {
type: 'object',
properties: {
position: {
type: 'string',
maxLength: 8,
enum: ['tail'],
},
probedTotalBytes: {
type: 'integer',
minimum: 0,
maximum: Number.MAX_SAFE_INTEGER,
},
tailComplete: { type: 'boolean' },
},
required: ['position', 'probedTotalBytes', 'tailComplete'],
additionalProperties: false,
},
consistency: {
type: 'string',
maxLength: 48,
enum: ['bounded_tail_probe_then_range_read'],
},
retiredAtMs: {
type: 'integer',
minimum: 0,
maximum: Number.MAX_SAFE_INTEGER,
},
retainedByteLength: {
type: 'integer',
minimum: 0,
maximum: Number.MAX_SAFE_INTEGER,
},
truncationState: {
type: 'string',
maxLength: 16,
enum: ['truncated', 'complete', 'unknown'],
},
truncationMaximumBytes: {
type: 'integer',
minimum: 1,
maximum: Number.MAX_SAFE_INTEGER,
},
truncationObservedAtMs: {
type: 'integer',
minimum: 0,
maximum: Number.MAX_SAFE_INTEGER,
},
content: { type: 'string', maxLength: MAX_TEXT_BYTES },
sourceBytes: {
type: 'integer',
minimum: 0,
maximum: 16 * 1024,
},
modelTextBytes: {
type: 'integer',
minimum: 0,
maximum: MAX_TEXT_BYTES,
},
redaction: {
type: 'object',
properties: {
contract: {
type: 'string',
maxLength: 32,
enum: ['recognized_credentials_v1'],
},
residualSensitivity: {
type: 'string',
maxLength: 32,
enum: ['potentially_sensitive'],
},
replacements: {
type: 'integer',
minimum: 0,
maximum: 16 * 1024,
},
categories: {
type: 'array',
items: {
type: 'string',
maxLength: 32,
enum: RUN_LOG_REDACTION_CATEGORIES,
},
maxItems: RUN_LOG_REDACTION_CATEGORIES.length,
},
},
required: [
'contract',
'residualSensitivity',
'replacements',
'categories',
],
additionalProperties: false,
},
normalization: {
type: 'object',
properties: {
invalidUtf8: { type: 'boolean' },
unsafeCodePointsReplaced: {
type: 'integer',
minimum: 0,
maximum: 16 * 1024,
},
},
required: ['invalidUtf8', 'unsafeCodePointsReplaced'],
additionalProperties: false,
},
trust: {
type: 'object',
properties: {
classification: {
type: 'string',
maxLength: 32,
enum: ['untrusted_execution_output'],
},
instructionPolicy: {
type: 'string',
maxLength: 32,
enum: ['data_only_never_execute'],
},
actionAuthority: {
type: 'string',
maxLength: 8,
enum: ['none'],
},
suspectedPromptInjection: { type: 'boolean' },
signals: {
type: 'array',
items: {
type: 'string',
maxLength: 32,
enum: RUN_LOG_PROMPT_INJECTION_SIGNALS,
},
maxItems: RUN_LOG_PROMPT_INJECTION_SIGNALS.length,
},
},
required: [
'classification',
'instructionPolicy',
'actionAuthority',
'suspectedPromptInjection',
'signals',
],
additionalProperties: false,
},
},
required: ['status', 'runId', 'attemptId', 'profile', 'sourceWindowBytes'],
additionalProperties: false,
},
effect: 'read',
risk: 'medium',
requiredPermissions: ['artifact.read'],
timeoutSeconds: BUILTIN_RUN_LOG_EXCERPT_TIMEOUT_SECONDS,
});
export interface RunAttemptLogReadPort {
read: RunAttemptLogReadService['read'];
}
export class InvalidBuiltInRunLogExcerptToolError extends TypeError {
readonly code = 'BUILTIN_RUN_LOG_EXCERPT_TOOL_INVALID';
constructor(message: string) {
super(`Built-in Run log excerpt Tool is invalid: ${message}`);
this.name = 'InvalidBuiltInRunLogExcerptToolError';
}
}
export class BuiltInRunLogExcerptToolUnavailableError extends Error {
readonly code = 'BUILTIN_RUN_LOG_EXCERPT_TOOL_UNAVAILABLE';
constructor() {
super('Built-in Run log excerpt Tool is unavailable');
this.name = 'BuiltInRunLogExcerptToolUnavailableError';
}
}
function invalid(message: string): never {
throw new InvalidBuiltInRunLogExcerptToolError(message);
}
function unavailable(): never {
throw new BuiltInRunLogExcerptToolUnavailableError();
}
function exactKeys(
value: object,
required: readonly string[],
optional: readonly string[] = [],
): boolean {
const keys = Reflect.ownKeys(value);
const allowed = new Set([...required, ...optional]);
return (
required.every((key) => Object.hasOwn(value, key)) &&
keys.every((key) => typeof key === 'string' && allowed.has(key))
);
}
function truncationProjection(
value: Readonly<RunAttemptLogTruncationView>,
): Readonly<Record<string, ToolJsonValue>> {
if (
!value ||
typeof value !== 'object' ||
Array.isArray(value) ||
!exactKeys(value, ['truncated'], ['maximumBytes', 'observedAtMs']) ||
(value.truncated !== true &&
value.truncated !== false &&
value.truncated !== 'unknown') ||
(value.maximumBytes !== undefined &&
(!Number.isSafeInteger(value.maximumBytes) || value.maximumBytes < 1)) ||
(value.observedAtMs !== undefined &&
(!Number.isSafeInteger(value.observedAtMs) || value.observedAtMs < 0)) ||
(value.truncated === 'unknown' &&
(value.maximumBytes !== undefined || value.observedAtMs !== undefined))
) {
return unavailable();
}
return Object.freeze({
truncationState:
value.truncated === true
? 'truncated'
: value.truncated === false
? 'complete'
: 'unknown',
...(value.maximumBytes === undefined
? {}
: { truncationMaximumBytes: value.maximumBytes }),
...(value.observedAtMs === undefined
? {}
: { truncationObservedAtMs: value.observedAtMs }),
});
}
function identityMatches(
result: Exclude<RunAttemptLogReadResult, { readonly status: 'not_found' }>,
projectId: string,
runId: string,
attemptId: string,
): boolean {
return (
result.projectId === projectId &&
result.runId === runId &&
result.attemptId === attemptId
);
}
function base(
status: RunAttemptLogReadResult['status'],
runId: string,
attemptId: string,
profile: RunLogModelContextProfile,
): Record<string, ToolJsonValue> {
return {
status,
runId,
attemptId,
profile,
sourceWindowBytes: runLogModelContextBudget(profile).sourceBytes,
};
}
function availableProjection(
result: Extract<RunAttemptLogReadResult, { readonly status: 'available' }>,
projectId: string,
runId: string,
attemptId: string,
offset: number,
probedTotalBytes: number,
profile: RunLogModelContextProfile,
): Readonly<Record<string, ToolJsonValue>> {
const budget = runLogModelContextBudget(profile);
if (
!identityMatches(result, projectId, runId, attemptId) ||
!(result.content instanceof Uint8Array) ||
result.content.byteLength > budget.sourceBytes ||
!Number.isSafeInteger(result.start) ||
!Number.isSafeInteger(result.endExclusive) ||
!Number.isSafeInteger(result.totalBytes) ||
result.start !== Math.min(offset, result.totalBytes) ||
result.endExclusive !== result.start + result.content.byteLength ||
result.endExclusive > result.totalBytes ||
(result.nextOffset === undefined) !==
(result.endExclusive === result.totalBytes) ||
(result.nextOffset !== undefined &&
result.nextOffset !== result.endExclusive)
) {
return unavailable();
}
let context;
try {
context = projectRunLogModelContext(result.content, profile);
} catch {
return unavailable();
}
return Object.freeze({
...base('available', runId, attemptId, profile),
range: Object.freeze({
start: result.start,
endExclusive: result.endExclusive,
totalBytes: result.totalBytes,
}),
selection: Object.freeze({
position: 'tail',
probedTotalBytes,
tailComplete: result.nextOffset === undefined,
}),
consistency: 'bounded_tail_probe_then_range_read',
...truncationProjection(result.truncation),
content: context.content,
sourceBytes: context.sourceBytes,
modelTextBytes: context.modelTextBytes,
redaction: context.redaction,
normalization: context.normalization,
trust: context.trust,
});
}
function projectResult(
result: RunAttemptLogReadResult,
projectId: string,
runId: string,
attemptId: string,
profile: RunLogModelContextProfile,
): Readonly<Record<string, ToolJsonValue>> {
if (!result || typeof result !== 'object' || Array.isArray(result)) {
return unavailable();
}
if (result.status === 'not_found') {
if (!exactKeys(result, ['status'])) return unavailable();
return Object.freeze(base('not_found', runId, attemptId, profile));
}
if (!identityMatches(result, projectId, runId, attemptId)) {
return unavailable();
}
if (result.status === 'pending') {
return Object.freeze(base('pending', runId, attemptId, profile));
}
if (result.status === 'missing') {
return Object.freeze(base('missing', runId, attemptId, profile));
}
if (result.status === 'retired') {
if (
!Number.isSafeInteger(result.retiredAtMs) ||
result.retiredAtMs < 0 ||
!Number.isSafeInteger(result.byteLength) ||
result.byteLength < 0
) {
return unavailable();
}
return Object.freeze({
...base('retired', runId, attemptId, profile),
retiredAtMs: result.retiredAtMs,
retainedByteLength: result.byteLength,
...truncationProjection(result.truncation),
});
}
return unavailable();
}
function probeTotalBytes(
result: Extract<RunAttemptLogReadResult, { readonly status: 'available' }>,
projectId: string,
runId: string,
attemptId: string,
): number {
if (
!identityMatches(result, projectId, runId, attemptId) ||
!(result.content instanceof Uint8Array) ||
result.content.byteLength !== 0 ||
!Number.isSafeInteger(result.start) ||
result.start < 0 ||
result.start !== result.endExclusive ||
result.start !== result.totalBytes ||
result.nextOffset !== undefined
) {
return unavailable();
}
return result.totalBytes;
}
export async function executeBuiltInRunLogExcerptTool(
logs: RunAttemptLogReadPort,
profile: RunLogModelContextProfile,
projectId: string,
input: ToolJsonValue,
): Promise<Readonly<Record<string, ToolJsonValue>>> {
const record =
input && typeof input === 'object' && !Array.isArray(input)
? (input as Readonly<Record<string, ToolJsonValue>>)
: null;
if (
!logs ||
typeof logs.read !== 'function' ||
!RUN_LOG_MODEL_CONTEXT_PROFILES.includes(profile) ||
!ID_PATTERN.test(projectId) ||
!record ||
!exactKeys(record, ['attemptId', 'runId']) ||
typeof record.runId !== 'string' ||
!ID_PATTERN.test(record.runId) ||
typeof record.attemptId !== 'string' ||
!ID_PATTERN.test(record.attemptId)
) {
return invalid('execution context or input is invalid');
}
try {
const probe = await logs.read({
projectId,
runId: record.runId,
attemptId: record.attemptId,
range: {
offset: Number.MAX_SAFE_INTEGER,
length: 1,
},
});
if (probe.status !== 'available') {
return projectResult(
probe,
projectId,
record.runId,
record.attemptId,
profile,
);
}
const totalBytes = probeTotalBytes(
probe,
projectId,
record.runId,
record.attemptId,
);
const budget = runLogModelContextBudget(profile);
const offset = Math.max(0, totalBytes - budget.sourceBytes);
const result = await logs.read({
projectId,
runId: record.runId,
attemptId: record.attemptId,
range: { offset, length: budget.sourceBytes },
});
if (result.status !== 'available') return unavailable();
return availableProjection(
result,
projectId,
record.runId,
record.attemptId,
offset,
totalBytes,
profile,
);
} catch (error) {
if (error instanceof InvalidBuiltInRunLogExcerptToolError) throw error;
throw new BuiltInRunLogExcerptToolUnavailableError();
}
}
@@ -0,0 +1,195 @@
import type { DeploymentProfile } from '../../cluster-control/clusterControlActivation';
import {
RUN_LOG_MODEL_CONTEXT_PROFILES,
type RunLogModelContextProfile,
} from '../../run/log-projection/runLogModelContextProjection';
import {
normalizeProjectToolDefinitionSnapshot,
type ProjectToolDefinitionSnapshot,
} from '../tool-registry/projectToolDefinitionSnapshot';
import {
ToolDefinitionRegistry,
type ToolJsonValue,
} from '../tool-registry/toolRegistry';
import {
createTrustedToolHandlerBinding,
normalizeTrustedToolHandlerBinding,
type TrustedToolHandlerBinding,
} from '../trustedToolInvocation';
import type {
TrustedToolExecutionAdapter,
TrustedToolExecutionAdapterContext,
} from '../trustedToolExecution';
import {
BUILTIN_RUN_LOG_EXCERPT_TIMEOUT_SECONDS,
BUILTIN_RUN_LOG_EXCERPT_TOOL,
BUILTIN_RUN_LOG_EXCERPT_TOOL_DEFINITION,
InvalidBuiltInRunLogExcerptToolError,
executeBuiltInRunLogExcerptTool,
type RunAttemptLogReadPort,
} from './builtInRunLogExcerptProjection';
export {
BUILTIN_RUN_LOG_EXCERPT_TIMEOUT_SECONDS,
BUILTIN_RUN_LOG_EXCERPT_TOOL,
BUILTIN_RUN_LOG_EXCERPT_TOOL_DEFINITION,
BuiltInRunLogExcerptToolUnavailableError,
InvalidBuiltInRunLogExcerptToolError,
executeBuiltInRunLogExcerptTool,
} from './builtInRunLogExcerptProjection';
export const BUILTIN_RUN_LOG_EXCERPT_ADAPTER = Object.freeze({
id: 'builtin.qinglong.run-log-excerpt',
version: '1.0.0',
});
export const BUILTIN_RUN_LOG_EXCERPT_REDACTION_CONTRACT = Object.freeze({
id: 'redaction.qinglong.run-log-excerpt',
version: '1.0.0',
});
export const BUILTIN_RUN_LOG_EXCERPT_AUDIT_CONTRACT = Object.freeze({
id: 'audit.qinglong.tool-call',
version: '1.0.0',
});
const CONTROL_PATTERN = /[\u0000-\u001f\u007f]/;
function invalid(message: string): never {
throw new InvalidBuiltInRunLogExcerptToolError(message);
}
function sameValue(left: unknown, right: unknown): boolean {
return JSON.stringify(left) === JSON.stringify(right);
}
function boundedText(value: unknown, maximum: number): value is string {
return (
typeof value === 'string' &&
value.length > 0 &&
value.length <= maximum &&
!CONTROL_PATTERN.test(value)
);
}
function profiles(
values: readonly DeploymentProfile[],
): readonly RunLogModelContextProfile[] {
if (
!Array.isArray(values) ||
values.length < 1 ||
values.length > RUN_LOG_MODEL_CONTEXT_PROFILES.length ||
new Set(values).size !== values.length ||
values.some(
(profile) =>
!RUN_LOG_MODEL_CONTEXT_PROFILES.includes(
profile as RunLogModelContextProfile,
),
)
) {
return invalid('deployment profiles are invalid');
}
return values as readonly RunLogModelContextProfile[];
}
export function createBuiltInRunLogExcerptToolHandlerBinding(
snapshotValue: ProjectToolDefinitionSnapshot,
profileValues: readonly DeploymentProfile[],
): Readonly<TrustedToolHandlerBinding> {
const snapshot = normalizeProjectToolDefinitionSnapshot(snapshotValue);
const supportedProfiles = profiles(profileValues);
const definition = snapshot.definitions.find(
(entry) =>
entry.definition.name === BUILTIN_RUN_LOG_EXCERPT_TOOL.name &&
entry.definition.version === BUILTIN_RUN_LOG_EXCERPT_TOOL.version,
)?.definition;
if (
!definition ||
!sameValue(definition, BUILTIN_RUN_LOG_EXCERPT_TOOL_DEFINITION)
) {
return invalid('reviewed Tool definition is absent or changed');
}
return createTrustedToolHandlerBinding(snapshot, {
tool: BUILTIN_RUN_LOG_EXCERPT_TOOL,
adapter: BUILTIN_RUN_LOG_EXCERPT_ADAPTER,
executionClass: 'builtin_in_process',
profiles: supportedProfiles,
authorities: ['artifact.read', 'database.read'],
timeoutSeconds: BUILTIN_RUN_LOG_EXCERPT_TIMEOUT_SECONDS,
redactionContract: BUILTIN_RUN_LOG_EXCERPT_REDACTION_CONTRACT,
auditContract: BUILTIN_RUN_LOG_EXCERPT_AUDIT_CONTRACT,
});
}
export class BuiltInRunLogExcerptToolAdapter
implements TrustedToolExecutionAdapter
{
readonly binding!: Readonly<TrustedToolHandlerBinding>;
readonly profile!: RunLogModelContextProfile;
readonly recoveryMode = 'retry_safe_read' as const;
readonly #logs!: RunAttemptLogReadPort;
constructor(
bindingValue: TrustedToolHandlerBinding,
profileValue: DeploymentProfile,
definitions: ToolDefinitionRegistry,
logs: RunAttemptLogReadPort,
) {
const binding = normalizeTrustedToolHandlerBinding(bindingValue);
const profile = profiles([profileValue])[0]!;
if (!(definitions instanceof ToolDefinitionRegistry)) {
return invalid('Tool Definition registry is invalid');
}
let definition;
try {
definition = definitions.resolve(
BUILTIN_RUN_LOG_EXCERPT_TOOL.name,
BUILTIN_RUN_LOG_EXCERPT_TOOL.version,
);
} catch {
return invalid('reviewed Tool definition is unavailable');
}
if (
!sameValue(binding.tool, BUILTIN_RUN_LOG_EXCERPT_TOOL) ||
!sameValue(binding.adapter, BUILTIN_RUN_LOG_EXCERPT_ADAPTER) ||
binding.executionClass !== 'builtin_in_process' ||
!sameValue(binding.authorities, ['artifact.read', 'database.read']) ||
binding.timeoutSeconds !== BUILTIN_RUN_LOG_EXCERPT_TIMEOUT_SECONDS ||
!sameValue(
binding.redactionContract,
BUILTIN_RUN_LOG_EXCERPT_REDACTION_CONTRACT,
) ||
!sameValue(
binding.auditContract,
BUILTIN_RUN_LOG_EXCERPT_AUDIT_CONTRACT,
) ||
!binding.profiles.includes(profile) ||
!sameValue(definition, BUILTIN_RUN_LOG_EXCERPT_TOOL_DEFINITION) ||
!logs ||
typeof logs.read !== 'function'
) {
return invalid('binding does not match the reviewed adapter contract');
}
this.binding = binding;
this.profile = profile;
this.#logs = logs;
Object.freeze(this);
}
async execute(
context: Readonly<TrustedToolExecutionAdapterContext>,
input: ToolJsonValue,
): Promise<unknown> {
if (
!context ||
typeof context !== 'object' ||
!boundedText(context.projectId, 128)
) {
return invalid('execution context or input is invalid');
}
return executeBuiltInRunLogExcerptTool(
this.#logs,
this.profile,
context.projectId,
input,
);
}
}