-
Notifications
You must be signed in to change notification settings - Fork 22
Expand file tree
/
Copy pathmiddleware.ts
More file actions
166 lines (158 loc) · 5.47 KB
/
Copy pathmiddleware.ts
File metadata and controls
166 lines (158 loc) · 5.47 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
import type {
AnyCommand,
ApiKeyCredential,
AuthStore,
ConfigStore,
CommandPackManager,
ConsoleCredential,
FlagsDef,
Identity,
OpenApiCredential,
ParsedFlags,
ResolutionSources,
Settings,
} from "bailian-cli-core";
import {
Client,
resolveApiKey,
resolveConsole,
resolveOpenApi,
resolveModelBaseUrl,
trackCommandExecution,
} from "bailian-cli-core";
import { maybeShowStatusBar } from "./output/status-bar.ts";
import { ansi } from "./output/color.ts";
import {
checkForUpdate,
getPendingUpdateNotification,
performAutoUpdate,
shouldAutoUpdate,
} from "./utils/update-checker.ts";
/**
* What each middleware stage gets for the invocation in flight: the matched
* `command` with its `path`/`settings`/`flags`, and the `client` (populated by
* {@link authStage}). A stage reads these and may augment them before `next()`.
*/
export interface RunContext {
/** 静态产品身份(binName/version/npmPackage/clientName)。 */
readonly identity: Identity;
/** The matched command path, e.g. ["speech","recognize"]. */
readonly path: string[];
readonly command: AnyCommand;
/** 只含本命令声明的 flag(分流后);全局 flag 在 sources/settings。 */
flags: ParsedFlags<FlagsDef>;
/** 解析后的有效配置面(命令的新读取面;双轨迁移期与 config 并存)。 */
settings: Settings;
/** 解析源:provider/访问器用;业务命令不可见(窄视图类型不含此字段)。 */
sources: ResolutionSources;
/** 配置持久化能力；lint 限定 commands/config/** 使用。 */
configStore: ConfigStore;
/** 鉴权持久化能力；lint 限定 commands/auth/** 使用。 */
authStore: AuthStore;
/** Command Pack 管理能力；lint 限定 commands/plugin/** 使用。 */
commandPacks: CommandPackManager;
/** Network surface with the credential baked in — set by {@link authStage}. */
client: Client;
}
/** Koa-style onion middleware: do work, call `next()`, do work after it returns. */
export type Middleware = (ctx: RunContext, next: () => Promise<void>) => Promise<void>;
/** Fold a middleware list into a single runnable function. */
export function compose(stack: Middleware[]): (ctx: RunContext) => Promise<void> {
return (ctx) => {
const dispatch = (i: number): Promise<void> => {
const mw = stack[i];
if (!mw) return Promise.resolve();
return mw(ctx, () => dispatch(i + 1));
};
return dispatch(0);
};
}
/**
* Bake the credential for the command's declared `auth` into `ctx.client`, and
* gate: no credential → throw before the command runs. dry-run 例外:凭证解析失败
* 不抛(dry-run 只打印请求,无需凭证;console 的 dry-run 展示读 settings.console*)。
* `auth: "none"` commands keep a credential-less client.
*/
export const authStage: Middleware = async (ctx, next) => {
const { command, settings, sources } = ctx;
const base = {
identity: ctx.identity,
settings,
baseUrl: resolveModelBaseUrl(sources),
};
if (command.auth === "apiKey") {
let cred: ApiKeyCredential | undefined;
try {
cred = resolveApiKey(sources);
} catch (err) {
if (!settings.dryRun) throw err;
}
ctx.client = new Client({ ...base, apiCred: cred });
if (cred) maybeShowStatusBar(settings, cred.token, cred);
} else if (command.auth === "console") {
let cred: ConsoleCredential | undefined;
try {
cred = resolveConsole(sources);
} catch (err) {
if (!settings.dryRun) throw err;
}
if (cred) ctx.client = new Client({ ...base, consoleCred: cred });
} else if (command.auth === "openapi") {
let cred: OpenApiCredential | undefined;
try {
cred = resolveOpenApi(sources);
} catch (err) {
if (!settings.dryRun) throw err;
}
ctx.client = new Client({ ...base, openApiCred: cred });
}
await next();
};
/** Record command execution (start / success / failure) around the command. */
export const telemetryStage: Middleware = (ctx, next) => {
return trackCommandExecution(
{
identity: ctx.identity,
settings: ctx.settings,
authMethod: ctx.command.auth,
},
ctx.path,
ctx.flags,
next,
);
};
/**
* Kick off a debounced update check before the command, then — only on success
* — surface any pending notification. Never affects the command's exit code:
* if `next()` throws, the notice is skipped (no update nag on failure).
*/
export const versionCheckStage: Middleware = async (ctx, next) => {
const pending = checkForUpdate(
ctx.identity.version,
ctx.identity.npmPackage,
ctx.identity.clientName,
).catch(() => {});
await next();
await pending;
const isUpdateCommand = ctx.path.length === 1 && ctx.path[0] === "update";
const newVersion = getPendingUpdateNotification();
if (newVersion && !ctx.settings.quiet && !isUpdateCommand) {
if (shouldAutoUpdate(newVersion, ctx.identity.version)) {
// 大版本差距且目标为稳定版,自动更新
await performAutoUpdate(
ctx.identity.version,
newVersion,
ctx.identity.npmPackage,
ctx.identity.clientName,
);
} else {
const color = ansi(process.stderr);
process.stderr.write(
`\n ${color.yellow(`Update available: ${ctx.identity.version} → ${newVersion}`)}\n`,
);
process.stderr.write(` Run ${color.cyan(`${ctx.identity.binName} update`)} to upgrade\n\n`);
}
}
};
/** Innermost stage: hand control to the command with its full context. */
export const runCommandStage: Middleware = (ctx) => ctx.command.run(ctx);