merge master (#20)

* 0.45.3 * 0.45.4 * upgrade puppet to use async-map-like memory-card * upgrade puppet * 0.45.5 * build onbuild docker image * 0.45.6 * test for onbuild home dir * 0.45.7 * deploy wechaty/onbuld * fix test for both wechaty & /bot * 0.45.8 * publish to wechaty/wechatyh * 0.45.9 * build with onbuld * 0.45.10 * rename zixia/wechaty -> wechaty/wechaty * 0.45.11 * fix typo * 0.45.12 * fix onbuild npm run * 0.45.13 * update official example * Update README.md * fix asscessory tests, and protect user class constructor from public to private * Increase MaxListener for Wechaty * 0.45.14 * add plugin uninstaller logic * 0.45.15 * fix race condition for plugin uninstallation * 0.45.16 * template clean * 0.45.17 * upgrade puppet * 0.46.0 * 0.46.1 * add new puppet for official account * 0.46.2 * Wechaty is a Conversational SDK for Chatbot Makers * fix bio * 0.46.3 * clean log message * 0.46.4 * upgrade hostie * 0.45.6 * 0.46.5 * 0.47.0 * 0.47.1 * support onbuild:version * 0.47.2 * use artifact image name * 0.47.3 * clean version & tag * 0.47.4 * 0.47.5 * fix hostie start bug * 0.47.6 * clean * 0.46.5 * 0.47.7 * add svg logos * use wechaty.js.org host * 0.47.7 * 0.47.8 * update * 0.47.9 * use docker for changelog * 0.47.10 * update changelog * 0.47.11 * use wechaty.js.org/qrcode/ to replace wechaty.github.io/qrcode/ * 0.47.12 * Update README.md * feat: add scoped wxwork puppet into puppet config (wechaty#2043) * add scoped wxwork puppet into puppet config * skip install scoped puppet * 0.47.13 * add phone method in contact class (wechaty#2039) * add phone method in contact class * 0.47.13 * 0.47.14 * update wechaty-puppet version * add jsdoc for contact.phone * use puppet.dirtyPayload (wechaty/puppet-service#43) * 0.47.15 * fix dirty exception * 0.47.16 * TODO: implement the dirty logic (wechaty/puppet-service#43) * 0.47.17 * TODO: implement the dirty logic (wechaty/puppet-service#43) * 0.47.18 * implement the dirty logic (wechaty/puppet-service#43) * 0.47.19 * clean * 0.47.20 * remove deprecated methods (wechaty#2049) * 0.47.21 * Upgrade to TypeScript 4.0! * 0.47.22 * feat: add more methods into contact class (wechaty#2048) * add more methods into contact class * fix code with new wechaty-puppet * 0.47.21 * 0.47.23 * throw a nice error message when we call user module before start wechaty * 0.47.24 * 0.48.0 (wechaty#2050) * bump hostie version to be the stable one (wechaty#2051) * bump hostie version to be the stable one * 0.48.1 * link images to wechaty.js.org * update links * 0.48.2 * update jsdocs * 0.48.3 * add gitter puppet * 0.48.4 * fix typo * 0.48.5 * add location user module * 0.47.25 * 0.48.6 * clean * 0.48.7 * add telegram channel for wechaty * 0.48.8 * add bibtex cite code * 0.48.9 * add star history badge * 0.48.10 * Split to trunks when making requests of room.findAll() and room.ready() (wechaty#2067) * add pagination on room.findAll() and room.ready() * 0.48.11 * fix wechaty#2073 (wechaty#2074) * fix wechaty#2073 * 0.48.12 * 0.48.13 * Bump minor 49 (wechaty#2078) * 0.49.0 * update hostie version to take advantage of the new stream grpc methods * fix io client qrcode by encodeURIComponent * 0.48.11 * upgrade deps * 0.49.1 * upgrade puppet to v0.33 * 0.49.2 * 0.49.3 * 0.49.4 * fix typos * 0.49.5 * clean * Update README.md * add credit link * fix typo * upgrade json-rpc-peer to v0.17 * 0.49.7 * 0.49.8 * Update Dockerfile (wechaty#2079) 按照 wechaty#1986 的方法用docker创建Hostie Token时，docker端报错。加入libxtst6库后可以完美运行。 * 0.50.0 * 0.50.1 * clean scan payload after login * 0.50.2 * enable io sync message botie support * 0.50.3 * use source for botie payload * 0.50.4 * add whatsapp to official puppet names (wechaty/puppet-whatsapp#1) * 0.50.5 * use a helper function for better FileBox instance check (wechaty/puppet-service#99) * 0.50.6 * loost Puppet instance type checking (wechaty#2024) * 0.50.7 * create looseInstanceOfClass (wechaty#2090) (wechaty#2091) * create looseInstanceOfClass (wechaty#2090) * 0.50.8 * 0.51.0 * 0.51.1 * fix file-box * fix file-box * 0.51.2 * rename from -> talker (wechaty#2094) * 0.51.3 * add gitter & deprecate padplus * strict typing check for typescript v4 * 0.51.4 * Update contact.ts (wechaty#2095) fix: return payload friend * rename from() to talker() from message * 0.51.5 * Update README.md * Update README.md * Update README.md * Update README.md * add wechaty-puppet-padlocal to the puppet config (wechaty#2102) * 0.51.6 * 0.51.7 * remove padplus from smoke testing (wechaty#2087) * 0.51.8 * add url link unit test * 0.51.9 * add strict check * clean * 0.51.10 * Update room-invitation.ts (wechaty#2104) topic() returns a Promise<string> instead of Promise<Contact>. The document is incorrect. * add puppet event to emitter typing * 0.51.11 * add puppet to wechaty event names * Working on RxJS related deps * 0.53.1 * Rename NODE_AUTH_TOKEN -> NPM_TOKEN * Use Debian instead of Ubuntu for our Docker (wechaty#2114) * 0.53.2 * Update Node.js v12 -> v14 (wechaty#2115) * 0.53.3 * RPA SDK * RPA SDK * use cache to speed up github action * use cache for node & npm * 0.53.4 * node v15 not support grpc yet * 0.53.5 * Update package.json * Upgrade pkg-jq * use better cache for gh actions * 0.53.6 * 0.53.7 * Update README.md (wechaty#2118) change puppet service provider link * use naive hashFile * 0.53.8 * fix typo * 0.53.9 * rename wechaty-puppet-hostie -> wechaty-puppet-service (wechaty#2124) * add deprecate warning message for WECHATY_HOSTIE_PORT (wechaty#2122) * 0.55.1 * 0.56.0 * 0.56.1 * Changelog for v0.56 * compatible with wechaty-puppet-hostie module name (wechaty/puppet-service#118) * 0.56.2 * use node v12 instead of v14 in docker image for maximum compatibility. (e.g. huggingface/tokenizers#603) * 0.56.3 * 0.57.0 * default puppet: service (wechaty#2127) * 0.57.1 * upgrade wechaty-puppet to v0.34 * 0.57.2 * change default puppet to puppet-service * 0.57.3 * upgrade deps * 0.57.4 * fix docker deploy for branches * 0.57.5 * pass custom server host to io server (wechaty#2138) * pass custom server host to io server * fix test * modify code according to comments * 0.57.6 * support puppet lark (wechaty/puppet-lark#4) * 0.57.7 * clean * 0.57.8 * use npm-run-all * 0.57.9 * specific puppet versions * 0.57.10 * upgrade upppeteer version * 0.57.11 Co-authored-by: Huan LI (李卓桓) <zixia@zixia.net> Co-authored-by: Yuan Gao <wind.memory.cn@gmail.com> Co-authored-by: 陶鑫 <i@yesxin.com> Co-authored-by: lijiarui <ruiruibupt@gmail.com> Co-authored-by: profthecopyright <54515051+profthecopyright@users.noreply.github.com>
su-chang · Feb 22, 2021 · b72d4b0 · b72d4b0
1 parent a4ca72a
commit b72d4b0
Show file tree

Hide file tree

Showing 117 changed files with 4,720 additions and 2,221 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -13,7 +13,7 @@ jobs:
       - run:
           name: Install Node.js
           command: |
-            curl --silent --location https://rpm.nodesource.com/setup_10.x | sudo bash -
+            curl --silent --location https://rpm.nodesource.com/setup_12.x | sudo bash -
             sudo yum -y install nodejs
 
       - run:

diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -2,5 +2,4 @@
 # https://help.github.com/articles/about-codeowners/
 #
 
-/docs/                                @lijiarui @hczhcz @TingYinHelen @ax4
-/examples/                            @Gcaufy @hczhcz
+/ @wechaty/contributors
diff --git a/.github/ISSUE_TEMPLATE/wechaty-bug-report.md b/.github/ISSUE_TEMPLATE/wechaty-bug-report.md
@@ -1,61 +1,73 @@
 ---
 name: Wechaty Bug Report
 about: Create a bug report for a bug you found in wechaty
-
 ---
 
-> Important：Please file the issue follow the template, or we won't help you to solve the problem.
-
+> Important：Please file the issue follow the template, or we won't be able to help you to solve the problem.
 
 ## 0. Report Issue Guide
 
 1. Please run the following command and check whether the problem has been fixed：
-```
-rm -rf package-lock.json
-rm -rf node_modules
-npm install
-```
 
-2. Please search in [FAQ List](https://docs.chatie.io/faq) first, and make sure your problem has not been solved before.
+    ```sh
+    rm -rf package-lock.json
+    rm -rf node_modules
+    npm install
+    ```
+
+2. Please search in [FAQ List](https://wechaty.js.org/faq) first, and make sure your problem has not been solved before.
 
 3. Please search in the issue first, and make sure your problem had not been reported before
 
 ## 1. Versions
-- What is your wechaty version?
+
+> What is your wechaty version?
+
 Answer:
 
-- Which puppet are you using for wechaty? (padchat/puppeteer/padpro/...)
+> Which puppet are you using for wechaty? (puppeteer/padlocal/service...)
+
 Answer:
 
-- What is your wechaty-puppet-XXX（padchat/puppeteer/） version?
+> What is your wechaty-puppet-XXX（padchat/puppeteer/） version?
+
 Answer:
 
-- What is your node version? (run `node --version`)
+> What is your node version? (run `node --version`)
+
 Answer:
 
-- What os are you using
+> What os are you using
+
 Answer:
 
 ## 2. Describe the bug
-Give a clear and concise description of what the bug is.
+
+> Give a clear and concise description of what the bug is.
 
 ## 3. To Reproduce
-This part is very important: if you can not provide any reproduce steps, then the problem will be very hard to be recognized.
+
+> This part is very important: if you can not provide any reproduce steps, then the problem will be very hard to be recognized.
+
+**[How to create a Minimal, Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example)**
 
 Steps to reproduce the behavior:
+
 1. run '...'
 2. ...
 3. ...
 
 ## 4. Expected behavior
-Give a clear and concise description of what you expected to happen.
+
+> Give a clear and concise description of what you expected to happen.
 
 ## 5. Actual behavior
-If applicable, add screenshots to help explain your problem. But do not paste log screenshots here.
 
+> If applicable, add screenshots to help explain your problem. But do not paste log screenshots here.
 
 ## 6. Full Output Logs
-Set env `WECHATY_LOG=silly` in order to set log level to silly, then we can get the full log (If you dosen't set log env, log level is info as default, we cannot get the full log)
+
+> Set env `WECHATY_LOG=silly` in order to set log level to silly, then we can get the full log (If you dosen't set log env, log level is info as default, we cannot get the full log)
 
 **We need full log instead of log screenshot or log fragments!**
 
@@ -67,14 +79,12 @@ Show Logs
 ```shell
 $ WECHATY_LOG=silly node yourbot.js
 
-Question: Paste your FULL(DO NOT ONLY PROVIDE FRAGMENTS) log messages
-Answer:
+-> PASTE YOUR FULL(DO NOT ONLY PROVIDE FRAGMENTS) LOG MESSAGES HERE
 
 ```
 
 </details>
 
 ## 7. Additional context
-Add any other context about the problem here.
 
-[bug]
+> Add any other context about the problem here.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,32 +1,12 @@
-## I'm submitting a...
-
-```
-[ ] Bug Fix
-[ ] Feature
-[ ] Other (Refactoring, Added tests, Documentation, ...)
-```
-
 ## Checklist
 
 - [ ] Commit Messages follow the [Conventional Commits](https://conventionalcommits.org/) pattern
   - A feature commit message is prefixed "feat:"
   - A bugfix commit message is prefixed "fix:"
 - [ ] Tests for the changes have been added
-
+- [ ] CI has been passed. (GitHub actions all turns green)
+- [ ] SLA has been signed
 
 ## Description
 
-_please describe the changes that you are making_
-
-_for features, please describe how to use the new feature_
-
-_please include a reference to an existing issue, if applicable_
-
-
-## Does this PR introduce a breaking change?
-
-```
-[ ] Yes
-[ ] No
-```
-
+> please describe the changes that you are making, with the related issue number.
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
@@ -21,23 +21,17 @@ jobs:
       - run: ./scripts/docker.sh build
       - run: ./scripts/docker.sh test
 
+  # https://www.prestonlamb.com/blog/creating-a-docker-image-with-github-actions
   publish:
-    if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/v'))
     name: Publish
     needs: [build]
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/v'))
     runs-on: ubuntu-latest
     steps:
-      - name: Check Branch
-        id: check-branch
-        run: |
-          if [[ ${{ github.ref }} =~ ^refs/heads/(master|v[0-9]+\.[0-9]+.*)$ ]]; then
-              echo ::set-output name=match::true
-          fi  # See: https://stackoverflow.com/a/58869470/1123955
-      - name: Is A Publish Branch
-        if: steps.check-branch.outputs.match == 'true'
-        run: curl -X POST -d '{"from":"GitHub Action"}' "$DOCKER_REBUILD_URL"
-        env:
-          DOCKER_REBUILD_URL: ${{ secrets.DOCKER_REBUILD_URL }}
-      - name: Is Not A Publish Branch
-        if: steps.check-branch.outputs.match != 'true'
-        run: echo 'Not A Publish Branch'
+      - uses: actions/checkout@v2
+      - name: Build the Docker image
+        run: ./scripts/docker.sh build
+      - name: Login to DockerHub Registry
+        run: echo ${{ secrets.DOCKER_PERSONAL_ACCESS_TOKEN }} | docker login -u zixia --password-stdin
+      - name: Deploy to Docker Hub
+        run: ./scripts/docker.sh deploy
diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
@@ -0,0 +1,37 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-latest]
+        node-version: [14]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/cache@v2
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-wechaty-${{ hashFiles('**/package.json') }}
+        restore-keys: |
+          ${{ runner.os }}-wechaty-
+
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install
+    - run: npm run build --if-present
+    - run: npm test
+      env:
+        CI: true
diff --git a/.github/workflows/npm.yml b/.github/workflows/npm.yml
@@ -5,19 +5,20 @@ on: [push, pull_request]
 jobs:
   build:
     name: Build
-    strategy:
-      matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
-        node: [12, 13]
-
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+      - uses: actions/cache@v2
         with:
-          node-version: ${{ matrix.node-version }}
+          path: ~/.npm
+          key: ${{ runner.os }}-wechaty-${{ hashFiles('**/package.json') }}
+          restore-keys: |
+            ${{ runner.os }}-wechaty-
 
+      - name: Use Node.js 15
+        uses: actions/setup-node@v2
+        with:
+          node-version: 15
       - name: Install Dependencies
         run: npm install
 
@@ -30,9 +31,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-wechaty-${{ hashFiles('**/package.json') }}
+          restore-keys: |
+            ${{ runner.os }}-wechaty-
+
+      - uses: actions/setup-node@v2
         with:
-          node-version: 13
+          node-version: 15
       - run: npm install
       - run: ./scripts/generate-version.sh
       - run: ./scripts/npm-pack-testing.sh
@@ -46,9 +54,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-wechaty-${{ hashFiles('**/package.json') }}
+          restore-keys: |
+            ${{ runner.os }}-wechaty-
+
+      - uses: actions/setup-node@v2
         with:
-          node-version: 13
+          node-version: 15
           registry-url: https://registry.npmjs.org/
       - run: npm install
       - run: ./scripts/generate-version.sh
@@ -63,9 +78,15 @@ jobs:
           fi  # See: https://stackoverflow.com/a/58869470/1123955
       - name: Is A Publish Branch
         if: steps.check-branch.outputs.match == 'true'
-        run: npm publish
+        run: |
+          NAME=$(npx pkg-jq -r .name)
+          VERSION=$(npx pkg-jq -r .version)
+          if npx version-exists "$NAME" "$VERSION"
+          then echo "$NAME@$VERSION exists on NPM, skipped."
+          else npm publish
+          fi
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.NODE_AUTH_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
       - name: Is Not A Publish Branch
         if: steps.check-branch.outputs.match != 'true'
         run: echo 'Not A Publish Branch'
diff --git a/.gitignore b/.gitignore
@@ -57,7 +57,7 @@ yarn.lock
 .yarn-cache/
 .v8flags.*
 
-# why? forgot... 2017-05-18 by zixia
+# why? forgot... 2017-05-18 by huan
 /tests/fixtures/docker/package.json
 
 tags

diff --git a/.npmignore b/.npmignore
@@ -0,0 +1 @@
+docs/
diff --git a/.nycrc b/.nycrc
@@ -0,0 +1,3 @@
+{
+    "reporter": ["lcov", "text-summary"]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -70,4 +70,30 @@
     "javascript",
     "typescript",
   ],
+  "cSpell.words": [
+    "Gitter",
+    "Wechaty",
+    "appid",
+    "botie",
+    "huan",
+    "ioscat",
+    "ipad",
+    "lcov",
+    "lijiarui",
+    "logonoff",
+    "padchat",
+    "padplus",
+    "padpro",
+    "pagepath",
+    "portfinder",
+    "qrcode",
+    "removee",
+    "ruirui",
+    "thumbnailurl",
+    "wechat",
+    "weixin",
+    "wxwork",
+    "zbeekman",
+    "zixia"
+  ],
 }
diff --git a/AUTHORS b/AUTHORS
@@ -1,2 +1,2 @@
-Huan  <zixia@zixia.net>       https://github.com/zixia
+Huan  <zixia@zixia.net>       https://github.com/huan
 Rui   <ruiruibupt@gmail.com>  https://github.com/lijiarui