@whyour/qinglong 2.22.0 → 2.23.0

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 (150) hide show
  1. package/back/protos/cron.proto +4 -0
  2. package/docs/development/node-cron-migration.md +49 -0
  3. package/docs/development/task-startup.md +78 -0
  4. package/docs/releases/2.22.0.md +8 -0
  5. package/docs/releases/2.23.0.md +33 -0
  6. package/docs/script-history.md +53 -0
  7. package/package.json +9 -8
  8. package/scripts/benchmark-script-history.cjs +39 -0
  9. package/scripts/publish-static.sh +34 -0
  10. package/scripts/sync-static.sh +20 -0
  11. package/scripts/wait-for-mirror.sh +214 -0
  12. package/shell/api.sh +56 -70
  13. package/shell/node_path_cache.sh +10 -2
  14. package/shell/otask.sh +7 -9
  15. package/shell/preload/sitecustomize.js +6 -2
  16. package/shell/preload/sitecustomize.py +4 -2
  17. package/shell/share.sh +1 -1
  18. package/shell/task-timeout.sh +63 -0
  19. package/shell/task.sh +8 -6
  20. package/shell/update.sh +40 -95
  21. package/shell/upgrade.cjs +8 -0
  22. package/static/build/api/config.js +2 -6
  23. package/static/build/api/env.js +15 -14
  24. package/static/build/api/open.js +2 -1
  25. package/static/build/api/script.js +155 -9
  26. package/static/build/api/subscription.js +3 -6
  27. package/static/build/api/system.js +35 -3
  28. package/static/build/config/grpcCerts.js +89 -40
  29. package/static/build/config/subscription.js +19 -11
  30. package/static/build/config/util.js +6 -4
  31. package/static/build/loaders/express.js +2 -0
  32. package/static/build/loaders/initData.js +20 -30
  33. package/static/build/loaders/initTask.js +11 -1
  34. package/static/build/middlewares/uniqueConstraintError.js +15 -0
  35. package/static/build/protos/cron.js +63 -2
  36. package/static/build/schedule/addCron.js +45 -63
  37. package/static/build/schedule/client.js +19 -1
  38. package/static/build/schedule/delCron.js +1 -1
  39. package/static/build/schedule/setConcurrency.js +27 -0
  40. package/static/build/services/config.js +2 -3
  41. package/static/build/services/cron.js +36 -10
  42. package/static/build/services/env.js +1 -1
  43. package/static/build/services/grpc.js +2 -1
  44. package/static/build/services/log.js +1 -1
  45. package/static/build/services/open.js +106 -31
  46. package/static/build/services/schedule.js +20 -10
  47. package/static/build/services/script.js +1 -1
  48. package/static/build/services/scriptHistory.js +30 -0
  49. package/static/build/services/sshKey.js +39 -14
  50. package/static/build/services/subscription.js +104 -53
  51. package/static/build/services/system.js +67 -32
  52. package/static/build/services/user.js +15 -10
  53. package/static/build/shared/cronCommand.js +17 -0
  54. package/static/build/shared/cronSchedule.js +101 -0
  55. package/static/build/shared/cronScheduler.js +73 -0
  56. package/static/build/shared/i18n.js +3 -2
  57. package/static/build/shared/logPath.js +15 -0
  58. package/static/build/shared/loginThrottle.js +45 -0
  59. package/static/build/shared/pLimit.js +19 -6
  60. package/static/build/shared/runCron.js +13 -4
  61. package/static/build/shared/scriptHistory.js +445 -0
  62. package/static/build/shared/shellQuote.js +11 -0
  63. package/static/build/shared/subscriptionMutationLock.js +34 -0
  64. package/static/build/shared/subscriptionPath.js +41 -0
  65. package/static/build/shared/subscriptionStorage.js +98 -0
  66. package/static/build/shared/utils.js +2 -1
  67. package/static/build/token.js +3 -14
  68. package/static/build/validation/schedule.js +3 -18
  69. package/static/dist/292.264757f0.async.js +1 -0
  70. package/static/dist/3512.95e41255.async.js +1 -0
  71. package/static/dist/index.html +2 -2
  72. package/static/dist/preload_helper.01fcd534.js +1 -0
  73. package/static/dist/src__pages__dependence__modal.0fa8b421.async.js +1 -0
  74. package/static/dist/src__pages__diff__index.b94e5dc5.async.js +1 -0
  75. package/static/dist/src__pages__script__editModal.afabf073.async.js +1 -0
  76. package/static/dist/src__pages__script__editNameModal.789ad87b.async.js +1 -0
  77. package/static/dist/src__pages__script__historyDrawer.8c58d958.async.js +1 -0
  78. package/static/dist/src__pages__script__historyDrawer.a449193a.chunk.css +1 -0
  79. package/static/dist/src__pages__script__index.ab360776.chunk.css +1 -0
  80. package/static/dist/src__pages__script__index.fc575945.async.js +1 -0
  81. package/static/dist/src__pages__script__saveModal.8fca1a22.async.js +1 -0
  82. package/static/dist/src__pages__script__saveWithHistory.99ece830.async.js +1 -0
  83. package/static/dist/src__pages__subscription__modal.30868ba8.async.js +1 -0
  84. package/static/dist/{umi.fc019050.js → umi.3a24a9fa.js} +1 -1
  85. package/test/back/advisory-input-security.test.cjs +416 -0
  86. package/test/back/code-scanning-security.test.cjs +189 -0
  87. package/test/back/cron-macros.test.cjs +51 -0
  88. package/test/back/cron-schedule-compatibility.test.cjs +69 -0
  89. package/test/back/cron-scheduler-routing.test.cjs +59 -0
  90. package/test/back/draft-path-security.test.cjs +235 -0
  91. package/test/back/env-import-security.test.cjs +91 -0
  92. package/test/back/execution-lifecycle.test.cjs +1 -1
  93. package/test/back/file-access-scope.test.cjs +180 -0
  94. package/test/back/grpc-mtls-security.test.cjs +136 -0
  95. package/test/back/http-security.test.cjs +105 -5
  96. package/test/back/legacy-cron-recovery.test.cjs +76 -0
  97. package/test/back/linux-mirror-result.test.cjs +176 -0
  98. package/test/back/listen-security.test.cjs +1 -0
  99. package/test/back/mirror-status.test.cjs +257 -0
  100. package/test/back/node-cron-migration.test.cjs +65 -0
  101. package/test/back/node-path-cache.test.cjs +29 -0
  102. package/test/back/node-path-lock.test.cjs +6 -2
  103. package/test/back/preload-lazy-notify.test.cjs +168 -0
  104. package/test/back/queued-cron-invalidation.test.cjs +98 -0
  105. package/test/back/restart-instance-recovery.test.cjs +116 -0
  106. package/test/back/scheduler-bulk-recovery.test.cjs +40 -0
  107. package/test/back/scheduler-concurrency.test.cjs +411 -0
  108. package/test/back/scheduler-reconciliation.test.cjs +58 -4
  109. package/test/back/script-file-access.test.cjs +210 -0
  110. package/test/back/script-history-api.test.cjs +551 -0
  111. package/test/back/script-history.test.cjs +383 -0
  112. package/test/back/shell-api-parsing.test.cjs +4 -4
  113. package/test/back/shell-translation-output.test.cjs +16 -0
  114. package/test/back/shell-upgrade.test.cjs +312 -0
  115. package/test/back/shellApiToken.test.cjs +151 -0
  116. package/test/back/ssh-config-home.test.cjs +113 -0
  117. package/test/back/static-mirror-trigger.test.cjs +441 -0
  118. package/test/back/static-mirror.test.cjs +179 -0
  119. package/test/back/stop-race.test.cjs +5 -1
  120. package/test/back/subscription-mutation-lock.test.cjs +83 -0
  121. package/test/back/subscription-review-regression.test.cjs +607 -0
  122. package/test/back/subscription-storage-regression.test.cjs +553 -0
  123. package/test/back/system-dependence-cache.test.cjs +1 -0
  124. package/test/back/system-export-history.test.cjs +119 -0
  125. package/test/back/systemTokenRenewal.test.cjs +497 -0
  126. package/test/back/task-shell-lifecycle.test.cjs +194 -0
  127. package/test/back/unique-constraint-error.test.cjs +72 -0
  128. package/test/back/upgrade-guards.test.cjs +285 -0
  129. package/test/back/upgrade-lifecycle.test.cjs +288 -0
  130. package/test/back/upgrade-transaction.test.cjs +133 -0
  131. package/test/back/user-security.test.cjs +102 -1
  132. package/test/back/wpush-grpc.test.cjs +1 -0
  133. package/test/fixtures/legacy-cron.json +1371 -0
  134. package/test/front/diff-file-routing.test.cjs +126 -0
  135. package/test/front/script-history-save.test.cjs +121 -0
  136. package/test/helpers/upgrade-fixture.cjs +30 -0
  137. package/version.yaml +14 -19
  138. package/static/dist/2096.6d98fd12.async.js +0 -1
  139. package/static/dist/4859.97d6653c.async.js +0 -1
  140. package/static/dist/6707.801b886b.async.js +0 -1
  141. package/static/dist/preload_helper.cf7de3fa.js +0 -1
  142. package/static/dist/src__pages__dependence__modal.a29c1a0f.async.js +0 -1
  143. package/static/dist/src__pages__diff__index.1714b941.async.js +0 -1
  144. package/static/dist/src__pages__script__editModal.22acdf7c.async.js +0 -1
  145. package/static/dist/src__pages__script__editNameModal.1a521cc0.async.js +0 -1
  146. package/static/dist/src__pages__script__index.60b6f827.chunk.css +0 -1
  147. package/static/dist/src__pages__script__index.a18b2692.async.js +0 -1
  148. package/static/dist/src__pages__script__saveModal.8965b74c.async.js +0 -1
  149. package/static/dist/src__pages__subscription__modal.38991e1e.async.js +0 -1
  150. /package/static/dist/{4859.1b962b29.chunk.css → 292.1b962b29.chunk.css} +0 -0
@@ -0,0 +1,312 @@
1
+ const test = require('node:test');
2
+ const assert = require('node:assert/strict');
3
+ const fs = require('node:fs');
4
+ const os = require('node:os');
5
+ const path = require('node:path');
6
+ const http = require('node:http');
7
+ const { spawn, execFileSync } = require('node:child_process');
8
+ const {
9
+ writeManifest,
10
+ sourceCommit,
11
+ } = require('../helpers/upgrade-fixture.cjs');
12
+ const { waitForHealth, withUpgradeLock } = require('../../shell/upgrade.cjs');
13
+
14
+ const share = `
15
+ export dir_root="$QL_DIR" dir_shell="$QL_DIR/shell" dir_tmp="$QL_DIR/.tmp"
16
+ export dir_data="$QL_DIR/data" dir_static="$QL_DIR/static" dir_log="$QL_DIR/data/log" dir_config="$QL_DIR/data/config"
17
+ load_ql_envs() { :; }
18
+ import_config() { :; }
19
+ fix_config() { :; }
20
+ make_dir() { mkdir -p "$1"; }
21
+ format_timestamp() { date +%s; }
22
+ format_time() { printf '%s' "$2"; }
23
+ t() { printf "$@"; }
24
+ npm_install_2() {
25
+ printf installed > "$QL_DIR/installed"
26
+ exit_status="$DEP_STATUS"
27
+ mkdir -p "$1/node_modules"
28
+ printf new > "$1/node_modules/dependency"
29
+ }
30
+ delete_pm2() { printf stopped >> "$QL_DIR/stops"; }
31
+ reload_pm2() {
32
+ printf started >> "$QL_DIR/starts"
33
+ if [[ "$FAIL_START" == 'true' ]] && [[ ! -f "$QL_DIR/failed-once" ]]; then
34
+ touch "$QL_DIR/failed-once"; return 1
35
+ fi
36
+ }
37
+ `;
38
+
39
+ function write(root, name, content) {
40
+ const filename = path.join(root, name);
41
+ fs.mkdirSync(path.dirname(filename), { recursive: true });
42
+ fs.writeFileSync(filename, content);
43
+ return filename;
44
+ }
45
+
46
+ function run(program, args, options) {
47
+ return new Promise((resolve, reject) => {
48
+ const cp = spawn(program, args, {
49
+ ...options,
50
+ stdio: ['ignore', 'pipe', 'pipe'],
51
+ });
52
+ let stdout = '',
53
+ stderr = '';
54
+ cp.stdout.on('data', (chunk) => {
55
+ stdout += chunk;
56
+ });
57
+ cp.stderr.on('data', (chunk) => {
58
+ stderr += chunk;
59
+ });
60
+ cp.on('error', reject);
61
+ cp.on('close', (code) => resolve({ code, stdout, stderr }));
62
+ });
63
+ }
64
+
65
+ async function fixture(t, options = {}) {
66
+ const base = fs.mkdtempSync(path.join(os.tmpdir(), 'ql-shell-upgrade-'));
67
+ t.after(() => fs.rmSync(base, { recursive: true, force: true }));
68
+ const root = path.join(base, 'panel'),
69
+ payload = path.join(base, 'payload'),
70
+ archives = path.join(base, 'archives');
71
+ const branch = ['develop', 'debian-dev'].includes(options.branch)
72
+ ? 'develop'
73
+ : 'master';
74
+ const source = path.join(payload, `qinglong-${sourceCommit}`),
75
+ staticRoot = path.join(payload, `qinglong-static-${branch}`);
76
+ const packageJson = '{"version":"2.22.0"}';
77
+ for (const target of [root, source]) {
78
+ write(target, 'shell/update.sh', fs.readFileSync('shell/update.sh'));
79
+ write(target, 'shell/upgrade.cjs', fs.readFileSync('shell/upgrade.cjs'));
80
+ write(
81
+ target,
82
+ 'cli/src/internal/maintenance/upgradeArtifacts.cjs',
83
+ fs.readFileSync('cli/src/internal/maintenance/upgradeArtifacts.cjs'),
84
+ );
85
+ write(target, 'shell/share.sh', share);
86
+ write(target, 'shell/api.sh', '');
87
+ write(target, 'shell/env.sh', '');
88
+ write(target, 'sample/config.sample.sh', 'sample');
89
+ write(target, 'package.json', packageJson);
90
+ write(
91
+ target,
92
+ 'pnpm-lock.yaml',
93
+ target === source && options.lockChange ? 'new lock' : 'old lock',
94
+ );
95
+ write(target, 'back/app.ts', target === source ? 'new' : 'old');
96
+ write(
97
+ target,
98
+ 'version.yaml',
99
+ target === source ? 'version: 2.22.0' : 'version: 2.21.0',
100
+ );
101
+ }
102
+ write(root, 'node_modules/dependency', 'old');
103
+ write(root, '.env', 'private setting');
104
+ write(root, 'data/config/config.sh', 'custom');
105
+ write(root, 'static/build/app.js', 'old backend');
106
+ write(root, 'static/dist/index.html', 'old frontend');
107
+ write(root, '.tmp/import-in-progress', 'keep');
108
+ write(staticRoot, 'build/app.js', 'new backend');
109
+ write(staticRoot, 'dist/index.html', '<script src="umi.js"></script>');
110
+ write(staticRoot, 'dist/umi.js', 'dashboard');
111
+ write(source, '.env.example', 'new example');
112
+ writeManifest(source, staticRoot);
113
+ const manifestFile = path.join(staticRoot, 'build-info.json');
114
+ const manifest = JSON.parse(fs.readFileSync(manifestFile));
115
+ if (options.manifest === 'missing') fs.unlinkSync(manifestFile);
116
+ else if (options.manifest === 'dirty')
117
+ fs.writeFileSync(
118
+ manifestFile,
119
+ JSON.stringify({ ...manifest, dirty: true }),
120
+ );
121
+ else if (options.manifest === 'lock')
122
+ fs.writeFileSync(
123
+ manifestFile,
124
+ JSON.stringify({ ...manifest, lockfileSha256: '0'.repeat(64) }),
125
+ );
126
+ else if (options.manifest === 'commit')
127
+ fs.writeFileSync(
128
+ manifestFile,
129
+ JSON.stringify({ ...manifest, sourceCommit: 'b'.repeat(40) }),
130
+ );
131
+ else if (options.manifest === 'checksum')
132
+ write(staticRoot, 'dist/umi.js', 'stale frontend');
133
+ else if (options.manifest === 'extra')
134
+ write(staticRoot, 'build/stale.js', 'stale backend');
135
+ else if (options.manifest === 'frontend')
136
+ fs.unlinkSync(path.join(staticRoot, 'dist/index.html'));
137
+ fs.mkdirSync(archives);
138
+ for (const repo of ['qinglong', 'qinglong-static']) {
139
+ const archive = path.join(archives, `${repo}.zip`);
140
+ execFileSync(
141
+ 'zip',
142
+ [
143
+ '-qr',
144
+ archive,
145
+ `${repo}-${repo === 'qinglong' ? sourceCommit : branch}`,
146
+ ],
147
+ { cwd: payload },
148
+ );
149
+ if (options.corrupt === repo) fs.writeFileSync(archive, 'invalid zip');
150
+ }
151
+ const curl = write(
152
+ base,
153
+ 'bin/curl',
154
+ `#!${process.execPath}
155
+ const fs=require('node:fs'),path=require('node:path'),args=process.argv.slice(2);
156
+ if(args.includes('--head')) process.exit(7);
157
+ const repo=args.at(-1).includes('/qinglong-static/')?'qinglong-static':'qinglong';
158
+ fs.appendFileSync(process.env.TRACE,args.at(-1)+'\\n');
159
+ if(process.env.FAIL_DOWNLOAD===repo) process.exit(22);
160
+ fs.copyFileSync(path.join(process.env.ARCHIVES,repo+'.zip'),args[args.indexOf('--output')+1]);
161
+ `,
162
+ );
163
+ fs.chmodSync(curl, 0o755);
164
+ const server = http.createServer((req, res) =>
165
+ res.end('{"code":200,"data":{"status":"ok"}}'),
166
+ );
167
+ await new Promise((resolve) => server.listen(0, '127.0.0.1', resolve));
168
+ t.after(() => new Promise((resolve) => server.close(resolve)));
169
+ const env = {
170
+ ...process.env,
171
+ QL_DIR: root,
172
+ QL_BRANCH: options.branch || 'master',
173
+ PATH: `${path.join(base, 'bin')}:${process.env.PATH}`,
174
+ QlPort: String(server.address().port),
175
+ ARCHIVES: archives,
176
+ TRACE: path.join(base, 'trace'),
177
+ real_time: options.tee ? 'false' : 'true',
178
+ FAIL_DOWNLOAD: options.download || '',
179
+ DEP_STATUS: options.depFail ? '1' : '0',
180
+ FAIL_START: options.failStart ? 'true' : 'false',
181
+ };
182
+ return {
183
+ root,
184
+ env,
185
+ execute: (...args) =>
186
+ run('bash', [path.join(root, 'shell/update.sh'), ...args], { env }),
187
+ read: (name) => fs.readFileSync(path.join(root, name), 'utf8'),
188
+ };
189
+ }
190
+
191
+ for (const options of [
192
+ { download: 'qinglong' },
193
+ { download: 'qinglong-static', tee: true },
194
+ { corrupt: 'qinglong' },
195
+ { corrupt: 'qinglong-static', tee: true },
196
+ ...[
197
+ 'missing',
198
+ 'dirty',
199
+ 'lock',
200
+ 'commit',
201
+ 'checksum',
202
+ 'extra',
203
+ 'frontend',
204
+ ].map((manifest) => ({ manifest })),
205
+ { lockChange: true, depFail: true, tee: true },
206
+ ])
207
+ test(`failed update preserves the running panel: ${JSON.stringify(
208
+ options,
209
+ )}`, async (t) => {
210
+ const f = await fixture(t, options);
211
+ const result = await f.execute('update');
212
+ assert.notEqual(result.code, 0, result.stdout + result.stderr);
213
+ assert.equal(f.read('version.yaml'), 'version: 2.21.0');
214
+ assert.equal(f.read('node_modules/dependency'), 'old');
215
+ assert.equal(f.read('static/dist/index.html'), 'old frontend');
216
+ assert.equal(fs.existsSync(path.join(f.root, 'stops')), false);
217
+ assert.equal(f.read('.tmp/import-in-progress'), 'keep');
218
+ assert.deepEqual(fs.readdirSync(path.join(f.root, '.tmp')), [
219
+ 'import-in-progress',
220
+ ]);
221
+ });
222
+
223
+ for (const branch of ['master', 'develop', 'debian', 'debian-dev'])
224
+ test(`download-only then reload installs matching artifacts and lockfile dependencies: ${branch}`, async (t) => {
225
+ const f = await fixture(t, { branch, lockChange: true, tee: true });
226
+ let result = await f.execute('update', 'false');
227
+ assert.equal(result.code, 0, result.stdout + result.stderr);
228
+ assert.equal(f.read('version.yaml'), 'version: 2.21.0');
229
+ assert.equal(fs.existsSync(path.join(f.root, 'stops')), false);
230
+ assert.match(
231
+ fs.readFileSync(f.env.TRACE, 'utf8'),
232
+ new RegExp(`qinglong/repository/archive/${sourceCommit}\\.zip`),
233
+ );
234
+ result = await f.execute('reload', 'system');
235
+ assert.equal(result.code, 0, result.stdout + result.stderr);
236
+ assert.equal(f.read('node_modules/dependency'), 'new');
237
+ assert.equal(f.read('pnpm-lock.yaml'), 'new lock');
238
+ assert.equal(f.read('static/dist/umi.js'), 'dashboard');
239
+ assert.equal(f.read('back/app.ts'), 'new');
240
+ assert.equal(f.read('.env'), 'private setting');
241
+ assert.equal(f.read('.env.example'), 'new example');
242
+ assert.equal(f.read('data/config/config.sh'), 'custom');
243
+ assert.deepEqual(fs.readdirSync(path.join(f.root, '.tmp')), [
244
+ 'import-in-progress',
245
+ ]);
246
+ assert.ok(
247
+ !fs.readdirSync(f.root).some((name) => name.includes('ql-backup')),
248
+ );
249
+ });
250
+
251
+ test('a failed start rolls code, frontend and node_modules back and exits nonzero through tee', async (t) => {
252
+ const f = await fixture(t, { lockChange: true, failStart: true, tee: true });
253
+ const result = await f.execute('update');
254
+ assert.notEqual(result.code, 0);
255
+ assert.equal(f.read('version.yaml'), 'version: 2.21.0');
256
+ assert.equal(f.read('node_modules/dependency'), 'old');
257
+ assert.equal(f.read('static/dist/index.html'), 'old frontend');
258
+ assert.equal(f.read('starts'), 'startedstarted');
259
+ assert.ok(!fs.readdirSync(f.root).some((name) => name.includes('ql-backup')));
260
+ });
261
+
262
+ test('reload revalidates staged files before stopping the old panel', async (t) => {
263
+ const f = await fixture(t);
264
+ assert.equal((await f.execute('update', 'false')).code, 0);
265
+ const directory = JSON.parse(
266
+ f.read('.tmp/upgrade-ready-master.json'),
267
+ ).directory;
268
+ write(
269
+ f.root,
270
+ `.tmp/${directory}/qinglong-static-master/dist/umi.js`,
271
+ 'corrupt',
272
+ );
273
+ assert.notEqual((await f.execute('reload', 'system')).code, 0);
274
+ assert.equal(fs.existsSync(path.join(f.root, 'stops')), false);
275
+ });
276
+
277
+ test('a new successful stage retires only the previous ready workspace', async (t) => {
278
+ const f = await fixture(t);
279
+ assert.equal((await f.execute('update', 'false')).code, 0);
280
+ const previous = JSON.parse(
281
+ f.read('.tmp/upgrade-ready-master.json'),
282
+ ).directory;
283
+ assert.equal((await f.execute('update', 'false')).code, 0);
284
+ const current = JSON.parse(
285
+ f.read('.tmp/upgrade-ready-master.json'),
286
+ ).directory;
287
+ assert.notEqual(previous, current);
288
+ assert.equal(fs.existsSync(path.join(f.root, '.tmp', previous)), false);
289
+ assert.equal(f.read('.tmp/import-in-progress'), 'keep');
290
+ });
291
+
292
+ test('failed health checks and concurrent upgrades are rejected', async (t) => {
293
+ const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'ql-upgrade-lock-'));
294
+ t.after(() => fs.rmSync(tmp, { recursive: true, force: true }));
295
+ await withUpgradeLock(tmp, async () => {
296
+ await assert.rejects(
297
+ withUpgradeLock(tmp, async () => {}),
298
+ /Another upgrade/,
299
+ );
300
+ });
301
+ assert.deepEqual(fs.readdirSync(tmp), []);
302
+ const server = http.createServer((req, res) => {
303
+ res.statusCode = 503;
304
+ res.end('{"code":503}');
305
+ });
306
+ await new Promise((resolve) => server.listen(0, '127.0.0.1', resolve));
307
+ t.after(() => new Promise((resolve) => server.close(resolve)));
308
+ await assert.rejects(
309
+ waitForHealth({ QlPort: String(server.address().port) }, 20),
310
+ /health check/,
311
+ );
312
+ });
@@ -0,0 +1,151 @@
1
+ const assert = require('node:assert/strict');
2
+ const fs = require('node:fs');
3
+ const os = require('node:os');
4
+ const path = require('node:path');
5
+ const { spawnSync } = require('node:child_process');
6
+ const { test } = require('node:test');
7
+
8
+ const apiFile = path.resolve(__dirname, '../../shell/api.sh');
9
+
10
+ const endpoints = {
11
+ status: {
12
+ method: 'PUT', url: /\/open\/crons\/status\?t=\d+$/,
13
+ body: { ids: ['37'], status: '1', pid: '4321', log_path: 'task/run.log',
14
+ last_execution_time: 1787004000, last_running_time: 90, exit_code: 0 },
15
+ success: '', failure: (message) => message,
16
+ },
17
+ statistics: {
18
+ method: 'POST', url: /\/open\/dashboard\/record$/,
19
+ body: { ref_id: 37, code: 0, elapsed: 90 },
20
+ success: '', failure: (message) => message,
21
+ },
22
+ add: {
23
+ method: 'POST', url: /\/open\/crons\?t=\d+$/,
24
+ body: { name: 'sample job', command: 'task job.py', schedule: '0 * * * *', sub_id: null },
25
+ success: 'sample job -> 添加成功', failure: (message) => `sample job -> 添加失败(${message})`,
26
+ },
27
+ update: {
28
+ method: 'PUT', url: /\/open\/crons\?t=\d+$/,
29
+ body: { name: 'sample job', command: 'task job.py', schedule: '0 * * * *', id: '37' },
30
+ success: 'sample job -> 更新成功', failure: (message) => `sample job -> 更新失败(${message})`,
31
+ },
32
+ command: {
33
+ method: 'PUT', url: /\/open\/crons\?t=\d+$/,
34
+ body: { command: 'task job.py', id: '37' },
35
+ success: 'task job.py -> 更新成功', failure: (message) => `task job.py -> 更新失败(${message})`,
36
+ },
37
+ delete: {
38
+ method: 'DELETE', url: /\/open\/crons\?t=\d+$/,
39
+ body: [37, 38], success: '成功', failure: (message) => `失败(${message})`,
40
+ },
41
+ notify: {
42
+ method: 'PUT', url: /\/open\/system\/notify\?t=\d+$/,
43
+ body: { title: 'title', content: 'body' },
44
+ success: '通知发送成功🎉', failure: (message) => `通知失败(${message})`,
45
+ },
46
+ find: {
47
+ method: 'GET', url: /\/open\/crons\/detail\?log_path=task\/run.log&t=\d+$/,
48
+ body: null, success: 'sample job', failure: () => '',
49
+ },
50
+ auth: {
51
+ method: 'PUT', url: /\/open\/system\/auth\/reset\?t=\d+$/,
52
+ body: { retries: 0 }, success: '重置登录错误次数成功🎉',
53
+ failure: (message) => `重置登录错误次数失败(${message})`,
54
+ },
55
+ };
56
+
57
+ function runCallback(endpoint, scenario) {
58
+ const directory = fs.mkdtempSync(path.join(os.tmpdir(), 'ql-api-token-'));
59
+ try {
60
+ const tokenFile = path.join(directory, 'token.json');
61
+ fs.writeFileSync(tokenFile, JSON.stringify({
62
+ value: 'initial-token', expiration: Math.floor(Date.now() / 1000) + 3600,
63
+ }));
64
+ const child = spawnSync('bash', ['-c', `
65
+ . "$API_FILE"
66
+ create_token() {
67
+ printf 'refresh\\n' >> "$CAPTURE"
68
+ __ql_token__=fresh-token
69
+ printf '{"value":"fresh-token","expiration":4102444800}' > "$file_auth_token"
70
+ }
71
+ case "$SCENARIO" in
72
+ expired) printf '{"value":"initial-token","expiration":1}' > "$file_auth_token" ;;
73
+ replaced) printf '{"value":"fresh-token","expiration":4102444800}' > "$file_auth_token" ;;
74
+ esac
75
+ curl() {
76
+ local auth body url method arg
77
+ while [[ $# -gt 0 ]]; do
78
+ arg="$1"; shift
79
+ case "$arg" in
80
+ -H) [[ "$1" == Authorization:* ]] && auth="$1"; shift ;;
81
+ --data-raw) body="$1"; shift ;;
82
+ -X) method="$1"; shift ;;
83
+ http:*) url="$arg" ;;
84
+ esac
85
+ done
86
+ printf '%s\\n%s\\n%s\\n%s\\n' "$auth" "$method" "$url" "\${body:-null}" >> "$CAPTURE"
87
+ if [[ "$SCENARIO" == forbidden ]]; then
88
+ printf '{"code":403,"message":"forbidden"}'
89
+ elif [[ "$SCENARIO" == unavailable ]]; then
90
+ printf '{"code":500,"message":"unavailable"}'
91
+ elif [[ "$SCENARIO" == persistent || ( "$SCENARIO" != valid && "$auth" != 'Authorization: Bearer fresh-token' ) ]]; then
92
+ printf '{"code":401,"message":"Token 已失效"}'
93
+ else
94
+ printf '{"code":200,"data":{"name":"sample job"}}'
95
+ fi
96
+ }
97
+ t() { printf "$@"; }
98
+ case "$ENDPOINT" in
99
+ status) update_cron '"37"' 1 4321 'task/run.log' 1787004000 90 0 execution-37 ;;
100
+ statistics) record_cron_stat 37 0 90 ;;
101
+ add) add_cron_api '0 * * * *' 'task job.py' 'sample job' ;;
102
+ update) update_cron_api '0 * * * *' 'task job.py' 'sample job' 37 ;;
103
+ command) update_cron_command_api 'task job.py' 37 ;;
104
+ delete) del_cron_api '37,38' ;;
105
+ notify) notify_api title body ;;
106
+ find) find_cron_api 'log_path=task/run.log' ;;
107
+ auth) update_auth_config '"retries":0' '重置登录错误次数' ;;
108
+ esac
109
+ `], {
110
+ env: { ...process.env, PATH: `/usr/bin:/bin:${process.env.PATH}`, API_FILE: apiFile, file_auth_token: tokenFile,
111
+ CAPTURE: path.join(directory, 'requests'), SCENARIO: scenario,
112
+ ENDPOINT: endpoint, ql_port: '5700' },
113
+ encoding: 'utf8', timeout: 10_000,
114
+ });
115
+ assert.equal(child.status, 0, child.stderr);
116
+ assert.equal(child.stderr, '');
117
+ const lines = fs.readFileSync(path.join(directory, 'requests'), 'utf8').trim().split('\n');
118
+ const refreshes = lines.filter((line) => line === 'refresh').length;
119
+ const requests = lines.filter((line) => line !== 'refresh');
120
+ const captures = [];
121
+ for (let i = 0; i < requests.length; i += 4) {
122
+ captures.push({ auth: requests[i], method: requests[i + 1],
123
+ url: requests[i + 2], body: JSON.parse(requests[i + 3]) });
124
+ }
125
+ return { output: child.stdout, refreshes, captures };
126
+ } finally {
127
+ fs.rmSync(directory, { recursive: true, force: true });
128
+ }
129
+ }
130
+
131
+ for (const [endpoint, expected] of Object.entries(endpoints)) {
132
+ for (const scenario of ['valid', 'expired', 'replaced', 'rejected', 'persistent', 'forbidden', 'unavailable']) {
133
+ test(`${endpoint} API handles ${scenario} token without unbounded retries`, () => {
134
+ const { output, refreshes, captures } = runCallback(endpoint, scenario);
135
+ const retries = ['rejected', 'persistent'].includes(scenario);
136
+ assert.equal(captures.length, retries ? 2 : 1);
137
+ assert.equal(refreshes, ['expired', 'rejected', 'persistent'].includes(scenario) ? 1 : 0);
138
+ for (const capture of captures) {
139
+ assert.deepEqual(capture.body, expected.body);
140
+ assert.equal(capture.method, expected.method);
141
+ assert.match(capture.url, expected.url);
142
+ }
143
+ if (['expired', 'replaced', 'rejected'].includes(scenario)) {
144
+ assert.equal(captures.at(-1).auth, 'Authorization: Bearer fresh-token');
145
+ }
146
+ const error = scenario === 'persistent' ? 'Token 已失效'
147
+ : scenario === 'forbidden' ? 'forbidden' : scenario === 'unavailable' ? 'unavailable' : '';
148
+ assert.equal(output.trim(), error ? expected.failure(error) : expected.success);
149
+ });
150
+ }
151
+ }
@@ -0,0 +1,113 @@
1
+ const assert = require('node:assert/strict');
2
+ const fs = require('node:fs/promises');
3
+ const os = require('node:os');
4
+ const path = require('node:path');
5
+ const test = require('node:test');
6
+ const load = require('../helpers/load-security-module.cjs');
7
+
8
+ async function fixture(t, sameHome = false, missingUser = false) {
9
+ const directory = await fs.mkdtemp(path.join(os.tmpdir(), 'ql-ssh-home-'));
10
+ t.after(() => fs.rm(directory, { recursive: true, force: true }));
11
+ const userHome = path.join(directory, 'user');
12
+ const envHome = sameHome ? userHome : path.join(directory, 'env');
13
+ const sshdPath = path.join(directory, 'ssh.d');
14
+ await fs.mkdir(sshdPath);
15
+ const util = {
16
+ fileExist: async (file) =>
17
+ fs.stat(file).then(
18
+ () => true,
19
+ () => false,
20
+ ),
21
+ rmPath: async (file) => fs.rm(file, { force: true }),
22
+ };
23
+ const { writeFileWithLock } = load('back/shared/utils.ts', {
24
+ '../config/util': util,
25
+ });
26
+ let initialized;
27
+ const ready = new Promise((resolve) => (initialized = resolve));
28
+ const SshKeyService = load('back/services/sshKey.ts', {
29
+ os: {
30
+ ...os,
31
+ homedir: () => envHome,
32
+ userInfo: () => {
33
+ if (missingUser) throw Error('No passwd entry');
34
+ return { homedir: userHome };
35
+ },
36
+ },
37
+ '../config': { sshdPath },
38
+ '../config/util': util,
39
+ '../shared/utils': {
40
+ writeFileWithLock: async (file, content, options) => {
41
+ await writeFileWithLock(file, content, options);
42
+ if (content.includes('Include ')) {
43
+ initialized();
44
+ }
45
+ },
46
+ },
47
+ }).default;
48
+ const service = new SshKeyService({ error: assert.fail, warn: assert.fail });
49
+ await ready;
50
+ return { service, userHome, envHome, sshdPath };
51
+ }
52
+
53
+ for (const sameHome of [false, true]) {
54
+ test(`SSH configuration uses the effective user home with ${
55
+ sameHome ? 'matching' : 'overridden'
56
+ } HOME`, async (t) => {
57
+ const { service, userHome, envHome, sshdPath } = await fixture(t, sameHome);
58
+ const configFile = path.join(userHome, '.ssh/config');
59
+ assert.equal(
60
+ await fs.readFile(configFile, 'utf8'),
61
+ `Include ${sshdPath}/*.config\n\n`,
62
+ );
63
+ assert.equal((await fs.stat(path.dirname(configFile))).mode & 0o777, 0o700);
64
+ assert.equal((await fs.stat(configFile)).mode & 0o777, 0o600);
65
+ if (!sameHome)
66
+ await assert.rejects(fs.stat(path.join(envHome, '.ssh/config')), {
67
+ code: 'ENOENT',
68
+ });
69
+ await fs.appendFile(
70
+ configFile,
71
+ 'Host existing\n Hostname example.com\n',
72
+ );
73
+ await service.initSshConfigFile();
74
+ const content = await fs.readFile(configFile, 'utf8');
75
+ assert.equal(content.split('Include ').length, 2);
76
+ assert.match(content, /Host existing/);
77
+ });
78
+ }
79
+
80
+ test('SSH initialization still works for a custom UID without a passwd entry', async (t) => {
81
+ const { envHome, sshdPath } = await fixture(t, true, true);
82
+ assert.equal(
83
+ await fs.readFile(path.join(envHome, '.ssh/config'), 'utf8'),
84
+ `Include ${sshdPath}/*.config\n\n`,
85
+ );
86
+ });
87
+
88
+ test('SSH alias changes retain private key permissions and remove old credentials', async (t) => {
89
+ const { service, sshdPath } = await fixture(t);
90
+ const {
91
+ getSubscriptionSshAlias,
92
+ } = require('../../back/shared/subscriptionPath');
93
+ const original = 'private/中文@v1';
94
+ const renamed = 'renamed/中文@v2';
95
+ await service.addSSHKey('fixture-private-key', original, '127.0.0.1');
96
+ const first = getSubscriptionSshAlias(original);
97
+ assert.equal((await fs.stat(path.join(sshdPath, first))).mode & 0o777, 0o400);
98
+ assert.match(
99
+ await fs.readFile(path.join(sshdPath, `${first}.config`), 'utf8'),
100
+ /Hostname 127\.0\.0\.1/,
101
+ );
102
+ await service.removeSSHKey(original, '127.0.0.1');
103
+ await service.addSSHKey('fixture-private-key', renamed, '127.0.0.1');
104
+ await assert.rejects(fs.stat(path.join(sshdPath, first)), { code: 'ENOENT' });
105
+ await assert.rejects(fs.stat(path.join(sshdPath, `${first}.config`)), {
106
+ code: 'ENOENT',
107
+ });
108
+ assert.equal(
109
+ (await fs.stat(path.join(sshdPath, getSubscriptionSshAlias(renamed))))
110
+ .mode & 0o777,
111
+ 0o400,
112
+ );
113
+ });