[MDL-54799] WS responses are not compatible on site error or upgrade - Moodle Tracker

XML

Word

Printable

Details

Type: Bug
Status: Closed
Priority: Major
Resolution: Fixed
Affects Version/s: 2.9.6, 3.0.4, 3.1, 3.7.2
Fix Version/s: 3.9
Component/s: Web Services
Labels:
- ci
- triaged
- webservice

Affected Branches:
MOODLE_29_STABLE, MOODLE_30_STABLE, MOODLE_31_STABLE, MOODLE_37_STABLE
Fixed Branches:
MOODLE_39_STABLE
Pull from Repository:
git://github.com/crazyserver/moodle.git
Pull Master Branch:
~~MDL-54799~~-master
Pull Master Diff URL:
https://github.com/crazyserver/moodle/compare/800563e415...MDL-54799-master
Testing Instructions:
Hide

As admin, enable "Mobile services": Site administration ► Mobile app ► Mobile settings

Create a Token in the mobile app service for user s1

Click on Site administration ► Plugins ► Web services ► Manage tokens.

Edit the config.php and add a print_error right after the require setup.php line (around line 35-36).

print_error('upgraderunning');

Open the console an execute this new curl request, replacing wstoken with the s1 token and the site url with yours.

curl 'http://localhost/m/stable_master/webservice/rest/server.php?moodlewsrestformat=json' --data 'wsfunction=core_block_get_dashboard_blocks&wstoken=630bfa4f38f4993f1514bea8a967e2fb&returncontents=1' | python -m "json.tool"

Confirm you receive an exception:

"errorcode": "upgraderunning",
"exception": "moodle_exception",
"message": "Site is being upgraded, please retry later."
Show
As admin, enable "Mobile services": Site administration ► Mobile app ► Mobile settings Create a Token in the mobile app service for user s1 Click on Site administration ► Plugins ► Web services ► Manage tokens. Edit the config.php and add a print_error right after the require setup.php line (around line 35-36). print_error('upgraderunning'); Open the console an execute this new curl request, replacing wstoken with the s1 token and the site url with yours. curl 'http://localhost/m/stable_master/webservice/rest/server.php?moodlewsrestformat=json' --data 'wsfunction=core_block_get_dashboard_blocks&wstoken=630bfa4f38f4993f1514bea8a967e2fb&returncontents=1' | python -m "json.tool" Confirm you receive an exception: "errorcode": "upgraderunning", "exception": "moodle_exception", "message": "Site is being upgraded, please retry later."

Description

When calling a WebService, if there's a site error (i.e config) or the site is upgrading it returns a HTML with the same content as web client.

It should return a WS compatible error message to avoid errors in app and WS clients.

Attachments

- Sort By Name
- Sort By Date
- Ascending
- Descending
- Thumbnails
- List
- Download All

image-2019-12-04-09-01-35-452.png
48 kB
04/Dec/19 9:01 AM

Activity

People

Assignee:: Pau Ferrer

Reporter:: Pau Ferrer

Peer reviewer:: Shamim Rezaie

Integrator:: Adrian Greeve

Tester:: Janelle Barcega

Participants:: Adrian Greeve, CiBoT, Janelle Barcega, Pau Ferrer, Ryan Wyllie, Shamim Rezaie

Component watchers:: Juan Leyva, David Woloszyn, Huong Nguyen, Jake Dallimore, Meirza, Michael Hawkins, Raquel Ortega, Safat Shahin, Stevani Andolo

Votes:: 1 Vote for this issue

Watchers:: 5 Start watching this issue

Dates

Created:: 03/Jun/16 2:42 AM

Updated:: 28/Feb/23 7:52 PM

Resolved:: 05/Dec/19 8:46 PM

Fix Release Date:: 15/Jun/20

Time Tracking

Estimated:

Remaining:

Logged:

4h 45m