@toa.io/operations 1.0.0-alpha.284 → 1.0.0-alpha.286

package/src/deployment/deployment.js

@@ -11,7 +11,7 @@ export class Deployment {
   #process
   #target
 
-  constructor (context, compositions, dependencies, process, image) {
+  constructor(context, compositions, dependencies, process, image) {
     const dependency = merge(dependencies)
 
     this.#chart = declare(context, dependency)
@@ -19,7 +19,7 @@ export class Deployment {
     this.#process = process
   }
 
-  async export (target) {
+  async export(target) {
     const chart = dump(this.#chart)
     const values = dump(this.#values)
 
@@ -32,9 +32,9 @@ export class Deployment {
     this.#target = target
   }
 
-  async install (options) {
+  async install(options) {
     if (options.target) this.#target = options.target
-    if (this.#target === undefined) throw new Error('Deployment hasn\'t been exported')
+    if (this.#target === undefined) throw new Error("Deployment hasn't been exported")
 
     const args = []
 
@@ -42,25 +42,46 @@ export class Deployment {
     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])
+    await this.#update()
+    await this.#process.execute('helm', [
+      'upgrade',
+      this.#chart.name,
+      '-i',
+      ...args,
+      this.#target
+    ])
   }
 
-  async template (options) {
-    if (this.#target === undefined) throw new Error('Deployment hasn\'t been exported')
+  async template(options) {
+    if (this.#target === undefined) throw new Error("Deployment hasn't been exported")
 
-    await this.#process.execute('helm', ['dependency', 'update', this.#target], { silently: true })
+    await this.#update({ silently: true })
 
     const args = []
 
     if (options.namespace !== undefined) args.push('-n', options.namespace)
 
-    return await this.#process.execute('helm',
+    return await this.#process.execute(
+      'helm',
       ['template', this.#chart.name, ...args, this.#target],
-      { silently: true })
+      { silently: true }
+    )
+  }
+
+  /**
+   * A chart with no subcharts has nothing to resolve, and the call still reaches out for
+   * the repositories it would have read.
+   *
+   * @param {object} [options]
+   * @returns {Promise<void>}
+   */
+  async #update(options = {}) {
+    if (this.#chart.dependencies.length === 0) return
+
+    await this.#process.execute('helm', ['dependency', 'update', this.#target], options)
   }
 
-  variables () {
+  variables() {
     const variables = []
     const used = new Set()
 
@@ -74,7 +95,7 @@ export class Deployment {
   }
 }
 
-function addVariables (list, variables, used = new Set()) {
+function addVariables(list, variables, used = new Set()) {
   for (const item of list) {
     if (item.variables === undefined) continue
 
@@ -89,9 +110,7 @@ function addVariables (list, variables, used = new Set()) {
 
 const TEMPLATES = join(import.meta.dirname, 'chart/templates')
 
-
-
-function dump (object) {
+function dump(object) {
   // js-yaml writes plain objects only, and the values carry locators and images
   return jsyaml.dump(JSON.parse(JSON.stringify(object)), { noRefs: true, lineWidth: -1 })
 }

package/src/deployment/factory.js

@@ -29,14 +29,18 @@ export class Factory {
    *  @type {Map<string, string[]>} */
   #claims
 
-  constructor (context, options = {}) {
+  constructor(context, options = {}) {
     this.#context = context
     this.#mono = options.mono === true
     this.#process = new Process()
 
-    const imagesFactory = new ImagesFactory(context.name, context.runtime, context.registry)
+    const imagesFactory = new ImagesFactory(
+      context.name,
+      context.runtime,
+      context.registry
+    )
 
-    this.#registry = new Registry(context.name, context.registry, imagesFactory, this.#process)
+    this.#registry = new Registry(context.registry, imagesFactory, this.#process)
     this.#claims = claims(context)
     this.#dependencies = this.#getDependencies()
     this.#compositions = []
@@ -46,10 +50,12 @@ export class Factory {
         components: context.components
       })
     else
-      this.#compositions = context.compositions.map((composition) => this.#composition(composition))
+      this.#compositions = context.compositions.map((composition) =>
+        this.#composition(composition)
+      )
   }
 
-  async operator () {
+  async operator() {
     const deployment = new Deployment(
       this.#context,
       this.#compositions,
@@ -62,17 +68,17 @@ export class Factory {
     return new Operator(deployment, this.#registry)
   }
 
-  registry () {
+  registry() {
     return this.#registry
   }
 
-  #composition (composition) {
+  #composition(composition) {
     const image = this.#registry.composition(composition)
 
     return new Composition(composition, image)
   }
 
-  async #getDependencies () {
+  async #getDependencies() {
     /** @type {toa.deployment.Dependency[]} */
     const dependencies = []
 
@@ -95,17 +101,21 @@ export class Factory {
     // point where a reference that yields nothing can be told from one that yields a service
     for (const [reference, compositions] of this.#claims)
       if (!contributing.has(reference))
-        throw new Error(`Composition '${compositions[0]}' lists '${reference}', ` +
-          'which contributes no service.')
+        throw new Error(
+          `Composition '${compositions[0]}' lists '${reference}', ` +
+            'which contributes no service.'
+        )
 
     return dependencies
   }
 
-  async #getDependency (reference, instances) {
+  async #getDependency(reference, instances) {
     // a dependency may be named the way a package is or written as a directory,
     // and a module is loaded by file
     const module = await import(pathToFileURL(require.resolve(reference)).href)
-    const pkg = JSON.parse(readFileSync(require.resolve(join(reference, 'package.json')), 'utf8'))
+    const pkg = JSON.parse(
+      readFileSync(require.resolve(join(reference, 'package.json')), 'utf8')
+    )
 
     if (module.deployment === undefined) return
 
@@ -121,9 +131,10 @@ export class Factory {
     /** @type {toa.deployment.Service[]} */
     const services = dependency.services?.map((service) =>
       workload === undefined
-        ? this.#service(reference, service)   // its own deployment, its own image
-        // named the way `Service` would name it, since it skips that wrapper
-        : { ...service, name: `${service.group}-${service.name}`, workload })
+        ? this.#service(reference, service) // its own deployment, its own image
+        : // named the way `Service` would name it, since it skips that wrapper
+          { ...service, name: `${service.group}-${service.name}`, workload }
+    )
 
     return { ...dependency, services }
   }
@@ -133,13 +144,20 @@ export class Factory {
    * @param service {toa.deployment.dependency.Service}
    * @returns {Service}
    */
-  #service (path, service) {
-    const image = this.#registry.service(path, service)
+  #service(path, service) {
+    // an extension that publishes its service's image is taken at its word: nothing is
+    // added to the registry, so nothing is prepared, probed, built or pushed for it
+    const published =
+      service.image !== undefined && this.#context.registry?.services === PUBLISHED
+
+    const image = published
+      ? { reference: `${service.image}:${this.#context.runtime.version}` }
+      : this.#registry.service(path, service)
 
     return new Service(service, image)
   }
 
-  static async create (path, environment, options = {}) {
+  static async create(path, environment, options = {}) {
     const context = await load(path, environment)
 
     return new Factory(context, options)
@@ -148,11 +166,13 @@ export class Factory {
 
 const MONO = 'mono'
 
+const PUBLISHED = 'published'
+
 /**
  * @param {toa.norm.Context} context
  * @returns {Map<string, string[]>}
  */
-function claims (context) {
+function claims(context) {
   const map = new Map()
 
   for (const composition of context.compositions ?? [])

package/src/deployment/images/composition.Dockerfile

@@ -12,7 +12,7 @@ COPY --chown=node:node . /composition
 {{build.run}}
 
 # run 'npm i' in each component
-RUN --mount=type=cache,target=/root/.npm \
+RUN --mount=type=cache,target=/root/.npm,sharing=locked \
   for entry in *; do if grep -qs '"dependencies"' "$entry/package.json"; then (cd $entry && npm i --omit=dev); fi; done
 
 USER node

package/src/deployment/images/composition.js

@@ -12,7 +12,7 @@ export class Composition extends Image {
   #image
   #components
 
-  constructor (scope, runtime, registry, composition) {
+  constructor(scope, runtime, registry, composition) {
     super(scope, runtime, registry)
 
     this.#name = composition.name
@@ -20,11 +20,11 @@ export class Composition extends Image {
     this.#components = composition.components
   }
 
-  get name () {
+  get name() {
     return 'composition-' + this.#name
   }
 
-  get version () {
+  get version() {
     const hash = createHash('sha256')
 
     for (const component of this.#components) {
@@ -35,31 +35,32 @@ export class Composition extends Image {
     return hash.digest('hex').slice(0, 8)
   }
 
-  get base () {
+  get base() {
     if (this.#image !== undefined) return this.#image
 
     const images = new Set(this.#components.map((component) => component.build?.image))
 
     if (images.size > 1)
-      throw new Error(`Composition '${this.#name}' requires different base images for its components. Specify base image for the composition in the context.`)
+      throw new Error(
+        `Composition '${this.#name}' requires different base images for its components. Specify base image for the composition in the context.`
+      )
 
     return images.values().next().value
   }
 
-  get run () {
+  get run() {
     const commands = []
 
     for (const component of this.#components) {
       const run = component.build?.run
 
-      if (run !== undefined)
-        commands.push(run)
+      if (run !== undefined) commands.push(run)
     }
 
     return commands.join('\n')
   }
 
-  async prepare (root) {
+  async prepare(root) {
     const context = await super.prepare(root)
 
     for (const component of this.#components) {

package/src/deployment/images/factory.js

@@ -17,7 +17,7 @@ export class Factory {
    * @param {toa.norm.context.Runtime} runtime
    * @param {toa.norm.context.Registry} registry
    */
-  constructor (scope, runtime, registry) {
+  constructor(scope, runtime, registry) {
     this.#scope = scope
     this.#runtime = runtime
     this.#registry = registry
@@ -26,8 +26,13 @@ export class Factory {
   /**
    * @returns {Composition}
    */
-  composition (composition) {
-    const instance = new Composition(this.#scope, this.#runtime, this.#registry, composition)
+  composition(composition) {
+    const instance = new Composition(
+      this.#scope,
+      this.#runtime,
+      this.#registry,
+      composition
+    )
 
     instance.tag()
 
@@ -37,8 +42,14 @@ export class Factory {
   /**
    * @returns {Service}
    */
-  service (path, service) {
-    const instance = new Service(this.#scope, this.#runtime, this.#registry, path, service)
+  service(path, service) {
+    const instance = new Service(
+      this.#scope,
+      this.#runtime,
+      this.#registry,
+      path,
+      service
+    )
 
     instance.tag()
 
@@ -48,7 +59,7 @@ export class Factory {
   /**
    * @returns {Mono}
    */
-  mono (composition) {
+  mono(composition) {
     const instance = new Mono(this.#scope, this.#runtime, this.#registry, composition)
 
     instance.tag()

package/src/deployment/images/format.js

@@ -14,11 +14,13 @@ import { dirname, join, parse } from 'node:path'
  * @param {string} target where it was copied
  * @param {string} name
  */
-export async function declare (source, target, name) {
+export async function declare(source, target, name) {
   if (existsSync(join(target, MANIFEST))) return
 
-  await writeFile(join(target, MANIFEST),
-    JSON.stringify({ name, private: true, type: format(source) }, null, 2) + '\n')
+  await writeFile(
+    join(target, MANIFEST),
+    JSON.stringify({ name, private: true, type: format(source) }, null, 2) + '\n'
+  )
 }
 
 /**
@@ -28,7 +30,7 @@ export async function declare (source, target, name) {
  * @param {string} directory
  * @returns {'module' | 'commonjs'}
  */
-export function format (directory) {
+export function format(directory) {
   const { root } = parse(directory)
 
   let current = directory
@@ -37,7 +39,9 @@ export function format (directory) {
     const manifest = join(current, MANIFEST)
 
     if (existsSync(manifest))
-      return JSON.parse(readFileSync(manifest, 'utf8')).type === 'module' ? 'module' : 'commonjs'
+      return JSON.parse(readFileSync(manifest, 'utf8')).type === 'module'
+        ? 'module'
+        : 'commonjs'
 
     current = dirname(current)
   }

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

@@ -8,11 +8,11 @@ const name = generate()
  * @implements {toa.deployment.images.Image}
  */
 class Class extends Image {
-  get name () {
+  get name() {
     return name
   }
 
-  get version () {
+  get version() {
     return version
   }
 }

package/src/deployment/images/image.js

@@ -21,13 +21,13 @@ export class Image {
     build: {}
   }
 
-  constructor (scope, runtime, registry) {
+  constructor(scope, runtime, registry) {
     this.#scope = scope
     this.#registry = registry
     this.#runtime = runtime
   }
 
-  tag () {
+  tag() {
     const hash = createHash('sha256')
 
     hash.update(this.#runtime.version)
@@ -35,25 +35,37 @@ export class Image {
 
     const tag = hash.digest('hex').slice(0, 8)
 
-    this.reference = posix.join(this.#registry.base ?? '', this.#scope, `${this.name}:${tag}`)
+    this.reference = posix.join(
+      this.#registry.base ?? '',
+      this.#scope,
+      `${this.name}:${tag}`
+    )
   }
 
   /** @returns {string | undefined} */
-  get name () { return undefined }
+  get name() {
+    return undefined
+  }
 
   /** @returns {string | undefined} */
-  get version () { return undefined }
+  get version() {
+    return undefined
+  }
 
   /** The image to build `FROM`. Undefined takes the runtime's, which is what a service does.
    *  @returns {string | undefined} */
-  get base () { return undefined }
+  get base() {
+    return undefined
+  }
 
   /** Build commands to add. Undefined adds none, which is what a service does.
    *  @returns {string | undefined} */
-  get run () { return undefined }
+  get run() {
+    return undefined
+  }
 
-  async prepare (root) {
-    if (this.dockerfile === undefined) throw new Error('Dockerfile isn\'t specified')
+  async prepare(root) {
+    if (this.dockerfile === undefined) throw new Error("Dockerfile isn't specified")
 
     this.#setValues()
 
@@ -73,38 +85,43 @@ export class Image {
     return path
   }
 
-  #setValues () {
+  #setValues() {
     this.#values.runtime = this.#runtime
-    this.#values.build = overwrite({
-      image: `${RUNTIME_IMAGE}:${this.#runtime.version}`
-    }, this.#registry.build)
+    this.#values.build = overwrite(
+      {
+        image: `${RUNTIME_IMAGE}:${this.#runtime.version}`
+      },
+      this.#registry.build
+    )
 
     const image = this.base
 
-    if (image !== undefined)
-      this.#values.build.image = image
+    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
+      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)
+    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)
   }
 
   /**
    * @param key {string}
    * @returns {string}
    */
-  #value (key) {
+  #value(key) {
     const [source, property] = key.split('.')
 
     return this.#values[source]?.[property] ?? ''
   }
 }
 
-function createRunCommands (input) {
+function createRunCommands(input) {
   const lines = input.split('\n')
 
   return lines.reduce((commands, command) => {
@@ -114,7 +131,7 @@ function createRunCommands (input) {
   }, '')
 }
 
-function createArguments (variables) {
+function createArguments(variables) {
   const args = []
 
   for (const variable of variables) {

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

@@ -14,11 +14,16 @@ beforeEach(() => {
 it('should assign url', () => {
   instance.tag()
 
-  assert.deepStrictEqual(instance.reference, `${fixtures.registry.base}/${fixtures.scope}/${fixtures.name}:${fixtures.version}`)
+  assert.deepStrictEqual(
+    instance.reference,
+    `${fixtures.registry.base}/${fixtures.scope}/${fixtures.name}:${fixtures.version}`
+  )
 })
 
 describe('prepare', () => {
   it('should throw error if no dockerfile specified', async () => {
-    await assert.rejects(instance.prepare(generate()), (error) => /Dockerfile isn't specified/.test(error.message))
+    await assert.rejects(instance.prepare(generate()), (error) =>
+      /Dockerfile isn't specified/.test(error.message)
+    )
   })
 })

package/src/deployment/images/mono.Dockerfile

@@ -11,7 +11,7 @@ COPY --chown=node:node . /composition
 
 {{build.run}}
 
-RUN --mount=type=cache,target=/root/.npm \
+RUN --mount=type=cache,target=/root/.npm,sharing=locked \
   for entry in *; do if grep -qs '"dependencies"' "$entry/package.json"; then (cd $entry && npm i --omit=dev); fi; done
 
 USER node

package/src/deployment/images/mono.js

@@ -11,18 +11,18 @@ export class Mono extends Image {
   #image
   #components
 
-  constructor (scope, runtime, registry, composition) {
+  constructor(scope, runtime, registry, composition) {
     super(scope, runtime, registry)
 
     this.#image = composition.image
     this.#components = composition.components
   }
 
-  get name () {
+  get name() {
     return 'mono'
   }
 
-  get version () {
+  get version() {
     const hash = createHash('sha256')
 
     for (const component of this.#components) {
@@ -33,31 +33,32 @@ export class Mono extends Image {
     return hash.digest('hex').slice(0, 8)
   }
 
-  get base () {
+  get base() {
     if (this.#image !== undefined) return this.#image
 
     const images = new Set(this.#components.map((component) => component.build?.image))
 
     if (images.size > 1)
-      throw new Error('Mono deployment requires different base images for its components. Specify base image for the composition in the context.')
+      throw new Error(
+        'Mono deployment requires different base images for its components. Specify base image for the composition in the context.'
+      )
 
     return images.values().next().value
   }
 
-  get run () {
+  get run() {
     const commands = []
 
     for (const component of this.#components) {
       const run = component.build?.run
 
-      if (run !== undefined)
-        commands.push(run)
+      if (run !== undefined) commands.push(run)
     }
 
     return commands.join('\n')
   }
 
-  async prepare (root) {
+  async prepare(root) {
     const context = await super.prepare(root)
 
     for (const component of this.#components) {