Merge branch 'master' of https://github.com/wechat-miniprogram/miniprogram-simulate

JuneAndGreen · JuneAndGreen · commit 944bd11b0c71 · 2022-12-28T16:43:22.000+08:00
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,2 @@
+# Owner
+* @JuneAndGreen
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,36 @@
+# Github actions workflow name
+name: CI
+
+# Triggers the workflow on push or pull request events
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  jest_test:
+    name: miniprogram-simulate test with jest
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 16
+    - run: npm install
+    - run: npm run test
+    - run: npm run codecov
+  
+  karma_test:
+    name: miniprogram-simulate test with karma
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 16
+    - run: npm install
+    - run: npm i puppeteer@latest
+    - run: npm run karma
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 # miniprogram-simulate
 
 [![](https://img.shields.io/npm/v/miniprogram-simulate.svg?style=flat)](https://www.npmjs.com/package/miniprogram-simulate)
-[![](https://img.shields.io/travis/wechat-miniprogram/miniprogram-simulate.svg)](https://github.com/wechat-miniprogram/miniprogram-simulate)
-[![](https://img.shields.io/github/license/wechat-miniprogram/miniprogram-simulate.svg)](https://github.com/wechat-miniprogram/miniprogram-simulate)
-[![](https://img.shields.io/codecov/c/github/wechat-miniprogram/miniprogram-simulate.svg)](https://github.com/wechat-miniprogram/miniprogram-simulate)
+[![](https://github.com/wechat-miniprogram/miniprogram-simulate/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/wechat-miniprogram/miniprogram-simulate/actions/workflows/ci.yml?query=branch%3Amaster+)
+[![](https://img.shields.io/github/license/wechat-miniprogram/miniprogram-simulate.svg)](https://github.com/wechat-miniprogram/miniprogram-simulate/blob/master/LICENSE)
+[![](https://img.shields.io/codecov/c/github/wechat-miniprogram/miniprogram-simulate.svg)](https://app.codecov.io/gh/wechat-miniprogram/miniprogram-simulate)
 
 ## 介绍
 
diff --git a/build.js b/build.js
diff --git a/docs/api.md b/docs/api.md
@@ -81,7 +81,7 @@ const id2 = simulate.load('/path/to/component', 'custom-comp', {
 | id | String | 可选字段，如果传了此字段，则表明注册为全局组件，其他组件可直接在 template 中使用而无需在 usingComponents 里引入 |
 | tagName | String | 可选字段，指定组件对应的 dom 节点的 tagName，默认取 usingComponents 里的定义或组件自身的 id |
 | template | String | 组件模板，即组件对应的 wxml 内容 |
-| usingComponents | Object | 使用到的自定义组件映射表 |
+| usingComponents | Object | 使用到的自定义组件映射表，子孙组件在进行 usingComponents 处理时，会从此表寻找同名组件进行覆盖处理，支持传入覆盖路径或者组件 id |
 | behaviors | Array<Behavior> | behavior 的用法和小程序类似 |
 | options | Object | 配置对象，支持小程序自定义组件 options 定义段支持的所有字段 |
 | options.classPrefix | String | 组件样式的私有化前缀，默认是空串，即没有前缀 |
diff --git a/docs/update.md b/docs/update.md
@@ -1,5 +1,17 @@
 # 更新日志
 
+## 1.5.6
+
+* storage 系列接口支持存取字符串内容
+
+## 1.5.5
+
+* 修复 global.wx 赋值会覆盖用户模拟的 wx 对象问题
+
+## 1.5.3
+
+* 支持子孙组件的 usingComponents 覆盖
+
 ## 1.5.0
 
 * load 方法支持 compilerOptions 配置
diff --git a/karma.conf.js b/karma.conf.js
@@ -1,6 +1,7 @@
 // Karma configuration
 // Generated on Fri Jan 11 2019 20:11:14 GMT+0800 (CST)
 
+process.env.CHROME_BIN = require('puppeteer').executablePath();
 const path = require('path')
 
 module.exports = function(config) {
@@ -77,12 +78,12 @@ module.exports = function(config) {
 
     // start these browsers
     // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
-    browsers: ['Chrome'],
+    browsers: ['ChromeHeadless'],
 
 
     // Continuous Integration mode
     // if true, Karma captures browsers, runs the tests and exits
-    singleRun: false,
+    singleRun: true,
 
     // Concurrency level
     // how many browser should be started simultaneous
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "miniprogram-simulate",
-  "version": "1.5.2",
+  "version": "1.5.8",
   "description": "tools for miniprogram custom component unit test",
   "main": "index.js",
   "types": "index.d.ts",
@@ -47,14 +47,14 @@
     "eslint-plugin-node": "^7.0.1",
     "eslint-plugin-promise": "^3.8.0",
     "jest": "^26.0.1",
-    "karma": "^3.1.4",
+    "karma": "^6.3.20",
     "karma-chai": "^0.1.0",
-    "karma-chrome-launcher": "^2.2.0",
+    "karma-chrome-launcher": "^3.1.1",
     "karma-dirname-preprocessor": "latest",
     "karma-filemap-preprocessor": "latest",
-    "karma-mocha": "^1.3.0",
-    "karma-webpack": "^3.0.5",
-    "mocha": "^5.2.0",
+    "karma-mocha": "^2.0.1",
+    "karma-webpack": "^4.0.2",
+    "mocha": "^10.0.0",
     "pretty-format": "^26.0.1",
     "webpack": "^4.41.2",
     "webpack-cli": "^3.3.10"
diff --git a/src/api/data.js b/src/api/data.js
@@ -26,7 +26,12 @@ module.exports = {
         _.runInAsync(options, res)
     },
     getStorageSync(key) {
-        return JSON.parse(localStorage.getItem(key))
+        const res = localStorage.getItem(key)
+        try {
+            return JSON.parse(res)
+        } catch (err) {
+            return res
+        }
     },
     getStorageInfo(options) {
         let res = {errMsg: 'getStorageInfo:ok'}
diff --git a/src/api/index.js b/src/api/index.js
@@ -5,6 +5,9 @@ const dataApi = require('./data')
 const openApi = require('./open')
 const _ = require('./utils')
 
+let nextTickQueue = []
+let nextTickTimer = null
+
 module.exports = {
     request: _.mockAsync('request'),
 
@@ -322,4 +325,18 @@ module.exports = {
     createIntersectionObserver(compInst, options) {
         return compInst.createIntersectionObserver(options)
     },
+    nextTick(func) {
+        nextTickQueue.push(func)
+
+        if (nextTickTimer) return
+        nextTickTimer = setTimeout(() => {
+            const funcQueue = nextTickQueue
+            nextTickQueue = []
+            nextTickTimer = null
+
+            for (const func of funcQueue) {
+                if (func) func()
+            }
+        }, 0)
+    },
 }
diff --git a/src/api/open.js b/src/api/open.js
@@ -2,7 +2,7 @@ const _ = require('./utils')
 
 module.exports = {
     getAccountInfoSync: _.mockSync({
-        miniprogram: {appId: 'wx4f4bc4dec97d474b'},
+        miniProgram: {appId: 'wx4f4bc4dec97d474b'},
     }),
     chooseAddress(options = {}) {
         _.runInAsync(options, {
diff --git a/src/definition.js b/src/definition.js
@@ -24,5 +24,6 @@ module.exports = function() {
     })
 
     // 注入 api
-    global.wx = api
+    if (typeof global.wx === 'object') global.wx = Object.assign(api, global.wx)
+    else global.wx = api
 }
diff --git a/src/index.js b/src/index.js
@@ -105,19 +105,20 @@ function register(componentPath, tagName, cache, hasRegisterCache) {
     const rootPath = cache.options.rootPath
     const usingComponents = component.json.usingComponents || {}
     const overrideUsingComponents = cache.options.usingComponents || {}
+    Object.assign(usingComponents, overrideUsingComponents)
     const usingComponentKeys = Object.keys(usingComponents)
     for (let i = 0, len = usingComponentKeys.length; i < len; i++) {
         const key = usingComponentKeys[i]
 
-        if (Object.prototype.hasOwnProperty.call(overrideUsingComponents, key)) continue // 被 override 的跳过
-
         const value = usingComponents[key]
         const usingPath = _.isAbsolute(value) ? path.join(rootPath, value) : path.join(path.dirname(componentPath), value)
-        const id = register(usingPath, key, cache, hasRegisterCache)
-
-        usingComponents[key] = id
+        
+        if (_.readFile(`${usingPath}.json`)) {
+            // 文件路径
+            const id = register(usingPath, key, cache, hasRegisterCache)
+            usingComponents[key] = id
+        }
     }
-    Object.assign(usingComponents, overrideUsingComponents)
 
     // 读取自定义组件的静态内容
     component.wxml = compile.getWxml(componentPath, cache.options)
diff --git a/test/comp11/comp/comp1.js b/test/comp11/comp/comp1.js
@@ -0,0 +1,13 @@
+Component({
+    properties: {
+        prop: {
+            type: String,
+            value: 'comp1.properties'
+        },
+    },
+    methods: {
+        getStr() {
+            return 'comp1'
+        }
+    }
+})
diff --git a/test/comp11/comp/comp1.json b/test/comp11/comp/comp1.json
@@ -0,0 +1,6 @@
+{
+    "component": true,
+    "usingComponents": {
+        "comp2": "12345"
+    }
+}
diff --git a/test/comp11/comp/comp1.wxml b/test/comp11/comp/comp1.wxml
@@ -0,0 +1,2 @@
+<view class="index">{{prop}}</view>
+<comp2 class="comp2" prop="from comp1"></comp2>
diff --git a/test/comp11/comp/comp1.wxss b/test/comp11/comp/comp1.wxss
@@ -0,0 +1,3 @@
+.index {
+  color: yellow;
+}
diff --git a/test/comp11/comp/comp2.js b/test/comp11/comp/comp2.js
@@ -0,0 +1,13 @@
+Component({
+    properties: {
+        prop: {
+            type: String,
+            value: 'comp2.properties'
+        },
+    },
+    methods: {
+        getStr() {
+            return 'comp2'
+        }
+    }
+})
diff --git a/test/comp11/comp/comp2.json b/test/comp11/comp/comp2.json
@@ -0,0 +1,4 @@
+{
+    "component": true,
+    "usingComponents": {}
+}
diff --git a/test/comp11/comp/comp2.wxml b/test/comp11/comp/comp2.wxml
@@ -0,0 +1 @@
+<view class="index">{{prop}}</view>
diff --git a/test/comp11/comp/comp2.wxss b/test/comp11/comp/comp2.wxss
@@ -0,0 +1,3 @@
+.index {
+  color: yellow;
+}
diff --git a/test/comp11/index.js b/test/comp11/index.js
@@ -0,0 +1 @@
+Component({})
diff --git a/test/comp11/index.json b/test/comp11/index.json
@@ -0,0 +1,6 @@
+{
+    "component": true,
+    "usingComponents": {
+        "comp1": "12345"
+    }
+}
diff --git a/test/comp11/index.test.js b/test/comp11/index.test.js
@@ -0,0 +1,54 @@
+const path = require('path')
+const simulate = require('../../index')
+
+function runTest(id) {
+    const comp = simulate.render(id, {prop: 'index.test.properties'})
+
+    const parent = document.createElement('parent-wrapper')
+    comp.attach(parent)
+
+    expect(simulate.match(comp.dom, `
+        <wx-view>root</wx-view>
+        <comp1 class="custom-comp--comp1">
+            <wx-view class="comp1--index">from root</wx-view>
+            <comp2 class="comp1--comp2">
+                <wx-view class="comp2--index">from comp1</wx-view>
+            </comp2>
+        </comp1>
+    `)).toBe(true)
+    expect(comp.querySelector('.comp1').instance.getStr).toBeInstanceOf(Function)
+    expect(comp.querySelector('.comp1').instance.getStr()).toBe('comp1')
+    expect(comp.querySelector('.comp1').querySelector('.comp2').instance.getStr).toBeInstanceOf(Function)
+    expect(comp.querySelector('.comp1').querySelector('.comp2').instance.getStr()).toBe('comp2')
+    expect(comp.dom.tagName).toBe('CUSTOM-COMP')
+}
+
+test('comp11', () => {
+    let comp2Id = simulate.load(path.resolve(__dirname, './comp/comp2'), 'comp2', {
+        rootPath: __dirname,
+    })
+    let id = simulate.load(path.resolve(__dirname, './index'), 'custom-comp', {
+        usingComponents: {
+            comp1: './comp/comp1',
+            comp2: comp2Id,
+        },
+        rootPath: __dirname,
+    })
+    runTest(id)
+
+    jest.resetModules() // https://github.com/facebook/jest/issues/5120
+
+    comp2Id = simulate.load(path.resolve(__dirname, './comp/comp2'), 'comp2', {
+        rootPath: __dirname,
+        compiler: 'simulate',
+    })
+    id = simulate.load(path.resolve(__dirname, './index'), 'custom-comp', {
+        usingComponents: {
+            comp1: './comp/comp1',
+            comp2: comp2Id,
+        },
+        rootPath: __dirname,
+        compiler: 'simulate',
+    })
+    runTest(id)
+})
diff --git a/test/comp11/index.wxml b/test/comp11/index.wxml
@@ -0,0 +1,2 @@
+<view>root</view>
+<comp1 class="comp1" prop="from root"></comp1>
diff --git a/test/comp11/index.wxss b/test/comp11/index.wxss
@@ -0,0 +1,4 @@
+.index {
+  color: green;
+  width: 100rpx;
+}
