@raidiant/notifai 10.1.1 → 10.1.3

package/src/pack-feedback-slice.ts

@@ -1,187 +0,0 @@
-/**
- * Consented, bounded slice of the local log for a later feedback send.
- *
- * This module packs. It does not upload. A caller that wants a report on
- * the wire asks here for the bytes and the consent copy, then decides
- * whether to send them.
- */
-import { gzipSync } from 'node:zlib'
-import {
-  LOG_SCHEMA_VERSION,
-  readLogRecords,
-  type LogQuery,
-  type LogRecord,
-} from './logging.js'
-
-export const FEEDBACK_SLICE_UNCOMPRESSED_CAP = 256 * 1024
-export const FEEDBACK_SLICE_COMPRESSED_CAP = 128 * 1024
-export const FEEDBACK_SLICE_DEFAULT_WINDOW_MS = 24 * 60 * 60 * 1000
-
-/** High enough that on-disk rotation, not this number, bounds a full-window read. */
-const FULL_WINDOW_READ_LIMIT = 1_000_000
-
-export interface PackFeedbackSliceOptions extends LogQuery {
-  /** Epoch ms. Defaults to now. Tests freeze the window with this. */
-  now?: number
-}
-
-export interface PackedFeedbackSlice {
-  records: LogRecord[]
-  jsonl: string
-  gzip?: Buffer
-  uncompressed_bytes: number
-  compressed_bytes: number
-  record_count: number
-  truncated: boolean
-  since: number
-  until: number
-  schema_version: number
-  consentSummary: string
-}
-
-export interface FeedbackSliceWire {
-  encoding: 'gzip+base64'
-  bytes: string
-  uncompressed_bytes: number
-  compressed_bytes: number
-  record_count: number
-  truncated: boolean
-  since: string
-  until: string
-  schema_version: number
-}
-
-/** Wire form. Empty slices have nothing to encode. */
-export function encodeFeedbackSlice(slice: PackedFeedbackSlice): FeedbackSliceWire | undefined {
-  if (slice.gzip === undefined) return undefined
-  return {
-    encoding: 'gzip+base64',
-    bytes: slice.gzip.toString('base64'),
-    uncompressed_bytes: slice.uncompressed_bytes,
-    compressed_bytes: slice.compressed_bytes,
-    record_count: slice.record_count,
-    truncated: slice.truncated,
-    since: new Date(slice.since).toISOString(),
-    until: new Date(slice.until).toISOString(),
-    schema_version: slice.schema_version,
-  }
-}
-
-export function packFeedbackSlice(
-  env: NodeJS.ProcessEnv = process.env,
-  options: PackFeedbackSliceOptions = {},
-): PackedFeedbackSlice {
-  const { now, since: sinceOption, limit, ...filters } = options
-  const until = now ?? Date.now()
-  const since = sinceOption ?? until - FEEDBACK_SLICE_DEFAULT_WINDOW_MS
-  const { records } = readLogRecords(env, {
-    ...filters,
-    since,
-    limit: limit ?? FULL_WINDOW_READ_LIMIT,
-  })
-
-  if (records.length === 0) {
-    return emptySlice(since, until)
-  }
-
-  const packed = fitToCaps(records)
-  if (packed === null) {
-    return emptySlice(since, until)
-  }
-
-  return {
-    records: packed.records,
-    jsonl: packed.jsonl,
-    gzip: packed.gzip,
-    uncompressed_bytes: packed.uncompressedBytes,
-    compressed_bytes: packed.gzip.length,
-    record_count: packed.records.length,
-    truncated: packed.truncated,
-    since,
-    until,
-    schema_version: LOG_SCHEMA_VERSION,
-    consentSummary: consentSummary({
-      since,
-      until,
-      recordCount: packed.records.length,
-      uncompressedBytes: packed.uncompressedBytes,
-      compressedBytes: packed.gzip.length,
-    }),
-  }
-}
-
-function fitToCaps(records: LogRecord[]): {
-  records: LogRecord[]
-  jsonl: string
-  gzip: Buffer
-  uncompressedBytes: number
-  truncated: boolean
-} | null {
-  const lines = records.map((record) => JSON.stringify(record))
-  let start = 0
-  let truncated = false
-  while (start < lines.length) {
-    const jsonl = toJsonl(lines.slice(start))
-    const uncompressedBytes = Buffer.byteLength(jsonl)
-    if (uncompressedBytes > FEEDBACK_SLICE_UNCOMPRESSED_CAP) {
-      start += 1
-      truncated = true
-      continue
-    }
-    const gzip = gzipSync(jsonl)
-    if (gzip.length <= FEEDBACK_SLICE_COMPRESSED_CAP) {
-      return {
-        records: records.slice(start),
-        jsonl,
-        gzip,
-        uncompressedBytes,
-        truncated,
-      }
-    }
-    start += 1
-    truncated = true
-  }
-  return null
-}
-
-function emptySlice(since: number, until: number): PackedFeedbackSlice {
-  return {
-    records: [],
-    jsonl: '',
-    uncompressed_bytes: 0,
-    compressed_bytes: 0,
-    record_count: 0,
-    truncated: false,
-    since,
-    until,
-    schema_version: LOG_SCHEMA_VERSION,
-    consentSummary: consentSummary({
-      since,
-      until,
-      recordCount: 0,
-      uncompressedBytes: 0,
-      compressedBytes: 0,
-    }),
-  }
-}
-
-function toJsonl(lines: string[]): string {
-  if (lines.length === 0) return ''
-  return `${lines.join('\n')}\n`
-}
-
-function consentSummary(input: {
-  since: number
-  until: number
-  recordCount: number
-  uncompressedBytes: number
-  compressedBytes: number
-}): string {
-  const from = new Date(input.since).toISOString()
-  const to = new Date(input.until).toISOString()
-  return (
-    `About to send ${String(input.recordCount)} log records from ${from} to ${to} ` +
-    `(${String(input.uncompressedBytes)} bytes uncompressed, ${String(input.compressedBytes)} bytes compressed). ` +
-    'Credentials are already removed. Notification titles and the user\'s answers are in the log.'
-  )
-}

package/src/platform.test.ts

@@ -1,152 +0,0 @@
-import os from 'node:os'
-import path from 'node:path'
-import { describe, expect, it } from 'vitest'
-import {
-  accountHome,
-  cmdScript,
-  configHome,
-  isWindowsAbsolute,
-  npxLaunch,
-  quoteCmdArgument,
-  stateHome,
-  urlOpenLaunch,
-} from './platform.js'
-import { globalConfigDir, stateDir } from './config.js'
-
-const PAIRING_URL = 'https://notifai.example/approve?code=AB&next=1|calc'
-
-describe('urlOpenLaunch', () => {
-  it('keeps a metacharacter pairing URL as one Windows argument and hides the console', () => {
-    const launch = urlOpenLaunch(PAIRING_URL, 'win32')
-    expect(launch.file.toLowerCase()).not.toMatch(/^cmd(\.exe)?$/)
-    expect(launch.args).toEqual(['url.dll,FileProtocolHandler', PAIRING_URL])
-    expect(launch.options.windowsHide).toBe(true)
-    expect(launch.options.detached).toBe(true)
-    expect(launch.options.stdio).toBe('ignore')
-  })
-
-  it('preserves best-effort open and xdg-open on POSIX', () => {
-    expect(urlOpenLaunch(PAIRING_URL, 'darwin')).toEqual({
-      file: 'open',
-      args: [PAIRING_URL],
-      options: { stdio: 'ignore', detached: true },
-    })
-    expect(urlOpenLaunch(PAIRING_URL, 'linux')).toEqual({
-      file: 'xdg-open',
-      args: [PAIRING_URL],
-      options: { stdio: 'ignore', detached: true },
-    })
-  })
-})
-
-describe('npxLaunch', () => {
-  const source = 'Raidiant-io/notifai#v1.0.1'
-  const args = ['-y', 'skills', 'add', source, '--skill', 'notifai', '--yes']
-
-  it('runs the .cmd shim through cmd on Windows with quoted arguments', () => {
-    const launch = npxLaunch(args, {
-      cwd: 'C:\\proj',
-      env: { ComSpec: 'C:\\Windows\\system32\\cmd.exe' },
-      platform: 'win32',
-    })
-    expect(launch.file).toBe('C:\\Windows\\system32\\cmd.exe')
-    expect(launch.args.slice(0, 4)).toEqual(['/d', '/s', '/v:off', '/c'])
-    expect(launch.args).toHaveLength(5)
-    expect(launch.args[4]).toBe(cmdScript('npx.cmd', args))
-    expect(launch.args[4]).toContain('npx.cmd')
-    expect(launch.args[4]).toContain(quoteCmdArgument(source))
-    expect(launch.options.windowsVerbatimArguments).toBe(true)
-    expect(launch.options.windowsHide).toBe(true)
-    expect(launch.options.stdio).toBe('inherit')
-    expect(launch.options.cwd).toBe('C:\\proj')
-  })
-
-  it('quotes a hostile source so cmd cannot treat & as a second command', () => {
-    const hostile = 'evil&calc.exe'
-    const launch = npxLaunch(['-y', 'skills', 'add', hostile, '--skill', 'notifai'], {
-      cwd: 'C:\\proj',
-      env: {},
-      platform: 'win32',
-    })
-    const script = launch.args[4] ?? ''
-    expect(script).toContain(quoteCmdArgument(hostile))
-    expect(script.startsWith('"') && script.endsWith('"')).toBe(true)
-    expect(launch.file).toBe('cmd.exe')
-  })
-
-  it('spawns npx directly on POSIX without a shell', () => {
-    const launch = npxLaunch(args, { cwd: '/tmp/proj', env: { PATH: '/usr/bin' }, platform: 'linux' })
-    expect(launch).toEqual({
-      file: 'npx',
-      args,
-      options: { cwd: '/tmp/proj', env: { PATH: '/usr/bin' }, stdio: 'inherit' },
-    })
-    expect(launch.options.windowsVerbatimArguments).toBeUndefined()
-  })
-})
-
-describe('accountHome', () => {
-  it('rejects an MSYS HOME on Windows and uses a Windows-absolute USERPROFILE', () => {
-    expect(
-      accountHome({ HOME: '/c/Users/rafael', USERPROFILE: 'C:\\Users\\rafael' }, 'win32'),
-    ).toBe('C:\\Users\\rafael')
-    expect(accountHome({ HOME: '/home/rafael', USERPROFILE: 'C:/Users/rafael' }, 'win32')).toBe(
-      'C:/Users/rafael',
-    )
-    expect(isWindowsAbsolute('/c/Users/rafael')).toBe(false)
-    expect(isWindowsAbsolute('C:\\Users\\rafael')).toBe(true)
-  })
-
-  it('honours a Windows-absolute HOME and falls back to os.homedir()', () => {
-    expect(accountHome({ HOME: 'D:\\homes\\dev', USERPROFILE: 'C:\\Users\\rafael' }, 'win32')).toBe(
-      'D:\\homes\\dev',
-    )
-    expect(accountHome({ HOME: '/c/Users/rafael' }, 'win32')).toBe(os.homedir())
-  })
-
-  it('preserves POSIX HOME, including a POSIX-looking value', () => {
-    expect(accountHome({ HOME: '/home/rafael', USERPROFILE: 'C:\\Users\\rafael' }, 'linux')).toBe(
-      '/home/rafael',
-    )
-    expect(accountHome({ HOME: '/c/Users/rafael' }, 'darwin')).toBe('/c/Users/rafael')
-    expect(accountHome({}, 'linux')).toBe(os.homedir())
-  })
-})
-
-describe('known-folder roots', () => {
-  it('defaults Windows config to APPDATA/notifai and state to LOCALAPPDATA/notifai', () => {
-    const env = {
-      APPDATA: 'C:\\Users\\rafael\\AppData\\Roaming',
-      LOCALAPPDATA: 'C:\\Users\\rafael\\AppData\\Local',
-      HOME: '/c/Users/rafael',
-      USERPROFILE: 'C:\\Users\\rafael',
-    }
-    expect(configHome(env, 'win32')).toBe(env.APPDATA)
-    expect(stateHome(env, 'win32')).toBe(env.LOCALAPPDATA)
-    expect(globalConfigDir(env, 'win32')).toBe(path.join(env.APPDATA, 'notifai'))
-    expect(stateDir(env, 'win32')).toBe(path.join(env.LOCALAPPDATA, 'notifai'))
-  })
-
-  it('lets explicit XDG roots override Windows known folders', () => {
-    const env = {
-      XDG_CONFIG_HOME: 'D:\\xdg\\config',
-      XDG_STATE_HOME: 'D:\\xdg\\state',
-      APPDATA: 'C:\\Users\\rafael\\AppData\\Roaming',
-      LOCALAPPDATA: 'C:\\Users\\rafael\\AppData\\Local',
-    }
-    expect(globalConfigDir(env, 'win32')).toBe(path.join('D:\\xdg\\config', 'notifai'))
-    expect(stateDir(env, 'win32')).toBe(path.join('D:\\xdg\\state', 'notifai'))
-  })
-
-  it('keeps POSIX XDG defaults under the account home', () => {
-    const env = { HOME: '/home/rafael' }
-    expect(globalConfigDir(env, 'linux')).toBe(path.join('/home/rafael', '.config', 'notifai'))
-    expect(stateDir(env, 'linux')).toBe(path.join('/home/rafael', '.local', 'state', 'notifai'))
-    expect(globalConfigDir({ XDG_CONFIG_HOME: '/custom/config' }, 'darwin')).toBe(
-      path.join('/custom/config', 'notifai'),
-    )
-    expect(stateDir({ XDG_STATE_HOME: '/custom/state' }, 'linux')).toBe(
-      path.join('/custom/state', 'notifai'),
-    )
-  })
-})

package/src/platform.ts

@@ -1,173 +0,0 @@
-import { spawn, type SpawnOptions } from 'node:child_process'
-import os from 'node:os'
-import path from 'node:path'
-
-/**
- * How this process should launch one child. Tests inspect the plan instead of
- * opening a browser or running npx; production hands it to `spawn`.
- */
-export interface ProcessLaunch {
-  file: string
-  args: string[]
-  options: SpawnOptions
-}
-
-/** Drive letter or UNC. MSYS `/c/Users/…` is not a Windows account home. */
-export function isWindowsAbsolute(value: string): boolean {
-  return /^[A-Za-z]:[\\/]/.test(value) || value.startsWith('\\\\')
-}
-
-/**
- * The account home used for Notifai's own defaults.
- *
- * On Windows, Git Bash and MSYS overwrite `HOME` with a POSIX path that is not
- * a usable NTFS root. Those values are ignored; a Windows-absolute
- * `USERPROFILE` or `os.homedir()` wins. A Windows-absolute `HOME` is still
- * honoured. POSIX keeps `HOME` as the override it has always been.
- */
-export function accountHome(
-  env: NodeJS.ProcessEnv = process.env,
-  platform: NodeJS.Platform = process.platform,
-): string {
-  if (platform === 'win32') {
-    const home = env['HOME']
-    if (typeof home === 'string' && isWindowsAbsolute(home)) return home
-    const profile = env['USERPROFILE']
-    if (typeof profile === 'string' && isWindowsAbsolute(profile)) return profile
-    return os.homedir()
-  }
-  const home = env['HOME']
-  if (typeof home === 'string' && home !== '') return home
-  return os.homedir()
-}
-
-/**
- * Directory that contains the `notifai/` configuration folder.
- *
- * An explicit `XDG_CONFIG_HOME` always wins, including on Windows. Otherwise
- * Windows uses `%APPDATA%` and POSIX uses `~/.config`.
- */
-export function configHome(
-  env: NodeJS.ProcessEnv = process.env,
-  platform: NodeJS.Platform = process.platform,
-): string {
-  const xdg = env['XDG_CONFIG_HOME']
-  if (typeof xdg === 'string' && xdg !== '') return xdg
-  if (platform === 'win32') {
-    const appdata = env['APPDATA']
-    if (typeof appdata === 'string' && appdata !== '') return appdata
-  }
-  return path.join(accountHome(env, platform), '.config')
-}
-
-/**
- * Directory that contains the `notifai/` machine-local state folder.
- *
- * An explicit `XDG_STATE_HOME` always wins. Otherwise Windows uses
- * `%LOCALAPPDATA%` and POSIX uses `~/.local/state`.
- */
-export function stateHome(
-  env: NodeJS.ProcessEnv = process.env,
-  platform: NodeJS.Platform = process.platform,
-): string {
-  const xdg = env['XDG_STATE_HOME']
-  if (typeof xdg === 'string' && xdg !== '') return xdg
-  if (platform === 'win32') {
-    const local = env['LOCALAPPDATA']
-    if (typeof local === 'string' && local !== '') return local
-  }
-  return path.join(accountHome(env, platform), '.local', 'state')
-}
-
-/**
- * Open a pairing or support URL.
- *
- * Windows goes through `rundll32` so the URL is one CreateProcess argument and
- * `cmd` never reparses `?a=1&b=2`. `windowsHide` keeps the helper from flashing
- * a console. macOS and Linux stay best-effort `open` / `xdg-open`.
- */
-export function urlOpenLaunch(
-  url: string,
-  platform: NodeJS.Platform = process.platform,
-): ProcessLaunch {
-  if (platform === 'darwin') {
-    return { file: 'open', args: [url], options: { stdio: 'ignore', detached: true } }
-  }
-  if (platform === 'win32') {
-    return {
-      file: 'rundll32.exe',
-      args: ['url.dll,FileProtocolHandler', url],
-      options: { stdio: 'ignore', detached: true, windowsHide: true },
-    }
-  }
-  return { file: 'xdg-open', args: [url], options: { stdio: 'ignore', detached: true } }
-}
-
-/** Best-effort browser open. Failure is silent: the URL is printed either way. */
-export function openUrl(url: string, platform: NodeJS.Platform = process.platform): void {
-  try {
-    const launch = urlOpenLaunch(url, platform)
-    spawn(launch.file, launch.args, launch.options).unref()
-  } catch {
-    // The caller already printed the URL.
-  }
-}
-
-/**
- * Quote one cmd.exe argument so it cannot start a second command.
- *
- * `%` expands even inside quotes, so it is doubled. Quotes themselves are
- * doubled. Everything else is inert once quoted, including `& | > < ^`.
- */
-export function quoteCmdArgument(value: string): string {
-  return `"${value.replace(/%/g, '%%').replace(/"/g, '""')}"`
-}
-
-/**
- * A single `/c` argument for `cmd /d /s /c`.
- *
- * `/s` strips the first and last quote when both ends are quotes, so the
- * payload is wrapped once more around the already-quoted argv. What cmd then
- * runs is `"npx.cmd" "-y" …` with no unquoted metacharacters.
- */
-export function cmdScript(command: string, args: readonly string[]): string {
-  return `"${[command, ...args].map(quoteCmdArgument).join(' ')}"`
-}
-
-/**
- * Launch `npx` so Windows can run the `.cmd` shim.
- *
- * `spawn('npx', …)` is CreateProcess of a file named `npx`, which does not
- * exist — npm installs `npx.cmd`. cmd.exe can run that shim; CreateProcess
- * cannot. Arguments stay in one quoted `/c` string rather than `shell: true`.
- */
-export function npxLaunch(
-  args: readonly string[],
-  options: {
-    cwd: string
-    env: NodeJS.ProcessEnv
-    platform?: NodeJS.Platform
-    stdio?: SpawnOptions['stdio']
-  },
-): ProcessLaunch {
-  const platform = options.platform ?? process.platform
-  const stdio = options.stdio ?? 'inherit'
-  if (platform === 'win32') {
-    return {
-      file: options.env['ComSpec'] && options.env['ComSpec'] !== '' ? options.env['ComSpec'] : 'cmd.exe',
-      args: ['/d', '/s', '/v:off', '/c', cmdScript('npx.cmd', args)],
-      options: {
-        cwd: options.cwd,
-        env: options.env,
-        stdio,
-        windowsHide: true,
-        windowsVerbatimArguments: true,
-      },
-    }
-  }
-  return {
-    file: 'npx',
-    args: [...args],
-    options: { cwd: options.cwd, env: options.env, stdio },
-  }
-}