Merge pull request #11 from SDPM-lab/dev

New version V1.0.0

Author: monkenWu

README.md

@@ -8,8 +8,6 @@
 
 Codeigniter4-RoadRunner provides the synchroniztion of the Request and Response object between Roadrunner-Worker and Codeigniter4. Since Codeigniter4 doesn't implement  [PSR-7 standard](https://codeigniter.tw/user_guide/intro/psr.html) completely, you need to use this library to allow your Codeigniter4 project to run using RoadRunner Server.
 
-> This library is currently under development, and its functions are not yet stable. Do not use it in production environment.
-
 [正體中文說明書](https://github.com/SDPM-lab/Codeigniter4-Roadrunner/blob/dev/README_zh-TW.md)
 
 ## Install
@@ -23,7 +21,7 @@ Codeigniter4-RoadRunner provides the synchroniztion of the Request and Response
 ### Composer Install
 Use "Composer" to download the library and its dependencies to the project
 ```
-composer require sdpmlab/codeigniter4-roadrunner "v1.0.0-beta.2"
+composer require sdpmlab/codeigniter4-roadrunner
 ```
 Initialize Roadrunner and files using built-in commands in the library
 
@@ -55,7 +53,7 @@ http:
     command:  "php psr-worker.php"
     # pool:
     #   numWorkers: 50
-    #   maxJobs:  10
+    #   maxJobs:  500
 
 static:
   enable:  true
@@ -142,7 +140,21 @@ http:
     command:  "php psr-worker.php"
     pool:
       numWorkers: 1
-      maxJobs:  1
+      # maxJobs:  500
+```
+
+### Database Connection
+
+We only focus on supporting the Codeigniter4 built-in [Database Library](https://codeigniter.com/user_guide/database/index.html), hence we do not guarantee if using the PHP
+built-in method should work as normal. Therefore, you should avoid using the PHP built-in database connection method but
+pick the Codeigniter4 framework built-in library.
+
+Under the default situation, DB of the Worker should be lasting, and will try to reconnect once the connection is failed.
+Every Request that goes into Worker is using a same DB connection instance. If you don't want this default setting but expecting
+every Request to use the reconnect DB connection instance. You can add the configuration down below into the `.env`  file under the root directory.
+
+```env
+CIROAD_DB_AUTOCLOSE = true
 ```
 
 # Global Methods

README_zh-TW.md

@@ -8,8 +8,6 @@
 
 Codeigniter4-RoadRunner 提供的是 Roadrunner-Worker 與 Codeigniter4 在 Request 與 Response 物件上的同步，因為 Codeigniter4 並沒有完整實作 [PSR-7 規範](https://codeigniter.tw/user_guide/intro/psr.html)。所以你需要使用這個程式庫才能讓你的 Codeigniter4 專案透過 RoadRunner Server 運作。
 
-> 這個程式庫目前處於開發版，功能尚未穩定。請不要將它運用在正式環境中。
-
 ## 安裝
 
 ### 需求
@@ -23,7 +21,7 @@ Codeigniter4-RoadRunner 提供的是 Roadrunner-Worker 與 Codeigniter4 在 Requ
 於專案根目錄下，使用 Composer 下載程式庫與其所需之依賴。
 
 ```
-composer require sdpmlab/codeigniter4-roadrunner "v1.0.0-beta.2"
+composer require sdpmlab/codeigniter4-roadrunner
 ```
 
 使用程式庫提供的內建指令初始化 Roadrunner 與其所需的檔案。
@@ -60,7 +58,7 @@ http:
     command:  "php psr-worker.php"
     # pool:
     #   numWorkers: 50
-    #   maxJobs:  10
+    #   maxJobs:  500
 
 static:
   enable:  true
@@ -146,7 +144,17 @@ http:
     command:  "php psr-worker.php"
     pool:
       numWorkers: 1
-      maxJobs:  1
+      # maxJobs:  500
+```
+
+### 資料庫連線
+
+我們只針對 Codeigniter4 內建 [Database 程式庫](https://codeigniter.tw/user_guide/database/index.html) 進行支援，並不保證 PHP 內建的方法是否能照常運作。所以，你應該避免使用內建的 PHP 資料庫連線方法，而是以 Codeigniter4 框架內建的程式庫為主。
+
+預設的情況下，在 Worker 中的 DB 連線是持久的，並會在連線失效時自動重新連線。所有進入 Worker 的 Request 都使用同一個 DB 連線實體。如果你不想要這個預設設定，希望每個進入 Worker 的 Request 都使用重新連線的 DB 連線實體。你可以在專案根目錄下的 `.env` 檔案加入以下設定。
+
+```env
+CIROAD_DB_AUTOCLOSE = true
 ```
 
 ## 全域方法

composer.json

@@ -18,7 +18,7 @@
     "require": {
         "php" : "^7.2",
         "codeigniter4/framework": "^4",
-        "spiral/roadrunner": "1.8.1",
+        "spiral/roadrunner": "^1.8.1",
         "spiral/dumper": "^1.1"
     },
     "autoload": {

src/Commands/file/.rr.yaml

@@ -4,7 +4,7 @@ http:
     command:  "php psr-worker.php"
     # pool:
     #   numWorkers: 50
-    #   maxJobs:  10
+    #   maxJobs:  500
 
 static:
   enable:  true

src/Commands/file/psr-worker.php

@@ -14,6 +14,7 @@
 use SDPMlab\Ci4Roadrunner\Debug\Toolbar;
 use SDPMlab\Ci4Roadrunner\Debug\Dumper;
 use SDPMlab\Ci4Roadrunner\UploadedFileBridge;
+use SDPMlab\Ci4Roadrunner\HandleDBConnection;
 
 // codeigniter4 public/index.php
 $minPHPVersion = '7.2';
@@ -56,25 +57,19 @@ function dump($value,string $target = "ERROR_LOG") : ?string{
     return Dumper::getInstance()->dump($value,$target);
 }
 
-$count = 0;
 while ($req = $psr7->acceptRequest()) {
-    //記憶體控制
-    if ($count++ > 500) {
-        break;
-    }
 
-    //請求物件相容
+    //handle request object
     try {
-        $requestBridge = new RequestBridge($req);
-        $ci4Req = $requestBridge->getRequest();
+        $ci4Req = RequestBridge::setRequest($req);
     } catch (
         \Throwable $e
     ){
         dump((string)$e);
         $psr7->getWorker()->error((string)$e);
     }
 
-    //處理除錯工具列
+    //handle debug-bar
     try{
         if(ENVIRONMENT === 'development'){
             $toolbar = new Toolbar(config('Toolbar'),$ci4Req);
@@ -89,8 +84,9 @@ function dump($value,string $target = "ERROR_LOG") : ?string{
         $psr7->getWorker()->error((string)$e);
     }
 
-    //執行框架邏輯與錯誤處理
+    //run framework and error handling
     try{
+        if(!env("CIROAD_DB_AUTOCLOSE")) HandleDBConnection::reconnect();
         $ci4Response = $app->setRequest($ci4Req)->run();
     }catch(
         \Throwable $e
@@ -102,12 +98,10 @@ function dump($value,string $target = "ERROR_LOG") : ?string{
         continue;
     }
 
-    //響應物件轉換
+    //handle response object
     try {
         $response = new ResponseBridge($ci4Response,$req);
-        //傳遞處理結果
         $psr7->respond($response);
-        //初始化 CI4 以及 PHP 輸出輸入內容
         init();
     } catch (
         \Throwable $e
@@ -127,8 +121,15 @@ function init()
     try {
         ob_end_clean();
     } catch (\Throwable $th) {}
+
     \CodeIgniter\Config\Services::reset(true);
+    
     UploadedFileBridge::reset();
+
+    if(env("CIROAD_DB_AUTOCLOSE")){
+        HandleDBConnection::closeConnect();
+    }
+
     $appConfig = config(\Config\App::class);
     $app       = new \CodeIgniter\CodeIgniter($appConfig);
     $app->initialize();

src/HandleDBConnection.php

@@ -0,0 +1,31 @@
+<?php
+namespace SDPMlab\Ci4Roadrunner;
+
+class HandleDBConnection
+{
+    public static function closeConnect()
+    {
+        $dbInstances = \Config\Database::getConnections();
+        foreach ($dbInstances as $connection) {
+            $connection->close();
+        }
+    }
+
+    public static function reconnect()
+    {
+        $dbInstances = \Config\Database::getConnections();
+        foreach ($dbInstances as $connection) {
+            if($connection->DBDriver == "MySQLi"){
+                try {
+                    $connection->mysqli->ping();
+                } catch (\Throwable $th) {
+                    $connection->reconnect();
+                }
+            }else{
+                $connection->reconnect();
+            }
+        }
+    }
+}
+
+?>

src/RequestBridge.php

@@ -7,78 +7,63 @@
 
 class RequestBridge 
 {
-    private $_rRequest;
+    private static $_rRequest;
 
-    public function __construct(ServerRequest $rRequest)
+    public static function setRequest(ServerRequest $rRequest)
     {
-        $this->_rRequest = $rRequest;
-        $this->setFile();
-        $_SERVER['HTTP_USER_AGENT'] = $this->_rRequest->getHeaderLine("User-Agent");
+        self::$_rRequest = $rRequest;
+        self::setFile();
+        $_SERVER['HTTP_USER_AGENT'] = self::$_rRequest->getHeaderLine("User-Agent");
         \CodeIgniter\Config\Services::request(new \Config\App(),false);
         \CodeIgniter\Config\Services::request()->getUserAgent()->parse($_SERVER['HTTP_USER_AGENT']);
-        $this->setUri();
-        \CodeIgniter\Config\Services::request()->setBody($this->getBody());
-        $this->setParams();
-        $this->setHeader();
+        UriBridge::setUri(self::$_rRequest->getUri());
+        \CodeIgniter\Config\Services::request()->setBody(self::getBody());
+        self::setParams();
+        self::setHeader();
+        return \CodeIgniter\Config\Services::request();
     }
 
-    private function setFile(){
-        if(count($this->_rRequest->getUploadedFiles()) > 0){
-            UploadedFileBridge::getPsr7UploadedFiles($this->_rRequest->getUploadedFiles(),true);
+    protected static function setFile(){
+        if(count(self::$_rRequest->getUploadedFiles()) > 0){
+            UploadedFileBridge::getPsr7UploadedFiles(self::$_rRequest->getUploadedFiles(),true);
         }
     }
 
-    private function getBody(){
+    protected static function getBody(){
         $body = "";
-        if(strpos($this->_rRequest->getHeaderLine("content-type"), "application/json") === 0){
-            $body = $this->_rRequest->getBody();
-        }else if(
-            strpos($this->_rRequest->getHeaderLine("content-type"), "text/plain") === 0 ||
-            strpos($this->_rRequest->getHeaderLine("content-type"), "application/javascript") === 0 ||
-            strpos($this->_rRequest->getHeaderLine("content-type"), "text/html") === 0 ||
-            strpos($this->_rRequest->getHeaderLine("content-type"), "application/xml") === 0
-        ){
-            $body = $this->_rRequest->getBody()->getContents();
+        if(strpos(self::$_rRequest->getHeaderLine("content-type"), "application/json") === 0){
+            $body = self::$_rRequest->getBody();
         }else{
-            $body = http_build_query($this->_rRequest->getParsedBody()??[]);
+            $body = self::$_rRequest->getBody()->getContents();
         }
         return $body;
     }
 
-    private function setParams(){
-        \CodeIgniter\Config\Services::request()->setMethod($this->_rRequest->getMethod());
-        \CodeIgniter\Config\Services::request()->setGlobal("get",$this->_rRequest->getQueryParams());
-        if($this->_rRequest->getMethod() == "POST"){
-            \CodeIgniter\Config\Services::request()->setGlobal("post",$this->_rRequest->getParsedBody());
+    protected static function setParams(){
+        \CodeIgniter\Config\Services::request()->setMethod(self::$_rRequest->getMethod());
+        \CodeIgniter\Config\Services::request()->setGlobal("get",self::$_rRequest->getQueryParams());
+        if(self::$_rRequest->getMethod() == "POST"){
+            \CodeIgniter\Config\Services::request()->setGlobal("post",self::$_rRequest->getParsedBody());
         }
         $_COOKIE = [];
-        \CodeIgniter\Config\Services::request()->setGlobal("cookie",$this->_rRequest->getCookieParams());
-        foreach ($this->_rRequest->getCookieParams() as $key => $value) {
+        \CodeIgniter\Config\Services::request()->setGlobal("cookie",self::$_rRequest->getCookieParams());
+        foreach (self::$_rRequest->getCookieParams() as $key => $value) {
             $_COOKIE[$key] = $value;
         }
         if(isset($_COOKIE[config(App::class)->sessionCookieName])){
             session_id($_COOKIE[config(App::class)->sessionCookieName]);
         }
-        \CodeIgniter\Config\Services::request()->setGlobal("server",$this->_rRequest->getServerParams());    
+        \CodeIgniter\Config\Services::request()->setGlobal("server",self::$_rRequest->getServerParams());    
     }
 
-    private function setHeader(){
-        $rHeader = $this->_rRequest->getHeaders();
+    protected static function setHeader(){
+        $rHeader = self::$_rRequest->getHeaders();
         foreach ($rHeader as $key => $datas) {
             foreach ($datas as $values) {
                 \CodeIgniter\Config\Services::request()->setHeader($key,$values);
             }
         }
     }
 
-    private function setUri(){
-        $uriBridge = new UriBridge($this->_rRequest->getUri());
-        $uriBridge->setUri();
-    }
-
-    public function getRequest(){
-        return \CodeIgniter\Config\Services::request();
-    }
-
 }
 ?>

src/UriBridge.php

@@ -3,21 +3,17 @@
 
 class UriBridge
 {
-    private $_rURI;
+    private static $_rURI;
 
-    public function __construct(\Laminas\Diactoros\Uri $rURI)
-    {
+    public static function setUri(\Laminas\Diactoros\Uri $rURI){
         \CodeIgniter\Config\Services::uri(null,false);
-        $this->_rURI = $rURI;
+        self::$_rURI = $rURI;
+        self::transferPath();
+        self::transferQuery();
     }
 
-    public function setUri(){
-        $this->transferPath();
-        $this->transferQuery();
-    }
-
-    private function transferPath(){
-        $rPath = $this->_rURI->getPath();
+    protected static function transferPath(){
+        $rPath = self::$_rURI->getPath();
 
         if($rPath == "/"){
             \CodeIgniter\Config\Services::uri()->setPath($rPath);
@@ -38,8 +34,8 @@ private function transferPath(){
 
     }
 
-    private function transferQuery(){
-        \CodeIgniter\Config\Services::uri()->setQuery($this->_rURI->getQuery());
+    protected static function transferQuery(){
+        \CodeIgniter\Config\Services::uri()->setQuery(self::$_rURI->getQuery());
     }
 
 }

test/.rr.yaml

@@ -4,9 +4,17 @@ http:
     command:  "php psr-worker.php"
     pool:
       numWorkers: 1
-      maxJobs:  1
+    #   maxJobs:  500
 
 static:
   enable:  true
   dir:   "public"
-  forbid: [".php", ".htaccess"]
+  forbid: [".php", ".htaccess"]
+
+# reload:
+#   interval: 1s
+#   patterns: [".php"]
+#   services:
+#     http:
+#       dirs: [""]
+#       recursive: true