@toa.io/operations 1.0.0-alpha.0 → 1.0.0-alpha.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/operations",
-  "version": "1.0.0-alpha.0",
+  "version": "1.0.0-alpha.11",
   "description": "Toa Deployment",
   "homepage": "https://toa.io",
   "author": {
@@ -27,10 +27,12 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@toa.io/filesystem": "1.0.0-alpha.0",
-    "@toa.io/generic": "1.0.0-alpha.0",
-    "@toa.io/yaml": "1.0.0-alpha.0",
-    "execa": "5.1.1"
+    "@toa.io/filesystem": "1.0.0-alpha.11",
+    "@toa.io/generic": "1.0.0-alpha.11",
+    "@toa.io/norm": "1.0.0-alpha.11",
+    "@toa.io/yaml": "1.0.0-alpha.11",
+    "execa": "5.1.1",
+    "fs-extra": "11.1.1"
   },
-  "gitHead": "06c64546f6292cc07c52f74b31415101037f7616"
+  "gitHead": "e343ac81eef12957cfa5e520119b1276b8ec0ad2"
 }

package/src/deployment/chart/templates/variables.yaml

@@ -8,5 +8,8 @@
     secretKeyRef:
       name: {{ .secret.name }}
       key: {{ .secret.key }}
+      {{- if .secret.optional }}
+      optional: {{ .secret.optional }}
+      {{- end }}
   {{- end }}
 {{- end }}

package/src/deployment/chart/values.yaml

@@ -12,6 +12,7 @@ compositions:
         secret:
           name: secret-name
           key: secret-key
+          optional: false
   - name: users
     image: localhost:5000/composition-users:0.0.0
     replicas: 3

package/src/deployment/deployment.js

@@ -2,8 +2,8 @@
 
 const { join } = require('node:path')
 const { writeFile: write } = require('node:fs/promises')
-const { directory: { copy } } = require('@toa.io/filesystem')
 const { dump } = require('@toa.io/yaml')
+const fs = require('fs-extra')
 
 const { merge, declare, describe } = require('./.deployment')
 
@@ -28,7 +28,7 @@ class Deployment {
     await Promise.all([
       write(join(target, 'Chart.yaml'), chart),
       write(join(target, 'values.yaml'), values),
-      copy(TEMPLATES, join(target, 'templates'))
+      fs.copy(TEMPLATES, join(target, 'templates'))
     ])
 
     this.#target = target

package/src/deployment/factory.js

@@ -1,5 +1,6 @@
 'use strict'
 
+const { context: load } = require('@toa.io/norm')
 const { Process } = require('../process')
 const { Operator } = require('./operator')
 const { Factory: ImagesFactory } = require('./images')
@@ -85,6 +86,12 @@ class Factory {
 
     return new Service(service, image)
   }
+
+  static async create (path, environment) {
+    const context = await load(path, environment)
+
+    return new Factory(context)
+  }
 }
 
 exports.Factory = Factory

package/src/deployment/images/composition.Dockerfile

@@ -1,4 +1,4 @@
-FROM node:20.9.0-alpine3.18
+FROM {{build.image}}
 
 {{build.arguments}}
 

package/src/deployment/images/composition.js

@@ -1,30 +1,23 @@
 'use strict'
 
 const { join } = require('node:path')
-const { hash } = require('@toa.io/generic')
-const { directory: { copy } } = require('@toa.io/filesystem')
+const fs = require('fs-extra')
+const { createHash } = require('node:crypto')
 
 const { Image } = require('./image')
 
 class Composition extends Image {
   dockerfile = join(__dirname, 'composition.Dockerfile')
 
-  /** @type {string} */
   #name
-
-  /** @type {toa.norm.Component[]} */
+  #image
   #components
 
-  /**
-   * @param {string} scope
-   * @param {toa.norm.context.Runtime} runtime
-   * @param {toa.norm.context.Registry} registry
-   * @param {toa.norm.context.Composition} composition
-   */
   constructor (scope, runtime, registry, composition) {
     super(scope, runtime, registry)
 
     this.#name = composition.name
+    this.#image = composition.image
     this.#components = composition.components
   }
 
@@ -33,16 +26,41 @@ class Composition extends Image {
   }
 
   get version () {
-    const tags = this.#components.map((component) => component.locator.id + ':' + component.version)
+    const hash = createHash('sha256')
+
+    for (const component of this.#components) {
+      hash.update(component.locator.id)
+      hash.update(component.version)
+    }
+
+    return hash.digest('hex').slice(0, 8)
+  }
+
+  get base () {
+    if (this.#image !== undefined) {
+      return this.#image
+    }
+
+    let image = null
+
+    for (const component of this.#components) {
+      const value = component.build?.image
+
+      if (image !== null && image !== value) {
+        throw new Error(`Composition '${this.#name}' requires different base images for its components. Specify base image for the composition in the context.`)
+      }
+
+      image = value
+    }
 
-    return hash(tags.join(';'))
+    return image ?? undefined
   }
 
   async prepare (root) {
     const context = await super.prepare(root)
 
     for (const component of this.#components) {
-      await copy(component.path, join(context, component.locator.label))
+      await fs.copy(component.path, join(context, component.locator.label))
     }
 
     return context

package/src/deployment/images/image.fixtures.js

@@ -2,9 +2,8 @@
 
 const { Image } = require('./image')
 const { generate } = require('randomstring')
-const { hash } = require('@toa.io/generic')
 
-const version = generate()
+const version = '168b04ff'
 const name = generate()
 
 /**
@@ -22,17 +21,17 @@ class Class extends Image {
 
 /** @type {toa.norm.context.Runtime} */
 const runtime = {
-  version: generate()
+  version: '0.0.0'
 }
 
 /** @type {toa.norm.context.Registry} */
 const registry = {
-  base: generate()
+  base: 'node:alpine'
 }
 
 exports.scope = generate()
 exports.name = name
-exports.version = hash(runtime.version + ';' + version)
+exports.version = 'ba2409fc'
 exports.Class = Class
 exports.runtime = runtime
 exports.registry = registry

package/src/deployment/images/image.js

@@ -1,10 +1,17 @@
 'use strict'
 
-const { join, posix } = require('node:path')
-const { readFile: read, writeFile: write } = require('node:fs/promises')
-
-const { hash, overwrite } = require('@toa.io/generic')
-const { directory } = require('@toa.io/filesystem')
+const {
+  join,
+  posix
+} = require('node:path')
+const {
+  readFile: read,
+  writeFile: write
+} = require('node:fs/promises')
+const { createHash } = require('node:crypto')
+
+const { overwrite } = require('@toa.io/generic')
+const { mkdir } = require('node:fs/promises')
 
 /**
  * @implements {toa.deployment.images.Image}
@@ -13,64 +20,48 @@ const { directory } = require('@toa.io/filesystem')
 class Image {
   context
   reference
-
-  /**
-   * @protected
-   * @type {string}
-   */
   dockerfile
 
-  /** @type {string} */
   #scope
-
-  /** @type {toa.norm.context.Registry} */
   #registry
-
-  /** @type {toa.norm.context.Runtime} */
   #runtime
+  #values = {
+    build: {
+      image: 'node:20.9.0-alpine3.18'
+    }
+  }
 
-  /** @type {{ runtime?: Partial<toa.norm.context.Runtime>, build: object }} */
-  #values = { build: { command: 'echo hello' } }
-
-  /**
-   * @param {string} scope
-   * @param {toa.norm.context.Runtime} runtime
-   * @param {toa.norm.context.Registry} registry
-   */
   constructor (scope, runtime, registry) {
     this.#scope = scope
     this.#registry = registry
     this.#runtime = runtime
-
-    this.#setValues()
   }
 
   tag () {
-    const tag = hash(this.#runtime?.version + ';' + this.version)
+    const hash = createHash('sha256')
+
+    hash.update(this.#runtime.version)
+    hash.update(this.version)
+
+    const tag = hash.digest('hex').slice(0, 8)
 
     this.reference = posix.join(this.#registry.base ?? '', this.#scope, `${this.name}:${tag}`)
   }
 
-  /**
-   * @abstract
-   * @protected
-   * @type {string}
-   */
   get name () {}
 
-  /**
-   * @abstract
-   * @protected
-   * @type {string}
-   */
   get version () {}
 
+  get base () {}
+
   async prepare (root) {
     if (this.dockerfile === undefined) throw new Error('Dockerfile isn\'t specified')
 
+    this.#setValues()
+
     const path = join(root, `${this.name}.${this.version}`)
 
-    await directory.ensure(path)
+    await mkdir(path, { recursive: true })
 
     const template = await read(this.dockerfile, 'utf-8')
     const contents = template.replace(/{{(\S{1,32})}}/g, (_, key) => this.#value(key))
@@ -88,6 +79,12 @@ class Image {
     this.#values.runtime = this.#runtime
     this.#values.build = overwrite(this.#values.build, this.#registry.build)
 
+    const image = this.base
+
+    if (image !== undefined) {
+      this.#values.build.image = image
+    }
+
     if (this.#values.build.arguments !== undefined) this.#values.build.arguments = createArguments(this.#values.build.arguments)
     if (this.#values.build.run !== undefined) this.#values.build.run = createRunCommands(this.#values.build.run)
   }

package/src/deployment/images/service.js

@@ -3,7 +3,7 @@
 const { join, dirname } = require('node:path')
 
 const { Image } = require('./image')
-const { directory: { copy } } = require('@toa.io/filesystem')
+const fs = require('fs-extra')
 
 class Service extends Image {
   dockerfile = join(__dirname, 'service.Dockerfile')
@@ -57,7 +57,7 @@ class Service extends Image {
   async prepare (root) {
     const context = await super.prepare(root)
 
-    await copy(this.#path, context)
+    await fs.copy(this.#path, context)
 
     return context
   }

package/src/deployment/registry.js

@@ -6,23 +6,14 @@ const workspace = require('./workspace')
  * @implements {toa.deployment.Registry}
  */
 class Registry {
-  /** @type {toa.norm.context.Registry} */
   #registry
 
-  /** @type {toa.deployment.images.Factory} */
   #factory
 
-  /** @type {toa.operations.Process} */
   #process
 
-  /** @type {toa.deployment.images.Image[]} */
   #images = []
 
-  /**
-   * @param {toa.norm.context.Registry} registry
-   * @param {toa.deployment.images.Factory} factory
-   * @param {toa.operations.Process} process
-   */
   constructor (registry, factory, process) {
     this.#registry = registry
     this.#factory = factory
@@ -48,7 +39,9 @@ class Registry {
   async build () {
     await this.prepare()
 
-    for (const image of this.#images) await this.#build(image)
+    for (const image of this.#images) {
+      await this.#build(image)
+    }
   }
 
   async push () {
@@ -58,7 +51,7 @@ class Registry {
   }
 
   /**
-   * @param {"composition" | "service"} type
+   * @param {'composition' | 'service'} type
    * @param {...any} args
    * @returns {toa.deployment.images.Image}
    */
@@ -78,7 +71,11 @@ class Registry {
   async #build (image, push = false) {
     const args = ['--context=default', 'buildx', 'build']
 
-    if (push) args.push('--push')
+    if (push) {
+      args.push('--push')
+    } else {
+      args.push('--load')
+    }
 
     args.push('--tag', image.reference, image.context)
 
@@ -95,7 +92,11 @@ class Registry {
       args.push('--builder', BUILDER)
 
       await this.#ensureBuilder()
-    } else args.push('--builder', 'default')
+    } else {
+      args.push('--builder', 'default')
+    }
+
+    args.push('--progress', 'plain')
 
     await this.#process.execute('docker', args)
   }

package/types/dependency.d.ts

@@ -18,6 +18,7 @@ export type Variable = {
   secret?: {
     name: string,
     key: string
+    optional?: boolean
   }
 }