@xiangyixie/dsh-superagent 0.10.0 → 0.11.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.
package/bin/archive.js ADDED
@@ -0,0 +1,185 @@
1
+ #!/usr/bin/env node
2
+ /**
3
+ * `dsh-superagent-archive` — prune terminal runs and move one run in or out of
4
+ * the durable store as a self-contained archive.
5
+ *
6
+ * Prune is a dry run unless `--confirm` is given: the command prints every run
7
+ * and byte it would delete first, and it never touches a run that is live or
8
+ * locked by another process.
9
+ */
10
+ import { createStore, resolveStateRoot } from '../lib/store.js'
11
+
12
+ const USAGE = `Usage: dsh-superagent-archive <command> [options]
13
+
14
+ Commands:
15
+ prune list terminal runs that prune would delete (dry run by default)
16
+ export <run-id> write one run as a self-contained archive
17
+ import <path> read an archive back into the local store
18
+
19
+ Common options:
20
+ --state-dir <path> run state directory (default: $DSH_HOME/state/superagent)
21
+ -h, --help show this message
22
+
23
+ prune options:
24
+ --older-than <days> only runs finished at least this many days ago (required)
25
+ --status <list> only these terminal statuses, comma separated
26
+ --confirm actually delete; without it prune only prints the plan
27
+
28
+ export options:
29
+ --out <path> archive path (default: ./superagent-<run-id>[.json|.html])
30
+ --format <kind> dir (default), bundle (one JSON file), or html (one page)
31
+
32
+ import options:
33
+ (none) an existing local run with the same id makes import fail`
34
+
35
+ /** Format a byte count the way the other CLIs in this package do. */
36
+ function sizeText(value) {
37
+ let size = Number(value)
38
+ if (!Number.isFinite(size) || size < 0) size = 0
39
+ if (size < 1024) return `${Math.round(size)} B`
40
+ const units = ['kB', 'MB', 'GB']
41
+ let unit = 'B'
42
+ for (const next of units) {
43
+ if (size < 1024) break
44
+ size /= 1024
45
+ unit = next
46
+ }
47
+ return `${size >= 100 ? size.toFixed(0) : size.toFixed(1)} ${unit}`
48
+ }
49
+
50
+ function fail(message, code = 2) {
51
+ console.error(`${message}\n\n${USAGE}`)
52
+ process.exit(code)
53
+ }
54
+
55
+ function valueOf(argv, index, flag) {
56
+ const value = argv[index]
57
+ if (value === undefined || value.startsWith('--')) fail(`${flag} needs a value`)
58
+ return value
59
+ }
60
+
61
+ function parse(argv) {
62
+ const options = {}
63
+ const positional = []
64
+ for (let index = 0; index < argv.length; index++) {
65
+ const arg = argv[index]
66
+ if (arg === '-h' || arg === '--help') {
67
+ console.log(USAGE)
68
+ process.exit(0)
69
+ } else if (arg === '--state-dir') options.stateDir = valueOf(argv, ++index, '--state-dir')
70
+ else if (arg.startsWith('--state-dir=')) options.stateDir = arg.slice('--state-dir='.length)
71
+ else if (arg === '--older-than') options.olderThan = Number(valueOf(argv, ++index, '--older-than'))
72
+ else if (arg.startsWith('--older-than=')) options.olderThan = Number(arg.slice('--older-than='.length))
73
+ else if (arg === '--status') options.statuses = valueOf(argv, ++index, '--status')
74
+ else if (arg.startsWith('--status=')) options.statuses = arg.slice('--status='.length)
75
+ else if (arg === '--format') options.format = valueOf(argv, ++index, '--format')
76
+ else if (arg.startsWith('--format=')) options.format = arg.slice('--format='.length)
77
+ else if (arg === '--out') options.out = valueOf(argv, ++index, '--out')
78
+ else if (arg.startsWith('--out=')) options.out = arg.slice('--out='.length)
79
+ else if (arg === '--confirm') options.confirm = true
80
+ else if (arg.startsWith('-')) fail(`unknown option: ${arg}`)
81
+ else positional.push(arg)
82
+ }
83
+ return { options, positional }
84
+ }
85
+
86
+ function printPlan(store, plan) {
87
+ console.log(`prune plan for ${store.root}`)
88
+ if (plan.candidates.length === 0) {
89
+ console.log(' nothing to delete: no terminal run matches this window and filter')
90
+ } else {
91
+ const width = Math.max(20, ...plan.candidates.map(candidate => candidate.id.length))
92
+ console.log(` ${plan.candidates.length} run(s) qualify, ${plan.files} file(s), ${sizeText(plan.bytes)}:`)
93
+ console.log(` ${'RUN'.padEnd(width)} ${'STATUS'.padEnd(11)} ${'FINISHED'.padEnd(24)} BYTES`)
94
+ for (const candidate of plan.candidates) {
95
+ console.log(
96
+ ` ${candidate.id.padEnd(width)} ${candidate.status.padEnd(11)} `
97
+ + `${String(candidate.finishedAt).padEnd(24)} ${sizeText(candidate.bytes)}`,
98
+ )
99
+ }
100
+ }
101
+ if (plan.skipped.length > 0) {
102
+ console.log(` skipped ${plan.skipped.length} run(s) held by another process: `
103
+ + plan.skipped.map(entry => entry.id).join(', '))
104
+ }
105
+ }
106
+
107
+ async function prune(options) {
108
+ if (options.olderThan === undefined) fail('prune needs --older-than <days>')
109
+ if (!Number.isFinite(options.olderThan) || options.olderThan <= 0) {
110
+ fail('--older-than must be a positive number of days')
111
+ }
112
+ // No init(): a dry run must not clean stale files either.
113
+ const store = createStore(resolveStateRoot(options.stateDir))
114
+ let plan
115
+ try {
116
+ plan = await store.planPrune({ olderThanDays: options.olderThan, statuses: options.statuses })
117
+ } catch (error) {
118
+ console.error(`cannot plan a prune: ${error?.message ?? error}`)
119
+ process.exit(1)
120
+ }
121
+ printPlan(store, plan)
122
+ if (!options.confirm) {
123
+ console.log('')
124
+ console.log(plan.candidates.length === 0
125
+ ? 'dry run: nothing deleted.'
126
+ : `dry run: nothing deleted; ${plan.candidates.length} run(s), ${sizeText(plan.bytes)} `
127
+ + `in ${plan.files} file(s). Re-run with --confirm to delete.`)
128
+ return
129
+ }
130
+ const result = await store.prune({
131
+ olderThanDays: options.olderThan,
132
+ statuses: options.statuses,
133
+ dryRun: false,
134
+ })
135
+ console.log('')
136
+ console.log(result.removed.length === 0
137
+ ? 'deleted nothing: the runs eligible a moment ago are gone or now held'
138
+ : `deleted ${result.removed.length} run(s), ${sizeText(result.deletedBytes)}`)
139
+ for (const failure of result.failed) console.error(` failed to delete ${failure.id}: ${failure.error}`)
140
+ if (result.failed.length > 0) process.exitCode = 1
141
+ }
142
+
143
+ async function exportRun(options, positional) {
144
+ const runId = positional[0]
145
+ if (!runId) fail('export needs a run id')
146
+ const format = options.format ?? 'dir'
147
+ if (!['dir', 'bundle', 'html'].includes(format)) fail('--format must be dir, bundle, or html')
148
+ const suffix = format === 'dir' ? '' : format === 'html' ? '.html' : '.json'
149
+ const out = options.out ?? `superagent-${runId}${suffix}`
150
+ const store = createStore(resolveStateRoot(options.stateDir))
151
+ let result
152
+ try {
153
+ result = await store.exportRun(runId, out, { format })
154
+ } catch (error) {
155
+ console.error(`cannot export run ${runId}: ${error?.message ?? error}`)
156
+ process.exit(1)
157
+ }
158
+ console.log(`exported run ${result.runId} to ${result.out} (${result.format}, `
159
+ + `${result.files.length} file(s), ${sizeText(result.bytes)})`)
160
+ for (const file of result.files) console.log(` ${file.path} ${sizeText(file.bytes)}`)
161
+ }
162
+
163
+ async function importRun(options, positional) {
164
+ const source = positional[0]
165
+ if (!source) fail('import needs an archive path')
166
+ const store = createStore(resolveStateRoot(options.stateDir))
167
+ await store.init()
168
+ let result
169
+ try {
170
+ result = await store.importRun(source)
171
+ } catch (error) {
172
+ console.error(`cannot import ${source}: ${error?.message ?? error}`)
173
+ process.exit(1)
174
+ }
175
+ console.log(`imported run ${result.run.id} from ${result.format} archive ${result.source}`)
176
+ console.log(` wrote ${result.out}`)
177
+ }
178
+
179
+ const { options, positional } = parse(process.argv.slice(2))
180
+ const command = positional.shift()
181
+ if (!command) fail('a command is required')
182
+ if (command === 'prune') await prune(options)
183
+ else if (command === 'export') await exportRun(options, positional)
184
+ else if (command === 'import') await importRun(options, positional)
185
+ else fail(`unknown command: ${command}`)
package/bin/doctor.js ADDED
@@ -0,0 +1,84 @@
1
+ #!/usr/bin/env node
2
+ /**
3
+ * `dsh-superagent-doctor` — read-only checks for the two ways this package has
4
+ * failed to run after a clean install: a `files` whitelist that dropped an
5
+ * imported module, and a profile copy left half-unpacked by an interrupted
6
+ * install. Prints one block per check and the commands that fix it.
7
+ */
8
+ import path from 'node:path'
9
+ import { fileURLToPath } from 'node:url'
10
+ import { inferProfileDir, renderReport, runDoctor } from '../lib/doctor.js'
11
+
12
+ const USAGE = `Usage: dsh-superagent-doctor [options]
13
+
14
+ Check that this copy of dsh-superagent can actually run:
15
+ - every file the code imports is shipped by package.json "files" and exists
16
+ - the installed copy matches the version package.json claims
17
+ - the installed files match the published tarball (skipped when offline)
18
+ - the DSH profile mounts the bundle patch and the nine tools are registered
19
+ - the running Node satisfies "engines"
20
+
21
+ Nothing is installed or modified; the only network access is one public
22
+ tarball for the hash comparison, and --offline removes even that.
23
+
24
+ Options:
25
+ --package <dir> package copy to inspect (default: the copy this runs from)
26
+ --profile <name> DSH profile name, or a full profile directory
27
+ --offline skip the npm registry comparison
28
+ --no-color never emit ANSI colour
29
+ -h, --help show this message
30
+
31
+ Exit code: 0 when no check fails, 1 when one does, 2 on bad usage.`
32
+
33
+ function valueOf(argv, index, flag) {
34
+ const value = argv[index]
35
+ if (value === undefined || value.startsWith('--')) {
36
+ console.error(`${flag} needs a value\n\n${USAGE}`)
37
+ process.exit(2)
38
+ }
39
+ return value
40
+ }
41
+
42
+ function parse(argv) {
43
+ const options = {}
44
+ for (let index = 0; index < argv.length; index++) {
45
+ const arg = argv[index]
46
+ if (arg === '--package') options.packageRoot = valueOf(argv, ++index, '--package')
47
+ else if (arg.startsWith('--package=')) options.packageRoot = arg.slice('--package='.length)
48
+ else if (arg === '--profile') options.profile = valueOf(argv, ++index, '--profile')
49
+ else if (arg.startsWith('--profile=')) options.profile = arg.slice('--profile='.length)
50
+ else if (arg === '--offline') options.online = false
51
+ else if (arg === '--no-color') options.color = false
52
+ else if (arg === '-h' || arg === '--help') {
53
+ console.log(USAGE)
54
+ process.exit(0)
55
+ } else {
56
+ console.error(`unknown argument: ${arg}\n\n${USAGE}`)
57
+ process.exit(2)
58
+ }
59
+ }
60
+ return options
61
+ }
62
+
63
+ const options = parse(process.argv.slice(2))
64
+ // When installed, bin/ lives one level below the package root. Running the
65
+ // checkout from source resolves to the checkout, which is the same idea.
66
+ const defaultRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..')
67
+ const packageRoot = options.packageRoot ? path.resolve(options.packageRoot) : defaultRoot
68
+
69
+ const result = await runDoctor({
70
+ packageRoot,
71
+ // `undefined` means "infer from where this package lives"; only an explicit
72
+ // `--profile` overrides the inference.
73
+ profile: options.profile,
74
+ online: options.online,
75
+ })
76
+
77
+ const color = options.color !== false
78
+ && process.stdout.isTTY
79
+ && !process.env.NO_COLOR
80
+ console.log(renderReport(result, { color }))
81
+ if (!options.profile && !inferProfileDir(result.targetDir)) {
82
+ console.log('\nnot inside a DSH profile, so only the package itself was checked')
83
+ }
84
+ process.exit(result.ok ? 0 : 1)
package/lib/cost.js ADDED
@@ -0,0 +1,267 @@
1
+ /**
2
+ * Cost accounting for recorded token usage.
3
+ *
4
+ * Prices are list prices per 1M tokens, supplied by the operator as
5
+ * `pricing: { "provider/model": { input, output, cacheRead, currency } }`.
6
+ * A bare model id is accepted as a fallback, and an exact `provider/model`
7
+ * key always wins, so usage logged as `dashscope/qwen-flash` can be priced by
8
+ * `"qwen-flash"` without guessing the provider.
9
+ *
10
+ * Money is accumulated as integer micro-units (1e-6 of the currency), never as
11
+ * floating point. Each model line is rounded once to the nearest micro-unit,
12
+ * the total is a plain integer sum, and presentation rounds that integer once
13
+ * more. A model absent from the table is reported as unpriced — it is never
14
+ * silently priced at zero, because "we do not know" and "it was free" are
15
+ * different answers.
16
+ *
17
+ * @module dsh-superagent/cost
18
+ */
19
+
20
+ /** Micro-units per currency unit. */
21
+ const MICRO = 1_000_000
22
+ /** Tokens per price unit: the table is quoted per million tokens. */
23
+ const TOKENS_PER_PRICE = 1_000_000
24
+ /** The smallest amount the report will print instead of "less than". */
25
+ const SMALLEST_SHOWN_MICROS = 100
26
+
27
+ /**
28
+ * Currency symbol for a three-letter code.
29
+ * @param {string} code - ISO currency code.
30
+ * @returns {string} symbol, or the code plus a space when unknown.
31
+ */
32
+ export function currencySymbol(code) {
33
+ if (code === 'CNY' || code === 'RMB') return '¥'
34
+ if (code === 'USD') return '$'
35
+ if (code === 'EUR') return '€'
36
+ return `${code ?? ''} `
37
+ }
38
+
39
+ /**
40
+ * Convert one configured price to integer micro-units per million tokens.
41
+ * @param {unknown} rate - price quoted per 1M tokens.
42
+ * @returns {number | null} micro-units, or null when the value is unusable.
43
+ */
44
+ function rateMicros(rate) {
45
+ if (typeof rate !== 'number' || !Number.isFinite(rate) || rate < 0) return null
46
+ return Math.round(rate * MICRO)
47
+ }
48
+
49
+ /**
50
+ * Validate and normalise one pricing row.
51
+ * @param {unknown} entry - configured `{ input, output, cacheRead?, cache?, currency? }`.
52
+ * @returns {{ input: number, output: number, cacheRead: number, currency: string,
53
+ * inputMicros: number, outputMicros: number, cacheMicros: number } | null}
54
+ */
55
+ function normalizeEntry(entry) {
56
+ if (!entry || typeof entry !== 'object') return null
57
+ const inputMicros = rateMicros(entry.input)
58
+ const outputMicros = rateMicros(entry.output)
59
+ if (inputMicros === null || outputMicros === null) return null
60
+ // A separate cache rate is optional. Without one, cache reads are priced as
61
+ // ordinary input, which over-reports rather than under-reports the spend.
62
+ const configuredCache = rateMicros(entry.cacheRead ?? entry.cache)
63
+ const cacheRead = configuredCache === null ? entry.input : (entry.cacheRead ?? entry.cache)
64
+ return {
65
+ input: entry.input,
66
+ output: entry.output,
67
+ cacheRead,
68
+ currency: typeof entry.currency === 'string' && entry.currency.trim()
69
+ ? entry.currency.trim().toUpperCase()
70
+ : 'USD',
71
+ inputMicros,
72
+ outputMicros,
73
+ cacheMicros: configuredCache ?? inputMicros,
74
+ }
75
+ }
76
+
77
+ /**
78
+ * Find the price row for one usage model key.
79
+ *
80
+ * Lookup order: exact `provider/model`, nested `provider: { model: {...} }`,
81
+ * then the bare model id. The first usable row wins.
82
+ *
83
+ * @param {object} table - configured pricing map.
84
+ * @param {string} model - usage model key, usually `provider/model`.
85
+ * @returns {object | null} normalised price row.
86
+ */
87
+ function priceFor(table, model) {
88
+ const exact = normalizeEntry(table[model])
89
+ if (exact) return exact
90
+ const slash = model.indexOf('/')
91
+ if (slash > 0) {
92
+ const provider = model.slice(0, slash)
93
+ const bare = model.slice(slash + 1)
94
+ const nested = table[provider]
95
+ const nestedEntry = nested && typeof nested === 'object' && !Array.isArray(nested)
96
+ ? normalizeEntry(nested[bare])
97
+ : null
98
+ if (nestedEntry) return nestedEntry
99
+ const bareEntry = normalizeEntry(table[bare])
100
+ if (bareEntry) return bareEntry
101
+ }
102
+ return null
103
+ }
104
+
105
+ /**
106
+ * Billed micro-units for one token count at one price.
107
+ *
108
+ * Integer arithmetic with a single half-up rounding keeps a long bill free of
109
+ * the drift that accumulates when fractional currency is added in floats.
110
+ *
111
+ * @param {number} tokens - token count.
112
+ * @param {number} priceMicros - micro-currency per 1M tokens.
113
+ * @returns {number} micro-units, rounded half-up.
114
+ */
115
+ function amountMicros(tokens, priceMicros) {
116
+ const count = Math.max(0, Math.trunc(Number(tokens) || 0))
117
+ if (count === 0 || priceMicros <= 0) return 0
118
+ const numerator = BigInt(count) * BigInt(priceMicros)
119
+ const denominator = BigInt(TOKENS_PER_PRICE)
120
+ const whole = numerator / denominator
121
+ const rest = numerator % denominator
122
+ const rounded = rest * 2n >= denominator ? whole + 1n : whole
123
+ return Number(rounded)
124
+ }
125
+
126
+ /**
127
+ * Price recorded usage with an explicit per-model table.
128
+ *
129
+ * @param {object | null} usage - summed usage for one run (or subtask).
130
+ * @param {Record<string, object> | undefined} pricing - configured price table.
131
+ * @returns {{
132
+ * currency: string,
133
+ * totalMicros: number,
134
+ * total: number,
135
+ * byModel: Record<string, number>,
136
+ * byModelMicros: Record<string, number>,
137
+ * records: object[],
138
+ * unpriced: string[],
139
+ * complete: boolean,
140
+ * } | null} cost, or null when there is nothing to price.
141
+ */
142
+ export function computeCost(usage, pricing) {
143
+ if (!usage || !usage.modelCalls) return null
144
+ const table = pricing && typeof pricing === 'object' ? pricing : {}
145
+ const byModel = {}
146
+ const byModelMicros = {}
147
+ const records = []
148
+ const unpriced = []
149
+ let totalMicros = 0
150
+ let currency = null
151
+
152
+ for (const [model, entry] of Object.entries(usage.models ?? {})) {
153
+ const record = {
154
+ model,
155
+ calls: entry.calls ?? 0,
156
+ inputTokens: entry.inputTokens ?? 0,
157
+ outputTokens: entry.outputTokens ?? 0,
158
+ cacheReadTokens: entry.cacheReadTokens ?? 0,
159
+ inputPrice: null,
160
+ outputPrice: null,
161
+ cachePrice: null,
162
+ amountMicros: null,
163
+ }
164
+ const price = priceFor(table, model)
165
+ if (!price) {
166
+ // Named, not zero: a caller can see exactly which route has no price.
167
+ unpriced.push(model)
168
+ records.push(record)
169
+ continue
170
+ }
171
+ record.inputPrice = price.input
172
+ record.outputPrice = price.output
173
+ record.cachePrice = price.cacheRead
174
+ const amount = amountMicros(record.inputTokens, price.inputMicros)
175
+ + amountMicros(record.cacheReadTokens, price.cacheMicros)
176
+ + amountMicros(record.outputTokens, price.outputMicros)
177
+ record.amountMicros = amount
178
+ byModelMicros[model] = amount
179
+ byModel[model] = amount / MICRO
180
+ totalMicros += amount
181
+ records.push(record)
182
+ currency = currency ?? price.currency
183
+ }
184
+
185
+ return {
186
+ currency: currency ?? 'USD',
187
+ totalMicros,
188
+ total: totalMicros / MICRO,
189
+ byModel,
190
+ byModelMicros,
191
+ records,
192
+ unpriced,
193
+ // "Complete" means every recorded model has a price. A usage record with no
194
+ // model attribution at all also cannot be called complete.
195
+ complete: unpriced.length === 0 && records.length > 0,
196
+ }
197
+ }
198
+
199
+ /**
200
+ * Price a run and each of its subtasks.
201
+ *
202
+ * Subtask costs cover only the worker children; planner and aggregator calls
203
+ * are part of the run total but belong to no subtask. A subtask without a
204
+ * readable usage log keeps `cost: null` rather than a fabricated zero.
205
+ *
206
+ * @param {object} run - run record with `usage`, `subtasks`.
207
+ * @param {object | undefined} pricing - configured price table.
208
+ * @returns {object | null} the run cost.
209
+ */
210
+ export function applyCost(run, pricing) {
211
+ if (!run || typeof run !== 'object') return null
212
+ run.cost = computeCost(run.usage, pricing)
213
+ for (const subtask of run.subtasks ?? []) {
214
+ subtask.cost = computeCost(subtask?.usage, pricing)
215
+ }
216
+ return run.cost
217
+ }
218
+
219
+ /**
220
+ * Integer micro-units for a cost object, accepting a legacy `total` number.
221
+ * @param {{ totalMicros?: number, total?: number } | number} cost - cost record.
222
+ * @returns {number} micro-units, or NaN.
223
+ */
224
+ function microsOf(cost) {
225
+ if (typeof cost === 'number') {
226
+ return Number.isFinite(cost) ? Math.round(cost * MICRO) : Number.NaN
227
+ }
228
+ if (cost && Number.isFinite(cost.totalMicros)) return Math.trunc(cost.totalMicros)
229
+ if (cost && Number.isFinite(cost.total)) return Math.round(cost.total * MICRO)
230
+ return Number.NaN
231
+ }
232
+
233
+ /**
234
+ * Render integer micro-units with one rounding, half-up, at the shown precision.
235
+ *
236
+ * Four decimals below one currency unit, two above it; a positive amount
237
+ * smaller than the smallest shown value is marked as such instead of printed
238
+ * as zero.
239
+ *
240
+ * @param {number} micros - integer micro-units.
241
+ * @param {string} [currency] - ISO currency code.
242
+ * @returns {string} e.g. `¥0.1016`, `$1.24`, `<¥0.0001`, `—`.
243
+ */
244
+ export function moneyOfMicros(micros, currency = 'USD') {
245
+ const symbol = currencySymbol(currency)
246
+ if (!Number.isFinite(micros)) return '—'
247
+ if (micros === 0) return `${symbol}0`
248
+ const value = Math.abs(micros)
249
+ if (value < SMALLEST_SHOWN_MICROS) return `<${symbol}0.0001`
250
+ const digits = value < MICRO ? 4 : 2
251
+ const step = 10 ** (6 - digits)
252
+ const rounded = Math.floor((value + step / 2) / step) * step
253
+ const whole = Math.floor(rounded / MICRO)
254
+ const fraction = String(rounded % MICRO).padStart(6, '0').slice(0, digits)
255
+ return `${micros < 0 ? '-' : ''}${symbol}${whole}.${fraction}`
256
+ }
257
+
258
+ /**
259
+ * Format a cost record (or a bare amount) for display.
260
+ * @param {{ totalMicros?: number, total?: number, currency?: string } | number | null} cost - cost.
261
+ * @param {string} [currency] - fallback currency code.
262
+ * @returns {string} formatted money, or `—` when unknown.
263
+ */
264
+ export function formatMoney(cost, currency) {
265
+ const code = (cost && typeof cost === 'object' && cost.currency) || currency || 'USD'
266
+ return moneyOfMicros(microsOf(cost), code)
267
+ }