matomo-org / matomo

Empowering People Ethically with the leading open source alternative to Google Analytics that gives you full control over your data. Matomo lets you easily collect data from websites & apps and visualise this data and extract insights. Privacy is built-in. Liberating Web Analytics. Star us on Github? +1. And we love Pull Requests!
https://matomo.org/
GNU General Public License v3.0
19.6k stars 2.62k forks source link

[Bug] Can't connect to marketplace anymore when curl uses brotli compression #22222

Closed pixelbrackets closed 4 weeks ago

pixelbrackets commented 3 months ago

What happened?

I can't reach the marketplace anymore. It keeps showing

There was an error reading the response from the Marketplace: Please try again later.

I debugged Matomo to find the requested URI:

https://plugins.matomo.org/api/2.0/plugins?keywords=&purchase_type=&query=&sort=lastupdated&release_channel=latest_stable&prefer_stable=1&piwik=5.0.3&php=8.1.28&mysql=10.6.17-MariaDB&num_users=9&num_websites=14

The response for this URI is always empty. The empty response triggers the above error message.

System report and security report in the Matomo backend look good and dont mentian any missing or faulty software.

Calling the URI from CLI works fine as well (curl https://plugins.matomo.org/… gives the expected JSON reponse).

Any hints what could be wrong here?

What should happen?

Marketplace is accessible

How can this be reproduced?

Try to open the marketplace page. Try to run "Looking for updates" in plugin page.

Matomo version

5.0.3

PHP version

8.1

Server operating system

Red Hat Enterprise Linux 7 with curl version 7.29 - See comment three

What browsers are you seeing the problem on?

All browsers

Computer operating system

Linux

Relevant log output

No response

Validations

pixelbrackets commented 3 months ago

Calling the URI from CLI works fine as well (curl https://plugins.matomo.org/… gives the expected JSON reponse).

When calling the URI from a simple PHP testscript using Guzzle I also get a response from the Matomo endpoint.

When I pass a random URL to the method trying to fetch the data (Piwik\Plugins\Marketplace\Api\Service::fetch()) then it will return a response as well.

When I mirror the JSON reponse of the marketplace from another instance, then the request is fine as well.

So curl is working ✔️, the server is able to handle requests (seems to be no firewall issue) ✔️ . Somehow the connection from Matomo to the Matomo marketplace URI is faulty.

pixelbrackets commented 3 months ago

The connection error lead me into Matomos HTTP class, which sets up custom curl request commands.

In there I found the error. The following line instructs curl to always request all encodings it supports: https://github.com/matomo-org/matomo/blob/4a5a877e5034bdd25bc89725c4bbb331ea9909b2/core/Http.php#L677-L680 (introduced in https://github.com/matomo-org/matomo/pull/17009 and afaik reasonable).

Outgoing requests show that my server sends the header accept-encoding: deflate, gzip, br. When I remove brotli (br), then Matomo will work just fine and the marketplace is available again. When I use brotli only, the response is empty.

I was able to reproduce the issue with a simple script:

<?php

$requestUrl = 'https://plugins.matomo.org/api/2.0/plugins?keywords=&purchase_type=&query=&sort=lastupdated&release_channel=latest_stable&prefer_stable=1&piwik=5.0.3&php=8.1.28&mysql=10.6.17-MariaDB&num_users=9&num_websites=14';
//$requestUrl = 'https://httpbin.dev/brotli';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $requestUrl);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_ENCODING, 'br');
$data = curl_exec($ch);
print_r($data);

However: This script works fine on a local test machine.

Running the request via CLI works on both machines (curl --output -H 'Accept-encoding: br' "https://plugins.matomo.org/api/2.0/plugins?keywords=&purchase_type=&query=&sort=lastupdated&release_channel=latest_stable&prefer_stable=1&piwik=5.0.3&php=8.1.28&mysql=10.6.17-MariaDB&num_users=9&num_websites=14"), so this seems to be a php-curl issue.

I have contacted my hosting provider, maybe php-curl was not compiled with brotli.

FYI: I wrote the a Guzzle script for the same request and this works. Guzzle decompresses the reponse using a stream wrapper.

pixelbrackets commented 3 months ago

I have contacted my hosting provider, maybe php-curl was not compiled with brotli.

The hosting uses Red Hat Enterprise Linux 7 with curl version 7.29. Since this is a long-term support OS, that's a rather old version, and the provider therefore installed an additional curl. PHP is provided in multiple versions with the popular Remi repo (https://rpms.remirepo.net/). Since these versions are supposed to run on RHEL 7, they are built against version 7.29. Brotli is supported in curl since version 7.57 (https://curl.se/changes.html).

Due to the mentioned empty CURLOPT_ENCODING argument php-curl now sends the “newer” list of accepted values, which includes brotli, but is not able to work with the response eventually.

My hotfix: I hardcoded $curl_options[CURLOPT_ENCODING] = 'deflate, gzip' in line https://github.com/matomo-org/matomo/blob/4a5a877e5034bdd25bc89725c4bbb331ea9909b2/core/Http.php#L680

Question: This issues did not pop up until this month. My provider said that they run this software setup for a long time already. Did the Matomo Marketplace API Server maybe activate brotli responses just now?

Suggestion: As written before, if Matomo would work with a stream wrapper - as Guzzle does - this would not trigger an error. Maybe add a stream wrapper or even replace the custom curl scripts with a library like Guzzle? Depends how many users are affected by the issue.

martinheise commented 3 months ago

I can reproduce the exact same behaviour, including @pixelbrackets test script and the fix. System is: Red Hat Enterprise Linux Server release 7.9 Curl version is 8.7.1, though

sgiehl commented 3 months ago

@patrickli @samjf Were there any changes done to our Marketplace API Server recently, which might cause the problem?

patrickli commented 3 months ago

Not anything I'm aware of. @samjf did we upgrade PHP version for it? I just checked and it is default.

samjf commented 3 months ago

@patrickli @sgiehl It is possible the servers could have been upgraded in that time -- from memory it was before 3 weeks ago though. I'll DM you more details.

sgiehl commented 3 months ago

This actually sounds more like a problem with php curl rather than an issue with Matomo or our server. Could be a similar issue as reported here: https://github.com/CpanelInc/libcurl/issues/3

dshoreman commented 3 months ago

I ran into this today setting up my first instance in Docker using the fpm-alpine image. From debugging, I get the same empty response. Curl from host and container CLI both work.

Workaround works for me on 5.0.3 with PHP 8.2, applied with sed from the host:

docker exec matomo_app \
  sed -i 's/_ENCODING] = "/&deflate, gzip/' /var/www/html/core/Http.php

On the admin dash it manifests as 3 identical errors down the page, but all three linked to the FAQ about setting up the cron. (on the bright side, cron got configured much sooner...)

MerleCedric commented 1 month ago

Hi, I'm having the same problem here, the marketplace won't connect anymore.

PHPinfo confirms that curl is compiled with brotli. The hotfix suggested by @pixelbrackets works for me too.

I have access to a second server where the marketplace works fine and on which curl isn't compiled with brotli.

Interesting things : forcing matomo to use http instead of https by adding force_matomo_http_request = 1 in the general section of configuration also "solves" the problem too (temporarily).

MerleCedric commented 1 month ago

I just upgraded to PHP 8.3.10 on my Matomo server (previously 8.3.8) and marketplace is working again. I double-checked by switching back to 8.3.8 to verify that it didn't work on that version.

I also noticed that the curl version has changed (8.7.1 with php 8.3.8 docker image and 8.9.0 with php 8.3.10 docker image).

Finally, there is a fix about curl in PHP 8.3.9 changelog.

So, the issue seems to be fixed in the latest php or curl version.

sgiehl commented 4 weeks ago

Hey @MerleCedric Thanks for the update. So it looks like a PHP / curl specific issue. Fixing it on our end by setting specific encoding doesn't sound like a wise decision anyway. And setting it to an empty string allows to use all available encodings.

If anyone still experiences that problem after updating PHP / curl, please let us know, so we can reconsider this.

pixelbrackets commented 3 weeks ago

FYI I sucessfully checked the solution described by @MerleCedric. My hoster installed an new curl version and PHP. My example script works again. And the Matomo Marketplace is available again when curl uses brotli compression. So it was indeed an issue with curl and/or PHP. All done. :heavy_check_mark: