mega-framework 0.1.5 → 0.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/mega-ws-hub.js +2 -2
- package/package.json +32 -8
- package/sample/crud/.env +156 -8
- package/sample/crud/.env.example +153 -28
- package/sample/crud/.mega/journal/history/20260612092543-create-users.json +261 -0
- package/sample/crud/.mega/journal/snapshot.json +261 -0
- package/sample/crud/apps/main/controllers/auth-controller.js +22 -14
- package/sample/crud/apps/main/controllers/web-controller.js +7 -5
- package/sample/crud/apps/main/migrations/20260606000001-create-users.js +91 -13
- package/sample/crud/apps/main/migrations/20260606000002-create-boards.js +165 -0
- package/sample/crud/apps/main/migrations/20260606000003-create-logs.js +107 -0
- package/sample/crud/apps/main/models/log-partition-model.js +105 -0
- package/sample/crud/apps/main/models/note-model.js +79 -0
- package/sample/crud/apps/main/models/user-level-model.js +24 -0
- package/sample/crud/apps/main/models/user-model.js +146 -0
- package/sample/crud/apps/main/models/user-type-model.js +21 -0
- package/sample/crud/apps/main/models/wallet-model.js +24 -0
- package/sample/crud/apps/main/routes/users.js +55 -10
- package/sample/crud/apps/main/schedules/log-partition-schedule.js +33 -0
- package/sample/crud/apps/main/services/auth-service.js +39 -24
- package/sample/crud/apps/main/services/log-partition-service.js +101 -0
- package/sample/crud/apps/main/services/note-service.js +6 -6
- package/sample/crud/apps/main/services/redis-demo-service.js +3 -3
- package/sample/crud/apps/main/services/user-service.js +62 -21
- package/sample/crud/apps/main/views/auth/login.ejs +6 -6
- package/sample/crud/apps/main/views/auth/register.ejs +46 -5
- package/sample/crud/apps/main/views/users/edit.ejs +42 -5
- package/sample/crud/apps/main/views/users/list.ejs +6 -2
- package/sample/crud/apps/main/views/users/new.ejs +56 -4
- package/sample/crud/docs/log_partition_design.mm.md +23 -0
- package/sample/crud/mega.config.js +63 -3
- package/sample/crud/package.json +3 -3
- package/sample/crud/scripts/start-ws-hub.sh +2 -2
- package/sample/simple/package.json +2 -2
- package/src/adapters/adapter-manager.js +2 -1
- package/src/adapters/adapter-options.js +30 -0
- package/src/adapters/maria-adapter.js +26 -3
- package/src/adapters/mega-db-adapter.js +7 -1
- package/src/adapters/mongo-adapter.js +19 -1
- package/src/adapters/postgres-adapter.js +25 -2
- package/src/adapters/sqlite-adapter.js +20 -1
- package/src/cli/commands/new.js +13 -3
- package/src/cli/commands/scaffold.js +137 -33
- package/src/cli/generators/index.js +82 -2
- package/src/cli/index.js +478 -104
- package/src/core/ajv-mapper.js +27 -2
- package/src/core/boot.js +485 -237
- package/src/core/cluster-metrics.js +13 -4
- package/src/core/config-validator.js +25 -0
- package/src/core/ctx-builder.js +6 -2
- package/src/core/envelope.js +112 -12
- package/src/core/hub-link.js +65 -4
- package/src/core/i18n.js +11 -1
- package/src/core/index.js +6 -2
- package/src/core/mega-app.js +223 -481
- package/src/core/mega-cluster.js +54 -13
- package/src/core/mega-server.js +40 -9
- package/src/core/migration/dialect-registry.js +107 -0
- package/src/core/migration/dialects/README.md +62 -0
- package/src/core/migration/dialects/maria.js +496 -0
- package/src/core/migration/dialects/mongo.js +824 -0
- package/src/core/migration/dialects/postgres.js +563 -0
- package/src/core/migration/dialects/sqlite.js +476 -0
- package/src/core/migration/differ.js +456 -0
- package/src/core/migration/generate.js +508 -0
- package/src/core/migration/journal.js +167 -0
- package/src/core/migration/model-scan.js +84 -0
- package/src/core/migration/mongo-migration-db.js +97 -0
- package/src/core/migration/schema-builder.js +400 -0
- package/src/core/migration/schema-validator.js +315 -0
- package/src/core/migration-lock.js +205 -0
- package/src/core/migration-runner.js +166 -38
- package/src/core/multipart.js +28 -5
- package/src/core/pipeline.js +129 -0
- package/src/core/router.js +70 -65
- package/src/core/scope-registry.js +0 -1
- package/src/core/security.js +67 -9
- package/src/core/workers-manager.js +12 -1
- package/src/core/ws-cluster.js +10 -3
- package/src/core/ws-message.js +48 -4
- package/src/core/ws-presence.js +624 -0
- package/src/core/ws-roster.js +4 -1
- package/src/core/ws-upgrade.js +118 -12
- package/src/index.js +1 -1
- package/src/lib/hub-protocol.js +29 -0
- package/src/lib/mega-health.js +25 -4
- package/src/lib/mega-job-queue.js +98 -21
- package/src/lib/mega-job.js +29 -0
- package/src/lib/mega-logger.js +1 -1
- package/src/lib/mega-metrics.js +3 -12
- package/src/lib/mega-plugin.js +34 -3
- package/src/lib/mega-schedule.js +40 -22
- package/src/lib/mega-shutdown.js +162 -49
- package/src/lib/mega-tracing.js +66 -19
- package/src/lib/mega-worker.js +5 -1
- package/src/lib/otel-resource.js +36 -0
- package/src/{cli → lib}/ws-hub.js +51 -8
- package/src/models/crud-sql-builder.js +133 -0
- package/src/models/mega-model.js +82 -2
- package/src/models/model-crud.js +483 -0
- package/src/models/mongo-crud.js +285 -0
- package/templates/model/code-mongo.tpl +35 -0
- package/templates/model/code.tpl +15 -1
- package/templates/model/test-mongo.tpl +38 -0
- package/templates/model/test.tpl +4 -0
- package/types/adapters/adapter-manager.d.ts +95 -0
- package/types/adapters/adapter-options.d.ts +91 -0
- package/types/adapters/file-adapter.d.ts +94 -0
- package/types/adapters/file-session-adapter.d.ts +101 -0
- package/types/adapters/index.d.ts +20 -0
- package/types/adapters/maria-adapter.d.ts +115 -0
- package/types/adapters/mega-adapter.d.ts +215 -0
- package/types/adapters/mega-bus-adapter.d.ts +45 -0
- package/types/adapters/mega-cache-adapter.d.ts +47 -0
- package/types/adapters/mega-db-adapter.d.ts +47 -0
- package/types/adapters/mega-lock-adapter.d.ts +62 -0
- package/types/adapters/mega-log-sink-adapter.d.ts +15 -0
- package/types/adapters/mega-session-adapter.d.ts +32 -0
- package/types/adapters/mongo-adapter.d.ts +139 -0
- package/types/adapters/nats-adapter.d.ts +108 -0
- package/types/adapters/postgres-adapter.d.ts +139 -0
- package/types/adapters/redis-adapter.d.ts +70 -0
- package/types/adapters/redis-session-adapter.d.ts +82 -0
- package/types/adapters/redlock-adapter.d.ts +149 -0
- package/types/adapters/registry.d.ts +46 -0
- package/types/adapters/sqlite-adapter.d.ts +106 -0
- package/types/auth/index.d.ts +24 -0
- package/types/cli/commands/console-cmd.d.ts +37 -0
- package/types/cli/commands/new.d.ts +16 -0
- package/types/cli/commands/routes.d.ts +36 -0
- package/types/cli/commands/scaffold.d.ts +78 -0
- package/types/cli/commands/test-cmd.d.ts +14 -0
- package/types/cli/generators/index.d.ts +112 -0
- package/types/cli/index.d.ts +249 -0
- package/types/cli/template-engine.d.ts +40 -0
- package/types/core/ajv-mapper.d.ts +27 -0
- package/types/core/boot.d.ts +233 -0
- package/types/core/cluster-metrics.d.ts +52 -0
- package/types/core/config-loader.d.ts +13 -0
- package/types/core/config-validator.d.ts +30 -0
- package/types/core/ctx-builder.d.ts +80 -0
- package/types/core/envelope.d.ts +79 -0
- package/types/core/error-mapper.d.ts +17 -0
- package/types/core/formbody.d.ts +41 -0
- package/types/core/hub-link.d.ts +264 -0
- package/types/core/i18n.d.ts +178 -0
- package/types/core/index.d.ts +28 -0
- package/types/core/mega-app.d.ts +529 -0
- package/types/core/mega-cluster.d.ts +104 -0
- package/types/core/mega-server.d.ts +91 -0
- package/types/core/mega-service.d.ts +31 -0
- package/types/core/migration/dialect-registry.d.ts +22 -0
- package/types/core/migration/dialects/maria.d.ts +99 -0
- package/types/core/migration/dialects/mongo.d.ts +89 -0
- package/types/core/migration/dialects/postgres.d.ts +117 -0
- package/types/core/migration/dialects/sqlite.d.ts +111 -0
- package/types/core/migration/differ.d.ts +47 -0
- package/types/core/migration/generate.d.ts +56 -0
- package/types/core/migration/journal.d.ts +52 -0
- package/types/core/migration/model-scan.d.ts +19 -0
- package/types/core/migration/mongo-migration-db.d.ts +7 -0
- package/types/core/migration/schema-builder.d.ts +197 -0
- package/types/core/migration/schema-validator.d.ts +20 -0
- package/types/core/migration-lock.d.ts +33 -0
- package/types/core/migration-runner.d.ts +101 -0
- package/types/core/multipart.d.ts +86 -0
- package/types/core/openapi.d.ts +62 -0
- package/types/core/pipeline.d.ts +92 -0
- package/types/core/router.d.ts +159 -0
- package/types/core/routes-loader.d.ts +21 -0
- package/types/core/scope-registry.d.ts +14 -0
- package/types/core/security.d.ts +77 -0
- package/types/core/services-loader.d.ts +27 -0
- package/types/core/session-cleanup-schedule.d.ts +19 -0
- package/types/core/session-store.d.ts +18 -0
- package/types/core/session.d.ts +77 -0
- package/types/core/static-assets.d.ts +73 -0
- package/types/core/template.d.ts +106 -0
- package/types/core/workers-manager.d.ts +79 -0
- package/types/core/ws-cluster.d.ts +208 -0
- package/types/core/ws-compression.d.ts +112 -0
- package/types/core/ws-controller.d.ts +65 -0
- package/types/core/ws-message.d.ts +106 -0
- package/types/core/ws-presence.d.ts +273 -0
- package/types/core/ws-roster.d.ts +96 -0
- package/types/core/ws-upgrade.d.ts +231 -0
- package/types/errors/config-error.d.ts +10 -0
- package/types/errors/http-errors.d.ts +120 -0
- package/types/errors/index.d.ts +3 -0
- package/types/errors/mega-error.d.ts +32 -0
- package/types/index.d.ts +39 -0
- package/types/lib/asp/config.d.ts +49 -0
- package/types/lib/asp/crypto.d.ts +43 -0
- package/types/lib/asp/errors.d.ts +30 -0
- package/types/lib/asp/nonce-cache.d.ts +52 -0
- package/types/lib/asp/plugin.d.ts +30 -0
- package/types/lib/asp/ws-terminator.d.ts +45 -0
- package/types/lib/env-mapper.d.ts +14 -0
- package/types/lib/hub-protocol.d.ts +106 -0
- package/types/lib/index.d.ts +22 -0
- package/types/lib/logger/telegram-core.d.ts +104 -0
- package/types/lib/logger/telegram-transport.d.ts +45 -0
- package/types/lib/mega-brute-force.d.ts +66 -0
- package/types/lib/mega-circuit-breaker.d.ts +241 -0
- package/types/lib/mega-cron.d.ts +66 -0
- package/types/lib/mega-hash.d.ts +32 -0
- package/types/lib/mega-health.d.ts +41 -0
- package/types/lib/mega-job-queue.d.ts +176 -0
- package/types/lib/mega-job-worker.d.ts +130 -0
- package/types/lib/mega-job.d.ts +138 -0
- package/types/lib/mega-logger.d.ts +45 -0
- package/types/lib/mega-metrics.d.ts +285 -0
- package/types/lib/mega-plugin.d.ts +245 -0
- package/types/lib/mega-retry.d.ts +85 -0
- package/types/lib/mega-schedule.d.ts +260 -0
- package/types/lib/mega-shutdown.d.ts +135 -0
- package/types/lib/mega-tracing.d.ts +224 -0
- package/types/lib/mega-worker.d.ts +127 -0
- package/types/lib/otel-resource.d.ts +16 -0
- package/types/lib/worker-runner/process-entry.d.ts +1 -0
- package/types/lib/worker-runner/task-dispatch.d.ts +28 -0
- package/types/lib/worker-runner/thread-entry.d.ts +1 -0
- package/types/lib/ws-hub.d.ts +234 -0
- package/types/models/crud-sql-builder.d.ts +48 -0
- package/types/models/index.d.ts +1 -0
- package/types/models/mega-model.d.ts +138 -0
- package/types/models/model-crud.d.ts +82 -0
- package/types/models/mongo-crud.d.ts +59 -0
- package/types/test/index.d.ts +84 -0
- package/.env +0 -127
- package/sample/crud/apps/main/migrations/20260606000002-add-auth-to-users.js +0 -30
- package/sample/crud/apps/main/models/note.js +0 -71
- package/sample/crud/apps/main/models/user.js +0 -86
- package/sample/crud/package-lock.json +0 -5665
- package/sample/crud/yarn.lock +0 -2142
- package/sample/simple/package-lock.json +0 -1851
package/src/cli/index.js
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
1
1
|
// @ts-check
|
|
2
2
|
/**
|
|
3
|
-
* `mega` CLI 디스패처 —
|
|
3
|
+
* `mega` CLI 디스패처 — 전 빌트인 명령을 단일 commander program 으로 파싱한다(ADR-195, ADR-123 개정).
|
|
4
4
|
*
|
|
5
|
-
* 명령
|
|
6
|
-
*
|
|
7
|
-
* - `mega
|
|
8
|
-
* - `mega
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
5
|
+
* 명령 표는 {@link buildProgram} 이 정본이다(도움말 자동 생성 — 수기 USAGE 드리프트 제거):
|
|
6
|
+
* - `mega start`(별칭 `serve`) / `worker` / `scheduler` / `migrate[:down|:status]` — 런타임 호스트.
|
|
7
|
+
* - `mega new` / `generate`(g) / `routes` / `test` / `console` — scaffold/dev(commands/scaffold.js).
|
|
8
|
+
* - `mega <plugin:command>` — 빌트인 표({@link BUILTIN_COMMANDS}) 밖 명령은 플러그인 dispatch 로
|
|
9
|
+
* fallthrough(ADR-123 계약 유지). `mega help` 가 프로젝트 플러그인 명령을 동적 병기한다.
|
|
10
|
+
*
|
|
11
|
+
* `runCli` 는 `process.exit` 를 부르지 않고 exit code 를 반환하며(테스트 가능), commander 가 아닌
|
|
12
|
+
* 예외(MegaConfigError·부팅 실패)는 bin 으로 전파해 정리 경로(MegaShutdown.now)를 태운다.
|
|
12
13
|
*
|
|
13
14
|
* worker/scheduler 의 **잡·스케줄 등록 소스 = `config.jobs` / `config.schedules`**(정적 배열) + 플러그인
|
|
14
15
|
* `host.listJobs()` / `host.listSchedules()`(동적)를 {@link collectRegistrations}(ADR-123)가 합친다 —
|
|
@@ -21,52 +22,38 @@
|
|
|
21
22
|
import { existsSync } from 'node:fs'
|
|
22
23
|
import { join } from 'node:path'
|
|
23
24
|
import os from 'node:os'
|
|
25
|
+
import { spawn as nodeSpawn } from 'node:child_process'
|
|
24
26
|
import { bootApp, prepareRuntime } from '../core/boot.js'
|
|
25
27
|
import { MegaCluster } from '../core/mega-cluster.js'
|
|
26
28
|
import { installPrimaryAggregator, installWorkerResponder } from '../core/cluster-metrics.js'
|
|
27
29
|
import { loadAndValidateConfig } from '../core/config-loader.js'
|
|
28
30
|
import { migrateUp, migrateDown, migrateStatus } from '../core/migration-runner.js'
|
|
31
|
+
import { withMigrationLock } from '../core/migration-lock.js'
|
|
32
|
+
import { runMigrateGenerate } from '../core/migration/generate.js'
|
|
29
33
|
import { buildFromGlobalConfig, connectAll, disconnectAll, get as getAdapter } from '../adapters/adapter-manager.js'
|
|
34
|
+
import { MegaDbAdapter } from '../adapters/mega-db-adapter.js'
|
|
30
35
|
import { MegaConfigError } from '../errors/config-error.js'
|
|
31
36
|
import { MegaPluginHost, loadPlugins } from '../lib/mega-plugin.js'
|
|
32
37
|
import { MegaJobWorker } from '../lib/mega-job-worker.js'
|
|
33
38
|
import { MegaScheduler } from '../lib/mega-schedule.js'
|
|
34
|
-
import { MegaShutdown } from '../lib/mega-shutdown.js'
|
|
39
|
+
import { MegaShutdown, DEFAULT_HARD_KILL_MS } from '../lib/mega-shutdown.js'
|
|
40
|
+
import { buildLogger } from '../lib/mega-logger.js'
|
|
35
41
|
import * as MegaMetrics from '../lib/mega-metrics.js'
|
|
36
|
-
import {
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
mega routes [--root DIR] 등록 라우트 트리 출력
|
|
52
|
-
mega test [--root DIR] [-- vitest args...] vitest 실행
|
|
53
|
-
mega console [--root DIR] 앱 컨텍스트 REPL
|
|
54
|
-
mega <plugin:command> [args...] 플러그인 등록 CLI 명령 실행
|
|
55
|
-
mega help 이 도움말
|
|
56
|
-
|
|
57
|
-
generator kinds:
|
|
58
|
-
app controller channel service model middleware route schedule job worker locale adapter migration
|
|
59
|
-
|
|
60
|
-
Options:
|
|
61
|
-
--root DIR 프로젝트 루트(기본: 현재 디렉토리)
|
|
62
|
-
--port N listen 포트(start, 기본: server/global 설정 또는 3000)
|
|
63
|
-
--host H listen 호스트(start)
|
|
64
|
-
--cluster X 워커 프로세스 수(start). 정수 N 또는 max(CPU 코어 수). 우선순위:
|
|
65
|
-
--cluster > MEGA_CLUSTER_WORKERS env > server.cluster config. 1/미지정=단일 프로세스.
|
|
66
|
-
`
|
|
67
|
-
|
|
68
|
-
/** 프로젝트 `.env` 를 로드하지 않는 명령 — 스캐폴드 생성(new/g)·도움말. 그 외 런타임/부팅 명령은 로드. */
|
|
69
|
-
const NO_ENV_COMMANDS = new Set(['new', 'g', 'generate', 'help'])
|
|
42
|
+
import { Command } from 'commander'
|
|
43
|
+
import { registerScaffoldCommands, commanderErrorToExitCode } from './commands/scaffold.js'
|
|
44
|
+
|
|
45
|
+
/** 빌트인 명령 이름·별칭 전체 — 이 표 밖의 첫 positional 은 플러그인 명령 dispatch 로 fallthrough 한다
|
|
46
|
+
* (ADR-123 계약 유지). `buildProgram` 의 commander 등록과 동기를 유지할 것. */
|
|
47
|
+
export const BUILTIN_COMMANDS = new Set([
|
|
48
|
+
'start', 'serve', 'worker', 'scheduler',
|
|
49
|
+
'migrate', 'migrate:down', 'migrate:status', 'migrate:generate',
|
|
50
|
+
'new', 'generate', 'g', 'routes', 'test', 'console', 'help',
|
|
51
|
+
])
|
|
52
|
+
|
|
53
|
+
/** 프로젝트 `.env` 를 로드하지 않는 명령(commander 정식 이름 기준 — 별칭 `g` 는 `generate` 로 해석됨).
|
|
54
|
+
* 스캐폴드 생성은 대상 프로젝트가 아직 없거나 무관하므로 제외(cwd 의 무관한 .env 로드 방지). `help` 는
|
|
55
|
+
* runCli 가 commander 진입 전에 처리한다. 그 외 런타임/부팅 명령은 로드(ADR-152). */
|
|
56
|
+
const NO_ENV_COMMANDS = new Set(['new', 'generate'])
|
|
70
57
|
|
|
71
58
|
/**
|
|
72
59
|
* 프로젝트 루트의 `.env` 를 `process.env` 로 로드한다(파일이 있을 때만). Node 내장
|
|
@@ -90,7 +77,8 @@ export function loadProjectEnv(projectRoot, logger) {
|
|
|
90
77
|
|
|
91
78
|
/**
|
|
92
79
|
* 인자 토큰을 `{ _: positionals[], flags: {} }` 로 파싱. `--key=value` / `--key value` / `--flag`(=true).
|
|
93
|
-
*
|
|
80
|
+
* commander 일원화(ADR-195) 이후에도 두 용도로 남는다 — ① runCli 의 사전 스캔(`--root`·명령어 판별,
|
|
81
|
+
* commander 진입 전), ② 플러그인 CLI 명령 핸들러 인자 계약(`handler({ _, flags })`, 03-api-spec §11).
|
|
94
82
|
* @param {string[]} argv - `process.argv.slice(2)` 형태.
|
|
95
83
|
* @returns {{ _: string[], flags: Record<string, string | boolean> }}
|
|
96
84
|
*/
|
|
@@ -202,6 +190,89 @@ export function resolveHost(setting) {
|
|
|
202
190
|
return setting
|
|
203
191
|
}
|
|
204
192
|
|
|
193
|
+
/**
|
|
194
|
+
* `--root` 플래그를 검증된 프로젝트 루트로 해석한다(fail-closed — {@link resolveHost} 와 동형, OQ-029②).
|
|
195
|
+
*
|
|
196
|
+
* 미지정은 cwd 폴백에 위임하려 `undefined`. 값 없는 베어 `--root`(=`true`)·빈 값 `--root=`(=`''`)은
|
|
197
|
+
* throw — 빈 루트를 통과시키면 `join('', '.env')`/`loadAndValidateConfig('')` 가 cwd 상대로 silent
|
|
198
|
+
* 오동작해 운영자가 의도한 루트 지정 실패를 모른다(P4/P7). 비어 있지 않은 문자열은 그대로.
|
|
199
|
+
*
|
|
200
|
+
* @param {string | boolean | undefined | null} setting - `--root` 플래그 값.
|
|
201
|
+
* @returns {string | undefined} 검증된 루트, 또는 미지정이면 `undefined`(cwd 폴백 위임).
|
|
202
|
+
* @throws {MegaConfigError} `config.invalid_root` — 값 없음/빈 값.
|
|
203
|
+
*/
|
|
204
|
+
export function resolveRoot(setting) {
|
|
205
|
+
if (setting === undefined || setting === null) return undefined
|
|
206
|
+
if (typeof setting !== 'string' || setting === '') {
|
|
207
|
+
throw new MegaConfigError('config.invalid_root', '--root requires a value (e.g. --root ./my-app).', { details: { setting } })
|
|
208
|
+
}
|
|
209
|
+
return setting
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
/**
|
|
213
|
+
* `--db` 플래그를 검증된 마이그레이션 대상 키로 해석한다(fail-closed — {@link resolveRoot} 와 동형, OQ-029②).
|
|
214
|
+
*
|
|
215
|
+
* 미지정은 자동 선택(`resolveMigrationAdapter` 의 유일 db/primary 규칙)에 위임하려 `undefined`. 값 없는
|
|
216
|
+
* 베어 `--db`(=`true`)·빈 값 `--db=`(=`''`)은 throw — 빈 키가 자동 선택으로 silent 강등되면 운영자가
|
|
217
|
+
* 지정 실패를 모른 채 다른 db 에 마이그레이션을 적용할 수 있다(P4/P7).
|
|
218
|
+
*
|
|
219
|
+
* @param {string | boolean | undefined | null} setting - `--db` 플래그 값.
|
|
220
|
+
* @returns {string | undefined} 검증된 db 키, 또는 미지정이면 `undefined`(자동 선택 위임).
|
|
221
|
+
* @throws {MegaConfigError} `config.invalid_db` — 값 없음/빈 값.
|
|
222
|
+
*/
|
|
223
|
+
export function resolveDb(setting) {
|
|
224
|
+
if (setting === undefined || setting === null) return undefined
|
|
225
|
+
if (typeof setting !== 'string' || setting === '') {
|
|
226
|
+
throw new MegaConfigError('config.invalid_db', '--db requires a value (e.g. --db primary).', { details: { setting } })
|
|
227
|
+
}
|
|
228
|
+
return setting
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
/**
|
|
232
|
+
* `mega start --watch` 가 자신을 `node --watch` 로 재실행해야 하는지 (ADR-182). `--watch` 플래그가 있고
|
|
233
|
+
* 아직 watch 하에 재실행되지 않았을 때만 true — 가드 env(`MEGA_WATCH_REEXEC`)로 무한재귀를 막는다.
|
|
234
|
+
* @param {Record<string, string|boolean>} flags
|
|
235
|
+
* @param {Record<string, string|undefined>} env
|
|
236
|
+
* @returns {boolean}
|
|
237
|
+
*/
|
|
238
|
+
export function shouldReexecForWatch(flags, env) {
|
|
239
|
+
return flags.watch === true && env.MEGA_WATCH_REEXEC !== '1'
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
/**
|
|
243
|
+
* `mega start --watch` → `node --watch … <self> start … --cluster 1` 재실행 명령을 빌드한다 (ADR-182).
|
|
244
|
+
*
|
|
245
|
+
* - `--watch` 인자는 **node 플래그**로 옮기고 mega 인자에선 제거한다.
|
|
246
|
+
* - **단일 프로세스 강제**(`--cluster 1`) — 멀티워커 watch 카오스 방지(기존 `--cluster` 값은 무시).
|
|
247
|
+
* - watchPaths 가 있으면 `--watch-path=…`(이게 모듈 그래프 watch 를 **대체**하므로 앱 소스·전역설정 경로를
|
|
248
|
+
* 명시해야 한다 — 실측 확인). 없으면 plain `--watch`(모듈 그래프 폴백).
|
|
249
|
+
*
|
|
250
|
+
* @param {Object} o
|
|
251
|
+
* @param {string[]} o.argv - 원본 mega argv(예: `['start','--watch','--port','3000']`).
|
|
252
|
+
* @param {string[]} o.watchPaths - 감시할 절대경로(존재하는 것만).
|
|
253
|
+
* @param {string} o.selfPath - mega 진입 스크립트(`process.argv[1]`).
|
|
254
|
+
* @param {string} o.execPath - node 바이너리(`process.execPath`).
|
|
255
|
+
* @returns {{ command: string, args: string[] }}
|
|
256
|
+
*/
|
|
257
|
+
export function buildWatchCommand({ argv, watchPaths, selfPath, execPath }) {
|
|
258
|
+
const nodeFlags =
|
|
259
|
+
Array.isArray(watchPaths) && watchPaths.length > 0 ? watchPaths.map((p) => `--watch-path=${p}`) : ['--watch']
|
|
260
|
+
/** @type {string[]} mega 인자 — `--watch` 제거 + `--cluster`(값 포함) 제거. */
|
|
261
|
+
const megaArgs = []
|
|
262
|
+
for (let i = 0; i < argv.length; i++) {
|
|
263
|
+
const tok = argv[i]
|
|
264
|
+
if (tok === '--watch' || tok.startsWith('--watch=')) continue
|
|
265
|
+
if (tok === '--cluster') {
|
|
266
|
+
if (i + 1 < argv.length && !argv[i + 1].startsWith('--')) i++ // 값 토큰도 건너뜀.
|
|
267
|
+
continue
|
|
268
|
+
}
|
|
269
|
+
if (tok.startsWith('--cluster=')) continue
|
|
270
|
+
megaArgs.push(tok)
|
|
271
|
+
}
|
|
272
|
+
megaArgs.push('--cluster', '1') // 단일 프로세스 강제.
|
|
273
|
+
return { command: execPath, args: [...nodeFlags, selfPath, ...megaArgs] }
|
|
274
|
+
}
|
|
275
|
+
|
|
205
276
|
/**
|
|
206
277
|
* `mega` CLI 진입점. 파싱 → 명령 분기. **이 함수는 process.exit 를 호출하지 않는다**(테스트 가능) —
|
|
207
278
|
* exit code 를 반환하고, bin 래퍼가 `process.exitCode` 로 반영한다.
|
|
@@ -212,108 +283,340 @@ export function resolveHost(setting) {
|
|
|
212
283
|
* @param {(msg: string) => void} [deps.err] - stderr writer(기본 console.error).
|
|
213
284
|
* @param {string} [deps.cwd] - 기본 projectRoot(기본 process.cwd()).
|
|
214
285
|
* @param {{ debug?: Function, info?: Function, warn?: Function }} [deps.logger]
|
|
286
|
+
* @param {Function} [deps.spawn] - child_process.spawn 주입(기본 node:child_process). `--watch` 재실행 테스트용.
|
|
287
|
+
* @param {string} [deps.selfPath] - mega 진입 스크립트 경로(기본 `process.argv[1]`). `--watch` 재실행 대상.
|
|
215
288
|
* @returns {Promise<number>} exit code(0=성공, 1=실패/미지정 명령).
|
|
216
289
|
*/
|
|
217
|
-
export async function runCli(argv, { out = console.log, err = console.error, cwd, logger } = {}) {
|
|
290
|
+
export async function runCli(argv, { out = console.log, err = console.error, cwd, logger, spawn = nodeSpawn, selfPath = process.argv[1] } = {}) {
|
|
218
291
|
const { _, flags } = parseArgs(argv)
|
|
219
292
|
const command = _[0]
|
|
220
|
-
|
|
293
|
+
// `--root` 는 fail-closed 검증(OQ-029② — 베어/빈 값은 throw, 미지정만 cwd 폴백).
|
|
294
|
+
const projectRoot = resolveRoot(flags.root) ?? cwd ?? process.cwd()
|
|
295
|
+
|
|
296
|
+
// 도움말 — commander 자동 생성(USAGE) + 프로젝트 플러그인 명령 동적 병기(ADR-195). 명령 없이
|
|
297
|
+
// 호출(`mega`)은 도움말 + 실패 코드(쉘 스크립트 친화), 명시적 help/`--help` 는 0.
|
|
298
|
+
// `mega help <command>`(인자 있는 help)·`mega <command> --help` 는 commander 가 명령별 도움말을 낸다.
|
|
299
|
+
if (command === undefined || (command === 'help' && _.length === 1)) {
|
|
300
|
+
out(USAGE)
|
|
301
|
+
await appendPluginCommandsHelp(projectRoot, out, logger)
|
|
302
|
+
return command === 'help' || flags.help === true ? 0 : 1
|
|
303
|
+
}
|
|
221
304
|
|
|
222
|
-
//
|
|
223
|
-
//
|
|
224
|
-
if (
|
|
305
|
+
// 플러그인 등록 CLI 명령 fallthrough(예: `mega sample:ping`) — 빌트인 표 밖의 명령만(ADR-123 계약).
|
|
306
|
+
// 이름 컨벤션은 `<plugin>:<verb>` 이지만 강제는 아니다 — host 에 등록된 임의 이름을 그대로 조회한다.
|
|
307
|
+
if (!BUILTIN_COMMANDS.has(command)) {
|
|
225
308
|
loadProjectEnv(projectRoot, logger)
|
|
309
|
+
/** @type {{ found: boolean, code: number }} */
|
|
310
|
+
let dispatched
|
|
311
|
+
try {
|
|
312
|
+
dispatched = await dispatchPluginCommand(projectRoot, command, { _: _.slice(1), flags }, logger)
|
|
313
|
+
} catch (e) {
|
|
314
|
+
// config 부재/오류(프로젝트 밖 등)로 플러그인 확인 자체가 불가 — unknown command 에 원인을 병기해
|
|
315
|
+
// config 에러로 오도되지 않게 보고한다(F6 audit §2.2-⑥).
|
|
316
|
+
err(`mega: unknown command '${command}' (플러그인 명령 확인 실패: ${/** @type {any} */ (e).message ?? e}).\n`)
|
|
317
|
+
err(USAGE)
|
|
318
|
+
return 1
|
|
319
|
+
}
|
|
320
|
+
if (dispatched.found) return dispatched.code
|
|
321
|
+
err(`mega: unknown command '${command}'.\n`)
|
|
322
|
+
err(USAGE)
|
|
323
|
+
return 1
|
|
226
324
|
}
|
|
227
325
|
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
326
|
+
// 빌트인 명령 — 단일 commander program 으로 파싱·디스패치(ADR-195). action 은 setExit 로 종료 코드를
|
|
327
|
+
// 보고하고, commander 가 아닌 예외(MegaConfigError·부팅 실패 등)는 그대로 전파해 bin 의 정리 경로
|
|
328
|
+
// (MegaShutdown.now)를 태운다.
|
|
329
|
+
let exitCode = 0
|
|
330
|
+
const program = buildProgram({ argv, out, err, projectRoot, logger, spawn, selfPath, setExit: (c) => (exitCode = c) })
|
|
331
|
+
try {
|
|
332
|
+
await program.parseAsync(argv, { from: 'user' })
|
|
333
|
+
return exitCode
|
|
334
|
+
} catch (e) {
|
|
335
|
+
return commanderErrorToExitCode(e, err, { rethrowUnknown: true })
|
|
232
336
|
}
|
|
337
|
+
}
|
|
338
|
+
|
|
339
|
+
/**
|
|
340
|
+
* `mega start`/`serve` 본체 — dev watch 재실행 또는 부팅+listen(단일/클러스터).
|
|
341
|
+
* @param {{ port?: string, host?: string, cluster?: string | boolean, watch?: boolean }} opts - commander 옵션.
|
|
342
|
+
* @param {{ argv: string[], out: (msg: string) => void, projectRoot: string, logger?: { debug?: Function, info?: Function, warn?: Function }, spawn: Function, selfPath: string }} ctx
|
|
343
|
+
* @returns {Promise<number>} exit code.
|
|
344
|
+
*/
|
|
345
|
+
async function runStart(opts, { argv, out, projectRoot, logger, spawn, selfPath }) {
|
|
346
|
+
{
|
|
347
|
+
// dev watch (ADR-182) — `--watch` 면 자신을 `node --watch` 로 재실행한다. 부모는 부팅하지 않고 watcher
|
|
348
|
+
// 자식만 띄운 뒤 그 exit code 를 그대로 반영한다(가드 env 로 무한재귀 방지). 단일 프로세스 강제 +
|
|
349
|
+
// NODE_ENV 미설정 시 development 기본. 시그널은 자식으로 전달해 Ctrl+C 가 watcher 까지 닿게 한다.
|
|
350
|
+
if (shouldReexecForWatch({ watch: opts.watch === true }, process.env)) {
|
|
351
|
+
const watchPaths = [join(projectRoot, 'apps'), join(projectRoot, 'mega.config.js')].filter(existsSync)
|
|
352
|
+
const { command: cmd, args } = buildWatchCommand({ argv, watchPaths, selfPath, execPath: process.execPath })
|
|
353
|
+
out(`mega: watch mode (single process) — restarting on changes in [${watchPaths.length ? watchPaths.join(', ') : 'module graph'}]`)
|
|
354
|
+
const child = spawn(cmd, args, {
|
|
355
|
+
stdio: 'inherit',
|
|
356
|
+
env: { ...process.env, MEGA_WATCH_REEXEC: '1', NODE_ENV: process.env.NODE_ENV ?? 'development' },
|
|
357
|
+
})
|
|
358
|
+
/** @type {NodeJS.Signals[]} */
|
|
359
|
+
const sigs = ['SIGINT', 'SIGTERM']
|
|
360
|
+
const forward = (/** @type {NodeJS.Signals} */ sig) => {
|
|
361
|
+
try {
|
|
362
|
+
child.kill(sig)
|
|
363
|
+
} catch {
|
|
364
|
+
// 자식이 이미 종료 중이면 kill 은 무의미 — 무시(비치명적).
|
|
365
|
+
}
|
|
366
|
+
}
|
|
367
|
+
for (const s of sigs) process.on(s, forward)
|
|
368
|
+
return await new Promise((resolve) => {
|
|
369
|
+
child.on('exit', (/** @type {number|null} */ code) => {
|
|
370
|
+
for (const s of sigs) process.removeListener(s, forward)
|
|
371
|
+
resolve(typeof code === 'number' ? code : 0)
|
|
372
|
+
})
|
|
373
|
+
})
|
|
374
|
+
}
|
|
233
375
|
|
|
234
|
-
if (command === 'start' || command === 'serve') {
|
|
235
376
|
// listen 포트/호스트는 부팅(어댑터 connect) 전에 fail-closed 검증한다 — 잘못된 값을 늦게(listen 시점)
|
|
236
377
|
// cryptic 에러로 만나거나 silent 강등(특권/랜덤 포트)하지 않도록(per ADR-167 후속).
|
|
237
|
-
const port = resolvePort(
|
|
238
|
-
const host = resolveHost(
|
|
378
|
+
const port = resolvePort(opts.port)
|
|
379
|
+
const host = resolveHost(opts.host)
|
|
239
380
|
|
|
240
381
|
// cluster 워커 수 해석(ADR-154) — `--cluster` 플래그 > `MEGA_CLUSTER_WORKERS` env > `server.cluster`
|
|
241
382
|
// config 순. 앞선 소스가 정해지면 config 로드를 생략한다(env/플래그만으로 동작 — port 패턴과 동일).
|
|
242
|
-
let clusterSetting =
|
|
383
|
+
let clusterSetting = opts.cluster ?? process.env.MEGA_CLUSTER_WORKERS
|
|
243
384
|
if (clusterSetting === undefined) {
|
|
244
385
|
const { global } = await loadAndValidateConfig(projectRoot)
|
|
245
386
|
clusterSetting = /** @type {any} */ (global).server?.cluster
|
|
246
387
|
}
|
|
247
388
|
const workers = resolveClusterWorkers(clusterSetting)
|
|
248
389
|
|
|
390
|
+
// 시작 확인 메시지 — pino 로거가 있으면 그쪽 info 로(구조적·sink 라우팅, ADR-180), 없으면 CLI stdout
|
|
391
|
+
// (`out`)으로 폴백한다. listen/forked 는 운영 라이프사이클 이벤트라 로그로 남기는 게 정합.
|
|
392
|
+
const announce = (/** @type {any} */ lg, /** @type {string} */ msg) => {
|
|
393
|
+
if (lg && typeof lg.info === 'function') lg.info(msg)
|
|
394
|
+
else out(`mega: ${msg}`)
|
|
395
|
+
}
|
|
396
|
+
|
|
249
397
|
// 워커 부팅 함수 — 단일/클러스터 모드 공통. 클러스터에선 각 워커 프로세스가 이 함수를 실행한다.
|
|
250
398
|
const bootListen = async () => {
|
|
251
|
-
const { server } = await bootApp(projectRoot, { listen: true, port, host, logger })
|
|
252
|
-
|
|
399
|
+
const { server, appLogger } = await bootApp(projectRoot, { listen: true, port, host, logger })
|
|
400
|
+
// 'server' stage — HTTP/WS 수용을 가장 먼저 끊는다(진행 중 요청·WS drain 포함).
|
|
401
|
+
MegaShutdown.register('mega-cli:server', async () => server.close(), { stage: 'server' })
|
|
253
402
|
MegaShutdown.setupSignals()
|
|
254
403
|
// 클러스터 워커면 메트릭 collect 응답기 설치(ADR-163) — 마스터의 집계 요청에 자기 메트릭 회신.
|
|
255
404
|
// 단일 프로세스면 no-op(cluster.isWorker=false).
|
|
256
405
|
installWorkerResponder()
|
|
257
|
-
return server
|
|
406
|
+
return { server, appLogger }
|
|
258
407
|
}
|
|
259
408
|
|
|
260
409
|
if (workers === null) {
|
|
261
410
|
// 단일 프로세스(클러스터 비활성) — 기존 경로 유지.
|
|
262
|
-
const server = await bootListen()
|
|
263
|
-
|
|
411
|
+
const { server, appLogger } = await bootListen()
|
|
412
|
+
announce(appLogger, `listening on [${server.hosts.join(', ')}]`)
|
|
264
413
|
return 0
|
|
265
414
|
}
|
|
266
415
|
|
|
267
416
|
// 클러스터 모드 — 마스터는 워커 N개 fork·respawn·graceful 협응(MegaCluster), 각 워커가 bootApp+listen.
|
|
268
417
|
// Node cluster 가 마스터의 공유 listen 소켓을 워커들에 분배하므로 SO_REUSEPORT 불필요(ADR-030/154).
|
|
269
|
-
|
|
418
|
+
// 마스터 grace 는 워커 shutdown 예산 상한(MegaShutdown hardKill 60s) + 마진으로 위계화한다 —
|
|
419
|
+
// 마스터 기본값(30s)을 그대로 쓰면 워커가 hook(어댑터 disconnect 등)을 다 돌기 전에 SIGKILL 된다.
|
|
420
|
+
const mega = new MegaCluster({ instances: workers, gracePeriodMs: DEFAULT_HARD_KILL_MS + 5_000 })
|
|
421
|
+
// 마스터 조율 로그(SIGINT 수신·워커 종료/respawn 등)를 pino 로(ADR-180). 마스터는 bootApp 을 안 해
|
|
422
|
+
// pino 인스턴스가 없으므로 config 로 직접 만든다. 워커는 bootApp 의 appLogger 를 쓰니 primary 에서만
|
|
423
|
+
// 만들어(워커당 중복 transport worker 회피) start 전에 주입한다.
|
|
424
|
+
/** @type {any} */ let masterLogger = null
|
|
425
|
+
if (mega.isPrimary()) {
|
|
426
|
+
const { global: masterGlobal } = await loadAndValidateConfig(projectRoot)
|
|
427
|
+
masterLogger = buildLogger(/** @type {any} */ (masterGlobal).logger)
|
|
428
|
+
mega.setLogger(masterLogger)
|
|
429
|
+
}
|
|
270
430
|
await mega.start(async () => {
|
|
271
|
-
const server = await bootListen()
|
|
272
|
-
|
|
431
|
+
const { server, appLogger } = await bootListen()
|
|
432
|
+
announce(appLogger, `worker ${process.pid} listening on [${server.hosts.join(', ')}]`)
|
|
273
433
|
})
|
|
274
434
|
if (mega.isPrimary()) {
|
|
275
435
|
// 마스터에 메트릭 집계기 설치(ADR-163) — 워커의 /metrics 요청을 받아 전 워커 합산해 회신.
|
|
276
436
|
installPrimaryAggregator()
|
|
277
|
-
|
|
437
|
+
announce(masterLogger, `cluster master ${process.pid} forked ${workers} worker(s)`)
|
|
278
438
|
}
|
|
279
439
|
return 0
|
|
280
440
|
}
|
|
441
|
+
}
|
|
281
442
|
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
443
|
+
/**
|
|
444
|
+
* 빌트인 명령 전체를 담은 commander program 을 만든다(ADR-195 — 파서 단일화의 정본).
|
|
445
|
+
* {@link BUILTIN_COMMANDS} 와 동기 유지. action 은 `process.exit` 없이 `setExit(code)` 로 보고한다.
|
|
446
|
+
*
|
|
447
|
+
* @param {object} deps
|
|
448
|
+
* @param {string[]} deps.argv - 원본 argv(`--watch` 재실행 명령 빌드용).
|
|
449
|
+
* @param {(msg: string) => void} deps.out
|
|
450
|
+
* @param {(msg: string) => void} deps.err
|
|
451
|
+
* @param {string} deps.projectRoot - 이미 `--root` 해석된 기준 디렉토리.
|
|
452
|
+
* @param {{ debug?: Function, info?: Function, warn?: Function }} [deps.logger]
|
|
453
|
+
* @param {Function} deps.spawn
|
|
454
|
+
* @param {string} deps.selfPath
|
|
455
|
+
* @param {(code: number) => void} deps.setExit
|
|
456
|
+
* @returns {import('commander').Command}
|
|
457
|
+
*/
|
|
458
|
+
function buildProgram({ argv, out, err, projectRoot, logger, spawn, selfPath, setExit }) {
|
|
459
|
+
const program = new Command()
|
|
460
|
+
program
|
|
461
|
+
.name('mega')
|
|
462
|
+
.description('MEGA-FRAMEWORK CLI')
|
|
463
|
+
.exitOverride()
|
|
464
|
+
// 도움말 폭 고정 — 터미널 폭에 따라 줄바꿈이 달라지면 USAGE 가 비결정적이 된다(테스트·문서 안정).
|
|
465
|
+
.configureHelp({ helpWidth: 100 })
|
|
466
|
+
.configureOutput({
|
|
467
|
+
writeOut: (s) => out(s.replace(/\n+$/, '')),
|
|
468
|
+
writeErr: (s) => err(s.replace(/\n+$/, '')),
|
|
469
|
+
})
|
|
470
|
+
.option('--root <dir>', '프로젝트 루트(기본: 현재 디렉토리)')
|
|
287
471
|
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
}
|
|
472
|
+
// 프로젝트 `.env` 자동 로드(ADR-152) — 스캐폴드 생성(new/generate)만 제외(NO_ENV_COMMANDS).
|
|
473
|
+
// preAction 시점이라 각 명령의 config 로드보다 항상 먼저다.
|
|
474
|
+
program.hook('preAction', (_thisCmd, actionCmd) => {
|
|
475
|
+
if (!NO_ENV_COMMANDS.has(actionCmd.name())) loadProjectEnv(projectRoot, logger)
|
|
476
|
+
})
|
|
293
477
|
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
478
|
+
program
|
|
479
|
+
.command('start')
|
|
480
|
+
.alias('serve')
|
|
481
|
+
.description('앱 부팅 + HTTP listen')
|
|
482
|
+
.option('--port <n>', 'listen 포트(기본: server/global 설정 또는 3000)')
|
|
483
|
+
.option('--host <h>', 'listen 호스트')
|
|
484
|
+
.option(
|
|
485
|
+
'--cluster [n]',
|
|
486
|
+
"워커 프로세스 수 — 정수 N 또는 'max'(CPU 코어 수, 베어 플래그도 max). 우선순위: 플래그 > MEGA_CLUSTER_WORKERS env > server.cluster config. 1/미지정 = 단일 프로세스",
|
|
487
|
+
)
|
|
488
|
+
.option('--watch', 'dev watch — 파일 변경 시 자동 재시작(node 내장 --watch 재실행, 단일 프로세스 강제)')
|
|
489
|
+
.action(async (/** @type {any} */ opts) => {
|
|
490
|
+
setExit(await runStart(opts, { argv, out, projectRoot, logger, spawn, selfPath }))
|
|
491
|
+
})
|
|
492
|
+
|
|
493
|
+
program
|
|
494
|
+
.command('worker')
|
|
495
|
+
.description('잡 소비 워커 런타임 호스트')
|
|
496
|
+
.action(async () => {
|
|
497
|
+
await runWorkerHost(projectRoot, logger)
|
|
498
|
+
out('mega: worker started')
|
|
499
|
+
})
|
|
500
|
+
|
|
501
|
+
program
|
|
502
|
+
.command('scheduler')
|
|
503
|
+
.description('분산 스케줄러 호스트')
|
|
504
|
+
.action(async () => {
|
|
505
|
+
await runSchedulerHost(projectRoot, logger)
|
|
506
|
+
out('mega: scheduler started')
|
|
507
|
+
})
|
|
302
508
|
|
|
303
|
-
//
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
509
|
+
// 마이그레이션 러너(ADR-149) — 일회성 호스트 3종. `--db` 는 fail-closed 해석(resolveDb).
|
|
510
|
+
const migrateAction = (/** @type {'up'|'down'|'status'} */ direction) =>
|
|
511
|
+
async (/** @type {any} */ opts) => {
|
|
512
|
+
await runMigrateHost(projectRoot, { direction, dbKey: resolveDb(opts.db), logger, out })
|
|
513
|
+
}
|
|
514
|
+
program
|
|
515
|
+
.command('migrate')
|
|
516
|
+
.description('pending 마이그레이션 일괄 적용(up)')
|
|
517
|
+
.option('--db <key>', '대상 db(services.databases 키, 기본: 유일 선언 db 또는 primary)')
|
|
518
|
+
.action(migrateAction('up'))
|
|
519
|
+
program
|
|
520
|
+
.command('migrate:down')
|
|
521
|
+
.description('마지막 적용 마이그레이션 1개 롤백(down)')
|
|
522
|
+
.option('--db <key>', '대상 db')
|
|
523
|
+
.action(migrateAction('down'))
|
|
524
|
+
program
|
|
525
|
+
.command('migrate:status')
|
|
526
|
+
.description('적용/미적용 마이그레이션 목록')
|
|
527
|
+
.option('--db <key>', '대상 db')
|
|
528
|
+
.action(migrateAction('status'))
|
|
529
|
+
// 자동 생성(ADR-204) — journal diff 기반. DB 연결 불요, 적용은 기존 `mega migrate` 가 담당.
|
|
530
|
+
program
|
|
531
|
+
.command('migrate:generate')
|
|
532
|
+
.description('모델 static schema ↔ journal snapshot diff 로 마이그레이션 파일 자동 생성')
|
|
533
|
+
.argument('[name]', '마이그레이션 이름(kebab-case, 기본: 변경 내용에서 자동 추론)')
|
|
534
|
+
.option('--renames <map>', '비인터랙티브 rename 매핑 — "old:new[,old2:new2]" (후보 불일치 시 fail-fast)')
|
|
535
|
+
.option('--dry-run', 'SQL 출력만(파일·journal 변경 없음)')
|
|
536
|
+
.option('--check', 'CI 드리프트 게이트 — 변경 있으면 exit 1, 파일 생성 없음')
|
|
537
|
+
.option('--concurrent', '인덱스 전용 생성을 온라인(no-tx)으로 — postgres CONCURRENTLY / maria ALGORITHM=INPLACE,LOCK=NONE / mongo 는 4.2+ 항상 online(표기); sqlite 미지원(거부)')
|
|
538
|
+
.option('--allow-destroy-drops', '파괴적 산출의 명시 옵트인 — 비인터랙티브 rename 후보의 drop+add 진행 + 모델 제거/table 변경의 테이블(컬렉션) 전체 DROP(ADR-210 게이트)')
|
|
539
|
+
.option('--adapter <key>', '특정 adapter(services.databases 키)만 처리(기본: 전부)')
|
|
540
|
+
.option('--app <name>', '마이그레이션 파일을 둘 앱(기본: main)', 'main')
|
|
541
|
+
.action(async (/** @type {string | undefined} */ name, /** @type {any} */ opts) => {
|
|
542
|
+
const r = await runMigrateGenerate(projectRoot, {
|
|
543
|
+
name,
|
|
544
|
+
renames: opts.renames,
|
|
545
|
+
dryRun: opts.dryRun === true,
|
|
546
|
+
check: opts.check === true,
|
|
547
|
+
concurrent: opts.concurrent === true,
|
|
548
|
+
allowDestroyDrops: opts.allowDestroyDrops === true,
|
|
549
|
+
adapter: opts.adapter,
|
|
550
|
+
app: opts.app,
|
|
551
|
+
out,
|
|
552
|
+
logger,
|
|
553
|
+
})
|
|
554
|
+
// --check 드리프트 발견은 CI 게이트용 비정상 종료("generate 안 돌림" 검출).
|
|
555
|
+
if (opts.check === true && r.changed) setExit(1)
|
|
556
|
+
})
|
|
557
|
+
|
|
558
|
+
// scaffold/dev 명령군(new/generate/routes/test/console) — 정의는 commands/scaffold.js 가 정본.
|
|
559
|
+
// 빌트인이 아닌 generator kind 는 플러그인 scaffold manifest 를 조회한다(`mega.scaffold.register`,
|
|
560
|
+
// 03-api-spec §11). 이 폴백 경로에 한해 `.env` 를 로드한다 — 플러그인은 대상 프로젝트의 config 에
|
|
561
|
+
// 선언되므로(NO_ENV_COMMANDS 의 "프로젝트 무관" 전제가 깨짐) process.env 참조가 채워져 있어야 한다.
|
|
562
|
+
const resolvePluginGenerator = async (/** @type {string} */ kind) => {
|
|
563
|
+
loadProjectEnv(projectRoot, logger)
|
|
564
|
+
const { global } = await loadAndValidateConfig(projectRoot)
|
|
565
|
+
const host = new MegaPluginHost({ logger })
|
|
566
|
+
await loadPlugins(/** @type {any} */ (global).plugins, host, { projectRoot, logger })
|
|
567
|
+
return host.getGenerator(kind)
|
|
307
568
|
}
|
|
569
|
+
registerScaffoldCommands(program, { out, projectRoot, logger, resolvePluginGenerator, setExit })
|
|
570
|
+
|
|
571
|
+
return program
|
|
572
|
+
}
|
|
308
573
|
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
const
|
|
312
|
-
|
|
574
|
+
/** 도움말 생성용 no-op deps — action 은 호출되지 않으므로 안전. @returns {Parameters<typeof buildProgram>[0]} */
|
|
575
|
+
function helpProgramDeps() {
|
|
576
|
+
const noop = () => {}
|
|
577
|
+
return { argv: [], out: noop, err: noop, projectRoot: '', logger: undefined, spawn: nodeSpawn, selfPath: '', setExit: noop }
|
|
578
|
+
}
|
|
579
|
+
|
|
580
|
+
/** CLI 사용법 텍스트 — commander 자동 생성(ADR-195) + 플러그인 명령 안내. 명령·옵션 정의가 곧 도움말의
|
|
581
|
+
* 단일 정본이라 수기 USAGE 와의 드리프트가 없다. */
|
|
582
|
+
export const USAGE = `${buildProgram(helpProgramDeps()).helpInformation()}
|
|
583
|
+
플러그인 명령:
|
|
584
|
+
mega <plugin:command> [args...] mega.config.js 의 plugins 가 등록한 CLI 명령 실행 (mega help 가 프로젝트 안에서 목록 병기)`
|
|
313
585
|
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
586
|
+
/**
|
|
587
|
+
* `mega help` 에 프로젝트 플러그인 등록물(CLI 명령 + scaffold generator manifest)을 동적으로 병기한다
|
|
588
|
+
* (ADR-195/199). 프로젝트 밖/config 오류면 병기만 생략 — help 는 어디서든 떠야 하므로 비치명적이다
|
|
589
|
+
* (P4: debug 로그로 가시화).
|
|
590
|
+
* @param {string} projectRoot
|
|
591
|
+
* @param {(msg: string) => void} out
|
|
592
|
+
* @param {{ debug?: Function }} [logger]
|
|
593
|
+
* @returns {Promise<void>}
|
|
594
|
+
*/
|
|
595
|
+
async function appendPluginCommandsHelp(projectRoot, out, logger) {
|
|
596
|
+
try {
|
|
597
|
+
const { global } = await loadAndValidateConfig(projectRoot)
|
|
598
|
+
const host = new MegaPluginHost({ logger })
|
|
599
|
+
await loadPlugins(/** @type {any} */ (global).plugins, host, { projectRoot, logger })
|
|
600
|
+
const names = host.listCommands()
|
|
601
|
+
if (names.length > 0) {
|
|
602
|
+
out('\n등록된 플러그인 명령:')
|
|
603
|
+
for (const n of names) {
|
|
604
|
+
const desc = host.getCommand(n)?.description ?? ''
|
|
605
|
+
out(` mega ${n}${desc ? ` ${desc}` : ''}`)
|
|
606
|
+
}
|
|
607
|
+
}
|
|
608
|
+
const generators = host.listGenerators()
|
|
609
|
+
if (generators.length > 0) {
|
|
610
|
+
out('\n등록된 플러그인 generator:')
|
|
611
|
+
for (const g of generators) {
|
|
612
|
+
const desc = host.getGenerator(g)?.description ?? ''
|
|
613
|
+
out(` mega g ${g} <name>${desc ? ` ${desc}` : ''}`)
|
|
614
|
+
}
|
|
615
|
+
}
|
|
616
|
+
} catch (e) {
|
|
617
|
+
// help 는 프로젝트 밖(config 부재)에서도 떠야 한다 — 플러그인 목록 병기만 생략(비치명적).
|
|
618
|
+
logger?.debug?.({ err: e }, 'cli.help plugin listing skipped')
|
|
619
|
+
}
|
|
317
620
|
}
|
|
318
621
|
|
|
319
622
|
/**
|
|
@@ -352,6 +655,29 @@ export function collectRegistrations(global, host, kind) {
|
|
|
352
655
|
return [...staticPart, ...dynamicPart]
|
|
353
656
|
}
|
|
354
657
|
|
|
658
|
+
/**
|
|
659
|
+
* CLI 호스트(worker/scheduler) 로거 배선 — `bin/mega.js` 는 `runCli` 에 logger 를 주입하지 않으므로
|
|
660
|
+
* (undefined), config 의 pino 로거를 만들어 종료 로그(`MegaShutdown.setLogger`)·flush 훅에 쓴다. 이로써
|
|
661
|
+
* `mega worker`/`mega scheduler` 의 자기 로그·종료 로그가 console 이 아니라 pino 로 나간다(ADR-180).
|
|
662
|
+
* 주입(테스트)이 있으면 그쪽을 그대로 쓰고 pino 는 만들지 않는다(side-effect 회피).
|
|
663
|
+
* @param {Object} global - global config(`logger` 보유 가능).
|
|
664
|
+
* @param {{ info?: Function, warn?: Function } | undefined} injectedLogger - 주입 로거(테스트) 또는 undefined.
|
|
665
|
+
* @returns {{ info?: Function, warn?: Function } | null} 호스트 로그에 쓸 로거(없으면 null).
|
|
666
|
+
*/
|
|
667
|
+
function wireHostLogger(global, injectedLogger) {
|
|
668
|
+
if (injectedLogger) return injectedLogger
|
|
669
|
+
const appLogger = buildLogger(/** @type {any} */ (global).logger)
|
|
670
|
+
if (appLogger) {
|
|
671
|
+
// 종료 시퀀스 로그를 pino 로(ADR-178) + graceful 시 로그 버퍼 flush. 'logs' stage 라 종료
|
|
672
|
+
// 시퀀스의 마지막에 drain 된다(다른 stage 의 hook 들이 남긴 로그까지 포함).
|
|
673
|
+
MegaShutdown.setLogger(appLogger)
|
|
674
|
+
MegaShutdown.register('mega-logger', async () => {
|
|
675
|
+
await new Promise((resolve) => appLogger.flush(() => resolve(undefined)))
|
|
676
|
+
}, { stage: 'logs' })
|
|
677
|
+
}
|
|
678
|
+
return appLogger
|
|
679
|
+
}
|
|
680
|
+
|
|
355
681
|
/**
|
|
356
682
|
* `mega worker` 호스트 골격 — config + 어댑터 connect + ctx + `MegaJobWorker` 인스턴스 + graceful.
|
|
357
683
|
* 등록 소스 = `config.jobs` + 플러그인 `mega.jobs.register` 분(`collectRegistrations`, ADR-123).
|
|
@@ -362,6 +688,7 @@ export function collectRegistrations(global, host, kind) {
|
|
|
362
688
|
export async function runWorkerHost(projectRoot, logger) {
|
|
363
689
|
// bootApp 과 같은 토대(config → 플러그인 install → 어댑터 connect → ctx).
|
|
364
690
|
const { global, host, ctx } = await prepareRuntime(projectRoot, { ping: false, logger })
|
|
691
|
+
const log = wireHostLogger(global, logger)
|
|
365
692
|
const worker = new MegaJobWorker({ ctx })
|
|
366
693
|
// 잡 메트릭 (ADR-132) — prepareRuntime 이 health.exposeMetrics 시 이미 MegaMetrics.init 했고,
|
|
367
694
|
// 옵트인 OFF 면 subscribeJobs 는 no-op() 을 반환한다. start 전에 구독해 enqueue(dispatch)부터 잡는다. 구독은
|
|
@@ -371,11 +698,12 @@ export async function runWorkerHost(projectRoot, logger) {
|
|
|
371
698
|
// 미선언·중복을 부팅 시 fail-fast.
|
|
372
699
|
const jobs = collectRegistrations(global, host, 'jobs')
|
|
373
700
|
for (const JobClass of jobs) worker.register(/** @type {any} */ (JobClass))
|
|
374
|
-
|
|
701
|
+
log?.info?.({ count: jobs.length }, 'worker.jobs registered')
|
|
375
702
|
await worker.start()
|
|
703
|
+
// 'jobs' stage — 새 잡 수신을 멈추고 진행 중 잡을 완료시킨 뒤 어댑터가 끊기게 한다.
|
|
376
704
|
MegaShutdown.register('mega-worker', async () => {
|
|
377
705
|
await worker.stop()
|
|
378
|
-
})
|
|
706
|
+
}, { stage: 'jobs' })
|
|
379
707
|
MegaShutdown.setupSignals()
|
|
380
708
|
return worker
|
|
381
709
|
}
|
|
@@ -388,16 +716,18 @@ export async function runWorkerHost(projectRoot, logger) {
|
|
|
388
716
|
*/
|
|
389
717
|
export async function runSchedulerHost(projectRoot, logger) {
|
|
390
718
|
const { global, host, ctx } = await prepareRuntime(projectRoot, { ping: false, logger })
|
|
719
|
+
const log = wireHostLogger(global, logger)
|
|
391
720
|
const scheduler = new MegaScheduler({ ctx })
|
|
392
721
|
// 등록 소스(ADR-123) = config.schedules(정적) + 플러그인 host.listSchedules()(동적). register 가
|
|
393
722
|
// cron 미선언·중복을 부팅 시 fail-fast.
|
|
394
723
|
const schedules = collectRegistrations(global, host, 'schedules')
|
|
395
724
|
for (const TaskClass of schedules) scheduler.register(/** @type {any} */ (TaskClass))
|
|
396
|
-
|
|
725
|
+
log?.info?.({ count: schedules.length }, 'scheduler.schedules registered')
|
|
397
726
|
scheduler.start()
|
|
727
|
+
// 'jobs' stage — cron 트리거를 멈추고 실행 중 핸들러를 완료시킨다(ClosingScheduler).
|
|
398
728
|
MegaShutdown.register('mega-scheduler', async () => {
|
|
399
729
|
await scheduler.stop()
|
|
400
|
-
})
|
|
730
|
+
}, { stage: 'jobs' })
|
|
401
731
|
MegaShutdown.setupSignals()
|
|
402
732
|
return scheduler
|
|
403
733
|
}
|
|
@@ -405,6 +735,11 @@ export async function runSchedulerHost(projectRoot, logger) {
|
|
|
405
735
|
/**
|
|
406
736
|
* 마이그레이션 대상 DB 어댑터 해석 — `services.databases` 의 globalKey 로 조회한다. `--db <key>` 미지정
|
|
407
737
|
* 시 유일 선언 db, 그게 아니면 `primary`, 둘 다 아니면(다중·미선언) fail-fast 로 명시를 요구한다.
|
|
738
|
+
*
|
|
739
|
+
* 러너는 SQL `query` 기반이라(ADR-149 ⑥) `query` 도메인 메서드를 구현하지 않은 어댑터(mongodb 등
|
|
740
|
+
* Document DB)는 대상이 될 수 없다 — 베이스의 `adapter.not_implemented` 가 늦게 터지는 대신 여기서
|
|
741
|
+
* `migrate.unsupported_driver` 로 명시 fail-fast 한다(ADR-190).
|
|
742
|
+
*
|
|
408
743
|
* @param {Object} global - global config.
|
|
409
744
|
* @param {string} [dbKey] - `--db` 플래그.
|
|
410
745
|
* @returns {import('../adapters/mega-adapter.js').MegaAdapter}
|
|
@@ -429,7 +764,20 @@ export function resolveMigrationAdapter(global, dbKey) {
|
|
|
429
764
|
details: { db: key, declared: keys },
|
|
430
765
|
})
|
|
431
766
|
}
|
|
432
|
-
|
|
767
|
+
const adapter = getAdapter('db', key)
|
|
768
|
+
// mongodb 는 SQL 이 아니라 도큐먼트 API 마이그레이션 대상(ADR-209) — 러너 부기는 호스트가
|
|
769
|
+
// mongo 셈({@link module:core/migration/mongo-migration-db})으로 번역하므로 query 검사를 거치지 않는다.
|
|
770
|
+
if (dbs[key]?.driver === 'mongodb') return adapter
|
|
771
|
+
// 구체 어댑터가 query 를 override 하지 않았으면 SQL 마이그레이션 실행 불가(Document DB 등) — 명시 거부.
|
|
772
|
+
if (/** @type {any} */ (adapter).query === MegaDbAdapter.prototype.query) {
|
|
773
|
+
throw new MegaConfigError(
|
|
774
|
+
'migrate.unsupported_driver',
|
|
775
|
+
`db '${key}' (driver '${dbs[key]?.driver ?? '?'}') 는 SQL query 를 지원하지 않아 마이그레이션 대상이 될 수 없습니다 — ` +
|
|
776
|
+
'마이그레이션은 postgres/mariadb/sqlite(SQL) + mongodb(도큐먼트 API, ADR-209)만 지원합니다(ADR-149).',
|
|
777
|
+
{ details: { db: key, driver: dbs[key]?.driver ?? null } },
|
|
778
|
+
)
|
|
779
|
+
}
|
|
780
|
+
return adapter
|
|
433
781
|
}
|
|
434
782
|
|
|
435
783
|
/**
|
|
@@ -437,11 +785,28 @@ export function resolveMigrationAdapter(global, dbKey) {
|
|
|
437
785
|
* disconnect. 워커/wsHub/메트릭은 띄우지 않는다(마이그레이션엔 불필요·이벤트루프 유지 회피).
|
|
438
786
|
* `MegaShutdown.now`(process.exit)를 쓰지 않고 직접 disconnect 해 반환값으로 결과를 돌려준다(테스트 가능).
|
|
439
787
|
*
|
|
788
|
+
* up/down 은 driver 별 마이그레이션 락({@link module:core/migration-lock}, ADR-190)으로 직렬화한다 —
|
|
789
|
+
* 동시 `mega migrate`(멀티 인스턴스 배포 훅)의 중복 적용 방지. status 는 읽기 전용이라 락 없이 실행.
|
|
790
|
+
*
|
|
440
791
|
* @param {string} projectRoot
|
|
441
792
|
* @param {{ direction?: 'up'|'down'|'status', dbKey?: string, logger?: { debug?: Function, info?: Function, warn?: Function }, out?: (msg: string) => void }} [opts]
|
|
442
|
-
* @returns {Promise<{ applied: string[] } | { rolledBack: string|null } | { applied: string[], pending: string[] }>}
|
|
793
|
+
* @returns {Promise<{ applied: string[] } | { rolledBack: string|null } | { applied: string[], pending: string[], modified: string[] }>}
|
|
443
794
|
*/
|
|
444
795
|
export async function runMigrateHost(projectRoot, { direction = 'up', dbKey, logger, out = console.log } = {}) {
|
|
796
|
+
// bin 경유 실행은 logger 가 없다 — 러너의 운영 경고(checksum 드리프트·no-tx 등)가 무음으로
|
|
797
|
+
// 사라지지 않도록 CLI 출력으로 폴백한다(배포 훅이 드리프트 상태를 조용히 통과하는 것 방지).
|
|
798
|
+
// pino 시그니처 양형(`(obj, msg)` / `(msg)`)을 모두 수용한다 — 락 모듈은 문자열 단독으로 호출.
|
|
799
|
+
const fmt = (/** @type {any} */ o, /** @type {string | undefined} */ msg) => {
|
|
800
|
+
const text = msg ?? (typeof o === 'string' ? o : '')
|
|
801
|
+
const suffix = typeof o === 'object' && o !== null && typeof o.migration === 'string' ? ` — ${o.migration}` : ''
|
|
802
|
+
return `${text}${suffix}`
|
|
803
|
+
}
|
|
804
|
+
const log =
|
|
805
|
+
logger ??
|
|
806
|
+
{
|
|
807
|
+
info: (/** @type {any} */ o, /** @type {string} */ msg) => out(`[migrate] ${fmt(o, msg)}`),
|
|
808
|
+
warn: (/** @type {any} */ o, /** @type {string} */ msg) => out(`[migrate] 경고: ${fmt(o, msg)}`),
|
|
809
|
+
}
|
|
445
810
|
const { global, apps } = await loadAndValidateConfig(projectRoot)
|
|
446
811
|
// 플러그인 install 을 어댑터 build 보다 먼저(config-driven driver 제약, boot.js 주석 참조).
|
|
447
812
|
const host = new MegaPluginHost({ logger })
|
|
@@ -449,21 +814,30 @@ export async function runMigrateHost(projectRoot, { direction = 'up', dbKey, log
|
|
|
449
814
|
buildFromGlobalConfig(global)
|
|
450
815
|
await connectAll({ logger })
|
|
451
816
|
try {
|
|
452
|
-
const
|
|
817
|
+
const adapter = /** @type {any} */ (resolveMigrationAdapter(global, dbKey))
|
|
818
|
+
// mongodb 는 러너 부기 SQL 을 collection 연산으로 번역하는 셈을 끼운다 — 러너/마이그레이션
|
|
819
|
+
// 파일 모두 이 객체를 받는다(파일의 db 는 사실상 native Db, ADR-209). 락은 어댑터 기준.
|
|
820
|
+
let db = adapter
|
|
821
|
+
if (adapter?.getStats?.().driver === 'mongodb') {
|
|
822
|
+
const { createMongoMigrationDb } = await import('../core/migration/mongo-migration-db.js')
|
|
823
|
+
db = createMongoMigrationDb(adapter.native)
|
|
824
|
+
}
|
|
453
825
|
const appNames = apps.map((a) => a.name)
|
|
454
826
|
if (direction === 'status') {
|
|
455
827
|
const s = await migrateStatus({ db, projectRoot, appNames })
|
|
456
828
|
out(`migrations — applied: ${s.applied.length}, pending: ${s.pending.length}`)
|
|
457
829
|
for (const n of s.applied) out(` [x] ${n}`)
|
|
458
830
|
for (const n of s.pending) out(` [ ] ${n}`)
|
|
831
|
+
// 적용 후 수정된(checksum 불일치) 파일 — 실행된 스키마와 어긋난 드리프트 경고(ADR-190).
|
|
832
|
+
for (const n of s.modified) out(` [!] ${n} (modified after apply — checksum mismatch)`)
|
|
459
833
|
return s
|
|
460
834
|
}
|
|
461
835
|
if (direction === 'down') {
|
|
462
|
-
const r = await migrateDown({ db, projectRoot, appNames, log
|
|
836
|
+
const r = await withMigrationLock(adapter, () => migrateDown({ db, projectRoot, appNames, log }), { logger: log })
|
|
463
837
|
out(r.rolledBack ? `rolled back: ${r.rolledBack}` : 'nothing to roll back')
|
|
464
838
|
return r
|
|
465
839
|
}
|
|
466
|
-
const r = await migrateUp({ db, projectRoot, appNames, log
|
|
840
|
+
const r = await withMigrationLock(adapter, () => migrateUp({ db, projectRoot, appNames, log }), { logger: log })
|
|
467
841
|
out(r.applied.length ? `applied ${r.applied.length} migration(s): ${r.applied.join(', ')}` : 'no pending migrations')
|
|
468
842
|
return r
|
|
469
843
|
} finally {
|