@toa.io/extensions.origins 0.8.0-dev.1 → 0.8.0-dev.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/extensions.origins",
-  "version": "0.8.0-dev.1",
+  "version": "0.8.0-dev.3",
   "description": "Toa Origins",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -19,15 +19,15 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@toa.io/core": "0.8.0-dev.1",
-    "@toa.io/generic": "0.8.0-dev.1",
-    "@toa.io/schemas": "0.8.0-dev.1",
-    "@toa.io/yaml": "0.7.2-dev.2",
+    "@toa.io/core": "0.8.0-dev.3",
+    "@toa.io/generic": "0.8.0-dev.3",
+    "@toa.io/schemas": "0.8.0-dev.3",
+    "@toa.io/yaml": "0.7.2-dev.4",
     "comq": "0.6.0",
     "node-fetch": "2.6.7"
   },
   "devDependencies": {
     "@types/node-fetch": "2.6.2"
   },
-  "gitHead": "9bb2f372c556440ee3e2a42e10eb415220ba1cb0"
+  "gitHead": "d72b4c2362e928dba56f4743cc956aa5486f82a4"
 }

package/readme.md

@@ -1,6 +1,6 @@
 # Toa Origins
 
-`origins` extension enables external communications over supported protocols (HTTP and AMQP).
+Enables external communications over supported protocols (HTTP and AMQP).
 
 ## TL;DR
 
@@ -36,7 +36,22 @@ origins:
 
 ## Manifest
 
-`origins` manifest is an object conforming declaring origin names as keys an origin URLs as values.
+`origins` manifest is an object with origin names as keys an origin URLs as values.
+Component's `origins` manifest can be overridden by the Context `origins` annotation.
+
+### Sharded Connections
+
+Origin value may contain [shards](/libraries/generic/readme.md#shards) placeholders.
+
+### Environment Variables
+
+Origin value may contain environment variable placeholders.
+
+```yaml
+# manifest.toa.yaml
+origins:
+  foo@dev: stage${STAGE_NUMBER}.stages.com
+```
 
 ## HTTP Aspect
 
@@ -85,7 +100,7 @@ async function transition (input, object, context) {
 }
 ```
 
-#### `null` origins
+#### `null` manifest
 
 To enable the extension for a component that uses arbitrary URLs without any specific origins to
 declare, the Origins manifest should be set to `null`.

package/source/manifest.js

@@ -1,5 +1,6 @@
 'use strict'
 
+const { remap, echo, shards } = require('@toa.io/generic')
 const schemas = require('./schemas')
 const protocols = require('./protocols')
 
@@ -10,16 +11,28 @@ const protocols = require('./protocols')
 function manifest (manifest) {
   if (manifest === null) return {}
 
-  schemas.manifest.validate(manifest)
+  manifest = remap(manifest, echo)
+  validate(manifest)
 
-  for (const uri of Object.values(manifest)) {
-    const protocol = new URL(uri).protocol
-    const supported = protocols.find((provider) => provider.protocols.includes(protocol))
+  for (const url of Object.values(manifest)) {
+    const supported = protocols.find((provider) => supports(provider, url))
 
-    if (supported === undefined) throw new Error(`'${protocol}' protocol is not supported`)
+    if (supported === undefined) throw new Error(`'${url}' protocol is not supported`)
   }
 
   return manifest
 }
 
+/**
+ * @param {toa.origins.Manifest} manifest
+ */
+function validate (manifest) {
+  manifest = remap(manifest, (value) => shards(value)[0])
+  schemas.manifest.validate(manifest)
+}
+
+function supports (provider, url) {
+  return provider.protocols.findIndex((protocol) => url.substring(0, protocol.length) === protocol) !== -1
+}
+
 exports.manifest = manifest

package/source/manifest.test.js

@@ -55,3 +55,21 @@ it.each(PROTOCOLS)('should support %s protocol', async (protocol) => {
 
   expect(() => manifest(input)).not.toThrow()
 })
+
+it('should handle placeholders', async () => {
+  const input = { foo: 'http://${FOO}' + generate() + ':${BAR}/' } // eslint-disable-line no-template-curly-in-string
+
+  expect(() => manifest(input)).not.toThrow()
+})
+
+it('should handle host shards', async () => {
+  const input = { foo: 'http://{0-3}' + generate() }
+
+  expect(() => manifest(input)).not.toThrow()
+})
+
+it('should handle port shards', async () => {
+  const input = { foo: 'http://' + generate() + ':888{0-9}' }
+
+  expect(() => manifest(input)).not.toThrow()
+})