w-orm-mongodb 1.1.40 → 1.1.41

package/src/WOrmMongodb.mjs

@@ -1,4 +1,3 @@
-import events from 'events'
 import mongodb from 'mongodb'
 import stream from 'stream'
 import cloneDeep from 'lodash-es/cloneDeep.js'
@@ -7,6 +6,7 @@ import get from 'lodash-es/get.js'
 import map from 'lodash-es/map.js'
 import omit from 'lodash-es/omit.js'
 import size from 'lodash-es/size.js'
+import evem from 'wsemi/src/evem.mjs'
 import genPm from 'wsemi/src/genPm.mjs'
 import genID from 'wsemi/src/genID.mjs'
 import isbol from 'wsemi/src/isbol.mjs'
@@ -63,8 +63,9 @@ function WOrmMongodb(opt = {}) {
     let _indexGfsReady = false
 
 
-    //ee
-    let ee = new events.EventEmitter()
+    //ee, 採wsemi之evem(即eventemitter3), 其於'error'無監聽者時僅回傳false而不拋出,
+    //故本套件之操作行為不因呼叫端有無註冊監聽而改變; Node內建之EventEmitter具該拋出語義, 不可用
+    let ee = evem()
 
 
     //MongoClient
@@ -78,7 +79,7 @@ function WOrmMongodb(opt = {}) {
      * @param {Error|String} err 輸入錯誤物件或字串
      * @returns {String} 回傳錯誤訊息字串
      */
-    function genErrMsg(err) {
+    function getErrMsg(err) {
 
         //message
         let message = get(err, 'message')
@@ -109,6 +110,28 @@ function WOrmMongodb(opt = {}) {
     }
 
 
+    /**
+     * 發出error事件，操作發生錯誤時發出，錯誤訊息一律轉為字串
+     * 註: 事件僅為附加通知，所送出之資訊必另有正規管道——整批性錯誤經Promise.reject，逐筆失敗經該筆之err欄位
+     * 註: 訂閱函數拋錯不得影響本次操作之結果，故另包try並自行吞掉
+     * 註: 正常結果不得發出本事件，如insert全數已存在、save合併後內容相同、del主鍵未命中、selectByPk查無數據
+     *
+     * @ignore
+     * @param {String} mode 輸入操作別字串
+     * @param {Array|null} data 輸入本次操作之數據
+     * @param {Error|String} err 輸入錯誤物件或字串
+     * @returns {undefined} 無回傳值
+     */
+    function emitError(mode, data, err) {
+        try {
+            ee.emit('error', mode, data, getErrMsg(err))
+        }
+        catch (errEmit) {
+            console.log(errEmit)
+        }
+    }
+
+
     /**
      * 檢查並補齊單筆數據之主鍵
      * autoGenPk為true時未帶有效id者自動產生，為false時往外拋
@@ -310,7 +333,12 @@ function WOrmMongodb(opt = {}) {
             client = null
         }
 
+        //check
         if (isErr) {
+
+            //emit, 整批性錯誤須於reject之前發出
+            emitError('select', null, res)
+
             return Promise.reject(res)
         }
         return res
@@ -368,7 +396,12 @@ function WOrmMongodb(opt = {}) {
             client = null
         }
 
+        //check
         if (isErr) {
+
+            //emit, 整批性錯誤須於reject之前發出
+            emitError('selectByPk', null, res)
+
             return Promise.reject(res)
         }
         return res
@@ -469,7 +502,12 @@ function WOrmMongodb(opt = {}) {
             emitChange('insert', data, res)
         }
 
+        //check
         if (isErr) {
+
+            //emit, 整批性錯誤須於reject之前發出
+            emitError('insert', data, res)
+
             return Promise.reject(res)
         }
         return res
@@ -574,7 +612,7 @@ function WOrmMongodb(opt = {}) {
                     nInserted: 0,
                     nModified: 0,
                     ok: 0,
-                    err: genErrMsg(err),
+                    err: getErrMsg(err),
                 }
 
                 break
@@ -587,6 +625,11 @@ function WOrmMongodb(opt = {}) {
             emitChange('insert', [v], rest)
         }
 
+        //emit, 逐筆失敗須於該筆結果定案後發出, 每筆一次
+        if (rest.ok === 0) {
+            emitError('save', [v], rest.err)
+        }
+
         return rest
     }
 
@@ -662,7 +705,12 @@ function WOrmMongodb(opt = {}) {
             emitChange('save', data, res)
         }
 
+        //check
         if (isErr) {
+
+            //emit, 整批性錯誤須於reject之前發出
+            emitError('save', data, res)
+
             return Promise.reject(res)
         }
         return res
@@ -714,49 +762,60 @@ function WOrmMongodb(opt = {}) {
                 //id, del不補值, 未帶有效id者視為本筆無法處理
                 let id = get(v, 'id')
 
+                //rest
+                let rest = null
+
                 //check, 不得將無效id送進查詢條件, 因undefined經序列化為null會誤中id為null之數據
                 if (!isestr(id)) {
-                    return {
+
+                    //rest
+                    rest = {
                         n: 0,
                         nDeleted: 0,
                         ok: 0,
                         err: `invalid id[${id}]`,
                     }
+
                 }
+                else {
 
-                //rest
-                let rest = null
+                    try {
 
-                try {
+                        //deleteOne
+                        let r = await collection.deleteOne({ id })
 
-                    //deleteOne
-                    let r = await collection.deleteOne({ id })
+                        //nDeleted
+                        let nDeleted = get(r, 'deletedCount', 0)
 
-                    //nDeleted
-                    let nDeleted = get(r, 'deletedCount', 0)
+                        //rest, 未命中時nDeleted為0, 屬正常結果
+                        rest = {
+                            n: nDeleted,
+                            nDeleted,
+                            ok: 1,
+                        }
 
-                    //rest, 未命中時nDeleted為0, 屬正常結果
-                    rest = {
-                        n: nDeleted,
-                        nDeleted,
-                        ok: 1,
                     }
+                    catch (err) {
 
-                }
-                catch (err) {
+                        //本筆失敗不中斷整批
 
-                    //本筆失敗不中斷整批
+                        //rest
+                        rest = {
+                            n: 1,
+                            nDeleted: 0,
+                            ok: 0,
+                            err: getErrMsg(err),
+                        }
 
-                    //rest
-                    rest = {
-                        n: 1,
-                        nDeleted: 0,
-                        ok: 0,
-                        err: genErrMsg(err),
                     }
 
                 }
 
+                //emit, 逐筆失敗須於該筆結果定案後發出, 每筆一次
+                if (rest.ok === 0) {
+                    emitError('del', [v], rest.err)
+                }
+
                 return rest
             })
 
@@ -775,7 +834,12 @@ function WOrmMongodb(opt = {}) {
             emitChange('del', data, res)
         }
 
+        //check
         if (isErr) {
+
+            //emit, 整批性錯誤須於reject之前發出
+            emitError('del', data, res)
+
             return Promise.reject(res)
         }
         return res
@@ -832,7 +896,12 @@ function WOrmMongodb(opt = {}) {
             emitChange('delAll', null, res)
         }
 
+        //check
         if (isErr) {
+
+            //emit, 整批性錯誤須於reject之前發出
+            emitError('delAll', null, res)
+
             return Promise.reject(res)
         }
         return res
@@ -937,7 +1006,12 @@ function WOrmMongodb(opt = {}) {
             emitChange('insertGfs', data, res)
         }
 
+        //check
         if (isErr) {
+
+            //emit, 整批性錯誤須於reject之前發出
+            emitError('insertGfs', data, res)
+
             return Promise.reject(res)
         }
         return res
@@ -1042,13 +1116,19 @@ function WOrmMongodb(opt = {}) {
             client = null
         }
 
+        //check, 查無檔案已於catch內判定為正常結果而未設isErr, 故不會誤發error事件
         if (isErr) {
+
+            //emit, 整批性錯誤須於reject之前發出
+            emitError('selectByPkGfs', null, res)
+
             return Promise.reject(res)
         }
         return res
     }
 
 
+    //_findGfs, 內部查找函數, 其reject由delGfs與delAllGfs之catch接住並於該處發出error事件, 故本函數不自行發出
     async function _findGfs(find = {}, bucket) {
         let isErr = false
 
@@ -1122,54 +1202,65 @@ function WOrmMongodb(opt = {}) {
                 //id, delGfs不補值, 未帶有效id者視為本筆無法處理
                 let id = get(v, 'id')
 
+                //rest
+                let rest = null
+
                 //check, 判定基準與del一致
                 if (!isestr(id)) {
-                    return {
+
+                    //rest
+                    rest = {
                         n: 0,
                         nDeleted: 0,
                         ok: 0,
                         err: `invalid id[${id}]`,
                     }
+
                 }
+                else {
 
-                //rest
-                let rest = null
+                    try {
 
-                try {
+                        //_findGfs
+                        let ltdt = await _findGfs({ filename: id }, bucket)
 
-                    //_findGfs
-                    let ltdt = await _findGfs({ filename: id }, bucket)
+                        //delete, 建立唯一索引後同一id至多一筆,
+                        //既有數據若尚存重複id則一併刪除並如實回報nDeleted
+                        let nDeleted = 0
+                        for (let vv of ltdt) {
+                            await bucket.delete(vv._id)
+                            nDeleted++
+                        }
 
-                    //delete, 建立唯一索引後同一id至多一筆,
-                    //既有數據若尚存重複id則一併刪除並如實回報nDeleted
-                    let nDeleted = 0
-                    for (let vv of ltdt) {
-                        await bucket.delete(vv._id)
-                        nDeleted++
-                    }
+                        //rest, n為命中與否, 未命中時兩者皆為0且屬正常結果
+                        rest = {
+                            n: nDeleted > 0 ? 1 : 0,
+                            nDeleted,
+                            ok: 1,
+                        }
 
-                    //rest, n為命中與否, 未命中時兩者皆為0且屬正常結果
-                    rest = {
-                        n: nDeleted > 0 ? 1 : 0,
-                        nDeleted,
-                        ok: 1,
                     }
+                    catch (err) {
 
-                }
-                catch (err) {
+                        //本筆失敗不中斷整批
 
-                    //本筆失敗不中斷整批
+                        //rest
+                        rest = {
+                            n: 1,
+                            nDeleted: 0,
+                            ok: 0,
+                            err: getErrMsg(err),
+                        }
 
-                    //rest
-                    rest = {
-                        n: 1,
-                        nDeleted: 0,
-                        ok: 0,
-                        err: genErrMsg(err),
                     }
 
                 }
 
+                //emit, 逐筆失敗須於該筆結果定案後發出, 每筆一次
+                if (rest.ok === 0) {
+                    emitError('delGfs', [v], rest.err)
+                }
+
                 return rest
             })
 
@@ -1188,7 +1279,12 @@ function WOrmMongodb(opt = {}) {
             emitChange('delGfs', data, res)
         }
 
+        //check
         if (isErr) {
+
+            //emit, 整批性錯誤須於reject之前發出
+            emitError('delGfs', data, res)
+
             return Promise.reject(res)
         }
         return res
@@ -1268,7 +1364,12 @@ function WOrmMongodb(opt = {}) {
             emitChange('delAllGfs', null, res)
         }
 
+        //check
         if (isErr) {
+
+            //emit, 整批性錯誤須於reject之前發出
+            emitError('delAllGfs', null, res)
+
             return Promise.reject(res)
         }
         return res

package/test/api-basic.test.mjs

@@ -1087,6 +1087,251 @@ describe('delAll', function() {
 })
 
 
+describe('error event', function() {
+    let vans = {}
+    let vget = {}
+
+    before(async function() {
+        this.timeout(120000)
+
+        //collect, 收集事件
+        let collect = (wo) => {
+            let evs = []
+            wo.on('error', function(mode, data, err) {
+                evs.push({ mode, data, err })
+            })
+            return evs
+        }
+
+        //整批性錯誤須於reject前發出, 且err與reject訊息一致
+        let woB = WOrm(genOptPk('everrbatch', false))
+        await woB.delAll()
+        let evsB = collect(woB)
+        let msgB = null
+        await woB.insert({ name: 'no-id' }).catch((err) => {
+            msgB = err.toString()
+        })
+        vget[1] = evsB.length
+        vget[2] = evsB[0].mode
+        vget[3] = typeof evsB[0].err
+        vget[4] = msgB.indexOf(evsB[0].err) >= 0
+
+        //save之整批性錯誤
+        evsB.length = 0
+        await woB.save({ name: 'no-id' }).catch(() => {})
+        vget[5] = evsB.map((v) => v.mode)
+
+        //逐筆失敗須於該筆定案後發出, 每筆一次, err與該筆err欄位一致
+        let woS = WOrm(genOpt('everrsave'))
+        await woS.delAll()
+        await woS.insert([{ id: 'f1' }, { id: 'f2' }, { id: 'f3' }])
+        let evsS = collect(woS)
+        let rs = await woS.save([
+            { id: 'f1', name: 'ok1' },
+            { id: 'f2', $bad: 1 },
+            { id: 'f3', name: 'ok3' },
+        ])
+        vget[6] = evsS.length
+        vget[7] = evsS[0].mode
+        vget[8] = evsS[0].err === rs[1].err
+
+        //del之逐筆失敗, 未帶有效id者亦須發出
+        let woD = WOrm(genOpt('everrdel'))
+        await woD.delAll()
+        await woD.insert({ id: 'd1' })
+        let evsD = collect(woD)
+        let rd = await woD.del([{ id: 'd1' }, { name: 'no-id' }])
+        vget[9] = evsD.length
+        vget[10] = evsD[0].mode
+        vget[11] = evsD[0].err === rd[1].err
+
+        //正常結果不得發出error
+        let woN = WOrm(genOpt('everrnormal'))
+        await woN.delAll()
+        let evsN = collect(woN)
+        await woN.insert({ id: 'n1', name: 'a' })
+        await woN.insert({ id: 'n1', name: 'a' }) //全數已存在
+        await woN.save({ id: 'n1', name: 'a' }) //合併後內容相同
+        await woN.del({ id: 'n-not-existed' }) //主鍵未命中
+        await woN.delAll({ name: 'not-existed' }) //條件無命中
+        await woN.selectByPk('n-not-existed') //查無數據
+        await woN.selectByPk('') //主鍵值無效
+        await woN.select({ name: 'not-existed' }) //無符合數據
+        vget[12] = evsN.length
+
+        //同批既有逐筆失敗又整批resolve時, 逐筆error先於整批change
+        let woO = WOrm(genOpt('everrorder'))
+        await woO.delAll()
+        await woO.insert([{ id: 'o1' }, { id: 'o2' }])
+        let seq = []
+        woO.on('error', function(mode) {
+            seq.push(`error:${mode}`)
+        })
+        woO.on('change', function(mode) {
+            seq.push(`change:${mode}`)
+        })
+        await woO.save([{ id: 'o1', name: 'ok' }, { id: 'o2', $bad: 1 }])
+        vget[13] = seq
+
+        //訂閱函數拋錯不得影響本次操作之結果
+        let woT = WOrm(genOpt('everrthrow'))
+        await woT.delAll()
+        woT.on('error', function() {
+            throw new Error('訂閱者拋錯')
+        })
+        await woT.insert({ id: 't1' })
+        vget[14] = await woT.del([{ id: 't1' }, { name: 'no-id' }])
+
+    })
+
+    vans[1] = 1
+    it(`should get ${JSON.stringify(vans[1])} for count of error event in batch error`, async function() {
+        assert.strict.deepStrictEqual(vget[1], vans[1])
+    })
+
+    vans[2] = 'insert'
+    it(`should get ${JSON.stringify(vans[2])} for mode of error event in batch error`, async function() {
+        assert.strict.deepStrictEqual(vget[2], vans[2])
+    })
+
+    vans[3] = 'string'
+    it(`should get ${JSON.stringify(vans[3])} for type of err in error event`, async function() {
+        assert.strict.deepStrictEqual(vget[3], vans[3])
+    })
+
+    vans[4] = true
+    it(`should get ${JSON.stringify(vans[4])} for same err between error event and reject`, async function() {
+        assert.strict.deepStrictEqual(vget[4], vans[4])
+    })
+
+    vans[5] = ['save']
+    it(`should get ${JSON.stringify(vans[5])} for mode of error event in save batch error`, async function() {
+        assert.strict.deepStrictEqual(vget[5], vans[5])
+    })
+
+    vans[6] = 1
+    it(`should get ${JSON.stringify(vans[6])} for count of error event in save single failure`, async function() {
+        assert.strict.deepStrictEqual(vget[6], vans[6])
+    })
+
+    vans[7] = 'save'
+    it(`should get ${JSON.stringify(vans[7])} for mode of error event in save single failure`, async function() {
+        assert.strict.deepStrictEqual(vget[7], vans[7])
+    })
+
+    vans[8] = true
+    it(`should get ${JSON.stringify(vans[8])} for same err between error event and result of save`, async function() {
+        assert.strict.deepStrictEqual(vget[8], vans[8])
+    })
+
+    vans[9] = 1
+    it(`should get ${JSON.stringify(vans[9])} for count of error event in del single failure`, async function() {
+        assert.strict.deepStrictEqual(vget[9], vans[9])
+    })
+
+    vans[10] = 'del'
+    it(`should get ${JSON.stringify(vans[10])} for mode of error event in del single failure`, async function() {
+        assert.strict.deepStrictEqual(vget[10], vans[10])
+    })
+
+    vans[11] = true
+    it(`should get ${JSON.stringify(vans[11])} for same err between error event and result of del`, async function() {
+        assert.strict.deepStrictEqual(vget[11], vans[11])
+    })
+
+    vans[12] = 0
+    it(`should get ${JSON.stringify(vans[12])} for count of error event in normal results`, async function() {
+        assert.strict.deepStrictEqual(vget[12], vans[12])
+    })
+
+    vans[13] = ['error:save', 'change:save']
+    it(`should get ${JSON.stringify(vans[13])} for order of error and change`, async function() {
+        assert.strict.deepStrictEqual(vget[13], vans[13])
+    })
+
+    vans[14] = [
+        { n: 1, nDeleted: 1, ok: 1 },
+        { n: 0, nDeleted: 0, ok: 0, err: 'invalid id[undefined]' }
+    ]
+    it(`should get ${JSON.stringify(vans[14])} for result with throwing error listener`, async function() {
+        assert.strict.deepStrictEqual(vget[14], vans[14])
+    })
+
+})
+
+
+describe('error listener does not change behavior', function() {
+    let vans = {}
+    let vget = {}
+
+    before(async function() {
+        this.timeout(120000)
+
+        //run, 以同一組操作跑兩次, 差別僅在有無註冊error監聽
+        //T10.1第2條: 操作行為不得因監聽者之有無而改變
+        let run = async (cl, withListener) => {
+            let wo = WOrm(genOpt(cl))
+            if (withListener) {
+                wo.on('error', function() {})
+            }
+            await wo.delAll()
+
+            let out = []
+
+            //整批性錯誤
+            let woOff = WOrm(genOptPk(`${cl}off`, false))
+            if (withListener) {
+                woOff.on('error', function() {})
+            }
+            await woOff.delAll()
+            await woOff.insert({ name: 'no-id' })
+                .then((r) => out.push({ t: 'resolve', r }))
+                .catch((e) => out.push({ t: 'reject', e: e.toString() }))
+
+            //逐筆失敗
+            await wo.insert([{ id: 'a1' }, { id: 'a2' }])
+            let rs = await wo.save([{ id: 'a1', name: 'ok' }, { id: 'a2', $bad: 1 }])
+            out.push({ t: 'save', ok: rs.map((v) => v.ok), n: rs.map((v) => v.n) })
+
+            //del逐筆失敗
+            let rd = await wo.del([{ id: 'a1' }, { name: 'no-id' }])
+            out.push({ t: 'del', r: rd })
+
+            //讀取函數之整批性錯誤
+            await wo.selectByPk('not-existed')
+                .then((r) => out.push({ t: 'selectByPk', r }))
+                .catch((e) => out.push({ t: 'selectByPkReject', e: e.toString() }))
+
+            return out
+        }
+
+        let a = await run('evnolisten', false)
+        let b = await run('evlisten', true)
+
+        vget[1] = JSON.stringify(a) === JSON.stringify(b)
+        vget[2] = a[0].t
+        vget[3] = a[1].ok
+
+    })
+
+    vans[1] = true
+    it(`should get ${JSON.stringify(vans[1])} for same result with and without error listener`, async function() {
+        assert.strict.deepStrictEqual(vget[1], vans[1])
+    })
+
+    vans[2] = 'reject'
+    it(`should get ${JSON.stringify(vans[2])} for reject without error listener`, async function() {
+        assert.strict.deepStrictEqual(vget[2], vans[2])
+    })
+
+    vans[3] = [1, 0]
+    it(`should get ${JSON.stringify(vans[3])} for ok of save without error listener`, async function() {
+        assert.strict.deepStrictEqual(vget[3], vans[3])
+    })
+
+})
+
+
 describe('change event', function() {
     let vans = {}
     let vget = {}