w-web-perm 1.1.3 → 1.1.5

package/server/maskLog.mjs

@@ -0,0 +1,104 @@
+import isestr from 'wsemi/src/isestr.mjs'
+import isarr from 'wsemi/src/isarr.mjs'
+
+
+//maskLog: 權杖與網址寫入 console / srLog 前之遮罩(M 契約, spec/設計要點與取捨.md ADR-023)
+//四 repo 一致(w-web-sso server/srLog.mjs 之 maskToken 與 src/maskUrl.mjs、w-web-api / w-web-task 之 maskTok), 以同一組測資守護(test/unit-maskLog.test.mjs)
+//why: 原 console 站點原樣印出 token / req.query / authorization(Hapi 對重複之 query 參數給陣列, 型別檢查失敗之分支正是印出處), verifyConn 之 srLog 原樣記 referer
+
+
+//safe: 露出字元之控制字元換成 '?', 避免請求端以 CR/LF 偽造 log 行
+function safe(s) {
+    return Array.from(s, (c) => {
+        let x = c.charCodeAt(0)
+        return (x < 32 || x === 127) ? '?' : c
+    }).join('')
+}
+
+
+/**
+ * 權杖遮罩
+ * - 空值(undefined / null / '')回 ''
+ * - 陣列逐元素遮罩
+ * - 字串(長度 n)露出前後各 k=min(4, floor(n/8)) 字: k=0 只回 '(len=n)', 否則 '前k...後k(len=n)'; 36 字元之 session token 為前 4 後 4(與 w-web-sso 格式相同)
+ * - 其他型別只回 '(typeof)', 絕不輸出原值
+ *
+ * @param {*} token 輸入權杖
+ * @returns {String|Array} 回傳遮罩後字串, 輸入陣列時回傳陣列
+ */
+function maskTok(token) {
+    if (isarr(token)) {
+        return token.map(maskTok)
+    }
+    if (token === undefined || token === null || token === '') {
+        return ''
+    }
+    if (!isestr(token)) {
+        return `(${typeof token})`
+    }
+    let n = token.length
+    let k = Math.min(4, Math.floor(n / 8))
+    if (k === 0) {
+        return `(len=${n})`
+    }
+    return `${safe(token.slice(0, k))}...${safe(token.slice(-k))}(len=${n})`
+}
+
+
+/**
+ * 查詢參數遮罩: 淺拷貝, 鍵名小寫為 token 者以 maskTok 處理, 其餘原樣(供印出 req.query)
+ * 非物件輸入依 maskTok 處理
+ *
+ * @param {*} q 輸入查詢參數物件(Hapi 之 req.query 為 null-prototype 物件)
+ * @returns {Object|String|Array} 回傳遮罩後之淺拷貝
+ */
+function maskQuery(q) {
+    if (q === null || typeof q !== 'object' || isarr(q)) {
+        return maskTok(q)
+    }
+    let r = {}
+    for (let k of Object.keys(q)) {
+        r[k] = (k.toLowerCase() === 'token') ? maskTok(q[k]) : q[k]
+    }
+    return r
+}
+
+
+/**
+ * 網址遮罩: http(s) 只留 origin + pathname, 捨棄 query / fragment / userinfo(其內常含權杖, 如 ?token=)
+ * - 陣列逐元素處理; 空值回 ''; 其他非字串只回 '(typeof)'
+ * - 非 http(s) 之網址(如 data:、javascript:)路徑即全部內容, 只回 protocol(同 w-web-sso src/maskUrl.mjs)
+ * - 無法解析回 '(invalid-url)'
+ *
+ * @param {*} u 輸入網址
+ * @returns {String|Array} 回傳可寫入 log 之字串, 輸入陣列時回傳陣列
+ */
+function maskUrl(u) {
+    if (isarr(u)) {
+        return u.map(maskUrl)
+    }
+    if (u === undefined || u === null || u === '') {
+        return ''
+    }
+    if (!isestr(u)) {
+        return `(${typeof u})`
+    }
+    let x = null
+    try {
+        x = new URL(u)
+    }
+    catch (err) {
+        return '(invalid-url)'
+    }
+    if (x.protocol !== 'http:' && x.protocol !== 'https:') {
+        return x.protocol
+    }
+    return `${x.origin}${x.pathname}`
+}
+
+
+export {
+    maskTok,
+    maskQuery,
+    maskUrl
+}

package/server/procLang.mjs

@@ -318,6 +318,14 @@ let kpLang = {
         eng: `Hide menu`,
         cht: `隱藏選單`,
     },
+    menuUser: { //上方標題列窄版漢堡按鈕之無障礙名稱(aria-label), 其選單內含當前登入者資訊/語系切換
+        eng: `User menu`,
+        cht: `使用者選單`,
+    },
+    language: { //上方標題列窄版選單內語系切換列之標籤
+        eng: `Language`,
+        cht: `語系`,
+    },
 
     mmTargets: {
         eng: `Targets`,

package/server/procStaInfor.mjs

@@ -6,13 +6,23 @@ import staEvent from './staLogs/staEvent.callWorker.mjs'
 import staEventTable from './staLogs/staEventTable.callWorker.mjs'
 
 
+//mock 之事件名單：
+//  true（預設 5 種）：既有 e2e 標準圖所用；
+//  'many'（13 種）：本系統實際會記錄之事件名（取自本機 log），供圖例列數跨門檻之 e2e（1440 寬時一般式 2 列，勾全部加總並切中文為 3 列）
+let MOCK_EVENTS = ['verifyConn', 'updateTargets-success', 'checkUser-error', 'api/getPerm-success', 'getWebInfor-success']
+let MOCK_EVENTS_MANY = ['api/getPermUserInfor-success', 'api/getUserByToken-success', 'getStaEvent-success', 'getStaEventTable-success', 'getTokenUser-error', 'getWebInfor-success', 'updateGrups-success', 'updatePemis-success', 'updateTabItems-pickKeysOnly', 'updateTargets-success', 'updateUsers-success', 'verifyConn', 'verifyConn-error']
+function getMockEvents(mock) {
+    return mock === 'many' ? MOCK_EVENTS_MANY : MOCK_EVENTS
+}
+
+
 //mock 確定性資料集（供 e2e 統計圖穩定用）：固定起點時間 + 固定 sin 計數，不依 now / log → 每次完全相同。
-//觸發：opt.mock=true（由 settings.json staEventMock 經 srv.mjs → WWebPerm 傳入）。非 mock 時走真實 staEvent。
-function genMockStaEvent(timeInterval = 'hr') {
+//觸發：opt.mock 為 true 或 'many'（由 settings.json staEventMock 經 srv.mjs → WWebPerm 傳入）。非 mock 時走真實 staEvent。
+function genMockStaEvent(timeInterval = 'hr', mock = true) {
     let fmt = timeInterval === 'day' ? 'YYYY-MM-DD' : 'YYYY-MM-DDTHH'
     let unit = timeInterval === 'hr' ? 'hour' : 'day'
     let nBuckets = timeInterval === 'hr' ? 48 : 7
-    let events = ['verifyConn', 'updateTargets-success', 'checkUser-error', 'api/getPerm-success', 'getWebInfor-success']
+    let events = getMockEvents(mock)
     let base = ot('2025-01-01T00:00:00') //固定起點，不依 now
     let rs = []
     for (let i = 0; i < nBuckets; i++) {
@@ -30,15 +40,23 @@ function genMockStaEvent(timeInterval = 'hr') {
 
 
 //mock 確定性資料集（供 e2e 統計表穩定用）：固定窗計數，不依 now / log → 每次完全相同。
-//5 個 event 與 genMockStaEvent 同名單；各事件滿足 last1Day>last8Hour>last4Hour>last1Hour，且各事件 last1Day 互不相同（排序明確、上多下少）。
-function genMockStaEventTable() {
-    let rs = [
-        { event: 'verifyConn', last1Day: 240, last8Hour: 90, last4Hour: 50, last1Hour: 15 },
-        { event: 'updateTargets-success', last1Day: 180, last8Hour: 70, last4Hour: 38, last1Hour: 11 },
-        { event: 'checkUser-error', last1Day: 120, last8Hour: 45, last4Hour: 24, last1Hour: 7 },
-        { event: 'api/getPerm-success', last1Day: 90, last8Hour: 33, last4Hour: 18, last1Hour: 5 },
-        { event: 'getWebInfor-success', last1Day: 60, last8Hour: 22, last4Hour: 12, last1Hour: 3 },
-    ]
+//事件名單與 genMockStaEvent 相同；各事件滿足 last1Day>last8Hour>last4Hour>last1Hour，且各事件 last1Day 互不相同（排序明確、上多下少）。
+function genMockStaEventTable(mock = true) {
+    if (mock !== 'many') {
+        let rs = [
+            { event: 'verifyConn', last1Day: 240, last8Hour: 90, last4Hour: 50, last1Hour: 15 },
+            { event: 'updateTargets-success', last1Day: 180, last8Hour: 70, last4Hour: 38, last1Hour: 11 },
+            { event: 'checkUser-error', last1Day: 120, last8Hour: 45, last4Hour: 24, last1Hour: 7 },
+            { event: 'api/getPerm-success', last1Day: 90, last8Hour: 33, last4Hour: 18, last1Hour: 5 },
+            { event: 'getWebInfor-success', last1Day: 60, last8Hour: 22, last4Hour: 12, last1Hour: 3 },
+        ]
+        return rs
+    }
+    //'many': 依名單順序遞減, last1Day 自 400 起每事件少 20（互不相同）
+    let rs = MOCK_EVENTS_MANY.map((event, k) => {
+        let last1Day = 400 - k * 20
+        return { event, last1Day, last8Hour: Math.round(last1Day * 0.4), last4Hour: Math.round(last1Day * 0.2), last1Hour: Math.round(last1Day * 0.05) }
+    })
     return rs
 }
 
@@ -66,7 +84,7 @@ function proc(opt = {}) {
 
         //mock 模式回固定確定性資料集
         if (mock) {
-            return genMockStaEvent(timeInterval)
+            return genMockStaEvent(timeInterval, mock)
         }
 
         //staEvent
@@ -98,7 +116,7 @@ function proc(opt = {}) {
 
         //mock 模式回固定確定性資料集
         if (mock) {
-            return genMockStaEventTable()
+            return genMockStaEventTable(mock)
         }
 
         //staEventTable

package/server/wrapInjected.mjs

@@ -0,0 +1,91 @@
+import get from 'lodash-es/get.js'
+import isestr from 'wsemi/src/isestr.mjs'
+import isarr from 'wsemi/src/isarr.mjs'
+import isfun from 'wsemi/src/isfun.mjs'
+
+
+//wrapInjected: 部署方注入函數(getUserByToken / verifyClientUser / verifyAppUser)之包裝(W 契約, spec/設計要點與取捨.md ADR-023)
+//why: 注入函數拋錯或 reject 時原會被 await 原樣上拋, 其原文經 pm2resolve 回前端、經 verifyConn 之 msg 入 srLog、經 error 事件印出;
+//部署方常以 w-web-sso 對外 helper(≤1.1.4)包裝 getUserByToken, 其 reject 字串含已代入系統介接權杖與使用者權杖之完整網址(修正前探測實證)。
+//包裝後失敗視同否定結果(由呼叫端給 failValue), 走各呼叫點既有之查無 / 無權限分支回自家 key; 上游原文不回前端、不入 log。
+
+
+//keysUpstream: 上游失敗可照記之 key 白名單 = w-web-sso 對外 helper 之 K 契約 14 個 key(w-web-sso ADR-068)
+//與 sso 之同步點: sso 之 K 契約增減 key 時須同步本表(見 CLAUDE_rulebook.md「權杖不外洩」)
+let keysUpstream = [
+    'invalidUrl',
+    'invalidTokenSelf',
+    'invalidTokenTar',
+    'invalidUserIdTar',
+    'noTokenKeyValueInUrl',
+    'noTokenKeyUserIdInUrl',
+    'noTokenInUrl',
+    'cannotGetUserByUrl',
+    'cannotGetUsersByUrl',
+    'cannotGetUserDataByUrl',
+    'cannotGetUsersDataByUrl',
+    'noUserDataByUrl',
+    'noUsersDataByUrl',
+    'noUserDataAfterConvert',
+]
+
+
+//reName: Error.name 之名稱形狀(同 w-web-sso helper 診斷之 errName), 不符者不記(name 亦可被設為任意字串)
+let reName = /^[A-Za-z]{1,40}$/
+
+
+/**
+ * 描述上游失敗, 供寫入 log: 絕不含上游原文
+ * - reject 值(字串)或其 message 屬白名單 key → { upstream: key }
+ * - 其餘 → { upstreamType, upstreamName }: 型別(null / array / typeof)與名稱形狀之 Error.name(無則 '')
+ *
+ * @param {*} err 輸入注入函數拋出或 reject 之值
+ * @returns {Object} 回傳描述物件
+ */
+function describeUpstream(err) {
+    let key = isestr(err) ? err : get(err, 'message')
+    if (isestr(key) && keysUpstream.includes(key)) {
+        return { upstream: key }
+    }
+    let upstreamType = (err === null) ? 'null' : (isarr(err) ? 'array' : typeof err)
+    let name = get(err, 'name')
+    let upstreamName = (isestr(name) && reName.test(name)) ? name : ''
+    return { upstreamType, upstreamName }
+}
+
+
+/**
+ * 包裝注入函數: 回傳(同步或 Promise)原樣回傳; 同步拋錯或 reject 回 failValue, 並以 describeUpstream(err) 呼叫 onFail
+ * 包裝後一律回 Promise(呼叫端既有之 ispm 判斷照常)
+ *
+ * @param {Function} fn 輸入注入函數
+ * @param {Object} [opt={}] 輸入設定物件
+ * @param {*} [opt.failValue=null] 輸入失敗時之回傳值(getUserByToken 為 null 等同查無, verify* 為 false 等同無權限)
+ * @param {Function} [opt.onFail=null] 輸入失敗時之紀錄函數, 只收到 describeUpstream 之結果(收不到上游原文); 其自身拋錯不影響回傳
+ * @returns {Function} 回傳包裝後之函數
+ */
+function wrapInjected(fn, opt = {}) {
+    let failValue = get(opt, 'failValue', null)
+    let onFail = get(opt, 'onFail', null)
+    return async (...args) => {
+        try {
+            return await fn(...args) //await 於 try 內: 同步拋錯、reject 與 thenable 之 reject 皆攔截
+        }
+        catch (err) {
+            if (isfun(onFail)) {
+                try {
+                    onFail(describeUpstream(err))
+                }
+                catch (e) {} //紀錄失敗不改變「失敗＝否定結果」之語意
+            }
+            return failValue
+        }
+    }
+}
+
+
+export {
+    keysUpstream,
+    describeUpstream
+}
+export default wrapInjected