@raidiant/notifai 10.1.0 → 10.1.2

package/src/logging.test.ts

@@ -1,544 +0,0 @@
-import { spawn } from 'node:child_process'
-import {
-  appendFileSync,
-  existsSync,
-  mkdtempSync,
-  readFileSync,
-  statSync,
-  writeFileSync,
-} from 'node:fs'
-import os from 'node:os'
-import path from 'node:path'
-import { describe, expect, it } from 'vitest'
-import {
-  LOG_SCHEMA_VERSION,
-  activeLogPath,
-  archiveLogPaths,
-  argvFlagNames,
-  createLogger,
-  logsDiskUsage,
-  nullLogger,
-  readLogRecords,
-  renderRecord,
-  serialize,
-  shape,
-  type LogRecord,
-} from './logging.js'
-
-function sandbox(): NodeJS.ProcessEnv {
-  return { XDG_STATE_HOME: mkdtempSync(path.join(os.tmpdir(), 'notifai-logs-')) }
-}
-
-function lines(env: NodeJS.ProcessEnv): LogRecord[] {
-  return readFileSync(activeLogPath(env), 'utf8')
-    .split('\n')
-    .filter((line) => line.trim() !== '')
-    .map((line) => JSON.parse(line) as LogRecord)
-}
-
-async function waitUntil(predicate: () => boolean, deadline: number): Promise<void> {
-  while (!predicate()) {
-    if (Date.now() >= deadline) throw new Error('timed out waiting for rotation workers')
-    await new Promise((resolve) => setTimeout(resolve, 5))
-  }
-}
-
-interface RotationRun {
-  env: NodeJS.ProcessEnv
-  worker: number
-  records: number
-  maxBytes: number
-  maxFiles: number
-  startPath: string
-  /**
-   * When the rendezvous has failed, as an absolute instant every participant
-   * reads the same way. A per-side countdown would let the first worker to
-   * report ready abandon a parent that is still waiting for the last one.
-   */
-  deadline: number
-}
-
-function rotationWorker(run: RotationRun): { readyPath: string; done: Promise<void> } {
-  const { env, worker } = run
-  const readyPath = path.join(env['XDG_STATE_HOME']!, `rotation-ready-${worker}`)
-  const vitest = path.join(process.cwd(), 'node_modules', 'vitest', 'vitest.mjs')
-  const child = spawn(
-    process.execPath,
-    [vitest, 'run', 'src/logging-process-worker.test.ts', '--reporter=dot', '--maxWorkers=1'],
-    {
-      cwd: process.cwd(),
-      env: {
-        ...process.env,
-        ...env,
-        NOTIFAI_ROTATION_WORKER: String(worker),
-        NOTIFAI_ROTATION_RECORDS: String(run.records),
-        NOTIFAI_ROTATION_MAX_BYTES: String(run.maxBytes),
-        NOTIFAI_ROTATION_MAX_FILES: String(run.maxFiles),
-        NOTIFAI_ROTATION_READY: readyPath,
-        NOTIFAI_ROTATION_START: run.startPath,
-        NOTIFAI_ROTATION_DEADLINE: String(run.deadline),
-      },
-      stdio: ['ignore', 'pipe', 'pipe'],
-    },
-  )
-  const stdout: Buffer[] = []
-  const stderr: Buffer[] = []
-  child.stdout.on('data', (chunk: Buffer) => stdout.push(chunk))
-  child.stderr.on('data', (chunk: Buffer) => stderr.push(chunk))
-  const done = new Promise<void>((resolve, reject) => {
-    child.once('error', reject)
-    child.once('exit', (code) => {
-      if (code === 0) resolve()
-      else {
-        reject(
-          new Error(
-            `rotation worker ${worker} exited ${String(code)}\n${Buffer.concat(stdout).toString()}\n${Buffer.concat(stderr).toString()}`,
-          ),
-        )
-      }
-    })
-  })
-  return { readyPath, done }
-}
-
-describe('the record', () => {
-  it('is one self-describing JSON object per line', () => {
-    const env = sandbox()
-    const logger = createLogger({ env, cmd: 'send', runId: 'r_test' })
-    logger.info('send.submitted', { request_id: 'req_1' })
-    logger.info('send.outcome', { request_id: 'req_1' })
-
-    const written = lines(env)
-    expect(written).toHaveLength(2)
-    // Every line stands alone: a line pulled out by grep, with no header and no
-    // neighbours, still says what it is and which run it belongs to.
-    for (const record of written) {
-      expect(record.v).toBe(LOG_SCHEMA_VERSION)
-      expect(record.run).toBe('r_test')
-      expect(record.cmd).toBe('send')
-      expect(record.pid).toBe(process.pid)
-      expect(() => new Date(record.ts).toISOString()).not.toThrow()
-    }
-  })
-
-  it('carries the project and session once bound', () => {
-    const env = sandbox()
-    const logger = createLogger({ env })
-    logger.bind({ project: 'notifai', session: 'sess-1' })
-    logger.info('hook.start', {})
-    expect(lines(env)[0]).toMatchObject({ project: 'notifai', session: 'sess-1' })
-  })
-})
-
-describe('level', () => {
-  it('records nothing at off', () => {
-    const env = sandbox()
-    const logger = createLogger({ env, settings: { level: 'off' } })
-    logger.error('cli.error', {})
-    expect(logsDiskUsage(env).files).toBe(0)
-    expect(logger.enabled).toBe(false)
-  })
-
-  it('drops debug below debug, and keeps it at debug', () => {
-    const quiet = sandbox()
-    createLogger({ env: quiet, settings: { level: 'info' } }).debug('http.call', {})
-    expect(logsDiskUsage(quiet).files).toBe(0)
-
-    const loud = sandbox()
-    createLogger({ env: loud, settings: { level: 'debug' } }).debug('http.call', {})
-    expect(lines(loud)).toHaveLength(1)
-  })
-
-  it('keeps errors at the error level and nothing else', () => {
-    const env = sandbox()
-    const logger = createLogger({ env, settings: { level: 'error' } })
-    logger.info('cli.end', {})
-    logger.error('cli.error', {})
-    expect(lines(env).map((record) => record.event)).toEqual(['cli.error'])
-  })
-})
-
-describe('redaction', () => {
-  it('never writes a machine token, wherever it appears', () => {
-    const env = sandbox()
-    const logger = createLogger({ env })
-    logger.info('http.call', {
-      authorization: 'Bearer nfm_abc123.supersecretvalue',
-      message: 'rejected credential nfm_abc123.supersecretvalue for this machine',
-      nested: { poll_verifier: 'v_secret', fine: 'kept' },
-    })
-
-    const raw = readFileSync(activeLogPath(env), 'utf8')
-    expect(raw).not.toContain('supersecretvalue')
-    expect(raw).not.toContain('v_secret')
-    expect(raw).toContain('kept')
-  })
-
-  it('redacts by key name regardless of the value', () => {
-    expect(shape({ api_key: 12345, token: null, other: 'ok' })).toEqual({
-      api_key: '[redacted]',
-      token: '[redacted]',
-      other: 'ok',
-    })
-  })
-
-  it('truncates a long string instead of carrying it whole', () => {
-    const shaped = shape({ detail: 'x'.repeat(1000) }) as { detail: string }
-    expect(shaped.detail.length).toBeLessThan(500)
-    expect(shaped.detail).toContain('+600 chars')
-  })
-
-  it('never persists notification content, answers, or raw argv at debug', () => {
-    const env = sandbox()
-    const logger = createLogger({ env, settings: { level: 'debug' } })
-    logger.debug('cli.start', {
-      argv: ['send', '--title', 'SECRET_TITLE', '--body', 'SECRET_BODY'],
-      title: 'SECRET_TITLE',
-      body: 'SECRET_BODY',
-      question: 'SECRET_QUESTION',
-      text: 'SECRET_REPLY',
-      answers: ['SECRET_ANSWER'],
-      choices: ['SECRET_CHOICE'],
-    })
-
-    const raw = readFileSync(activeLogPath(env), 'utf8')
-    expect(raw).not.toContain('SECRET_TITLE')
-    expect(raw).not.toContain('SECRET_BODY')
-    expect(raw).not.toContain('SECRET_QUESTION')
-    expect(raw).not.toContain('SECRET_REPLY')
-    expect(raw).not.toContain('SECRET_ANSWER')
-    expect(raw).not.toContain('SECRET_CHOICE')
-    const record = JSON.parse(raw) as LogRecord
-    expect(record.data).toMatchObject({
-      title_chars: 'SECRET_TITLE'.length,
-      body_chars: 'SECRET_BODY'.length,
-      question_chars: 'SECRET_QUESTION'.length,
-      text_chars: 'SECRET_REPLY'.length,
-      answers_count: 1,
-      choices_count: 1,
-      argv_count: 5,
-      flags: ['--title', '--body'],
-    })
-    expect(record.data).not.toHaveProperty('argv')
-    expect(record.data).not.toHaveProperty('title')
-  })
-
-  it('strips inline --name=value assignments so notification content is never logged', () => {
-    const inlineTitle = 'private title words'
-    const inlineBody = 'private body words'
-    expect(
-      argvFlagNames(['send', `--title=${inlineTitle}`, `--body=${inlineBody}`, '--reply', '--']),
-    ).toEqual(['--title', '--body', '--reply'])
-
-    const env = sandbox()
-    const logger = createLogger({ env, settings: { level: 'debug' } })
-    logger.debug('cli.start', {
-      argv: ['send', `--title=${inlineTitle}`, `--body=${inlineBody}`, 'plain'],
-    })
-
-    const raw = readFileSync(activeLogPath(env), 'utf8')
-    expect(raw).not.toContain(inlineTitle)
-    expect(raw).not.toContain(inlineBody)
-    expect(shape({ argv: ['send', `--title=${inlineTitle}`, '--choice=yes'] })).toEqual({
-      flags: ['--title', '--choice'],
-      argv_count: 3,
-    })
-    const record = JSON.parse(raw) as LogRecord
-    expect(record.data).toMatchObject({
-      flags: ['--title', '--body'],
-      argv_count: 4,
-    })
-  })
-
-  it('refuses to recurse for ever into a cyclic object', () => {
-    const cyclic: Record<string, unknown> = {}
-    cyclic['self'] = cyclic
-    expect(() => JSON.stringify(shape(cyclic))).not.toThrow()
-  })
-})
-
-describe('record size', () => {
-  it('drops an oversized payload rather than the event', () => {
-    const record: LogRecord = {
-      v: LOG_SCHEMA_VERSION,
-      ts: new Date(0).toISOString(),
-      level: 'info',
-      event: 'send.submitted',
-      run: 'r_1',
-      cmd: 'send',
-      pid: 1,
-      data: Object.fromEntries(Array.from({ length: 400 }, (_, i) => [`k${i}`, 'y'.repeat(300)])),
-    }
-    const line = serialize(record)
-    // Small enough to land in one write, which is what makes concurrent
-    // appends safe — and the event survives even though its detail did not.
-    expect(Buffer.byteLength(line)).toBeLessThan(8_000)
-    const parsed = JSON.parse(line) as LogRecord
-    expect(parsed.event).toBe('send.submitted')
-    expect(parsed.data).toMatchObject({ dropped: expect.any(String) })
-  })
-})
-
-describe('rotation', () => {
-  it('rotates at the byte cap and keeps only the configured files', () => {
-    const env = sandbox()
-    const logger = createLogger({ env, settings: { maxBytes: 700, maxFiles: 3 } })
-    for (let i = 0; i < 60; i += 1) logger.info('cli.end', { i, pad: 'p'.repeat(50) })
-
-    const usage = logsDiskUsage(env)
-    expect(usage.files).toBe(3)
-    expect(archiveLogPaths(env)).toHaveLength(2)
-    // The whole point: bounded. Every retained file obeys the configured cap,
-    // however long the agent runs.
-    expect(usage.bytes).toBeLessThanOrEqual(3 * 700)
-    for (const file of [activeLogPath(env), ...archiveLogPaths(env)]) {
-      expect(statSync(file).size).toBeLessThanOrEqual(700)
-    }
-  })
-
-  it('leaves a marker in the fresh file so a gap is explained, not inferred', () => {
-    const env = sandbox()
-    const logger = createLogger({ env, settings: { maxBytes: 700, maxFiles: 3 } })
-    for (let i = 0; i < 20; i += 1) logger.info('cli.end', { i, pad: 'p'.repeat(40) })
-    expect(lines(env).some((record) => record.event === 'log.rotated')).toBe(true)
-  })
-
-  it('keeps only the active file when asked for one', () => {
-    const env = sandbox()
-    const logger = createLogger({ env, settings: { maxBytes: 300, maxFiles: 1 } })
-    for (let i = 0; i < 30; i += 1) logger.info('cli.end', { i, pad: 'p'.repeat(40) })
-    expect(archiveLogPaths(env)).toHaveLength(0)
-    expect(logsDiskUsage(env).files).toBe(1)
-    expect(statSync(activeLogPath(env)).size).toBeLessThanOrEqual(300)
-  })
-
-  it('keeps an indivisible record whole when an internal test injects an impossible cap', () => {
-    const env = sandbox()
-    const logger = createLogger({ env, settings: { maxBytes: 64, maxFiles: 3 } })
-    logger.info('cli.end', { sequence: 1 })
-    logger.info('cli.end', { sequence: 2 })
-
-    const files = [activeLogPath(env), ...archiveLogPaths(env)]
-    expect(files).toHaveLength(2)
-    for (const file of files) {
-      const records = readFileSync(file, 'utf8').split('\n').filter((line) => line !== '')
-      expect(records).toHaveLength(1)
-      expect(() => JSON.parse(records[0]!) as unknown).not.toThrow()
-      expect(statSync(file).size).toBeGreaterThan(64)
-    }
-  })
-
-  it('enforces the byte cap and preserves each record across overlapping processes', async () => {
-    const env = sandbox()
-    const workers = 4
-    const recordsPerWorker = 50
-    const maxBytes = 4_000
-    const maxFiles = 100
-    const startPath = path.join(env['XDG_STATE_HOME']!, 'rotation-start')
-    // Four cold Vitest processes have to reach the barrier before any of them
-    // writes, and a busy CI host schedules them far apart. The budget is shared,
-    // so it bounds the whole rendezvous rather than each side of it.
-    const deadline = Date.now() + 20_000
-    const children = Array.from({ length: workers }, (_, worker) =>
-      rotationWorker({ env, worker, records: recordsPerWorker, maxBytes, maxFiles, startPath, deadline }),
-    )
-
-    await waitUntil(() => children.every(({ readyPath }) => existsSync(readyPath)), deadline)
-    writeFileSync(startPath, 'go')
-    await Promise.all(children.map(({ done }) => done))
-
-    const files = [activeLogPath(env), ...archiveLogPaths(env)]
-    expect(files.length).toBeGreaterThan(1)
-    // The stat/rotate/append transaction is cross-process: no writer gets to
-    // consume budget another writer already claimed.
-    for (const file of files) expect(statSync(file).size).toBeLessThanOrEqual(maxBytes)
-
-    const seen = new Map<string, number>()
-    let retainedRecords = 0
-    for (const file of files) {
-      for (const line of readFileSync(file, 'utf8').split('\n')) {
-        if (line.trim() === '') continue
-        const record = JSON.parse(line) as LogRecord
-        if (record.event !== 'cli.end') continue
-        retainedRecords += 1
-        const key = `${String(record.data?.['worker'])}:${String(record.data?.['sequence'])}`
-        seen.set(key, (seen.get(key) ?? 0) + 1)
-      }
-    }
-    // Retention has room for every record, so neither a rotation nor an archive
-    // name race may lose or duplicate one.
-    expect(retainedRecords).toBe(workers * recordsPerWorker)
-    expect(seen.size).toBe(workers * recordsPerWorker)
-    // Name the offending records: a bare boolean would report a duplication bug
-    // as "expected false to be true" and leave the next reader nothing to go on.
-    expect([...seen].filter(([, count]) => count !== 1)).toEqual([])
-  }, 90_000)
-})
-
-describe('failure isolation', () => {
-  it('a sink that cannot write never throws at the caller', () => {
-    const env = sandbox()
-    // The logs directory's place is taken by a regular file, so every write
-    // below fails. A command must not care.
-    writeFileSync(path.join(env['XDG_STATE_HOME']!, 'notifai'), 'in the way')
-    const logger = createLogger({ env })
-    expect(() => logger.info('cli.end', { exit: 0 })).not.toThrow()
-    expect(logger.enabled).toBe(false)
-  })
-
-  it('the null logger accepts everything and records nothing', () => {
-    const logger = nullLogger()
-    expect(() => {
-      logger.info('cli.end', {})
-      logger.bind({ cmd: 'x' })
-      logger.adopt({ level: 'debug' })
-    }).not.toThrow()
-    expect(logger.enabled).toBe(false)
-  })
-})
-
-describe('reading', () => {
-  function seed(env: NodeJS.ProcessEnv): void {
-    const logger = createLogger({ env, runId: 'r_1', cmd: 'send' })
-    logger.bind({ project: 'alpha' })
-    logger.info('send.submitted', { request_id: 'req_alpha' })
-    logger.error('cli.error', { message: 'boom' })
-    const other = createLogger({ env, runId: 'r_2', cmd: 'ask' })
-    other.bind({ project: 'beta' })
-    other.info('ask.registered', { request_id: 'req_beta' })
-  }
-
-  it('returns records oldest first, so the result reads forwards', () => {
-    const env = sandbox()
-    seed(env)
-    const { records } = readLogRecords(env)
-    expect(records.map((record) => record.event)).toEqual([
-      'send.submitted',
-      'cli.error',
-      'ask.registered',
-    ])
-  })
-
-  it('is bounded, and says when there is more behind it', () => {
-    const env = sandbox()
-    seed(env)
-    const { records, more } = readLogRecords(env, { limit: 1 })
-    // The newest, not the oldest: a limit exists to answer "what just
-    // happened", so cutting the recent end would defeat it.
-    expect(records.map((record) => record.event)).toEqual(['ask.registered'])
-    expect(more).toBe(true)
-  })
-
-  it('filters by run, project, event, and severity', () => {
-    const env = sandbox()
-    seed(env)
-    expect(readLogRecords(env, { run: 'r_1' }).records).toHaveLength(2)
-    expect(readLogRecords(env, { project: 'beta' }).records).toHaveLength(1)
-    expect(readLogRecords(env, { event: ['cli.error'] }).records).toHaveLength(1)
-    expect(readLogRecords(env, { level: 'error' }).records.map((r) => r.event)).toEqual(['cli.error'])
-  })
-
-  it('finds every record touching one notification request', () => {
-    const env = sandbox()
-    seed(env)
-    const { records } = readLogRecords(env, { request: 'req_alpha' })
-    expect(records).toHaveLength(1)
-    expect(records[0]!.event).toBe('send.submitted')
-  })
-
-  it('matches every structured request identity without prefix false positives', () => {
-    const env = sandbox()
-    const logger = createLogger({ env })
-    logger.info('send.submitted', { request_id: 'req_1' })
-    logger.info('send.submitted', { request_id: 'req_10' })
-    logger.info('hook.answer', { request_ids: ['req_1', 'req_10'], answered: false })
-    logger.error('cli.error', { request_ids: ['req_10'], message: 'req_1' })
-
-    const { records } = readLogRecords(env, { request: 'req_1' })
-    expect(records).toHaveLength(2)
-    expect(records.map((record) => record.event)).toEqual(['send.submitted', 'hook.answer'])
-  })
-
-  it('honours a time floor', () => {
-    const env = sandbox()
-    const early = createLogger({ env, now: () => Date.parse('2026-08-01T00:00:00Z') })
-    early.info('cli.end', { when: 'old' })
-    const late = createLogger({ env, now: () => Date.parse('2026-08-11T00:00:00Z') })
-    late.info('cli.end', { when: 'new' })
-
-    const { records } = readLogRecords(env, { since: Date.parse('2026-08-10T00:00:00Z') })
-    expect(records).toHaveLength(1)
-    expect(records[0]!.data).toMatchObject({ when: 'new' })
-  })
-
-  it('reads across archives when the active file is not enough', () => {
-    const env = sandbox()
-    const logger = createLogger({ env, settings: { maxBytes: 500, maxFiles: 5 } })
-    for (let i = 0; i < 30; i += 1) logger.info('cli.end', { i })
-    expect(archiveLogPaths(env).length).toBeGreaterThan(0)
-    const { records, files } = readLogRecords(env, { limit: 30, event: ['cli.end'] })
-    expect(files.length).toBeGreaterThan(1)
-    expect(records.length).toBeGreaterThan(lines(env).filter((r) => r.event === 'cli.end').length)
-  })
-
-  it('skips damaged and unknown-future lines without throwing away the file', () => {
-    const env = sandbox()
-    seed(env)
-    // A half-written line is what a crashed process leaves behind, and a
-    // reader that dies on it loses every good record around it.
-    appendFileSync(activeLogPath(env), '{"v":1,"ts":"2026-0\n')
-    appendFileSync(activeLogPath(env), 'not json at all\n')
-    appendFileSync(
-      activeLogPath(env),
-      `${JSON.stringify({
-        v: LOG_SCHEMA_VERSION + 1,
-        ts: '2026-08-18T12:00:00.000Z',
-        level: 'info',
-        event: 'future.event',
-      })}\n`,
-    )
-    expect(readLogRecords(env).records.map((record) => record.event)).toEqual([
-      'send.submitted',
-      'cli.error',
-      'ask.registered',
-    ])
-  })
-
-  it('reports nothing at all rather than failing when there is no log', () => {
-    expect(readLogRecords(sandbox())).toMatchObject({ records: [], more: false })
-  })
-})
-
-describe('rendering', () => {
-  it('puts the fixed columns first so lines can be scanned, not read', () => {
-    const line = renderRecord({
-      v: 1,
-      ts: '2026-08-11T12:04:31.123Z',
-      level: 'info',
-      event: 'hook.gate',
-      run: 'r_1',
-      cmd: 'hook stop',
-      pid: 1,
-      data: { verdict: 'held', reason: 'notifications-off', source: 'default' },
-    })
-    expect(line).toContain('2026-08-11 12:04:31')
-    expect(line).toContain('hook.gate')
-    expect(line).toContain('reason=notifications-off')
-    expect(line).toContain('source=default')
-  })
-
-  it('stays on one line whatever the payload', () => {
-    const line = renderRecord({
-      v: 1,
-      ts: '2026-08-11T12:04:31.123Z',
-      level: 'error',
-      event: 'cli.error',
-      run: 'r_1',
-      cmd: 'send',
-      pid: 1,
-      data: { message: 'first\nsecond\nthird', big: 'z'.repeat(300) },
-    })
-    expect(line).not.toContain('\n')
-    expect(line.length).toBeLessThan(200)
-  })
-})