Practical debugging - Историја измена

Amadannabriona у 19:42, 15. септембар 2018.

2018-09-15T19:42:50Z

← Старија измена		Верзија на датум 15. септембар 2018. у 19:42
Ред 1:		Ред 1:

	This page gives you practical tips to debug your game during ~~the~~ development. Don't hesitate to share with us ~~your difficulties in order~~ we can improve this section.		This page gives you practical tips to debug your game during development. Don't hesitate to share your difficulties with us so that we can improve this section.

	== Tools ==		== Tools ==

	To work on BGA Studio, we recommend you to use [http://www.google.com/chrome Google Chrome] as it's the ~~current~~ fastest browser for BGA platform, and it's available in all OS.		To work on BGA Studio, we recommend that you use [http://www.google.com/chrome Google Chrome] as it's currently the fastest browser for the BGA platform, and it's available for all OSes.

	Another reason to use Chrome is that it ~~embed~~ all tools you need to work on BGA Studio. You can see them by pressing "F12" or from the menu ("Tools > Development tools").		Another reason to use Chrome is that it embeds all the tools you need to work on BGA Studio. You can see them by pressing "F12" or from the menu ("Tools > Development tools").

	A good practice is to use a second browser to develop the game, in order to ~~check~~ that your game is working fine on this browser too.		A good practice is to use a second browser to develop the game, in order to verify that your game is working fine on this browser too.

	To debug with Firefox browser, we advise you to use these 2 extensions:		To debug with Firefox browser, we advise you to use these 2 extensions:
	* [https://addons.mozilla.org/firefox/addon/firebug/ Firebug]		* [https://addons.mozilla.org/firefox/addon/firebug/ Firebug]
	* [https://addons.mozilla.org/firefox/addon/web-developer/ Web ~~developper~~]		* [https://addons.mozilla.org/firefox/addon/web-developer/ Web developer]

	To debug with other browsers (IE, Edge, Opera), we advise you to use one of the most recent versions. Latest versions of the browser will likely have better development tools than the previous ones...		To debug with other browsers (IE, Edge, Opera), we advise you to use one of the most recent versions. Latest versions of the browser will likely have better development tools than the previous ones...
Ред 24:		Ред 24:
	== Debugging my game when it cannot start ==		== Debugging my game when it cannot start ==

	If your game ~~don~~'t start because of an error, you are probably in one of these situations:		If your game won't start because of an error, you are probably in one of these situations:
	* There is a SQL error in your dbmodel.sql file.		* There is a SQL error in your dbmodel.sql file.
	* You have a syntax error in your PHP file.		* You have a syntax error in your PHP file.
Ред 30:		Ред 30:

	If the error is not explicitly displayed when you click on "Express start", you should check the "Gameserver error log" as per [[Studio logs]].		If the error is not explicitly displayed when you click on "Express start", you should check the "Gameserver error log" as per [[Studio logs]].
	More cases of why game can't start described in [[Troubleshooting]] page.		More cases of why game can't start are described on the [[Troubleshooting]] page.

	== Debugging my PHP game logic (or my view) ==		== Debugging my PHP game logic (or my view) ==
Ред 36:		Ред 36:
	Most of the time, debugging PHP is quite easy. Here's what I do when I want to develop/debug some game logic that is triggered by some game action:		Most of the time, debugging PHP is quite easy. Here's what I do when I want to develop/debug some game logic that is triggered by some game action:

	* At first, I make sure that I can reproduce the needed game situation in one click. To do this, I use the "[[Tools_and_tips_of_BGA_Studio#Save_.26_restore_state\|save & restore]]" function.		* At first, I make sure that I can reproduce the needed game situation with one click. To do this, I use the "[[Tools_and_tips_of_BGA_Studio#Save_.26_restore_state\|save & restore]]" function.
	* Another possibility for this is to place a '''die('ok');''' PHP statement right after the PHP I am developing/debugging. This way, I make sure that every request will fail and then nothing will be ~~commited~~ to the database~~, anyway~~.		* Another possibility for this is to place a '''die('ok');''' PHP statement right after the PHP I am developing/debugging. This way, I make sure that every request will fail and then nothing will be committed to the database.
	* Then, I use '''var_dump''' function to dump PHP variables and check what's wrong, until it works.		* Then, I use the '''var_dump''' function to dump PHP variables and check what's wrong, until it works.

	Example:		Example:
Ред 75:		Ред 75:
	== Debugging my HTML/CSS layout ==		== Debugging my HTML/CSS layout ==

	~~Situation examples:~~		Example situations
	* why my game element doesn't show up in the interface?
	* why my CSS property hasn't been applied to this element?
	* why this game element is displayed at this position?

	A ~~first~~ useful tip when an element does not show up in the interface is to give it a red background:		* Why doesn't my game element show up in the interface?
			* Why hasn't my CSS property been applied to this element?
			* Why is this game element displayed at this position?

			A useful tip when an element does not show up in the interface is to give it a red background:
	<pre>		<pre>
	#my_element {		#my_element {
Ред 88:		Ред 89:
	</pre>		</pre>

	This way, you know if the element is not visible because of some ~~of its~~ CSS property or because of ~~anything~~ else.		This way, you know if the element is not visible because of some CSS property or because of something else.

	Another tip: sometimes, ~~you change~~ a CSS property ~~with~~ no visible effect on your interface. In that case, add a "display:none" property. If your element does not disappear, the bug probably comes from your CSS selector and not from your CSS property.		Another tip: sometimes, changing a CSS property has no visible effect on your interface. In that case, add a "display:none" property. If your element does not disappear, the bug probably comes from your CSS selector and not from your CSS property.

	Using Chrome "Elements" tab (~~thre~~ first one), you can:		Using Chrome "Elements" tab (the first one), you can:
	* See the CURRENT HTML of your page. Remember that the classical "show page source" is inefficient with BGA as you are modifying the page source with your Javascript code.		* See the CURRENT HTML of your page. Remember that the classical "show page source" is inefficient with BGA as you are modifying the page source with your Javascript code.
	* Using the "magnifying glass", you can click on any part of your game interface and check ~~it's~~ HTML code and associated CSS styles.		* Using the "magnifying glass", you can click on any part of your game interface and check its HTML code and associated CSS styles.
	* You can even modify directly some CSS ~~property~~ and see if how it looks immediately on the game interface.		* You can even modify directly some CSS properties and see how it looks immediately in the game interface.

	== Debugging my Javascript game interface logic ==		== Debugging my Javascript game interface logic ==

	~~Compare~~ to PHP debugging, Javascript debugging can sometimes be painful.		Compared to PHP debugging, Javascript debugging can sometimes be painful.

	Here's are some tips to make your life easier while developing and debugging Javascript:		Here are some tips to make your life easier while developing and debugging Javascript:

	=== Do complex things on PHP side ===		=== Do complex things on the PHP side ===

	The most frequent case is the following: you want to compute possible moves in a game situation. Doing it in Javascript is a nightmare. ~~Then, do~~ it on PHP, and transfer the ~~result~~ to your client interface using the "args" game state property.		The most frequent case is the following: you want to compute possible moves in a game situation. Doing it in Javascript is a nightmare. Do it in PHP, and transfer the results to your client interface using the "args" game state property.

	Note: ~~check~~ Reversi example ~~for this~~.		Note: See the Reversi tutorial for an example.

	=== Add traces in your code ===		=== Add traces in your code ===
Ред 123:		Ред 124:
	It will popup what you wish and pause the execution until you click ok.		It will popup what you wish and pause the execution until you click ok.

	This won't be useful for complex structures, only native types will ~~get~~ plainly displayed. But this is sometimes useful just with messages to make sure which way the execution goes.		This won't be useful for complex structures; only native types will be plainly displayed. But this is sometimes useful just with messages to make sure which way the execution goes.

	=== Use Debugger ===		=== Use Debugger ===

	Modern browsers also allow to put breakpoints in your js code.		Modern browsers also allow you to put breakpoints in your js code.

	~~That~~ will stop code execution on that line and will launch the JavaScript debugger		This will stop code execution on that line and will launch the JavaScript debugger

	== Some frequent errors ==		== Some frequent errors ==
Ред 138:		Ред 139:

	When a player creates a bug report in production, a snapshot of the game database is taken. You can get access to this snapshot from the studio by following the steps below:		When a player creates a bug report in production, a snapshot of the game database is taken. You can get access to this snapshot from the studio by following the steps below:
	* Create a table on the studio with the same game and number of players as the table for which the report has been written. Launch this table.		* Create a table in the studio with the same game and number of players as the table for which the report has been written. Launch this table.
	* Open another tab on the studio and go to "Manage game" page for your project (you have to be admin for this project)		* Open another tab on the studio and go to "Manage game" page for your project (you have to be admin for this project)
	* In the "Errors in production" section, fill up the fields "Bug report ID" (this is the ID of the bug report in production) and "Studio table ID" (this is the ID of the table you created above) then click the "⇨ Load bug report state into this table save slot #1" button.		* In the "Errors in production" section, fill up the fields "Bug report ID" (this is the ID of the bug report in production) and "Studio table ID" (this is the ID of the table you created above) then click the "⇨ Load bug report state into this table save slot #1" button.

Een: /* Get the database matching a bug report */

2018-08-02T15:28:05Z

Get the database matching a bug report

← Старија измена		Верзија на датум 2. август 2018. у 15:28
Ред 139:		Ред 139:
	When a player creates a bug report in production, a snapshot of the game database is taken. You can get access to this snapshot from the studio by following the steps below:		When a player creates a bug report in production, a snapshot of the game database is taken. You can get access to this snapshot from the studio by following the steps below:
	* Create a table on the studio with the same game and number of players as the table for which the report has been written. Launch this table.		* Create a table on the studio with the same game and number of players as the table for which the report has been written. Launch this table.
	* Open another tab on the studio and go to "Manage ~~your project~~" page for ~~this game~~ (you have to be admin for this project)		* Open another tab on the studio and go to "Manage game" page for your project (you have to be admin for this project)
	* In the "Errors in production" section, fill up the fields "Bug report ID" (this is the ID of the bug report in production) and "Studio table ID" (this is the ID of the table you created above) then click the "⇨ Load bug report state into this table save slot #1" button.		* In the "Errors in production" section, fill up the fields "Bug report ID" (this is the ID of the bug report in production) and "Studio table ID" (this is the ID of the table you created above) then click the "⇨ Load bug report state into this table save slot #1" button.
	* If the snapshot is correctly retrieved, you see a "Done!" message.		* If the snapshot is correctly retrieved, you see a "Done!" message.
	* Go back to the tab with your studio table and click "Load 1".		* Go back to the tab with your studio table and click "Load 1".
	* The page refreshes automatically and is broken. This is normal, as the player ids from the snapshot are the player ids of the production, not those of the studio. We'll need to update them.		* The page refreshes automatically and is broken. This is normal, as the player ids from the snapshot are the player ids of the production, not those of the studio. We'll need to update them.
	* Click on the "Go to game database button"		* Click on the "Go to game database" button
	* For each table using player_ids, you'll need to update the player_ids from the production to use the player_ids from the studio. You can see the player_ids from the table page before entering the game by hovering over the player names.		* For each table using player_ids, you'll need to update the player_ids from the production to use the player_ids from the studio. You can see the player_ids from the table page before entering the game by hovering over the player names.
	* Tables to update:		* Tables to update:
Ред 151:		Ред 151:
	** stats		** stats
	** tables specific to your schema that use player_ids		** tables specific to your schema that use player_ids
			* If your changes to player_ids are not taken into account, it may be a cache problem: use the "Clear PHP cache" button on your "Manage game" page.
	* Then you should be able to play with the same state of the game as when the report was created in production.		* Then you should be able to play with the same state of the game as when the report was created in production.

Een: /* Get the database matching a bug report */

2018-08-02T15:21:43Z

Get the database matching a bug report

← Старија измена		Верзија на датум 2. август 2018. у 15:21
Ред 145:		Ред 145:
	* The page refreshes automatically and is broken. This is normal, as the player ids from the snapshot are the player ids of the production, not those of the studio. We'll need to update them.		* The page refreshes automatically and is broken. This is normal, as the player ids from the snapshot are the player ids of the production, not those of the studio. We'll need to update them.
	* Click on the "Go to game database button"		* Click on the "Go to game database button"
	* For each table using player_ids, you'll need to update the player_ids from the production to use the player_ids from the studio. You can see the player_ids from the ~~studio~~ by hovering over ~~the red arrow in~~ the player ~~panels~~.		* For each table using player_ids, you'll need to update the player_ids from the production to use the player_ids from the studio. You can see the player_ids from the table page before entering the game by hovering over the player names.
	* Tables to update:		* Tables to update:
	** player		** player

Een: Retrieve database state

2018-08-02T15:10:27Z

Retrieve database state

← Старија измена		Верзија на датум 2. август 2018. у 15:10
Ред 134:		Ред 134:

	See [[Troubleshooting]].		See [[Troubleshooting]].

			== Get the database matching a bug report ==

			When a player creates a bug report in production, a snapshot of the game database is taken. You can get access to this snapshot from the studio by following the steps below:
			* Create a table on the studio with the same game and number of players as the table for which the report has been written. Launch this table.
			* Open another tab on the studio and go to "Manage your project" page for this game (you have to be admin for this project)
			* In the "Errors in production" section, fill up the fields "Bug report ID" (this is the ID of the bug report in production) and "Studio table ID" (this is the ID of the table you created above) then click the "⇨ Load bug report state into this table save slot #1" button.
			* If the snapshot is correctly retrieved, you see a "Done!" message.
			* Go back to the tab with your studio table and click "Load 1".
			* The page refreshes automatically and is broken. This is normal, as the player ids from the snapshot are the player ids of the production, not those of the studio. We'll need to update them.
			* Click on the "Go to game database button"
			* For each table using player_ids, you'll need to update the player_ids from the production to use the player_ids from the studio. You can see the player_ids from the studio by hovering over the red arrow in the player panels.
			* Tables to update:
			** player
			** global (value with ID 2 is the active player)
			** stats
			** tables specific to your schema that use player_ids
			* Then you should be able to play with the same state of the game as when the report was created in production.

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

2017-06-11T02:04:37Z

Add traces to your code

← Старија измена		Верзија на датум 11. јун 2017. у 02:04
Ред 55:		Ред 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::dump( 'name_of_variable', $variable );''' // dump variable, like var_dump but in the log debug level logging, goes to [[Studio_logs\|BGA request&SQL logs]]

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

Victoria la у 03:35, 4. јун 2017.

2017-06-04T03:35:28Z

← Старија измена		Верзија на датум 4. јун 2017. у 03:35
Ред 30:		Ред 30:

	If the error is not explicitly displayed when you click on "Express start", you should check the "Gameserver error log" as per [[Studio logs]].		If the error is not explicitly displayed when you click on "Express start", you should check the "Gameserver error log" as per [[Studio logs]].
			More cases of why game can't start described in [[Troubleshooting]] page.

	== Debugging my PHP game logic (or my view) ==		== Debugging my PHP game logic (or my view) ==
Ред 101:		Ред 102:

	=== Do complex things on PHP side ===		=== Do complex things on PHP side ===

	~~PHP side is more reliable and simpler to debug than Javascript. Then, when you need to perform a complex operation, check first it you can't write it on server side first.~~

	The most frequent case is the following: you want to compute possible moves in a game situation. Doing it in Javascript is a nightmare. Then, do it on PHP, and transfer the result to your client interface using the "args" game state property.		The most frequent case is the following: you want to compute possible moves in a game situation. Doing it in Javascript is a nightmare. Then, do it on PHP, and transfer the result to your client interface using the "args" game state property.
Ред 124:		Ред 123:
	This won't be useful for complex structures, only native types will get plainly displayed. But this is sometimes useful just with messages to make sure which way the execution goes.		This won't be useful for complex structures, only native types will get plainly displayed. But this is sometimes useful just with messages to make sure which way the execution goes.

	~~Modern browsers also allo to put the instruction in your js code~~		=== Use Debugger ===

	~~debugger;~~		Modern browsers also allow to put breakpoints in your js code.

	That will stop code execution on that line and will launch the JavaScript debugger		That will stop code execution on that line and will launch the JavaScript debugger

Victoria la: /* Tools */

2017-06-04T03:27:49Z

Tools

← Старија измена		Верзија на датум 4. јун 2017. у 03:27
Ред 14:		Ред 14:
	* [https://addons.mozilla.org/firefox/addon/web-developer/ Web developper]		* [https://addons.mozilla.org/firefox/addon/web-developer/ Web developper]

	To debug with ~~Internet Explorer~~, we advise you to use one of the most recent ~~version (ex: IE9)~~. ~~Last~~ versions of ~~Internet Explorer~~ have ~~way~~ better development tools than the previous ones...		To debug with other browsers (IE, Edge, Opera), we advise you to use one of the most recent versions. Latest versions of the browser will likely have better development tools than the previous ones...

	== General tip for debugging ==		== General tip for debugging ==

Victoria la: /* Tools */

2017-06-04T03:25:30Z

Tools

← Старија измена		Верзија на датум 4. јун 2017. у 03:25
Ред 4:		Ред 4:
	== Tools ==		== Tools ==

	To work on BGA Studio, we recommend you to use [www.google.com/chrome Google Chrome] as it's the current fastest browser for BGA platform, and it's available in all OS.		To work on BGA Studio, we recommend you to use [http://www.google.com/chrome Google Chrome] as it's the current fastest browser for BGA platform, and it's available in all OS.

	Another reason to use Chrome is that it embed all tools you need to work on BGA Studio. You can see them by pressing "F12" or from the menu ("Tools > Development tools").		Another reason to use Chrome is that it embed all tools you need to work on BGA Studio. You can see them by pressing "F12" or from the menu ("Tools > Development tools").

Morgalad: /* Add traces in your code */

2017-02-25T00:01:09Z

Add traces in your code

← Старија измена		Верзија на датум 25. фебруар 2017. у 00:01
Ред 123:		Ред 123:

	This won't be useful for complex structures, only native types will get plainly displayed. But this is sometimes useful just with messages to make sure which way the execution goes.		This won't be useful for complex structures, only native types will get plainly displayed. But this is sometimes useful just with messages to make sure which way the execution goes.

			Modern browsers also allo to put the instruction in your js code

			debugger;

			That will stop code execution on that line and will launch the JavaScript debugger

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

	See [[Troubleshooting]].		See [[Troubleshooting]].

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

2016-10-14T12:26:51Z

Add traces to your code

← Старија измена		Верзија на датум 14. октобар 2016. у 12:26
Ред 55:		Ред 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.