@atomservice/config 0.1.5

package/src/config.compose.ts

@@ -0,0 +1,59 @@
+import { tmpl } from "@atomservice/core"
+import { CONFIG_DEFAULT_PORT } from "./config.consts.ts"
+
+export interface ConfigComposeOptions {
+  image: string
+  dataDir: string
+  adminName?: string
+  adminEmail?: string
+  adminPassword?: string
+  environment?: Record<string, string>
+  hostPort?: number
+}
+
+export function configCompose(id: string, opts: ConfigComposeOptions): string {
+  const port = CONFIG_DEFAULT_PORT
+  const portsBlock = opts.hostPort ? `\n    ports:\n      - "${opts.hostPort}:${port}"` : ""
+
+  const lines: string[] = []
+  const push = (k: string, v: string | number | undefined) => {
+    if (v === undefined || v === "") return
+    lines.push(`      - ${k}=${v}`)
+  }
+  push("CONFIG_ADMIN_NAME", opts.adminName)
+  push("CONFIG_ADMIN_EMAIL", opts.adminEmail)
+  push("CONFIG_ADMIN_PASSWORD", opts.adminPassword)
+  if (opts.environment) {
+    for (const [k, v] of Object.entries(opts.environment)) push(k, v)
+  }
+  const extraEnv = lines.length ? `\n${lines.join("\n")}` : ""
+
+  return tmpl`\
+services:
+  ${id}:
+    image: ${opts.image}
+    container_name: ${id}
+    environment:
+      - CONFIG_PORT=${port}
+      - CONFIG_DB_PATH=/data/config.db${extraEnv}
+    volumes:
+      - ${opts.dataDir}:/data
+    expose:
+      - "${port}"${portsBlock}
+    networks:
+      - atomservice
+    restart: unless-stopped
+    healthcheck:
+      test: ["CMD", "curl", "-sf", "http://localhost:${port}/v1/health"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+      start_period: 15s
+      start_period: 20s
+
+networks:
+  atomservice:
+    name: atomservice
+    external: true
+`
+}

package/src/config.consts.ts

@@ -0,0 +1,5 @@
+import pkg from "../package.json" with { type: "json" }
+
+export const CONFIG_IMAGE_REPO = "localhost/atomservice/config-server"
+export const CONFIG_DEFAULT_PORT = 4921
+export const CONFIG_VERSION = pkg.version

package/src/config.instance.ts

@@ -0,0 +1,26 @@
+export interface ConfigInstance {
+  /**
+   * 容器主机名
+   *
+   * - 同容器名
+   * - 容器网络内可直接访问
+   */
+  readonly host: string
+  /**
+   * 容器内 HTTP 监听端口
+   */
+  readonly port: number
+  /**
+   * 容器网络内访问地址
+   *
+   * - 如 `http://config:4921/`
+   */
+  readonly url: string
+  /**
+   * 对外域名地址
+   *
+   * - 如 `https://config.example.com/`
+   * - 仅配置 `domain` 后可用
+   */
+  readonly externalUrl: string | undefined
+}

package/src/config.options.ts

@@ -0,0 +1,58 @@
+import type { CallableService } from "@atomservice/core"
+import type { GatewayInstance } from "@atomservice/gateway"
+
+export interface ConfigOptions {
+  /**
+   * 实例标识
+   *
+   * @default "default"
+   */
+  id?: string
+  /**
+   * 容器对外端口
+   *
+   * - 不填则不对外暴露，仅容器网络内访问
+   */
+  hostPort?: number
+  /**
+   * 对外域名
+   *
+   * - 填写后自动在网关注册反代路由
+   * - 需要和 `gateway` 原子一起使用
+   */
+  domain?: string
+  /**
+   * 初始超级管理员用户名
+   *
+   * - 与 `adminEmail` 和 `adminPassword` 一起填写则容器首次启动时自动创建超管账号
+   *
+   * @default "admin"
+   */
+  adminName?: string
+  /**
+   * 初始超级管理员邮箱
+   *
+   * - 与 `adminPassword` 一起填写则容器首次启动时自动创建超管账号
+   * - 不填则需首次访问后通过 API 手动创建
+   */
+  adminEmail?: string
+  /**
+   * 初始超级管理员密码
+   *
+   * - 见 `adminEmail`
+   */
+  adminPassword?: string
+  /**
+   * 自定义环境变量
+   *
+   * - 透传到容器
+   */
+  environment?: Record<string, string>
+  /**
+   * 关联的网关原子
+   *
+   * - 填写后自动向网关注册反代路由
+   * - 通常和 `domain` 一起使用
+   */
+  gateway?: CallableService<GatewayInstance>
+}

package/src/config.service.ts

@@ -0,0 +1,121 @@
+import path from "node:path"
+import { fileURLToPath } from "node:url"
+import type { CallableService } from "@atomservice/core"
+import { defineService, onDown, onHealth, onUp, useConfig, useLogger, useShell, useState } from "@atomservice/core"
+import { configCompose } from "./config.compose.ts"
+import { CONFIG_DEFAULT_PORT, CONFIG_IMAGE_REPO, CONFIG_VERSION } from "./config.consts.ts"
+import type { ConfigInstance } from "./config.instance.ts"
+import type { ConfigOptions } from "./config.options.ts"
+import type { ConfigState } from "./config.types.ts"
+
+const HERE = path.dirname(fileURLToPath(import.meta.url))
+const SERVER_DIR = path.resolve(HERE, "..", "server")
+
+export function config(opts: ConfigOptions = {}): CallableService<ConfigInstance> {
+  const serviceId = opts.id && opts.id !== "default" ? opts.id : "default"
+  const containerName = serviceId !== "default" ? `config-${serviceId}` : "config"
+  const version = CONFIG_VERSION
+  const imageTag = `${CONFIG_IMAGE_REPO}:${version}`
+
+  return defineService({
+    name: "config",
+    id: opts.id,
+    setup: () => {
+      const logger = useLogger()
+      const $ = useShell()
+      const conf = useConfig()
+      const gw = opts.gateway?.()
+
+      const dir = path.join(conf.root, containerName)
+      const composePath = path.join(dir, "compose.yml")
+      const dataDir = path.join(dir, "data")
+
+      const { save, watch, checkChanges } = useState<ConfigState>()
+      watch("version", {
+        risk: "low",
+        changed: (a, b) => `Config 镜像版本变更 ${a} → ${b}，将重新构建`,
+      })
+
+      async function ensureImage() {
+        const exists = await $`podman image exists ${imageTag}`.quiet().nothrow()
+        if (exists.exitCode === 0) return
+        logger.info(`未找到镜像 ${imageTag}，开始构建（首次较慢）…`)
+        const build = await $`podman build -t ${imageTag} -f ${path.join(SERVER_DIR, "Containerfile")} ${SERVER_DIR}`
+          .quiet()
+          .nothrow()
+        if (build.exitCode !== 0) {
+          throw new Error(`镜像构建失败：${build.stderr.toString().slice(-500)}`)
+        }
+        logger.success(`镜像已构建 ${imageTag}`)
+      }
+
+      onUp(async () => {
+        const currentState: ConfigState = { version }
+        await checkChanges(currentState)
+
+        await $`mkdir -p ${dataDir}`
+        await ensureImage()
+
+        await Bun.write(
+          composePath,
+          configCompose(containerName, {
+            image: imageTag,
+            dataDir,
+            adminName: opts.adminName,
+            adminEmail: opts.adminEmail,
+            adminPassword: opts.adminPassword,
+            environment: opts.environment,
+            hostPort: opts.hostPort,
+          }),
+        )
+
+        logger.info(`正在启动 ${containerName}`)
+        await $`podman compose -f ${composePath} up -d`
+        logger.success(`${containerName} 已启动`)
+
+        if (opts.domain && gw) {
+          logger.info(`注册路由 ${opts.domain} → ${containerName}:${CONFIG_DEFAULT_PORT}`)
+          await gw.registerRoute(opts.domain, `${containerName}:${CONFIG_DEFAULT_PORT}`)
+          logger.success(`路由已注册，访问 https://${opts.domain}`)
+        }
+
+        await save(currentState)
+      })
+
+      onDown(async () => {
+        logger.info(`正在停止 ${containerName}`)
+        await $`podman compose -f ${composePath} down`
+        if (opts.domain && gw) await gw.unregisterRoute(opts.domain)
+        logger.success(`${containerName} 已停止`)
+      })
+
+      onHealth(async () => {
+        try {
+          const result =
+            await $`podman exec ${containerName} curl -sf http://localhost:${CONFIG_DEFAULT_PORT}/v1/health`
+              .quiet()
+              .nothrow()
+          if (result.exitCode === 0) return { status: "healthy" }
+          return { status: "unhealthy", message: `Config 健康检查返回 ${result.exitCode}` }
+        } catch {
+          return { status: "unhealthy", message: `容器 ${containerName} 不存在` }
+        }
+      })
+
+      return {
+        get host() {
+          return containerName
+        },
+        get port() {
+          return CONFIG_DEFAULT_PORT
+        },
+        get url() {
+          return `http://${containerName}:${CONFIG_DEFAULT_PORT}/`
+        },
+        get externalUrl() {
+          return opts.domain ? `https://${opts.domain}/` : undefined
+        },
+      }
+    },
+  })
+}

package/src/config.types.ts

@@ -0,0 +1,3 @@
+export type ConfigState = {
+  version: string
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export type { ConfigInstance } from "./config.instance.ts"
+export type { ConfigOptions } from "./config.options.ts"
+export { config } from "./config.service.ts"