w-orm-reladb 1.1.6 → 1.1.8

package/src/importModels.mjs

@@ -1,117 +1,183 @@
-import fs from 'fs'
-import path from 'path'
-import JSON5 from 'json5'
-import Sequelize from 'sequelize'
+import fs from 'fs'
+import path from 'path'
+import JSON5 from 'json5'
+import Sequelize from 'sequelize'
 import each from 'lodash-es/each.js'
 import get from 'lodash-es/get.js'
 import isBoolean from 'lodash-es/isBoolean.js'
-import genPm from 'wsemi/src/genPm.mjs'
-import modifyModel from './modifyModel.mjs'
-import requireModel from './requireModel.js'
-
-
-function readJsModel(fn, sequelize) {
-    //model = sequelize.import(fn) //舊版sequelize才有import函數
-    //model = require(fn)(sequelize, Sequelize.DataTypes)
-    let model = requireModel(fn, sequelize, Sequelize.DataTypes)
-    return model
-}
-
-function readJsonModel(fn, sequelize) {
-
-    //s
-    let j = fs.readFileSync(fn, 'utf8')
-    let s = JSON5.parse(j)
-
-    //抽換DataTypes, 例如將'DataTypes.TEXT'改為DataTypes.TEXT
-    each(s.fields, (v) => {
-        v.type = get(Sequelize, v.type, null)
-    })
-
-    //model, 使用define產生model
-    let model = sequelize.define(s.table, s.fields, s.options)
-    // console.log('model', model)
-
-    return model
-}
-
-async function importModels(fdModels, sequelize, name, opt = {}) {
-
-    //type
-    let type = get(opt, 'type')
-    if (type !== 'js' && type !== 'json') {
-        type = 'js'
-    }
-
-    //sync
-    let sync = get(opt, 'sync')
-    if (!isBoolean(sync)) {
-        sync = false
-    }
-
-    //pm
-    let pm = genPm()
-
-    //file
-    let file = `${name}.${type}`
-
-    //fparent
-    let fparent = path.resolve(fdModels) + path.sep
-
-    //fn
-    let fn = fparent + file
-    // console.log('fn', fn)
-
-    //modifyModel
-    try {
-        modifyModel(fn, { type })
-    }
-    catch (err) {
-        pm.reject(err)
-        return pm
-    }
-
-    //import
-    let model
-    try {
-        if (type === 'js') {
-            model = readJsModel(fn, sequelize)
-        }
-        else if (type === 'json') {
-            model = readJsonModel(fn, sequelize)
-        }
-    }
-    catch (err) {
-        pm.reject(err)
-        return pm
-    }
-
-    //sync
-    try {
-        if (sync) {
-            await model.sync() //{ force: true }
-        }
-    }
-    catch (err) {
-        pm.reject(err)
-        return pm
-    }
-
-    //models
-    let models = {}
-    try {
-        models[model.name] = model
-    }
-    catch (err) {
-        pm.reject(err)
-        return pm
-    }
-
-    //resolve
-    pm.resolve(models)
-
-    return pm
-}
-
-
-export default importModels
+import genPm from 'wsemi/src/genPm.mjs'
+import requireModel from './requireModel.js'
+
+
+//匯入資料表設定檔(models)
+//
+//model內之id欄位須為主鍵, 否則sequelize拒絕匯入(model.js: A column called 'id' was added ... but not marked with 'primaryKey: true')
+//原版以modifyModel於[每一次]匯入時無條件重寫呼叫端之model原始檔(逐行trim、刪空行並改為LF)以補上主鍵設定,
+//而本套件每次操作(含select、selectByPk)皆匯入一次, 故讀取函數亦改變可被觀察之狀態(規格T9),
+//且多行程併發時一方正截斷檔案而另一方讀取, 即讀到空內容並寫回空檔而[永久損毀](已實機重現: 4行程併發, 4/4輪model檔被截為0位元組)
+//
+//本版改於記憶體內補上主鍵設定, 一律不寫model檔:
+//  js格式於呼叫model之定義函數期間暫時包裝sequelize.define, 於定義前補上id之primaryKey
+//  json格式於解析後、define前補上
+
+
+/**
+ * 令欄位定義之id為主鍵, 不改動傳入之物件
+ * 註: 僅於model完全沒有主鍵設定而有id欄時補上(sequelize於此情形拒絕匯入);
+ * model已有其他主鍵時不改動, 否則成為(既有主鍵, id)之複合主鍵而使主鍵去重失效(原版modifyModel有此缺陷)
+ *
+ * @ignore
+ * @param {Object} attrs 輸入欄位定義物件
+ * @returns {Object} 回傳欄位定義物件
+ */
+function patchIdPk(attrs) {
+
+    //check
+    if (!attrs || !Object.prototype.hasOwnProperty.call(attrs, 'id')) {
+        return attrs
+    }
+
+    //check, 已有任一主鍵設定者不改動
+    let hasPk = Object.keys(attrs).some((k) => get(attrs[k], 'primaryKey') === true)
+    if (hasPk) {
+        return attrs
+    }
+
+    //id
+    let id = attrs.id
+
+    //idNew, id可為欄位設定物件或直接為型別
+    let idNew = Object.prototype.toString.call(id) === '[object Object]' && get(id, 'type') !== undefined
+        ? { ...id, primaryKey: true }
+        : { type: id, primaryKey: true }
+
+    return { ...attrs, id: idNew }
+}
+
+
+/**
+ * 讀取js格式之model
+ * 註: 於呼叫model之定義函數期間暫時以實例自有屬性包裝define, 結束後刪除該屬性即回復原型上之define
+ *
+ * @ignore
+ */
+function readJsModel(fn, sequelize) {
+    let define = sequelize.define
+    sequelize.define = function(name, attrs, options) {
+        return define.call(sequelize, name, patchIdPk(attrs), options)
+    }
+    try {
+        return requireModel(fn, sequelize, Sequelize.DataTypes)
+    }
+    finally {
+        delete sequelize.define
+    }
+}
+
+
+/**
+ * 讀取json格式之model
+ *
+ * @ignore
+ */
+function readJsonModel(fn, sequelize) {
+
+    //s
+    let j = fs.readFileSync(fn, 'utf8')
+    let s = JSON5.parse(j)
+
+    //抽換DataTypes, 例如將'DataTypes.TEXT'改為DataTypes.TEXT
+    each(s.fields, (v) => {
+        v.type = get(Sequelize, v.type, null)
+    })
+
+    //model, 使用define產生model, 定義前於記憶體內補上id之主鍵設定
+    let model = sequelize.define(s.table, patchIdPk(s.fields), s.options)
+
+    return model
+}
+
+
+/**
+ * 匯入資料表設定檔
+ *
+ * 註: 不寫入model檔, id之主鍵設定於記憶體內補上
+ *
+ * @param {String} fdModels 輸入models所在資料夾字串
+ * @param {Object} sequelize 輸入sequelize實例
+ * @param {String} name 輸入資料表名稱字串
+ * @param {Object} [opt={}] 輸入設定物件
+ * @param {String} [opt.type='js'] 輸入資料表設定檔類型字串，可有'js'、'json'
+ * @param {Boolean} [opt.sync=false] 輸入是否將models資料同步至資料庫
+ * @returns {Promise} 回傳Promise，resolve回傳models物件，reject回傳錯誤訊息
+ */
+async function importModels(fdModels, sequelize, name, opt = {}) {
+
+    //type
+    let type = get(opt, 'type')
+    if (type !== 'js' && type !== 'json') {
+        type = 'js'
+    }
+
+    //sync
+    let sync = get(opt, 'sync')
+    if (!isBoolean(sync)) {
+        sync = false
+    }
+
+    //pm
+    let pm = genPm()
+
+    //file
+    let file = `${name}.${type}`
+
+    //fparent
+    let fparent = path.resolve(fdModels) + path.sep
+
+    //fn
+    let fn = fparent + file
+
+    //import
+    let model
+    try {
+        if (type === 'js') {
+            model = readJsModel(fn, sequelize)
+        }
+        else if (type === 'json') {
+            model = readJsonModel(fn, sequelize)
+        }
+    }
+    catch (err) {
+        pm.reject(err)
+        return pm
+    }
+
+    //sync
+    try {
+        if (sync) {
+            await model.sync() //{ force: true }
+        }
+    }
+    catch (err) {
+        pm.reject(err)
+        return pm
+    }
+
+    //models
+    let models = {}
+    try {
+        models[model.name] = model
+    }
+    catch (err) {
+        pm.reject(err)
+        return pm
+    }
+
+    //resolve
+    pm.resolve(models)
+
+    return pm
+}
+
+
+export default importModels

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之前發出`)
+        }
+    })
+
+})