Note: This test uses a test branch, based on integration, with the commits from the LTI migration epic also included, and where the 'ltiservice' mod_lti subplugin has been fully removed and deprecated (per the deprecation policy introduced in this patch). Setup - install a site with a dummy 3rd party plugin Note: this simulates a real site, which may have 3rd party plugins installed at the time of plugin type deprecation. Apply a dummy 3rd party service plugin. In the root of your site: cd mod/lti/service git clone https://github.com/snake/ltiservice_testservice.git testservice Now, run the site upgrade and make sure the dummy plugin is installed (you can see it on the site admin plugins overview, listed as an additional plugin). At this stage, this is just a useless plugin, but we'll use it to see what happens when we deprecate the plugin type. Phase 1 deprecation (deprecation) test Checkout the test branch git checkout main git fetch https://github.com/snake/moodle.git MDL-79843-testing git merge FETCH_HEAD Go to your site. You should be prompted to upgrade (a part of deprecating these plugintypes is version bumping, to ensure upgrade is triggered) Proceed past the env checks to the plugins check Verify : You see a red pill with "Deprecated plugin type" text for the 'testservice' plugin You see nothing in the "new version" column of the testservice plugin Note: Ignore the other plugins being removed - that's expected for this branch. Don't do anything in the web ui yet. In an editor, bump the version number in the plugin's version.php (mod/lti/service/testservice/version.php). Now, reload the page in the browser Verify you still see nothing in the "new version" column (i.e. deprecated plugins aren't being flagged for upgrade if version incremented) In your editor, change the version number back again Now reload the page and this time proceed with the site upgrade Note: ignore any capability deprecation warnings/errors. These are worsened with debugging on. When you see them, just reload the page to get past them. Once the upgrade completes, go to 'Site admin > Plugins > Overview' Scroll to the bottom Verify : you see ltiservice_testservice listed in a yellow / warning row. It has pills for 'additional' and 'deprecated plugin type' The deprecated plugin type is shown as red/error There is no 'enabled' or 'settings' in the row There is an uninstall link in the row. Click to uninstall the plugin Click to proceed Verify the plugin is uninstalled and you see the notice about removing the directory Click 'continue' Proceed past the env checks to the plugin checks At this screen, Verify you don't see the ltiservice_testservice plugin listed for reinstallation (this, again, is expected for a deprecated plugin type) Continue with the DB upgrade and verify no errors Go to "Site admin > Plugins > Overview" Verify you no longer see 'ltiservice_testservice' listed Remove this site entirely. We'll use a fresh site for the next part. Phase 2 deprecation (deletion) test Complete the entire setup process again, so you have a new site, with the 'testservice' plugin installed. Checkout the test branch git checkout main git fetch https://github.com/snake/moodle.git MDL-79843-testing git merge FETCH_HEAD Now, in your site, run through the upgrade process as you did in the earlier test Once site upgrade completes, just wait there Now, in your editor, modify the file 'mod/lti/subplugins.json' Change the following from: "deprecatedsubplugintypes": { "ltiservice": "service" } to: "deletedsubplugintypes": { "ltiservice": "service" } Save the file Bump the site version number (edit version.php) Go to the site, where upgrade should be triggered Try to proceed Verify : that site upgrade is now blocked on the env checks step You see a row for the ltiservice_testservice plugin containing information reading 'Deleted plugin detected', a message explaining what needs to be done, the plugin name and a red 'check' pill That you cannot proceed with the site upgrade at this point in time Now, run the following in your terminal: php admin/cli/uninstall_plugins.php --plugins=ltiservice_testservice --run Verify the uninstallation completes without errors. Reload the web page now Verify : you no longer see the blocker notice about the deleted plugin type you can see the 'continue' button now Click 'continue' and proceed with site upgrade, verifying it completes without errors. Go to "Site admin > plugins > overview" Verify you cannot see the ltiservice_testservice plugin listed. Don't remove your site this time - we'll reuse it for the next bit. Phase 3 deprecation (final removal) test Continuing on from above... Again, edit the mod/lti/subplugins.json file Replace the entire contents of the file with the following (i.e. 'ltiservice' has now been completely removed from the subplugin definitions): "subplugintypes": { "ltisource": "source" }, "plugintypes": { "ltisource": "mod/lti/source" }, Again, bump the site version Proceed through the upgrade and verify no errors Go to "Site admin > plugins > overview" Verify you cannot see the ltiservice_testservice plugin listed.

Code verified against automated checks with warnings. Checked MDL-79843 using repository: https://github.com/snake/moodle main (0 errors / 1 warnings) [branch: MDL-79843-main | CI Job ] overview (0/0) , phplint (0/0) , phpcs (0/0) , js (0/0) , css (0/0) , phpdoc (0/0) , commit (0/1) , savepoint (0/0) , thirdparty (0/0) , externalbackup (0/0) , grunt (0/0) , shifter (0/0) , mustache (0/0) , gherkin (0/0) , Should these errors be fixed? Built on: Wed 20 Nov 2024 05:50:08 PM UTC

Launching automatic jobs for branch MDL-79843 -main https://ci.moodle.org/view/Testing/job/DEV.02%20-%20Developer-requested%20PHPUnit/17440/ PHPUnit (sqlsrv) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59484/ Behat (NonJS - boost and classic) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59485/ Behat (Firefox - boost) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59486/ Behat (Firefox - classic) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/59487/ App tests (stable app version) Built on: Wed Nov 20 16:25:48 UTC 2024