error_could_not_get_api_version / api_exception on v4.3 (2023101500)

[ksteitz]

Updating from v4.2-r5 (2023-07-27) to v4.3 (2023101500) from Oct 16 (8b4112f) we got that errors and etherpad stop working:
[20-Oct-2023 14:13:39 Europe/Berlin] Default exception handler: Fehler: Class "mod_etherpadlite\api\api_exception" not found Debug:
Error code: generalexceptionmessage

• line 235 of /mod/etherpadlite/classes/api/client.php: Error thrown
• line 247 of /mod/etherpadlite/classes/api/client.php: call to mod_etherpadlite\api\client->get_version()
• line 116 of /mod/etherpadlite/classes/api/client.php: call to mod_etherpadlite\api\client->check_version()
• line 771 of /mod/etherpadlite/classes/api/client.php: call to mod_etherpadlite\api\client->__construct()
• line 45 of /mod/etherpadlite/classes/output/component/urlsettingsnote.php: call to mod_etherpadlite\api\client::get_instance()
• line 32 of /mod/etherpadlite/settings.php: call to mod_etherpadlite\output\component\urlsettingsnote->__construct()
• line 158 of /lib/classes/plugininfo/mod.php: call to include()
• line 47 of /admin/settings/plugins.php: call to core\plugininfo\mod->load_settings()
• line 8758 of /lib/adminlib.php: call to require()
• line 8639 of /lib/adminlib.php: call to admin_get_root()
• line 19 of /admin/upgradesettings.php: call to admin_externalpage_setup()

[20-Oct-2023 14:15:15 Europe/Berlin] Default exception handler: The Moodle server could not get the api version! Your Moodle server may not be able to connect to the Etherpad server. Please check your configuration! Debug:
Error code: error_could_not_get_api_version

• line 235 of /mod/etherpadlite/classes/api/client.php: mod_etherpadlite\api\api_exception thrown
• line 247 of /mod/etherpadlite/classes/api/client.php: call to mod_etherpadlite\api\client->get_version()
• line 116 of /mod/etherpadlite/classes/api/client.php: call to mod_etherpadlite\api\client->check_version()
• line 771 of /mod/etherpadlite/classes/api/client.php: call to mod_etherpadlite\api\client->__construct()
• line 59 of /mod/etherpadlite/view.php: call to mod_etherpadlite\api\client::get_instance()

Moodle 4.2.3
pg13
PHP 8.0

[grabs]

Hi, thank you for reporting this!
Could you be a bit more specific. When do you get this error? Did you have a look into the settings. What is it showing? Maybe there was a change in your environment.

Best regards
Andreas

[ksteitz]

Hi Andreas,

thanks for your quick answer!

The first one directly during update / at the end of the update (just updated etherpad-plugin, no other changes in parallel); the second one entering the settings.
In the meantime i rolled back to the previous, working, etherpad-version. But i remember red font in the plugins-settings saying "our Moodle server may not be able to connect to the Etherpad server. Please check your configuration!"

There was NO change in our environment. Using v4.2-r5 everything works fine, so also after rollback to that version setting "2023072700" in the DB for mod_etherpadlite in mdl_config_plugins table.

Best regards and nice weekend!
Klaus

[MalteHellwig]

Hello,
we got the same issue with updating Etherpad. We updated to Moodle 4.1.6 and the Etherpad.
There were no changes made in the configuration.

This is the error: The Moodle server could not get the api version! Your Moodle server may not be able to connect to the Etherpad server. Please check your configuration!

Greetings,
Malte

[MalteHellwig]

Update:
We changed the Etherpad URL in the configuration. We just removed the last "/" in the end of the URL and it is working now.
Maybe its something similar for you... the URL we used for the earlier Version had the / at the end and worked..

Best regards!
Malte

[grabs]

Hi at all, I really can not reproduce this problem :(.
I tried with PHP 8.0 and PHP 8.1 and Moodle 4.1, 4.2 and 4.3.
I tried with and without "/" at the end of the server url.
All test were successful.
So I really don't know, what else I can do.
Maybe someone posts his plugin configuration (without the apikey of course).

Thank you!

[grabsch]

I have the same Issue. Moodle Version is 4.5 and the Plugin Etherpad-Lite ist version: v4.4 (2024071000)

Der Moodle-Server konnte die Api-Version nicht abrufen! Ihr Moodle-Server kann sich möglicherweise nicht mit dem Etherpad-Server verbinden. Bitte überprüfen Sie Ihre Konfiguration!

Weitere Informationen über diesen Fehler

Debug-Info:
Error code: error_could_not_get_api_version
Stack trace:
line 235 of /mod/etherpadlite/classes/api/client.php: mod_etherpadlite\api\api_exception thrown
line 247 of /mod/etherpadlite/classes/api/client.php: call to mod_etherpadlite\api\client->get_version()
line 116 of /mod/etherpadlite/classes/api/client.php: call to mod_etherpadlite\api\client->check_version()
line 771 of /mod/etherpadlite/classes/api/client.php: call to mod_etherpadlite\api\client->__construct()
line 59 of /mod/etherpadlite/view.php: call to mod_etherpadlite\api\client::get_instance()

The Error occurs if I have / at the end of the Setting "baseurl" and if I remove it too, that doesn't solve the problem.

[grabs]

Hi, it seems that your Moodle server cannot reach the Etherpad server.
Try connecting to the Etherpad server manually from a shell within your Moodle server using curl.
Make sure you have completed all the necessary settings correctly in the Moodle configuration for Etherpad.

[grabsch]

It can, but it seems that the moodle plugin cannot follow the redirect:

srv/php/moodle/mod/etherpadlite# curl https://pad.haw-landshut.de/api

**<title>302 Found</title>**

Found

**

The document has moved here.

**

root@ :/srv/php/moodle/mod/etherpadlite# curl https://pad.haw-landshut.de/p/api

<!doctype html>

<title>Etherpad</title> <script> /* |@licstart The following is the entire license notice for the JavaScript code in this page.|

Copyright 2011 Peter Martischka, Primary Technology.

.......

|@licend  The above is the entire license notice
for the JavaScript code in this page.|
*/

</script> <script src="../static/js/basic_error_handler.js?v=e5759f0b"></script>

[grabs]

Make sure the Moodle server can connect the Etherpad server in the same way as the user do in a browser. Otherwise it will fail.

[grabsch]

The Etherpad-Server is reachable, and the error occurs just with the newest version of the plugin. With Pugin Version: 'v3.11-r3 (2022-05-14)'; and the Buxfix from this post: https://moodle.org/mod/forum/discuss.php?d=439756 it is working.

[grabs]

Hello, unfortunately there is not much I can do :(.
You should check the following things:

Go to the console of your Moodle server and type at the prompt:
curl <etherpadlite/url>/api
You should see output like this:
{“currentVersion”: “1.3.0”}
(You need to replace <etherpadlite/url> with the URL configured in Moodle).

Call up the same url in your browser. The result should be the same.

If both checks were positive, you can check the Etherpad settings. There is an information field below the text input for the URL. It should say “Connected”.
If this is not the case, you can try activating the “Ignore security” setting.

Finally, you should check the Etherpad server to see if it is running an outdated version and needs to be updated.

Translated with DeepL.com (free version)

Best regards
Andreas