hiwork-core 0.0.7 → 0.0.10

package/lib/app-version-rpc.js

@@ -0,0 +1,92 @@
+/**
+ * `/hiwork-app` loopback RPC 的 Host 实现：把「当前桌面端版本」报给渲染端。
+ *
+ * 为什么需要这个频道：侧栏品牌行显示的是**桌面端**版本，而这个值只有 Host 拿得到
+ * ——桌面端主进程启动时经 `hiwork:device-info`（stdio:ipc）把 `app.getVersion()` 推给
+ * Host，缓存在 `src/browser-login.ts` 的模块级 `pushedDeviceInfo` 里。渲染端看不到
+ * 那条 IPC，因此必须经 loopback RPC 取。此前的做法是在 client 侧硬编码产品版本，
+ * 每次桌面端发版都要手工同步一次；本频道就是为了去掉这步手工同步。
+ *
+ * 设计要点（与 `src/daily-rpc.ts` / `src/usage-rpc.ts` 同构）：
+ *  - 只注册一个 channel，endpoint 白名单在 {@link APP_VERSION_RPC_ENDPOINTS}，
+ *    未知 endpoint 直接 `bad-request`；
+ *  - `version` 端点无入参：payload 出现任何字段都判 `bad-request`；
+ *  - **「桌面端没推过」不是错误**：纯 web / 浏览器 dev 下永远不会有值，与本频道要
+ *    回答的问题无关，所以返回 `{ version: null }` 的成功信封，由客户端自行回退到
+ *    常量——不产生任何错误 UI，也不进日志。
+ *
+ * 本模块不 import cordis 运行时，只依赖结构化的 {@link AppVersionRpcContext} 端口，
+ * 便于单测直接伪造。
+ */
+/** RPC 频道；必须与 client 半边 `src/client/app-version.ts` 的 `APP_VERSION_CHANNEL` 一致（由测试锁定）。 */
+export const APP_VERSION_RPC_CHANNEL = '/hiwork-app';
+/** 端点白名单；必须与 client 半边 `APP_VERSION_ENDPOINTS` 一致（由测试锁定）。 */
+export const APP_VERSION_RPC_ENDPOINTS = ['version'];
+/** 通用失败文案：不暴露任何实现细节。 */
+export const APP_VERSION_GENERIC_FAILURE_MESSAGE = '暂时无法获取桌面端版本';
+/** 请求侧错误（只有 `bad-request`：未知端点 / 非法 payload）。 */
+export class AppVersionRequestError extends Error {
+    code;
+    constructor(code, message) {
+        super(message);
+        this.code = code;
+        this.name = 'AppVersionRequestError';
+    }
+}
+/** 是否为白名单端点。 */
+export function isAppVersionRpcEndpoint(endpoint) {
+    return APP_VERSION_RPC_ENDPOINTS.includes(endpoint);
+}
+/** 取消判定（用函数包一层，避免 TS 把属性窄化固化到 `await` 之后）。 */
+function isAborted(signal) {
+    return signal?.aborted === true;
+}
+/** payload 校验：`version` 无任何入参，出现字段即客户端实现缺陷。 */
+export function parseAppVersionPayload(raw) {
+    if (raw === undefined || raw === null)
+        return;
+    if (typeof raw !== 'object' || Array.isArray(raw)) {
+        throw new AppVersionRequestError('bad-request', '桌面端版本请求参数不合法。');
+    }
+    const keys = Object.keys(raw);
+    if (keys.length > 0)
+        throw new AppVersionRequestError('bad-request', `桌面端版本请求包含未知字段 '${keys[0]}'。`);
+}
+/** 空串与缺省同义：都表示「拿不到」，一律归一为 null，绝不渲染成 `v`。 */
+function normalizedVersion(raw) {
+    const version = typeof raw === 'string' ? raw.trim() : '';
+    return version === '' ? null : version;
+}
+/**
+ * 处理一次端点调用：返回 DSH Connection 的结果信封，**永不抛异常**。
+ * 导出以便单测直接驱动（无需伪造 `ctx.connection`）。
+ */
+export async function handleAppVersionEndpoint(endpoint, rawPayload, deps, signal) {
+    try {
+        if (isAborted(signal))
+            return failure('cancelled', '桌面端版本请求已取消。');
+        if (!isAppVersionRpcEndpoint(endpoint)) {
+            throw new AppVersionRequestError('bad-request', `未知的桌面端版本端点 '${endpoint}'`);
+        }
+        parseAppVersionPayload(rawPayload);
+        const value = { version: normalizedVersion(deps.appVersion()) };
+        return { ok: true, value };
+    }
+    catch (error) {
+        if (error instanceof AppVersionRequestError)
+            return failure(error.code, error.message);
+        deps.log?.(`hiwork-core: 桌面端版本 RPC '${endpoint}' 失败（${error instanceof Error ? error.name : typeof error}）`);
+        return failure('internal', APP_VERSION_GENERIC_FAILURE_MESSAGE);
+    }
+}
+function failure(code, message) {
+    return { ok: false, error: { code, message, details: {} } };
+}
+/**
+ * 注册 `/hiwork-app` 频道，返回异步 disposer（交给 `ctx.effect` 管理生命周期）。
+ */
+export function registerAppVersionRpc(ctx, deps) {
+    const handler = (endpoint, payload, signal) => handleAppVersionEndpoint(endpoint, payload, deps, signal);
+    const remove = ctx.connection.rpc.handle(APP_VERSION_RPC_CHANNEL, handler, { authority: 'loopback' });
+    return async () => { await remove(); };
+}

package/lib/browser-login.js

@@ -47,6 +47,13 @@ export function setDeviceInfo(info) {
         ...(appVersion === '' ? {} : { appVersion }),
     };
 }
+/**
+ * 桌面端经 IPC 推来的版本号（未推过 / 纯 web 时为 undefined）。
+ * 只读、无副作用：`/hiwork-app` 频道拿它给侧栏品牌行展示（见 `src/app-version-rpc.ts`）。
+ */
+export function pushedAppVersion() {
+    return pushedDeviceInfo?.appVersion;
+}
 /** 清空模块级状态（IPC 设备缓存 + 待完成授权）；供测试与插件卸载使用。 */
 export function resetBrowserLoginState() {
     pushedDeviceInfo = undefined;

package/lib/client-policy.js

@@ -15,6 +15,8 @@ export const DEFAULT_LOGIN_MODE = 'both';
 export const CLIENT_POLICY_PATH = '/api/client/policy';
 /** 策略拉取默认超时：免登录只读接口，超过 5s 视同不可达（fail-open）。 */
 export const CLIENT_POLICY_TIMEOUT_MS = 5_000;
+/** fail-open 缺省：旧网关不返回 passwordLogin 时，密码表单仍视作可用。 */
+export const DEFAULT_PASSWORD_LOGIN = true;
 /**
  * 拼策略 URL：`{baseURL}/api/client/policy?platform=&arch=&version=&device_id=`。
  * 参数固定顺序、逐个 `encodeURIComponent`（device_id 可能是任意 ASCII，含 `+/=` 也必须安全）；
@@ -47,6 +49,16 @@ function parseLoginMode(payload) {
     const value = payload.loginMode;
     return value === 'browser' || value === 'form' || value === 'both' ? value : undefined;
 }
+/**
+ * 解析 `passwordLogin`：只认布尔值；缺失 / 非法值一律 {@link DEFAULT_PASSWORD_LOGIN}
+ * （fail-open：旧网关不返回该字段，不能因此收起密码入口）。
+ */
+function parsePasswordLogin(payload) {
+    if (typeof payload !== 'object' || payload === null)
+        return DEFAULT_PASSWORD_LOGIN;
+    const value = payload.passwordLogin;
+    return typeof value === 'boolean' ? value : DEFAULT_PASSWORD_LOGIN;
+}
 /**
  * 拉取并解析客户端策略。**永不抛异常**：任何失败都返回 undefined（fail-open）。
  *
@@ -73,7 +85,7 @@ export async function fetchClientPolicy(opts) {
             return undefined;
         }
         const loginMode = parseLoginMode(payload);
-        return loginMode === undefined ? undefined : { loginMode };
+        return loginMode === undefined ? undefined : { loginMode, passwordLogin: parsePasswordLogin(payload) };
     }
     catch {
         // 网络异常 / 超时（AbortSignal.timeout 抛 TimeoutError）/ 非法 URL：一律 fail-open。