@pikku/core 0.12.106 → 0.12.111

package/src/schema.test.ts

@@ -1,430 +0,0 @@
-import { test, describe, before, beforeEach } from 'node:test'
-import * as assert from 'assert'
-import {
-  addSchema,
-  getSchema,
-  applyDefaultsFromSchema,
-  coerceTopLevelDataFromSchema,
-  validateSchema,
-  compileAllSchemas,
-} from './schema.js'
-import { resetPikkuState } from './pikku-state.js'
-
-describe('Schema', () => {
-  describe('addSchema and getSchema', () => {
-    beforeEach(() => {
-      resetPikkuState()
-    })
-
-    test('should add and retrieve a schema', () => {
-      const schema = { properties: { name: { type: 'string' } } }
-      addSchema('testAdd', schema)
-      const result = getSchema('testAdd')
-      assert.deepStrictEqual(result, schema)
-    })
-
-    test('should return undefined for non-existent schema', () => {
-      const result = getSchema('nonExistent')
-      assert.strictEqual(result, undefined)
-    })
-
-    test('should add schema for specific package', () => {
-      const schema = { properties: { id: { type: 'number' } } }
-      addSchema('pkgSchema', schema, '@addon/pkg')
-      const result = getSchema('pkgSchema', '@addon/pkg')
-      assert.deepStrictEqual(result, schema)
-    })
-
-    test('should not find package schema in main', () => {
-      addSchema('pkgOnly', { properties: {} }, '@addon/pkg')
-      const result = getSchema('pkgOnly', null)
-      assert.strictEqual(result, undefined)
-    })
-
-    test('should unwrap default export', () => {
-      const schema = { default: { properties: { x: { type: 'string' } } } }
-      addSchema('withDefault', schema)
-      const result = getSchema('withDefault')
-      assert.deepStrictEqual(result, { properties: { x: { type: 'string' } } })
-    })
-  })
-
-  describe('coerceTopLevelDataFromSchema', () => {
-    before(() => {
-      addSchema('testSchema', {
-        properties: {
-          tags: { type: 'array' },
-          count: { type: 'number' },
-          name: { type: 'string' },
-        },
-      })
-
-      addSchema('booleanSchema', {
-        properties: {
-          isActive: true,
-          tags: { type: 'array' },
-        },
-      })
-
-      addSchema('dateSchema', {
-        properties: {
-          createdAt: { type: 'string', format: 'date-time' },
-        },
-      })
-    })
-
-    test('should split a string into an array for properties of type array', () => {
-      const data = { tags: 'a,b,c' }
-      coerceTopLevelDataFromSchema('testSchema', data)
-      assert.deepStrictEqual(data.tags, ['a', 'b', 'c'])
-    })
-
-    test('should not modify properties of type array if they are already arrays', () => {
-      const data = { tags: ['a', 'b', 'c'] }
-      coerceTopLevelDataFromSchema('testSchema', data)
-      assert.deepStrictEqual(data.tags, ['a', 'b', 'c'])
-    })
-
-    test('should not modify properties that are not type array', () => {
-      const data = { count: 5, name: 'example' }
-      coerceTopLevelDataFromSchema('testSchema', data)
-      assert.strictEqual(data.count, 5)
-      assert.strictEqual(data.name, 'example')
-    })
-
-    test('should handle cases where the data object does not have a key present in the schema', () => {
-      const data = { unknownKey: 'shouldRemain' }
-      coerceTopLevelDataFromSchema('testSchema', data)
-      assert.strictEqual(data.unknownKey, 'shouldRemain')
-    })
-
-    test('should handle cases where schema properties contain boolean values', () => {
-      const data = { tags: 'a,b,c', isActive: 'true' }
-      coerceTopLevelDataFromSchema('booleanSchema', data)
-      assert.deepStrictEqual(data.tags, ['a', 'b', 'c'])
-      assert.strictEqual(data.isActive, 'true')
-    })
-
-    test('should coerce date-time strings to Date objects', () => {
-      const data = { createdAt: '2024-01-01T00:00:00Z' } as any
-      coerceTopLevelDataFromSchema('dateSchema', data)
-      assert.ok(data.createdAt instanceof Date)
-    })
-  })
-
-  describe('applyDefaultsFromSchema', () => {
-    before(() => {
-      addSchema('defaultsSchema', {
-        properties: {
-          page: { type: 'number', default: 1 },
-          limit: { type: 'number', default: 50 },
-          addons: { type: 'array', default: [] },
-          mode: { type: 'string', default: 'manual' },
-          enabled: { type: 'boolean', default: true },
-          name: { type: 'string' },
-        },
-      })
-
-      addSchema('noDefaultsSchema', {
-        properties: { name: { type: 'string' } },
-      })
-
-      addSchema('booleanPropSchema', {
-        properties: { isActive: true, page: { type: 'number', default: 1 } },
-      })
-    })
-
-    test('should fill in absent properties from their default', () => {
-      const data = applyDefaultsFromSchema('defaultsSchema', {})
-      assert.strictEqual(data.page, 1)
-      assert.strictEqual(data.limit, 50)
-      assert.strictEqual(data.mode, 'manual')
-      assert.strictEqual(data.enabled, true)
-    })
-
-    test('should not overwrite a supplied value', () => {
-      const data = applyDefaultsFromSchema('defaultsSchema', {
-        page: 7,
-        limit: 200,
-      })
-      assert.strictEqual(data.page, 7)
-      assert.strictEqual(data.limit, 200)
-    })
-
-    // `false` and `0` are the values a truthiness check silently replaces, and
-    // the reason this tests presence rather than falsiness.
-    test('should not overwrite a supplied falsy value', () => {
-      const data = applyDefaultsFromSchema('defaultsSchema', {
-        page: 0,
-        enabled: false,
-      })
-      assert.strictEqual(data.page, 0)
-      assert.strictEqual(data.enabled, false)
-    })
-
-    test('should fill defaults into nullish data', () => {
-      assert.strictEqual(
-        applyDefaultsFromSchema('defaultsSchema', undefined).page,
-        1
-      )
-      assert.strictEqual(
-        applyDefaultsFromSchema('defaultsSchema', null).limit,
-        50
-      )
-    })
-
-    test('should leave properties without a default absent', () => {
-      const data = applyDefaultsFromSchema('defaultsSchema', {})
-      assert.ok(!('name' in data))
-    })
-
-    // Two requests sharing one array default would let the first request's
-    // pushes show up in the second.
-    test('should clone object and array defaults per call', () => {
-      const first = applyDefaultsFromSchema('defaultsSchema', {})
-      const second = applyDefaultsFromSchema('defaultsSchema', {})
-      first.addons.push('leaked')
-      assert.deepStrictEqual(second.addons, [])
-    })
-
-    test('should return the same data when the schema has no defaults', () => {
-      const data = { name: 'x' }
-      assert.strictEqual(
-        applyDefaultsFromSchema('noDefaultsSchema', data),
-        data
-      )
-    })
-
-    test('should return data untouched for an unknown schema', () => {
-      const data = { name: 'x' }
-      assert.strictEqual(applyDefaultsFromSchema('nonExistent', data), data)
-    })
-
-    test('should leave a primitive body for the validator to reject', () => {
-      assert.strictEqual(
-        applyDefaultsFromSchema('defaultsSchema', 'nope'),
-        'nope'
-      )
-    })
-
-    test('should skip boolean schema properties', () => {
-      const data = applyDefaultsFromSchema('booleanPropSchema', {})
-      assert.strictEqual(data.page, 1)
-      assert.ok(!('isActive' in data))
-    })
-  })
-
-  describe('validateSchema', () => {
-    beforeEach(() => {
-      resetPikkuState()
-    })
-
-    test('should pass when no schema service provided', async () => {
-      const logger = {
-        info: () => {},
-        warn: () => {},
-        error: () => {},
-        debug: () => {},
-      } as any
-      await validateSchema(logger, undefined, 'some-schema', { data: 1 })
-    })
-
-    test('should warn when no schema name but data is passed', async () => {
-      let warningMsg = ''
-      const logger = {
-        info: () => {},
-        warn: (msg: string) => {
-          warningMsg = msg
-        },
-        error: () => {},
-        debug: () => {},
-      } as any
-      const schemaService = {
-        compileSchema: async () => {},
-        validateSchema: async () => {},
-        getSchemaNames: () => new Set<string>(),
-      }
-      await assert.rejects(
-        () => validateSchema(logger, schemaService, null, { key: 'value' }),
-        (err: any) => err.message === 'No data expected'
-      )
-    })
-
-    test('should return early when no schema name and empty data', async () => {
-      const logger = {
-        info: () => {},
-        warn: () => {},
-        error: () => {},
-        debug: () => {},
-      } as any
-      const schemaService = {
-        compileSchema: async () => {},
-        validateSchema: async () => {},
-        getSchemaNames: () => new Set<string>(),
-      }
-      await validateSchema(logger, schemaService, null, {})
-    })
-
-    test('strips undefined-valued properties before validating', async () => {
-      addSchema('undefinedProps', {
-        properties: { name: { type: 'string' }, count: { type: 'number' } },
-      })
-      const logger = {
-        info: () => {},
-        warn: () => {},
-        error: () => {},
-        debug: () => {},
-      } as any
-      let seen: any
-      const schemaService = {
-        compileSchema: async () => {},
-        validateSchema: async (_name: string, data: any) => {
-          seen = data
-        },
-        getSchemaNames: () => new Set<string>(),
-      }
-      await validateSchema(logger, schemaService, 'undefinedProps', {
-        name: 'ada',
-        count: undefined,
-      })
-      assert.deepStrictEqual(seen, { name: 'ada' })
-      assert.ok(!('count' in seen))
-    })
-
-    test('strips undefined nested in objects and arrays', async () => {
-      addSchema('nestedUndefined', { properties: {} })
-      const logger = {
-        info: () => {},
-        warn: () => {},
-        error: () => {},
-        debug: () => {},
-      } as any
-      let seen: any
-      const schemaService = {
-        compileSchema: async () => {},
-        validateSchema: async (_name: string, data: any) => {
-          seen = data
-        },
-        getSchemaNames: () => new Set<string>(),
-      }
-      await validateSchema(logger, schemaService, 'nestedUndefined', {
-        nested: { keep: 1, drop: undefined },
-        list: [{ keep: 2, drop: undefined }],
-      })
-      assert.deepStrictEqual(seen, {
-        nested: { keep: 1 },
-        list: [{ keep: 2 }],
-      })
-    })
-
-    test('leaves Date instances intact while stripping', async () => {
-      addSchema('withDate', { properties: {} })
-      const logger = {
-        info: () => {},
-        warn: () => {},
-        error: () => {},
-        debug: () => {},
-      } as any
-      const when = new Date('2020-01-01T00:00:00.000Z')
-      let seen: any
-      const schemaService = {
-        compileSchema: async () => {},
-        validateSchema: async (_name: string, data: any) => {
-          seen = data
-        },
-        getSchemaNames: () => new Set<string>(),
-      }
-      await validateSchema(logger, schemaService, 'withDate', {
-        when,
-        drop: undefined,
-      })
-      assert.ok(seen.when instanceof Date)
-      assert.equal(seen.when.getTime(), when.getTime())
-      assert.ok(!('drop' in seen))
-    })
-
-    test('should throw MissingSchemaError when schema not found', async () => {
-      const logger = {
-        info: () => {},
-        warn: () => {},
-        error: () => {},
-        debug: () => {},
-      } as any
-      const schemaService = {
-        compileSchema: async () => {},
-        validateSchema: async () => {},
-        getSchemaNames: () => new Set<string>(),
-      }
-      await assert.rejects(
-        () => validateSchema(logger, schemaService, 'nonExistent', { data: 1 }),
-        (err: any) => err.message.includes('not found')
-      )
-    })
-
-    test('should compile and validate schema when found', async () => {
-      addSchema('validSchema', { properties: { name: { type: 'string' } } })
-      const logger = {
-        info: () => {},
-        warn: () => {},
-        error: () => {},
-        debug: () => {},
-      } as any
-      let compiled = false
-      let validated = false
-      const schemaService = {
-        compileSchema: async () => {
-          compiled = true
-        },
-        validateSchema: async () => {
-          validated = true
-        },
-        getSchemaNames: () => new Set<string>(),
-      }
-      await validateSchema(logger, schemaService, 'validSchema', {
-        name: 'test',
-      })
-      assert.strictEqual(compiled, true)
-      assert.strictEqual(validated, true)
-    })
-  })
-
-  describe('compileAllSchemas', () => {
-    beforeEach(() => {
-      resetPikkuState()
-    })
-
-    test('should throw when no schema service available', () => {
-      const logger = {
-        info: () => {},
-        warn: () => {},
-        error: () => {},
-        debug: () => {},
-      } as any
-      assert.throws(() => compileAllSchemas(logger), {
-        message: 'SchemaService needs to be defined to load schemas',
-      })
-    })
-
-    test('should compile all schemas across packages', () => {
-      addSchema('schema1', { properties: { a: { type: 'string' } } })
-      addSchema('schema2', { properties: { b: { type: 'number' } } })
-
-      const compiled: string[] = []
-      const logger = {
-        info: () => {},
-        warn: () => {},
-        error: () => {},
-        debug: () => {},
-      } as any
-      const schemaService = {
-        compileSchema: (name: string, _schema: any) => {
-          compiled.push(name)
-        },
-        getSchemaNames: () => new Set(compiled),
-      }
-      compileAllSchemas(logger, schemaService as any)
-      assert.ok(compiled.includes('schema1'))
-      assert.ok(compiled.includes('schema2'))
-    })
-  })
-})

package/src/schema.ts

@@ -1,204 +0,0 @@
-import type { Logger } from './services/logger.js'
-import type { SchemaService } from './services/schema-service.js'
-import {
-  MissingSchemaError,
-  UnprocessableContentError,
-} from './errors/errors.js'
-import { pikkuState, getAllPackageStates } from './pikku-state.js'
-
-const schemaKey = (name: string, packageName: string | null): string =>
-  packageName ? `${packageName}:${name}` : name
-
-export const addSchema = (
-  name: string,
-  value: any,
-  packageName: string | null = null
-) => {
-  const schema = value?.default ?? value
-  pikkuState(packageName, 'misc', 'schemas').set(name, schema)
-}
-
-export const getSchema = (
-  name: string,
-  packageName: string | null = null
-): Record<string, unknown> | undefined => {
-  return pikkuState(packageName, 'misc', 'schemas').get(name)
-}
-
-export const compileAllSchemas = (
-  logger: Logger,
-  schemaService?: SchemaService
-) => {
-  if (!schemaService) {
-    schemaService = pikkuState(null, 'package', 'singletonServices')?.schema
-  }
-  if (!schemaService) {
-    throw new Error('SchemaService needs to be defined to load schemas')
-  }
-  for (const [pkgName, packageState] of getAllPackageStates()) {
-    const resolvedPkgName = pkgName === '__main__' ? null : pkgName
-    for (const [name, schema] of packageState.misc.schemas) {
-      schemaService.compileSchema(schemaKey(name, resolvedPkgName), schema)
-    }
-  }
-  validateAllSchemasLoaded(logger, schemaService)
-}
-
-const validateAllSchemasLoaded = (
-  logger: Logger,
-  schemaService: SchemaService
-) => {
-  const routesMeta = pikkuState(null, 'http', 'meta')
-  const validators = schemaService.getSchemaNames()
-
-  const missingSchemas: string[] = []
-
-  for (const routePaths of Object.values(routesMeta)) {
-    for (const meta of Object.values(routePaths)) {
-      const inputs = pikkuState(null, 'function', 'meta')[meta.pikkuFuncId]
-        ?.inputs
-      const input = inputs?.[0]
-      if (!input || validators.has(input)) {
-        continue
-      }
-      missingSchemas.push(input)
-    }
-  }
-
-  if (missingSchemas.length > 0) {
-    logger.error(
-      `Error: Failed to load schemas:\n.${missingSchemas.join('\n')}`
-    )
-    logger.error('\tHave you run the schema generation?')
-    logger.error('\tnpx @pikku/cli schemas')
-  } else {
-    logger.info('All schemas loaded')
-  }
-}
-
-/**
- * Fills in absent top-level properties from their schema `default`. Applied
- * unconditionally: a default belongs to the schema, not to the transport the
- * call arrived on, and runs before coercion so a defaulted and a supplied
- * value are treated identically from here on. Values are cloned so an object
- * or array default is never shared as one mutable instance across requests.
- */
-export const applyDefaultsFromSchema = (
-  schemaName: string,
-  data: any,
-  packageName: string | null = null
-) => {
-  const schema = pikkuState(packageName, 'misc', 'schemas').get(schemaName)
-  if (!schema?.properties) return data
-
-  // A primitive body cannot carry named properties; leave it for the validator
-  // to reject rather than reshaping it into something that would pass.
-  if (data != null && typeof data !== 'object') return data
-
-  let result = data
-  for (const key in schema.properties) {
-    const property = schema.properties[key]
-    if (typeof property === 'boolean' || !('default' in property)) {
-      continue
-    }
-    // Allocated only once a default is actually found, so a schema without any
-    // leaves the caller's data (and its absence) exactly as it was.
-    result ??= {}
-    if (result[key] === undefined) {
-      result[key] = structuredClone(property.default)
-    }
-  }
-  return result
-}
-
-export const coerceTopLevelDataFromSchema = (
-  schemaName: string,
-  data: any,
-  packageName: string | null = null
-) => {
-  const schema = pikkuState(packageName, 'misc', 'schemas').get(schemaName)
-  if (!schema?.properties) return
-  for (const key in schema.properties) {
-    const property = schema.properties[key]
-    if (typeof property === 'boolean') {
-      continue
-    }
-    const type = property.type
-    if (typeof type === 'boolean') {
-      continue
-    }
-    if (type === 'array' && typeof data[key] === 'string') {
-      data[key] = data[key].split(',')
-    } else if (type === 'string' && property.format === 'date-time') {
-      data[key] = new Date(data[key])
-    }
-  }
-}
-
-/**
- * Drops object properties whose value is literally `undefined`.
- *
- * JSON Schema has no way to describe such a property, and the validator refuses
- * the whole instance rather than reporting it — `{ a: undefined }` throws
- * "Instances of \"undefined\" type are not supported" instead of validating.
- *
- * That matters because whether a payload can contain one depends on how the
- * call travelled. Over HTTP `JSON.stringify` drops these keys before the
- * request is built, so they never arrive. Dispatched in-process — an inline
- * workflow step calling an RPC — the object is handed over as-is, and
- * `{ retries: data.maybeRetries }` with the field omitted by the caller is
- * enough to kill the step. Normalising here makes the two paths agree, and an
- * explicitly-undefined *required* field now reports as the missing property it
- * is rather than as an internal error.
- *
- * Deliberately not a JSON round-trip: `coerceTopLevelDataFromSchema` puts real
- * `Date` instances on the data first, and stringifying would flatten them back
- * to strings the validator has never been given.
- */
-const stripUndefinedValues = <T>(value: T): T => {
-  if (Array.isArray(value)) return value.map(stripUndefinedValues) as T
-  if (value === null || typeof value !== 'object') return value
-  // Only plain objects: a Date, Map or class instance is data, not a bag of
-  // properties to be rewritten.
-  const prototype = Object.getPrototypeOf(value)
-  if (prototype !== Object.prototype && prototype !== null) return value
-
-  return Object.fromEntries(
-    Object.entries(value)
-      .filter(([, entry]) => entry !== undefined)
-      .map(([key, entry]) => [key, stripUndefinedValues(entry)])
-  ) as T
-}
-
-export const validateSchema = async (
-  logger: Logger,
-  schemaService: SchemaService | undefined,
-  schemaName: string | undefined | null,
-  data: any,
-  packageName: string | null = null
-) => {
-  if (schemaService) {
-    if (!schemaName) {
-      if (data && (data.length > 0 || Object.keys(data).length > 0)) {
-        logger.warn('No schema provided, but data was passed')
-        throw new UnprocessableContentError('No data expected')
-      } else {
-        return
-      }
-    }
-    const key = schemaKey(schemaName, packageName)
-    const schemas = pikkuState(packageName, 'misc', 'schemas')
-    const schema = schemas.get(schemaName)
-    if (schema === undefined) {
-      const availableSchemas = Array.from(schemas.keys())
-      logger.error(
-        `Schema '${schemaName}' not found for package '${packageName ?? 'main'}'. Available schemas: ${availableSchemas.join(', ') || '(none)'}`
-      )
-      throw new MissingSchemaError(
-        `Schema '${schemaName}' not found. Ensure schema generation has been run.`
-      )
-    }
-    await schemaService.compileSchema(key, schema)
-    await schemaService.validateSchema(key, stripUndefinedValues(data ?? {}))
-  }
-}