@toa.io/operations 0.7.6-dev.9 → 0.8.0-dev.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/operations",
-  "version": "0.7.6-dev.9",
+  "version": "0.8.0-dev.0",
   "description": "Toa Deployment",
   "homepage": "https://toa.io",
   "author": {
@@ -26,10 +26,10 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@toa.io/filesystem": "1.0.2-dev.9",
-    "@toa.io/generic": "0.11.0-dev.9",
-    "@toa.io/yaml": "0.7.6-dev.9",
+    "@toa.io/filesystem": "1.1.0-dev.2",
+    "@toa.io/generic": "0.11.0-dev.16",
+    "@toa.io/yaml": "0.7.6-dev.16",
     "execa": "5.1.1"
   },
-  "gitHead": "db624e061c5017062f46561e6d5e4106b7420e28"
+  "gitHead": "669be360acebac4dbe49735ec506127d9d0a05e3"
 }

package/src/deployment/.deployment/.describe/variables.js

@@ -9,7 +9,7 @@ const variables = (context, variables) => {
   if (variables.global === undefined) variables.global = []
 
   if (context.environment !== undefined) {
-    const variable = format('TOA_ENV', context.environment)
+    const variable = { name: 'TOA_ENV', value: context.environment }
 
     variables.global.unshift(variable)
   }
@@ -17,11 +17,4 @@ const variables = (context, variables) => {
   return variables
 }
 
-/**
- * @param {string} name
- * @param {string} value
- * @returns {toa.deployment.dependency.Variable}
- */
-const format = (name, value) => ({ name, value })
-
 exports.variables = variables

package/src/deployment/factory.js

@@ -2,8 +2,9 @@
 
 const { Process } = require('../process')
 const { Operator } = require('./operator')
-const { Factory: Images, Registry } = require('./images')
+const { Factory: ImagesFactory } = require('./images')
 const { Deployment } = require('./deployment')
+const { Registry } = require('./registry')
 const { Composition } = require('./composition')
 const { Service } = require('./service')
 
@@ -13,8 +14,16 @@ const { Service } = require('./service')
 class Factory {
   /** @type {toa.norm.Context} */
   #context
-  /** @type {toa.deployment.images.Registry} */
+
+  /** @type {Composition[]} */
+  #compositions
+
+  /** @type {toa.deployment.Dependency[]} */
+  #dependencies
+
+  /** @type {toa.deployment.Registry} */
   #registry
+
   /** @type {toa.operations.Process} */
   #process
 
@@ -25,18 +34,23 @@ class Factory {
     this.#context = context
     this.#process = new Process()
 
-    const images = new Images(context.name, context.runtime)
-    this.#registry = new Registry(context.registry, images, this.#process)
+    const imagesFactory = new ImagesFactory(context.name, context.runtime)
+
+    this.#registry = new Registry(context.registry, imagesFactory, this.#process)
+    this.#compositions = context.compositions.map((composition) => this.#composition(composition))
+    this.#dependencies = this.#getDependencies()
   }
 
   operator () {
-    const compositions = this.#context.compositions.map((composition) => this.#composition(composition))
-    const dependencies = this.#dependencies()
-    const deployment = new Deployment(this.#context, compositions, dependencies, this.#process)
+    const deployment = new Deployment(this.#context, this.#compositions, this.#dependencies, this.#process)
 
     return new Operator(deployment, this.#registry)
   }
 
+  registry () {
+    return this.#registry
+  }
+
   /**
    * @param composition {toa.norm.context.Composition}
    * @returns {Composition}
@@ -50,12 +64,14 @@ class Factory {
   /**
    * @returns {toa.deployment.Dependency[]}
    */
-  #dependencies () {
+  #getDependencies () {
     /** @type {toa.deployment.Dependency[]} */
     const dependencies = []
 
+    if (this.#context.dependencies === undefined) return dependencies
+
     for (const [reference, instances] of Object.entries(this.#context.dependencies)) {
-      const dependency = this.#dependency(reference, instances)
+      const dependency = this.#getDependency(reference, instances)
 
       if (dependency !== undefined) dependencies.push(dependency)
     }
@@ -68,7 +84,7 @@ class Factory {
    * @param {toa.norm.context.dependencies.Instance[]} instances
    * @returns {toa.deployment.Dependency | undefined}
    */
-  #dependency (path, instances) {
+  #getDependency (path, instances) {
     const module = require(path)
     const pkg = require(path + '/package.json')
 

package/src/deployment/images/composition.Dockerfile

@@ -1,4 +1,4 @@
-FROM node:18.2.0-alpine3.15
+FROM node:18.16.0-alpine3.17
 
 ENV NODE_ENV=production
 RUN if [ {{registry}} != undefined ]; then npm set registry {{registry}}; fi

package/src/deployment/images/composition.js

@@ -11,7 +11,7 @@ class Composition extends Image {
 
   /** @type {string} */
   #name
-  /** @type {Array<toa.norm.Component>} */
+  /** @type {toa.norm.Component[]} */
   #components
 
   /**

package/{test → src}/deployment/images/image.fixtures.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { Image } = require('../../../src/deployment/images/image')
+const { Image } = require('./image')
 const { generate } = require('randomstring')
 const { hash } = require('@toa.io/generic')
 

package/src/deployment/images/image.js

@@ -52,9 +52,9 @@ class Image {
   get version () {}
 
   tag (base) {
-    const tag = hash(this.#runtime.version + ';' + this.version)
+    const tag = hash(this.#runtime?.version + ';' + this.version)
 
-    this.reference = posix.join(base, `${this.#scope}/${this.#type}-${this.name}:${tag}`)
+    this.reference = posix.join(base ?? '', this.#scope, `${this.#type}-${this.name}:${tag}`)
   }
 
   async prepare (root) {

package/src/deployment/images/index.js

@@ -1,7 +1,5 @@
 'use strict'
 
 const { Factory } = require('./factory')
-const { Registry } = require('./registry')
 
 exports.Factory = Factory
-exports.Registry = Registry

package/src/deployment/images/service.Dockerfile

@@ -1,4 +1,4 @@
-FROM node:18.2.0-alpine3.15
+FROM node:18.16.0-alpine3.17
 
 ENV NODE_ENV=production
 RUN if [ {{registry}} != undefined ]; then npm set registry {{registry}}; fi

package/src/deployment/operator.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { directory } = require('@toa.io/filesystem')
+const workspace = require('./workspace')
 
 /**
  * @implements {toa.deployment.Operator}
@@ -8,12 +8,13 @@ const { directory } = require('@toa.io/filesystem')
 class Operator {
   /** @type {toa.deployment.Deployment} */
   #deployment
-  /** @type {toa.deployment.images.Registry} */
+
+  /** @type {toa.deployment.Registry} */
   #registry
 
   /**
    * @param deployment {toa.deployment.Deployment}
-   * @param registry {toa.deployment.images.Registry}
+   * @param registry {toa.deployment.Registry}
    */
   constructor (deployment, registry) {
     this.#deployment = deployment
@@ -21,7 +22,7 @@ class Operator {
   }
 
   async export (path) {
-    const target = await Operator.#target('deployment', path)
+    const target = await workspace.create('deployment', path)
 
     await this.#deployment.export(target)
 
@@ -29,61 +30,32 @@ class Operator {
   }
 
   async prepare (path) {
-    const target = await Operator.#target('images', path)
-
-    await this.#registry.prepare(target)
-
-    return target
+    return await this.#registry.prepare(path)
   }
 
-  async build () {
-    const target = await Operator.#target('images')
-
-    await this.#registry.prepare(target)
+  async push () {
     await this.#registry.push()
-
-    await directory.remove(target)
   }
 
   async install (options = {}) {
     options = Object.assign({}, OPTIONS, options)
 
-    const [source] = await Promise.all([this.export(), this.build()])
-
+    await Promise.all([this.export(), this.push()])
     await this.#deployment.install(options)
-
-    await directory.remove(source)
   }
 
   async template (options = {}) {
-    const source = await this.export()
-    const output = await this.#deployment.template(options)
+    await this.export()
 
-    await directory.remove(source)
-
-    return output
+    return await this.#deployment.template(options)
   }
 
   variables () {
     return this.#deployment.variables()
   }
-
-  /**
-   * @param type {string}
-   * @param [path] {string}
-   * @returns {Promise<string>}
-   */
-  static async #target (type, path) {
-    if (path === undefined) path = await directory.temp('toa-' + type)
-    else path = await directory.ensure(path)
-
-    return path
-  }
 }
 
 /** @type {toa.deployment.installation.Options} */
-const OPTIONS = {
-  wait: false
-}
+const OPTIONS = { wait: false }
 
 exports.Operator = Operator

package/{test → src}/deployment/operator.test.js

@@ -14,12 +14,12 @@ describe('env', () => {
   /** @type {toa.deployment.Deployment} */
   let deployment
 
-  /** @type {toa.deployment.images.Registry} */
+  /** @type {toa.deployment.Registry} */
   let registry
 
   beforeEach(() => {
     deployment = /** @type {toa.deployment.Deployment} */ {}
-    registry = /** @type {toa.deployment.images.Registry} */ {}
+    registry = /** @type {toa.deployment.Registry} */ {}
   })
 
   it('should be', async () => {
@@ -31,7 +31,10 @@ describe('env', () => {
   it('should return variables', async () => {
     const variables = { [generate()]: { name: generate(), value: generate() } }
 
-    deployment.variables = jest.fn(() => variables)
+    deployment.variables =
+      /** @type {typeof toa.deployment.Operator.variables} */
+      jest.fn(() => variables)
+
     operator = new Operator(deployment, registry)
 
     const output = operator.variables()

package/src/deployment/{images/registry.js → registry.js}

@@ -1,18 +1,21 @@
 'use strict'
 
-const { directory: { remove } } = require('@toa.io/filesystem')
+const workspace = require('./workspace')
 
 /**
- * @implements {toa.deployment.images.Registry}
+ * @implements {toa.deployment.Registry}
  */
 class Registry {
   /** @type {toa.norm.context.Registry} */
   #registry
+
   /** @type {toa.deployment.images.Factory} */
   #factory
+
   /** @type {toa.operations.Process} */
   #process
-  /** @type {Array<toa.deployment.images.Image>} */
+
+  /** @type {toa.deployment.images.Image[]} */
   #images = []
 
   /**
@@ -34,15 +37,24 @@ class Registry {
     return this.#create('service', path, service)
   }
 
-  async prepare (target) {
-    await Promise.all(this.#images.map((image) => image.prepare(target)))
+  async prepare (root) {
+    const path = await workspace.create('images', root)
+
+    await Promise.all(this.#images.map((image) => image.prepare(path)))
+
+    return path
+  }
+
+  async build () {
+    await this.prepare()
+
+    for (const image of this.#images) await this.#build(image)
   }
 
   async push () {
-    for (const image of this.#images) {
-      await this.#push(image)
-      await remove(image.context)
-    }
+    await this.prepare()
+
+    for (const image of this.#images) await this.#push(image)
   }
 
   /**
@@ -53,7 +65,7 @@ class Registry {
   #create (type, ...args) {
     const image = this.#factory[type](...args)
 
-    image.tag(this.#registry.base)
+    image.tag(this.#registry?.base)
     this.#images.push(image)
 
     return image
@@ -61,39 +73,48 @@ class Registry {
 
   /**
    * @param {toa.deployment.images.Image} image
+   * @param {boolean} [push]
    * @returns {Promise<void>}
    */
-  async #push (image) {
-    const args = ['--context=default', 'buildx', 'build', '--push', '--tag', image.reference, image.context]
-    const local = this.#registry.platforms === null
+  async #build (image, push = false) {
+    const args = ['--context=default', 'buildx', 'build']
+
+    if (push) args.push('--push')
+
+    args.push('--tag', image.reference, image.context)
+
+    const multiarch = this.#registry.platforms !== null
 
-    if (local) {
-      args.push('--builder', 'default')
-    } else {
+    if (multiarch) {
       const platform = this.#registry.platforms.join(',')
 
       args.push('--platform', platform)
       args.push('--builder', BUILDER)
 
-      await this.#builder()
-    }
+      await this.#ensureBuilder()
+    } else args.push('--builder', 'default')
 
     await this.#process.execute('docker', args)
   }
 
-  async #builder () {
+  async #push (image) {
+    await this.#build(image, true)
+  }
+
+  async #ensureBuilder () {
     const ls = 'buildx ls'.split(' ')
     const output = await this.#process.execute('docker', ls, { silently: true })
+    const exists = output.split('\n').findIndex((line) => line.startsWith('toa '))
 
-    const exists = output.split('\n').find((line) => line.startsWith('toa '))
+    if (exists === -1) await this.#createBuilder()
+  }
 
-    if (exists === undefined) {
-      const create = `buildx create --name ${BUILDER} --use`.split(' ')
-      const bootstrap = 'buildx inspect --bootstrap'.split(' ')
+  async #createBuilder () {
+    const create = `buildx create --name ${BUILDER} --use`.split(' ')
+    const bootstrap = 'buildx inspect --bootstrap'.split(' ')
 
-      await this.#process.execute('docker', create)
-      await this.#process.execute('docker', bootstrap)
-    }
+    await this.#process.execute('docker', create)
+    await this.#process.execute('docker', bootstrap)
   }
 }
 

package/src/deployment/workspace.js

@@ -0,0 +1,17 @@
+'use strict'
+
+const { directory } = require('@toa.io/filesystem')
+
+/**
+ * @param {string} type
+ * @param {string} [path]
+ * @return {Promise<string>}
+ */
+async function create (type, path) {
+  if (path === undefined) path = await directory.temp('toa-' + type)
+  else path = await directory.ensure(path)
+
+  return path
+}
+
+exports.create = create

package/types/deployment/composition.d.ts

@@ -1,12 +1,10 @@
-// noinspection ES6UnusedImports
-
-import type { Deployable } from './deployment'
+import type * as _deployment from './deployment'
 
 declare namespace toa.deployment {
 
-    interface Composition extends Deployable {
-        components: Array<string>
-    }
+  interface Composition extends _deployment.Deployable {
+    components: Array<string>
+  }
 
 }
 

package/types/deployment/dependency.d.ts

@@ -1,6 +1,4 @@
-// noinspection JSUnusedGlobalSymbols,ES6UnusedImports
-
-import { Service } from './service'
+import * as _service from './service'
 import { dependencies } from '@toa.io/norm/types/context'
 
 declare namespace toa.deployment {
@@ -58,20 +56,17 @@ declare namespace toa.deployment {
 
   type Dependency = {
     references?: dependency.Reference[]
-    services?: Service[] // deployment.Service
+    services?: _service.Service[] // deployment.Service
     proxies?: dependency.Proxy[]
     variables?: dependency.Variables
   }
 
 }
 
-export namespace dependency {
-  export type Declaration = toa.deployment.dependency.Declaration
-  export type Reference = toa.deployment.dependency.Reference
-  export type Service = toa.deployment.dependency.Service
-  export type Proxy = toa.deployment.dependency.Proxy
-  export type Variables = toa.deployment.dependency.Variables
-  export type Variable = toa.deployment.dependency.Variable
-}
-
+export type Declaration = toa.deployment.dependency.Declaration
+export type Reference = toa.deployment.dependency.Reference
+export type Service = toa.deployment.dependency.Service
+export type Proxy = toa.deployment.dependency.Proxy
+export type Variables = toa.deployment.dependency.Variables
+export type Variable = toa.deployment.dependency.Variable
 export type Dependency = toa.deployment.Dependency

package/types/deployment/deployment.d.ts

@@ -1,8 +1,6 @@
-// noinspection ES6UnusedImports,JSUnusedGlobalSymbols
-
-import type { Composition } from './composition'
-import type { Service } from './service'
-import type { dependency } from './dependency'
+import type * as _composition from './composition'
+import type * as _service from './service'
+import type * as _dependency from './dependency'
 
 declare namespace toa.deployment {
 
@@ -13,15 +11,15 @@ declare namespace toa.deployment {
     description?: string
     version: string
     appVersion: string
-    dependencies: dependency.Reference[]
+    dependencies: _dependency.Reference[]
   }
 
   interface Contents {
-    compositions?: Composition[]
+    compositions?: _composition.Composition[]
     components?: string[]
-    services?: Service[]
-    proxies?: dependency.Proxy[]
-    variables?: dependency.Variables
+    services?: _service.Service[]
+    proxies?: _dependency.Proxy[]
+    variables?: _dependency.Variables
 
     [key: string]: Object
   }
@@ -38,7 +36,7 @@ declare namespace toa.deployment {
 
   namespace template {
     interface Options {
-      namespace: string
+      namespace?: string
     }
   }
 
@@ -54,7 +52,7 @@ declare namespace toa.deployment {
 
     template(options: template.Options): Promise<string>
 
-    variables(): dependency.Variables
+    variables(): _dependency.Variables
   }
 
 }

package/types/deployment/factory.d.ts

@@ -1,11 +1,13 @@
-// noinspection ES6UnusedImports
-import type { Operator } from './operator'
+import type * as _operator from './operator'
+import * as _registry from './registry'
 
 declare namespace toa.deployment {
 
-    interface Factory {
-        operator(): Operator
-    }
+  interface Factory {
+    operator(): _operator.Operator
+
+    registry(): _registry.Registry
+  }
 
 }
 

package/types/deployment/operator.d.ts

@@ -1,5 +1,3 @@
-// noinspection ES6UnusedImports
-
 import * as _deployment from './deployment'
 import * as _dependency from './dependency'
 
@@ -8,15 +6,11 @@ declare namespace toa.deployment {
   interface Operator {
     export(path?: string): Promise<string>
 
-    prepare(path?: string): Promise<string>
-
-    build(): Promise<void>
-
     install(options?: _deployment.installation.Options): Promise<void>
 
     template(options?: _deployment.template.Options): Promise<string>
 
-    variables(): _dependency.dependency.Variables
+    variables(): _dependency.Variables
   }
 
 }

package/types/deployment/registry.d.ts

@@ -0,0 +1,21 @@
+import type * as _norm from '@toa.io/norm/types'
+import type * as _dependency from './dependency'
+import type * as _image from "./images/image"
+
+declare namespace toa.deployment {
+
+  interface Registry {
+    composition(composition: _norm.Composition): _image.Image
+
+    service(path: string, service: _dependency.Service): _image.Image
+
+    prepare(path: string): Promise<string>
+
+    build(): Promise<void>
+
+    push(): Promise<void>
+  }
+
+}
+
+export type Registry = toa.deployment.Registry

package/types/deployment/service.d.ts

@@ -1,20 +1,18 @@
-// noinspection ES6UnusedImports
-
-import type { Deployable } from './deployment'
+import type * as _deployment from './deployment'
 
 declare namespace toa.deployment {
 
-    interface Ingress {
-        host: string
-        class: string
-        annotations?: object
-    }
+  interface Ingress {
+    host: string
+    class: string
+    annotations?: object
+  }
+
+  interface Service extends _deployment.Deployable {
+    port: number
+    ingress?: Ingress
+  }
 
-    interface Service extends Deployable {
-        port: number
-        ingress?: Ingress
-    }
-    
 }
 
 export type Service = toa.deployment.Service

package/types/deployment/index.d.ts

@@ -1 +0,0 @@
-export { Dependency, dependency } from './dependency'