[5.2] Add offline mode support in the API

[wilsonge]

Pull Request for Issue # .

Summary of Changes

Adds support for the onBeforeRender and onAfterRender events to the API. It should be noted our core plugin correctly checks for html document types or if in site/admin modes in most places. The only exception to this is the cache plugin. However I think this won't change much because we don't call onAfterRoute in the API which does all the initialisation anyhow.

Adds support for offline mode to the API - if the site is in offline mode the API now should not be made available to users who cannot access it alongside an appropriate 503 status code

Testing Instructions

Turn on Offline mode. Before this PR check that the API is accessible. After PR you get a 503 error code.

For the Plugin events this should be as easy as dropping some test functions into an existing plugin.

Documentation Changes Required

N/A

[richard67]

Testing instructions
Turn on API mode.

@wilsonge I assume you meant "offline mode" and not "API mode", or there is a new feature "API mode" in J4 of which I don't know yet.

[richard67]

@wilsonge It seems you have to adjust the API tests to the changes in this PR. Currently they fail with:

1) BasicCest: Test route not found
 Test  tests/Codeception/api/BasicCest.php:testRouteNotFound
 Step  See response code is 404
 Fail  Expected HTTP Status Code: 404 (Not Found). Actual Status Code: 503 (Service Unavailable)
Failed asserting that 503 matches expected 404.

[wilsonge]

Yup I did mean Offline mode - fixed that. Will look at tests tonight :)

[wilsonge]

Tests fixed

[alikon]

humm got 500 shoduln't be 503 ?

{
    "errors": [
        {
            "code": 500,
            "title": "Internal server error",
            "detail": "Joomla\\CMS\\Application\\Exception\\OfflineWebsiteException: This site is down for maintenance.<br />Please check back again soon. in /var/www/html/cloud/libraries/src/Application/ApiApplication.php:162\nStack trace:\n#0 /var/www/html/cloud/libraries/src/Application/CMSApplication.php(284): Joomla\\CMS\\Application\\ApiApplication->render()\n#1 /var/www/html/cloud/api/includes/app.php(54): Joomla\\CMS\\Application\\CMSApplication->execute()\n#2 /var/www/html/cloud/api/index.php(31): require_once('/var/www/html/c...')\n#3 {main}"
        }
    ]
}

[wilsonge]

Fixed

[alikon]

something is going wrong in your merge

joomla-cms/libraries/src/Error/Renderer/JsonapiRenderer.php

Line 69 in e0727da

$errors->registerHandler(new InstallLanguageExceptionHandler);

fe93f16

[alikon]

i dunno if this was already there...
anyway with
core.login.offline = false and wrong request articlesx
got this from postman

my usual dirty hack wilsonge#67

[wilsonge]

That one is a bit hacky :) will debug when I’m in front of my laptop this evening. May be there’s nothing better but 🤷‍♂️

[laoneo]

Can you remove this event triggering, so we can merge it in 4.3 and make a new pr on 5.0. I fear these events will have some undesired effect, so it is better to add it in 5.0 and document it properly.

[laoneo]

Same as comment above.

[laoneo]

@wilsonge any interest to move this one forward?

[HLeithner]

This pull request has been automatically rebased to 5.0-dev. No new features will be merged into Joomla! 4.3 series. Joomla! 4.4 series is a bridge release to make migration from Joomla! 4 to 5 as smooth as possible.

[HLeithner]

This pull request has been automatically rebased to 5.1-dev.

[HLeithner]

This pull request has been automatically rebased to 5.2-dev.