w-serv-orm 1.1.7 → 1.1.9

package/src/getDbBackupAndRecover.mjs

@@ -1,10 +1,15 @@
 // import path from 'path'
 import fs from 'fs'
-import trim from 'lodash-es/trim.js'
-import size from 'lodash-es/size.js'
+import trim from 'lodash-es/trim.js'
+import size from 'lodash-es/size.js'
+import get from 'lodash-es/get.js'
+import each from 'lodash-es/each.js'
 import pmSeries from 'wsemi/src/pmSeries.mjs'
 import fsIsFile from 'wsemi/src/fsIsFile.mjs'
 import iseobj from 'wsemi/src/iseobj.mjs'
+import isearr from 'wsemi/src/isearr.mjs'
+import isestr from 'wsemi/src/isestr.mjs'
+import haskey from 'wsemi/src/haskey.mjs'
 import isfun from 'wsemi/src/isfun.mjs'
 import isbol from 'wsemi/src/isbol.mjs'
 import j2o from 'wsemi/src/j2o.mjs'
@@ -12,6 +17,12 @@ import j2o from 'wsemi/src/j2o.mjs'
 
 async function backup(woItems) {
 
+    //check, 同recover; 否則無效值由pmSeries以字串reject, 而空物件或空陣列會產出recover拒收之空備份
+    if (!iseobj(woItems)) {
+        console.log('woItems', woItems)
+        throw new Error('invalid woItems')
+    }
+
     //rs
     let rs = await pmSeries(woItems, async (v, k) => {
         console.log('backup...', k)
@@ -58,6 +69,20 @@ async function recover(fp, woItems, genModels, needCreateStorage = false) {
     let rs = j2o(j)
     // console.log('recover rs', rs)
 
+    //check, 備份內容須為非空陣列, 且各筆之name為woItems內之資料表; 於任何寫入之前驗證, 避免空檔或壞檔(j2o解析失敗回{})假成功, 亦避免部分還原
+    if (!isearr(rs)) {
+        throw new Error('invalid backup data, need a non-empty array')
+    }
+    each(rs, (v, k) => {
+        let name = get(v, 'name')
+        if (!isestr(name)) {
+            throw new Error(`invalid backup data, rs[${k}].name is not a string`)
+        }
+        if (!haskey(woItems, name)) {
+            throw new Error(`invalid backup data, table[${name}] is not in woItems`)
+        }
+    })
+
     //genModels
     if (isfun(genModels)) {
         genModels()

package/src/getItemsFail.mjs

@@ -1,37 +1,5 @@
-import get from 'lodash-es/get.js'
-import each from 'lodash-es/each.js'
-import isarr from 'wsemi/src/isarr.mjs'
-
-
-function getItemsFail(rs, data) {
-    //由ORM逐筆函數(save、del)之回傳結果取出失敗者, 回傳[{k,id,err}], k為該筆於輸入內之位置
-    //w-orm系列規格: 逐筆函數回傳與輸入等長保序之陣列, 單筆失敗時整批仍resolve, 該筆以ok為0並附err回報, 須由呼叫端逐筆檢查
-    //逐筆結果不含主鍵, 故主鍵取自輸入之同位置數據
-
-    //check, 未依規格之ORM可能回傳非陣列, 無從逐筆檢查
-    if (!isarr(rs)) {
-        return []
-    }
-
-    //check, 輸入為單一物件時ORM回傳長度為1之陣列
-    if (!isarr(data)) {
-        data = [data]
-    }
-
-    //fails, 僅ok為0者視為失敗
-    let fails = []
-    each(rs, (v, k) => {
-        if (get(v, 'ok') === 0) {
-            fails.push({
-                k,
-                id: get(data, [k, 'id']),
-                err: get(v, 'err', ''),
-            })
-        }
-    })
-
-    return fails
-}
+import getItemsFail from 'w-data-collector/src/getItemsFail.mjs'
 
 
+//相容檔: 本套件1.1.7曾以此路徑提供getItemsFail, 使用端有以深層路徑引用者(如w-web-sso之server/ormWrite.mjs), 故保留並轉出w-data-collector之實作
 export default getItemsFail

package/src/getMapOrm.mjs

@@ -4,54 +4,98 @@ import map from 'lodash-es/map.js'
 import size from 'lodash-es/size.js'
 import take from 'lodash-es/take.js'
 import join from 'lodash-es/join.js'
+import truncate from 'lodash-es/truncate.js'
 import nowms2str from 'wsemi/src/nowms2str.mjs'
+import genIDSeq from 'wsemi/src/genIDSeq.mjs'
 import isarr from 'wsemi/src/isarr.mjs'
 import iseobj from 'wsemi/src/iseobj.mjs'
 import isestr from 'wsemi/src/isestr.mjs'
 import isnum from 'wsemi/src/isnum.mjs'
 import clearXSS from 'wsemi/src/clearXSS.mjs'
-import getItemsFail from './getItemsFail.mjs'
-
-
-let _ds = null
-let _woItems = null
+import getItemsFail from 'w-data-collector/src/getItemsFail.mjs'
 
 
 function getMsgFail(msg, fails) {
     //前端訊息僅列出失敗筆, 錯誤原文另由console.log輸出, 與既有整批錯誤之處理一致
     //有效主鍵(非空字串或數字)列為id[...], 否則列其於輸入內之位置, 失敗筆數過多時僅列前nShow筆並附總筆數
+    //主鍵超過nIdMax字元者截斷顯示(LMDB逐筆失敗常因主鍵超長, 故兩者常同時出現), log仍保留全文
 
-    //nShow
+    //nShow, nIdMax
     let nShow = 10
+    let nIdMax = 100
 
     //ss
     let ss = map(take(fails, nShow), (v) => {
         if (isestr(v.id) || isnum(v.id)) {
-            return `id[${v.id}]`
+            return `id[${truncate(String(v.id), { length: nIdMax, omission: '…' })}]`
         }
-        return `第${v.k + 1}筆`
+        return `data[${v.k}]`
     })
 
     //c
     let c = `${msg}: ${join(ss, ', ')}`
     if (size(fails) > nShow) {
-        c += `等共${size(fails)}筆`
+        c += `, ... (${size(fails)} in total)`
     }
 
     return c
 }
 
 
-function adjustData(woName, userId, data, mode = 'save') { //mode: 'insert', 'save', 'insert+save'
+function isPkIdString(dsTab, keys) {
+    //資料表之主鍵欄是否為id且可容納字串型之補值, 供adjustData判斷是否補主鍵
+
+    //check, 須有id欄; 有settings者另須標為pk
+    if (keys.indexOf('id') < 0) {
+        return false
+    }
+    let settings = get(dsTab, 'settings', null)
+    if (iseobj(settings) && get(settings, 'id.pk') !== true) {
+        return false
+    }
+
+    //check, 型別已知者須為字串型, 與w-orm-reladb可自動補值之主鍵欄型別一致
+    let type = get(settings, 'id.type', '') || get(dsTab, 'kpType.id', '')
+    if (isestr(type) && ['STRING', 'TEXT', 'CHAR', 'UUID', 'CITEXT'].indexOf(type.toUpperCase()) < 0) {
+        return false
+    }
+
+    return true
+}
+
+
+function getItemsIdXSS(data) {
+    //輸入數據之主鍵(非空字串)會被clearXSS改寫者, 回傳[{k,id}], k為其於輸入內之位置
+    //寫入路徑之欄位皆經clearXSS而select與del不經過, 主鍵被改寫後以原主鍵查詢與刪除皆找不到, 故呼叫端須於寫入前整批拒絕
+    let rs = []
+    each(isarr(data) ? data : [data], (v, k) => {
+        let id = get(v, 'id')
+        if (isestr(id) && clearXSS(id) !== id) {
+            rs.push({ k, id })
+        }
+    })
+    return rs
+}
+
+
+function getMsgIdXSS(msg, fails) {
+    //主鍵含HTML標記, 訊息只列位置不回顯主鍵, 主鍵原文另由console.log輸出
+    return getMsgFail(`${msg}, id contains HTML markup`, map(fails, (v) => {
+        return { k: v.k }
+    }))
+}
+
+
+function adjustData(ds, woName, userId, data, mode = 'save') { //mode: 'insert', 'save', 'insert+save'
 
     //check
-    if (!iseobj(_ds)) {
-        console.log('ds', _ds)
+    if (!iseobj(ds)) {
+        console.log('ds', ds)
         throw new Error('invalid ds')
     }
 
     //keys
-    let keys = _ds[woName].keys
+    let keys = ds[woName].keys
 
     //one
     let one = false
@@ -128,6 +172,17 @@ function adjustData(woName, userId, data, mode = 'save') { //mode: 'insert', 'sa
         })
     }
 
+    //id, 未提供有效主鍵者由本套件補值, 令回傳之主鍵與實際寫入者一致, 補值器同各ORM之genIDSeq
+    //有效主鍵之判定同w-orm系列: 非空字串或數字(reladb、mdb視數字為有效)
+    //補值寫在上方之複本, 不改呼叫端原物件; 無欄位之列不補, 保留ORM視空物件為無效輸入之行為
+    if (isPkIdString(ds[woName], keys)) {
+        each(data, (v) => {
+            if (size(v) > 0 && !isestr(v.id) && !isnum(v.id)) {
+                v.id = genIDSeq()
+            }
+        })
+    }
+
     //復原data型態, 若原本data為物件則取第0個回傳
     data = one ? data[0] : data
 
@@ -135,22 +190,22 @@ function adjustData(woName, userId, data, mode = 'save') { //mode: 'insert', 'sa
 }
 
 
-async function mapOrm(userId, woName, mode, input) {
+async function mapOrm(ds, woItems, userId, woName, mode, input) {
     //由woName自動綁定至woItems內的ORM物件
     let err = null
     let r
 
     //check
-    if (!iseobj(_woItems)) {
-        return Promise.reject(`無有效woItems`)
+    if (!iseobj(woItems)) {
+        return Promise.reject(`invalid woItems`)
     }
 
     //wo
-    let wo = get(_woItems, woName, null)
+    let wo = get(woItems, woName, null)
 
     //check
     if (wo === null) {
-        return Promise.reject(`ORM找不到表名稱: ${woName}`)
+        return Promise.reject(`can not find table[${woName}] in ORM`)
     }
 
     if (mode === 'select') {
@@ -159,7 +214,7 @@ async function mapOrm(userId, woName, mode, input) {
         r = await wo.select(input)
             .catch((msg) => {
                 console.log(`${woName}.select catch`, msg)
-                err = '取得資料失敗'
+                err = 'failed to select data'
             })
 
         //check
@@ -170,13 +225,23 @@ async function mapOrm(userId, woName, mode, input) {
     }
     else if (mode === 'insert' || mode === 'save') {
 
+        //inputOrig, 呼叫端原輸入, 逐筆失敗之訊息以呼叫端視角列出(本套件補出之主鍵只寫於複本, reject時呼叫端未曾取得)
+        let inputOrig = input
+
+        //check, 主鍵會被clearXSS改寫者整批拒絕, 不寫入任何一筆
+        let failsIdXSS = getItemsIdXSS(input)
+        if (size(failsIdXSS) > 0) {
+            console.log(`${woName}.${mode} id changed by clearXSS`, failsIdXSS)
+            return Promise.reject(getMsgIdXSS(mode === 'insert' ? 'failed to insert data' : 'failed to save data', failsIdXSS))
+        }
+
         //adjustData
         try {
-            input = adjustData(woName, userId, input, mode)
+            input = adjustData(ds, woName, userId, input, mode)
         }
         catch (e) {
-            console.log(`adjustData catch`, e.toString())
-            err = '調整資料失敗'
+            console.log(`${woName}.adjustData catch`, e.toString())
+            err = 'failed to adjust data'
             return Promise.reject(err)
         }
 
@@ -184,15 +249,15 @@ async function mapOrm(userId, woName, mode, input) {
         if (mode === 'insert') {
             r = await wo.insert(input)
                 .catch((msg) => {
-                    console.log(`${woName}.save catch`, msg)
-                    err = '新增資料失敗'
+                    console.log(`${woName}.insert catch`, msg)
+                    err = 'failed to insert data'
                 })
         }
         else if (mode === 'save') {
             r = await wo.save(input)
                 .catch((msg) => {
                     console.log(`${woName}.save catch`, msg)
-                    err = '儲存資料失敗'
+                    err = 'failed to save data'
                 })
         }
 
@@ -207,7 +272,7 @@ async function mapOrm(userId, woName, mode, input) {
             let fails = getItemsFail(r, input)
             if (size(fails) > 0) {
                 console.log(`${woName}.save fail`, fails)
-                return Promise.reject(getMsgFail('儲存資料失敗', fails))
+                return Promise.reject(getMsgFail('failed to save data', getItemsFail(r, inputOrig)))
             }
         }
 
@@ -229,7 +294,7 @@ async function mapOrm(userId, woName, mode, input) {
         r = await wo.del(input)
             .catch((msg) => {
                 console.log(`${woName}.del catch`, msg)
-                err = '刪除資料失敗'
+                err = 'failed to delete data'
             })
 
         //check, 單筆失敗時整批仍resolve並以該筆ok為0回報, 須逐筆檢查
@@ -237,7 +302,7 @@ async function mapOrm(userId, woName, mode, input) {
             let fails = getItemsFail(r, input)
             if (size(fails) > 0) {
                 console.log(`${woName}.del fail`, fails)
-                err = getMsgFail('刪除資料失敗', fails)
+                err = getMsgFail('failed to delete data', fails)
             }
         }
 
@@ -248,7 +313,7 @@ async function mapOrm(userId, woName, mode, input) {
         r = await wo.delAll(input)
             .catch((msg) => {
                 console.log(`${woName}.delAll catch`, msg)
-                err = '刪除資料失敗'
+                err = 'failed to delete data'
             })
 
     }
@@ -256,7 +321,20 @@ async function mapOrm(userId, woName, mode, input) {
 
         //check
         if (!iseobj(input)) {
-            return Promise.reject('mix僅支援輸入ltdtDiffByKey結果物件')
+            return Promise.reject('invalid input of mix, need the result object of ltdtDiffByKey')
+        }
+
+        //check, 新增與修改之主鍵會被clearXSS改寫者, 於任何步驟寫入之前整批拒絕
+        let msgsIdXSS = []
+        for (let [key, msg] of [['add', 'failed to insert data'], ['diff', 'failed to update data']]) {
+            let fails = getItemsIdXSS(get(input, key, []))
+            if (size(fails) > 0) {
+                console.log(`${woName}.mix ${key} id changed by clearXSS`, fails)
+                msgsIdXSS.push(getMsgIdXSS(msg, fails))
+            }
+        }
+        if (size(msgsIdXSS) > 0) {
+            return Promise.reject(join(msgsIdXSS, '; '))
         }
 
         //rt,r
@@ -271,19 +349,19 @@ async function mapOrm(userId, woName, mode, input) {
 
             //adjustData
             try {
-                add = adjustData(woName, userId, add, 'insert+save')
+                add = adjustData(ds, woName, userId, add, 'insert+save')
             }
             catch (e) {
-                console.log(`adjustData catch`, e.toString())
-                err = '調整資料失敗'
+                console.log(`${woName}.adjustData catch`, e.toString())
+                err = 'failed to adjust data'
                 return Promise.reject(err)
             }
 
             //insert
             await wo.insert(add)
                 .catch((msg) => {
-                    console.log(`${woName}.save catch`, msg)
-                    err = '新增資料失敗'
+                    console.log(`${woName}.insert catch`, msg)
+                    err = 'failed to insert data'
                 })
 
             //check
@@ -304,8 +382,8 @@ async function mapOrm(userId, woName, mode, input) {
             //del
             let rs = await wo.del(del)
                 .catch((msg) => {
-                    console.log(`${woName}.save catch`, msg)
-                    err = '刪除資料失敗'
+                    console.log(`${woName}.del catch`, msg)
+                    err = 'failed to delete data'
                 })
 
             //check
@@ -317,7 +395,7 @@ async function mapOrm(userId, woName, mode, input) {
             let fails = getItemsFail(rs, del)
             if (size(fails) > 0) {
                 console.log(`${woName}.del fail`, fails)
-                msgsFail.push(getMsgFail('刪除資料失敗', fails))
+                msgsFail.push(getMsgFail('failed to delete data', fails))
             }
 
             //r
@@ -330,13 +408,16 @@ async function mapOrm(userId, woName, mode, input) {
         let diff = get(input, 'diff', [])
         if (size(diff) > 0) {
 
+            //diffOrig, 呼叫端原輸入, 逐筆失敗之訊息以呼叫端視角列出
+            let diffOrig = diff
+
             //adjustData
             try {
-                diff = adjustData(woName, userId, diff)
+                diff = adjustData(ds, woName, userId, diff)
             }
             catch (e) {
-                console.log(`adjustData catch`, e.toString())
-                err = '調整資料失敗'
+                console.log(`${woName}.adjustData catch`, e.toString())
+                err = 'failed to adjust data'
                 return Promise.reject(err)
             }
 
@@ -344,7 +425,7 @@ async function mapOrm(userId, woName, mode, input) {
             let rs = await wo.save(diff)
                 .catch((msg) => {
                     console.log(`${woName}.save catch`, msg)
-                    err = '變更資料失敗'
+                    err = 'failed to update data'
                 })
 
             //check
@@ -356,7 +437,7 @@ async function mapOrm(userId, woName, mode, input) {
             let fails = getItemsFail(rs, diff)
             if (size(fails) > 0) {
                 console.log(`${woName}.save fail`, fails)
-                msgsFail.push(getMsgFail('變更資料失敗', fails))
+                msgsFail.push(getMsgFail('failed to update data', getItemsFail(rs, diffOrig)))
             }
 
             //r
@@ -387,9 +468,10 @@ async function mapOrm(userId, woName, mode, input) {
 
 
 function getMapOrm(ds, woItems) {
-    _ds = ds
-    _woItems = woItems
-    return mapOrm
+    //每次呼叫各自綁定ds與woItems並回傳新函數, 令同一行程內之多個實例互不干擾; 回傳函數之參數形狀維持(userId, woName, mode, input)
+    return async (userId, woName, mode, input) => {
+        return mapOrm(ds, woItems, userId, woName, mode, input)
+    }
 }