@toa.io/extensions.origins 0.20.0-dev.9 → 0.20.0

package/source/extension.test.ts

@@ -0,0 +1,161 @@
+import { generate } from 'randomstring'
+import { encode } from 'msgpackr'
+import { Locator } from '@toa.io/core'
+import { deployment, type Instance } from './extension'
+import type { Annotation, Properties } from './annotation'
+import type { Manifest } from './manifest'
+import type { Dependency } from '@toa.io/operations'
+
+const locator = new Locator(generate(), generate())
+const NAMESPACE = locator.namespace.toUpperCase()
+const NAME = locator.name.toUpperCase()
+
+it('should deploy pointer variables', async () => {
+  const manifest: Manifest = { queue: null }
+  const instance = { locator, manifest } as unknown as Instance
+  const url = 'amqp://host-' + generate()
+
+  const annotation: Annotation = {
+    [locator.id]: {
+      queue: url
+    }
+  }
+
+  const deploy = deployment([instance], annotation)
+
+  const expected: Dependency = {
+    variables: {
+      [locator.label]: expect.arrayContaining([
+        {
+          name: `TOA_ORIGINS_${NAMESPACE}_${NAME}_QUEUE`,
+          value: url
+        }
+      ])
+    }
+  }
+
+  expect(deploy)
+    .toMatchObject(expected)
+})
+
+it('should deploy default origin', async () => {
+  const example = 'http://api.example.com'
+  const manifest: Manifest = { example }
+  const instance = { locator, manifest } as unknown as Instance
+  const annotation: Annotation = {}
+  const deploy = deployment([instance], annotation)
+
+  const expected: Dependency = {
+    variables: {
+      [locator.label]: expect.arrayContaining([
+        {
+          name: `TOA_ORIGINS_${NAMESPACE}_${NAME}_EXAMPLE`,
+          value: example
+        }
+      ])
+    }
+  }
+
+  expect(deploy)
+    .toMatchObject(expected)
+})
+
+it('should deploy properties', async () => {
+  const manifest: Manifest = {}
+  const instance = { locator, manifest } as unknown as Instance
+  const properties: Properties = {
+    '.http': {
+      '/^http:\\/\\/\\w+api.example.com/': true
+    }
+  }
+
+  const annotation: Annotation = {
+    [locator.id]: properties
+  }
+
+  const deploy = deployment([instance], annotation)
+  const value = encode(properties).toString('base64')
+
+  const expected: Dependency = {
+    variables: {
+      [locator.label]: expect.arrayContaining([
+        {
+          name: `TOA_ORIGINS_${NAMESPACE}_${NAME}__PROPERTIES`,
+          value
+        }
+      ])
+    }
+  }
+
+  expect(deploy)
+    .toMatchObject(expected)
+})
+
+it('should deploy properties with null manifest', async () => {
+  const manifest: Manifest = null
+  const instance = { locator, manifest } as unknown as Instance
+  const properties: Properties = {
+    '.http': {
+      '/^http:\\/\\/\\w+api.example.com/': true
+    }
+  }
+
+  const annotation: Annotation = {
+    [locator.id]: properties
+  }
+
+  const deploy = deployment([instance], annotation)
+  const value = encode(properties).toString('base64')
+
+  const expected: Dependency = {
+    variables: {
+      [locator.label]: expect.arrayContaining([
+        {
+          name: `TOA_ORIGINS_${NAMESPACE}_${NAME}__PROPERTIES`,
+          value
+        }
+      ])
+    }
+  }
+
+  expect(deploy)
+    .toMatchObject(expected)
+})
+
+it('should deploy credentials for amqp', async () => {
+  const manifest: Manifest = { queue: null }
+  const instance = { locator, manifest } as unknown as Instance
+  const url = 'amqp://host-' + generate()
+
+  const annotation: Annotation = {
+    [locator.id]: {
+      queue: url
+    }
+  }
+
+  const deploy = deployment([instance], annotation)
+
+  const expected: Dependency = {
+    variables: {
+      [locator.label]: expect.arrayContaining([
+        {
+          name: `TOA_ORIGINS_${NAMESPACE}_${NAME}_QUEUE_USERNAME`,
+          secret: {
+            name: `toa-origins-${locator.label}-queue`,
+            key: 'username'
+          }
+        },
+        {
+          name: `TOA_ORIGINS_${NAMESPACE}_${NAME}_QUEUE_PASSWORD`,
+          secret: {
+            name: `toa-origins-${locator.label}-queue`,
+            key: 'password'
+          }
+        }
+      ])
+    }
+  }
+
+  expect(deploy)
+    .toMatchObject(expected)
+})

package/source/extension.ts

@@ -0,0 +1,60 @@
+import { encode } from 'msgpackr'
+import { createVariables, type Request } from '@toa.io/pointer'
+import { merge } from '@toa.io/generic'
+import { normalize, split, type Annotation, type Properties, type Origins } from './annotation'
+import { type Manifest, validate } from './manifest'
+import type { Locator } from '@toa.io/core'
+import type { Dependency, Variables } from '@toa.io/operations'
+import type { context } from '@toa.io/norm'
+
+export function deployment (instances: Instance[], annotation: Annotation = {}): Dependency {
+  normalize(instances, annotation)
+
+  const variables: Variables = {}
+
+  for (const instance of instances) {
+    const component = annotation[instance.locator.id]
+    const { origins, properties } = split(component)
+    const instanceVariables = createInstanceVariables(instance, origins)
+    const propertiesVariable = createPropertiesVariable(instance.locator, properties)
+
+    merge(variables, instanceVariables)
+    merge(variables, propertiesVariable)
+  }
+
+  return { variables }
+}
+
+export function manifest (manifest: Manifest): Manifest {
+  validate(manifest)
+
+  return manifest
+}
+
+function createInstanceVariables (instance: Instance, origins: Origins): Variables {
+  if (instance.manifest === null) return {}
+
+  const label: string = instance.locator.label
+  const id = ID_PREFIX + label
+  const selectors = Object.keys(instance.manifest)
+  const request: Request = { group: label, selectors }
+
+  return createVariables(id, origins, [request])
+}
+
+function createPropertiesVariable (locator: Locator, properties: Properties): Variables {
+  const name = ENV_PREFIX + locator.uppercase + PROPERTIES_SUFFIX
+  const value = encode(properties).toString('base64')
+
+  return {
+    [locator.label]: [
+      { name, value }
+    ]
+  }
+}
+
+export const ID_PREFIX = 'origins-'
+export const ENV_PREFIX = 'TOA_ORIGINS_'
+export const PROPERTIES_SUFFIX = '__PROPERTIES'
+
+export type Instance = context.Dependency<Manifest>

package/source/index.ts

@@ -0,0 +1,2 @@
+export { deployment, manifest } from './extension'
+export { Factory } from './Factory'

package/source/manifest.test.ts

@@ -0,0 +1,30 @@
+import { type Manifest, validate } from './manifest'
+
+let manifest: Manifest
+
+it('should not throw if valid', async () => {
+  manifest = {
+    one: 'http://localhost',
+    two: null
+  }
+
+  expect(run).not.toThrow()
+})
+
+it('should throw if not a uri', async () => {
+  manifest = {
+    one: 'not a URI'
+  }
+
+  expect(run).toThrow('must match format')
+})
+
+it('should not throw on null manifest', async () => {
+  manifest = null
+
+  expect(run).not.toThrow()
+})
+
+function run (): void {
+  validate(manifest)
+}

package/source/manifest.ts

@@ -0,0 +1,11 @@
+import { resolve } from 'node:path'
+import * as schemas from '@toa.io/schemas'
+
+export function validate (manifest: Manifest): void {
+  if (manifest !== null) schema.validate(manifest)
+}
+
+const path = resolve(__dirname, '../schemas/manifest.cos.yaml')
+const schema = schemas.schema(path)
+
+export type Manifest = Record<string, string | null> | null

package/source/protocols/amqp/.test/aspect.fixtures.js

@@ -9,7 +9,7 @@ const originCount = random(5) + 2
 for (let j = 0; j < originCount; j++) {
   const origin = generate()
 
-  manifest[origin] = 'amqp://' + generate()
+  manifest[origin] = ['amqp://' + generate()]
 }
 
 exports.manifest = manifest

package/source/protocols/amqp/.test/mock.comq.js

@@ -2,7 +2,7 @@
 
 const { generate } = require('randomstring')
 
-const connect = jest.fn(async () => ({
+const assert = jest.fn(async () => ({
   emit: jest.fn(async () => undefined),
   request: jest.fn(async () => generate()),
   reply: jest.fn(async () => undefined),
@@ -10,4 +10,4 @@ const connect = jest.fn(async () => ({
   close: jest.fn(async () => undefined)
 }))
 
-exports.connect = connect
+exports.assert = assert

package/source/protocols/amqp/aspect.js

@@ -1,33 +1,26 @@
 'use strict'
 
-const { connect } = require('comq')
+const { assert } = require('comq')
 const { Connector } = require('@toa.io/core')
-const { shards } = require('@toa.io/generic')
+const protocol = require('./index')
 
-const { id } = require('./id')
-
-/**
- * @implements {toa.origins.amqp.Aspect}
- */
 class Aspect extends Connector {
-  name = id
-  /** @type {toa.origins.Manifest} */
-  #manifest
+  name = protocol.id
+
+  #resolve
 
   /** @type {Record<string, Partial<comq.IO>>} */
   #origins = {}
 
-  /**
-   * @param {toa.origins.Manifest} manifest
-   */
-  constructor (manifest) {
+  constructor (resolve) {
     super()
 
-    this.#manifest = manifest
+    this.#resolve = resolve
   }
 
   async open () {
-    const promises = Object.entries(this.#manifest).map(this.#open)
+    const cfg = await this.#resolve()
+    const promises = Object.entries(cfg.origins).map(this.#open)
 
     await Promise.all(promises)
   }
@@ -39,12 +32,15 @@ class Aspect extends Connector {
   }
 
   async invoke (origin, method, ...args) {
+    if (this.#origins[origin]?.[method] === undefined) {
+      throw new Error(`Origin "${origin}" or method "${method}" is undefined`)
+    }
+
     return this.#origins[origin][method](...args)
   }
 
-  #open = async ([origin, reference]) => {
-    const references = shards(reference)
-    const io = await connect(...references)
+  #open = async ([origin, references]) => {
+    const io = await assert(...references)
 
     this.#origins[origin] = restrict(io)
   }
@@ -67,11 +63,8 @@ function restrict (io) {
   }
 }
 
-/**
- * @param {toa.origins.Manifest} manifest
- */
-function create (manifest) {
-  return new Aspect(manifest)
+function create (resolve) {
+  return new Aspect(resolve)
 }
 
 exports.create = create

package/source/protocols/amqp/deployment.js

@@ -15,9 +15,13 @@ function deployment (instances) {
     const secrets = []
 
     for (const [origin, reference] of Object.entries(manifest)) {
-      const url = new URL(reference)
+      let protocol
 
-      if (protocols.includes(url.protocol)) {
+      const match = reference.match(RX)
+
+      if (match !== null) protocol = match.groups.protocol
+
+      if (protocols.includes(protocol)) {
         const originSecrets = createSecrets(locator, origin)
 
         secrets.push(...originSecrets)
@@ -60,4 +64,6 @@ function createSecret (locator, origin, property) {
   }
 }
 
+const RX = /^(?<protocol>\w{1,12}:)/
+
 exports.deployment = deployment

package/source/protocols/http/.aspect/permissions.js

@@ -1,23 +1,26 @@
 'use strict'
 
 const { echo } = require('@toa.io/generic')
+const { Connector } = require('@toa.io/core')
 
-/**
- * @implements {toa.origins.http.Permissions}
- */
-class Permissions {
-  #default = process.env.TOA_DEV === '1'
-
+class Permissions extends Connector {
   /** @type {RegExp[]} */
   #allowances = []
 
   /** @type {RegExp[]} */
   #denials = []
 
-  /**
-   * @param {toa.origins.http.Properties} properties
-   */
-  constructor (properties) {
+  #resolve
+
+  constructor (resolve) {
+    super()
+
+    this.#resolve = resolve
+  }
+
+  async open () {
+    const { properties } = await this.#resolve()
+
     if (properties !== undefined) this.#parse(properties)
   }
 

package/source/protocols/http/aspect.js

@@ -1,41 +1,35 @@
 'use strict'
 
-/**
- * @typedef {import('node-fetch').RequestInit} Request
- * @typedef {import('node-fetch').Response} Response
- */
-
 const fetch = require('node-fetch')
 
 const { Connector } = require('@toa.io/core')
 const { retry } = require('@toa.io/generic')
 
 const { Permissions } = require('./.aspect/permissions')
-const { id } = require('./id')
 const protocols = require('./protocols')
+const protocol = require('./index')
 
-/**
- * @implements {toa.origins.http.Aspect}
- */
 class Aspect extends Connector {
   /** @readonly */
-  name = id
+  name = protocol.id
 
-  /** @type {toa.origins.Manifest} */
+  #resolve
   #origins
-
-  /** @type {toa.origins.http.Permissions} */
   #permissions
 
-  /**
-   * @param {toa.origins.Manifest} manifest
-   * @param {toa.origins.http.Permissions} permissions
-   */
-  constructor (manifest, permissions) {
+  constructor (resolve, permissions) {
     super()
 
-    this.#origins = manifest
+    this.#resolve = resolve
     this.#permissions = permissions
+
+    this.depends(permissions)
+  }
+
+  async open () {
+    const { origins } = await this.#resolve()
+
+    this.#origins = origins
   }
 
   async invoke (name, path, request, options) {
@@ -56,23 +50,12 @@ class Aspect extends Connector {
     return this.#request(url.href, request, options?.retry)
   }
 
-  /**
-   * @param {string} url
-   * @param {Request} request
-   * @return {Promise<Response>}
-   */
   async #invokeURL (url, request) {
     if (this.#permissions.test(url) === false) throw new Error(`URL '${url}' is not allowed`)
 
     return this.#request(url, request)
   }
 
-  /**
-   * @param {string} url
-   * @param {Request} request
-   * @param {toa.generic.retry.Options} [options]
-   * @return {Promise<Response>}
-   */
   async #request (url, request, options) {
     const call = () => fetch(url, request)
 
@@ -117,14 +100,10 @@ function isAbsoluteURL (path) {
 
 const PLACEHOLDER = /\*/g
 
-/**
- * @param {toa.origins.Manifest} manifest
- * @param {toa.origins.http.Properties} [properties]
- */
-function create (manifest, properties) {
-  const permissions = new Permissions(properties)
+function create (resolve) {
+  const permissions = new Permissions(resolve)
 
-  return new Aspect(manifest, permissions)
+  return new Aspect(resolve, permissions)
 }
 
 exports.create = create

package/source/protocols/index.ts

@@ -0,0 +1,16 @@
+'use strict'
+
+import { type Resolver } from '../Factory'
+import amqp from './amqp'
+import http from './http'
+import type { extensions } from '@toa.io/core'
+
+export const protocols: Protocol[] = [http, amqp]
+
+export interface Protocol {
+  id: ProtocolID
+  protocols: string[]
+  create: (resolver: Resolver) => extensions.Aspect
+}
+
+export type ProtocolID = 'http' | 'amqp'

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./transpiled"
+  },
+  "include": [
+    "source"
+  ],
+  "exclude": [
+    "**/*.test.ts"
+  ]
+}

package/source/.credentials.js

@@ -1,14 +0,0 @@
-'use strict'
-
-/**
- * @param {string} reference
- */
-function check (reference) {
-  if (typeof reference !== 'string') return // aspect properties object
-
-  const url = new URL(reference)
-
-  if (url.username !== '' || url.password !== '') throw new Error('Origins must not contain credentials. Please use environment secrets instead.')
-}
-
-exports.check = check

package/source/.deployment/index.js

@@ -1,5 +0,0 @@
-'use strict'
-
-const { uris } = require('./uris')
-
-exports.uris = uris

package/source/.deployment/uris.js

@@ -1,37 +0,0 @@
-'use strict'
-
-const { PREFIX } = require('../constants')
-
-/**
- * @param {toa.norm.context.dependencies.Instance[]} instances
- * @param {toa.origins.Annotations} annotations
- * @returns {toa.deployment.dependency.Variables}
- */
-function uris (instances, annotations) {
-  const variables = {}
-
-  for (const [id, annotation] of Object.entries(annotations)) {
-    const component = instances.find((instance) => instance.locator.id === id)
-
-    if (component === undefined) throw new Error(`Origins annotations error: component '${id}' is not found`)
-
-    for (const origin of Object.keys(annotation)) {
-      const properties = origin[0] === '.'
-
-      if (!properties && !(origin in component.manifest)) {
-        throw new Error(`Origins annotations error: component '${id}' doesn't have '${origin}' origin`)
-      }
-    }
-
-    const name = PREFIX + component.locator.uppercase
-    const json = JSON.stringify(annotation)
-    const value = btoa(json)
-    const variable = { name, value }
-
-    variables[component.locator.label] = [variable]
-  }
-
-  return variables
-}
-
-exports.uris = uris

package/source/.test/constants.js

@@ -1,3 +0,0 @@
-'use strict'
-
-exports.PROTOCOLS = ['http:', 'https:', 'amqp:', 'amqps:']

package/source/.test/deployment.fixtures.js

@@ -1,20 +0,0 @@
-'use strict'
-
-const { generate } = require('randomstring')
-const { Locator } = require('@toa.io/core')
-const { random, sample } = require('@toa.io/generic')
-
-const { PROTOCOLS } = require('./constants')
-
-const component = () => ({
-  locator: new Locator(generate(), generate()),
-  manifest: { [generate()]: sample(PROTOCOLS) + '//' + generate() }
-})
-
-const components = () => {
-  const length = random(20) + 10
-
-  return Array.from({ length }, component)
-}
-
-exports.components = components

package/source/.test/factory.fixtures.js

@@ -1,13 +0,0 @@
-'use strict'
-
-const { generate } = require('randomstring')
-
-/** @type {Record<string, string>} */
-const manifest = {
-  [generate()]: 'https://toa.io',
-  [generate()]: 'https://api.domain.com',
-  [generate()]: 'amqp://localhost',
-  [generate()]: 'amqps://localhost'
-}
-
-exports.manifest = manifest