@toa.io/operations 1.0.0-alpha.26 → 1.0.0-alpha.261

package/src/deployment/chart/values.yaml

@@ -3,9 +3,16 @@ compositions:
   - name: todos
     image: localhost:5000/composition-todos:0.0.0
     replicas: 2
+    mounts:
+      - name: mount-name
+        path: /storage
+        claim: storage-pvc
     components:
       - todos-tasks
       - todos-stats
+    resources:
+      cpu: [100m, 1]
+      memory: [100Mi, 1Gi]
     variables:
       - name: TOA_CONFIGURATION_TODOS_TASKS
         value: foo
@@ -18,7 +25,6 @@ compositions:
     replicas: 3
     components:
       - users-users
-# TODO: create component services only if sync binding is being used
 components:
   - todos-tasks
   - todos-stats
@@ -28,7 +34,11 @@ services:
     image: localhost:5000/resources-gateway:0.0.0
     port: 8000
     replicas: 2
+    resources:
+      cpu: [100m, 1]
+      memory: [100Mi, 1Gi]
     ingress:
+      default: true
       hosts: [dummies.toa.io]
       class: alb
       annotations:

package/src/deployment/composition.js

@@ -10,6 +10,7 @@ class Composition {
     this.name = composition.name
     this.image = image.reference
     this.components = composition.components.map(component)
+    this.resources = composition.resources
   }
 }
 

package/src/deployment/deployment.js

@@ -13,11 +13,11 @@ class Deployment {
   #process
   #target
 
-  constructor (context, compositions, dependencies, process) {
+  constructor (context, compositions, dependencies, process, image) {
     const dependency = merge(dependencies)
 
     this.#chart = declare(context, dependency)
-    this.#values = describe(context, compositions, dependency)
+    this.#values = describe(context, compositions, dependency, image)
     this.#process = process
   }
 
@@ -42,6 +42,7 @@ class Deployment {
 
     if (options.namespace !== undefined) args.push('-n', options.namespace)
     if (options.wait === true) args.push('--wait')
+    if (options.timeout !== undefined) args.push('--timeout', options.timeout)
 
     await this.#process.execute('helm', ['dependency', 'update', this.#target])
     await this.#process.execute('helm', ['upgrade', this.#chart.name, '-i', ...args, this.#target])
@@ -68,6 +69,9 @@ class Deployment {
     addVariables(this.#values.compositions, variables, used)
     addVariables(this.#values.services, variables, used)
 
+    if (this.#values.mono !== undefined)
+      addVariables([this.#values.mono], variables, used)
+
     return variables
   }
 }

package/src/deployment/factory.js

@@ -11,25 +11,42 @@ const { Service } = require('./service')
 
 class Factory {
   #context
+  #root
+  #mono
   #compositions
   #dependencies
   #registry
   #process
-  #extensionComponents = []
+  #image
 
-  constructor (context) {
+  constructor (context, options = {}) {
     this.#context = context
+    this.#root = options.root
+    this.#mono = options.mono === true
     this.#process = new Process()
 
     const imagesFactory = new ImagesFactory(context.name, context.runtime, context.registry)
 
-    this.#registry = new Registry(context.registry, imagesFactory, this.#process)
-    this.#compositions = context.compositions.map((composition) => this.#composition(composition))
+    this.#registry = new Registry(context.name, context.registry, imagesFactory, this.#process)
     this.#dependencies = this.#getDependencies()
+    this.#compositions = []
+
+    if (this.#mono)
+      this.#image = this.#registry.mono({
+        components: context.components
+      }, this.#root)
+    else
+      this.#compositions = context.compositions.map((composition) => this.#composition(composition))
   }
 
   operator () {
-    const deployment = new Deployment(this.#context, this.#compositions, this.#dependencies, this.#process)
+    const deployment = new Deployment(
+      this.#context,
+      this.#compositions,
+      this.#dependencies,
+      this.#process,
+      this.#image
+    )
 
     return new Operator(deployment, this.#registry)
   }
@@ -71,7 +88,8 @@ class Factory {
     const dependency = module.deployment(instances, annotation)
 
     /** @type {toa.deployment.Service[]} */
-    const services = dependency.services?.map((service) => this.#service(path, service))
+    const services = dependency.services?.map((service) =>
+      this.#mono ? service : this.#service(path, service))
 
     return { ...dependency, services }
   }
@@ -87,10 +105,10 @@ class Factory {
     return new Service(service, image)
   }
 
-  static async create (path, environment) {
+  static async create (path, environment, options = {}) {
     const context = await load(path, environment)
 
-    return new Factory(context)
+    return new Factory(context, { ...options, root: path })
   }
 }
 

package/src/deployment/images/composition.Dockerfile

@@ -5,7 +5,6 @@ FROM {{build.image}}
 ENV NODE_ENV=production
 RUN if [ "{{runtime.registry}}" != "" ]; then npm set registry {{runtime.registry}}; fi
 RUN if [ "{{runtime.proxy}}" != "" ]; then npm set proxy {{runtime.proxy}}; fi
-RUN npm i -g @toa.io/runtime@{{runtime.version}} --omit=dev
 
 WORKDIR /composition
 COPY --chown=node:node . /composition
@@ -13,7 +12,8 @@ COPY --chown=node:node . /composition
 {{build.run}}
 
 # run 'npm i' in each component
-RUN for entry in *; do if [ -f "$entry/package.json" ]; then (cd $entry && npm i --omit=dev); fi; done
+RUN --mount=type=cache,target=/root/.npm \
+  for entry in *; do if [ -f "$entry/package.json" ]; then (cd $entry && npm i --omit=dev); fi; done
 
 USER node
 CMD toa compose *

package/src/deployment/images/composition.js

@@ -5,6 +5,7 @@ const fs = require('fs-extra')
 const { createHash } = require('node:crypto')
 
 const { Image } = require('./image')
+const { undef } = require('@toa.io/concise/source/expressions/undefined')
 
 class Composition extends Image {
   dockerfile = join(__dirname, 'composition.Dockerfile')
@@ -37,11 +38,7 @@ class Composition extends Image {
   }
 
   get base () {
-    if (this.#image !== undefined) {
-      return this.#image
-    }
-
-    let image = null
+    let image = this.#image
 
     for (const component of this.#components) {
       const value = component.build?.image
@@ -53,7 +50,20 @@ class Composition extends Image {
       image = value
     }
 
-    return image ?? undefined
+    return image
+  }
+
+  get run () {
+    const commands = []
+
+    for (const component of this.#components) {
+      const run = component.build?.run
+
+      if (run !== undefined)
+        commands.push(run)
+    }
+
+    return commands.join('\n')
   }
 
   async prepare (root) {

package/src/deployment/images/factory.js

@@ -2,10 +2,8 @@
 
 const { Composition } = require('./composition')
 const { Service } = require('./service')
+const { Mono } = require('./mono')
 
-/**
- * @implements {toa.deployment.images.Factory}
- */
 class Factory {
   /** @type {string} */
   #scope
@@ -48,6 +46,17 @@ class Factory {
 
     return instance
   }
+
+  /**
+   * @returns {Mono}
+   */
+  mono (composition, root) {
+    const instance = new Mono(this.#scope, this.#runtime, this.#registry, composition, root)
+
+    instance.tag()
+
+    return instance
+  }
 }
 
 exports.Factory = Factory

package/src/deployment/images/image.js

@@ -26,9 +26,7 @@ class Image {
   #registry
   #runtime
   #values = {
-    build: {
-      image: 'node:20.9.0-alpine3.18'
-    }
+    build: {}
   }
 
   constructor (scope, runtime, registry) {
@@ -54,6 +52,8 @@ class Image {
 
   get base () {}
 
+  get run () {}
+
   async prepare (root) {
     if (this.dockerfile === undefined) throw new Error('Dockerfile isn\'t specified')
 
@@ -65,7 +65,7 @@ class Image {
 
     const template = await read(this.dockerfile, 'utf-8')
     const contents = template.replace(/{{(\S{1,32})}}/g, (_, key) => this.#value(key))
-    const ignore = 'Dockerfile'
+    const ignore = ['Dockerfile', '**/node_modules'].join('\r\n')
 
     await write(join(path, 'Dockerfile'), contents)
     await write(join(path, '.dockerignore'), ignore)
@@ -77,13 +77,19 @@ class Image {
 
   #setValues () {
     this.#values.runtime = this.#runtime
-    this.#values.build = overwrite(this.#values.build, this.#registry.build)
+    this.#values.build = overwrite({
+      image: `${RUNTIME_IMAGE}:${this.#runtime.version}`
+    }, this.#registry.build)
 
     const image = this.base
 
-    if (image !== undefined) {
+    if (image !== undefined)
       this.#values.build.image = image
-    }
+
+    const run = this.run
+
+    if (run !== undefined)
+      this.#values.build.run = (this.#values.build.run === undefined ? '' : this.#values.build.run + '\n') + run
 
     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)
@@ -121,4 +127,7 @@ function createArguments (variables) {
   return args.join('\n')
 }
 
+const RUNTIME_IMAGE = 'ghcr.io/toa-io/runtime'
+
 exports.Image = Image
+exports.RUNTIME_IMAGE = RUNTIME_IMAGE

package/src/deployment/images/mono.Dockerfile

@@ -0,0 +1,18 @@
+FROM {{build.image}}
+
+{{build.arguments}}
+
+ENV NODE_ENV=production
+RUN if [ "{{runtime.registry}}" != "" ]; then npm set registry {{runtime.registry}}; fi
+RUN if [ "{{runtime.proxy}}" != "" ]; then npm set proxy {{runtime.proxy}}; fi
+
+WORKDIR /composition
+COPY --chown=node:node . /composition
+
+{{build.run}}
+
+RUN --mount=type=cache,target=/root/.npm \
+  for entry in components/*; do if [ -f "$entry/package.json" ]; then (cd $entry && npm i --omit=dev); fi; done
+
+USER node
+CMD toa mono .

package/src/deployment/images/mono.js

@@ -0,0 +1,82 @@
+'use strict'
+
+const { join } = require('node:path')
+const fs = require('fs-extra')
+const { createHash } = require('node:crypto')
+
+const { Image } = require('./image')
+
+class Mono extends Image {
+  dockerfile = join(__dirname, 'mono.Dockerfile')
+
+  #root
+  #image
+  #components
+
+  constructor (scope, runtime, registry, composition, root) {
+    super(scope, runtime, registry)
+
+    this.#root = root
+    this.#image = composition.image
+    this.#components = composition.components
+  }
+
+  get name () {
+    return 'mono'
+  }
+
+  get 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 () {
+    let image = this.#image
+
+    for (const component of this.#components) {
+      const value = component.build?.image
+
+      if (image !== null && image !== value)
+        throw new Error('Mono deployment requires different base images for its components. Specify base image for the composition in the context.')
+
+      image = value
+    }
+
+    return image
+  }
+
+  get run () {
+    const commands = []
+
+    for (const component of this.#components) {
+      const run = component.build?.run
+
+      if (run !== undefined)
+        commands.push(run)
+    }
+
+    return commands.join('\n')
+  }
+
+  async prepare (root) {
+    const context = await super.prepare(root)
+
+    await fs.copy(join(this.#root, CONTEXT), join(context, CONTEXT))
+    await fs.ensureDir(join(context, 'components'))
+
+    for (const component of this.#components)
+      await fs.copy(component.path, join(context, 'components', component.locator.label))
+
+    return context
+  }
+}
+
+const CONTEXT = 'context.toa.yaml'
+
+exports.Mono = Mono

package/src/deployment/images/runtime-base.test.js

@@ -0,0 +1,90 @@
+'use strict'
+
+const { join } = require('node:path')
+const { readFile } = require('node:fs/promises')
+const { directory } = require('@toa.io/filesystem')
+
+const { Image, RUNTIME_IMAGE } = require('./image')
+
+const compositionDockerfile = join(__dirname, 'composition.Dockerfile')
+const serviceDockerfile = join(__dirname, 'service.Dockerfile')
+
+class TestImage extends Image {
+  dockerfile
+
+  #name
+  #base
+
+  constructor (runtime, registry, dockerfile, name = 'test', base) {
+    super('acme', runtime, registry)
+
+    this.dockerfile = dockerfile
+    this.#name = name
+    this.#base = base
+  }
+
+  get name () {
+    return this.#name
+  }
+
+  get version () {
+    return 'abcdef12'
+  }
+
+  get base () {
+    return this.#base
+  }
+}
+
+describe('runtime base image', () => {
+  /** @type {string} */
+  let root
+
+  beforeEach(async () => {
+    root = await directory.temp('toa-runtime-base-test')
+  })
+
+  it('should default build.image to version-pinned GHCR runtime image', async () => {
+    const runtime = { version: '1.0.0-alpha.232' }
+    const image = new TestImage(runtime, {}, compositionDockerfile)
+
+    const path = await image.prepare(root)
+    const dockerfile = await readFile(join(path, 'Dockerfile'), 'utf8')
+
+    expect(dockerfile).toContain(`FROM ${RUNTIME_IMAGE}:1.0.0-alpha.232`)
+    expect(dockerfile).not.toMatch(/npm i -g @toa\.io\/runtime/)
+  })
+
+  it('should not install runtime in service Dockerfile template', async () => {
+    const runtime = { version: '1.0.0-alpha.99' }
+    const image = new TestImage(runtime, {}, serviceDockerfile, 'service-test')
+
+    const path = await image.prepare(root)
+    const dockerfile = await readFile(join(path, 'Dockerfile'), 'utf8')
+
+    expect(dockerfile).toContain(`FROM ${RUNTIME_IMAGE}:1.0.0-alpha.99`)
+    expect(dockerfile).not.toMatch(/npm i -g @toa\.io\/runtime/)
+  })
+
+  it('should allow registry.build.image override', async () => {
+    const runtime = { version: '1.0.0-alpha.232' }
+    const registry = { build: { image: 'node:24.14.0-alpine3.22' } }
+    const image = new TestImage(runtime, registry, compositionDockerfile)
+
+    const path = await image.prepare(root)
+    const dockerfile = await readFile(join(path, 'Dockerfile'), 'utf8')
+
+    expect(dockerfile).toContain('FROM node:24.14.0-alpine3.22')
+    expect(dockerfile).not.toContain(RUNTIME_IMAGE)
+  })
+
+  it('should allow composition.image override via base', async () => {
+    const runtime = { version: '1.0.0-alpha.232' }
+    const image = new TestImage(runtime, {}, compositionDockerfile, 'mono', 'custom.example/base:1')
+
+    const path = await image.prepare(root)
+    const dockerfile = await readFile(join(path, 'Dockerfile'), 'utf8')
+
+    expect(dockerfile).toContain('FROM custom.example/base:1')
+  })
+})

package/src/deployment/images/service.Dockerfile

@@ -1,14 +1,14 @@
-FROM node:20.9.0-alpine3.18
+FROM {{build.image}}
 
 ENV NODE_ENV=production
 RUN if [ "{{runtime.registry}}" != "" ]; then npm set registry {{runtime.registry}}; fi
 RUN if [ "{{runtime.proxy}}" != "" ]; then npm set proxy {{runtime.proxy}}; fi
-RUN npm i -g @toa.io/runtime@{{runtime.version}} --omit=dev
 
 WORKDIR /service
 COPY --chown=node:node . /service
 
-RUN npm i --omit=dev
+RUN --mount=type=cache,target=/root/.npm \
+  npm i --omit=dev
 
 USER node
 CMD toa serve .

package/src/deployment/operator.js

@@ -50,6 +50,10 @@ class Operator {
   variables () {
     return this.#deployment.variables()
   }
+
+  tags () {
+    return this.#registry.tags()
+  }
 }
 
 /** @type {toa.deployment.installation.Options} */

package/src/deployment/registry.js

@@ -1,12 +1,14 @@
 'use strict'
 
+const { posix } = require('node:path')
 const workspace = require('./workspace')
-const { newid } = require('@toa.io/generic')
 
 /**
  * @implements {toa.deployment.Registry}
  */
 class Registry {
+  #scope
+
   #registry
 
   #factory
@@ -15,7 +17,11 @@ class Registry {
 
   #images = []
 
-  constructor (registry, factory, process) {
+  /** @type {string | undefined} */
+  #builder
+
+  constructor (scope, registry, factory, process) {
+    this.#scope = scope
     this.#registry = registry
     this.#factory = factory
     this.#process = process
@@ -29,6 +35,10 @@ class Registry {
     return this.#create('service', path, service)
   }
 
+  mono (composition, root) {
+    return this.#create('mono', composition, root)
+  }
+
   async prepare (root) {
     const path = await workspace.create('images', root)
 
@@ -40,9 +50,8 @@ class Registry {
   async build () {
     await this.prepare()
 
-    for (const image of this.#images) {
+    for (const image of this.#images)
       await this.#build(image)
-    }
   }
 
   async push () {
@@ -51,8 +60,12 @@ class Registry {
     for (const image of this.#images) await this.#push(image)
   }
 
+  tags () {
+    return this.#images.map((image) => image.reference)
+  }
+
   /**
-   * @param {'composition' | 'service'} type
+   * @param {'composition' | 'service' | 'mono'} type
    * @param {...any} args
    * @returns {toa.deployment.images.Image}
    */
@@ -70,13 +83,17 @@ class Registry {
    * @returns {Promise<void>}
    */
   async #build (image, push = false) {
+    if (await this.exists(image.reference)) {
+      console.log('Image already exists, skipping:', image.reference)
+      return
+    }
+
     const args = ['--context=default', 'buildx', 'build']
 
-    if (push) {
+    if (push)
       args.push('--push')
-    } else {
+    else
       args.push('--load')
-    }
 
     args.push('--tag', image.reference, image.context)
 
@@ -88,14 +105,15 @@ class Registry {
 
     if (multiarch) {
       const platform = this.#registry.platforms.join(',')
-      const builder = await this.#createBuilder()
+      const builder = await this.#ensureBuilder()
 
       args.push('--platform', platform)
       args.push('--builder', builder)
 
-    } else {
+      if (this.#registry.base !== undefined)
+        this.#appendCache(args)
+    } else
       args.push('--builder', 'default')
-    }
 
     args.push('--progress', 'plain')
 
@@ -106,13 +124,43 @@ class Registry {
     await this.#build(image, true)
   }
 
-  async #createBuilder () {
-    const name = `toa-${newid()}`
-    const create = `buildx create --name ${name} --bootstrap --use`.split(' ')
+  async exists (tag) {
+    const args = ['manifest', 'inspect', tag]
+
+    try {
+      await this.#process.execute('docker', args, { silently: true })
+    } catch (error) {
+      console.log(error.message)
+
+      return false
+    }
+
+    return true
+  }
+
+  async #ensureBuilder () {
+    if (this.#builder !== undefined)
+      return this.#builder
+
+    try {
+      await this.#process.execute('docker', ['buildx', 'inspect', BUILDER], { silently: true })
+    } catch {
+      await this.#process.execute('docker', ['buildx', 'create', '--name', BUILDER, '--bootstrap'])
+    }
+
+    this.#builder = BUILDER
+
+    return BUILDER
+  }
 
-    await this.#process.execute('docker', create)
+  /**
+   * @param {string[]} args
+   */
+  #appendCache (args) {
+    const ref = posix.join(this.#registry.base, this.#scope, 'buildcache')
 
-    return name
+    args.push('--cache-from', `type=registry,ref=${ref}`)
+    args.push('--cache-to', `type=registry,ref=${ref},mode=max,image-manifest=true`)
   }
 }