chore(release): 0.2.16

CHANGELOG.md

@@ -1,4 +1,35 @@
 # 版本更新日志
+### [0.2.16](http://124.126.16.154:8888/singularity/HyperfDevelopmentKitCore/compare/v0.2.15...v0.2.16) (2023-04-25)
+
+
+### 🐛 Bug Fixes | Bug 修复
+
+* **extend:** 修复未传入 extends 不存在缺省值的问题 ([77f3141](http://124.126.16.154:8888/singularity/HyperfDevelopmentKitCore/commit/77f3141c56a09905e0c357c1b183c1c8831c9acd))
+
+
+### ✨ Features | 新功能
+
+* **handler:** 补全了各种错误的状态码 ([0247dd4](http://124.126.16.154:8888/singularity/HyperfDevelopmentKitCore/commit/0247dd415c2a62c21b5a6fbb15ab1e6ce3d1a316))
+
+### [0.2.15](http://124.126.16.154:8888/singularity/HyperfDevelopmentKitCore/compare/v0.2.14...v0.2.15) (2023-04-13)
+
+
+### 🐛 Bug Fixes | Bug 修复
+
+* **coreMiddleware:** 修复restful 无法分页的问题 ([a6b71db](http://124.126.16.154:8888/singularity/HyperfDevelopmentKitCore/commit/a6b71dbb037624ac69eddc1e5b1d671ab45b06ae))
+
+
+### ✨ Features | 新功能
+
+* 默认绑定 CoreMiddleware 的映射关系 ([5e5792b](http://124.126.16.154:8888/singularity/HyperfDevelopmentKitCore/commit/5e5792b28ca13cc8833280ba3d26ec588c445350))
+
+### [0.2.14](http://124.126.16.154:8888/singularity/HyperfDevelopmentKitCore/compare/v0.2.13...v0.2.14) (2023-04-12)
+
+
+### ✨ Features | 新功能
+
+* **handler:** 补充 restful 响应的状态码 ([e69c149](http://124.126.16.154:8888/singularity/HyperfDevelopmentKitCore/commit/e69c1494c3ec0a8d26341f1891d7d067511e8baf))
+
 ### [0.2.13](http://124.126.16.154:8888/singularity/HyperfDevelopmentKitCore/compare/v0.2.12...v0.2.13) (2023-04-11)
 
 

VERSION_TRACKER.txt

@@ -1 +1 @@
-0.2.13
+0.2.16

composer.json

@@ -111,5 +111,5 @@
       "url": "https://mirrors.cloud.tencent.com/composer/"
     }
   },
-  "version": "0.2.13"
+  "version": "0.2.16"
 }

src/ConfigProvider.php

@@ -14,8 +14,10 @@ namespace Singularity\HDK\Core;
 
 use Hyperf\Contract\StdoutLoggerInterface;
 use Hyperf\Framework\Logger\StdoutLogger;
+use Hyperf\HttpServer\Contract\CoreMiddlewareInterface;
 use Singularity\HDK\Core\Listener\EmailWillSentListener;
 use Singularity\HDK\Core\Listener\SmsWillSentListener;
+use Singularity\HDK\Core\Middleware\CommonCoreMiddleware;
 
 class ConfigProvider
 {
@@ -27,6 +29,7 @@ class ConfigProvider
             // 合并到  config/autoload/dependencies.php 文件
             'dependencies' => [
                 StdoutLoggerInterface::class => StdoutLogger::class,
+                CoreMiddlewareInterface::class => CommonCoreMiddleware::class
             ],
             // 合并到  config/autoload/annotations.php 文件
             'annotations' => [

src/Exceptions/Handler/CommonHandler.php

@@ -12,6 +12,7 @@ declare(strict_types=1);
 
 namespace Singularity\HDK\Core\Exceptions\Handler;
 
+use Carbon\Carbon;
 use Hyperf\Database\Exception\QueryException;
 use Hyperf\Database\Model\ModelNotFoundException;
 use Hyperf\Di\Annotation\Inject;
@@ -31,6 +32,7 @@ use RedisException;
 use Singularity\HDK\Core\Constants\CommonErrorCode;
 use Singularity\HDK\Core\Exceptions\ValidateException;
 use Symfony\Component\Mailer\Exception\TransportException;
+use Teapot\StatusCode\RFC\RFC4918;
 use Teapot\StatusCode\RFC\RFC7231;
 use Throwable;
 
@@ -55,6 +57,7 @@ class CommonHandler extends ExceptionHandler
      */
     #[Inject]
     private StdoutLogger $logger;
+
     /**
      * {@inheritDoc}
      */
@@ -67,9 +70,12 @@ class CommonHandler extends ExceptionHandler
         $message_name = config('common.response.message_name');
         $is_testing = config('app_status') === true;
         $this->request?->url();
-        $is_debug = $this->request?->hasHeader('Postman-Token') || str_starts_with($this->request?->header('User-Agent', ''), 'apifox');
+        $is_debug = $this->request?->hasHeader('Postman-Token') || str_starts_with(
+                $this->request?->header('User-Agent', ''),
+                'apifox'
+            );
         $error_type = $throwable::class;
-        $request_time = date('Y-m-d H:i:s');
+        $request_time = Carbon::now()->toDateTimeString();
         $request_data = Json::encode($this->request?->getParsedBody());
         $request_headers = Json::encode($this->request?->getHeaders());
         // 901 程序语法错误
@@ -79,7 +85,10 @@ class CommonHandler extends ExceptionHandler
                 '42S22' => CommonErrorCode::PROGRAM_SQL_COLUMN_NOT_FOUND,
                 default => CommonErrorCode::PROGRAM_SQL_ERROR,
             };
-            $data = [$code_name => $code, $message_name => CommonErrorCode::getMessage($is_testing ? $code : CommonErrorCode::PROGRAM_SQL_ERROR)];
+            $data = [
+                $code_name => $code,
+                $message_name => CommonErrorCode::getMessage($is_testing ? $code : CommonErrorCode::PROGRAM_SQL_ERROR),
+            ];
             if ($is_testing) {
                 $data['details'] = ['sql' => $throwable->getSql(), 'error' => $throwable->getMessage()];
             }
@@ -89,24 +98,48 @@ class CommonHandler extends ExceptionHandler
             $message = explode(': ', $throwable->getMessage());
             $allow_method = explode(', ', $message[1]);
             $code = CommonErrorCode::REQUEST_METHOD_ERROR;
-            $data = [$code_name => $code, $message_name => CommonErrorCode::getMessage($code, ['methods' => join(', ', $allow_method)]), 'currentMethod' => $this->request?->getMethod(), 'allowedMethod' => $allow_method];
+            $data = [
+                $code_name => $code,
+                $message_name => CommonErrorCode::getMessage($code, ['methods' => join(', ', $allow_method)]),
+                'currentMethod' => $this->request?->getMethod(),
+                'allowedMethod' => $allow_method,
+            ];
+            $status_code = RFC7231::METHOD_NOT_ALLOWED;
         }
         // 验证失败
         if ($throwable instanceof BadRequestHttpException) {
-            $data = [$code_name => CommonErrorCode::REQUEST_PARAMS_ERROR, $message_name => $is_testing ? $throwable->getMessage() : CommonErrorCode::getMessage(CommonErrorCode::SERVER_ERROR)];
+            $data = [
+                $code_name => CommonErrorCode::REQUEST_PARAMS_ERROR,
+                $message_name => $is_testing ? $throwable->getMessage() : CommonErrorCode::getMessage(
+                    CommonErrorCode::SERVER_ERROR
+                ),
+            ];
+            $status_code = RFC4918::UNPROCESSABLE_ENTITY;
         }
         if ($throwable instanceof ValidationException) {
             $data = $throwable->validator->errors()->first();
             if (is_numeric($data)) {
-                $code = (int) $data;
+                $code = (int)$data;
                 $data = CommonErrorCode::getMessage($code);
             }
             $data = [$code_name => $code ?? CommonErrorCode::REQUEST_PARAMS_ERROR, $message_name => $data];
+            $status_code = RFC4918::UNPROCESSABLE_ENTITY;
         }
         if ($throwable instanceof ValidateException) {
+            $status_code = RFC4918::UNPROCESSABLE_ENTITY;
             $code = $throwable->getCode();
             $message = $throwable->getMessage();
-            $data = [$code_name => $code, $message_name => empty($message) ? CommonErrorCode::getMessage($code, ['param' => $throwable->getFieldName()]) : $message];
+            $data = [
+                $code_name => $code,
+                $message_name => empty($message)
+                    ? CommonErrorCode::getMessage(
+                        $code,
+                        [
+                            'param' => $throwable->getFieldName(),
+                        ]
+                    )
+                    : $message,
+            ];
             if ($is_debug) {
                 $data['currentValue'] = $throwable->getCurrentValue();
                 $data['availableValue'] = $throwable->getAvailableValue();
@@ -116,14 +149,15 @@ class CommonHandler extends ExceptionHandler
         if ($throwable instanceof NotFoundHttpException) {
             $code = CommonErrorCode::ROUTE_NOT_FOUND;
             $data = [$code_name => $code, $message_name => CommonErrorCode::getMessage($code)];
-            $status_code = 404;
+            $status_code = RFC7231::NOT_FOUND;
         }
         // 模型不存在
         if ($throwable instanceof ModelNotFoundException) {
             $code = empty($throwable->getCode()) ? CommonErrorCode::MODEL_NOT_FOUND : $throwable->getCode();
-            $message = empty($throwable->getCode()) ? CommonErrorCode::getMessage($code, ['resource' => '资源']) : $throwable->getMessage();
+            $message = empty($throwable->getCode()) ? CommonErrorCode::getMessage($code, ['resource' => '资源']
+            ) : $throwable->getMessage();
             $data = [$code_name => $code, $message_name => $message];
-            $status_code = 404;
+            $status_code = RFC7231::NOT_FOUND;
         }
         // 300 服务出错
         // 303 缓存异常
@@ -132,7 +166,12 @@ class CommonHandler extends ExceptionHandler
             if ($throwable->getMessage() === 'Connection refused') {
                 $code = CommonErrorCode::SERVER_CACHE_REDIS_REFUSED_ERROR;
             }
-            $data = [$code_name => $code, $message_name => CommonErrorCode::getMessage($is_testing ? $code : CommonErrorCode::SERVER_CACHE_REDIS_ERROR)];
+            $data = [
+                $code_name => $code,
+                $message_name => CommonErrorCode::getMessage(
+                    $is_testing ? $code : CommonErrorCode::SERVER_CACHE_REDIS_ERROR
+                ),
+            ];
         }
         // 306 消息异常
         // 30601 邮箱发件异常
@@ -141,14 +180,29 @@ class CommonHandler extends ExceptionHandler
             if (strpos($throwable->getMessage(), '500 Error: bad syntax')) {
                 $code = CommonErrorCode::SERVER_MESSAGE_EMAIL_NOT_FOUND;
             }
-            $data = [$code_name => $code, $message_name => CommonErrorCode::getMessage($is_testing ? $code : CommonErrorCode::SERVER_MESSAGE_EMAIL_ERROR)];
+            $data = [
+                $code_name => $code,
+                $message_name => CommonErrorCode::getMessage(
+                    $is_testing ? $code : CommonErrorCode::SERVER_MESSAGE_EMAIL_ERROR
+                ),
+            ];
         }
         if (empty($data)) {
             // 其他情况
-            $data = [$code_name => $is_testing ? $throwable->getCode() == 0 ? CommonErrorCode::SERVER_ERROR : $throwable->getCode() : CommonErrorCode::SERVER_ERROR, $message_name => $is_testing ? $throwable->getMessage() : __(CommonErrorCode::getMessage(CommonErrorCode::SERVER_ERROR))];
+            $data = [
+                $code_name => $is_testing ? $throwable->getCode(
+                ) == 0 ? CommonErrorCode::SERVER_ERROR : $throwable->getCode() : CommonErrorCode::SERVER_ERROR,
+                $message_name => $is_testing ? $throwable->getMessage() : __(
+                    CommonErrorCode::getMessage(CommonErrorCode::SERVER_ERROR)
+                ),
+            ];
             // 其他错误
             if ($throwable instanceof HttpException) {
-                $data = [$code_name => $throwable->getCode() ?: $throwable->getStatusCode(), $message_name => $throwable->getMessage()];
+                $data = [
+                    $code_name => $throwable->getCode() ?: $throwable->getStatusCode(),
+                    $message_name => $throwable->getMessage(),
+                ];
+                $status_code = $throwable->getStatusCode();
             }
         }
         $response = $response->withHeader(Header::CONTENT_TYPE, 'application/json; charset=utf-8');
@@ -159,7 +213,7 @@ class CommonHandler extends ExceptionHandler
         $this->logger->error(
             <<<ERROR_LOG
 TYPE: {$error_type}
-[{$data[$code_name]}] {$data[$message_name]}
+[$data[$code_name]] $data[$message_name]
 {$throwable->getMessage()}
 -------------------------------
 REQUEST_TIME: {$request_time}
@@ -190,10 +244,13 @@ ERROR_LOG
         );
         $data = Json::encode($data);
         if ($restful) {
-            $response = $response->withStatus($status_code ?? $throwable->status ?? $throwable->statusCode ?? RFC7231::INTERNAL_SERVER_ERROR);
+            $response = $response->withStatus(
+                $status_code ?? $throwable->status ?? $throwable->statusCode ?? RFC7231::INTERNAL_SERVER_ERROR
+            );
         }
         return $response->withBody(new SwooleStream($data));
     }
+
     /**
      * 判断该异常处理器是否要对该异常进行处理.
      */

src/Middleware/CommonCoreMiddleware.php

@@ -73,11 +73,12 @@ class CommonCoreMiddleware extends CoreMiddleware
                 'last'
             );
             $fact_response = $this->utilsService->extendLinkToHeader($fact_response, $response->url(1), 'first');
-            return $this->utilsService->extendLinkToHeader(
+            $fact_response = $this->utilsService->extendLinkToHeader(
                 $fact_response,
                 $response->previousPageUrl(),
                 'prev'
             );
+            return $fact_response->withBody(new SwooleStream(Json::encode($response->items())));
         }
 
         return parent::transferToResponse($response, $request);

src/Service/ExtendService.php

@@ -24,13 +24,10 @@ class ExtendService
         array|string|null $params = null
     ): array {
         $params ??= $request?->getQueryParams();
-        $extends = $params['extends'] ?? null;
-        if (!empty($extends)) {
-            $extends = explode(',', $extends);
-            return Context::set(self::class, array_map('trim', $extends));
-        }
+        $extends = explode(',', $params['extends'] ?? '');
+        $extends = array_map('trim', $extends);
 
-        return [];
+        return Context::set(self::class, array_filter($extends));
     }
 
 
@@ -57,6 +54,6 @@ class ExtendService
      */
     public function hasExtend(string $field): bool
     {
-        return $this->utils->inArray($field, Context::get(self::class));
+        return $this->utils->inArray($field, Context::get(self::class) ?? []);
     }
 }

tests/Unit/ExtendServiceTest.php

@@ -9,12 +9,10 @@
 
 namespace Singularity\HDK\Test\Core\Unit;
 
+use Hyperf\Context\Context;
 use Singularity\HDK\Core\Service\ExtendService;
 use Singularity\HDK\Core\Service\UtilsService;
 
-$service = new ExtendService(new UtilsService());
-
-
 /** @var ExtendService $service */
 $service = make(ExtendService::class, ['utils' => new UtilsService()]);
 it('asserts no parameters can be parsed.', function (ExtendService $service, $params) {
@@ -23,7 +21,7 @@ it('asserts no parameters can be parsed.', function (ExtendService $service, $pa
         $params
     );
     $result = $service->getExtends();
-    expect($result)->toBeArray()->toHaveCount(0)->toBe([]);
+    expect($result)->toBeArray()->toBe([])->toHaveCount(0)->toBe([]);
 })->with([
     [$service, null],
     [$service, ''],
@@ -32,6 +30,11 @@ it('asserts no parameters can be parsed.', function (ExtendService $service, $pa
     [$service, ['extends' => null]],
 ]);
 
+it('asserts has no specify extend', function () use ($service) {
+    Context::destroy(ExtendService::class);
+    expect($service->hasExtend('a'))->toBeFalse();
+})->depends('it asserts query parameters can be parsed.');
+
 it('asserts query parameters can be parsed.', function () use ($service) {
     $result = $service->parse(
         null,
@@ -44,19 +47,21 @@ it('asserts query parameters can be parsed.', function () use ($service) {
 });
 
 it('asserts has extends', function () use ($service) {
+    Context::set(ExtendService::class, ['a', 'b']);
     expect($service->hasExtends())->toBeTrue();
 });
 
 it('asserts has specify extend', function () use ($service) {
+    Context::set(ExtendService::class, ['a', 'b']);
     expect($service->hasExtend('a'))->toBeTrue()
         ->and($service->hasExtend('b'))->toBeTrue()
         ->and($service->hasExtend('c'))->toBeFalse();
 })->depends('it asserts query parameters can be parsed.');
 
-it('asserts parsed extends', function () use ($service) {
-    $extends = $service->getExtends();
-    expect($extends)->toBeArray()->toMatchArray([
-        'a',
-        'b',
-    ]);
-})->depends('it asserts query parameters can be parsed.');
+// it('asserts parsed extends', function () use ($service) {
+//     $extends = $service->getExtends();
+//     expect($extends)->toBeArray()->toMatchArray([
+//         'a',
+//         'b',
+//     ]);
+// })->depends('it asserts query parameters can be parsed.');