w-md2docx 1.0.6 → 1.0.7

package/test/unit-cvMdTo.test.mjs

@@ -7,7 +7,7 @@ import cvMdTo from '../src/cvMdTo.mjs'
 //cvMdTo之html路徑(不需Microsoft Word); docx路徑於unit-cvMdToDocx以Word守門測試
 describe('cvMdTo', function() {
 
-    let fdTmp = path.resolve('./tmp/zt_cvMdTo')
+    let fdTmp = path.resolve('./test/_tmp/unit-cvMdTo')
     let svgB64 = fs.readFileSync('./test/cocktail.svg').toString('base64')
     let toHtml = (r) => Buffer.from(r.html.base64, 'base64').toString('utf8')
 
@@ -16,7 +16,7 @@ describe('cvMdTo', function() {
     })
 
     after(function() {
-        fs.rmSync(fdTmp, { recursive: true, force: true })
+        fs.rmSync(fdTmp, { recursive: true, force: true, maxRetries: 10, retryDelay: 300 })
     })
 
     it('out=html: 回傳物件形狀與檔名', async function() {

package/test/unit-cvMdToDocx.test.mjs

@@ -1,22 +1,24 @@
 import fs from 'fs'
 import path from 'path'
 import zlib from 'zlib'
+import { pathToFileURL } from 'url'
 import { execFileSync } from 'child_process'
 import assert from 'assert'
 import cvMdToDocx from '../src/cvMdToDocx.mjs'
 import cvMdTo from '../src/cvMdTo.mjs'
-import { getFpExe } from '../src/utils.mjs'
 
 
-//hasWord: 本機是否可調用 Microsoft Word(Windows + Word.Application COM 已註冊 + htmlToDocx.exe 存在)
-//why: docx 階段須真 Word, 無 Word 之機器僅測輸入檢查, 實轉區塊整段略過(同 w-html2docx 之 isWindows 守門)
+//fdTmpRoot: 本測試檔專用暫存夾, 各describe於其下自建子夾並於after刪除
+let fdTmpRoot = path.resolve('./test/_tmp/unit-cvMdToDocx')
+
+
+//hasWord: 本機是否可調用 Microsoft Word(Windows + Word.Application COM 已註冊)
+//why: docx 階段須真 Word, 無 Word 之機器實轉區塊整段略過;
+//     不以 htmlToDocx.exe 是否存在為條件——缺檔時 w-html2docx 於轉檔時自動下載, 以其為條件會使剛安裝之機器漏測實轉
 function hasWord() {
     if (process.platform !== 'win32') {
         return false
     }
-    if (getFpExe() === '') {
-        return false
-    }
     try {
         execFileSync('reg', ['query', 'HKCR\\Word.Application'], { stdio: 'ignore', windowsHide: true })
         return true
@@ -57,13 +59,15 @@ function readZipEntries(buf) {
 
 describe('cvMdToDocx 輸入檢查(不需Word)', function() {
 
+    let fpOut = path.resolve(fdTmpRoot, 'input', 'x.docx') //輸入檢查皆於寫檔前拒絕, 不會產生檔案
+
     it('fpInMd非有效字串', async function() {
-        await assert.rejects(cvMdToDocx('', './tmp/x.docx'), (e) => e === 'fpInMd must be a non-empty string')
-        await assert.rejects(cvMdToDocx(null, './tmp/x.docx'), (e) => e === 'fpInMd must be a non-empty string')
+        await assert.rejects(cvMdToDocx('', fpOut), (e) => e === 'fpInMd must be a non-empty string')
+        await assert.rejects(cvMdToDocx(null, fpOut), (e) => e === 'fpInMd must be a non-empty string')
     })
 
     it('fpInMd不存在', async function() {
-        await assert.rejects(cvMdToDocx('./test/nope.md', './tmp/x.docx'), (e) => /^fpInMd\[.+nope\.md\] does not exist$/.test(e))
+        await assert.rejects(cvMdToDocx('./test/nope.md', fpOut), (e) => /^fpInMd\[.+nope\.md\] does not exist$/.test(e))
     })
 
     it('fpOutDocx非有效字串', async function() {
@@ -71,7 +75,7 @@ describe('cvMdToDocx 輸入檢查(不需Word)', function() {
     })
 
     it('fpInTemp不存在', async function() {
-        await assert.rejects(cvMdToDocx('./test/report.md', './tmp/x.docx', { fpInTemp: './test/nope.docx' }), (e) => /^fpInTemp\[.+nope\.docx\] does not exist$/.test(e))
+        await assert.rejects(cvMdToDocx('./test/report.md', fpOut, { fpInTemp: './test/nope.docx' }), (e) => /^fpInTemp\[.+nope\.docx\] does not exist$/.test(e))
     })
 
 })
@@ -85,7 +89,7 @@ describe('cvMdToDocx 實轉(需Windows+Microsoft Word)', function() {
         return
     }
 
-    let fdTmp = path.resolve('./tmp/zt_cvMdToDocx')
+    let fdTmp = path.resolve(fdTmpRoot, 'real')
     let fpIn = './test/report.md'
     let fpOut = path.resolve(fdTmp, 'report.docx')
     let fpOutHtml = path.resolve(fdTmp, 'report.html')
@@ -108,7 +112,7 @@ describe('cvMdToDocx 實轉(需Windows+Microsoft Word)', function() {
     })
 
     after(function() {
-        fs.rmSync(fdTmp, { recursive: true, force: true })
+        fs.rmSync(fdTmp, { recursive: true, force: true, maxRetries: 10, retryDelay: 300 })
     })
 
     it('回傳物件: fpOutDocx/sizeDocx/sizeHtml/ms/fpOutHtml與實體檔一致', function() {
@@ -183,3 +187,162 @@ describe('cvMdToDocx 實轉(需Windows+Microsoft Word)', function() {
     })
 
 })
+
+
+//轉檔器之定位與補齊由 w-html2docx 負責(WHtml2docx.mjs:158 → autoDownloadFiles), 上層不得以自身規則事前攔截
+describe('cvMdToDocx 缺轉檔器時交由w-html2docx取得(不得於上層事前攔截)', function() {
+
+    //check, htmlToDocx.exe僅供Windows, 非Windows時w-html2docx於下載前即拒絕
+    if (process.platform !== 'win32') {
+        return
+    }
+
+    let fpInTemp = path.resolve('./src/templates/temp_tpc.docx')
+    let msgHint = 'w-html2docx resolves htmlToDocx.exe and its default template from cwd and downloads htmlToDocx.exe automatically when absent, please run from the project root that contains node_modules/w-html2docx'
+
+    after(function() {
+        fs.rmSync(fdTmpRoot, { recursive: true, force: true, maxRetries: 10, retryDelay: 300 })
+    })
+
+    it('缺檔時不於上層中斷, 由w-html2docx自動下載轉檔器後續行轉檔', async function() {
+        this.timeout(180000)
+
+        //fdCwd: 模擬工作目錄, 其下src/與node_modules/w-html2docx/src/皆無htmlToDocx.exe(即安裝時postinstall未執行)
+        let fdCwd = path.resolve(fdTmpRoot, 'autodl')
+        let fpMd = path.resolve(fdCwd, 'in.md')
+        let fpDocx = path.resolve(fdCwd, 'out.docx')
+        let fpExeDL = path.resolve(fdCwd, 'src', 'htmlToDocx.exe') //cwd無node_modules/w-html2docx/時之下載落點(autoDownloadFiles.mjs:66)
+        fs.rmSync(fdCwd, { recursive: true, force: true })
+        fs.mkdirSync(fdCwd, { recursive: true })
+        fs.writeFileSync(fpMd, '# 轉檔器自動下載\n\n段落', 'utf8')
+
+        let cwdOri = process.cwd()
+        let err = null
+        let r = null
+        process.chdir(fdCwd)
+        try {
+            assert.strict.equal(fs.existsSync(fpExeDL), false) //前置: 缺檔
+            r = await cvMdToDocx(fpMd, fpDocx, { fpInTemp })
+                .catch((e) => {
+                    err = e
+                })
+        }
+        finally {
+            process.chdir(cwdOri)
+        }
+
+        //不得為上層事前檢查之拒絕(未呼叫w-html2docx即中斷)
+        assert.strict.equal(/htmlToDocx\.exe not found/.test(String(err)), false, `rejected by upper-layer pre-check: ${err}`)
+
+        //缺檔即自動下載: 轉檔器落地於下載落點
+        if (!fs.existsSync(fpExeDL)) {
+            //下載失敗(如離線)時僅能確認失敗來自docx階段(已交由w-html2docx), 無法確認落地
+            assert.strict.equal(/^Failed to convert html to docx: /.test(String(err)), true, String(err))
+            console.log(`[unit-cvMdToDocx] htmlToDocx.exe download failed, skip landing check: ${err}`)
+            this.skip()
+        }
+        assert.strict.equal(fs.statSync(fpExeDL).size > 1024 * 1024, true)
+
+        //下載後續行轉檔: 有Word則產出docx; 無Word則 w-html2docx(≥1.0.29) 以離開碼1 reject 並帶轉檔器回報之原因
+        //(其 srcPython/說明.txt 第9點: `error: com_error: (-2147221005, …)` 為Word未安裝), 本層加前綴後原樣傳出, 非轉檔器缺檔
+        if (err === null) {
+            assert.strict.equal(r.sizeDocx, fs.statSync(fpDocx).size)
+            assert.strict.equal(r.sizeDocx > 0, true)
+        }
+        else {
+            assert.strict.equal(hasWord(), false, `conversion failed although Word is available: ${err}`)
+            assert.strict.equal(/^Failed to convert html to docx: code\[1\]:\r?\nerror: com_error: /.test(String(err)), true, String(err))
+        }
+    })
+
+    it('缺檔且下載失敗時reject(不假成功), 不產出docx且中介html已清除', function() {
+        this.timeout(180000)
+
+        //fdCwd: 以子程序於此cwd啟動並經不可達之代理下載, 使w-html2docx之自動下載確定失敗(不需連網)
+        let fdCwd = path.resolve(fdTmpRoot, 'dlfail')
+        let fpMd = path.resolve(fdCwd, 'in.md')
+        let fpDocx = path.resolve(fdCwd, 'out.docx')
+        let fpExeDL = path.resolve(fdCwd, 'src', 'htmlToDocx.exe')
+        fs.rmSync(fdCwd, { recursive: true, force: true })
+        fs.mkdirSync(fdCwd, { recursive: true })
+        fs.writeFileSync(fpMd, '# 下載失敗\n\n段落', 'utf8')
+
+        let script = [
+            `import fs from 'fs'`,
+            `import os from 'os'`,
+            `let m = await import(process.env.T_MOD)`,
+            `let err = null`,
+            `await m.default(process.env.T_MD, process.env.T_DOCX, { fpInTemp: process.env.T_TEMP }).catch((e) => { err = e })`,
+            `let nHtml = fs.readdirSync(os.tmpdir()).filter((v) => v.startsWith('wmd2docx_' + process.pid + '_')).length`,
+            `process.stdout.write('@@RESULT@@' + JSON.stringify({ err, nHtml }))`,
+            `process.exit(0)`,
+        ].join('\n')
+        let out = execFileSync(process.execPath, ['--input-type=module', '-e', script], {
+            cwd: fdCwd,
+            env: {
+                ...process.env,
+                NODE_USE_ENV_PROXY: '1',
+                HTTPS_PROXY: 'http://127.0.0.1:1',
+                HTTP_PROXY: 'http://127.0.0.1:1',
+                T_MOD: pathToFileURL(path.resolve('./src/cvMdToDocx.mjs')).href,
+                T_MD: fpMd,
+                T_DOCX: fpDocx,
+                T_TEMP: fpInTemp,
+            },
+            windowsHide: true,
+            encoding: 'utf8',
+        })
+        let { err, nHtml } = JSON.parse(out.split('@@RESULT@@')[1])
+
+        //Node未支援NODE_USE_ENV_PROXY時下載會實際成功, 無法構成下載失敗之前置, 標為pending
+        if (fs.existsSync(fpExeDL)) {
+            console.log('[unit-cvMdToDocx] proxy env not honored by this Node version, skip download failure check')
+            this.skip()
+        }
+
+        //下載失敗才失敗: 由docx階段reject, 不假成功
+        assert.strict.equal(/^Failed to convert html to docx: /.test(String(err)), true, String(err))
+        assert.strict.equal(fs.existsSync(fpDocx), false)
+        //清理路徑: 未指定fpOutHtml時中介html於失敗時亦刪除
+        assert.strict.equal(nHtml, 0)
+    })
+
+    it('於不含node_modules/w-html2docx之cwd啟動且未給fpInTemp時, 保留w-html2docx原訊息並附cwd提示', function() {
+        this.timeout(180000)
+
+        //fdCwd: 以子程序於此cwd啟動, w-html2docx於模組載入時以cwd查找預設模板, 查無即拒絕(WHtml2docx.mjs:136, 早於下載)
+        let fdCwd = path.resolve(fdTmpRoot, 'wrongcwd')
+        let fpMd = path.resolve(fdCwd, 'in.md')
+        let fpDocx = path.resolve(fdCwd, 'out.docx')
+        fs.rmSync(fdCwd, { recursive: true, force: true })
+        fs.mkdirSync(fdCwd, { recursive: true })
+        fs.writeFileSync(fpMd, '# 錯誤工作目錄\n\n段落', 'utf8')
+
+        let script = [
+            `import(process.env.T_MOD).then(async (m) => {`,
+            `    let err = null`,
+            `    await m.default(process.env.T_MD, process.env.T_DOCX).catch((e) => { err = e })`,
+            `    process.stdout.write('@@RESULT@@' + JSON.stringify({ err }))`,
+            `})`,
+        ].join('\n')
+        let out = execFileSync(process.execPath, ['--input-type=module', '-e', script], {
+            cwd: fdCwd,
+            env: {
+                ...process.env,
+                T_MOD: pathToFileURL(path.resolve('./src/cvMdToDocx.mjs')).href,
+                T_MD: fpMd,
+                T_DOCX: fpDocx,
+            },
+            windowsHide: true,
+            encoding: 'utf8',
+        })
+        let { err } = JSON.parse(out.split('@@RESULT@@')[1])
+
+        //原訊息保留, 並附cwd與執行位置提示
+        let prefix = 'Failed to convert html to docx: can not find folder for tmp.docx (cwd='
+        assert.strict.equal(String(err).startsWith(prefix), true, String(err))
+        assert.strict.equal(String(err).toLowerCase().includes(`(cwd=${fdCwd.toLowerCase()}, `), true, String(err))
+        assert.strict.equal(String(err).endsWith(`, ${msgHint})`), true, String(err))
+    })
+
+})

package/test/unit-utils.test.mjs

@@ -23,14 +23,14 @@ let sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms))
 
 describe('utils', function() {
 
-    let fdTmp = path.resolve('./tmp/zt_utils')
+    let fdTmp = path.resolve('./test/_tmp/unit-utils')
 
     before(function() {
         fs.mkdirSync(fdTmp, { recursive: true })
     })
 
     after(function() {
-        fs.rmSync(fdTmp, { recursive: true, force: true })
+        fs.rmSync(fdTmp, { recursive: true, force: true, maxRetries: 10, retryDelay: 300 })
     })
 
     describe('mime', function() {
@@ -182,7 +182,24 @@ describe('utils', function() {
             assert.strict.equal(r.cwd, path.resolve())
             assert.strict.equal(r.exePath, getFpExe())
             assert.strict.equal(r.exeFound, r.exePath !== '')
-            assert.strict.equal(r.ready, r.isWindows && r.exeFound)
+            assert.strict.equal(r.ready, r.isWindows) //ready不以轉檔器存在為條件(缺檔於首次轉檔時由w-html2docx自動下載)
+        })
+
+        it('轉檔器缺檔時exeFound為false但ready不因此為false', function() {
+            let fdCwd = path.resolve(fdTmp, 'noexe') //其下src/與node_modules/w-html2docx/src/皆無htmlToDocx.exe
+            fs.mkdirSync(fdCwd, { recursive: true })
+            let cwdOri = process.cwd()
+            let r = null
+            process.chdir(fdCwd)
+            try {
+                r = checkDocxReady()
+            }
+            finally {
+                process.chdir(cwdOri)
+            }
+            assert.strict.equal(r.exePath, '')
+            assert.strict.equal(r.exeFound, false)
+            assert.strict.equal(r.ready, process.platform === 'win32')
         })
 
     })