@autional/shared 0.1.0-rc.58 → 0.1.0-rc.60
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/package.json +4 -1
- package/src/api/__tests__/fetch-client.test.ts +33 -0
- package/src/api/fetch-client.ts +16 -6
- package/src/hooks/__tests__/useSessionActivity.test.tsx +89 -0
- package/src/hooks/useSessionActivity.ts +106 -0
- package/src/index.ts +2 -0
- package/src/portal/check-literals.mjs +341 -0
- package/src/portal/registry.ts +349 -349
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@autional/shared",
|
|
3
|
-
"version": "0.1.0-rc.
|
|
3
|
+
"version": "0.1.0-rc.60",
|
|
4
4
|
"description": "Autional shared layer — API client, auth, types, hooks, utils",
|
|
5
5
|
"license": "AGPL-3.0",
|
|
6
6
|
"main": "./src/index.ts",
|
|
@@ -16,6 +16,9 @@
|
|
|
16
16
|
"./generated/queries": "./src/generated/queries.ts",
|
|
17
17
|
"./package.json": "./package.json"
|
|
18
18
|
},
|
|
19
|
+
"bin": {
|
|
20
|
+
"autional-check-portal-literals": "./src/portal/check-literals.mjs"
|
|
21
|
+
},
|
|
19
22
|
"files": [
|
|
20
23
|
"src"
|
|
21
24
|
],
|
|
@@ -193,6 +193,20 @@ describe('createFetchClient', () => {
|
|
|
193
193
|
expect(onUnauthorized).not.toHaveBeenCalled();
|
|
194
194
|
});
|
|
195
195
|
|
|
196
|
+
|
|
197
|
+
it('refresh 收到 401 错误本身(可按业务码决定要不要续期)', async () => {
|
|
198
|
+
stubFetch(() => jsonResponse({ code: '30000001', detail: 'secret not found' }, 401));
|
|
199
|
+
const refresh = vi.fn(async (_error: FetchApiError) => null);
|
|
200
|
+
const onUnauthorized = vi.fn();
|
|
201
|
+
const client = createFetchClient({ baseUrl: '/api', refresh, onUnauthorized });
|
|
202
|
+
|
|
203
|
+
await expect(client.get('/x')).rejects.toMatchObject({ status: 401 });
|
|
204
|
+
|
|
205
|
+
expect(refresh).toHaveBeenCalledTimes(1);
|
|
206
|
+
expect(refresh.mock.calls[0]![0]).toMatchObject({ status: 401, code: '30000001' });
|
|
207
|
+
expect(onUnauthorized).toHaveBeenCalledTimes(1);
|
|
208
|
+
});
|
|
209
|
+
|
|
196
210
|
it('401 + refresh 返回 null:不重试,抛 401 并通知一次', async () => {
|
|
197
211
|
stubFetch(() => jsonResponse({ message: 'expired' }, 401));
|
|
198
212
|
const onUnauthorized = vi.fn();
|
|
@@ -257,6 +271,25 @@ describe('createFetchClient', () => {
|
|
|
257
271
|
await expect(client.get('/x')).rejects.toMatchObject({ status: 200, code: 'invalid_json' });
|
|
258
272
|
});
|
|
259
273
|
|
|
274
|
+
|
|
275
|
+
it('responseType=text:原样返回字符串(导出文件体),不解析 JSON', async () => {
|
|
276
|
+
const body = 'key: value' + String.fromCharCode(10) + 'other: 1' + String.fromCharCode(10);
|
|
277
|
+
stubFetch(() => textResponse(body));
|
|
278
|
+
const client = createFetchClient({ baseUrl: '/api' });
|
|
279
|
+
|
|
280
|
+
await expect(client.get('/export', { responseType: 'text' })).resolves.toBe(body);
|
|
281
|
+
});
|
|
282
|
+
|
|
283
|
+
it('responseType=text 时非 2xx 仍归一为 FetchApiError(错误体为文本)', async () => {
|
|
284
|
+
stubFetch(() => textResponse('upstream unavailable', 503));
|
|
285
|
+
const client = createFetchClient({ baseUrl: '/api' });
|
|
286
|
+
|
|
287
|
+
await expect(client.get('/export', { responseType: 'text' })).rejects.toMatchObject({
|
|
288
|
+
status: 503,
|
|
289
|
+
body: 'upstream unavailable',
|
|
290
|
+
});
|
|
291
|
+
});
|
|
292
|
+
|
|
260
293
|
it('空响应体 ⇒ null(删除成功类)', async () => {
|
|
261
294
|
stubFetch(() => textResponse('', 204));
|
|
262
295
|
const client = createFetchClient({ baseUrl: '/api' });
|
package/src/api/fetch-client.ts
CHANGED
|
@@ -40,6 +40,8 @@ export interface FetchRequestOptions {
|
|
|
40
40
|
headers?: Record<string, string>;
|
|
41
41
|
/** 单次覆盖超时(ms)。 */
|
|
42
42
|
timeoutMs?: number;
|
|
43
|
+
/** 响应解析方式:`text` = 原样返回字符串(导出 JSON/YAML 文件体用)。默认 `json`。 */
|
|
44
|
+
responseType?: 'json' | 'text';
|
|
43
45
|
signal?: AbortSignal;
|
|
44
46
|
}
|
|
45
47
|
|
|
@@ -58,8 +60,12 @@ export interface FetchClientOptions {
|
|
|
58
60
|
* 可救回的 401 静默续期,不打扰用户。
|
|
59
61
|
*/
|
|
60
62
|
onUnauthorized?: (error: FetchApiError) => void;
|
|
61
|
-
/**
|
|
62
|
-
|
|
63
|
+
/**
|
|
64
|
+
* 401 静默续期:返回新 token 则重试一次;返回 null/抛错则放弃。
|
|
65
|
+
* 入参是本次 401 的错误(含 `code` / `body`)—— 调用方可据此区分「会话过期」与
|
|
66
|
+
* 「业务 401」(如密钥服务的 `30000001 secret not found` 不该续期、更不该踢下线)。
|
|
67
|
+
*/
|
|
68
|
+
refresh?: (error: FetchApiError) => Promise<string | null>;
|
|
63
69
|
/** 默认超时,20s(与两站现状一致)。 */
|
|
64
70
|
timeoutMs?: number;
|
|
65
71
|
/**
|
|
@@ -247,7 +253,7 @@ export function createFetchClient(options: FetchClientOptions): FetchClient {
|
|
|
247
253
|
if (!retried && refresh) {
|
|
248
254
|
let nextToken: string | null = null;
|
|
249
255
|
try {
|
|
250
|
-
nextToken = await refresh();
|
|
256
|
+
nextToken = await refresh(unauthorized);
|
|
251
257
|
} catch {
|
|
252
258
|
nextToken = null;
|
|
253
259
|
}
|
|
@@ -260,8 +266,12 @@ export function createFetchClient(options: FetchClientOptions): FetchClient {
|
|
|
260
266
|
}
|
|
261
267
|
|
|
262
268
|
const raw = await safeText(response);
|
|
269
|
+
const isText = init.responseType === 'text';
|
|
263
270
|
let parsed: unknown = null;
|
|
264
|
-
if (
|
|
271
|
+
if (isText) {
|
|
272
|
+
// 文本模式:不解析 JSON(导出接口返回文件体);错误仍按 text 承载
|
|
273
|
+
parsed = raw;
|
|
274
|
+
} else if (raw !== '') {
|
|
265
275
|
try {
|
|
266
276
|
parsed = JSON.parse(raw);
|
|
267
277
|
} catch {
|
|
@@ -277,7 +287,7 @@ export function createFetchClient(options: FetchClientOptions): FetchClient {
|
|
|
277
287
|
}
|
|
278
288
|
|
|
279
289
|
let result: unknown = parsed;
|
|
280
|
-
if (unwrap && parsed && typeof parsed === 'object') {
|
|
290
|
+
if (unwrap && !isText && parsed && typeof parsed === 'object') {
|
|
281
291
|
const envelope = parsed as { code?: unknown; data?: unknown; items?: unknown; message?: string };
|
|
282
292
|
// 业务码:number 0 / 字符串 '0' 视为成功;其余非空值为错误(部分服务把 code 序列化成字符串)
|
|
283
293
|
const code = envelope.code;
|
|
@@ -293,7 +303,7 @@ export function createFetchClient(options: FetchClientOptions): FetchClient {
|
|
|
293
303
|
// 列表信封(`{items,total,pagination}`):保持原形,由调用方取 items
|
|
294
304
|
}
|
|
295
305
|
|
|
296
|
-
return (caseConversion === 'camel' ? camelizeKeys<T>(result) : result) as T;
|
|
306
|
+
return (caseConversion === 'camel' && !isText ? camelizeKeys<T>(result) : result) as T;
|
|
297
307
|
}
|
|
298
308
|
|
|
299
309
|
const request = <T,>(path: string, init: FetchRequestOptions = {}): Promise<T> =>
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
// @vitest-environment jsdom
|
|
2
|
+
// ============================================================
|
|
3
|
+
// 会话心跳 hook 契约锁(2026-11-10 会话策略交接 §3.3):
|
|
4
|
+
// ① 端点由调用方给定(管理面 /admin/sessions/me/activity、用户面 /sessions/me/activity)
|
|
5
|
+
// ② getToken 可注入(config/secret 用本地 @/lib/auth,不复用 shared store)
|
|
6
|
+
// ③ 三道闸门:页面不可见不发 / 最近无交互不发 / 未到间隔不发
|
|
7
|
+
// ④ 缺 sid 不发(服务端按 token 归属,前端不拼 sid)
|
|
8
|
+
// ============================================================
|
|
9
|
+
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
|
|
10
|
+
import { renderHook } from '@testing-library/react';
|
|
11
|
+
|
|
12
|
+
import { useSessionActivity } from '../useSessionActivity';
|
|
13
|
+
|
|
14
|
+
/** 构造一个带 sid 的假 JWT(签名无关,只解码 payload)。 */
|
|
15
|
+
function fakeToken(payload: Record<string, unknown>): string {
|
|
16
|
+
const b64 = (obj: Record<string, unknown>) =>
|
|
17
|
+
Buffer.from(JSON.stringify(obj)).toString('base64url');
|
|
18
|
+
return `${b64({ alg: 'none' })}.${b64(payload)}.sig`;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
const fetchMock = vi.fn(() => Promise.resolve({ ok: true } as Response));
|
|
22
|
+
|
|
23
|
+
beforeEach(() => {
|
|
24
|
+
vi.useFakeTimers();
|
|
25
|
+
vi.stubGlobal('fetch', fetchMock);
|
|
26
|
+
fetchMock.mockClear();
|
|
27
|
+
Object.defineProperty(document, 'visibilityState', { value: 'visible', configurable: true });
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
afterEach(() => {
|
|
31
|
+
vi.useRealTimers();
|
|
32
|
+
vi.unstubAllGlobals();
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
describe('useSessionActivity', () => {
|
|
36
|
+
it('可见 + 有交互 + 到间隔 → 按调用方端点发一次心跳', () => {
|
|
37
|
+
const token = fakeToken({ custom: { sid: 'sid-1' }, tenant_id: 't-1' });
|
|
38
|
+
renderHook(() =>
|
|
39
|
+
useSessionActivity({ endpoint: '/bff/session/api/v1/admin/sessions/me/activity', getToken: () => token }),
|
|
40
|
+
);
|
|
41
|
+
|
|
42
|
+
vi.advanceTimersByTime(5 * 60_000);
|
|
43
|
+
|
|
44
|
+
expect(fetchMock).toHaveBeenCalledTimes(1);
|
|
45
|
+
const [url, init] = fetchMock.mock.calls[0] as [string, RequestInit];
|
|
46
|
+
expect(url).toBe('/bff/session/api/v1/admin/sessions/me/activity');
|
|
47
|
+
expect(init.method).toBe('POST');
|
|
48
|
+
expect((init.headers as Record<string, string>).Authorization).toBe('Bearer ' + token);
|
|
49
|
+
expect((init.headers as Record<string, string>)['X-Tenant-ID']).toBe('t-1');
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
it('页面不可见 → 不发', () => {
|
|
53
|
+
Object.defineProperty(document, 'visibilityState', { value: 'hidden', configurable: true });
|
|
54
|
+
renderHook(() =>
|
|
55
|
+
useSessionActivity({ endpoint: '/x', getToken: () => fakeToken({ custom: { sid: 's' } }) }),
|
|
56
|
+
);
|
|
57
|
+
vi.advanceTimersByTime(10 * 60_000);
|
|
58
|
+
expect(fetchMock).not.toHaveBeenCalled();
|
|
59
|
+
});
|
|
60
|
+
|
|
61
|
+
it('没有 sid → 不发(服务端按 token 归属,前端不拼 sid)', () => {
|
|
62
|
+
renderHook(() =>
|
|
63
|
+
useSessionActivity({ endpoint: '/x', getToken: () => fakeToken({ sub: 'u-1' }) }),
|
|
64
|
+
);
|
|
65
|
+
vi.advanceTimersByTime(10 * 60_000);
|
|
66
|
+
expect(fetchMock).not.toHaveBeenCalled();
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
it('超过交互窗口无交互 → 停发(人不在就让会话自然过期)', () => {
|
|
70
|
+
renderHook(() =>
|
|
71
|
+
useSessionActivity({ endpoint: '/x', getToken: () => fakeToken({ custom: { sid: 'sid-1' } }) }),
|
|
72
|
+
);
|
|
73
|
+
|
|
74
|
+
vi.advanceTimersByTime(5 * 60_000);
|
|
75
|
+
expect(fetchMock).toHaveBeenCalledTimes(1);
|
|
76
|
+
|
|
77
|
+
// 之后 15 分钟无人交互(lastInteraction 停在挂载时刻)
|
|
78
|
+
vi.advanceTimersByTime(15 * 60_000);
|
|
79
|
+
expect(fetchMock).toHaveBeenCalledTimes(1);
|
|
80
|
+
});
|
|
81
|
+
|
|
82
|
+
it('disabled → 完全不发', () => {
|
|
83
|
+
renderHook(() =>
|
|
84
|
+
useSessionActivity({ endpoint: '/x', getToken: () => fakeToken({ custom: { sid: 's' } }), disabled: true }),
|
|
85
|
+
);
|
|
86
|
+
vi.advanceTimersByTime(10 * 60_000);
|
|
87
|
+
expect(fetchMock).not.toHaveBeenCalled();
|
|
88
|
+
});
|
|
89
|
+
});
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import { useEffect, useRef } from 'react';
|
|
2
|
+
|
|
3
|
+
import { getAccessToken } from '../auth/store';
|
|
4
|
+
import { decodeJwtPayload } from '../auth/jwt-payload';
|
|
5
|
+
|
|
6
|
+
/** 心跳间隔:闲置 30 分钟的 1/6(业界常用 5 分钟)。 */
|
|
7
|
+
const DEFAULT_PING_INTERVAL = 5 * 60_000;
|
|
8
|
+
/** 检查节拍:每秒级太重,1 分钟一次足够(真正的间隔由 pingInterval 控制)。 */
|
|
9
|
+
const DEFAULT_TICK_INTERVAL = 60_000;
|
|
10
|
+
/** 交互新鲜度:超过这个时间没交互就不发心跳(人不在,让会话自然闲置过期)。 */
|
|
11
|
+
const DEFAULT_INTERACTION_FRESH = 5 * 60_000;
|
|
12
|
+
|
|
13
|
+
export interface UseSessionActivityOptions {
|
|
14
|
+
/**
|
|
15
|
+
* 心跳端点。管理面用 `/bff/session/api/v1/admin/sessions/me/activity`,
|
|
16
|
+
* 用户面用 `/bff/session/api/v1/sessions/me/activity`。
|
|
17
|
+
*/
|
|
18
|
+
endpoint: string;
|
|
19
|
+
/**
|
|
20
|
+
* 取 access token。默认用 shared 的 `getAccessToken`;
|
|
21
|
+
* 门户若用本地 auth 模块(如 config/secret 的 `@/lib/auth`),可注入自己的实现。
|
|
22
|
+
*/
|
|
23
|
+
getToken?: () => string | null;
|
|
24
|
+
/** 心跳最小间隔,默认 5 分钟。 */
|
|
25
|
+
pingIntervalMs?: number;
|
|
26
|
+
/** 检查节拍,默认 60 秒。 */
|
|
27
|
+
tickIntervalMs?: number;
|
|
28
|
+
/** 交互新鲜度窗口,默认 5 分钟。 */
|
|
29
|
+
interactionFreshMs?: number;
|
|
30
|
+
/** 关闭开关(灰度/测试用),默认 false。 */
|
|
31
|
+
disabled?: boolean;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
function str(source: Record<string, unknown> | null | undefined, key: string): string {
|
|
35
|
+
const value = source?.[key];
|
|
36
|
+
return typeof value === 'string' ? value : '';
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* 会话活动心跳(NIST「activity resets inactivity」口径)。
|
|
41
|
+
*
|
|
42
|
+
* 只在「页面可见 + 最近 N 分钟有真实交互」时上报;失败静默,不影响业务请求。
|
|
43
|
+
* 服务端首次心跳把会话切到闲置策略(opt-in),未接心跳的客户端不受影响。
|
|
44
|
+
* 心跳只续闲置窗口,绝对上限由服务端固定,心跳无法突破。
|
|
45
|
+
*/
|
|
46
|
+
export function useSessionActivity(options: UseSessionActivityOptions): void {
|
|
47
|
+
const {
|
|
48
|
+
endpoint,
|
|
49
|
+
getToken = getAccessToken,
|
|
50
|
+
pingIntervalMs = DEFAULT_PING_INTERVAL,
|
|
51
|
+
tickIntervalMs = DEFAULT_TICK_INTERVAL,
|
|
52
|
+
interactionFreshMs = DEFAULT_INTERACTION_FRESH,
|
|
53
|
+
disabled = false,
|
|
54
|
+
} = options;
|
|
55
|
+
|
|
56
|
+
const lastInteraction = useRef(Date.now());
|
|
57
|
+
const lastPing = useRef(0);
|
|
58
|
+
|
|
59
|
+
// 依赖项放在 ref 里,避免调用方每次渲染传新对象导致定时器重建。
|
|
60
|
+
const config = useRef({ endpoint, getToken, pingIntervalMs, tickIntervalMs, interactionFreshMs, disabled });
|
|
61
|
+
config.current = { endpoint, getToken, pingIntervalMs, tickIntervalMs, interactionFreshMs, disabled };
|
|
62
|
+
|
|
63
|
+
useEffect(() => {
|
|
64
|
+
const mark = () => {
|
|
65
|
+
lastInteraction.current = Date.now();
|
|
66
|
+
};
|
|
67
|
+
const events: Array<keyof WindowEventMap> = ['pointerdown', 'keydown', 'touchstart', 'wheel'];
|
|
68
|
+
events.forEach((name) => window.addEventListener(name, mark, { passive: true }));
|
|
69
|
+
|
|
70
|
+
const ping = () => {
|
|
71
|
+
const cfg = config.current;
|
|
72
|
+
if (cfg.disabled) return;
|
|
73
|
+
const token = cfg.getToken();
|
|
74
|
+
if (!token) return;
|
|
75
|
+
if (typeof document !== 'undefined' && document.visibilityState !== 'visible') return;
|
|
76
|
+
const now = Date.now();
|
|
77
|
+
if (now - lastInteraction.current > cfg.interactionFreshMs) return;
|
|
78
|
+
if (now - lastPing.current < cfg.pingIntervalMs) return;
|
|
79
|
+
const claims = decodeJwtPayload(token);
|
|
80
|
+
const custom = (claims?.custom ?? null) as Record<string, unknown> | null;
|
|
81
|
+
const sid = str(custom, 'sid') || str(custom, 'session_id') || str(claims, 'session_id');
|
|
82
|
+
if (!sid) return;
|
|
83
|
+
lastPing.current = now;
|
|
84
|
+
const headers: Record<string, string> = {
|
|
85
|
+
Accept: 'application/json',
|
|
86
|
+
Authorization: 'Bearer ' + token,
|
|
87
|
+
};
|
|
88
|
+
const tenant = str(claims, 'tenant_id') || str(custom, 'tenant_id');
|
|
89
|
+
const app = str(claims, 'app_id') || str(custom, 'app_id');
|
|
90
|
+
if (tenant) headers['X-Tenant-ID'] = tenant;
|
|
91
|
+
if (app) headers['X-App-ID'] = app;
|
|
92
|
+
void fetch(cfg.endpoint, { method: 'POST', headers, credentials: 'omit' }).catch(() => undefined);
|
|
93
|
+
};
|
|
94
|
+
|
|
95
|
+
const timer = window.setInterval(ping, tickIntervalMs);
|
|
96
|
+
const onVisible = () => {
|
|
97
|
+
if (document.visibilityState === 'visible') ping();
|
|
98
|
+
};
|
|
99
|
+
document.addEventListener('visibilitychange', onVisible);
|
|
100
|
+
return () => {
|
|
101
|
+
events.forEach((name) => window.removeEventListener(name, mark));
|
|
102
|
+
window.clearInterval(timer);
|
|
103
|
+
document.removeEventListener('visibilitychange', onVisible);
|
|
104
|
+
};
|
|
105
|
+
}, [tickIntervalMs]);
|
|
106
|
+
}
|
package/src/index.ts
CHANGED
|
@@ -97,6 +97,8 @@ export type { BootstrapState } from './hooks/useBootstrap';
|
|
|
97
97
|
export { useSodMode, useIsAuditRestricted } from './hooks/useSodMode';
|
|
98
98
|
export type { SodMode } from './hooks/useSodMode';
|
|
99
99
|
export { useCurrentRole } from './hooks/useCurrentRole';
|
|
100
|
+
export { useSessionActivity } from './hooks/useSessionActivity';
|
|
101
|
+
export type { UseSessionActivityOptions } from './hooks/useSessionActivity';
|
|
100
102
|
export {
|
|
101
103
|
usePortalCatalog,
|
|
102
104
|
isPortalVisible,
|
|
@@ -0,0 +1,341 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
// check-portal-literals —— 门户清单回潮门(第 N 道)
|
|
3
|
+
//
|
|
4
|
+
// 背景:门户 code 过去被写了十几次(PORTAL_DEFAULTS / SLUG_PORTALS / 重定向白名单 /
|
|
5
|
+
// isPortalVisible 角色集 / DEFAULT_EXCLUDE / PORTAL_KEY_MAP + 6 个站点各一份 CONSOLE_PORTALS)。
|
|
6
|
+
// 现在唯一真源是 packages/shared/src/portal/registry.ts(`PORTALS`)。
|
|
7
|
+
//
|
|
8
|
+
// 本闸门扫 packages/*/src(跳过测试与 registry.ts),禁止再出现「≥2 个门户 code」的字面量数组 / Set:
|
|
9
|
+
//
|
|
10
|
+
// const CONSOLE_PORTALS = new Set(['config', 'secret', 'admin', ...]); ❌
|
|
11
|
+
// const DEFAULT_EXCLUDE = ['auth', 'landing']; ❌
|
|
12
|
+
//
|
|
13
|
+
// 允许:
|
|
14
|
+
// • registry.ts 自身(真源)
|
|
15
|
+
// • 单门户字面量(getPortalUrl('admin') / code === 'config' 之类)
|
|
16
|
+
// • 测试文件(oracle 断言需要原文拷贝)
|
|
17
|
+
//
|
|
18
|
+
// 已知边界(有意接受,别当它是形式化证明):
|
|
19
|
+
// • 只认「数组 / Set 字面量」;字符串拼接、模板串、`push('admin')`、对象键清单不在扫描面
|
|
20
|
+
// • 只扫本仓 `packages/*/src`(站点仓在各自主仓,由各自的 CI 跑同名脚本)
|
|
21
|
+
// 因此它是「回潮早报警」,不是「不可能绕过」;绕过本身要写得刻意,评审时肉眼可见。
|
|
22
|
+
//
|
|
23
|
+
// 用法(**单文件自足**,可直接复制进站点仓,不依赖 scripts/lib/*):
|
|
24
|
+
// node scripts/check-portal-literals.mjs # 扫本仓(自动识别 packages/ / apps/ / src/)
|
|
25
|
+
// node scripts/check-portal-literals.mjs --root <dir> # 扫指定目录(站点仓:--root .)
|
|
26
|
+
// node scripts/check-portal-literals.mjs --json
|
|
27
|
+
//
|
|
28
|
+
// 门户 code 的取法(按序回退):
|
|
29
|
+
// 1. --codes <file> 指定
|
|
30
|
+
// 2. <root>/packages/shared/src/portal/registry.ts(ui 仓)
|
|
31
|
+
// 3. <root>/node_modules/@autional/shared/src/portal/registry.ts(站点仓,装了 shared 之后)
|
|
32
|
+
// 4. <root>/node_modules/@autional/shared/dist/portal/registry.js(将来若出 dist)
|
|
33
|
+
|
|
34
|
+
import { existsSync, readFileSync, readdirSync, statSync } from 'node:fs';
|
|
35
|
+
import { join, relative, resolve } from 'node:path';
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* 默认扫描根 = 当前工作目录(作为包内 `bin` 分发时,脚本位置在 node_modules 里,不能用它推仓库根)。
|
|
39
|
+
* ui 仓内部调用由 `scripts/check-portal-literals.mjs` 包装,cwd 即仓根。
|
|
40
|
+
*/
|
|
41
|
+
const SCRIPT_ROOT = process.cwd();
|
|
42
|
+
|
|
43
|
+
function argValue(flag) {
|
|
44
|
+
const i = process.argv.indexOf(flag);
|
|
45
|
+
return i >= 0 ? process.argv[i + 1] : undefined;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
const ROOT = resolve(argValue('--root') ?? SCRIPT_ROOT);
|
|
49
|
+
/** 待扫目录:显式 --scan(逗号分隔)> 仓库里存在的 packages/apps/src。 */
|
|
50
|
+
const SCAN_DIRS = (() => {
|
|
51
|
+
const explicit = argValue('--scan');
|
|
52
|
+
if (explicit) return explicit.split(',').map((s) => s.trim()).filter(Boolean).map((d) => resolve(ROOT, d));
|
|
53
|
+
const candidates = ['packages', 'apps', 'src'].filter((d) => existsSync(join(ROOT, d)));
|
|
54
|
+
return candidates.length > 0 ? candidates.map((d) => join(ROOT, d)) : [ROOT];
|
|
55
|
+
})();
|
|
56
|
+
const SKIP_DIR = new Set(['node_modules', 'dist', '__tests__', 'test', 'generated']);
|
|
57
|
+
const SKIP_FILE = /(\.test\.|\.spec\.|\.d\.ts$)/;
|
|
58
|
+
|
|
59
|
+
/**
|
|
60
|
+
* shared 的注册表可能落在:ui 仓自身源码 / 站点仓根 node_modules(pnpm 提升)/
|
|
61
|
+
* 站点仓 apps/<app>/node_modules(pnpm workspace 的常规位置)/ 将来若出 dist。
|
|
62
|
+
*/
|
|
63
|
+
function installedCandidates() {
|
|
64
|
+
const out = [];
|
|
65
|
+
const rel = join('@autional', 'shared');
|
|
66
|
+
const variants = [join('src', 'portal', 'registry.ts'), join('dist', 'portal', 'registry.js')];
|
|
67
|
+
const bundlers = [
|
|
68
|
+
join(ROOT, 'node_modules'),
|
|
69
|
+
...(existsSync(join(ROOT, 'apps')) ? readdirSync(join(ROOT, 'apps')).map((d) => join(ROOT, 'apps', d, 'node_modules')) : []),
|
|
70
|
+
...(existsSync(join(ROOT, 'packages')) ? readdirSync(join(ROOT, 'packages')).map((d) => join(ROOT, 'packages', d, 'node_modules')) : []),
|
|
71
|
+
];
|
|
72
|
+
for (const base of bundlers) for (const v of variants) out.push(join(base, rel, v));
|
|
73
|
+
return out;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
const REGISTRY_CANDIDATES = [
|
|
77
|
+
argValue('--codes'),
|
|
78
|
+
join(ROOT, 'packages', 'shared', 'src', 'portal', 'registry.ts'),
|
|
79
|
+
...installedCandidates(),
|
|
80
|
+
].filter(Boolean);
|
|
81
|
+
|
|
82
|
+
/** 从 registry 提取门户 code(避免本脚本自己维护第二份清单)。 */
|
|
83
|
+
function readPortalCodes() {
|
|
84
|
+
const found = REGISTRY_CANDIDATES.find((p) => existsSync(p));
|
|
85
|
+
if (!found) return { codes: [], registry: null };
|
|
86
|
+
const src = readFileSync(found, 'utf8');
|
|
87
|
+
const codes = [...src.matchAll(/code:\s*['"]([a-z0-9-]+)['"]/g)].map((m) => m[1]);
|
|
88
|
+
return { codes: [...new Set(codes)], registry: found };
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
function walk(dir, out = []) {
|
|
92
|
+
for (const entry of readdirSync(dir)) {
|
|
93
|
+
const full = join(dir, entry);
|
|
94
|
+
const stat = statSync(full);
|
|
95
|
+
if (stat.isDirectory()) {
|
|
96
|
+
if (SKIP_DIR.has(entry)) continue;
|
|
97
|
+
walk(full, out);
|
|
98
|
+
} else if (/\.(ts|tsx)$/.test(entry) && !SKIP_FILE.test(entry)) {
|
|
99
|
+
out.push(full);
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
return out;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* 只在「数组字面量 / Set 字面量」上判定(`['a','b']` / `new Set([...])`)。
|
|
107
|
+
* 单门户字面量(`code === 'admin'`、`getPortalUrl('admin')`、类型联合)不算清单,不报。
|
|
108
|
+
*/
|
|
109
|
+
/**
|
|
110
|
+
* 去注释(保留字符串原样、保留换行以维持行号)。
|
|
111
|
+
*
|
|
112
|
+
* 不能用正则一把梭:`'https://…'` 里的 `//` 会把整行截断成"已剥离",
|
|
113
|
+
* `'src/*.ts'` 里的 `/*` 会开一个幽灵块注释吞掉后面的真代码 —— 两者都会造成**漏报**。
|
|
114
|
+
* 所以走一次字符级状态机(code / line-comment / block-comment / string / template)。
|
|
115
|
+
* 已知边界:正则字面量(如 `/\/\//`)按代码处理,若其中含 `//` 仍可能误判(本仓无此写法)。
|
|
116
|
+
*/
|
|
117
|
+
function stripComments(src) {
|
|
118
|
+
let out = '';
|
|
119
|
+
let state = 'code';
|
|
120
|
+
for (let i = 0; i < src.length; i += 1) {
|
|
121
|
+
const ch = src[i];
|
|
122
|
+
const next = src[i + 1];
|
|
123
|
+
if (state === 'code') {
|
|
124
|
+
if (ch === '/' && next === '/') {
|
|
125
|
+
state = 'line';
|
|
126
|
+
i += 1;
|
|
127
|
+
continue;
|
|
128
|
+
}
|
|
129
|
+
if (ch === '/' && next === '*') {
|
|
130
|
+
state = 'block';
|
|
131
|
+
i += 1;
|
|
132
|
+
continue;
|
|
133
|
+
}
|
|
134
|
+
if (ch === "'" || ch === '"' || ch === '`') {
|
|
135
|
+
state = ch;
|
|
136
|
+
out += ch;
|
|
137
|
+
continue;
|
|
138
|
+
}
|
|
139
|
+
out += ch;
|
|
140
|
+
continue;
|
|
141
|
+
}
|
|
142
|
+
if (state === 'line') {
|
|
143
|
+
if (ch === '\n') {
|
|
144
|
+
state = 'code';
|
|
145
|
+
out += '\n';
|
|
146
|
+
}
|
|
147
|
+
continue;
|
|
148
|
+
}
|
|
149
|
+
if (state === 'block') {
|
|
150
|
+
if (ch === '*' && next === '/') {
|
|
151
|
+
state = 'code';
|
|
152
|
+
i += 1;
|
|
153
|
+
continue;
|
|
154
|
+
}
|
|
155
|
+
if (ch === '\n') out += '\n';
|
|
156
|
+
continue;
|
|
157
|
+
}
|
|
158
|
+
// 字符串 / 模板串内部:原样保留(含转义)
|
|
159
|
+
if (ch === '\\') {
|
|
160
|
+
out += ch + (next ?? '');
|
|
161
|
+
i += 1;
|
|
162
|
+
continue;
|
|
163
|
+
}
|
|
164
|
+
// 单/双引号字符串不跨行:遇到换行仍未闭合 ⇒ 说明前面把 JSX 撇号 / 正则引号当成了字符串起点。
|
|
165
|
+
// 回到 code 态(fail-closed:宁可多剥注释,也不要因状态带偏而漏报或误报)。
|
|
166
|
+
if (ch === '\n' && state !== '`') {
|
|
167
|
+
state = 'code';
|
|
168
|
+
out += ch;
|
|
169
|
+
continue;
|
|
170
|
+
}
|
|
171
|
+
if (ch === state) state = 'code';
|
|
172
|
+
out += ch;
|
|
173
|
+
}
|
|
174
|
+
return out;
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
function findViolations(file, codes, exemptions) {
|
|
178
|
+
const rawSrc = readFileSync(file, 'utf8');
|
|
179
|
+
const src = stripComments(rawSrc); // 扫描用:注释已剥离
|
|
180
|
+
const violations = [];
|
|
181
|
+
const blocks = [
|
|
182
|
+
...src.matchAll(/new Set\(\s*\[[\s\S]{0,4000}?\]\s*\)/g),
|
|
183
|
+
...src.matchAll(/\[[^[\]]{0,4000}\]/g),
|
|
184
|
+
];
|
|
185
|
+
for (const block of blocks) {
|
|
186
|
+
// 取块内所有字符串字面量:**全部**都是门户 code 才算「门户清单」。
|
|
187
|
+
// 只要求「含 ≥2 个 code」会在站点仓大量误报('status'/'secret'/'user'/'admin' 也是业务名词:
|
|
188
|
+
// 服务名清单、用户菜单项都会命中)。全量匹配才能区分「门户清单」与「恰好撞词的业务枚举」。
|
|
189
|
+
const strings = [...block[0].matchAll(/['"]([^'"]*)['"]/g)].map((m) => m[1]);
|
|
190
|
+
const hits = strings.filter((s) => codes.includes(s));
|
|
191
|
+
if (hits.length < 2) continue;
|
|
192
|
+
if (strings.some((s) => !codes.includes(s))) continue;
|
|
193
|
+
const upTo = (block.index ?? 0) + block[0].length;
|
|
194
|
+
const line = src.slice(0, upTo).split(/\r?\n/).length;
|
|
195
|
+
// 显式豁免:块起始行前 4 行内写 `portal-literals-ok: <理由>`。
|
|
196
|
+
// 只给「不是可见性策略、但确实要写死几条门户」的场景(如目录失败时的静态兜底);
|
|
197
|
+
// 与 eslint-disable 同性质:理由在代码里、评审可见,豁免数在输出里单独报。
|
|
198
|
+
const allLines = rawSrc.split(/\r?\n/); // 豁免标记在注释里 ⇒ 必须查原文
|
|
199
|
+
const startLine = src.slice(0, block.index ?? 0).split(/\r?\n/).length;
|
|
200
|
+
const exempt = allLines
|
|
201
|
+
.slice(Math.max(0, startLine - 4), startLine)
|
|
202
|
+
.some((l) => /portal-literals-ok/.test(l));
|
|
203
|
+
if (exempt) {
|
|
204
|
+
exemptions.push({ line, codes: hits });
|
|
205
|
+
continue;
|
|
206
|
+
}
|
|
207
|
+
violations.push({
|
|
208
|
+
line,
|
|
209
|
+
codes: hits,
|
|
210
|
+
text: block[0].replace(/\s+/g, ' ').slice(0, 120),
|
|
211
|
+
});
|
|
212
|
+
}
|
|
213
|
+
// Set 字面量会同时命中内层数组 ⇒ 按 (行, code 集) 去重
|
|
214
|
+
const seen = new Set();
|
|
215
|
+
return violations.filter((v) => {
|
|
216
|
+
const key = `${v.line}:${[...v.codes].sort().join(',')}`;
|
|
217
|
+
if (seen.has(key)) return false;
|
|
218
|
+
seen.add(key);
|
|
219
|
+
return true;
|
|
220
|
+
});
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
const { codes, registry } = readPortalCodes();
|
|
224
|
+
if (codes.length === 0) {
|
|
225
|
+
console.error(
|
|
226
|
+
'check-portal-literals:取不到门户 code 清单。已找过:\n ' +
|
|
227
|
+
REGISTRY_CANDIDATES.join('\n ') +
|
|
228
|
+
'\n(站点仓请先安装 @autional/shared,或用 --codes 指向 registry 文件)',
|
|
229
|
+
);
|
|
230
|
+
process.exit(1);
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
const registryAbs = registry ? resolve(registry) : null;
|
|
234
|
+
const files = SCAN_DIRS.flatMap((dir) => walk(dir)).filter((f) => resolve(f) !== registryAbs);
|
|
235
|
+
const results = [];
|
|
236
|
+
const exemptions = [];
|
|
237
|
+
for (const file of files) {
|
|
238
|
+
const violations = findViolations(file, codes, exemptions);
|
|
239
|
+
if (violations.length > 0) results.push({ file: relative(ROOT, file), violations });
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
/**
|
|
243
|
+
* 站点面:ui 仓的 verify 在**舰队机器**上要连带扫 6 个站点仓,
|
|
244
|
+
* 否则「各站自己扫」又会变成 6 份实现(正是本门要消灭的东西)。
|
|
245
|
+
* 站点清单优先取 AUTIONAL_SITES_DIR,回退 <ui>/../sites;不存在就跳过(与其它闸门同约定:
|
|
246
|
+
* 跳过必须在输出里看得见)。
|
|
247
|
+
*/
|
|
248
|
+
function scanSites() {
|
|
249
|
+
const sitesDir =
|
|
250
|
+
process.env.AUTIONAL_SITES_DIR || resolve(ROOT, '..', 'sites');
|
|
251
|
+
if (!existsSync(sitesDir)) return null;
|
|
252
|
+
const out = [];
|
|
253
|
+
for (const entry of readdirSync(sitesDir, { withFileTypes: true })) {
|
|
254
|
+
const siteRoot = join(sitesDir, entry.name);
|
|
255
|
+
// 舰队树里各站常是 junction / symlink ⇒ Dirent.isDirectory() 为 false,必须再 stat 一次
|
|
256
|
+
const isDir = entry.isDirectory() || (entry.isSymbolicLink() && statSync(siteRoot).isDirectory());
|
|
257
|
+
if (!isDir) continue;
|
|
258
|
+
if (!existsSync(join(siteRoot, 'apps')) && !existsSync(join(siteRoot, 'src'))) continue;
|
|
259
|
+
const siteCodes = readPortalCodesFor(siteRoot) ?? codes;
|
|
260
|
+
const dirs = ['packages', 'apps', 'src']
|
|
261
|
+
.filter((d) => existsSync(join(siteRoot, d)))
|
|
262
|
+
.map((d) => join(siteRoot, d));
|
|
263
|
+
const siteFiles = dirs.flatMap((d) => walk(d));
|
|
264
|
+
const siteExemptions = [];
|
|
265
|
+
const siteViolations = [];
|
|
266
|
+
for (const file of siteFiles) {
|
|
267
|
+
const v = findViolations(file, siteCodes, siteExemptions);
|
|
268
|
+
if (v.length) siteViolations.push({ file: relative(siteRoot, file), violations: v });
|
|
269
|
+
}
|
|
270
|
+
out.push({
|
|
271
|
+
site: entry.name,
|
|
272
|
+
files: siteFiles.length,
|
|
273
|
+
exemptions: siteExemptions.length,
|
|
274
|
+
results: siteViolations,
|
|
275
|
+
});
|
|
276
|
+
}
|
|
277
|
+
return out;
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
/** 站点自己的 shared 安装(pnpm workspace 常在 apps/<app>/node_modules)。 */
|
|
281
|
+
function readPortalCodesFor(siteRoot) {
|
|
282
|
+
const candidates = [
|
|
283
|
+
join(siteRoot, 'node_modules', '@autional', 'shared', 'src', 'portal', 'registry.ts'),
|
|
284
|
+
...(existsSync(join(siteRoot, 'apps'))
|
|
285
|
+
? readdirSync(join(siteRoot, 'apps')).map((d) =>
|
|
286
|
+
join(siteRoot, 'apps', d, 'node_modules', '@autional', 'shared', 'src', 'portal', 'registry.ts'),
|
|
287
|
+
)
|
|
288
|
+
: []),
|
|
289
|
+
];
|
|
290
|
+
const found = candidates.find((p) => existsSync(p));
|
|
291
|
+
if (!found) return null;
|
|
292
|
+
const src = readFileSync(found, 'utf8');
|
|
293
|
+
return [...new Set([...src.matchAll(/code:\s*['"]([a-z0-9-]+)['"]/g)].map((m) => m[1]))];
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
const sites = scanSites();
|
|
297
|
+
const siteFailures = (sites ?? []).filter((s) => s.results.length > 0);
|
|
298
|
+
|
|
299
|
+
if (process.argv.includes('--json')) {
|
|
300
|
+
console.log(JSON.stringify({ codes, results, exemptions, sites }, null, 2));
|
|
301
|
+
} else {
|
|
302
|
+
if (results.length === 0) {
|
|
303
|
+
console.log(
|
|
304
|
+
`check-portal-literals:PASS(${files.length} 个文件,门户 code 字面量 0 处` +
|
|
305
|
+
`${exemptions.length ? `;显式豁免 ${exemptions.length} 处` : ''})`,
|
|
306
|
+
);
|
|
307
|
+
} else {
|
|
308
|
+
console.error(`check-portal-literals:FAIL(${results.length} 个文件仍持有门户字面量清单)`);
|
|
309
|
+
if (exemptions.length) console.error(` (另有显式豁免 ${exemptions.length} 处)`);
|
|
310
|
+
for (const { file, violations } of results) {
|
|
311
|
+
for (const v of violations) {
|
|
312
|
+
console.error(` ${file}:${v.line} [${v.codes.join(', ')}] ${v.text}`);
|
|
313
|
+
}
|
|
314
|
+
}
|
|
315
|
+
console.error(' 修法:改用 @autional/shared[/portal] 的派生函数' +
|
|
316
|
+
'(isConsolePortal / getConsolePortalCodes / getSwitcherExcludedCodes / ADMIN_PLANE_ROLES)');
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
if (sites === null) {
|
|
320
|
+
console.log('check-portal-literals:站点面跳过(本机无 sites/;舰队机器上会连带扫 6 站)');
|
|
321
|
+
} else {
|
|
322
|
+
for (const s of sites) {
|
|
323
|
+
const suffix = s.exemptions ? `;显式豁免 ${s.exemptions} 处` : '';
|
|
324
|
+
if (s.results.length === 0) {
|
|
325
|
+
console.log(` [${s.site}] PASS(${s.files} 个文件,0 处${suffix})`);
|
|
326
|
+
continue;
|
|
327
|
+
}
|
|
328
|
+
console.error(` [${s.site}] FAIL(${s.results.length} 个文件)${suffix}`);
|
|
329
|
+
for (const { file, violations } of s.results) {
|
|
330
|
+
for (const v of violations) {
|
|
331
|
+
console.error(` ${file}:${v.line} [${v.codes.join(', ')}] ${v.text}`);
|
|
332
|
+
}
|
|
333
|
+
}
|
|
334
|
+
}
|
|
335
|
+
console.log(
|
|
336
|
+
`check-portal-literals:站点面 ${sites.length} 站,${siteFailures.length ? `${siteFailures.length} 站有清单` : '全部 0 处'}`,
|
|
337
|
+
);
|
|
338
|
+
}
|
|
339
|
+
}
|
|
340
|
+
|
|
341
|
+
process.exit(results.length === 0 && siteFailures.length === 0 ? 0 : 1);
|