File size: 11,957 Bytes
064bfd6 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 | import { randomUUID } from 'crypto'
import { LRUCache } from 'lru-cache'
import { logForDebugging } from '../../utils/debug.js'
import { toError } from '../../utils/errors.js'
import { logError } from '../../utils/log.js'
import { jsonStringify } from '../../utils/slowOperations.js'
import type { DiagnosticFile } from '../diagnosticTracking.js'
/**
* Pending LSP diagnostic notification
*/
export type PendingLSPDiagnostic = {
/** Server that sent the diagnostic */
serverName: string
/** Diagnostic files */
files: DiagnosticFile[]
/** When diagnostic was received */
timestamp: number
/** Whether attachment was already sent to conversation */
attachmentSent: boolean
}
/**
* LSP Diagnostic Registry
*
* Stores LSP diagnostics received asynchronously from LSP servers via
* textDocument/publishDiagnostics notifications. Follows the same pattern
* as AsyncHookRegistry for consistent async attachment delivery.
*
* Pattern:
* 1. LSP server sends publishDiagnostics notification
* 2. registerPendingLSPDiagnostic() stores diagnostic
* 3. checkForLSPDiagnostics() retrieves pending diagnostics
* 4. getLSPDiagnosticAttachments() converts to Attachment[]
* 5. getAttachments() delivers to conversation automatically
*
* Similar to AsyncHookRegistry but simpler since diagnostics arrive
* synchronously (no need to accumulate output over time).
*/
// Volume limiting constants
const MAX_DIAGNOSTICS_PER_FILE = 10
const MAX_TOTAL_DIAGNOSTICS = 30
// Max files to track for deduplication - prevents unbounded memory growth
const MAX_DELIVERED_FILES = 500
// Global registry state
const pendingDiagnostics = new Map<string, PendingLSPDiagnostic>()
// Cross-turn deduplication: tracks diagnostics that have been delivered
// Maps file URI to a set of diagnostic keys (hash of message+severity+range)
// Using LRUCache to prevent unbounded growth in long sessions
const deliveredDiagnostics = new LRUCache<string, Set<string>>({
max: MAX_DELIVERED_FILES,
})
/**
* Register LSP diagnostics received from a server.
* These will be delivered as attachments in the next query.
*
* @param serverName - Name of LSP server that sent diagnostics
* @param files - Diagnostic files to deliver
*/
export function registerPendingLSPDiagnostic({
serverName,
files,
}: {
serverName: string
files: DiagnosticFile[]
}): void {
// Use UUID for guaranteed uniqueness (handles rapid registrations)
const diagnosticId = randomUUID()
logForDebugging(
`LSP Diagnostics: Registering ${files.length} diagnostic file(s) from ${serverName} (ID: ${diagnosticId})`,
)
pendingDiagnostics.set(diagnosticId, {
serverName,
files,
timestamp: Date.now(),
attachmentSent: false,
})
}
/**
* Maps severity string to numeric value for sorting.
* Error=1, Warning=2, Info=3, Hint=4
*/
function severityToNumber(severity: string | undefined): number {
switch (severity) {
case 'Error':
return 1
case 'Warning':
return 2
case 'Info':
return 3
case 'Hint':
return 4
default:
return 4
}
}
/**
* Creates a unique key for a diagnostic based on its content.
* Used for both within-batch and cross-turn deduplication.
*/
function createDiagnosticKey(diag: {
message: string
severity?: string
range?: unknown
source?: string
code?: unknown
}): string {
return jsonStringify({
message: diag.message,
severity: diag.severity,
range: diag.range,
source: diag.source || null,
code: diag.code || null,
})
}
/**
* Deduplicates diagnostics by file URI and diagnostic content.
* Also filters out diagnostics that were already delivered in previous turns.
* Two diagnostics are considered duplicates if they have the same:
* - File URI
* - Range (start/end line and character)
* - Message
* - Severity
* - Source and code (if present)
*/
function deduplicateDiagnosticFiles(
allFiles: DiagnosticFile[],
): DiagnosticFile[] {
// Group diagnostics by file URI
const fileMap = new Map<string, Set<string>>()
const dedupedFiles: DiagnosticFile[] = []
for (const file of allFiles) {
if (!fileMap.has(file.uri)) {
fileMap.set(file.uri, new Set())
dedupedFiles.push({ uri: file.uri, diagnostics: [] })
}
const seenDiagnostics = fileMap.get(file.uri)!
const dedupedFile = dedupedFiles.find(f => f.uri === file.uri)!
// Get previously delivered diagnostics for this file (for cross-turn dedup)
const previouslyDelivered = deliveredDiagnostics.get(file.uri) || new Set()
for (const diag of file.diagnostics) {
try {
const key = createDiagnosticKey(diag)
// Skip if already seen in this batch OR already delivered in previous turns
if (seenDiagnostics.has(key) || previouslyDelivered.has(key)) {
continue
}
seenDiagnostics.add(key)
dedupedFile.diagnostics.push(diag)
} catch (error: unknown) {
const err = toError(error)
const truncatedMessage =
diag.message?.substring(0, 100) || '<no message>'
logError(
new Error(
`Failed to deduplicate diagnostic in ${file.uri}: ${err.message}. ` +
`Diagnostic message: ${truncatedMessage}`,
),
)
// Include the diagnostic anyway to avoid losing information
dedupedFile.diagnostics.push(diag)
}
}
}
// Filter out files with no diagnostics after deduplication
return dedupedFiles.filter(f => f.diagnostics.length > 0)
}
/**
* Get all pending LSP diagnostics that haven't been delivered yet.
* Deduplicates diagnostics to prevent sending the same diagnostic multiple times.
* Marks diagnostics as sent to prevent duplicate delivery.
*
* @returns Array of pending diagnostics ready for delivery (deduplicated)
*/
export function checkForLSPDiagnostics(): Array<{
serverName: string
files: DiagnosticFile[]
}> {
logForDebugging(
`LSP Diagnostics: Checking registry - ${pendingDiagnostics.size} pending`,
)
// Collect all diagnostic files from all pending notifications
const allFiles: DiagnosticFile[] = []
const serverNames = new Set<string>()
const diagnosticsToMark: PendingLSPDiagnostic[] = []
for (const diagnostic of pendingDiagnostics.values()) {
if (!diagnostic.attachmentSent) {
allFiles.push(...diagnostic.files)
serverNames.add(diagnostic.serverName)
diagnosticsToMark.push(diagnostic)
}
}
if (allFiles.length === 0) {
return []
}
// Deduplicate diagnostics across all files
let dedupedFiles: DiagnosticFile[]
try {
dedupedFiles = deduplicateDiagnosticFiles(allFiles)
} catch (error: unknown) {
const err = toError(error)
logError(new Error(`Failed to deduplicate LSP diagnostics: ${err.message}`))
// Fall back to undedup'd files to avoid losing diagnostics
dedupedFiles = allFiles
}
// Only mark as sent AFTER successful deduplication, then delete from map.
// Entries are tracked in deliveredDiagnostics LRU for dedup, so we don't
// need to keep them in pendingDiagnostics after delivery.
for (const diagnostic of diagnosticsToMark) {
diagnostic.attachmentSent = true
}
for (const [id, diagnostic] of pendingDiagnostics) {
if (diagnostic.attachmentSent) {
pendingDiagnostics.delete(id)
}
}
const originalCount = allFiles.reduce(
(sum, f) => sum + f.diagnostics.length,
0,
)
const dedupedCount = dedupedFiles.reduce(
(sum, f) => sum + f.diagnostics.length,
0,
)
if (originalCount > dedupedCount) {
logForDebugging(
`LSP Diagnostics: Deduplication removed ${originalCount - dedupedCount} duplicate diagnostic(s)`,
)
}
// Apply volume limiting: cap per file and total
let totalDiagnostics = 0
let truncatedCount = 0
for (const file of dedupedFiles) {
// Sort by severity (Error=1 < Warning=2 < Info=3 < Hint=4) to prioritize errors
file.diagnostics.sort(
(a, b) => severityToNumber(a.severity) - severityToNumber(b.severity),
)
// Cap per file
if (file.diagnostics.length > MAX_DIAGNOSTICS_PER_FILE) {
truncatedCount += file.diagnostics.length - MAX_DIAGNOSTICS_PER_FILE
file.diagnostics = file.diagnostics.slice(0, MAX_DIAGNOSTICS_PER_FILE)
}
// Cap total
const remainingCapacity = MAX_TOTAL_DIAGNOSTICS - totalDiagnostics
if (file.diagnostics.length > remainingCapacity) {
truncatedCount += file.diagnostics.length - remainingCapacity
file.diagnostics = file.diagnostics.slice(0, remainingCapacity)
}
totalDiagnostics += file.diagnostics.length
}
// Filter out files that ended up with no diagnostics after limiting
dedupedFiles = dedupedFiles.filter(f => f.diagnostics.length > 0)
if (truncatedCount > 0) {
logForDebugging(
`LSP Diagnostics: Volume limiting removed ${truncatedCount} diagnostic(s) (max ${MAX_DIAGNOSTICS_PER_FILE}/file, ${MAX_TOTAL_DIAGNOSTICS} total)`,
)
}
// Track delivered diagnostics for cross-turn deduplication
for (const file of dedupedFiles) {
if (!deliveredDiagnostics.has(file.uri)) {
deliveredDiagnostics.set(file.uri, new Set())
}
const delivered = deliveredDiagnostics.get(file.uri)!
for (const diag of file.diagnostics) {
try {
delivered.add(createDiagnosticKey(diag))
} catch (error: unknown) {
// Log but continue - failure to track shouldn't prevent delivery
const err = toError(error)
const truncatedMessage =
diag.message?.substring(0, 100) || '<no message>'
logError(
new Error(
`Failed to track delivered diagnostic in ${file.uri}: ${err.message}. ` +
`Diagnostic message: ${truncatedMessage}`,
),
)
}
}
}
const finalCount = dedupedFiles.reduce(
(sum, f) => sum + f.diagnostics.length,
0,
)
// Return empty if no diagnostics to deliver (all filtered by deduplication)
if (finalCount === 0) {
logForDebugging(
`LSP Diagnostics: No new diagnostics to deliver (all filtered by deduplication)`,
)
return []
}
logForDebugging(
`LSP Diagnostics: Delivering ${dedupedFiles.length} file(s) with ${finalCount} diagnostic(s) from ${serverNames.size} server(s)`,
)
// Return single result with all deduplicated diagnostics
return [
{
serverName: Array.from(serverNames).join(', '),
files: dedupedFiles,
},
]
}
/**
* Clear all pending diagnostics.
* Used during cleanup/shutdown or for testing.
* Note: Does NOT clear deliveredDiagnostics - that's for cross-turn deduplication
* and should only be cleared when files are edited or on session reset.
*/
export function clearAllLSPDiagnostics(): void {
logForDebugging(
`LSP Diagnostics: Clearing ${pendingDiagnostics.size} pending diagnostic(s)`,
)
pendingDiagnostics.clear()
}
/**
* Reset all diagnostic state including cross-turn tracking.
* Used on session reset or for testing.
*/
export function resetAllLSPDiagnosticState(): void {
logForDebugging(
`LSP Diagnostics: Resetting all state (${pendingDiagnostics.size} pending, ${deliveredDiagnostics.size} files tracked)`,
)
pendingDiagnostics.clear()
deliveredDiagnostics.clear()
}
/**
* Clear delivered diagnostics for a specific file.
* Should be called when a file is edited so that new diagnostics for that file
* will be shown even if they match previously delivered ones.
*
* @param fileUri - URI of the file that was edited
*/
export function clearDeliveredDiagnosticsForFile(fileUri: string): void {
if (deliveredDiagnostics.has(fileUri)) {
logForDebugging(
`LSP Diagnostics: Clearing delivered diagnostics for ${fileUri}`,
)
deliveredDiagnostics.delete(fileUri)
}
}
/**
* Get count of pending diagnostics (for monitoring)
*/
export function getPendingLSPDiagnosticCount(): number {
return pendingDiagnostics.size
}
|