Making changes show up during development - Revision history

Strobotta: Some enhancements and clarifications that I encountered during my developer experience.

2023-11-14T08:24:06Z

Some enhancements and clarifications that I encountered during my developer experience.

← Older revision		Revision as of 08:24, 14 November 2023
Line 86:		Line 86:
	\|see below		\|see below
	\|}		\|}

	== PHP ==		== PHP ==
	After changing the PHP files (*.php), you should just need to press reload (F5) in your browser.		After changing the PHP files (*.php), you should just need to press reload (F5) in your browser.
Line 93:		Line 92:
	=== Adding or removing an autoloaded class ===		=== Adding or removing an autoloaded class ===
	If you get class-not-found errors, you need to either do any of these:		If you get class-not-found errors, you need to either do any of these:

	* GUI: visit <nowiki>http://your.domain/moodle</nowiki>'''/admin'''		* GUI: visit <nowiki>http://your.domain/moodle</nowiki>'''/admin'''
	* File system: Delete the file '''core_component.php''' in the moodledata cache directory.		* File system: Delete the file '''core_component.php''' in the moodledata cache directory.

	== JavaScript ==		== JavaScript ==
			'''Note''': if you do plugin development run the grunt task from the base directory of your plugin, not Moodle root. This speeds up the build process, because only the js files in your plugin will be build (which is way faster than building everyting from Moodle root).

	=== AMD Modules ===		=== AMD Modules ===
	While changing older [[Javascript Modules\|AMD Javascript Module]] source files (amd/src/*.js), if you have Administration -> Appearance -> AJAX and Javascript -> Cache Javascript turned off, then you should just need to reload (F5) in your browser. If JS caching is on, you need to re-run grunt, because Moodle will always prefer to load the minified modules then.		While changing older [[Javascript Modules\|AMD Javascript Module]] source files (amd/src/*.js), if you have Administration -> Appearance -> AJAX and Javascript -> Cache Javascript turned off, then you should just need to reload (F5) in your browser. If JS caching is on, you need to re-run grunt, because Moodle will always prefer to load the minified modules then.

	=== ES Modules ===		=== ES Modules ===
	If you're using the newer ES module syntax, you always have to re-run grunt or have it running in watch mode, as the normal js files need to be transpiled by grunt (using babel) to be usable.		If you're using the newer ES module syntax, you always have to re-run grunt or have it running in watch mode, as the normal js files need to be transpiled by grunt (using babel) to be usable.

	== CSS, SCSS, LESS ==		== CSS, SCSS, LESS ==
	After changing the CSS styles (.css, .scss, *.less) you may either:		After changing the CSS styles (.css, .scss, *.less) you may either:

	* GUI: Purge all caches via '''/admin/purgecaches.php'''		* GUI: Purge all caches via '''/admin/purgecaches.php'''
			* CLI: run '''php admin/purgecaches.php'''
	* "developer way": Write a mini script that calls '''theme_reset_all_caches()'''		* "developer way": Write a mini script that calls '''theme_reset_all_caches()'''

	== Language strings ==		== Language strings ==
	After changing language pack strings (lang/en/type_plugin.php), you may either:		After changing language pack strings (lang/en/type_plugin.php), you may either:
	* Prevention: The best option is to turn off Admin -> Language -> Language settings -> Cache all language strings when doing development. Then you only need to press F5 to refresh to see your changes.		* Prevention: The best option is to turn off Admin -> Language -> Language settings -> Cache all language strings when doing development. Then you only need to press F5 to refresh to see your changes.
	* GUI: Otherwise you need to Purge all caches (or just the Language strings cache) before reloading.		* GUI: Otherwise you need to Purge all caches (or just the Language strings cache) before reloading.
			* CLI: run '''php admin/purgecaches.php'''
	* "developer_way": Write a mini script that calls '''get_string_manager()->reset_caches()'''		* "developer_way": Write a mini script that calls '''get_string_manager()->reset_caches()'''
	== Capabilities ==		== Capabilities ==
Line 121:		Line 117:
	# Go to admin -> Notifications.		# Go to admin -> Notifications.
	Then check that the capabilities show up on Site administration > Users > Permissions > Define roles for any role.		Then check that the capabilities show up on Site administration > Users > Permissions > Define roles for any role.

	== Events ==		== Events ==
	After changing event listeners (db/events.php) you don't seem to need to do anything. Event listeners don't seem to be cached in any way.		After changing event listeners (db/events.php) you don't seem to need to do anything. Event listeners don't seem to be cached in any way.

	== Scheduled tasks ==		== Scheduled tasks ==
	After changing scheduled tasks (db/tasks.php) you need to		After changing scheduled tasks (db/tasks.php) you need to
Line 133:		Line 127:
	After changing web services (db/services.php) ...		After changing web services (db/services.php) ...
	== Database structure ==		== Database structure ==
	After changing the database scheme (db/install.xml, db/upgrade.php) ...		After changing the database scheme (db/install.xml, db/upgrade.php):

			* Run the update process of you Moodle site before doing any of your custom schema changes.
			* Make a database dump now with a recent up to date database.
			* Bump the version and then run the upgrade process.
			* Check that your changes are in place as you want them, if not restore the dump and rerun the update/install process.
	== PHPunit ==		== PHPunit ==
			After you add/delete/rename any files that contain php unittests, you need to re-run:
			$ php admin/tool/phpunit/cli/init.php

	== Behat ==		== Behat ==
	After you add a new *.feature file, you need to re-run		After you add a new *.feature file, you need to re-run

Danowar: Added an overview table, talked about opcache, added something about ES modules, threw CSS + SCSS + LESS together, categorized possible actions in "GUI", "developer way" or "file system", added Events section (no caching detected)

2021-09-16T11:25:05Z

Added an overview table, talked about opcache, added something about ES modules, threw CSS + SCSS + LESS together, categorized possible actions in "GUI", "developer way" or "file system", added Events section (no caching detected)

Show changes

Finns: /* Capabilities */

2020-03-06T15:00:08Z

Capabilities

← Older revision		Revision as of 15:00, 6 March 2020
Line 52:		Line 52:
	# Go to admin -> Notifications.		# Go to admin -> Notifications.

	Then check that the ~~capabilitie shows~~ up on Site administration > Users > Permissions > Define roles for any role.		Then check that the capabilities show up on Site administration > Users > Permissions > Define roles for any role.

	== Scheduled tasks ==		== Scheduled tasks ==

Plemaire: /* Capabilities */

2019-04-04T09:56:12Z

Capabilities

← Older revision		Revision as of 09:56, 4 April 2019
Line 47:		Line 47:
	== Capabilities ==		== Capabilities ==

	After changing capabilities (db/access.php) ...		After changing capabilities (db/access.php) you need to

			# Bump the plugin version number.
			# Go to admin -> Notifications.

			Then check that the capabilitie shows up on Site administration > Users > Permissions > Define roles for any role.

	== Scheduled tasks ==		== Scheduled tasks ==

TimHunt: /* Language strings */

2019-03-29T15:23:25Z

Language strings

← Older revision		Revision as of 15:23, 29 March 2019
Line 40:		Line 40:
	== Language strings ==		== Language strings ==

	After changing language pack strings (lang/en/type_plugin.php) ...		After changing language pack strings (lang/en/type_plugin.php):

			* The best option is to turn off Admin -> Language -> Language settings -> Cache all language strings when doing development. Then you only need to press F5 to refresh to see your changes.
			* Otherwise you need to Purge all caches (or just the Language strings cache) before reloading.

	== Capabilities ==		== Capabilities ==

TimHunt: /* Scheduled tasks */

2019-03-29T15:18:06Z

Scheduled tasks

← Older revision		Revision as of 15:18, 29 March 2019
Line 48:		Line 48:
	== Scheduled tasks ==		== Scheduled tasks ==

	After changing scheduled tasks (db/tasks.php) ...		After changing scheduled tasks (db/tasks.php) you need to

			# Bump the plugin version number.
			# Go to admin -> Notifications.

			Then check that the task shows up on Admin -> Server -> Scheduled tasks.

	== Web services ==		== Web services ==

Mudrd8mz: Restructure to give headings nicer URLs

2019-03-26T19:00:49Z

Restructure to give headings nicer URLs

Show changes

TimHunt: TimHunt moved page Making changes show up during Moodle development to Making changes show up during development without leaving a redirect

2019-03-26T16:43:56Z

TimHunt moved page Making changes show up during Moodle development to Making changes show up during development without leaving a redirect

← Older revision	Revision as of 16:43, 26 March 2019
(No difference)

TimHunt: /* Changing web services (db/services.php) */

2019-03-26T16:27:17Z

Changing web services (db/services.php)

← Older revision		Revision as of 16:27, 26 March 2019
Line 42:		Line 42:
	===Changing web services (db/services.php)===		===Changing web services (db/services.php)===

	===Changing database strucutre (db/install.xml, db/upgrade.php)		===Changing database strucutre (db/install.xml, db/upgrade.php)===

	===Adding a new PHPunit test===		===Adding a new PHPunit test===

TimHunt: Created page with "Sometime, when you are trying to do Moodle development, you edit the code, and nothing seems to change as a result. This is because, to improve performance, Moodle now has all..."

2019-03-26T16:26:39Z

Created page with "Sometime, when you are trying to do Moodle development, you edit the code, and nothing seems to change as a result. This is because, to improve performance, Moodle now has all..."

New page

Sometime, when you are trying to do Moodle development, you edit the code, and nothing seems to change as a result. This is because, to improve performance, Moodle now has all sorts of caching built in. When this is happening, this page will try to give you the quickest way to make your changes show up in all situation.

However, this page is still quite new, so please help build it.

==General advice==

# In your development site, change most of the admin settings like 'Cache language strings', 'Cache JavaScript' to be suitalble for development. (But note that doing this will slow down your development site.
# If in doubt, visit <nowiki>http://your.domain/moodle</nowiki>'''/admin''' to check that the Moodle install is up-to-date.
# And then <nowiki>http://your.domain/moodle</nowiki>'''/vle/admin/purgecaches.php''' and click the 'Purge all caches' button. This will slow things down for the next few requests, until the caches have re-populated.
# Depending on what you changed in your plugin, then in addition to the above, you may need to remember to increase the version number in version.php, or the changes will not show up.
# You may have forgotted to run grunt.
# If you have just added a new Behat or PHPunit test, you may need to re-run admin/tool/.../cli/init.php.

The above steps are a brute force approach. They will probably work, but are probably not the fastest way. Below, we list for all the various type of change you can make, the most efficient way to make the change show up.

==Changes in the Moodle and Moodle plugins==

===Changing PHP (*.php)===

You should just need to press reload (F5) in your browser.

===Adding or removing an auto-loaded class===

If you get class-not-found errors, you need to visit <nowiki>http://your.domain/moodle</nowiki>'''/admin'''.

===Changing JavaScript (amd/src/*.js)===

If you have Administration -> Appearance -> AJAX and Javascript -> Cache Javascript turned off, then you should just need to reload (F5) in your browser.

If JS caching is on, you need to re-run grunt. (Do you also need to purge a cache??? I don't think so.)

===Changing CSS (*.css)===

===Changing SCSS/LESS (*.scss/*.less)===

===Changing language strings (lang/en/type_plugin.php)===

===Changing capabilities (db/access.php)===

===Changing scheduled tasks (db/tasks.php)===

===Changing web services (db/services.php)===

===Changing database strucutre (db/install.xml, db/upgrade.php)

===Adding a new PHPunit test===

===Adding a new Behat test===

You need to re-run

php admin/tool/behat/cli/init.php

or any newly-added *.feature file will not be found.

==Changes in mobile support for plugins==

If you are doing the kind of development descrived in [[Mobile support for plugins]], using a pre-built version of the app like https://mobileapp.moodledemo.net/.

Note, these steps were originally written by people mostly on question type plugins. Hopefully they are generally applicable, but if they don't make sense in your case, that might be why. Please edit to improve them.

===General note it you are seeing a lot of errors===

If there are lots of red error messages appearing in the JavaScript console (but not the very common error 'ERROR Error: Uncaught (in promise): null...' that repeats every minute and fills the console logs!) it is often necessary to clear site data and restart.

# In browser developer tools, go to Application -> Clear storage.
# Close the browser, and re-launch.

===Adding mobile support to a plugin for the first time===

# Bump the plugin version number.
# Go to admin -> Notifications.
# F5 in the app to restart.

===Change in existing template (mobile/*.html)===

Just pull down in the app to refresh.

===Adding a new template (mobile/*.html)===

???

===Change to existing client-side JavaScript (mobile/*.js)

Press F5 in the browser developer tools to restart the app.

===New client-side JavaScript (mobile/*.js)

===Change to server-side classes/output/mobile.php - ???

===Changing CSS===

# bump version number in db/mobile.php
# purge caches (specifically the tool_mobile/plugininfo MUC cache)
# Press F5 to restart the app.

==Changes in the Moodle mobile app==

TODO.