node-easywechat 3.7.1 → 3.7.3

package/CHANGELOG.md

@@ -1,6 +1,14 @@
 # CHANGELOG
 
 
+## v3.7.3 (2024-07-26)
+
+- Fix: 修复各模块获取服务端消息时，未能获取最新请求导致解密异常的问题。(#88)
+
+## v3.7.2 (2024-07-22)
+
+- Fix: 补充公众号和小程序服务端缺失的获取解密消息的方法，并优化其它模块该方法的逻辑；(#86)
+
 ## v3.7.1 (2024-06-07)
 
 - Fix: 调整ts编译目标版本为ES2020 (#79)

package/README.md

@@ -177,13 +177,17 @@ let data = response.toObject();
   // 商户号
   mch_id: '',
   // 商户证书路径
-  certificate: '',
+  certificate: '/path/to/apiclient_cert.pem',
   // 商户证书私钥路径
-  private_key: '',
+  private_key: '/path/to/apiclient_key.pem',
   // 平台证书（v3接口需要）
   // 持路径列表或者PublicKey对象列表或者，以serial_no为key，证书内容或PublicKey对象为value的对象
   // 下载工具：https://github.com/wechatpay-apiv3/CertificateDownloader
-  platform_certs: '',
+  // 从 3.5.15 版本开始，node-easywechat 会自动下载并缓存平台证书，开发者可以不再配置该参数，当然配置也还是可以的。
+  platform_certs: [
+    '/path/to/platform_cert_1.pem',
+    '/path/to/platform_cert_2.pem',
+  ],
   // v3 API密钥
   secret_key: '',
   // v2 API密钥
@@ -288,7 +292,7 @@ client.setLogger((...args) => {
 
 #### 缓存模块
 
-框架默认使用文件缓存读取到的 `access_token` 等值，如需要改用其他缓存方式（如：redis），请实现接口 `CacheInterface` 并通过 `app.setCacher` 方法进行模块替换。
+框架默认使用文件缓存读取到的 `access_token` 等值，如需要改用其他缓存方式（如：redis），请实现接口 `CacheInterface` 并通过 `app.setCache` 方法进行模块替换。
 
 ```js
 const { OfficialAccount, CacheInterface } = require('node-easywechat');
@@ -333,7 +337,7 @@ let app = new OfficialAccount({
 });
 
 // 替换缓存实例
-app.setCacher(new RedisCacher(new Redis));
+app.setCache(new RedisCacher(new Redis));
 ```
 
 #### 请求模块

package/dist/Core/Http/ServerRequest.js

@@ -26,6 +26,7 @@ class ServerRequest {
             .withProtocolVersion(version)
             .withQueryParams((0, url_1.parse)(url, true).query || {});
         if (body) {
+            this.parsedBody = {};
             this.withBody(body);
         }
     }

package/dist/OfficialAccount/Server.d.ts

@@ -33,7 +33,13 @@ declare class Server extends ServerInterface {
      * @returns
      */
     getRequestMessage(request?: ServerRequestInterface): Promise<Message>;
-    protected decryptRequestMessage(query: Record<string, any>): ServerHandlerClosure<Message>;
+    protected decryptRequestMessage(): ServerHandlerClosure<Message>;
+    /**
+     * 获取解密后的消息
+     * @param request 未设置该参数时，则从当前服务端收到的请求中获取
+     * @returns
+     */
+    getDecryptedMessage(request?: ServerRequestInterface): Promise<import("../Core/Message")>;
 }
 interface Server {
     /**

package/dist/OfficialAccount/Server.js

@@ -16,14 +16,14 @@ class Server extends ServerInterface_1.default {
      * @returns
      */
     async serve() {
-        let echostr = this.request.getQueryParams()['echostr'] || '';
+        let query = this.request.getQueryParams();
+        let echostr = query['echostr'] || '';
         if (!!echostr) {
             return new Response_1.default(200, { 'Content-Type': 'text/html' }, echostr);
         }
         let message = await this.getRequestMessage(this.request);
-        let query = this.request.getQueryParams();
         if (this.encryptor && query['msg_signature']) {
-            this.prepend(this.decryptRequestMessage(query));
+            this.prepend(this.decryptRequestMessage());
         }
         let response = await this.handle(new Response_1.default(200, {}, 'success'), message);
         if (!(response instanceof Response_1.default)) {
@@ -64,14 +64,27 @@ class Server extends ServerInterface_1.default {
     getRequestMessage(request = null) {
         return Message_1.default.createFromRequest(request || this.request);
     }
-    decryptRequestMessage(query) {
+    decryptRequestMessage() {
         return async (message, next) => {
-            if (!this.encryptor)
-                return null;
-            await this.decryptMessage(message, this.encryptor, query['msg_signature'] || '', query['timestamp'] || '', query['nonce'] || '');
+            let query = this.request.getQueryParams();
+            message = await this.decryptMessage(message, this.encryptor, query['msg_signature'] || '', query['timestamp'] || '', query['nonce'] || '');
             return next(message);
         };
     }
+    /**
+     * 获取解密后的消息
+     * @param request 未设置该参数时，则从当前服务端收到的请求中获取
+     * @returns
+     */
+    async getDecryptedMessage(request = null) {
+        request = request ?? this.request;
+        let message = await this.getRequestMessage(request);
+        let query = request.getQueryParams();
+        if (!this.encryptor || !query['msg_signature']) {
+            return message;
+        }
+        return await this.decryptMessage(message, this.encryptor, query['msg_signature'] ?? '', query['timestamp'] ?? '', query['nonce'] ?? '');
+    }
 }
 ;
 module.exports = Server;

package/dist/OpenPlatform/Server.js

@@ -17,12 +17,15 @@ class Server extends ServerInterface_1.default {
      * @returns
      */
     async serve() {
-        let echostr = this.request.getQueryParams()['echostr'] || '';
+        let query = this.request.getQueryParams();
+        let echostr = query['echostr'] || '';
         if (!!echostr) {
             return new Response_1.default(200, { 'Content-Type': 'text/html' }, echostr);
         }
         let message = await this.getRequestMessage(this.request);
-        this.prepend(this.decryptRequestMessage());
+        if (this.encryptor && query['msg_signature']) {
+            this.prepend(this.decryptRequestMessage());
+        }
         let response = await this.handle(new Response_1.default(200, {}, 'success'), message);
         if (!(response instanceof Response_1.default)) {
             response = await this.transformToReply(response, message, this.encryptor);
@@ -94,9 +97,9 @@ class Server extends ServerInterface_1.default {
         });
     }
     decryptRequestMessage() {
-        let query = this.request.getQueryParams();
         return async (message, next) => {
-            await this.decryptMessage(message, this.encryptor, query['msg_signature'] || '', query['timestamp'] || '', query['nonce'] || '');
+            let query = this.request.getQueryParams();
+            message = await this.decryptMessage(message, this.encryptor, query['msg_signature'] || '', query['timestamp'] || '', query['nonce'] || '');
             return next(message);
         };
     }
@@ -114,9 +117,8 @@ class Server extends ServerInterface_1.default {
      * @returns
      */
     async getDecryptedMessage(request = null) {
-        if (!request)
-            request = this.request;
-        let message = await Message_1.default.createFromRequest(request);
+        request = request ?? this.request;
+        let message = await this.getRequestMessage(request);
         let query = request.getQueryParams();
         return this.decryptMessage(message, this.encryptor, query['msg_signature'] || '', query['timestamp'] || '', query['nonce'] || '');
     }

package/dist/OpenWork/Server.d.ts

@@ -92,7 +92,7 @@ declare class Server extends ServerInterface {
      * @returns
      */
     getRequestMessage(request?: ServerRequestInterface): Promise<Message>;
-    protected decryptRequestMessage(query: Record<string, any>): ServerHandlerClosure<Message>;
+    protected decryptRequestMessage(): ServerHandlerClosure<Message>;
     /**
      * 获取解密后的消息
      * @param request 未设置该参数时，则从当前服务端收到的请求中获取

package/dist/OpenWork/Server.js

@@ -24,7 +24,9 @@ class Server extends ServerInterface_1.default {
             return new Response_1.default(200, { 'Content-Type': 'text/html' }, echostr);
         }
         let message = await this.getRequestMessage(this.request);
-        this.prepend(this.decryptRequestMessage(query));
+        if (this.encryptor && query['msg_signature']) {
+            this.prepend(this.decryptRequestMessage());
+        }
         let response = await this.handle(new Response_1.default(200, {}, 'success'), message);
         if (!(response instanceof Response_1.default)) {
             response = await this.transformToReply(response, message, this.encryptor);
@@ -174,11 +176,10 @@ class Server extends ServerInterface_1.default {
     getRequestMessage(request = null) {
         return Message_1.default.createFromRequest(request ?? this.request);
     }
-    decryptRequestMessage(query) {
+    decryptRequestMessage() {
         return async (message, next) => {
-            if (!this.encryptor)
-                return null;
-            await this.decryptMessage(message, this.encryptor, query['msg_signature'] ?? '', query['timestamp'] ?? '', query['nonce'] ?? '');
+            let query = this.request.getQueryParams();
+            message = await this.decryptMessage(message, this.encryptor, query['msg_signature'] ?? '', query['timestamp'] ?? '', query['nonce'] ?? '');
             return next(message);
         };
     }
@@ -191,6 +192,9 @@ class Server extends ServerInterface_1.default {
         request = request ?? this.request;
         let message = await this.getRequestMessage(request);
         let query = request.getQueryParams();
+        if (!this.encryptor || !query['msg_signature']) {
+            return message;
+        }
         return await this.decryptMessage(message, this.encryptor, query['msg_signature'] ?? '', query['timestamp'] ?? '', query['nonce'] ?? '');
     }
 }

package/dist/Work/Server.d.ts

@@ -79,7 +79,7 @@ declare class Server extends ServerInterface {
      */
     getRequestMessage(request?: ServerRequestInterface): Promise<Message>;
     protected validateUrl(): (message: Message, next: ServerHandlerClosure) => Promise<Response>;
-    protected decryptRequestMessage(query: Record<string, any>): ServerHandlerClosure;
+    protected decryptRequestMessage(): ServerHandlerClosure;
     /**
      * 获取解密后的消息
      * @param request 未设置该参数时，则从当前服务端收到的请求中获取

package/dist/Work/Server.js

@@ -22,7 +22,9 @@ class Server extends ServerInterface_1.default {
             return new Response_1.default(200, { 'Content-Type': 'text/html' }, echostr);
         }
         let message = await this.getRequestMessage(this.request);
-        this.prepend(this.decryptRequestMessage(query));
+        if (this.encryptor && query['msg_signature']) {
+            this.prepend(this.decryptRequestMessage());
+        }
         let response = await this.handle(new Response_1.default(200, {}, 'SUCCESS'), message);
         if (!(response instanceof Response_1.default)) {
             response = await this.transformToReply(response, message, this.encryptor);
@@ -149,11 +151,10 @@ class Server extends ServerInterface_1.default {
             return new Response_1.default(200, { 'Content-Type': 'text/html' }, echostr);
         };
     }
-    decryptRequestMessage(query) {
+    decryptRequestMessage() {
         return async (message, next) => {
-            if (!this.encryptor)
-                return null;
-            await this.decryptMessage(message, this.encryptor, query['msg_signature'] ?? '', query['timestamp'] ?? '', query['nonce'] ?? '');
+            let query = this.request.getQueryParams();
+            message = await this.decryptMessage(message, this.encryptor, query['msg_signature'] ?? '', query['timestamp'] ?? '', query['nonce'] ?? '');
             return next(message);
         };
     }
@@ -166,6 +167,9 @@ class Server extends ServerInterface_1.default {
         request = request ?? this.request;
         let message = await this.getRequestMessage(request);
         let query = request.getQueryParams();
+        if (!this.encryptor || !query['msg_signature']) {
+            return message;
+        }
         return await this.decryptMessage(message, this.encryptor, query['msg_signature'] ?? '', query['timestamp'] ?? '', query['nonce'] ?? '');
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-easywechat",
-  "version": "3.7.1",
+  "version": "3.7.3",
   "description": "EasyWechat SDK for Node.js (NOT OFFICIAL)",
   "main": "dist/index.js",
   "scripts": {