@pikku/inspector 0.12.75 → 0.12.81

package/src/add/classified-sink-check.test.ts

@@ -1,347 +0,0 @@
-import { strict as assert } from 'assert'
-import { describe, test } from 'node:test'
-import { mkdtemp, rm, writeFile } from 'node:fs/promises'
-import { tmpdir } from 'node:os'
-import { join } from 'node:path'
-import { inspect } from '../inspector.js'
-import { ErrorCode } from '../error-codes.js'
-import type { InspectorLogger } from '../types.js'
-
-function makeLogger() {
-  const diagnostics: Array<{ code: ErrorCode; message: string }> = []
-  const logger: InspectorLogger = {
-    debug: () => {},
-    info: () => {},
-    warn: () => {},
-    error: () => {},
-    diagnostic: ({ code, message }) => diagnostics.push({ code, message }),
-    critical: (code, message) => diagnostics.push({ code, message }),
-    hasCriticalErrors: () => diagnostics.length > 0,
-  }
-  return { logger, diagnostics }
-}
-
-/**
- * Stands in for @pikku/core, which is not importable from a tmp dir. The shapes
- * are what matters: `Secret<T>` is the optional brand `.reveal()` returns,
- * `Pii<T>` and `Private<T>` are the brands a generated row type carries, and the
- * service interfaces are matched by name, so these must keep the real names.
- */
-const PRELUDE = `
-type Secret<T> = T & { readonly __classification__?: 'secret' }
-type Pii<T> = T & { readonly __classification__?: 'pii' }
-type Private<T> = T & { readonly __classification__?: 'private' }
-
-/** What \`db.selectFrom('user')\` hands back once the schema is generated. */
-interface UserRow {
-  userId: string
-  email: Pii<string>
-  internalNote: Private<string>
-}
-declare function getUser(): Promise<UserRow>
-
-declare class SecretValue<T = string> {
-  private brand: T
-  reveal(): Secret<T>
-}
-
-interface Logger {
-  info(messageOrObj: any, ...meta: any[]): void
-  error(messageOrObj: any, ...meta: any[]): void
-}
-interface QueueService {
-  add<T>(queueName: string, data: T): Promise<string>
-}
-interface EmailService {
-  send(input: any): Promise<void>
-}
-interface WebhookService {
-  send(input: any): Promise<void>
-}
-interface AuditService {
-  audit(event: { type: string; input?: unknown }): Promise<void>
-}
-interface AuditLog {
-  write(event: { type: string; input?: unknown }): Promise<void>
-}
-
-type Services = {
-  logger: Logger
-  queueService: QueueService
-  email: EmailService
-  webhooks: WebhookService
-  audit?: AuditService
-  auditLog?: AuditLog
-  secrets: { getSecret(key: string): Promise<SecretValue<string>> }
-}
-
-declare const pikkuFunc: <In, Out>(cfg: {
-  func: (services: Services, data: In) => Promise<Out>
-}) => unknown
-`
-
-async function runInspect(source: string) {
-  const tmpDir = await mkdtemp(join(tmpdir(), 'pikku-secret-sink-test-'))
-  const file = join(tmpDir, 'funcs.ts')
-  await writeFile(file, PRELUDE + source)
-  const { logger, diagnostics } = makeLogger()
-  try {
-    await inspect(logger, [file], {
-      rootDir: tmpDir,
-      classificationCheck: true,
-    })
-  } finally {
-    await rm(tmpDir, { recursive: true, force: true })
-  }
-  return diagnostics
-}
-
-const sinkErrors = (diagnostics: Array<{ code: ErrorCode; message: string }>) =>
-  diagnostics.filter((d) => d.code === ErrorCode.SECRET_REVEALED_INTO_SINK)
-
-const piiErrors = (diagnostics: Array<{ code: ErrorCode; message: string }>) =>
-  diagnostics.filter((d) => d.code === ErrorCode.PII_INTO_SINK)
-
-describe('PKU953 — a revealed secret reaching a sink', () => {
-  test('flags a secret logged inline', async () => {
-    const diagnostics = await runInspect(`
-      export const leak = pikkuFunc<void, void>({
-        func: async ({ logger, secrets }) => {
-          const token = await secrets.getSecret('API_KEY')
-          logger.info(token.reveal())
-        },
-      })
-    `)
-    const errors = sinkErrors(diagnostics)
-    assert.equal(errors.length, 1)
-    assert.match(errors[0]!.message, /logger\.info/)
-  })
-
-  test('flags a secret that reaches the sink through a local binding', async () => {
-    const diagnostics = await runInspect(`
-      export const leak = pikkuFunc<void, void>({
-        func: async ({ logger, secrets }) => {
-          const token = (await secrets.getSecret('API_KEY')).reveal()
-          logger.error('auth failed', { token })
-        },
-      })
-    `)
-    const errors = sinkErrors(diagnostics)
-    assert.equal(errors.length, 1)
-    assert.match(errors[0]!.message, /logger\.error/)
-    assert.match(errors[0]!.message, /token/)
-  })
-
-  test('flags a secret enqueued, emailed or sent to a webhook', async () => {
-    const diagnostics = await runInspect(`
-      export const leak = pikkuFunc<void, void>({
-        func: async ({ queueService, email, webhooks, secrets }) => {
-          const token = (await secrets.getSecret('API_KEY')).reveal()
-          await queueService.add('jobs', { token })
-          await email.send({ to: 'a@b.c', text: token })
-          await webhooks.send({ url: 'https://x', data: { token } })
-        },
-      })
-    `)
-    assert.equal(sinkErrors(diagnostics).length, 3)
-  })
-
-  test('flags a secret written to an audit, through the optional chain it is reached by', async () => {
-    const diagnostics = await runInspect(`
-      export const leak = pikkuFunc<void, void>({
-        func: async ({ audit, auditLog, secrets }) => {
-          const token = (await secrets.getSecret('API_KEY')).reveal()
-          await audit?.audit({ type: 'used', input: { token } })
-          await auditLog?.write({ type: 'used', input: token })
-        },
-      })
-    `)
-    const errors = sinkErrors(diagnostics)
-    assert.equal(errors.length, 2)
-    assert.match(errors[0]!.message, /audit\.audit/)
-    assert.match(errors[1]!.message, /auditLog\.write/)
-  })
-
-  test('flags console, which no type guard covers', async () => {
-    const diagnostics = await runInspect(`
-      export const leak = pikkuFunc<void, void>({
-        func: async ({ secrets }) => {
-          const token = await secrets.getSecret('API_KEY')
-          console.log(token.reveal())
-        },
-      })
-    `)
-    const errors = sinkErrors(diagnostics)
-    assert.equal(errors.length, 1)
-    assert.match(errors[0]!.message, /console\.log/)
-  })
-
-  test('stays quiet when the secret never reaches a sink', async () => {
-    const diagnostics = await runInspect(`
-      declare function authenticate(token: string): Promise<void>
-
-      export const fine = pikkuFunc<void, void>({
-        func: async ({ logger, secrets }) => {
-          const token = (await secrets.getSecret('API_KEY')).reveal()
-          await authenticate(token)
-          logger.info('authenticated')
-        },
-      })
-    `)
-    assert.equal(sinkErrors(diagnostics).length, 0)
-  })
-
-  test('stays quiet for ordinary logging', async () => {
-    const diagnostics = await runInspect(`
-      export const fine = pikkuFunc<{ id: string }, void>({
-        func: async ({ logger }, data) => {
-          logger.info('processing', { id: data.id, at: new Date() })
-        },
-      })
-    `)
-    assert.equal(sinkErrors(diagnostics).length, 0)
-  })
-
-  test('does not run without the classification flag', async () => {
-    const tmpDir = await mkdtemp(join(tmpdir(), 'pikku-secret-sink-off-'))
-    const file = join(tmpDir, 'funcs.ts')
-    await writeFile(
-      file,
-      PRELUDE +
-        `
-      export const leak = pikkuFunc<void, void>({
-        func: async ({ logger, secrets }) => {
-          const token = await secrets.getSecret('API_KEY')
-          logger.info(token.reveal())
-        },
-      })
-    `
-    )
-    const { logger, diagnostics } = makeLogger()
-    try {
-      await inspect(logger, [file], { rootDir: tmpDir })
-    } finally {
-      await rm(tmpDir, { recursive: true, force: true })
-    }
-    assert.equal(sinkErrors(diagnostics).length, 0)
-  })
-})
-
-/**
- * PII is not a secret, so the policy is not "never write it down" — it is "not
- * where it leaves your control". A log ships to an aggregator and a webhook
- * posts to somebody else's server; an email is addressed to the data subject,
- * and a queue and an audit stay on the operator's own infrastructure.
- */
-describe('PKU954 — personal data reaching a sink', () => {
-  test('flags PII logged inline and through a local binding', async () => {
-    const diagnostics = await runInspect(`
-      export const leak = pikkuFunc<void, void>({
-        func: async ({ logger }) => {
-          const user = await getUser()
-          logger.info(user.email)
-          const email = user.email
-          logger.error('send failed', { email })
-        },
-      })
-    `)
-    const errors = piiErrors(diagnostics)
-    assert.equal(errors.length, 2)
-    assert.match(errors[0]!.message, /logger\.info/)
-    assert.match(errors[1]!.message, /logger\.error/)
-    assert.equal(sinkErrors(diagnostics).length, 0)
-  })
-
-  test('flags a whole row logged, since the PII rides along inside it', async () => {
-    const diagnostics = await runInspect(`
-      export const leak = pikkuFunc<void, void>({
-        func: async ({ logger }) => {
-          const user = await getUser()
-          logger.info('loaded', user)
-        },
-      })
-    `)
-    assert.equal(piiErrors(diagnostics).length, 1)
-  })
-
-  test('flags PII on console and in a webhook', async () => {
-    const diagnostics = await runInspect(`
-      export const leak = pikkuFunc<void, void>({
-        func: async ({ webhooks }) => {
-          const user = await getUser()
-          console.log(user.email)
-          await webhooks.send({ url: 'https://x', data: { email: user.email } })
-        },
-      })
-    `)
-    const errors = piiErrors(diagnostics)
-    assert.equal(errors.length, 2)
-    assert.match(errors[0]!.message, /console\.log/)
-    assert.match(errors[1]!.message, /webhooks\.send/)
-  })
-
-  test('stays quiet for an email to the data subject, an audit and a queue', async () => {
-    const diagnostics = await runInspect(`
-      export const fine = pikkuFunc<void, void>({
-        func: async ({ email, audit, auditLog, queueService }) => {
-          const user = await getUser()
-          await email.send({ to: user.email, text: 'Hi ' + user.email })
-          await audit?.audit({ type: 'viewed', input: { email: user.email } })
-          await auditLog?.write({ type: 'viewed', input: user.email })
-          await queueService.add('welcome', { email: user.email })
-        },
-      })
-    `)
-    assert.equal(piiErrors(diagnostics).length, 0)
-    assert.equal(sinkErrors(diagnostics).length, 0)
-  })
-
-  test('stays quiet for private, which is about who may read the row', async () => {
-    const diagnostics = await runInspect(`
-      export const fine = pikkuFunc<void, void>({
-        func: async ({ logger }) => {
-          const user = await getUser()
-          logger.info('note', { note: user.internalNote, id: user.userId })
-        },
-      })
-    `)
-    assert.equal(piiErrors(diagnostics).length, 0)
-  })
-
-  test('stays quiet when an explicit annotation erases the brand', async () => {
-    const diagnostics = await runInspect(`
-      export const documentedLimit = pikkuFunc<void, void>({
-        func: async ({ logger }) => {
-          const user = await getUser()
-          const email: string = user.email
-          logger.info(email)
-        },
-      })
-    `)
-    assert.equal(piiErrors(diagnostics).length, 0)
-  })
-
-  test('does not run without the classification flag', async () => {
-    const tmpDir = await mkdtemp(join(tmpdir(), 'pikku-pii-sink-off-'))
-    const file = join(tmpDir, 'funcs.ts')
-    await writeFile(
-      file,
-      PRELUDE +
-        `
-      export const leak = pikkuFunc<void, void>({
-        func: async ({ logger }) => {
-          const user = await getUser()
-          logger.info(user.email)
-        },
-      })
-    `
-    )
-    const { logger, diagnostics } = makeLogger()
-    try {
-      await inspect(logger, [file], { rootDir: tmpDir })
-    } finally {
-      await rm(tmpDir, { recursive: true, force: true })
-    }
-    assert.equal(piiErrors(diagnostics).length, 0)
-  })
-})

package/src/add/config-value-metadata.test.ts

@@ -1,263 +0,0 @@
-import { strict as assert } from 'assert'
-import { describe, test } from 'node:test'
-import { mkdtemp, rm, writeFile } from 'node:fs/promises'
-import { join } from 'node:path'
-import { fileURLToPath } from 'node:url'
-import { inspect } from '../inspector.js'
-import type { ErrorCode } from '../error-codes.js'
-import type { InspectorLogger } from '../types.js'
-
-// Fixtures must sit inside the package so `zod` resolves — the schema-vendor
-// check rejects a schema it cannot trace to a supported library, and the
-// definition is then never recorded at all.
-const fixtureRoot = join(
-  fileURLToPath(new URL('.', import.meta.url)),
-  '__fixtures'
-)
-
-const makeLogger = (criticals: Array<{ code: ErrorCode; message: string }>) =>
-  ({
-    debug: () => {},
-    info: () => {},
-    warn: () => {},
-    error: () => {},
-    diagnostic: ({ code, message }) => {
-      criticals.push({ code, message })
-    },
-    critical: (code: ErrorCode, message: string) => {
-      criticals.push({ code, message })
-    },
-    hasCriticalErrors: () => criticals.length > 0,
-  }) satisfies InspectorLogger
-
-/**
- * `docsUrl` is only useful if it survives inspection — a field declared on the
- * wiring but dropped by the inspector is invisible to every consumer
- * downstream, which is exactly how `displayName` went unused.
- */
-describe('config value metadata (docsUrl)', () => {
-  test('carries docsUrl from defineSecret into the definition', async () => {
-    const rootDir = await mkdtemp(`${fixtureRoot}-secret-`)
-    const file = join(rootDir, 'secret.ts')
-
-    await writeFile(
-      file,
-      [
-        "import { defineSecret } from '@pikku/core'",
-        "import { z } from 'zod'",
-        'export const StripeKeySchema = z.string()',
-        'defineSecret({',
-        "  name: 'stripeKey',",
-        "  displayName: 'Stripe Secret Key',",
-        "  secretId: 'STRIPE_SECRET_KEY',",
-        "  docsUrl: 'https://dashboard.stripe.com/apikeys',",
-        '  schema: StripeKeySchema,',
-        '})',
-      ].join('\n')
-    )
-
-    const criticals: Array<{ code: ErrorCode; message: string }> = []
-    try {
-      const state = await inspect(makeLogger(criticals), [file], { rootDir })
-      const def = state.secrets.definitions.find(
-        (d) => d.secretId === 'STRIPE_SECRET_KEY'
-      )
-      assert.ok(def, 'expected the secret definition to be inspected')
-      assert.equal(def!.docsUrl, 'https://dashboard.stripe.com/apikeys')
-    } finally {
-      await rm(rootDir, { recursive: true, force: true })
-    }
-  })
-
-  test('leaves docsUrl undefined when not declared', async () => {
-    const rootDir = await mkdtemp(`${fixtureRoot}-bare-`)
-    const file = join(rootDir, 'secret.ts')
-
-    await writeFile(
-      file,
-      [
-        "import { defineSecret } from '@pikku/core'",
-        "import { z } from 'zod'",
-        'export const ApiKeySchema = z.string()',
-        'defineSecret({',
-        "  name: 'apiKey',",
-        "  displayName: 'API Key',",
-        "  secretId: 'API_KEY',",
-        '  schema: ApiKeySchema,',
-        '})',
-      ].join('\n')
-    )
-
-    const criticals: Array<{ code: ErrorCode; message: string }> = []
-    try {
-      const state = await inspect(makeLogger(criticals), [file], { rootDir })
-      const def = state.secrets.definitions.find(
-        (d) => d.secretId === 'API_KEY'
-      )
-      assert.ok(def, 'expected the secret definition to be inspected')
-      assert.equal(def!.docsUrl, undefined)
-    } finally {
-      await rm(rootDir, { recursive: true, force: true })
-    }
-  })
-
-  test('carries docsUrl from defineVariable into the definition', async () => {
-    const rootDir = await mkdtemp(`${fixtureRoot}-variable-`)
-    const file = join(rootDir, 'variable.ts')
-
-    await writeFile(
-      file,
-      [
-        "import { defineVariable } from '@pikku/core'",
-        "import { z } from 'zod'",
-        'export const ConsoleUrlSchema = z.string()',
-        'defineVariable({',
-        "  name: 'consoleUrl',",
-        "  displayName: 'Console URL',",
-        "  variableId: 'CONSOLE_URL',",
-        "  docsUrl: 'https://example.com/docs/console-url',",
-        '  schema: ConsoleUrlSchema,',
-        '})',
-      ].join('\n')
-    )
-
-    const criticals: Array<{ code: ErrorCode; message: string }> = []
-    try {
-      const state = await inspect(makeLogger(criticals), [file], { rootDir })
-      const def = state.variables.definitions.find(
-        (d) => d.variableId === 'CONSOLE_URL'
-      )
-      assert.ok(def, 'expected the variable definition to be inspected')
-      assert.equal(def!.docsUrl, 'https://example.com/docs/console-url')
-    } finally {
-      await rm(rootDir, { recursive: true, force: true })
-    }
-  })
-
-  test('carries docsUrl from defineCredential into the definition', async () => {
-    const rootDir = await mkdtemp(`${fixtureRoot}-credential-`)
-    const file = join(rootDir, 'credential.ts')
-
-    await writeFile(
-      file,
-      [
-        "import { defineCredential } from '@pikku/core'",
-        "import { z } from 'zod'",
-        'export const TokenSchema = z.object({ token: z.string() })',
-        'defineCredential({',
-        "  name: 'githubToken',",
-        "  displayName: 'GitHub Token',",
-        "  type: 'wire',",
-        "  docsUrl: 'https://github.com/settings/tokens',",
-        '  schema: TokenSchema,',
-        '})',
-      ].join('\n')
-    )
-
-    const criticals: Array<{ code: ErrorCode; message: string }> = []
-    try {
-      const state = await inspect(makeLogger(criticals), [file], { rootDir })
-      const def = state.credentials.definitions.find(
-        (d) => d.name === 'githubToken'
-      )
-      assert.ok(def, 'expected the credential definition to be inspected')
-      assert.equal(def!.docsUrl, 'https://github.com/settings/tokens')
-    } finally {
-      await rm(rootDir, { recursive: true, force: true })
-    }
-  })
-})
-
-/**
- * `optional` is the deploy gate's whole input. A flag the
- * inspector drops leaves the gate seeing a bare declaration, which is how an
- * optional secret suspends a deploy over a value production is meant NOT to
- * have.
- */
-describe('config value gating flags', () => {
-  test('carries optional from defineSecret into the definition', async () => {
-    const rootDir = await mkdtemp(`${fixtureRoot}-secret-optional-`)
-    const file = join(rootDir, 'secret.ts')
-
-    await writeFile(
-      file,
-      [
-        "import { defineSecret } from '@pikku/core'",
-        "import { z } from 'zod'",
-        'export const ActorSchema = z.string()',
-        'export const StripeSchema = z.string()',
-        'defineSecret({',
-        "  name: 'scenarioActor',",
-        "  displayName: 'Scenario Actor Secret',",
-        "  secretId: 'SCENARIO_ACTOR_SECRET',",
-        '  optional: true,',
-        '  schema: ActorSchema,',
-        '})',
-        'defineSecret({',
-        "  name: 'stripe',",
-        "  displayName: 'Stripe',",
-        "  secretId: 'STRIPE_KEY',",
-        '  schema: StripeSchema,',
-        '})',
-      ].join('\n')
-    )
-
-    const criticals: Array<{ code: ErrorCode; message: string }> = []
-    try {
-      const state = await inspect(makeLogger(criticals), [file], { rootDir })
-      const optional = state.secrets.definitions.find(
-        (d) => d.secretId === 'SCENARIO_ACTOR_SECRET'
-      )
-      const required = state.secrets.definitions.find(
-        (d) => d.secretId === 'STRIPE_KEY'
-      )
-      assert.equal(optional!.optional, true)
-      assert.equal(required!.optional, undefined)
-    } finally {
-      await rm(rootDir, { recursive: true, force: true })
-    }
-  })
-
-  test('carries optional from defineVariable into the definition', async () => {
-    const rootDir = await mkdtemp(`${fixtureRoot}-variable-optional-`)
-    const file = join(rootDir, 'variable.ts')
-
-    await writeFile(
-      file,
-      [
-        "import { defineVariable } from '@pikku/core'",
-        "import { z } from 'zod'",
-        'export const ConsoleUrlSchema = z.string()',
-        'export const CorsSchema = z.string()',
-        'defineVariable({',
-        "  name: 'consoleUrl',",
-        "  displayName: 'Console URL',",
-        "  variableId: 'CONSOLE_URL',",
-        '  optional: true,',
-        '  schema: ConsoleUrlSchema,',
-        '})',
-        'defineVariable({',
-        "  name: 'corsOrigins',",
-        "  displayName: 'Allowed Browser Origins',",
-        "  variableId: 'CORS_ORIGINS',",
-        '  schema: CorsSchema,',
-        '})',
-      ].join('\n')
-    )
-
-    const criticals: Array<{ code: ErrorCode; message: string }> = []
-    try {
-      const state = await inspect(makeLogger(criticals), [file], { rootDir })
-      const optional = state.variables.definitions.find(
-        (d) => d.variableId === 'CONSOLE_URL'
-      )
-      const required = state.variables.definitions.find(
-        (d) => d.variableId === 'CORS_ORIGINS'
-      )
-      assert.equal(optional!.optional, true)
-      assert.equal(required!.optional, undefined)
-    } finally {
-      await rm(rootDir, { recursive: true, force: true })
-    }
-  })
-})