@platformatic/watt-extra 1.14.0 → 1.14.2

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.
Files changed (3) hide show
  1. package/cli.js +36 -20
  2. package/package.json +1 -1
  3. package/test/cli.test.js +50 -1
package/cli.js CHANGED
@@ -2,7 +2,7 @@
2
2
  import commist from 'commist'
3
3
  import minimist from 'minimist'
4
4
  import { resolve, join, dirname } from 'node:path'
5
- import { fileURLToPath } from 'node:url'
5
+ import { fileURLToPath, pathToFileURL } from 'node:url'
6
6
  import helpMeInit from 'help-me'
7
7
  import { readFileSync } from 'node:fs'
8
8
  import { start, logger } from './index.js'
@@ -27,14 +27,11 @@ function version () {
27
27
  }
28
28
  }
29
29
 
30
- // Handle start command
31
- async function startCommand (argv) {
32
- if (process.stdout.isTTY) {
33
- console.log(getSimpleBanner(pkg.version))
34
- } else {
35
- logger.info(`WattExtra v${pkg.version}`)
36
- }
37
-
30
+ // Parse start command argv and apply CLI options to env.
31
+ // Precedence for PLT_LOG_LEVEL: --log-level flag > pre-set env > 'info' default.
32
+ // Do NOT add a minimist default for `log-level`: that would make args['log-level']
33
+ // always truthy and unconditionally clobber an env-provided value.
34
+ export function applyStartArgs (argv, env = process.env) {
38
35
  const args = minimist(argv, {
39
36
  alias: {
40
37
  h: 'help',
@@ -46,33 +43,50 @@ async function startCommand (argv) {
46
43
  boolean: ['help'],
47
44
  string: ['log-level', 'icc-url', 'app-name', 'app-dir'],
48
45
  default: {
49
- 'log-level': 'info',
50
46
  'app-dir': process.cwd()
51
47
  }
52
48
  })
53
49
 
54
- logger.debug({ args, argv }, 'Start command arguments')
55
-
56
50
  if (args.help) {
57
- helpMe.toStdout('start')
58
- return true
51
+ return { args, help: true }
59
52
  }
60
53
 
61
- // Set environment variables based on CLI options
62
54
  if (args['log-level']) {
63
- process.env.PLT_LOG_LEVEL = args['log-level']
55
+ env.PLT_LOG_LEVEL = args['log-level']
56
+ } else if (!env.PLT_LOG_LEVEL) {
57
+ env.PLT_LOG_LEVEL = 'info'
64
58
  }
65
59
 
66
60
  if (args['icc-url']) {
67
- process.env.PLT_ICC_URL = args['icc-url']
61
+ env.PLT_ICC_URL = args['icc-url']
68
62
  }
69
63
 
70
64
  if (args['app-name']) {
71
- process.env.PLT_APP_NAME = args['app-name']
65
+ env.PLT_APP_NAME = args['app-name']
72
66
  }
73
67
 
74
68
  if (args['app-dir']) {
75
- process.env.PLT_APP_DIR = resolve(args['app-dir']) // Ensure the path is absolute
69
+ env.PLT_APP_DIR = resolve(args['app-dir']) // Ensure the path is absolute
70
+ }
71
+
72
+ return { args, help: false }
73
+ }
74
+
75
+ // Handle start command
76
+ async function startCommand (argv) {
77
+ if (process.stdout.isTTY) {
78
+ console.log(getSimpleBanner(pkg.version))
79
+ } else {
80
+ logger.info(`WattExtra v${pkg.version}`)
81
+ }
82
+
83
+ const { args, help } = applyStartArgs(argv)
84
+
85
+ logger.debug({ args, argv }, 'Start command arguments')
86
+
87
+ if (help) {
88
+ helpMe.toStdout('start')
89
+ return true
76
90
  }
77
91
 
78
92
  await start()
@@ -144,4 +158,6 @@ async function run () {
144
158
  }
145
159
  }
146
160
 
147
- run()
161
+ if (import.meta.url === pathToFileURL(process.argv[1]).href) {
162
+ run()
163
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@platformatic/watt-extra",
3
- "version": "1.14.0",
3
+ "version": "1.14.2",
4
4
  "description": "The Platformatic runtime manager",
5
5
  "type": "module",
6
6
  "scripts": {
package/test/cli.test.js CHANGED
@@ -1,8 +1,9 @@
1
1
  import assert from 'node:assert'
2
2
  import { test } from 'node:test'
3
3
  import { spawn } from 'node:child_process'
4
- import { join, dirname } from 'node:path'
4
+ import { join, resolve, dirname } from 'node:path'
5
5
  import { fileURLToPath } from 'node:url'
6
+ import { applyStartArgs } from '../cli.js'
6
7
 
7
8
  const __filename = fileURLToPath(import.meta.url)
8
9
  const __dirname = dirname(__filename)
@@ -90,3 +91,51 @@ test('CLI should output JSON log without banner in non-TTY mode (version command
90
91
  'Non-TTY output should include JSON log with version'
91
92
  )
92
93
  })
94
+
95
+ test('applyStartArgs: --log-level flag overrides env-provided PLT_LOG_LEVEL', () => {
96
+ const env = { PLT_LOG_LEVEL: 'warn' }
97
+ applyStartArgs(['--log-level', 'debug'], env)
98
+ assert.strictEqual(env.PLT_LOG_LEVEL, 'debug')
99
+ })
100
+
101
+ test('applyStartArgs: -l short flag also overrides env', () => {
102
+ const env = { PLT_LOG_LEVEL: 'warn' }
103
+ applyStartArgs(['-l', 'trace'], env)
104
+ assert.strictEqual(env.PLT_LOG_LEVEL, 'trace')
105
+ })
106
+
107
+ // Regression test: cli.js used to have `default: { 'log-level': 'info' }` in its
108
+ // minimist config, which populated args['log-level'] with 'info' whenever the flag
109
+ // was not passed. The subsequent unconditional write to process.env.PLT_LOG_LEVEL
110
+ // then silently clobbered the value provided by the deployment environment (e.g.
111
+ // PLT_LOG_LEVEL=warn from k8s), forcing the runtime to log at info regardless.
112
+ test('applyStartArgs: preserves env-provided PLT_LOG_LEVEL when --log-level is not passed', () => {
113
+ const env = { PLT_LOG_LEVEL: 'warn' }
114
+ applyStartArgs([], env)
115
+ assert.strictEqual(env.PLT_LOG_LEVEL, 'warn')
116
+ })
117
+
118
+ test('applyStartArgs: defaults PLT_LOG_LEVEL to "info" when neither env nor flag is set', () => {
119
+ const env = {}
120
+ applyStartArgs([], env)
121
+ assert.strictEqual(env.PLT_LOG_LEVEL, 'info')
122
+ })
123
+
124
+ test('applyStartArgs: passes through other CLI options to env', () => {
125
+ const env = {}
126
+ applyStartArgs([
127
+ '--icc-url', 'http://icc.example',
128
+ '--app-name', 'my-app',
129
+ '--app-dir', 'test/fixtures/runtime-service'
130
+ ], env)
131
+ assert.strictEqual(env.PLT_ICC_URL, 'http://icc.example')
132
+ assert.strictEqual(env.PLT_APP_NAME, 'my-app')
133
+ assert.strictEqual(env.PLT_APP_DIR, resolve('test/fixtures/runtime-service'))
134
+ })
135
+
136
+ test('applyStartArgs: --help short-circuits without mutating env', () => {
137
+ const env = {}
138
+ const res = applyStartArgs(['--help'], env)
139
+ assert.strictEqual(res.help, true)
140
+ assert.strictEqual(env.PLT_LOG_LEVEL, undefined)
141
+ })