Enhance support for Swoole. (#71)

Author: jmjoy

Cargo.lock

@@ -36,12 +36,8 @@ SkyWalking PHP Agent requires SkyWalking 8.4+ and PHP 7.2+
   * [x] [php-amqplib](https://github.com/php-amqplib/php-amqplib) for Message Queuing Producer
 
 * Swoole Ecosystem
-  * [ ] [Coroutine\Http\Client](https://wiki.swoole.com/#/coroutine_client/http_client)
-  * [ ] [Coroutine\MySQL](https://wiki.swoole.com/#/coroutine_client/mysql)
-  * [ ] [Swoole\Coroutine\Http\Client](https://wiki.swoole.com/#/coroutine_client/http_client)
-  * [ ] [Coroutine\Redis](https://wiki.swoole.com/#/coroutine_client/redis)
 
-  *The components of the PHP-FPM ecosystem can also be used in Swoole.*
+  *The components of the PHP-FPM ecosystem can also be used in Swoole, wether the flag `SWOOLE_HOOK_ALL` is enabled or not.*
 
 ## Contact Us
 

README.md

@@ -578,11 +578,11 @@ MulanPSL-2.0 licenses
 The following components are provided under the MulanPSL-2.0 License. See project link for details.
 The text of each license is also included in licenses/LICENSE-[project].txt.
 
-    https://crates.io/crates/phper/0.11.0 0.11.0 MulanPSL-2.0
-    https://crates.io/crates/phper-alloc/0.11.0 0.11.0 MulanPSL-2.0
-    https://crates.io/crates/phper-build/0.11.0 0.11.0 MulanPSL-2.0
-    https://crates.io/crates/phper-macros/0.11.0 0.11.0 MulanPSL-2.0
-    https://crates.io/crates/phper-sys/0.11.0 0.11.0 MulanPSL-2.0
+    https://crates.io/crates/phper/0.11.1 0.11.1 MulanPSL-2.0
+    https://crates.io/crates/phper-alloc/0.11.1 0.11.1 MulanPSL-2.0
+    https://crates.io/crates/phper-build/0.11.1 0.11.1 MulanPSL-2.0
+    https://crates.io/crates/phper-macros/0.11.1 0.11.1 MulanPSL-2.0
+    https://crates.io/crates/phper-sys/0.11.1 0.11.1 MulanPSL-2.0
 
 ========================================================================
 Unlicense licenses

dist-material/LICENSE

@@ -13,7 +13,11 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use crate::{plugin::select_plugin, request::IS_SWOOLE, util::catch_unwind_result};
+use crate::{
+    plugin::select_plugin,
+    request::{HACK_SWOOLE_ON_REQUEST_FUNCTION_NAME, IS_SWOOLE},
+    util::catch_unwind_result,
+};
 use anyhow::{bail, Context};
 use phper::{
     objects::ZObj,
@@ -100,6 +104,11 @@ unsafe extern "C" fn execute_internal(
         }
     };
 
+    if function_name == HACK_SWOOLE_ON_REQUEST_FUNCTION_NAME {
+        ori_execute_internal(Some(execute_data), Some(return_value));
+        return;
+    }
+
     let plugin = select_plugin(class_name.as_deref(), &function_name);
     let plugin = match plugin {
         Some(plugin) => plugin,
@@ -297,7 +306,7 @@ fn infer_request_id(execute_data: &mut ExecuteData) -> Option<i64> {
         };
         let func_name = prev_execute_data.func().get_function_name();
         if !func_name
-            .map(|s| s == b"skywalking_hack_swoole_on_request_please_do_not_use")
+            .map(|s| s == &HACK_SWOOLE_ON_REQUEST_FUNCTION_NAME.as_bytes())
             .unwrap_or_default()
         {
             prev_execute_data_ptr = unsafe { (*prev_execute_data_ptr).prev_execute_data };

src/execute.rs

@@ -31,6 +31,7 @@ mod worker;
 
 use phper::{ini::Policy, modules::Module, php_get_module};
 
+use crate::request::HACK_SWOOLE_ON_REQUEST_FUNCTION_NAME;
 pub use errors::{Error, Result};
 
 /// Enable agent and report or not.
@@ -156,7 +157,7 @@ pub fn get_module() -> Module {
     // The function is used by swoole plugin, to surround the callback of on
     // request.
     module.add_function(
-        "skywalking_hack_swoole_on_request_please_do_not_use",
+        HACK_SWOOLE_ON_REQUEST_FUNCTION_NAME,
         request::skywalking_hack_swoole_on_request,
     );
 

src/lib.rs

@@ -16,7 +16,10 @@
 use crate::{
     execute::{get_this_mut, validate_num_args, AfterExecuteHook, BeforeExecuteHook, Noop},
     plugin::Plugin,
-    request::{IS_SWOOLE, ORI_SWOOLE_ON_REQUEST, SWOOLE_RESPONSE_STATUS_MAP},
+    request::{
+        HACK_SWOOLE_ON_REQUEST_FUNCTION_NAME, IS_SWOOLE, ORI_SWOOLE_ON_REQUEST,
+        SWOOLE_RESPONSE_STATUS_MAP,
+    },
 };
 use phper::{strings::ZString, values::ZVal};
 use std::{mem::replace, sync::atomic::Ordering};
@@ -61,9 +64,7 @@ impl SwooleServerPlugin {
                 let closure = execute_data.get_mut_parameter(1);
                 let ori_closure = replace(
                     closure,
-                    ZVal::from(ZString::new(
-                        "skywalking_hack_swoole_on_request_please_do_not_use",
-                    )),
+                    ZVal::from(ZString::new(HACK_SWOOLE_ON_REQUEST_FUNCTION_NAME)),
                 );
 
                 ORI_SWOOLE_ON_REQUEST.store(

src/plugin/plugin_swoole.rs

@@ -25,7 +25,6 @@ use once_cell::sync::Lazy;
 use phper::{arrays::ZArr, eg, pg, sg, sys, values::ZVal};
 use skywalking::trace::{propagation::decoder::decode_propagation, tracer};
 use std::{
-    convert::Infallible,
     panic::AssertUnwindSafe,
     ptr::null_mut,
     sync::atomic::{AtomicBool, AtomicPtr, Ordering},
@@ -146,6 +145,9 @@ fn get_page_request_server<'a>() -> anyhow::Result<&'a ZArr> {
     }
 }
 
+pub const HACK_SWOOLE_ON_REQUEST_FUNCTION_NAME: &str =
+    "skywalking_hack_swoole_on_request_please_do_not_use";
+
 /// Hold the response fd and status code kvs, because I dont't found that
 /// response has the status field, so I hook the response.status method, maybe
 /// there is a better way?
@@ -157,11 +159,11 @@ pub static IS_SWOOLE: AtomicBool = AtomicBool::new(false);
 
 /// The function is used by swoole plugin, to surround the callback of on
 /// request.
-pub fn skywalking_hack_swoole_on_request(args: &mut [ZVal]) -> Result<(), Infallible> {
+pub fn skywalking_hack_swoole_on_request(args: &mut [ZVal]) -> phper::Result<ZVal> {
     let f = ORI_SWOOLE_ON_REQUEST.load(Ordering::Relaxed);
     if f.is_null() {
         error!("Origin swoole on request handler is null");
-        return Ok(());
+        return Ok(ZVal::from(()));
     }
     let f = unsafe { ZVal::from_mut_ptr(f) };
 
@@ -170,7 +172,8 @@ pub fn skywalking_hack_swoole_on_request(args: &mut [ZVal]) -> Result<(), Infall
         error!(mode = "swoole", ?err, "request init failed");
     }
 
-    if let Err(err) = f.call(&mut *args) {
+    let return_value = f.call(&mut *args);
+    if let Err(err) = &return_value {
         error!(
             mode = "swoole",
             ?err,
@@ -186,7 +189,7 @@ pub fn skywalking_hack_swoole_on_request(args: &mut [ZVal]) -> Result<(), Infall
         }
     }
 
-    Ok(())
+    return_value
 }
 
 fn request_init_for_swoole(request: &mut ZVal) -> crate::Result<()> {

src/request.rs

@@ -51,7 +51,6 @@ pub const PROXY_SERVER_2_ADDRESS: &str = "127.0.0.1:9012";
 pub const FPM_SERVER_1_ADDRESS: &str = "127.0.0.1:9001";
 pub const FPM_SERVER_2_ADDRESS: &str = "127.0.0.1:9002";
 pub const SWOOLE_SERVER_1_ADDRESS: &str = "127.0.0.1:9501";
-#[allow(dead_code)]
 pub const SWOOLE_SERVER_2_ADDRESS: &str = "127.0.0.1:9502";
 pub const COLLECTOR_GRPC_ADDRESS: &str = "127.0.0.1:19876";
 pub const COLLECTOR_HTTP_ADDRESS: &str = "127.0.0.1:12800";