diff options
Diffstat (limited to 'crates/shirabe')
5 files changed, 106 insertions, 7 deletions
diff --git a/crates/shirabe/src/plugin/php_plugin_proxy.rs b/crates/shirabe/src/plugin/php_plugin_proxy.rs index 491a320c..c966897b 100644 --- a/crates/shirabe/src/plugin/php_plugin_proxy.rs +++ b/crates/shirabe/src/plugin/php_plugin_proxy.rs @@ -21,7 +21,7 @@ use crate::package::{DisplayMode, PackageInterfaceHandle}; use crate::plugin::capability::{Capability, CommandProvider}; use crate::plugin::capable::Capable; use crate::plugin::php_plugin_value::{ - date_time_from_wire, date_time_to_wire, link_from_wire, link_to_wire, + date_time_from_wire, date_time_to_wire, link_from_wire, link_to_wire, response_to_wire, }; use crate::plugin::plugin_interface::PluginInterface; use crate::repository::{ @@ -1177,11 +1177,27 @@ fn dispatch_http_downloader_method( downloader.borrow_mut().set_options(options); Ok(PluginValue::Null) } - // TODO(plugin): a `Composer\Util\Http\Response` has no representation on the wire, so - // the two synchronous request methods have nothing to answer with. - "get" | "copy" => Err(runtime_throw(format!( - "Shirabe does not support HttpDownloader::{method_name}() from a plugin yet" - ))), + "get" => { + let url = arg::<String>(method_name, args, 0)?; + let options = + arg_or::<IndexMap<String, PhpMixed>>(method_name, args, 1, IndexMap::new())?; + let response = downloader + .borrow() + .get(&url, options) + .map_err(|error| error_throw("get failed", &error))?; + Ok(response_to_wire(&response)) + } + "copy" => { + let url = arg::<String>(method_name, args, 0)?; + let to = arg::<String>(method_name, args, 1)?; + let options = + arg_or::<IndexMap<String, PhpMixed>>(method_name, args, 2, IndexMap::new())?; + let response = downloader + .borrow() + .copy(&url, &to, options) + .map_err(|error| error_throw("copy failed", &error))?; + Ok(response_to_wire(&response)) + } // TODO(plugin,async): the async surface resolves its promises with a Response the wire // cannot carry, and driving it needs a promise representation that crosses the boundary // unresolved. Neither exists yet. diff --git a/crates/shirabe/src/plugin/php_plugin_value.rs b/crates/shirabe/src/plugin/php_plugin_value.rs index cb9b990e..80415eef 100644 --- a/crates/shirabe/src/plugin/php_plugin_value.rs +++ b/crates/shirabe/src/plugin/php_plugin_value.rs @@ -14,6 +14,7 @@ //! constraint) has no faithful constructor call. use crate::package::Link; +use crate::util::http::Response; use chrono::{DateTime, NaiveDateTime, TimeZone, Utc}; use shirabe_php_rpc::{PhpObject, PhpThrow, PluginValue}; use shirabe_semver::constraint::{ @@ -21,6 +22,7 @@ use shirabe_semver::constraint::{ }; const LINK_CLASS: &str = "Composer\\Package\\Link"; +const RESPONSE_CLASS: &str = "Composer\\Util\\Http\\Response"; const CONSTRAINT_CLASS: &str = "Composer\\Semver\\Constraint\\Constraint"; const MULTI_CONSTRAINT_CLASS: &str = "Composer\\Semver\\Constraint\\MultiConstraint"; const MATCH_ALL_CLASS: &str = "Composer\\Semver\\Constraint\\MatchAllConstraint"; @@ -197,6 +199,48 @@ fn constraint_from_wire(value: &PluginValue) -> Result<AnyConstraint, PhpThrow> }) } +/// A `Response` is built for one request and never retained by the object graph, so the child +/// holds a real instance rather than a handle, and `collect()` frees the copy it holds. +/// +/// TODO(type-model): PHP's `$request` is the whole request array (`url`, `options`, `copyTo`) +/// and this port keeps only the url, which is all `decodeJson()` reads back out of it. +/// +/// TODO(port): Composer answers a curl request with a `Composer\Util\Http\CurlResponse` +/// carrying the transfer info; this port flattens that subclass into `Response` before the +/// value leaves `HttpDownloader`, so `getCurlInfo()` is gone and `get_class()` differs. +pub(crate) fn response_to_wire(response: &Response) -> PluginValue { + let mut object = PhpObject::new(RESPONSE_CLASS); + let mut request = indexmap::IndexMap::new(); + request.insert(b"url".to_vec(), PluginValue::string(response.request_url())); + object.set_private(RESPONSE_CLASS, "request", PluginValue::Array(request)); + object.set_private( + RESPONSE_CLASS, + "code", + PluginValue::Int(response.get_status_code()), + ); + object.set_private( + RESPONSE_CLASS, + "headers", + PluginValue::List( + response + .get_headers() + .iter() + .cloned() + .map(PluginValue::string) + .collect(), + ), + ); + object.set_private( + RESPONSE_CLASS, + "body", + match response.get_body() { + Some(body) => PluginValue::string(body), + None => PluginValue::Null, + }, + ); + PluginValue::PhpObject(object) +} + pub(crate) fn link_to_wire(link: &Link) -> PluginValue { let mut object = PhpObject::new(LINK_CLASS); object.set_protected("source", PluginValue::string(link.get_source())); diff --git a/crates/shirabe/src/util/http/response.rs b/crates/shirabe/src/util/http/response.rs index 4f824baa..d505bde4 100644 --- a/crates/shirabe/src/util/http/response.rs +++ b/crates/shirabe/src/util/http/response.rs @@ -21,6 +21,13 @@ impl Response { } } + /// The url of the request this response answered. PHP keeps the whole request array in a + /// private property with no getter, and the plugin boundary codec needs the url out of it to + /// rebuild the value in the child. + pub(crate) fn request_url(&self) -> &str { + &self.url + } + pub fn get_status_code(&self) -> i64 { self.code } diff --git a/crates/shirabe/tests/plugin/e2e_http_downloader_test.rs b/crates/shirabe/tests/plugin/e2e_http_downloader_test.rs index ecb0b34c..42471b61 100644 --- a/crates/shirabe/tests/plugin/e2e_http_downloader_test.rs +++ b/crates/shirabe/tests/plugin/e2e_http_downloader_test.rs @@ -61,7 +61,8 @@ fn test_plugin_owned_http_downloader_matches_upstream_composer() { // Pinned as well as compared, so a run where neither side wrote a trace cannot pass. The // second options line is the evidence that both worlds merge into one value rather than each - // holding its own copy of the map. + // holding its own copy of the map, and the response lines are the evidence that the value the + // request answers with is a real instance of the class rather than something shaped like one. assert_eq!( "\ event=post-update-cmd @@ -71,6 +72,11 @@ options merged=[\"X-Probe: 2\"] isCurlEnabled=true hints other=null transport=null outputWarnings=ok +get=ok +response class=\"Composer\\\\Util\\\\Http\\\\Response\" body=\"{\\\"probe\\\":true,\\\"n\\\":42}\" headers=[] +getHeader=null +copy=ok file=\"{\\\"probe\\\":true,\\\"n\\\":42}\" +collect=ok ", upstream.trace ); diff --git a/crates/shirabe/tests/plugin/fixtures/e2e-http-downloader/plugin/src/Plugin.php b/crates/shirabe/tests/plugin/fixtures/e2e-http-downloader/plugin/src/Plugin.php index 504c2108..054a47ca 100644 --- a/crates/shirabe/tests/plugin/fixtures/e2e-http-downloader/plugin/src/Plugin.php +++ b/crates/shirabe/tests/plugin/fixtures/e2e-http-downloader/plugin/src/Plugin.php @@ -78,6 +78,32 @@ class Plugin implements PluginInterface, EventSubscriberInterface ); }); + // A file:// url keeps the probe offline and off the curl path, so the trace is the same + // on a machine with no network. Paths stay out of the trace: the two runs work in + // different temporary directories. + $payload = getcwd() . '/probe-payload.json'; + file_put_contents($payload, '{"probe":true,"n":42}'); + + $response = null; + $lines[] = 'get=' . $this->describe(static function () use ($downloader, $payload, &$response): void { + $response = $downloader->get('file://' . $payload); + }); + $lines[] = 'response class=' . json_encode($response === null ? null : \get_class($response)) + . ' body=' . json_encode($response === null ? null : $response->getBody()) + . ' headers=' . json_encode($response === null ? null : $response->getHeaders()); + $lines[] = 'getHeader=' . json_encode($response === null ? null : $response->getHeader('Content-Type')); + + $target = getcwd() . '/probe-copy.json'; + $lines[] = 'copy=' . $this->describe(static function () use ($downloader, $payload, $target): void { + $downloader->copy('file://' . $payload, $target); + }) . ' file=' . json_encode(@file_get_contents($target)); + + // collect() unsets the response's own properties, so the object is spent afterwards and + // nothing may read it again. + $lines[] = 'collect=' . $this->describe(static function () use ($response): void { + $response->collect(); + }); + file_put_contents('http-downloader-trace.txt', implode("\n", $lines) . "\n"); } |