Responses - Revision history

Benzac at 09:41, 3 July 2026

2026-07-03T09:41:52Z

Benzac at 09:41, 3 July 2026

2026-07-03T09:41:06Z

Benzac at 09:37, 3 July 2026

2026-07-03T09:37:16Z

Benzac at 18:54, 26 June 2026

2026-06-26T18:54:49Z

Benzac: /* Error Handling */

2026-06-26T18:50:24Z

Error Handling

Benzac at 18:46, 26 June 2026

2026-06-26T18:46:59Z

Benzac: /* Error Handling */

2026-06-26T18:46:13Z

Error Handling

Benzac at 18:45, 26 June 2026

2026-06-26T18:45:56Z

Benzac at 10:01, 18 January 2021

2021-01-18T10:01:24Z

Benzac at 13:26, 14 January 2021

2021-01-14T13:26:35Z

@@ Line 79: / Line 79: @@
 |}
-'''Note: MSX is a pure client-side framework. There is no server component included — you provide the JSON endpoints on any HTTP server of your choice. MSX fetches these URLs, parses the responses, and renders the UI or executes the action. Please note that every HTTP request made by MSX has a timeout of 30 seconds. If no response is received within this time, MSX discards the request and shows a timeout error to the user. Design your endpoints to respond well within this limit.'''
+'''Note: MSX is a pure client-side framework. There is no server component included — you provide the JSON endpoints on any HTTP server of your choice. MSX fetches these URLs, parses the responses, and renders the UI or executes the action. Please note that every HTTP request made by MSX has a timeout of 30 seconds. If no response is received within this time, MSX discards the request and throws an internal error. Design your endpoints to respond well within this limit.'''
 == Error Handling ==

@@ Line 99: / Line 99: @@
 | '''Request timeout'''
 | No response received within '''30 seconds'''.
-| MSX discards the request and shows a timeout error to the user.
+| MSX discards the request and throws an internal error.
 |}
 The <code>response</code> wrapper was introduced specifically to work around the limitation that many TV platforms cannot reliably display non-200 HTTP errors. By always returning HTTP 200 and encoding the error state inside the <code>response</code> object, errors are guaranteed to reach the user.

@@ Line 79: / Line 79: @@
 |}
-'''Note: MSX is a pure client-side framework. There is no server component included — you provide the JSON endpoints on any HTTP server of your choice. MSX fetches these URLs, parses the responses, and renders the UI or executes the action. Please note that every HTTP request made by MSX has a timeout of 30 seconds. If no response is received within this time, the request is silently discarded and MSX throws an internal error. Design your endpoints to respond well within this limit.'''
+'''Note: MSX is a pure client-side framework. There is no server component included — you provide the JSON endpoints on any HTTP server of your choice. MSX fetches these URLs, parses the responses, and renders the UI or executes the action. Please note that every HTTP request made by MSX has a timeout of 30 seconds. If no response is received within this time, MSX discards the request and shows a timeout error to the user. Design your endpoints to respond well within this limit.'''
 == Error Handling ==
@@ Line 99: / Line 99: @@
 | '''Request timeout'''
 | No response received within '''30 seconds'''.
-| MSX discards the request and throws an internal error.
+| MSX discards the request and shows a timeout error to the user.
 |}
 The <code>response</code> wrapper was introduced specifically to work around the limitation that many TV platforms cannot reliably display non-200 HTTP errors. By always returning HTTP 200 and encoding the error state inside the <code>response</code> object, errors are guaranteed to reach the user.

@@ Line 79: / Line 79: @@
 |}
-'''Note: MSX is a pure client-side framework. There is no server component included — you provide the JSON endpoints on any HTTP server of your choice. MSX fetches these URLs, parses the responses, and renders the UI. Please note that every HTTP request made by MSX has a timeout of 30 seconds. If no response is received within this time, the request is silently discarded and MSX throws an internal error. Design your endpoints to respond well within this limit.'''
+'''Note: MSX is a pure client-side framework. There is no server component included — you provide the JSON endpoints on any HTTP server of your choice. MSX fetches these URLs, parses the responses, and renders the UI or executes the action. Please note that every HTTP request made by MSX has a timeout of 30 seconds. If no response is received within this time, the request is silently discarded and MSX throws an internal error. Design your endpoints to respond well within this limit.'''
 == Error Handling ==

← Older revision		Revision as of 18:50, 26 June 2026
Line 102:		Line 102:
	\|}		\|}

−	The <code>response</code> wrapper was introduced specifically to work around the limitation that many TV platforms cannot reliably display non-200 HTTP errors. By always returning HTTP 200 and encoding the error state inside the <code>response</code> object, errors are guaranteed to reach the user. ~~Please use the following recommended pattern for server-side errors.~~	+	The <code>response</code> wrapper was introduced specifically to work around the limitation that many TV platforms cannot reliably display non-200 HTTP errors. By always returning HTTP 200 and encoding the error state inside the <code>response</code> object, errors are guaranteed to reach the user.
−
−	~~<syntaxhighlight lang="json">~~
−	{
−	~~"response": {~~
−	~~"status": 503,~~
−	~~"text": "Service Unavailable",~~
−	~~"message": "External API did not respond in time. Please try again.",~~
−	~~"data": null~~
−	}
−	}
−	~~</syntaxhighlight>~~
−
−	'''Note: If your endpoint calls an external API that may be slow or unreachable, implement a server-side timeout shorter than 30 seconds and return a <code>response</code> error object — rather than letting MSX hit the hard client-side timeout.'''

@@ Line 87: / Line 87: @@
 {| class="wikitable"
 |-
-! Scenario ! Cause ! Behavior
+! Scenario !! Cause !! Behavior
 |-
 | '''HTTP error'''

@@ Line 83: / Line 83: @@
 == Error Handling ==
-There are three distinct error scenarios:
+There are three distinct error scenarios.
 {| class="wikitable"

← Older revision		Revision as of 18:45, 26 June 2026
Line 78:		Line 78:
	This property is only used in success responses and contains the actual JSON data.		This property is only used in success responses and contains the actual JSON data.
	\|}		\|}
		+
		+	'''Note: MSX is a pure client-side framework. There is no server component included — you provide the JSON endpoints on any HTTP server of your choice. MSX fetches these URLs, parses the responses, and renders the UI. Please note that every HTTP request made by MSX has a timeout of 30 seconds. If no response is received within this time, the request is silently discarded and MSX throws an internal error. Design your endpoints to respond well within this limit.'''
		+
		+	== Error Handling ==
		+
		+	There are three distinct error scenarios:
		+
		+	{\| class="wikitable"
		+	\|-
		+	! Scenario ! Cause ! Behavior
		+	\|-
		+	\| '''HTTP error'''
		+	\| The server returns a non-2xx HTTP status (e.g. 404, 500).
		+	\| Platform-dependent. Most TV platforms cannot display error details in this case — the error message may appear or a generic one is shown. '''Avoid relying on this for user-facing error details.'''
		+	\|-
		+	\| '''Response error'''
		+	\| The server returns HTTP 200 but the <code>response.status</code> is not <code>200</code>.
		+	\| MSX displays the <code>message</code> property to the user. This is the '''recommended approach''' for surfacing errors, because it works reliably across all TV platforms.
		+	\|-
		+	\| '''Request timeout'''
		+	\| No response received within '''30 seconds'''.
		+	\| MSX discards the request and throws an internal error.
		+	\|}
		+
		+	The <code>response</code> wrapper was introduced specifically to work around the limitation that many TV platforms cannot reliably display non-200 HTTP errors. By always returning HTTP 200 and encoding the error state inside the <code>response</code> object, errors are guaranteed to reach the user. Please use the following recommended pattern for server-side errors.
		+
		+	<syntaxhighlight lang="json">
		+	{
		+	"response": {
		+	"status": 503,
		+	"text": "Service Unavailable",
		+	"message": "External API did not respond in time. Please try again.",
		+	"data": null
		+	}
		+	}
		+	</syntaxhighlight>
		+
		+	'''Note: If your endpoint calls an external API that may be slow or unreachable, implement a server-side timeout shorter than 30 seconds and return a <code>response</code> error object — rather than letting MSX hit the hard client-side timeout.'''

@@ Line 60: / Line 60: @@
 {| class="wikitable sortable"
-|+ Property syntax of responses
+|+ Property syntax of response object
 |-
 ! Property !! Type !! Default Value !! Mandatory !! Since Version !! class="unsortable" | Description

@@ Line 57: / Line 57: @@
+}
 </syntaxhighlight>
-Please see '''[[Actions#Server Actions]]''' for more information.
+Please see [[Actions#Server Actions]] for more information.
 {| class="wikitable sortable"