w-serv-orm 1.1.7 → 1.1.8

package/test/unit-getDb.test.mjs

@@ -0,0 +1,188 @@
+import fs from 'fs'
+import path from 'path'
+import assert from 'assert'
+import { spawnSync } from 'child_process'
+import { pathToFileURL } from 'url'
+import getDb from '../src/getDb.mjs'
+import br from '../src/getDbBackupAndRecover.mjs'
+
+
+//會寫出備份檔之案例以子行程執行: getDb之輸出目錄於模組載入時取cwd, 子行程之cwd設於本案暫存夾, 不寫入repo根目錄
+let fd = path.resolve('./test/_tmp/unit-getDb')
+let urlGetDb = pathToFileURL(path.resolve('./src/getDb.mjs')).href
+
+function mkWoItems(log, behavior = {}) {
+    return {
+        tests: {
+            select: async () => {
+                if (behavior.select) {
+                    return behavior.select()
+                }
+                return [{ id: 'a' }]
+            },
+            insert: async (d) => {
+                log.push({ fn: 'insert', table: 'tests', d })
+                return { n: d.length, nInserted: d.length, ok: 1 }
+            },
+            createStorage: async () => {
+                log.push({ fn: 'createStorage', table: 'tests' })
+            },
+        },
+    }
+}
+
+async function getReject(pm) {
+    try {
+        await pm
+    }
+    catch (err) {
+        return err
+    }
+    throw new Error('預期reject但resolve')
+}
+
+async function quiet(fn) {
+    let logOrig = console.log
+    console.log = () => {}
+    try {
+        return await fn()
+    }
+    finally {
+        console.log = logOrig
+    }
+}
+
+function writeBackup(name, content) {
+    let fp = path.join(fd, name)
+    fs.writeFileSync(fp, content, 'utf8')
+    return fp
+}
+
+function runChild(name, code) {
+    let dir = path.join(fd, name)
+    fs.mkdirSync(dir, { recursive: true })
+    let fp = path.join(dir, 'run.mjs')
+    fs.writeFileSync(fp, code, 'utf8')
+    let r = spawnSync(process.execPath, [fp], { cwd: dir, encoding: 'utf8' })
+    let files = fs.readdirSync(dir).filter((v) => v.startsWith('backup-'))
+    return { status: r.status, stdout: r.stdout, stderr: r.stderr, dir, files }
+}
+
+
+describe('getDb備份與還原', function() {
+
+    before(function() {
+        fs.rmSync(fd, { recursive: true, force: true })
+        fs.mkdirSync(fd, { recursive: true })
+    })
+
+    after(function() {
+        fs.rmSync(fd, { recursive: true, force: true })
+    })
+
+    it('B01 backup之select失敗即reject', async function() {
+        //D5: 印log後reject原錯誤
+        let woItems = mkWoItems([], { select: () => Promise.reject(new Error('E-select')) })
+        let err = await quiet(() => getReject(getDb.backup(woItems, { bLog: false })))
+        assert.ok(String(err).includes('E-select'))
+    })
+
+    it('B02 recover之備份檔不存在即reject', async function() {
+        //D5
+        let err = await quiet(() => getReject(getDb.recover(mkWoItems([]), path.join(fd, 'none.json'), { bLog: false })))
+        assert.ok(String(err).includes('fp is not exist'))
+    })
+
+    it('B03 recover之備份內容無效即reject且不寫入', async function() {
+        //P4-2: 空檔、壞JSON、空陣列、缺name皆拒絕, 不假成功
+        for (let [name, content] of [['empty.json', ''], ['bad.json', '{bad'], ['arr0.json', '[]'], ['noname.json', '[{"x":1}]']]) {
+            let log = []
+            let err = await quiet(() => getReject(getDb.recover(mkWoItems(log), writeBackup(name, content), { bLog: false })))
+            assert.ok(String(err).includes('invalid backup'), `${name}: ${err}`)
+            assert.strict.deepEqual(log, [])
+        }
+    })
+
+    it('B04 recover之備份含woItems沒有之資料表即於寫入前reject', async function() {
+        //P4-2: 先驗全部再寫入, 不留部分還原
+        let log = []
+        let fp = writeBackup('unknown.json', JSON.stringify([{ name: 'tests', data: [{ id: 'a' }] }, { name: 'nope', data: [{ id: 'b' }] }]))
+        let err = await quiet(() => getReject(getDb.recover(mkWoItems(log), fp, { bLog: false })))
+        assert.ok(String(err).includes('nope'))
+        assert.strict.deepEqual(log, [])
+    })
+
+    it('B05 recover成功', async function() {
+        //D5: 成功路徑不變
+        let log = []
+        let fp = writeBackup('ok.json', JSON.stringify([{ name: 'tests', data: [{ id: 'a' }] }]))
+        await quiet(() => getDb.recover(mkWoItems(log), fp, { bLog: false }))
+        assert.strict.deepEqual(log, [{ fn: 'insert', table: 'tests', d: [{ id: 'a' }] }])
+    })
+
+    it('B06 recover之bRela缺ds或genModelsByTabs即於寫入前reject', async function() {
+        //P4-1: 明確訊息, 不寫入
+        let log = []
+        let fp = writeBackup('rela.json', JSON.stringify([{ name: 'tests', data: [{ id: 'a' }] }]))
+        let err = await quiet(() => getReject(getDb.recover(mkWoItems(log), fp, { bRela: true, bLog: false })))
+        assert.ok(String(err).includes('genModelsByTabs'))
+        assert.strict.deepEqual(log, [])
+    })
+
+    it('B07 recover之bRela帶ds與genModelsByTabs可產生model並建表寫入', async function() {
+        //P4-1: genModelsByTabs收到各表settings, 之後建表並寫入
+        let log = []
+        let calls = []
+        let ds = { tests: { keys: ['id'], settings: { id: { pk: true, type: 'STRING' } } } }
+        let genModelsByTabs = (fdModels, tabs) => {
+            calls.push({ fdModels, tabs })
+        }
+        let fp = writeBackup('rela2.json', JSON.stringify([{ name: 'tests', data: [{ id: 'a' }] }]))
+        await quiet(() => getDb.recover(mkWoItems(log), fp, { bRela: true, ds, genModelsByTabs, fdModels: './test/_tmp/unit-getDb/models', bLog: false }))
+        assert.strict.equal(calls.length, 1)
+        assert.strict.deepEqual(calls[0].tabs, { tests: ds.tests.settings })
+        assert.strict.deepEqual(log.map((v) => v.fn), ['createStorage', 'insert'])
+    })
+
+    it('B08 低階recover之備份內容無效即reject', async function() {
+        //P4-2: WServOrm實例上之recover即此低階函數
+        let fp = writeBackup('bad2.json', '{bad')
+        let err = await getReject(br.recover(fp, mkWoItems([])))
+        assert.ok(String(err).includes('invalid backup'))
+    })
+
+    it('B12 backup之woItems無效即reject且為Error', async function() {
+        //錯誤型別: 工具函數一律拋Error(原由pmSeries以字串reject); 空物件與空陣列原會產出recover拒收之空備份, 一併拒絕
+        for (let bad of [null, undefined, 'x', 1, [], {}]) {
+            let err = await quiet(() => getReject(br.backup(bad)))
+            assert.ok(err instanceof Error && err.message === 'invalid woItems', `低階 ${String(bad)}: ${err}`)
+            err = await quiet(() => getReject(getDb.backup(bad, { bLog: false })))
+            assert.ok(err instanceof Error && err.message === 'invalid woItems', `getDb ${String(bad)}: ${err}`)
+        }
+    })
+
+    it('B09 backup成功寫出備份檔(子行程)', async function() {
+        //D5: 成功路徑不變
+        let r = runChild('bk-ok', `import getDb from '${urlGetDb}'\nlet woItems = { tests: { select: async () => [{ id: 'a' }] } }\nawait getDb.backup(woItems, { bLog: false })\nconsole.log('RESOLVED')\n`)
+        assert.strict.equal(r.status, 0, r.stderr)
+        assert.ok(r.stdout.includes('RESOLVED'))
+        assert.strict.equal(r.files.length, 1)
+        let j = JSON.parse(fs.readFileSync(path.join(r.dir, r.files[0]), 'utf8'))
+        assert.strict.deepEqual(j, [{ name: 'tests', data: [{ id: 'a' }] }])
+    })
+
+    it('B10 仿g_backupDb未await呼叫而失敗時離開碼非零(子行程)', async function() {
+        //D5: 使用端之頂層呼叫未await, 失敗成為未處理之rejection
+        let r = runChild('bk-fail', `import getDb from '${urlGetDb}'\nlet woItems = { tests: { select: async () => { throw new Error('E-select') } } }\ngetDb.backup(woItems)\n`)
+        assert.notStrictEqual(r.status, 0)
+        assert.strict.equal(r.files.length, 0)
+    })
+
+    it('B11 backup資料無法序列化即reject且不寫出空檔(子行程)', async function() {
+        //D5: o2j失敗回空字串, 不得寫出空備份而回報成功
+        let r = runChild('bk-circular', `import getDb from '${urlGetDb}'\nlet a = { id: 'a' }\na.self = a\nlet woItems = { tests: { select: async () => [a] } }\nlet out = 'RESOLVED'\nawait getDb.backup(woItems, { bLog: false }).catch(() => { out = 'REJECTED' })\nconsole.log(out)\n`)
+        assert.ok(r.stdout.includes('REJECTED'), r.stdout + r.stderr)
+        assert.strict.equal(r.files.length, 0)
+    })
+
+})

package/test/unit-mapOrm.test.mjs

@@ -1,6 +1,7 @@
 import assert from 'assert'
 import WServOrm from '../src/WServOrm.mjs'
 import genTestData from '../src/genTestData.mjs'
+import dsSchema from '../schema/index.mjs'
 
 
 //替身ORM, 回傳形狀依w-orm系列規格(資料庫函數回傳定義計算.md T2、T4):
@@ -66,28 +67,28 @@ describe('mapOrm逐筆失敗', function() {
         //R01: 逐筆ok為0即reject, 訊息帶失敗筆之主鍵, 不含成功筆
         plan.save = () => [okSave, { n: 1, nInserted: 0, nModified: 0, ok: 0, err: 'E-save' }]
         let err = await getReject(proc('save', [{ id: 's1' }, { id: 's2' }]))
-        assert.strict.equal(err, '儲存資料失敗: id[s2]')
+        assert.strict.equal(err, 'failed to save data: id[s2]')
     })
 
     it('U04 save物件ok為0', async function() {
         //R01: 輸入為單一物件時ORM回傳長度為1之陣列, 仍須檢出
         plan.save = () => [{ n: 1, nInserted: 0, nModified: 0, ok: 0, err: 'E-save' }]
         let err = await getReject(proc('save', { id: 's1' }))
-        assert.strict.equal(err, '儲存資料失敗: id[s1]')
+        assert.strict.equal(err, 'failed to save data: id[s1]')
     })
 
     it('U05 save未帶主鍵之筆ok為0且無err', async function() {
         //R01: 無有效主鍵者以輸入位置標示; R07: ok為0而無err(舊版ORM)仍判失敗
         plan.save = () => [okSave, { n: 1, ok: 0 }]
         let err = await getReject(proc('save', [{ id: 's1' }, { name: 'no-id' }]))
-        assert.strict.equal(err, '儲存資料失敗: 第2筆')
+        assert.strict.equal(err, 'failed to save data: data[1]')
     })
 
     it('U06 save整批reject', async function() {
         //R05: 整批性錯誤之訊息不變
         plan.save = () => Promise.reject(new Error('E-batch'))
         let err = await getReject(proc('save', [{ id: 's1' }]))
-        assert.strict.equal(err, '儲存資料失敗')
+        assert.strict.equal(err, 'failed to save data')
     })
 
     it('U07 save之ORM回傳非陣列', async function() {
@@ -106,7 +107,7 @@ describe('mapOrm逐筆失敗', function() {
         plan.save = (data) => data.map(() => ({ n: 1, nInserted: 0, nModified: 0, ok: 0, err: 'E-full' }))
         let err = await getReject(proc('save', input))
         let ids = input.slice(0, 10).map((v) => `id[${v.id}]`).join(', ')
-        assert.strict.equal(err, `儲存資料失敗: ${ids}等共12筆`)
+        assert.strict.equal(err, `failed to save data: ${ids}, ... (12 in total)`)
     })
 
     it('U09 del全部成功含主鍵未命中', async function() {
@@ -121,21 +122,21 @@ describe('mapOrm逐筆失敗', function() {
         //R02: del逐筆ok為0即reject; 數字主鍵照列
         plan.del = () => [okDel, { n: 0, nDeleted: 0, ok: 0, err: 'can not delete by invalid id[123]' }]
         let err = await getReject(proc('del', [{ id: 'd1' }, { id: 123 }]))
-        assert.strict.equal(err, '刪除資料失敗: id[123]')
+        assert.strict.equal(err, 'failed to delete data: id[123]')
     })
 
     it('U10b del物件輸入ok為0且無err', async function() {
         //R02: 物件輸入亦須檢出; R07: ok為0而無err仍判失敗
         plan.del = () => [{ n: 1, nDeleted: 0, ok: 0 }]
         let err = await getReject(proc('del', { id: 'd1' }))
-        assert.strict.equal(err, '刪除資料失敗: id[d1]')
+        assert.strict.equal(err, 'failed to delete data: id[d1]')
     })
 
     it('U11 del整批reject', async function() {
         //R05: 整批性錯誤之訊息不變
         plan.del = () => Promise.reject(new Error('E-batch'))
         let err = await getReject(proc('del', [{ id: 'd1' }]))
-        assert.strict.equal(err, '刪除資料失敗')
+        assert.strict.equal(err, 'failed to delete data')
     })
 
     it('U12 del之ORM回傳非陣列', async function() {
@@ -161,7 +162,7 @@ describe('mapOrm逐筆失敗', function() {
         plan.del = () => [okDel, { n: 0, nDeleted: 0, ok: 0, err: 'E-del' }]
         plan.save = () => [{ n: 1, nInserted: 0, nModified: 0, ok: 0, err: 'E-save' }]
         let err = await getReject(proc('mix', { add: [{ id: 'a1' }], del: [{ id: 'd1' }, { id: 'd2' }], diff: [{ id: 'f1' }] }))
-        assert.strict.equal(err, '刪除資料失敗: id[d2]; 變更資料失敗: id[f1]')
+        assert.strict.equal(err, 'failed to delete data: id[d2]; failed to update data: id[f1]')
         assert.strict.deepEqual(calls.map((v) => v.fn), ['insert', 'del', 'save'])
     })
 
@@ -170,7 +171,7 @@ describe('mapOrm逐筆失敗', function() {
         plan.del = () => [{ n: 0, nDeleted: 0, ok: 0, err: 'E-del' }]
         plan.save = (data) => data.map(() => okSave)
         let err = await getReject(proc('mix', { del: [{ id: 'd1' }], diff: [{ id: 'f1' }] }))
-        assert.strict.equal(err, '刪除資料失敗: id[d1]')
+        assert.strict.equal(err, 'failed to delete data: id[d1]')
         assert.strict.deepEqual(calls.map((v) => v.fn), ['del', 'save'])
     })
 
@@ -179,7 +180,7 @@ describe('mapOrm逐筆失敗', function() {
         plan.del = () => Promise.reject(new Error('E-batch'))
         plan.save = (data) => data.map(() => okSave)
         let err = await getReject(proc('mix', { del: [{ id: 'd1' }], diff: [{ id: 'f1' }] }))
-        assert.strict.equal(err, '刪除資料失敗')
+        assert.strict.equal(err, 'failed to delete data')
         assert.strict.deepEqual(calls.map((v) => v.fn), ['del'])
     })
 
@@ -188,7 +189,7 @@ describe('mapOrm逐筆失敗', function() {
         plan.insert = () => Promise.reject(new Error('E-batch'))
         plan.del = (data) => data.map(() => okDel)
         let err = await getReject(proc('mix', { add: [{ id: 'a1' }], del: [{ id: 'd1' }] }))
-        assert.strict.equal(err, '新增資料失敗')
+        assert.strict.equal(err, 'failed to insert data')
         assert.strict.deepEqual(calls.map((v) => v.fn), ['insert'])
     })
 
@@ -197,7 +198,7 @@ describe('mapOrm逐筆失敗', function() {
         plan.del = () => [{ n: 0, nDeleted: 0, ok: 0, err: 'E-del' }]
         plan.save = () => Promise.reject(new Error('E-batch'))
         let err = await getReject(proc('mix', { del: [{ id: 'd1' }], diff: [{ id: 'f1' }] }))
-        assert.strict.equal(err, '變更資料失敗')
+        assert.strict.equal(err, 'failed to update data')
     })
 
     it('U19 insert成功', async function() {
@@ -229,6 +230,88 @@ describe('mapOrm逐筆失敗', function() {
 })
 
 
+describe('mapOrm主鍵與clearXSS', function() {
+
+    let so = WServOrm(ds, WOrmStub, 'stub-url', 'stub-db', { useCheckUser: false, useExcludeWhenNotAdmin: false })
+    let proc = (mode, input) => so.procOrm('u1', 'tests', mode, input)
+
+    beforeEach(function() {
+        plan = {}
+        calls = []
+    })
+
+    it('X01 數學式之主鍵與欄位原樣寫入並回傳', async function() {
+        //wsemi 1.9.13起clearXSS只轉義會開始標籤之<, 數學式不改寫, 主鍵不被拒絕且與寫入者一致
+        plan.save = (data) => data.map(() => okSave)
+        let r = await proc('save', [{ id: 'a < b', name: '溫度 > 30°C' }, { id: '1 > 0', name: 'x <= 5' }])
+        assert.strict.deepEqual(r, [{ id: 'a < b' }, { id: '1 > 0' }])
+        assert.strict.deepEqual(calls[0].data.map((v) => [v.id, v.name]), [['a < b', '溫度 > 30°C'], ['1 > 0', 'x <= 5']])
+    })
+
+    it('X02 save之主鍵會被改寫即整批reject且不呼叫ORM', async function() {
+        //改寫後之主鍵與呼叫端所持者不同而查不到, 整批拒絕; 訊息只列位置不回顯主鍵; 結尾之<亦會被轉義
+        plan.save = (data) => data.map(() => okSave)
+        let err = await getReject(proc('save', [{ id: 's1' }, { id: 'a<b' }, { id: 'x <' }]))
+        assert.strict.equal(err, 'failed to save data, id contains HTML markup: data[1], data[2]')
+        assert.strict.deepEqual(calls, [])
+    })
+
+    it('X03 insert物件之主鍵會被改寫即reject且不呼叫ORM', async function() {
+        plan.insert = (data) => ({ n: data.length, nInserted: data.length, ok: 1 })
+        let err = await getReject(proc('insert', { id: '<script>x' }))
+        assert.strict.equal(err, 'failed to insert data, id contains HTML markup: data[0]')
+        assert.strict.deepEqual(calls, [])
+    })
+
+    it('X04 mix之新增或修改之主鍵會被改寫即於任何步驟之前reject', async function() {
+        //mix依add、del、diff執行, 預檢於任何步驟寫入之前, 故一筆都不寫入
+        plan.insert = (data) => ({ n: data.length, nInserted: data.length, ok: 1 })
+        plan.del = (data) => data.map(() => okDel)
+        plan.save = (data) => data.map(() => okSave)
+        let err = await getReject(proc('mix', { add: [{ id: 'a1' }, { id: 'a<b' }], del: [{ id: 'd1' }], diff: [{ id: '</x>' }] }))
+        assert.strict.equal(err, 'failed to insert data, id contains HTML markup: data[1]; failed to update data, id contains HTML markup: data[0]')
+        assert.strict.deepEqual(calls, [])
+        err = await getReject(proc('mix', { del: [{ id: 'd1' }], diff: [{ id: 'f1' }, { id: '<!--x-->' }] }))
+        assert.strict.equal(err, 'failed to update data, id contains HTML markup: data[1]')
+        assert.strict.deepEqual(calls, [])
+    })
+
+    it('X05 數字主鍵、未帶主鍵與不被改寫之主鍵照常寫入', async function() {
+        //判準為是否被改寫: 數字不經清除, 未帶主鍵者由本套件補值, 白名單標籤之規範寫法不被改寫
+        plan.save = (data) => data.map(() => okSave)
+        let r = await proc('save', [{ id: 5 }, { id: '<b>粗體</b>' }, { name: 'no-id' }])
+        assert.strict.equal(r[0].id, 5)
+        assert.strict.equal(r[1].id, '<b>粗體</b>')
+        assert.ok(typeof r[2].id === 'string' && r[2].id.length > 0)
+    })
+
+    it('X06 select與del不經clearXSS, 主鍵原樣交ORM', async function() {
+        //此不對稱即主鍵會被改寫者須於寫入前拒絕之原因
+        plan.select = () => []
+        plan.del = (data) => data.map(() => ({ n: 0, nDeleted: 0, ok: 1 }))
+        await proc('select', { id: 'a<b' })
+        await proc('del', [{ id: 'a<b' }])
+        assert.strict.deepEqual(calls.map((v) => v.data), [{ id: 'a<b' }, [{ id: 'a<b' }]])
+    })
+
+    it('X07 insert與mix各入口之其餘主鍵狀態', async function() {
+        //數字與不被改寫之主鍵照寫, mix之修改未帶主鍵者補值, mix之刪除不經clearXSS而原樣交ORM
+        plan.insert = (data) => ({ n: data.length, nInserted: data.length, ok: 1 })
+        plan.del = (data) => data.map(() => okDel)
+        plan.save = (data) => data.map(() => okSave)
+        let r1 = await proc('insert', [{ id: 7 }, { id: 'a < b' }])
+        assert.strict.deepEqual(r1, [{ id: 7 }, { id: 'a < b' }])
+        let r2 = await proc('mix', { add: [{ id: 8 }, { id: '1 > 0' }], del: [{ id: 'a<b' }], diff: [{ id: 9 }, { id: 'x <= 5' }, { name: 'no-id' }] })
+        assert.strict.deepEqual(r2.slice(0, 5), [{ id: 8 }, { id: '1 > 0' }, { id: 'a<b' }, { id: 9 }, { id: 'x <= 5' }])
+        assert.ok(typeof r2[5].id === 'string' && r2[5].id.length > 0)
+        assert.strict.deepEqual(calls.map((v) => v.fn), ['insert', 'insert', 'del', 'save'])
+        assert.strict.deepEqual(calls[2].data, [{ id: 'a<b' }])
+        assert.strict.equal(calls[3].data[2].id, r2[5].id)
+    })
+
+})
+
+
 describe('genTestData逐筆失敗', function() {
 
     let dsGen = {
@@ -265,4 +348,26 @@ describe('genTestData逐筆失敗', function() {
         assert.ok(String(err).includes('g2'))
     })
 
+    it('U23 funTestAndSave與funTest之逐筆失敗訊息相同', async function() {
+        //R09: funTestAndSave由w-data-collector之build產生(schema/index.mjs)且其錯誤原樣轉出; w-data-collector 1.0.46起兩種模式之訊息同為英文同格式
+        let woItems = {
+            tests: {
+                save: async (rs) => rs.map((v, k) => (k === 1 ? { n: 1, nInserted: 0, nModified: 0, ok: 0, err: 'E-gen' } : okSave)),
+            },
+        }
+        let logOrig = console.log
+        console.log = () => {}
+        let errs = []
+        try {
+            for (let mode of ['funTestAndSave', 'funTest']) {
+                errs.push(await getReject(genTestData(dsSchema, woItems, { mode, bLog: false })))
+            }
+        }
+        finally {
+            console.log = logOrig
+        }
+        let msg = 'failed to write test data into table[tests]: [{"k":1,"id":"id-for-tests-2","err":"E-gen"}]'
+        assert.strict.deepEqual(errs.map((e) => e.message), [msg, msg])
+    })
+
 })