How to Support Maintenance Mode

[Luke 42077]

@TeamB @quickmic  @chef  @Tolriq

See description here:

No special maintenance mode handling or detection is required for your UI to support this.

Be able to handle request errors and display them appropriately to users either in the form of a dialog or inline on screen depending on context. You can get the error message to display from the response body:

• If the body is text/plain, then the contents are the error message
• If the body is application/json - parse the contents as json, then use the Message property - this is currently not used so you could skip this for now if you wanted, but it might in the future if we ever need to attach more info to the response object.

Getting this kind of error handling in place will help you support a lot more things as well, particularly on the login screen and at the point of playback in order to display more useful error messages.

[TeamB 2438]

how are request errors identified, by the return code? i.e 5xx is usually error response

[Luke 42077]

1 hour ago, TeamB said:

how are request errors identified, by the return code? i.e 5xx is usually error response

Correct. Anything in the 400 range is generally user error or some kind of access denied. The error codes that the server most frequently uses are 400, 401, 402, 403, 404, 500 and 503.

The error code can help you decide whether to display a Refresh/Retry button along with the error message. Right now I would say anything in the 500 range would make sense to have a retry button.

The best way to beef up your error handling would be to turn on maintenance mode while using and seeing how things respond. Like for example, trying to get to a new screen, trying to click play, etc.

[TeamB 2438]

Any idea when this will be released?

 

[Luke 42077]

Very soon.

[quickmic 1703]

I think maintenance mode should be reported via websocket. Is this already covered?

[Luke 42077]

11 hours ago, quickmic said:

I think maintenance mode should be reported via websocket. Is this already covered?

I need to add that for admins so that the main dashboard can immediately show and hide a banner about it. It's needed there since admins api requests are not blocked by this.

But in your case, if you were to depend on that as your only maintenance mode detection then I think that is not a good idea. There might be a use case for it to supplement and use it to improve and react quicker, but i would not use it as a replacement for the basic error handling that I mentioned above.