@toa.io/extensions.configuration 1.1.0-dev.11 → 1.1.0-dev.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/extensions.configuration",
-  "version": "1.1.0-dev.11",
+  "version": "1.1.0-dev.13",
   "description": "Toa Configuration",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -16,11 +16,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@toa.io/core": "1.1.0-dev.11",
-    "@toa.io/generic": "0.11.0-dev.11",
-    "@toa.io/schema": "0.7.6-dev.11",
-    "@toa.io/yaml": "0.7.6-dev.11",
+    "@toa.io/core": "1.1.0-dev.13",
+    "@toa.io/generic": "0.11.0-dev.13",
+    "@toa.io/schema": "0.7.6-dev.13",
+    "@toa.io/yaml": "0.7.6-dev.13",
     "clone-deep": "4.0.1"
   },
-  "gitHead": "43f790e208d5eea38a8d3f09136dc1221d26ccc3"
+  "gitHead": "8c824ed7448e01f0ddf44500a4a6e692d35eaa1b"
 }

package/readme.md

@@ -163,11 +163,6 @@ configuration:
     bar@staging: 2
 ```
 
-### Local environment
-
-Configuration Objects for local environment may be created
-by [`toa configure`](../../runtime/cli/readme.md#configure) command.
-
 ## Configuration Secrets
 
 Context Configuration values which are uppercase strings prefixed with `$` considered as Secrets.
@@ -196,13 +191,13 @@ Deployed kubernetes secret's name is predefined as `configuration`.
 $ toa conceal configuration STRIPE_API_KEY xxxxxxxx
 ```
 
-## Operation Context
-
-Configuration Value is available as a well-known operation context extension `configuration`.
+## Aspect
 
-### Usage: node
+Configuration Value is available as a well-known operation Aspect `configuration`.
 
 ```javascript
+// Node.js bridge
+
 function transition (input, entity, context) {
   const foo = context.configiuration.foo
 
@@ -216,21 +211,46 @@ function transition (input, entity, context) {
 > from [hot updates](#).
 >
 > ```javascript
-> // THIS IS WEIRD, BAD AND NOT RECOMMENDED
+> // NOT RECOMMENDED
 > let foo
 > 
 > function transition (input, entity, context) {
+>   // NOT RECOMMENDED
 >   if (foo === undefined) foo = context.configuration.foo
 > 
 >   // ...
 > }
 > ```
-> See [Genuine operations](#).
+> See [Genuine operations](/documentation/design.md#genuine-operations).
+
+## Development Configuration
+
+Configuration can be exported by [`toa env`](/runtime/cli/readme.md#env).
+
+### Local Environment Placeholders
+
+Context Configuration values may contain placeholders that reference environment variables.
+Placeholders are replaced with values if the corresponding environment variables are set.
+
+> Placeholders can only be used with local environment (exported by `toa env`), as these values are not
+> deployed.
+
+```yaml
+# context.toa.yaml
+configuration:
+  dummies.dummy:
+    url@local: https://stage${STAGE}.intranet/
+```
+
+```dotenv
+# .env
+STAGE=82
+```
 
 ## Appendix
 
 - [Discussion](./docs/discussion.md)
 - [Configuration consistency](./docs/consistency.md)
 
-[^1]: Cannot be changed without a deployment. New values are considered to be a subject of
+[^1]: Cannot be changed without a deployment as new values are considered to be a subject of
 testing. [#146](https://github.com/toa-io/toa/issues/146)

package/source/.provider/env.js

@@ -0,0 +1,19 @@
+'use strict'
+
+const { map } = require('@toa.io/generic')
+
+function env (object) {
+  return map(object,
+    /**
+     * @type {toa.generic.map.transform<string>}
+     */
+    (value) => {
+      if (typeof value !== 'string') return
+
+      return value.replaceAll(RX, (match, variable) => process.env[variable] ?? match)
+    })
+}
+
+const RX = /\${(?<variable>[A-Z0-9_]{1,32})}/g
+
+exports.env = env

package/source/.provider/index.js

@@ -0,0 +1,7 @@
+'use strict'
+
+const { form } = require('./form')
+const { env } = require('./env')
+
+exports.form = form
+exports.env = env

package/source/provider.js

@@ -6,7 +6,7 @@ const { decode, encode, empty, overwrite } = require('@toa.io/generic')
 const { Connector } = require('@toa.io/core')
 
 const { secrets } = require('./secrets')
-const { form } = require('./.provider/form')
+const { env, form } = require('./.provider')
 
 /**
  * @implements {toa.extensions.configuration.Provider}
@@ -88,6 +88,8 @@ class Provider extends Connector {
 
   #set (object) {
     object = this.#reveal(object)
+    object = env(object)
+
     this.#merge(object)
 
     this.object = empty(object) ? undefined : object

package/source/provider.test.js

@@ -1,5 +1,7 @@
 'use strict'
 
+/* eslint-disable no-template-curly-in-string */
+
 const { generate } = require('randomstring')
 const { encode } = require('@toa.io/generic')
 
@@ -52,6 +54,44 @@ it('should replace nested secrets', async () => {
   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 = []
 
 /**
@@ -60,8 +100,9 @@ const usedVariables = []
  */
 function setEnv (configuration, secrets) {
   const variable = PREFIX + locator.uppercase
+  const encoded = encode(configuration)
 
-  setVal(variable, configuration)
+  setVal(variable, encoded)
 
   if (secrets !== undefined) {
     for (const [key, value] of Object.entries(secrets)) {
@@ -74,7 +115,7 @@ function setEnv (configuration, secrets) {
 }
 
 function setVal (variable, value) {
-  process.env[variable] = encode(value)
+  process.env[variable] = value
   usedVariables.push(variable)
 }