w-orm-reladb 1.1.7 → 1.1.9

package/src/requireModel.js

@@ -1,5 +1,13 @@
-function requireModel(fn, sequelize, DataTypes) {
-    return require(fn)(sequelize, DataTypes)
-}
-
-module.exports = requireModel
+const { createRequire } = require('module')
+
+
+//載入js格式之model檔並呼叫其定義函數
+//註: 不可直接以require(fn)載入: 發布用dist經rollup之commonjs外掛打包時, 引數非字面值之require會被換成必拋[Could not dynamically require]之樁,
+//故以Node內建module之createRequire依model檔之絕對路徑產生require函數載入, 其解析與模組快取皆同require
+//註: fn須為絕對路徑, 呼叫端(本套件與w-orm-mdb之importModels)皆以path.resolve產生; 被w-orm-mdb等深層引用, 勿改簽章或路徑
+function requireModel(fn, sequelize, DataTypes) {
+    let req = createRequire(fn)
+    return req(fn)(sequelize, DataTypes)
+}
+
+module.exports = requireModel

package/test/api-dist.test.mjs

@@ -0,0 +1,112 @@
+import fs from 'fs'
+import path from 'path'
+import assert from 'assert'
+import { execFile } from 'child_process'
+import { createRequire } from 'module'
+
+
+//rulebook R10: 經package.json之main(dist)使用時, js型model之importModels與各函數須與經src使用時同樣可用
+//修正前dist內src/requireModel.js之require(fn)被rollup之commonjs外掛換成必拋[Could not dynamically require]之樁, 而測試只跑src未曾發現
+//作法: 以toolg/gDistRollup.mjs原檔之設定只換輸出夾, 由目前src建置至已安裝佈局(app/node_modules/w-orm-reladb/dist), 再由app以套件名require
+//僅以sqlite驗證, 因model檔之載入與資料庫種類無關
+
+
+let fd = './test/_tmp/api-dist'
+let fdApp = `${fd}/app`
+let fdPkg = `${fdApp}/node_modules/w-orm-reladb`
+let fdDist = `${fdPkg}/dist`
+let fdModels = `${fd}/models`
+let fpBundle = `${fdDist}/w-orm-reladb.umd.js`
+
+
+//buildDist, 複製gDistRollup.mjs並只把fdTar換成已安裝佈局之dist後, 以子行程於專案根目錄執行(同發布時之cwd, 故babel.config.js與package.json同發布)
+let buildDist = () => {
+    let c = fs.readFileSync('./toolg/gDistRollup.mjs', 'utf8')
+    let from = `let fdTar = './dist'`
+    assert.strictEqual(c.split(from).length - 1, 1, `toolg/gDistRollup.mjs須恰有一處[${from}]供替換輸出夾`)
+    c = c.replace(from, `let fdTar = '${fdDist}'`)
+    let fpGen = `${fd}/gDistRollup.mjs`
+    fs.writeFileSync(fpGen, c, 'utf8')
+    return new Promise((resolve, reject) => {
+        execFile(process.execPath, [fpGen], { maxBuffer: 64 * 1024 * 1024 }, (err, stdout, stderr) => {
+            if (err) {
+                reject(new Error(`build dist failed: ${err.message}\n${stderr}`))
+                return
+            }
+            resolve(stdout)
+        })
+    })
+}
+
+
+describe('dist (installed layout)', function() {
+
+    let wo = null
+
+    before(async function() {
+
+        fs.rmSync(fd, { recursive: true, force: true })
+        fs.mkdirSync(fdDist, { recursive: true })
+
+        //build
+        await buildDist()
+
+        //已安裝佈局: 套件夾內之package.json(main指向dist), 相依(sequelize等)沿上層node_modules解析
+        fs.copyFileSync('./package.json', `${fdPkg}/package.json`)
+
+        //models, 複製至暫存夾, 不動版控中之models
+        fs.mkdirSync(fdModels, { recursive: true })
+        fs.copyFileSync('./models/users.js', `${fdModels}/users.js`)
+        fs.copyFileSync('./models/users.json', `${fdModels}/users.json`)
+
+        //require, 由app以套件名解析
+        let req = createRequire(path.resolve(fdApp, 'index.js'))
+        assert.strictEqual(req.resolve('w-orm-reladb'), path.resolve(fpBundle), '套件名須經package.json之main解析至建出之dist')
+        wo = req('w-orm-reladb')
+
+    })
+
+    after(function() {
+        fs.rmSync(fd, { recursive: true, force: true })
+    })
+
+    it('建出之dist不含rollup動態require之樁', function() {
+        //rulebook R10: 建置產物不得含[Could not dynamically require](含被打包之相依)
+        let code = fs.readFileSync(fpBundle, 'utf8')
+        assert.ok(code.length > 0)
+        assert.strictEqual(code.indexOf('Could not dynamically require'), -1)
+    })
+
+    it('js型model: createStorage、insert、select、selectByPk、del皆成功且不發error事件', async function() {
+        //rulebook R10: 預設modelType為js, 經main使用時importModels須可載入js型model
+        assert.strictEqual(typeof wo, 'function')
+        let w = wo({ url: 'sqlite://:', db: 'worm', cl: 'users', fdModels, storage: `${fd}/js.sqlite` })
+        let errs = []
+        w.on('error', (mode, data, err) => {
+            errs.push([mode, err])
+        })
+
+        assert.strictEqual(await w.createStorage(), 'created')
+        assert.deepStrictEqual(await w.insert({ id: 'a1', name: 'A', value: 1.5 }), { n: 1, nInserted: 1, ok: 1 })
+        assert.deepStrictEqual(await w.select({ id: 'a1' }), [{ id: 'a1', name: 'A', value: 1.5 }])
+        assert.deepStrictEqual(await w.selectByPk('a1'), { id: 'a1', name: 'A', value: 1.5 })
+        assert.deepStrictEqual(await w.del({ id: 'a1' }), [{ n: 1, nDeleted: 1, ok: 1 }])
+        assert.deepStrictEqual(await w.select(), [])
+        assert.deepStrictEqual(errs, [])
+    })
+
+    it('json型model(對照): createStorage、insert、select皆成功且不發error事件', async function() {
+        //rulebook R10: 兩種modelType經main皆須可用; json型不經requireModel, 修正前即可用
+        let w = wo({ url: 'sqlite://:', db: 'worm', cl: 'users', fdModels, modelType: 'json', storage: `${fd}/json.sqlite` })
+        let errs = []
+        w.on('error', (mode, data, err) => {
+            errs.push([mode, err])
+        })
+
+        assert.strictEqual(await w.createStorage(), 'created')
+        assert.deepStrictEqual(await w.insert({ id: 'b1', name: 'B', value: 2 }), { n: 1, nInserted: 1, ok: 1 })
+        assert.deepStrictEqual(await w.select({ id: 'b1' }), [{ id: 'b1', name: 'B', value: 2 }])
+        assert.deepStrictEqual(errs, [])
+    })
+
+})

package/test/api-init.test.mjs

@@ -0,0 +1,50 @@
+import assert from 'assert'
+import wo from '../src/WOrmReladb.mjs'
+
+
+//rulebook R7: 七函數之內部初始化(initSequelize)在主try內, 其建構期例外與其他整批性錯誤同樣於reject前發一次error事件(規格T10.3)
+//觸發: 本套件不相依mysql2, 以mysql://建構sequelize時即拋[Please install mysql2 package manually]; 若環境另裝mysql2則前提不成立, 斷言訊息會指出
+
+
+describe('initSequelize throws', function() {
+
+    it('七函數皆reject, 且於reject前各發一次error事件, mode為函數名、data為輸入數據或null、err與reject訊息一致', async function() {
+        let w = wo({ url: 'mysql://username:password@localhost:3306', db: 'worm', cl: 'users', fdModels: './models' })
+        let settled = false
+        let evs = []
+        w.on('error', (mode, data, err) => {
+            evs.push({ mode, data, err, settled })
+        })
+
+        let cases = [
+            ['select', null, () => w.select({ id: 'k1' })],
+            ['selectByPk', null, () => w.selectByPk('k1')],
+            ['insert', { id: 'k1', name: 'A' }, (d) => w.insert(d)],
+            ['insertBulk', [{ id: 'k2', name: 'B' }], (d) => w.insertBulk(d)],
+            ['save', [{ id: 'k1', name: 'Z' }], (d) => w.save(d)],
+            ['del', [{ id: 'k1' }], (d) => w.del(d)],
+            ['delAll', null, () => w.delAll({ id: 'k1' })],
+        ]
+        for (let [mode, data, fn] of cases) {
+            settled = false
+            evs = []
+            let r = await fn(data)
+                .then((v) => ({ RESOLVE: v }), (err) => ({ REJECT: String(err.message || err) }))
+                .finally(() => {
+                    settled = true
+                })
+
+            //整批性錯誤經Promise.reject(規格T4)
+            assert.ok(r.REJECT !== undefined, `${mode} 未reject, 實得 ${JSON.stringify(r.RESOLVE)}`)
+            assert.ok(r.REJECT.indexOf('Please install mysql2') >= 0, `${mode} 之reject非建構期例外(前提: 本機未裝mysql2): ${r.REJECT}`)
+
+            //規格T10.3: 整批性錯誤於reject之前發出一次, mode取函數名, err與reject之訊息一致, data為本次輸入數據(無輸入數據者為null)
+            assert.strictEqual(evs.length, 1, `${mode} 之error事件數 ${evs.length}`)
+            assert.strictEqual(evs[0].mode, mode)
+            assert.strictEqual(evs[0].err, r.REJECT)
+            assert.deepStrictEqual(evs[0].data, data)
+            assert.strictEqual(evs[0].settled, false, `${mode} 之error事件須於reject之前發出`)
+        }
+    })
+
+})

package/test/api-models.test.mjs

@@ -128,6 +128,29 @@ describe('models file', function() {
         assert.deepStrictEqual((await wAll.select()).map((v) => v.id).sort(), ['a', 'b'])
     })
 
+    it('model之defaultScope帶group/having、include或含Op.and之where時delAll拒絕且不刪除(select與destroy對這些選項之處置不同, 或scope之Op.and被cvFind頂層之Op.and覆寫)', async function() {
+        //rulebook R1: findAll套用scope之group/having與required include(只回部分列), destroy卻不套用而刪除全部符合where者(run05 sol F03、opus 疑慮(ii), sqlite實測 select=[2] 而 destroy=3);
+        //scope.where含Op.and者, sequelize以Object.assign合併而被cvFind輸出之頂層Op.and覆寫, scope條件消失(opus 疑慮(i))
+        let cases = [
+            ['group+having', 'defaultScope: { group: [\'id\'], having: sequelize.literal(\'value > 0\') }'],
+            ['required include', 'defaultScope: { include: [{ model: sequelize.define(\'uchild\', { id: { type: DataTypes.STRING, primaryKey: true } }, { tableName: \'uchild\' }), required: true }] }'],
+            ['where含Op.and', 'defaultScope: { where: { [require(\'sequelize\').Op.and]: [{ name: \'x\' }] } }'],
+        ]
+        for (let [i, [t, sc]] of cases.entries()) {
+            let fdm = path.join(fd, `m6${i}`)
+            fs.mkdirSync(fdm, { recursive: true })
+            fs.writeFileSync(path.join(fdm, 'users.js'), genModel(true).replace('tableName: \'users\'', `tableName: 'users', ${sc}`), 'utf8')
+            let st = path.join(fd, `m6${i}.sqlite`)
+            let w = wo({ url: 'sqlite://:', storage: st, db: 'worm', cl: 'users', fdModels: fdm })
+            await w.createStorage()
+            await w.insert([{ id: 'a', name: 'x', value: 1 }, { id: 'b', name: 'y', value: 0 }])
+            let r = await w.delAll({ value: { $gte: 0 } }).then(() => null).catch((err) => String(err.message || err))
+            assert.ok(r !== null && r.indexOf('defaultScope') >= 0, `${t}: 未reject: ${r}`)
+            let wAll = wo({ url: 'sqlite://:', storage: st, db: 'worm', cl: 'users', fdModels: path.join(fd, 'm1') })
+            assert.deepStrictEqual((await wAll.select()).map((v) => v.id).sort(), ['a', 'b'], `${t}: 資料被刪`)
+        }
+    })
+
     it('BIGINT主鍵: 超出安全整數之數值為型別不符, 精確值以標準整數寫法之字串給予', async function() {
         //rulebook R8: 整數類主鍵之數值須為安全整數, 否則已失精度而會命中相鄰主鍵; 超出安全整數之標準整數寫法字串保留為字串(表外細化)
         let fdm = path.join(fd, 'm5')