Skip to content

feat: add Zod validation for message metadata #8268

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
siddseethepalli merged 1 commit into from
Feb 24, 2026
Merged

feat: add Zod validation for message metadata #8268

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion assistant/src/memory/conversation-store.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,41 @@
import { eq, desc, asc, and, count, sql, inArray, or, isNull } from 'drizzle-orm';
import { v4 as uuid } from 'uuid';
import { z } from 'zod';
import { getDb, rawGet, rawExec } from './db.js';
import { conversations, messages, toolInvocations, messageRuns, channelInboundEvents, memoryItemSources, memoryItems, memoryEmbeddings, memoryItemEntities, memorySegments, messageAttachments, llmRequestLogs } from './schema.js';
import { getConfig } from '../config/loader.js';
import { indexMessageNow } from './indexer.js';
import { parseChannelId } from '../channels/types.js';
import type { ChannelId } from '../channels/types.js';
import { isChannelId } from '../channels/types.js';
import { isChannelId, CHANNEL_IDS } from '../channels/types.js';
import { getLogger } from '../util/logger.js';
import { deleteOrphanAttachments } from './attachments-store.js';
import { createRowMapper } from '../util/row-mapper.js';

const log = getLogger('conversation-store');

// ── Message metadata Zod schema ──────────────────────────────────────
// Validates the JSON stored in messages.metadata. Known fields are typed;
// extra keys are allowed via passthrough so callers can attach ad-hoc data.

const channelIdSchema = z.enum(CHANNEL_IDS);

const subagentNotificationSchema = z.object({
subagentId: z.string(),
label: z.string(),
status: z.enum(['completed', 'failed', 'aborted']),
error: z.string().optional(),
conversationId: z.string().optional(),
});

export const messageMetadataSchema = z.object({
userMessageChannel: channelIdSchema.optional(),
assistantMessageChannel: channelIdSchema.optional(),
subagentNotification: subagentNotificationSchema.optional(),
}).passthrough();

export type MessageMetadata = z.infer<typeof messageMetadataSchema>;

export interface ConversationRow {
id: string;
title: string | null;
Expand Down Expand Up @@ -181,6 +204,14 @@ export function getLatestConversation(): ConversationRow | null {
export function addMessage(conversationId: string, role: string, content: string, metadata?: Record<string, unknown>) {
const db = getDb();
const messageId = uuid();

if (metadata) {
const result = messageMetadataSchema.safeParse(metadata);
if (!result.success) {
log.warn({ conversationId, messageId, issues: result.error.issues }, 'Invalid message metadata, storing as-is');
}
}

const metadataStr = metadata ? JSON.stringify(metadata) : undefined;
const originChannelCandidate =
metadata && isChannelId(metadata.userMessageChannel)
Expand Down