|
| 1 | +package compliance |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | + "strings" |
| 6 | + "testing" |
| 7 | +) |
| 8 | + |
| 9 | +// ============================================================================= |
| 10 | +// Compliance Scanner Benchmarks |
| 11 | +// ============================================================================= |
| 12 | +// These cover the innermost hot paths of the audit pipeline: |
| 13 | +// |
| 14 | +// normalizeIdentifier — called per identifier per line across all files |
| 15 | +// extractIdentifiers — called per line (regex + dedup) |
| 16 | +// extractContainer — called per line (7 compiled regexes) |
| 17 | +// matchPII — called per identifier against ~80 patterns |
| 18 | +// isNonPIIIdentifier — called on every matchPII hit |
| 19 | +// |
| 20 | +// Baselines (Apple M4 Pro, arm64, -count=6): |
| 21 | +// normalizeIdentifier: ~138 ns/op, 138 B/op, 4 allocs/op |
| 22 | +// normalizeIdentifier_Long: ~650 ns/op, 1352 B/op, 9 allocs/op ← allocs on long idents |
| 23 | +// extractIdentifiers: ~555 ns/op, 219 B/op, 6 allocs/op |
| 24 | +// extractContainer: ~502 ns/op, 24 B/op, 0 allocs/op (allocation is submatches slice) |
| 25 | +// isNonPIIIdentifier: ~197 ns/op, 0 B/op, 0 allocs/op |
| 26 | +// matchPII (hit): ~706 ns/op, 0 B/op, 0 allocs/op |
| 27 | +// matchPII (miss/full scan): ~1.13 µs/op, 0 B/op, 0 allocs/op |
| 28 | +// ScannerPipeline/100lines: ~283 µs/op, 37 KB/op, 1190 allocs/op ← ~1190 allocs for 100 lines |
| 29 | +// ScannerPipeline/500lines: ~1.42 ms/op |
| 30 | +// ScannerPipeline/1000lines: ~2.85 ms/op |
| 31 | +// NewPIIScanner: ~2.4 µs/op, 13 KB/op, 6 allocs/op |
| 32 | +// NewPIIScannerWithExtras: ~4.2 µs/op, 21 KB/op, 32 allocs/op |
| 33 | +// |
| 34 | +// Notable: ScannerPipeline allocates ~12 allocs/line. Most come from |
| 35 | +// extractIdentifiers (map + slice per line). Worth profiling if audit |
| 36 | +// latency becomes a bottleneck on large repos. |
| 37 | +// |
| 38 | +// Use benchstat for before/after comparison: |
| 39 | +// go test -bench=. ./internal/compliance/... -count=10 > before.txt |
| 40 | +// # make changes |
| 41 | +// go test -bench=. ./internal/compliance/... -count=10 > after.txt |
| 42 | +// benchstat before.txt after.txt |
| 43 | +// |
| 44 | +// To update the stored baseline: |
| 45 | +// go test -bench=. ./internal/compliance/... -count=10 > testdata/benchmarks/compliance_baseline.txt |
| 46 | +// ============================================================================= |
| 47 | + |
| 48 | +// BenchmarkNormalizeIdentifier measures identifier normalization (camelCase → snake_case). |
| 49 | +// This is the hottest inner loop function — called on every identifier in every line. |
| 50 | +func BenchmarkNormalizeIdentifier(b *testing.B) { |
| 51 | + cases := []string{ |
| 52 | + "firstName", // camelCase |
| 53 | + "UserEmailAddress", // PascalCase |
| 54 | + "http_client", // already snake_case |
| 55 | + "HTMLParser", // acronym boundary |
| 56 | + "getUser", // short camelCase |
| 57 | + "SCREAMING_SNAKE", // all-caps |
| 58 | + "userID", // mixed acronym |
| 59 | + "date_of_birth", // long snake_case |
| 60 | + } |
| 61 | + |
| 62 | + b.ResetTimer() |
| 63 | + b.ReportAllocs() |
| 64 | + for i := 0; i < b.N; i++ { |
| 65 | + normalizeIdentifier(cases[i%len(cases)]) |
| 66 | + } |
| 67 | +} |
| 68 | + |
| 69 | +// BenchmarkNormalizeIdentifier_Long measures the cost on long identifiers. |
| 70 | +func BenchmarkNormalizeIdentifier_Long(b *testing.B) { |
| 71 | + long := "VeryLongCamelCaseIdentifierWithManyBoundariesForTestingPurposes" |
| 72 | + b.ResetTimer() |
| 73 | + b.ReportAllocs() |
| 74 | + for i := 0; i < b.N; i++ { |
| 75 | + normalizeIdentifier(long) |
| 76 | + } |
| 77 | +} |
| 78 | + |
| 79 | +// BenchmarkExtractIdentifiers measures per-line identifier extraction (regex + dedup). |
| 80 | +func BenchmarkExtractIdentifiers(b *testing.B) { |
| 81 | + lines := []string{ |
| 82 | + "\tfirstName string `json:\"first_name\"`", // Go struct field |
| 83 | + "\tprivate String userEmailAddress;", // Java field |
| 84 | + "\temail_address: Optional[str] = None", // Python |
| 85 | + "export interface UserProfile { dateOfBirth: string }", // TypeScript |
| 86 | + "func (u *User) GetFullName() string { return u.FullName }", // Go method |
| 87 | + "// This is a comment with identifiers: email phone address", // comment (should skip) |
| 88 | + "", // empty line |
| 89 | + "const MAX_RETRY_COUNT = 3", // constant |
| 90 | + } |
| 91 | + |
| 92 | + b.ResetTimer() |
| 93 | + b.ReportAllocs() |
| 94 | + for i := 0; i < b.N; i++ { |
| 95 | + extractIdentifiers(lines[i%len(lines)]) |
| 96 | + } |
| 97 | +} |
| 98 | + |
| 99 | +// BenchmarkExtractContainer measures per-line container detection (7 compiled regexes). |
| 100 | +func BenchmarkExtractContainer(b *testing.B) { |
| 101 | + lines := []string{ |
| 102 | + `type UserProfile struct {`, // Go struct |
| 103 | + `class UserService extends BaseService {`, // Java/Python/TS class |
| 104 | + `interface PaymentProvider {`, // TypeScript interface |
| 105 | + `export type UserRecord = {`, // TypeScript type alias |
| 106 | + `data class UserData(val name: String) {`, // Kotlin data class |
| 107 | + `pub struct ConnectionPool {`, // Rust struct |
| 108 | + `func processPayment(amount float64) error {`, // non-container (no match) |
| 109 | + ` return nil`, // non-container (no match) |
| 110 | + } |
| 111 | + |
| 112 | + b.ResetTimer() |
| 113 | + b.ReportAllocs() |
| 114 | + for i := 0; i < b.N; i++ { |
| 115 | + extractContainer(lines[i%len(lines)]) |
| 116 | + } |
| 117 | +} |
| 118 | + |
| 119 | +// BenchmarkIsNonPIIIdentifier measures the filter function for false-positive suppression. |
| 120 | +func BenchmarkIsNonPIIIdentifier(b *testing.B) { |
| 121 | + identifiers := []string{ |
| 122 | + "fingerprint", // filtered: non-biometric |
| 123 | + "display_name", // filtered: UI label |
| 124 | + "file_name", // filtered: code entity |
| 125 | + "function_name", // filtered: code entity |
| 126 | + "email", // NOT filtered: real PII |
| 127 | + "first_name", // NOT filtered: real PII |
| 128 | + "host_name", // filtered: infra |
| 129 | + "user_fingerprint", // NOT filtered: biometric context |
| 130 | + } |
| 131 | + |
| 132 | + b.ResetTimer() |
| 133 | + b.ReportAllocs() |
| 134 | + for i := 0; i < b.N; i++ { |
| 135 | + isNonPIIIdentifier(identifiers[i%len(identifiers)]) |
| 136 | + } |
| 137 | +} |
| 138 | + |
| 139 | +// BenchmarkMatchPII measures PII pattern matching against the full pattern set (~80 patterns). |
| 140 | +// This is called per-identifier per-line so allocation pressure matters. |
| 141 | +func BenchmarkMatchPII(b *testing.B) { |
| 142 | + scanner := NewPIIScanner(nil) |
| 143 | + |
| 144 | + identifiers := []string{ |
| 145 | + "email", // exact match (hit) |
| 146 | + "first_name", // exact match (hit) |
| 147 | + "user_email", // suffix match (hit) |
| 148 | + "customer_phone", // suffix match (hit) |
| 149 | + "fingerprint", // non-PII filter (filtered before lookup) |
| 150 | + "engine_name", // non-PII filter (filtered before lookup) |
| 151 | + "query_result", // no match (miss) |
| 152 | + "backend_ladder", // no match (miss) |
| 153 | + } |
| 154 | + |
| 155 | + b.ResetTimer() |
| 156 | + b.ReportAllocs() |
| 157 | + for i := 0; i < b.N; i++ { |
| 158 | + scanner.matchPII(identifiers[i%len(identifiers)]) |
| 159 | + } |
| 160 | +} |
| 161 | + |
| 162 | +// BenchmarkMatchPII_Miss measures the worst-case path: no match, full suffix scan. |
| 163 | +func BenchmarkMatchPII_Miss(b *testing.B) { |
| 164 | + scanner := NewPIIScanner(nil) |
| 165 | + // A normalized identifier that won't match any pattern and doesn't get filtered early. |
| 166 | + // Forces a full suffix scan of all patterns. |
| 167 | + ident := "orchestrator_backend_result" |
| 168 | + |
| 169 | + b.ResetTimer() |
| 170 | + b.ReportAllocs() |
| 171 | + for i := 0; i < b.N; i++ { |
| 172 | + scanner.matchPII(ident) |
| 173 | + } |
| 174 | +} |
| 175 | + |
| 176 | +// syntheticLines builds a realistic mixed-content source file of n lines. |
| 177 | +// The mix (~60% logic/control flow, ~20% field declarations, ~20% comments/blank) |
| 178 | +// is tuned to match real Go/TS/Python distribution in a large service repo. |
| 179 | +func syntheticLines(n int) []string { |
| 180 | + templates := []string{ |
| 181 | + // Field declarations — trigger PII matches |
| 182 | + "\tfirstName string `json:\"first_name\"`", |
| 183 | + "\temailAddress string `json:\"email\"`", |
| 184 | + "\tphoneNumber string `json:\"phone\"`", |
| 185 | + "\tdateOfBirth time.Time `json:\"date_of_birth\"`", |
| 186 | + "\tuserID string `json:\"user_id\"`", |
| 187 | + "\tcreatedAt time.Time", |
| 188 | + "\tupdatedAt time.Time", |
| 189 | + "\tscore int", |
| 190 | + // Container declarations |
| 191 | + "type %s struct {", |
| 192 | + "func (u *%s) Validate() error {", |
| 193 | + "func (u *%s) GetDisplayName() string {", |
| 194 | + // Logic — dense identifiers but no PII hits |
| 195 | + "\tif u.score > 0 {", |
| 196 | + "\t\treturn fmt.Errorf(\"validation failed: %w\", err)", |
| 197 | + "\t}", |
| 198 | + "\treturn nil", |
| 199 | + "\tresult := make([]string, 0, len(items))", |
| 200 | + "\tfor i, item := range items {", |
| 201 | + "\t\tresult = append(result, item.String())", |
| 202 | + "\t}", |
| 203 | + "\tctx, cancel := context.WithTimeout(ctx, 30*time.Second)", |
| 204 | + "\tdefer cancel()", |
| 205 | + "\tif err := db.QueryContext(ctx, query, args...); err != nil {", |
| 206 | + "\t\treturn nil, fmt.Errorf(\"query failed: %w\", err)", |
| 207 | + "\t}", |
| 208 | + // Comments — skipped by extractIdentifiers |
| 209 | + "// GetDisplayName returns the user's display name for UI purposes", |
| 210 | + "// TODO: add rate limiting", |
| 211 | + "", |
| 212 | + // Constants / vars — few identifiers |
| 213 | + "const maxRetryCount = 3", |
| 214 | + "var defaultTimeout = 30 * time.Second", |
| 215 | + "\tlog.Printf(\"processing request for user %s\", u.userID)", |
| 216 | + } |
| 217 | + |
| 218 | + lines := make([]string, n) |
| 219 | + for i := range lines { |
| 220 | + tmpl := templates[i%len(templates)] |
| 221 | + if strings.Contains(tmpl, "%s") { |
| 222 | + lines[i] = fmt.Sprintf(tmpl, "Entity"+fmt.Sprint(i%20)) |
| 223 | + } else { |
| 224 | + lines[i] = tmpl |
| 225 | + } |
| 226 | + } |
| 227 | + return lines |
| 228 | +} |
| 229 | + |
| 230 | +// BenchmarkScannerPipeline simulates the per-line processing loop inside scanFile. |
| 231 | +// This is the composite hot path: extractContainer + extractIdentifiers + matchPII |
| 232 | +// called for every line in every source file during a full audit. |
| 233 | +// |
| 234 | +// Sizes reflect real-world CKB usage: |
| 235 | +// - 500 lines: typical service file |
| 236 | +// - 5k lines: large generated file or fat service |
| 237 | +// - 50k lines: worst-case single file (e.g. generated protobuf, large test fixture) |
| 238 | +// |
| 239 | +// For the full-repo picture see BenchmarkAuditFileSet. |
| 240 | +func BenchmarkScannerPipeline(b *testing.B) { |
| 241 | + pii := NewPIIScanner(nil) |
| 242 | + |
| 243 | + sizes := []struct { |
| 244 | + name string |
| 245 | + lines int |
| 246 | + }{ |
| 247 | + {"500lines", 500}, |
| 248 | + {"5klines", 5_000}, |
| 249 | + {"50klines", 50_000}, |
| 250 | + } |
| 251 | + |
| 252 | + for _, sz := range sizes { |
| 253 | + lines := syntheticLines(sz.lines) |
| 254 | + |
| 255 | + // Measure total bytes so b.SetBytes gives us a lines-throughput proxy. |
| 256 | + var totalBytes int64 |
| 257 | + for _, l := range lines { |
| 258 | + totalBytes += int64(len(l)) |
| 259 | + } |
| 260 | + |
| 261 | + b.Run(sz.name, func(b *testing.B) { |
| 262 | + b.SetBytes(totalBytes) |
| 263 | + b.ReportAllocs() |
| 264 | + b.ResetTimer() |
| 265 | + |
| 266 | + for iter := 0; iter < b.N; iter++ { |
| 267 | + currentContainer := "" |
| 268 | + for _, line := range lines { |
| 269 | + if container := extractContainer(line); container != "" { |
| 270 | + currentContainer = container |
| 271 | + } |
| 272 | + if strings.HasPrefix(strings.TrimSpace(line), "}") { |
| 273 | + currentContainer = "" |
| 274 | + } |
| 275 | + identifiers := extractIdentifiers(line) |
| 276 | + for _, ident := range identifiers { |
| 277 | + normalized := normalizeIdentifier(ident) |
| 278 | + pii.matchPII(normalized) |
| 279 | + _ = currentContainer |
| 280 | + } |
| 281 | + } |
| 282 | + } |
| 283 | + }) |
| 284 | + } |
| 285 | +} |
| 286 | + |
| 287 | +// BenchmarkAuditFileSet simulates the full audit scanning N files of M lines each. |
| 288 | +// This is the scenario where CKB struggles on huge repos — the alloc cascade |
| 289 | +// from extractIdentifiers accumulates across every file in the set. |
| 290 | +// |
| 291 | +// File counts reflect real-world repo sizes: |
| 292 | +// - 100 files × 300 lines ≈ small service (~30k lines) |
| 293 | +// - 1k files × 300 lines ≈ mid-size repo (~300k lines) |
| 294 | +// - 5k files × 300 lines ≈ large monorepo (~1.5M lines) |
| 295 | +// |
| 296 | +// Each sub-benchmark runs a single b.N iteration over the full file set, |
| 297 | +// so ns/op = total wall time for one complete scan of that repo size. |
| 298 | +func BenchmarkAuditFileSet(b *testing.B) { |
| 299 | + pii := NewPIIScanner(nil) |
| 300 | + fileLines := syntheticLines(300) // one representative file |
| 301 | + |
| 302 | + sets := []struct { |
| 303 | + name string |
| 304 | + files int |
| 305 | + }{ |
| 306 | + {"100files", 100}, |
| 307 | + {"1kfiles", 1_000}, |
| 308 | + {"5kfiles", 5_000}, |
| 309 | + } |
| 310 | + |
| 311 | + for _, set := range sets { |
| 312 | + var totalBytes int64 |
| 313 | + for _, l := range fileLines { |
| 314 | + totalBytes += int64(len(l)) |
| 315 | + } |
| 316 | + totalBytes *= int64(set.files) |
| 317 | + |
| 318 | + b.Run(set.name, func(b *testing.B) { |
| 319 | + b.SetBytes(totalBytes) |
| 320 | + b.ReportAllocs() |
| 321 | + b.ResetTimer() |
| 322 | + |
| 323 | + for iter := 0; iter < b.N; iter++ { |
| 324 | + for f := 0; f < set.files; f++ { |
| 325 | + currentContainer := "" |
| 326 | + for _, line := range fileLines { |
| 327 | + if container := extractContainer(line); container != "" { |
| 328 | + currentContainer = container |
| 329 | + } |
| 330 | + if strings.HasPrefix(strings.TrimSpace(line), "}") { |
| 331 | + currentContainer = "" |
| 332 | + } |
| 333 | + identifiers := extractIdentifiers(line) |
| 334 | + for _, ident := range identifiers { |
| 335 | + normalized := normalizeIdentifier(ident) |
| 336 | + pii.matchPII(normalized) |
| 337 | + _ = currentContainer |
| 338 | + } |
| 339 | + } |
| 340 | + } |
| 341 | + } |
| 342 | + }) |
| 343 | + } |
| 344 | +} |
| 345 | + |
| 346 | +// BenchmarkMatchPII_PatternScale measures how matchPII degrades as the pattern |
| 347 | +// set grows. CKB users can add custom patterns via config; this shows the cost. |
| 348 | +func BenchmarkMatchPII_PatternScale(b *testing.B) { |
| 349 | + // A miss forces a full suffix scan — worst case for pattern count scaling. |
| 350 | + ident := "orchestrator_backend_result" |
| 351 | + |
| 352 | + sizes := []struct { |
| 353 | + name string |
| 354 | + nExtras int |
| 355 | + }{ |
| 356 | + {"default_~80patterns", 0}, |
| 357 | + {"100patterns", 20}, |
| 358 | + {"200patterns", 120}, |
| 359 | + {"500patterns", 420}, |
| 360 | + } |
| 361 | + |
| 362 | + for _, sz := range sizes { |
| 363 | + extras := make([]string, sz.nExtras) |
| 364 | + for i := range extras { |
| 365 | + extras[i] = fmt.Sprintf("custom_field_%d", i) |
| 366 | + } |
| 367 | + scanner := NewPIIScanner(extras) |
| 368 | + |
| 369 | + b.Run(sz.name, func(b *testing.B) { |
| 370 | + b.ReportAllocs() |
| 371 | + b.ResetTimer() |
| 372 | + for i := 0; i < b.N; i++ { |
| 373 | + scanner.matchPII(ident) |
| 374 | + } |
| 375 | + }) |
| 376 | + } |
| 377 | +} |
| 378 | + |
| 379 | +// BenchmarkNewPIIScanner measures scanner construction cost (pattern compilation). |
| 380 | +// Relevant for callers that create per-request scanners. |
| 381 | +func BenchmarkNewPIIScanner(b *testing.B) { |
| 382 | + b.ReportAllocs() |
| 383 | + for i := 0; i < b.N; i++ { |
| 384 | + NewPIIScanner(nil) |
| 385 | + } |
| 386 | +} |
| 387 | + |
| 388 | +// BenchmarkNewPIIScannerWithExtras measures construction cost with additional patterns. |
| 389 | +func BenchmarkNewPIIScannerWithExtras(b *testing.B) { |
| 390 | + extra := []string{"patient_id", "member_number", "policy_holder", "claim_ref", "beneficiary"} |
| 391 | + b.ReportAllocs() |
| 392 | + for i := 0; i < b.N; i++ { |
| 393 | + NewPIIScanner(extra) |
| 394 | + } |
| 395 | +} |
0 commit comments