Practical debugging - Istor ar c'hemmoù

Victoria la: /* Add traces to your code */

2016-10-14T12:26:51Z

Add traces to your code

← Stumm kent		Stumm eus an 14 Her 2016 da 12:26
Linenn 55:		Linenn 55:
	You can use the following functions in your game to add server side logging:		You can use the following functions in your game to add server side logging:

	'''self::debug( $message );''' // debug level logging		'''self::debug( $message );''' // debug level logging, goes to [[Studio_logs\|BGA request&SQL logs]]

	'''self::trace( $message );''' // info level logging		'''self::trace( $message );''' // info level logging, goes to [[Studio_logs\|BGA request&SQL logs]]

	'''self::warn( $message );''' // warning level logging		'''self::warn( $message );''' // warning level logging, goes to [[Studio_logs#BGA_unexpected_exceptions_logs\|BGA unexpected exceptions log]]

	'''self::error( $message );''' // error level logging		'''self::error( $message );''' // error level logging, goes to [[Studio_logs#BGA_unexpected_exceptions_logs\|BGA unexpected exceptions log]]

	~~To see the logs, you should check the "Current table error log" in the~~ [[~~Studio_back-office\|~~Studio ~~backoffice~~]].		Check [[Studio logs]] for more details on how to access your logs.

	This can be useful when you need to follow the flow of your code and not just stop it to see how it goes at some point.		This can be useful when you need to follow the flow of your code and not just stop it to see how it goes at some point.

Victoria la: /* Some frequent errors */

2016-07-29T01:06:06Z

Some frequent errors

← Stumm kent		Stumm eus an 29 Gou 2016 da 01:06
Linenn 126:		Linenn 126:
	== Some frequent errors ==		== Some frequent errors ==

	~~=== when launching the game "Fatal error during creation of database ebd_quoridor_389 Not logged." ===~~		See [[Troubleshooting]].

	~~Check that you didn't use $g_user or getCurrentPlayerId() in setupNewGame() function or in an "args" function of your state.~~

	~~As these functions are not consequences of a user action, there is no current player defined.~~

	~~As a general rule, you should use getActivePlayerId() and not getCurrentPlayerId().~~ See ~~the~~ [~~http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine presentation on the game state machine~~] ~~for more information.~~

	~~=== when refreshing the web page, the interface remains on "Application loading..." ===~~

	~~In this case, you probably have a syntax error in your Javascript code, and the interface refuses to load.~~

	~~To find this error, check if there is an error message in the Javascript console (F12).~~

	If there is really nothing on the log, it's probably that the system was unable to load your Javascript because of an syntax error that affect the structure of the Javascript file, typically a missing "}" or a missing "," after a method definition.

	~~=== When I do a move, I got "Move recorded, waiting for update ..." forever ===~~

	~~"Move recorded" means that your ajaxcall request has been sent to the server and returned normally.~~

	~~"Waiting for update" means that your client interface is waiting for some notifications from the server that correspond to the move we just did.~~

	If this message stays forever, it is probably that your PHP code does not send any notification when the move happens, which is abnormal. To fix this: add a notifyAllPlayers or a notifyPlayer call in your PHP code.

	~~=== Some player action is triggered randomly when I click somewhere on the game area ===~~

	~~You probably used "dojo.connect" on a null object. In this case, dojo.connect associate the event (ex: "onclick") to the whole game area.~~

	~~Most of the time it happens in this situation, when my_object element does not exists:~~
	~~<pre>~~
	~~dojo.connect( $("my_object"), "onclick", this, function() {~~
	~~...~~
	}
	~~</pre>~~

	~~To determine if this is the case, place "alert( $("my_object") )" before the dojo.connect to check if the object exists or not.~~

	~~=== Javascript does not know how to sum two numbers ===~~

	~~Be careful when you manipulate integers returned by notifications: most of the time, Javascript considers they are Strings and not Integers.~~

	~~As a result:~~
	~~<pre>~~
	~~var i=1;~~
	~~i += notif.args.increment; // With notif.args.increment='1'~~
	~~alert( i ); // i=11 instead of 2 !! Javascript concatenate 2 strings !~~
	~~</pre>~~

	~~To solve this, you should use the "toint" function:~~
	~~<pre>~~
	~~var i=1;~~
	~~i += toint( notif.args.increment ); // With notif.args.increment='1'~~
	~~alert( i ); // i=2 :)~~
	~~</pre>~~

	~~=== Javascript: do not use substr with negative numbers ===~~

	~~To get the last characters of a string, use "slice" instead of "substr" which has a bug on IE:~~
	~~<pre>~~
	~~var three_last_characters = string.substr( -3 ); // Wrong~~
	~~var three_last_characters = string~~.~~slice( -3 ); // Correct~~
	~~</pre>~~

Denis: /* Debugging my game when it cannot start */

2014-11-20T20:40:25Z

Debugging my game when it cannot start

← Stumm kent		Stumm eus an 20 Du 2014 da 20:40
Linenn 29:		Linenn 29:
	* Your PHP "setup" - or any method used during the game initial states - generates an exception.		* Your PHP "setup" - or any method used during the game initial states - generates an exception.

	If the error is not explicitly displayed when you click on "Express start", you should check the "Gameserver error log" ~~in the~~ [[~~Studio_back-office\|~~Studio ~~backoffice~~]].		If the error is not explicitly displayed when you click on "Express start", you should check the "Gameserver error log" as per [[Studio logs]].

	== Debugging my PHP game logic (or my view) ==		== Debugging my PHP game logic (or my view) ==

Een: /* Add traces to your code */

2013-05-19T20:14:01Z

Add traces to your code

← Stumm kent		Stumm eus an 19 Mae 2013 da 20:14
Linenn 55:		Linenn 55:
	You can use the following functions in your game to add server side logging:		You can use the following functions in your game to add server side logging:

	'''self::debug( $message )'''		'''self::debug( $message );''' // debug level logging

	'''self::trace( $message )'''		'''self::trace( $message );''' // info level logging

	'''self::warn( $message )'''		'''self::warn( $message );''' // warning level logging

	'''self::error( $message )'''		'''self::error( $message );''' // error level logging

	To see the logs, you should check the "Current table error log" in the [[Studio_back-office\|Studio backoffice]].		To see the logs, you should check the "Current table error log" in the [[Studio_back-office\|Studio backoffice]].

Een: /* Debugging my PHP game logic (or my view) */

2013-05-19T19:32:34Z

Debugging my PHP game logic (or my view)

← Stumm kent		Stumm eus an 19 Mae 2013 da 19:32
Linenn 50:		Linenn 50:

	</pre>		</pre>

			=== Add traces to your code ===

			You can use the following functions in your game to add server side logging:

			'''self::debug( $message )'''

			'''self::trace( $message )'''

			'''self::warn( $message )'''

			'''self::error( $message )'''

			To see the logs, you should check the "Current table error log" in the [[Studio_back-office\|Studio backoffice]].

			This can be useful when you need to follow the flow of your code and not just stop it to see how it goes at some point.

			Only the error log level will appear in production. This level should be used only for critical problems.
			Other levels will show only in the development environment and can be used as you see fit.

	== Debugging my HTML/CSS layout ==		== Debugging my HTML/CSS layout ==

Een: /* Javascript does not know how to sum two numbers */

2013-02-15T15:09:18Z

Javascript does not know how to sum two numbers

← Stumm kent		Stumm eus an 15 C'hwe 2013 da 15:09
Linenn 155:		Linenn 155:
	</pre>		</pre>

	To solve this, ~~to hesitate to~~ use the "toint" function:		To solve this, you should use the "toint" function:
	<pre>		<pre>
	var i=1;		var i=1;

Sourisdudesert: /* Javascript does not know how to sum two numbers */

2013-01-30T16:35:03Z

Javascript does not know how to sum two numbers

@@ Linenn 160: / Linenn 160: @@
      i += toint( notif.args.increment );  // With notif.args.increment='1'
      alert( i );                 // i=2 :)
 </pre>

Sourisdudesert: /* Some frequent errors */

2013-01-30T16:31:34Z

Some frequent errors

← Stumm kent		Stumm eus an 30 Gen 2013 da 16:31
Linenn 122:		Linenn 122:

	If there is really nothing on the log, it's probably that the system was unable to load your Javascript because of an syntax error that affect the structure of the Javascript file, typically a missing "}" or a missing "," after a method definition.		If there is really nothing on the log, it's probably that the system was unable to load your Javascript because of an syntax error that affect the structure of the Javascript file, typically a missing "}" or a missing "," after a method definition.

			=== When I do a move, I got "Move recorded, waiting for update ..." forever ===

			"Move recorded" means that your ajaxcall request has been sent to the server and returned normally.

			"Waiting for update" means that your client interface is waiting for some notifications from the server that correspond to the move we just did.

			If this message stays forever, it is probably that your PHP code does not send any notification when the move happens, which is abnormal. To fix this: add a notifyAllPlayers or a notifyPlayer call in your PHP code.

			=== Some player action is triggered randomly when I click somewhere on the game area ===

			You probably used "dojo.connect" on a null object. In this case, dojo.connect associate the event (ex: "onclick") to the whole game area.

			Most of the time it happens in this situation, when my_object element does not exists:
			<pre>
			dojo.connect( $("my_object"), "onclick", this, function() {
			...
			}
			</pre>

			To determine if this is the case, place "alert( $("my_object") )" before the dojo.connect to check if the object exists or not.

			=== Javascript does not know how to sum two numbers ===

			Be careful when you manipulate integers returned by notifications: most of the time, Javascript considers they are Strings and not Integers.

			As a result:
			<pre>
			var i=1;
			i += notif.args.increment; // With notif.args.increment='1'
			alert( i ); // i=11 instead of 2 !! Javascript concatenate 2 strings !
			</pre>

			To solve this, to hesitate to use the "toint" function:
			<pre>
			var i=1;
			i += toint( notif.args.increment ); // With notif.args.increment='1'
			alert( i ); // i=2 :)
			</pre>

Sourisdudesert: /* Some frequent errors */

2013-01-30T16:17:01Z

Some frequent errors

← Stumm kent		Stumm eus an 30 Gen 2013 da 16:17
Linenn 114:		Linenn 114:

	As a general rule, you should use getActivePlayerId() and not getCurrentPlayerId(). See the [http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine presentation on the game state machine] for more information.		As a general rule, you should use getActivePlayerId() and not getCurrentPlayerId(). See the [http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine presentation on the game state machine] for more information.

			=== when refreshing the web page, the interface remains on "Application loading..." ===

			In this case, you probably have a syntax error in your Javascript code, and the interface refuses to load.

			To find this error, check if there is an error message in the Javascript console (F12).

			If there is really nothing on the log, it's probably that the system was unable to load your Javascript because of an syntax error that affect the structure of the Javascript file, typically a missing "}" or a missing "," after a method definition.

Sourisdudesert: /* Some frequent errors */

2013-01-29T22:49:46Z

Some frequent errors

← Stumm kent		Stumm eus an 29 Gen 2013 da 22:49
Linenn 106:		Linenn 106:

	== Some frequent errors ==		== Some frequent errors ==

			=== when launching the game "Fatal error during creation of database ebd_quoridor_389 Not logged." ===

			Check that you didn't use $g_user or getCurrentPlayerId() in setupNewGame() function or in an "args" function of your state.

			As these functions are not consequences of a user action, there is no current player defined.

			As a general rule, you should use getActivePlayerId() and not getCurrentPlayerId(). See the [http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine presentation on the game state machine] for more information.