@toa.io/operations 1.0.0-alpha.274 → 1.0.0-alpha.277

package/src/deployment/images/factory.js

@@ -1,10 +1,8 @@
-'use strict'
+import { Composition } from './composition.js'
+import { Service } from './service.js'
+import { Mono } from './mono.js'
 
-const { Composition } = require('./composition')
-const { Service } = require('./service')
-const { Mono } = require('./mono')
-
-class Factory {
+export class Factory {
   /** @type {string} */
   #scope
 
@@ -58,5 +56,3 @@ class Factory {
     return instance
   }
 }
-
-exports.Factory = Factory

package/src/deployment/images/format.js

@@ -0,0 +1,48 @@
+import { existsSync, readFileSync } from 'node:fs'
+import { writeFile } from 'node:fs/promises'
+import { dirname, join, parse } from 'node:path'
+
+/**
+ * A component is copied into the image on its own, away from the package that
+ * declared what its files are. Node reads a `.js` as CommonJS unless a manifest
+ * beside it says otherwise, so the one the component was written under is
+ * restated where it lands.
+ *
+ * A component that ships its own manifest already says so, and is left alone.
+ *
+ * @param {string} source the component in the workspace
+ * @param {string} target where it was copied
+ * @param {string} 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')
+}
+
+/**
+ * The module format a directory's files are read as, which the nearest manifest
+ * above it decides.
+ *
+ * @param {string} directory
+ * @returns {'module' | 'commonjs'}
+ */
+export function format (directory) {
+  const { root } = parse(directory)
+
+  let current = directory
+
+  while (current !== root) {
+    const manifest = join(current, MANIFEST)
+
+    if (existsSync(manifest))
+      return JSON.parse(readFileSync(manifest, 'utf8')).type === 'module' ? 'module' : 'commonjs'
+
+    current = dirname(current)
+  }
+
+  return 'commonjs'
+}
+
+const MANIFEST = 'package.json'

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

@@ -0,0 +1,74 @@
+import { it, describe, before, after } from 'node:test'
+import assert from 'node:assert/strict'
+import { mkdtemp, mkdir, writeFile, readFile, rm } from 'node:fs/promises'
+import { tmpdir } from 'node:os'
+import { join } from 'node:path'
+
+import { declare, format } from './format.js'
+
+let root
+
+before(async () => {
+  root = await mkdtemp(join(tmpdir(), 'format-'))
+})
+
+after(async () => {
+  await rm(root, { recursive: true, force: true })
+})
+
+describe('format', () => {
+  it('should read the nearest manifest above', async () => {
+    const workspace = join(root, 'modules')
+    const component = join(workspace, 'components', 'one')
+
+    await mkdir(component, { recursive: true })
+    await writeFile(join(workspace, 'package.json'), JSON.stringify({ type: 'module' }))
+
+    assert.strictEqual(format(component), 'module')
+  })
+
+  it('should default to commonjs', async () => {
+    const workspace = join(root, 'scripts')
+    const component = join(workspace, 'components', 'one')
+
+    await mkdir(component, { recursive: true })
+    await writeFile(join(workspace, 'package.json'), JSON.stringify({ name: 'scripts' }))
+
+    assert.strictEqual(format(component), 'commonjs')
+  })
+})
+
+describe('declare', () => {
+  it('should state the format the component was written under', async () => {
+    const workspace = join(root, 'stated')
+    const source = join(workspace, 'components', 'one')
+    const target = join(root, 'image', 'one')
+
+    await mkdir(source, { recursive: true })
+    await mkdir(target, { recursive: true })
+    await writeFile(join(workspace, 'package.json'), JSON.stringify({ type: 'module' }))
+
+    await declare(source, target, 'default-one')
+
+    const manifest = JSON.parse(await readFile(join(target, 'package.json'), 'utf8'))
+
+    assert.strictEqual(manifest.type, 'module')
+    assert.strictEqual(manifest.name, 'default-one')
+    assert.strictEqual(manifest.private, true)
+  })
+
+  it('should leave a manifest the component ships alone', async () => {
+    const source = join(root, 'own', 'components', 'one')
+    const target = join(root, 'image', 'own')
+
+    await mkdir(source, { recursive: true })
+    await mkdir(target, { recursive: true })
+
+    const own = JSON.stringify({ name: 'own', dependencies: { matchacho: '0.6.0' } })
+
+    await writeFile(join(target, 'package.json'), own)
+    await declare(source, target, 'default-own')
+
+    assert.strictEqual(await readFile(join(target, 'package.json'), 'utf8'), own)
+  })
+})

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

@@ -1,7 +1,5 @@
-'use strict'
-
-const { Image } = require('./image')
-const { generate } = require('randomstring')
+import { Image } from './image.js'
+import { generate } from 'randomstring'
 
 const version = '168b04ff'
 const name = generate()
@@ -29,10 +27,12 @@ const registry = {
   base: 'node:alpine'
 }
 
-exports.scope = generate()
-exports.name = name
-exports.version = 'ba2409fc'
-exports.Class = Class
-exports.runtime = runtime
-exports.registry = registry
-exports.process = process
+export const scope = generate()
+
+// distinct from the module's own `version` above
+const published = 'ba2409fc'
+
+// the fixture stands in for the global process
+const current = process
+
+export { name, Class, runtime, registry, current as process, published as version }

package/src/deployment/images/image.js

@@ -1,23 +1,15 @@
-'use strict'
+import { join, posix } from 'node:path'
+import { readFile as read, writeFile as write } from 'node:fs/promises'
+import { createHash } from 'node:crypto'
 
-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')
+import { overwrite } from '@toa.io/generic'
+import { mkdir } from 'node:fs/promises'
 
 /**
  * @implements {toa.deployment.images.Image}
  * @abstract
  */
-class Image {
+export class Image {
   context
   reference
   dockerfile
@@ -127,7 +119,4 @@ function createArguments (variables) {
   return args.join('\n')
 }
 
-const RUNTIME_IMAGE = 'ghcr.io/toa-io/runtime'
-
-exports.Image = Image
-exports.RUNTIME_IMAGE = RUNTIME_IMAGE
+export const RUNTIME_IMAGE = 'ghcr.io/toa-io/runtime'

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

@@ -1,7 +1,8 @@
-'use strict'
+import { describe, it, beforeEach } from 'node:test'
+import assert from 'node:assert/strict'
 
-const fixtures = require('./image.fixtures')
-const { generate } = require('randomstring')
+import * as fixtures from './image.fixtures.js'
+import { generate } from 'randomstring'
 
 /** @type {toa.deployment.images.Image} */
 let instance
@@ -13,11 +14,11 @@ beforeEach(() => {
 it('should assign url', () => {
   instance.tag()
 
-  expect(instance.reference).toEqual(`${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 expect(instance.prepare(generate())).rejects.toThrow(/Dockerfile isn't specified/)
+    await assert.rejects(instance.prepare(generate()), (error) => /Dockerfile isn't specified/.test(error.message))
   })
 })

package/src/deployment/images/index.js

@@ -1,5 +1 @@
-'use strict'
-
-const { Factory } = require('./factory')
-
-exports.Factory = Factory
+export { Factory } from './factory.js'

package/src/deployment/images/mono.Dockerfile

@@ -12,7 +12,7 @@ COPY --chown=node:node . /composition
 {{build.run}}
 
 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
+  for entry in *; do if grep -qs '"dependencies"' "$entry/package.json"; then (cd $entry && npm i --omit=dev); fi; done
 
 USER node
 CMD toa mono *

package/src/deployment/images/mono.js

@@ -1,13 +1,12 @@
-'use strict'
+import { join } from 'node:path'
+import fs from 'fs-extra'
+import { createHash } from 'node:crypto'
 
-const { join } = require('node:path')
-const fs = require('fs-extra')
-const { createHash } = require('node:crypto')
+import { Image } from './image.js'
+import { declare } from './format.js'
 
-const { Image } = require('./image')
-
-class Mono extends Image {
-  dockerfile = join(__dirname, 'mono.Dockerfile')
+export class Mono extends Image {
+  dockerfile = join(import.meta.dirname, 'mono.Dockerfile')
 
   #image
   #components
@@ -61,11 +60,13 @@ class Mono extends Image {
   async prepare (root) {
     const context = await super.prepare(root)
 
-    for (const component of this.#components)
-      await fs.copy(component.path, join(context, component.locator.label))
+    for (const component of this.#components) {
+      const target = join(context, component.locator.label)
+
+      await fs.copy(component.path, target)
+      await declare(component.path, target, component.locator.label)
+    }
 
     return context
   }
 }
-
-exports.Mono = Mono

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

@@ -1,13 +1,14 @@
-'use strict'
+import { describe, it, beforeEach } from 'node:test'
+import assert from 'node:assert/strict'
 
-const { join } = require('node:path')
-const { mkdtemp, readFile } = require('node:fs/promises')
-const { tmpdir } = require('node:os')
+import { join } from 'node:path'
+import { mkdtemp, readFile } from 'node:fs/promises'
+import { tmpdir } from 'node:os'
 
-const { Image, RUNTIME_IMAGE } = require('./image')
+import { Image, RUNTIME_IMAGE } from './image.js'
 
-const compositionDockerfile = join(__dirname, 'composition.Dockerfile')
-const serviceDockerfile = join(__dirname, 'service.Dockerfile')
+const compositionDockerfile = join(import.meta.dirname, 'composition.Dockerfile')
+const serviceDockerfile = join(import.meta.dirname, 'service.Dockerfile')
 
 class TestImage extends Image {
   dockerfile
@@ -51,8 +52,8 @@ describe('runtime base image', () => {
     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/)
+    assert.ok(dockerfile.includes(`FROM ${RUNTIME_IMAGE}:1.0.0-alpha.232`))
+    assert.doesNotMatch(dockerfile, /npm i -g @toa\.io\/runtime/)
   })
 
   it('should not install runtime in service Dockerfile template', async () => {
@@ -62,8 +63,8 @@ describe('runtime base image', () => {
     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/)
+    assert.ok(dockerfile.includes(`FROM ${RUNTIME_IMAGE}:1.0.0-alpha.99`))
+    assert.doesNotMatch(dockerfile, /npm i -g @toa\.io\/runtime/)
   })
 
   it('should allow registry.build.image override', async () => {
@@ -74,8 +75,8 @@ describe('runtime base image', () => {
     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)
+    assert.ok(dockerfile.includes('FROM node:24.14.0-alpine3.22'))
+    assert.ok(!(dockerfile.includes(RUNTIME_IMAGE)))
   })
 
   it('should allow composition.image override via base', async () => {
@@ -85,6 +86,6 @@ describe('runtime base image', () => {
     const path = await image.prepare(root)
     const dockerfile = await readFile(join(path, 'Dockerfile'), 'utf8')
 
-    expect(dockerfile).toContain('FROM custom.example/base:1')
+    assert.ok(dockerfile.includes('FROM custom.example/base:1'))
   })
 })

package/src/deployment/images/service.js

@@ -1,12 +1,14 @@
-'use strict'
+import { createRequire } from 'node:module'
+import { join, dirname } from 'node:path'
 
-const { join, dirname } = require('node:path')
+import { Image } from './image.js'
+import fs from 'fs-extra'
 
-const { Image } = require('./image')
-const fs = require('fs-extra')
+// a service is named the way a package is, and its directory is where it lives
+const require = createRequire(import.meta.url)
 
-class Service extends Image {
-  dockerfile = join(__dirname, 'service.Dockerfile')
+export class Service extends Image {
+  dockerfile = join(import.meta.dirname, 'service.Dockerfile')
 
   /**
    * Used by Dockerfile
@@ -70,5 +72,3 @@ class Service extends Image {
 const find = (reference) => {
   return dirname(require.resolve(join(reference, 'package.json')))
 }
-
-exports.Service = Service

package/src/deployment/index.js

@@ -1,5 +1 @@
-'use strict'
-
-const { Factory } = require('./factory')
-
-exports.Factory = Factory
+export { Factory } from './factory.js'

package/src/deployment/operator.js

@@ -1,8 +1,6 @@
-'use strict'
+import * as workspace from './workspace.js'
 
-const workspace = require('./workspace')
-
-class Operator {
+export class Operator {
   /** @type {toa.deployment.Deployment} */
   #deployment
 
@@ -58,5 +56,3 @@ class Operator {
 
 /** @type {toa.deployment.installation.Options} */
 const OPTIONS = { wait: false }
-
-exports.Operator = Operator

package/src/deployment/operator.test.js

@@ -1,10 +1,11 @@
-'use strict'
+import { describe, it, beforeEach, mock } from 'node:test'
+import assert from 'node:assert/strict'
 
-const { Operator } = require('../../src/deployment/operator')
-const { generate } = require('randomstring')
+import { Operator } from '../../src/deployment/operator.js'
+import { generate } from 'randomstring'
 
 it('should be', async () => {
-  expect(Operator).toBeInstanceOf(Function)
+  assert.ok(Operator instanceof Function)
 })
 
 /** @type {toa.deployment.Operator} */
@@ -25,7 +26,7 @@ describe('env', () => {
   it('should be', async () => {
     operator = new Operator(deployment, registry)
 
-    expect(operator.variables).toBeInstanceOf(Function)
+    assert.ok(operator.variables instanceof Function)
   })
 
   it('should return variables', async () => {
@@ -33,12 +34,12 @@ describe('env', () => {
 
     deployment.variables =
       /** @type {typeof toa.deployment.Operator.variables} */
-      jest.fn(() => variables)
+      mock.fn(() => variables)
 
     operator = new Operator(deployment, registry)
 
     const output = operator.variables()
 
-    expect(output).toStrictEqual(variables)
+    assert.deepStrictEqual(output, variables)
   })
 })

package/src/deployment/registry.js

@@ -1,12 +1,10 @@
-'use strict'
-
-const { posix } = require('node:path')
-const workspace = require('./workspace')
+import { posix } from 'node:path'
+import * as workspace from './workspace.js'
 
 /**
  * @implements {toa.deployment.Registry}
  */
-class Registry {
+export class Registry {
   #scope
 
   #registry
@@ -165,5 +163,3 @@ class Registry {
 }
 
 const BUILDER = 'toa'
-
-exports.Registry = Registry

package/src/deployment/registry.test.js

@@ -1,6 +1,8 @@
-'use strict'
+import { it, beforeEach, mock } from 'node:test'
+import assert from 'node:assert/strict'
+import { isDeepStrictEqual } from 'node:util'
 
-const { Registry } = require('./registry')
+import { Registry } from './registry.js'
 
 /** @type {toa.operations.Process} */
 let process
@@ -14,7 +16,7 @@ let images
 beforeEach(() => {
   images = []
   process = /** @type {toa.operations.Process} */ {
-    execute: jest.fn(async (cmd, args) => {
+    execute: mock.fn(async (cmd, args) => {
       if (args[0] === 'manifest')
         throw new Error('manifest unknown')
 
@@ -39,25 +41,25 @@ it('should reuse named builder across images', async () => {
 
   await registry.build()
 
-  const creates = process.execute.mock.calls.filter(([, args]) =>
+  const creates = process.execute.mock.calls.filter(({ arguments: [, args] }) =>
     args[0] === 'buildx' && args[1] === 'create')
 
-  expect(creates).toHaveLength(1)
-  expect(creates[0][1]).toEqual(['buildx', 'create', '--name', 'toa', '--bootstrap'])
+  assert.strictEqual(creates.length, 1)
+  assert.deepStrictEqual(creates[0].arguments[1], ['buildx', 'create', '--name', 'toa', '--bootstrap'])
 
-  const builds = process.execute.mock.calls.filter(([, args]) =>
+  const builds = process.execute.mock.calls.filter(({ arguments: [, args] }) =>
     args[0] === '--context=default' && args[1] === 'buildx' && args[2] === 'build')
 
-  expect(builds).toHaveLength(2)
+  assert.strictEqual(builds.length, 2)
 
-  for (const [, args] of builds) {
-    expect(args).toContain('--builder')
-    expect(args[args.indexOf('--builder') + 1]).toBe('toa')
+  for (const { arguments: [, args] } of builds) {
+    assert.ok(args.includes('--builder'))
+    assert.strictEqual(args[args.indexOf('--builder') + 1], 'toa')
   }
 })
 
 it('should not create builder when it already exists', async () => {
-  process.execute = jest.fn(async (cmd, args) => {
+  process.execute = mock.fn(async (cmd, args) => {
     if (args[0] === 'manifest')
       throw new Error('manifest unknown')
 
@@ -70,10 +72,10 @@ it('should not create builder when it already exists', async () => {
 
   await registry.build()
 
-  const creates = process.execute.mock.calls.filter(([, args]) =>
+  const creates = process.execute.mock.calls.filter(({ arguments: [, args] }) =>
     args[0] === 'buildx' && args[1] === 'create')
 
-  expect(creates).toHaveLength(0)
+  assert.strictEqual(creates.length, 0)
 })
 
 it('should add shared registry cache flags when base is set', async () => {
@@ -84,16 +86,16 @@ it('should add shared registry cache flags when base is set', async () => {
 
   await registry.build()
 
-  const builds = process.execute.mock.calls.filter(([, args]) =>
+  const builds = process.execute.mock.calls.filter(({ arguments: [, args] }) =>
     args[0] === '--context=default' && args[2] === 'build')
 
-  expect(builds).toHaveLength(2)
+  assert.strictEqual(builds.length, 2)
 
-  for (const [, args] of builds) {
-    expect(args).toContain('--cache-from')
-    expect(args).toContain('type=registry,ref=example.com/reg/acme/buildcache')
-    expect(args).toContain('--cache-to')
-    expect(args).toContain('type=registry,ref=example.com/reg/acme/buildcache,mode=max,image-manifest=true')
+  for (const { arguments: [, args] } of builds) {
+    assert.ok(args.includes('--cache-from'))
+    assert.ok(args.includes('type=registry,ref=example.com/reg/acme/buildcache'))
+    assert.ok(args.includes('--cache-to'))
+    assert.ok(args.includes('type=registry,ref=example.com/reg/acme/buildcache,mode=max,image-manifest=true'))
   }
 })
 
@@ -104,15 +106,15 @@ it('should omit cache flags when base is not set', async () => {
 
   await registry.build()
 
-  const builds = process.execute.mock.calls.filter(([, args]) =>
+  const builds = process.execute.mock.calls.filter(({ arguments: [, args] }) =>
     args[0] === '--context=default' && args[2] === 'build')
 
-  expect(builds).toHaveLength(1)
+  assert.strictEqual(builds.length, 1)
 
-  const [, args] = builds[0]
+  const { arguments: [, args] } = builds[0]
 
-  expect(args).not.toContain('--cache-from')
-  expect(args).not.toContain('--cache-to')
+  assert.ok(!(args.includes('--cache-from')))
+  assert.ok(!(args.includes('--cache-to')))
 })
 
 it('should use default builder when platforms is null', async () => {
@@ -122,20 +124,20 @@ it('should use default builder when platforms is null', async () => {
 
   await registry.build()
 
-  const builds = process.execute.mock.calls.filter(([, args]) =>
+  const builds = process.execute.mock.calls.filter(({ arguments: [, args] }) =>
     args[0] === '--context=default' && args[2] === 'build')
 
-  expect(builds).toHaveLength(1)
+  assert.strictEqual(builds.length, 1)
 
-  const [, args] = builds[0]
+  const { arguments: [, args] } = builds[0]
 
-  expect(args[args.indexOf('--builder') + 1]).toBe('default')
-  expect(args).not.toContain('--cache-from')
-  expect(args).not.toContain('--platform')
+  assert.strictEqual(args[args.indexOf('--builder') + 1], 'default')
+  assert.ok(!(args.includes('--cache-from')))
+  assert.ok(!(args.includes('--platform')))
 })
 
 it('should skip build when image already exists', async () => {
-  process.execute = jest.fn(async () => '')
+  process.execute = mock.fn(async () => '')
 
   const registry = createRegistry({ base: 'example.com/reg', platforms: ['linux/amd64'] })
 
@@ -143,11 +145,11 @@ it('should skip build when image already exists', async () => {
 
   await registry.build()
 
-  const builds = process.execute.mock.calls.filter(([, args]) =>
+  const builds = process.execute.mock.calls.filter(({ arguments: [, args] }) =>
     args[0] === '--context=default' && args[2] === 'build')
 
-  expect(builds).toHaveLength(0)
-  expect(process.execute).toHaveBeenCalledWith('docker', ['manifest', 'inspect', images[0].reference], { silently: true })
+  assert.strictEqual(builds.length, 0)
+  assert.ok(process.execute.mock.calls.some((call) => call.arguments.length === 3 && isDeepStrictEqual(call.arguments[0], 'docker') && isDeepStrictEqual(call.arguments[1], ['manifest', 'inspect', images[0].reference]) && isDeepStrictEqual(call.arguments[2], { silently: true })))
 })
 
 /**
@@ -166,7 +168,7 @@ function createImage (name) {
   const image = /** @type {toa.deployment.images.Image} */ {
     reference: `example.com/reg/acme/${name}:abcdef12`,
     context: `/tmp/${name}`,
-    prepare: jest.fn(async () => `/tmp/${name}`)
+    prepare: mock.fn(async () => `/tmp/${name}`)
   }
 
   images.push(image)

package/src/deployment/service.js

@@ -1,6 +1,4 @@
-'use strict'
-
-class Service {
+export class Service {
   constructor (service, image) {
     Object.assign(this, service)
 
@@ -8,5 +6,3 @@ class Service {
     this.image = image.reference
   }
 }
-
-exports.Service = Service