w-syslog 1.0.8 → 1.0.10

package/test/cleanLogs.test.mjs

@@ -34,20 +34,17 @@ describe('WSyslog cleanLogs', function() {
         w.fsDeleteFolder(fdLog)
     })
 
-    afterEach(async function() {
-        //稍候pino worker flush, 避免Windows上EBUSY
-        await w.delay(100)
-        //完全移除測試資料夾, 不留空殼
+    afterEach(function() {
+        //clear已保證worker收攤與fd釋放, 直接移除測試資料夾, 不留空殼
         w.fsDeleteFolder(fdLog)
     })
 
-    after(async function() {
+    after(function() {
         //最終把'資料夾不存在時不崩'測試可能由pino formatter建立的資料夾也清掉
-        await w.delay(100)
         w.fsDeleteFolder(fdNoExist)
     })
 
-    it('day模式: 保留最新numKeep個檔, 最舊的被刪', function() {
+    it('day模式: 保留最新numKeep個檔, 最舊的被刪', async function() {
         seedFiles(fdLog, [
             '2020-01-01.log',
             '2020-01-02.log',
@@ -65,10 +62,10 @@ describe('WSyslog cleanLogs', function() {
             '2020-01-05.log',
         ])
 
-        log.clear()
+        await log.clear()
     })
 
-    it('當檔數小於等於numKeep時不刪任何檔', function() {
+    it('當檔數小於等於numKeep時不刪任何檔', async function() {
         seedFiles(fdLog, [
             '2020-01-01.log',
             '2020-01-02.log',
@@ -83,10 +80,10 @@ describe('WSyslog cleanLogs', function() {
             '2020-01-02.log',
         ])
 
-        log.clear()
+        await log.clear()
     })
 
-    it('hr模式: 只匹配hr命名, 不誤刪day命名', function() {
+    it('hr模式: 只匹配hr命名, 不誤刪day命名', async function() {
         seedFiles(fdLog, [
             //day命名(不該被hr模式cleanLogs動到)
             '2020-01-01.log',
@@ -115,10 +112,10 @@ describe('WSyslog cleanLogs', function() {
             '2020-01-01T05.log',
         ])
 
-        log.clear()
+        await log.clear()
     })
 
-    it('刪除時觸發delete事件, payload含fp與fn', function() {
+    it('刪除時觸發delete事件, payload含fp與fn', async function() {
         //先啟動空資料夾的logger, 此時init的cleanLogs不會刪任何檔
         let log = WSyslog({ fdLog, numKeep: 5, interval: 'hr' })
 
@@ -159,22 +156,23 @@ describe('WSyslog cleanLogs', function() {
             assert.strict.equal(d.fp, path.join(fdLog, d.fn))
         }
 
-        log.clear()
+        await log.clear()
     })
 
-    it('資料夾不存在時不崩', function() {
+    it('資料夾不存在時不崩', async function() {
         //確保起始狀態為不存在
         w.fsDeleteFolder(fdNoExist)
 
+        let log = null
         assert.doesNotThrow(() => {
-            let log = WSyslog({ fdLog: fdNoExist, numKeep: 5, interval: 'day' })
+            log = WSyslog({ fdLog: fdNoExist, numKeep: 5, interval: 'day' })
             log.cleanLogs()
-            log.clear()
         })
+        await log.clear()
         //pino formatter可能async建立資料夾, 由describe區塊的after hook統一清理
     })
 
-    it('忽略不符regex命名的檔', function() {
+    it('忽略不符regex命名的檔', async function() {
         seedFiles(fdLog, [
             '2020-01-01.log',
             '2020-01-02.log',
@@ -209,7 +207,7 @@ describe('WSyslog cleanLogs', function() {
             .sort()
         assert.strict.deepEqual(matching, ['2020-01-03.log'])
 
-        log.clear()
+        await log.clear()
     })
 
 })

package/test/clear.test.mjs

@@ -0,0 +1,138 @@
+import fs from 'fs'
+import path from 'path'
+import assert from 'assert'
+import { execFile } from 'child_process'
+import { fileURLToPath } from 'url'
+import _ from 'lodash-es'
+import w from 'wsemi'
+import WSyslog from '../src/WSyslog.mjs'
+
+
+//獨立測試資料夾, 避免與其他測試檔在parallel模式下競用
+let fdLog = './_logs_clear_test'
+let fdLogChild = './_logs_clear_child' //子程序fixture用, 實際為`${fdLogChild}_${i}`
+let fdLogStress = './_logs_clear_stress'
+let fdLogAfter = './_logs_clear_after'
+
+
+//fixture路徑錨定於本測試檔位置, 不受cwd影響
+let fpFxExit = fileURLToPath(new URL('./fixtures/clear-exit.mjs', import.meta.url))
+let fpFxAfter = fileURLToPath(new URL('./fixtures/log-after-clear.mjs', import.meta.url))
+
+
+function runNode(args) {
+    //以子程序執行fixture, 回傳{code, stderr, ms}
+    return new Promise((resolve) => {
+        let ts = Date.now()
+        execFile(process.execPath, args, { cwd: process.cwd() }, (err, stdout, stderr) => {
+            let code = err ? err.code : 0
+            resolve({ code, stderr, ms: Date.now() - ts })
+        })
+    })
+}
+
+
+function countLogLines(folder) {
+    //統計資料夾內所有log檔的非空行數
+    if (!w.fsIsFolder(folder)) {
+        return 0
+    }
+    let n = 0
+    for (let fn of fs.readdirSync(folder)) {
+        let jj = fs.readFileSync(path.join(folder, fn), 'utf8')
+        n += w.sep(jj, '\n').length
+    }
+    return n
+}
+
+
+function cleanAll() {
+    w.fsDeleteFolder(fdLog)
+    w.fsDeleteFolder(fdLogAfter)
+    for (let i = 0; i < 10; i++) {
+        w.fsDeleteFolder(`${fdLogChild}_${i}`)
+        w.fsDeleteFolder(`${fdLogStress}_${i}`)
+    }
+}
+
+
+describe('WSyslog clear', function() {
+
+    before(function() {
+        cleanAll()
+    })
+
+    after(async function() {
+        await w.delay(100)
+        cleanAll()
+    })
+
+    it('clear後檔案內容立即完整, 不需delay等flush', async function() {
+
+        let log = WSyslog({ fdLog, interval: 'day' })
+        log.info({ event: 'runner', msg: 'start' })
+        log.warn({ event: 'monitor-memory', msg: 'usage-high', ratio: 85.4 })
+        log.error({ event: 'crash', msg: 'db connection', code: 500 })
+
+        await log.clear()
+
+        //clear已保證殘餘log全數寫出, 立即讀檔驗證
+        let vpfs = w.fsTreeFolder(fdLog)
+        let fp = _.get(vpfs, `0.path`, '')
+        let jj = fs.readFileSync(fp, 'utf8')
+        let ss = w.sep(jj, '\n')
+        let r = _.map(ss, (j) => {
+            let v = JSON.parse(j)
+            return { event: _.get(v, 'event'), msg: _.get(v, 'msg') }
+        })
+        assert.strict.deepEqual(r, [
+            { event: 'runner', msg: 'start' },
+            { event: 'monitor-memory', msg: 'usage-high' },
+            { event: 'crash', msg: 'db connection' },
+        ])
+    })
+
+    it('重複clear回傳同一Promise(冪等)', async function() {
+
+        let log = WSyslog({ fdLog, interval: 'day' })
+        log.info({ event: 'idem', msg: 'x' })
+
+        let p1 = log.clear()
+        let p2 = log.clear()
+        assert.strict.equal(p1, p2)
+
+        await p1
+
+        //clear之後再呼叫依然回傳同一Promise
+        let p3 = log.clear()
+        assert.strict.equal(p1, p3)
+    })
+
+    it('子程序寫300筆log後clear, 行程於數秒內自然退出且無漏筆', async function() {
+
+        let { code, stderr, ms } = await runNode([fpFxExit, fdLogChild, '1', '300'])
+
+        assert.strict.equal(code, 0, `子程序應exit 0, 實得code=${code}, stderr=${stderr}`)
+        assert.ok(ms < 20000, `子程序應於數秒內退出, 實測${ms}ms`)
+        assert.strict.equal(countLogLines(`${fdLogChild}_0`), 300)
+    })
+
+    it('壓測: 10實例各寫300筆後逐一clear, 行程自然退出且無漏筆', async function() {
+
+        let { code, stderr } = await runNode([fpFxExit, fdLogStress, '10', '300'])
+
+        assert.strict.equal(code, 0, `子程序應exit 0, 實得code=${code}, stderr=${stderr}`)
+        for (let i = 0; i < 10; i++) {
+            assert.strict.equal(countLogLines(`${fdLogStress}_${i}`), 300, `實例${i}應有300筆log`)
+        }
+    })
+
+    it('clear後再寫log, 非同步丟the worker has exited(子程序exit非0)', async function() {
+
+        let { code, stderr } = await runNode([fpFxAfter, fdLogAfter])
+
+        assert.notStrictEqual(code, 0, 'clear後再寫log的子程序應以非0退出')
+        assert.ok(stderr.includes('the worker has exited'), `stderr應含'the worker has exited', 實得: ${stderr}`)
+    })
+
+})

package/test/fixtures/clear-exit.mjs

@@ -0,0 +1,25 @@
+import WSyslog from '../../src/WSyslog.mjs'
+
+
+//子程序fixture: 建nInst個實例各寫nLogs筆log後逐一clear, 用於驗證行程能自然退出(不依賴exit hook)
+//argv: [fdLogBase, nInst, nLogs], 各實例寫入`${fdLogBase}_${i}`資料夾
+
+
+let fdLogBase = process.argv[2]
+let nInst = parseInt(process.argv[3], 10)
+let nLogs = parseInt(process.argv[4], 10)
+
+let logs = []
+for (let i = 0; i < nInst; i++) {
+    logs.push(WSyslog({ fdLog: `${fdLogBase}_${i}`, interval: 'day' }))
+}
+
+for (let log of logs) {
+    for (let k = 0; k < nLogs; k++) {
+        log.info({ event: 'stress', msg: `m${k}` })
+    }
+}
+
+for (let log of logs) {
+    await log.clear()
+}

package/test/fixtures/log-after-clear.mjs

@@ -0,0 +1,18 @@
+import WSyslog from '../../src/WSyslog.mjs'
+
+
+//子程序fixture: clear後再寫log, 預期非同步丟uncaughtException(the worker has exited)致exit code非0
+//argv: [fdLog]
+
+
+let fdLog = process.argv[2]
+
+let log = WSyslog({ fdLog, interval: 'day' })
+log.info({ event: 'probe', msg: 'before-clear' })
+
+await log.clear()
+
+log.info({ event: 'probe', msg: 'after-clear' })
+
+//保持存活讓非同步錯誤有時間浮現; 若未丟錯則計時器到期以exit 0結束, 由測試端斷言非0
+setTimeout(() => {}, 3000)

package/test/timeZone.test.mjs

@@ -28,9 +28,8 @@ describe('WSyslog timeZone', function() {
         w.fsDeleteFolder(fdLogTpe)
     })
 
-    afterEach(async function() {
-        //稍候pino worker flush, 避免Windows上EBUSY
-        await w.delay(200)
+    afterEach(function() {
+        //clear已保證worker收攤與fd釋放, 直接移除測試資料夾
         w.fsDeleteFolder(fdLogUtc)
         w.fsDeleteFolder(fdLogTpe)
     })
@@ -40,7 +39,7 @@ describe('WSyslog timeZone', function() {
         let log = WSyslog({ fdLog: fdLogUtc, interval: 'hr', timeZone: 'UTC' })
         log.info({ event: 'tz-utc', msg: 'check' })
 
-        await w.delay(2000) //等pino flush
+        await log.clear() //顯式關閉, 保證殘餘log已全數寫出
 
         let actualKey = readHrKey(fdLogUtc)
         assert.ok(actualKey !== null, `應有1個hr log檔, 取得actualKey=${actualKey}`)
@@ -54,8 +53,6 @@ describe('WSyslog timeZone', function() {
             actualKey === utcKey || actualKey === utcKeyPrev,
             `actualKey="${actualKey}" 應為UTC當前小時"${utcKey}"或前一小時"${utcKeyPrev}"`
         )
-
-        log.clear()
     })
 
     it('timeZone="UTC" 與 "Asia/Taipei" (UTC+8) 寫log應產生不同小時檔名', async function() {
@@ -67,7 +64,8 @@ describe('WSyslog timeZone', function() {
         logUtc.info({ msg: 'x' })
         logTpe.info({ msg: 'x' })
 
-        await w.delay(2000)
+        await logUtc.clear()
+        await logTpe.clear()
 
         let keyUtc = readHrKey(fdLogUtc)
         let keyTpe = readHrKey(fdLogTpe)
@@ -81,9 +79,6 @@ describe('WSyslog timeZone', function() {
             keyTpe,
             `UTC與Asia/Taipei檔名應不同: keyUtc="${keyUtc}", keyTpe="${keyTpe}"`
         )
-
-        logUtc.clear()
-        logTpe.clear()
     })
 
 })