Repository navigation
Conversation
Move the setup agent, its config and objectives, and the SOAP administration class into components/ILIAS/BackgroundTasks/src under the ILIAS\BackgroundTasks namespace. Delete the old files from BackgroundTasks_ and the empty class.ilBackgroundTasksDB80.php. ilBackgroundTasksDBHotfixes10 keeps its global class name, because the database step log stores executed steps by that class name.
Delete @inheritdoc blocks and @return or @throws tags that restate the interface or the method body. Delete the @var tag for $io in ConfigStoredObjective, which named a class that does not exist. Drop the two imports that only these docblocks used.
Contributor
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hey all,
The technical board asked me if we could remove
BackgroundTasks_and migrate the remaining code to their respective new components. This is Part 1 of 4.Why
The BackgroundTasks setup agent and its SOAP worker entry are global
il*classes, split across the legacyBackgroundTasks_directory andBackgroundTasks/classes. This MR moves them into theBackgroundTaskscomponent under its PSR-4src/layout, so the component owns its setup and its SOAP entry.What changed
Agent,SetupConfig,ConfigStoredObjective,MetricsCollectedObjective, andBackgoundWorkerObjectiveinILIAS\BackgroundTasks\Setup.ilSoapBackgroundTasksAdministrationis nowILIAS\BackgroundTasks\SOAP\Administration.BackgroundTasks.phpandinc.soap_functions.phpconstruct the new classes.class.ilBackgroundTasksDB80.phpand redundant docblocks in the moved files are deleted too.Scope
ilBackgroundTasksDBHotfixes10keeps its global name. The database step log stores executed steps by class name, so a rename runs its steps again on every installation.BackgroundTasks_stay for other MRs.Blast Radius
Setup runs and the
startBackgroundTaskWorkerSOAP call load the new classes. Behavior stays the same, and each file keeps itsstrict_typessetting. The one visible difference is the metrics objective label insetup status, which now shows the new class name. An installation finds the moved classes aftercomposer installorcomposer dump-autoload.Verification
php8.3 -lon the 8 changed PHP files shows no errors.rgfinds none of the 6 old class names outsidevendor/.php-cs-fixerwithscripts/PHP-CS-Fixer/code-format.php_csreports no changes.BackgroundTasks::initcontributes the new agent and thatstartBackgroundTaskWorkerconstructs the new SOAP class. That check fails when the old class name is put back.