@toa.io/extensions.configuration 0.20.0-dev.9 → 0.20.1-alpha.0

package/source/deployment.fixtures.js

@@ -1,38 +0,0 @@
-'use strict'
-
-const { generate } = require('randomstring')
-
-const { Locator } = require('@toa.io/core')
-const { random } = require('@toa.io/generic')
-
-const component = () => {
-  const namespace = generate()
-  const name = generate()
-
-  return { locator: new Locator(name, namespace) }
-}
-
-/** @type {toa.norm.context.dependencies.Instance[]} */
-const components = []
-const annotations = {}
-
-const annotate = (component) => {
-  const key = component.locator.id
-
-  annotations[key] = { [generate()]: generate() }
-}
-
-for (let i = 0; i < random(10) + 5; i++) components.push(component())
-for (let i = 0; i < components.length; i++) if (i % 2 === 0) annotate(components[i])
-
-/**
- * @param {string} id
- * @returns {toa.norm.context.dependencies.Instance}
- */
-const find = (id) => {
-  return components.find((component) => component.locator.id === id)
-}
-
-exports.components = components
-exports.annotations = annotations
-exports.find = find

package/source/deployment.js

@@ -1,20 +0,0 @@
-'use strict'
-
-const { merge } = require('@toa.io/generic')
-const get = require('./.deployment')
-
-/**
- * @param {toa.norm.context.dependencies.Instance[]} components
- * @param {object} annotations
- * @return {toa.deployment.dependency.Declaration}
- */
-const deployment = (components, annotations) => {
-  const variables = get.variables(components, annotations)
-  const secrets = get.secrets(components, annotations)
-
-  merge(variables, secrets)
-
-  return { variables }
-}
-
-exports.deployment = deployment

package/source/deployment.test.js

@@ -1,70 +0,0 @@
-'use strict'
-
-const clone = require('clone-deep')
-const { encode, sample } = require('@toa.io/generic')
-
-const fixtures = require('./deployment.fixtures')
-const { deployment } = require('../')
-const { generate } = require('randomstring')
-
-/** @type {toa.deployment.dependency.Declaration} */
-let declaration
-
-beforeAll(() => {
-  declaration = deployment(fixtures.components, fixtures.annotations)
-})
-
-it('should exist', () => {
-  expect(deployment).toBeDefined()
-})
-
-it('should declare variables', () => {
-  expect(declaration.variables).toBeDefined()
-})
-
-it('should map configurations', () => {
-  const keys = Object.keys(fixtures.annotations)
-
-  expect(keys.length).toBeGreaterThan(0)
-
-  for (const [id, annotations] of Object.entries(fixtures.annotations)) {
-    const component = fixtures.find(id)
-    const variables = declaration.variables[component.locator.label]
-    const encoded = encode(annotations)
-
-    expect(component).toBeDefined()
-    expect(variables).toBeDefined()
-    expect(variables).toBeInstanceOf(Array)
-    expect(variables.length).toStrictEqual(1)
-
-    const env = variables[0]
-
-    expect(env.name).toBeDefined()
-    expect(env.name).toStrictEqual('TOA_CONFIGURATION_' + component.locator.uppercase)
-    expect(env.value).toBeDefined()
-    expect(env.value).toStrictEqual(encoded)
-  }
-})
-
-it('should declare secrets', async () => {
-  const annotations = clone(fixtures.annotations)
-  const component = sample(fixtures.components)
-  const id = component.locator.id
-  const key = generate()
-  const name = generate().substring(0, 16).toUpperCase()
-  const value = '$' + name
-
-  if (annotations[id] === undefined) annotations[id] = {}
-
-  annotations[id][key] = value
-
-  declaration = deployment(fixtures.components, annotations)
-
-  const variables = declaration.variables[component.locator.label]
-
-  expect(variables).toBeDefined()
-
-  const secret = variables.find((variable) => variable.name === 'TOA_CONFIGURATION__' + name)
-
-  expect(secret).toBeDefined()
-})

package/source/factory.js

@@ -1,39 +0,0 @@
-'use strict'
-
-const { Schema } = require('@toa.io/schema')
-const { Aspect } = require('./aspect')
-const { Configuration } = require('./configuration')
-const { Provider } = require('./provider')
-
-/**
- * @implements {toa.extensions.configuration.Factory}
- */
-class Factory {
-  /**
-   * @param {toa.core.Locator} locator
-   * @param {toa.schema.JSON | Object} annotation
-   * @return {toa.extensions.configuration.Aspect}
-   */
-  aspect (locator, annotation) {
-    const schema = new Schema(annotation)
-    const provider = new Provider(locator, schema)
-    const configuration = new Configuration(provider)
-
-    return new Aspect(configuration)
-  }
-
-  provider (component) {
-    const locator = component.locator
-    const declaration = component.extensions?.[ID]
-
-    if (declaration === undefined) throw new Error(`Configuration extension not found in '${locator.id}'`)
-
-    const schema = new Schema(declaration)
-
-    return new Provider(locator, schema)
-  }
-}
-
-const ID = require('../package.json').name
-
-exports.Factory = Factory

package/source/factory.test.js

@@ -1,22 +0,0 @@
-'use strict'
-
-const { Factory } = require('../')
-
-it('should export', () => {
-  expect(Factory).toBeInstanceOf(Function)
-})
-
-/** @type {toa.extensions.configuration.Factory} */
-let factory
-
-beforeAll(async () => {
-  factory = new Factory()
-})
-
-it('should expose context', () => {
-  expect(factory.aspect).toBeInstanceOf(Function)
-})
-
-it('should expose provider', () => {
-  expect(factory.provider).toBeInstanceOf(Function)
-})

package/source/index.js

@@ -1,13 +0,0 @@
-'use strict'
-
-const { manifest } = require('./manifest')
-const { annotation } = require('./annotation')
-const { deployment } = require('./deployment')
-
-const { Factory } = require('./factory')
-
-exports.manifest = manifest
-exports.annotation = annotation
-exports.deployment = deployment
-
-exports.Factory = Factory

package/source/manifest.js

@@ -1,13 +0,0 @@
-'use strict'
-
-const { normalize, validate } = require('./.manifest')
-
-const manifest = (manifest) => {
-  const declaration = normalize(manifest)
-
-  validate(declaration)
-
-  return declaration
-}
-
-exports.manifest = manifest

package/source/manifest.test.js

@@ -1,123 +0,0 @@
-'use strict'
-
-const { generate } = require('randomstring')
-const { random } = require('@toa.io/generic')
-
-const { manifest } = require('../')
-
-it('should export', () => {
-  expect(manifest).toBeInstanceOf(Function)
-})
-
-describe('validation', () => {
-  it('should throw if not an object', () => {
-    const call = () => manifest(generate())
-    expect(call).toThrow(/must be object/)
-  })
-
-  it('should throw if not a valid schema', () => {
-    const object = { type: generate() }
-    const call = () => manifest(object)
-
-    expect(call).toThrow(/one of the allowed values/)
-  })
-
-  it('should throw if schema is not an object type', () => {
-    const schema = { type: 'number' }
-    const call = () => manifest(schema)
-
-    expect(call).toThrow(/equal to constant 'object'/)
-  })
-})
-
-describe('normalization', () => {
-  it('should expand concise', () => {
-    const concise = {
-      foo: generate(),
-      bar: {
-        baz: random()
-      }
-    }
-
-    const declaration = manifest(concise)
-
-    expect(declaration).toMatchObject({
-      type: 'object',
-      properties: {
-        foo: {
-          type: 'string',
-          default: concise.foo
-        },
-        bar: {
-          type: 'object',
-          properties: {
-            baz: {
-              type: 'number',
-              default: concise.bar.baz
-            }
-          }
-        }
-      }
-    })
-  })
-
-  it('should expand partially concise', () => {
-    const concise = {
-      foo: generate(),
-      bar: {
-        baz: random()
-      },
-      qux: {
-        type: 'string',
-        default: null
-      }
-    }
-
-    const declaration = manifest(concise)
-
-    expect(declaration).toMatchObject({
-      type: 'object',
-      properties: {
-        foo: {
-          type: 'string',
-          default: concise.foo
-        },
-        bar: {
-          type: 'object',
-          properties: {
-            baz: {
-              type: 'number',
-              default: concise.bar.baz
-            }
-          }
-        },
-        qux: {
-          type: 'string',
-          default: null
-        }
-      }
-    })
-  })
-
-  it('should expand arrays', () => {
-    const concise = { foo: [1, 2, 3] }
-
-    const declaration = manifest(concise)
-
-    expect(declaration).toMatchObject({
-      type: 'object',
-      properties: {
-        foo: {
-          type: 'array',
-          default: [1, 2, 3]
-        }
-      }
-    })
-  })
-
-  it('should throw on empty array', () => {
-    const concise = { foo: [] }
-
-    expect(() => manifest(concise)).toThrow(/array items type because it's empty/)
-  })
-})

package/source/provider.js

@@ -1,121 +0,0 @@
-'use strict'
-
-const clone = require('clone-deep')
-const { decode, encode, empty, overwrite } = require('@toa.io/generic')
-
-const { Connector } = require('@toa.io/core')
-
-const { secrets } = require('./secrets')
-const { env, form } = require('./.provider')
-
-/**
- * @implements {toa.extensions.configuration.Provider}
- */
-class Provider extends Connector {
-  /** @type {toa.schema.Schema} */
-  #schema
-
-  /** @type {Object} */
-  #form
-  /** @type {Object} */
-  #value
-
-  source
-  object
-  key
-
-  /**
-   * @param {toa.core.Locator} locator
-   * @param {toa.schema.Schema} schema
-   */
-  constructor (locator, schema) {
-    super()
-
-    this.source = this.#source.bind(this)
-
-    this.key = PREFIX + locator.uppercase
-    this.#schema = schema
-
-    // form is required to enable nested defaults
-    this.#form = form(schema.schema)
-  }
-
-  async open () {
-    this.#retrieve()
-  }
-
-  set (key, value) {
-    const object = this.object === undefined ? {} : clone(this.object)
-    const properties = key.split('.')
-    const property = properties.pop()
-
-    let cursor = object
-
-    for (const name of properties) {
-      if (cursor[name] === undefined) cursor[name] = {}
-
-      cursor = cursor[name]
-    }
-
-    if (value === undefined) delete cursor[property]
-    else cursor[property] = value
-
-    this.#set(object)
-  }
-
-  unset (key) {
-    this.set(key, undefined)
-  }
-
-  reset () {
-    this.object = undefined
-  }
-
-  export () {
-    return this.object === undefined ? undefined : encode(this.object)
-  }
-
-  #source () {
-    return this.#value
-  }
-
-  #retrieve () {
-    const string = process.env[this.key]
-    const object = string === undefined ? {} : decode(string)
-
-    this.#set(object)
-  }
-
-  #set (object) {
-    object = this.#reveal(object)
-    object = env(object)
-
-    this.#merge(object)
-
-    this.object = empty(object) ? undefined : object
-  }
-
-  #merge (object) {
-    object = clone(object)
-
-    const form = clone(this.#form)
-    const value = overwrite(form, object)
-
-    this.#schema.validate(value)
-    this.#value = value
-  }
-
-  #reveal (object) {
-    return secrets(object, (variable) => {
-      if (!(variable in process.env)) throw new Error(`Configuration secret value ${variable} is not set`)
-
-      const base64 = process.env[variable]
-
-      return decode(base64)
-    })
-  }
-}
-
-const PREFIX = 'TOA_CONFIGURATION_'
-
-exports.Provider = Provider

package/source/provider.test.js

@@ -1,130 +0,0 @@
-'use strict'
-
-/* eslint-disable no-template-curly-in-string */
-
-const { generate } = require('randomstring')
-const { encode } = require('@toa.io/generic')
-
-const { Provider } = require('./provider')
-
-it('should be', async () => {
-  expect(Provider).toBeInstanceOf(Function)
-})
-
-const locator = /** @type {toa.core.Locator} */ { uppercase: generate().toUpperCase() }
-const schema = /** @type {toa.schema.Schema} */ { validate: () => undefined }
-
-/** @type {Provider} */
-let provider
-
-beforeEach(() => {
-  cleanEnv()
-  provider = new Provider(locator, schema)
-})
-
-it('should replace secret values', async () => {
-  const configuration = { foo: '$FOO_SECRET' }
-  const secrets = { FOO_SECRET: generate() }
-
-  setEnv(configuration, secrets)
-
-  await provider.open()
-  const value = provider.source()
-
-  expect(value).toStrictEqual({ foo: secrets.FOO_SECRET })
-})
-
-it('should throw if secret value is not set', async () => {
-  const configuration = { foo: '$FOO_SECRET' }
-
-  setEnv(configuration)
-
-  await expect(provider.open()).rejects.toThrow('FOO_SECRET is not set')
-})
-
-it('should replace nested secrets', async () => {
-  const configuration = { foo: { bar: '$BAR' } }
-  const secrets = { BAR: generate() }
-
-  setEnv(configuration, secrets)
-
-  await provider.open()
-  const value = provider.source()
-
-  expect(value).toStrictEqual({ foo: { bar: secrets.BAR } })
-})
-
-it('should replace placeholders', async () => {
-  const name = 'FOO_VALUE'
-  const configuration = { foo: { bar: 'foo_${' + name + '}' } }
-  const value = generate()
-
-  setEnv(configuration)
-  setVal(name, value)
-
-  await provider.open()
-  const source = provider.source()
-
-  expect(source).toStrictEqual({ foo: { bar: 'foo_' + value } })
-})
-
-it('should replace multiple placeholders', async () => {
-  const configuration = { foo: '${FOO} ${BAR}' }
-
-  setEnv(configuration)
-  setVal('FOO', 'hello')
-  setVal('BAR', 'world')
-
-  await provider.open()
-  const source = provider.source()
-
-  expect(source).toStrictEqual({ foo: 'hello world' })
-})
-
-it('should not replace if variable not set', async () => {
-  const configuration = { foo: '${FOO}' }
-
-  setEnv(configuration)
-
-  await provider.open()
-  const value = provider.source()
-
-  expect(value).toStrictEqual(configuration)
-})
-
-const usedVariables = []
-
-/**
- * @param {object} configuration
- * @param {Record<string, string>} [secrets]
- */
-function setEnv (configuration, secrets) {
-  const variable = PREFIX + locator.uppercase
-  const encoded = encode(configuration)
-
-  setVal(variable, encoded)
-
-  if (secrets !== undefined) {
-    for (const [key, value] of Object.entries(secrets)) {
-      const variable = PREFIX + '_' + key
-
-      process.env[variable] = encode(value)
-      usedVariables.push(variable)
-    }
-  }
-}
-
-function setVal (variable, value) {
-  process.env[variable] = value
-  usedVariables.push(variable)
-}
-
-function cleanEnv () {
-  for (const variable of usedVariables) {
-    delete process.env[variable]
-  }
-
-  usedVariables.length = 0
-}
-
-const PREFIX = 'TOA_CONFIGURATION_'

package/source/secrets.js

@@ -1,28 +0,0 @@
-'use strict'
-
-const { map } = require('@toa.io/generic')
-
-/**
- * @param {object} configuration
- * @param {(variable: string, name?: string) => void} callback
- * @returns {object}
- */
-function secrets (configuration, callback) {
-  return map(configuration, (value) => {
-    if (typeof value !== 'string') return
-
-    const match = value.match(SECRET_RX)
-
-    if (match === null) return
-
-    const name = match.groups.variable
-    const variable = PREFIX + name
-
-    return callback(variable, name)
-  })
-}
-
-const PREFIX = 'TOA_CONFIGURATION__'
-const SECRET_RX = /^\$(?<variable>[A-Z0-9_]{1,32})$/
-
-exports.secrets = secrets

package/source/secrets.test.js

@@ -1,47 +0,0 @@
-'use strict'
-
-const { secrets } = require('./secrets')
-
-it('should be', async () => {
-  expect(secrets).toBeInstanceOf(Function)
-})
-
-it('should find secrets', async () => {
-  const configuration = {
-    foo: {
-      bar: '$BAR_VALUE'
-    },
-    baz: '$BAZ_VALUE'
-  }
-
-  const variables = new Set()
-  const names = new Set()
-
-  secrets(configuration, (variable, name) => {
-    variables.add(variable)
-    names.add(name)
-  })
-
-  expect(variables.has('TOA_CONFIGURATION__BAR_VALUE')).toStrictEqual(true)
-  expect(variables.has('TOA_CONFIGURATION__BAZ_VALUE')).toStrictEqual(true)
-
-  expect(names.has('BAR_VALUE')).toStrictEqual(true)
-  expect(names.has('BAZ_VALUE')).toStrictEqual(true)
-})
-
-it('should replace values', async () => {
-  const configuration = { foo: '$FOO' }
-
-  const output = secrets(configuration, (variable) => 'hello')
-
-  expect(output).toStrictEqual({ foo: 'hello' })
-})
-
-it('should allow numbers in secret names', async () => {
-  const configuration = { foo: '$HOST_0' }
-  const found = new Set()
-
-  secrets(configuration, (variable) => found.add(variable))
-
-  expect(found.has('TOA_CONFIGURATION__HOST_0')).toStrictEqual(true)
-})

package/types/aspect.ts

@@ -1,11 +0,0 @@
-// noinspection ES6UnusedImports
-
-import * as core from '@toa.io/core/types/extensions'
-
-declare namespace toa.extensions.configuration {
-
-  interface Aspect extends core.Aspect {
-    invoke(path?: string[]): any
-  }
-
-}

package/types/factory.d.ts

@@ -1,12 +0,0 @@
-import { Component } from '@toa.io/norm/types'
-
-import * as _extensions from '@toa.io/core/types/extensions'
-import * as _provider from './provider'
-
-declare namespace toa.extensions.configuration {
-
-  interface Factory extends _extensions.Factory {
-    provider(component: Component): _provider.Provider
-  }
-
-}