Module uninstall #7442

juggernautsei · 2024-05-20T01:27:05Z

Short description of what this resolves:

Changes proposed in this pull request:

sjpadgett · 2024-05-20T12:28:16Z

@claimrevolution Need you to look this over today. Want for patch!

sjpadgett

Just need to finish the task handling for enable and disable actions. Thanks for taking care of the bootstrap includes. I'm surprised we let that slide when bringing module into core.
I'm not testing and leaving that to you.

sjpadgett · 2024-05-20T21:36:16Z

interface/modules/custom_modules/oe-module-claimrev-connect/moduleConfig.php

+use OpenEMR\Core\ModulesClassLoader;
+
+require_once dirname(__FILE__, 4) . '/globals.php';
+
+/* required for config before install */
+$classLoader = new ModulesClassLoader($GLOBALS['fileroot']);
+$classLoader->registerNamespaceIfNotExists("OpenEMR\\Modules\\ClaimRevConnector\\", __DIR__ . DIRECTORY_SEPARATOR . 'src');
+
+$module_config = 1;


If the MM config/settings frame is not being used by a module, this file is not required. Regardless, what you have here is fine but just not required fyi.

sjpadgett · 2024-05-20T21:50:00Z

interface/modules/custom_modules/oe-module-claimrev-connect/ModuleManagerListener.php

+     * @param string $col
+     * @return array
+     */
+    function getModuleRegistry($modId, $col = '*'): array


I may move to abstract class or trait for convivence just a fyi.

sjpadgett · 2024-05-20T21:55:33Z

interface/modules/custom_modules/oe-module-claimrev-connect/ModuleManagerListener.php

+//    private function install($modId, $currentActionStatus): mixed
+//    {
+//        $modService = new ModuleServices();
+//        /* setting the active ui flag here will allow the config button to show
+//         * before enable. This is a good thing because it allows the user to
+//         * configure the module before enabling it. However, if the module is disabled
+//         * this flag is reset by MM.
+//        */
+//        $modService::setModuleState($modId, '0', '1');
+//        return $currentActionStatus;
+//    }


For readability either delete comment methods or just have them return $currentActionStatus. I opt to leave empty methods in place for future reference though all available method call but MM action events are listed in the abstract class or should be.. Sorry, I think I didn't update that class for last couple new events I added to MM. I will soon.

Bottom line, need to lose all the commented lines. I prefer if you leave empty method.

private function install($modId, $currentActionStatus): mixed { $modService = new ModuleServices(); /* setting the active ui flag here will allow the config button to show * before enable. This is a good thing because it allows the user to * configure the module before enabling it. However, if the module is disabled * this flag is reset by MM. */ return $currentActionStatus; }

I was unsure of the role of the comment methods. I commented them out to make sure they were not causing the issue that I was facing at the time. I will uncomment. I think that will be best for future utilization

sjpadgett · 2024-05-20T23:09:49Z

interface/modules/custom_modules/oe-module-claimrev-connect/ModuleManagerListener.php

+//    private function disable($modId, $currentActionStatus): mixed
+//    {
+//        // allow config button to show before enable.
+//        ModuleServices::setModuleState($modId, '0', '1');
+//        return $currentActionStatus;
+//    }


uncomment method and add action to disable tasks because module is now disabled. You can make this cleaner or use below. Just use same for enable action by setting active to 1. Then unregister action will delete tasks so default table.sql will reinstall.

UPDATE `background_services` SET `active` = '0' WHERE `background_services`.`name` = 'ClaimRev_Elig_Send_Receive'; UPDATE `background_services` SET `active` = '0' WHERE `background_services`.`name` = 'ClaimRev_Receive'; UPDATE `background_services` SET `active` = '0' WHERE `background_services`.`name` = 'ClaimRev_Send';

@juggernautsei You still need the enable and disable tasks i.e active flag. If user disables then background tasks don't have access to module so need to make tasks inactive. Same with reverse and enable action. You're only half way there.
See the sql example I gave above for disable.

sjpadgett · 2024-05-20T23:12:09Z

interface/modules/custom_modules/oe-module-claimrev-connect/ModuleManagerListener.php

+     * @param $currentActionStatus
+     * @return mixed
+     */
+//    private function reset_module($modId, $currentActionStatus): mixed


If needed or wanted, this gets called also when unregistered action is called.

When I enabled all the methods that were commented out. The module will not install. It can enable but it won't install. I have uploaded what I have. The code does not produce any errors in the errors in the logs.

I will try to figure this out tomorrow. I got some other stuff to work on right now.

@juggernautsei Just delete the unused methods(commented). The controller will simply ignore them. You need unregister, enable and disable for task maintenance.

I figured out what you were saying and just return current status. I have installed and removed. It removes all the globals and tables.

I wanted a cleanup action that I chose to name reset i.e. reset module to a state before original install. All these still need to be documented but besides our admins, you and Brad, I've seen no third party user make any attempt to give feedback or contrib.
So, you're in the know now so to say:)

@sjpadgett I move the getModuleState method into the listener. The reset_module method is not being called. I checked the error log and it does not show there. The background services are being removed but not the table or globals as you would know.

Forget reset_module just delete it you won't be using.
You don't need getModuleState. I wrote those for how I use weno module actions.
All you need is enable method with the sql to set the 3 active flag in background services, disable to unset active flag in background service table and what you already have to delete the tasks.

got it and here are the updates.

sjpadgett · 2024-05-22T17:31:33Z

interface/modules/custom_modules/oe-module-claimrev-connect/ModuleManagerListener.php

+        $sql = "DELETE FROM `globals` WHERE `gl_name` LIKE 'oe_claimrev%'";
+        $rtn = sqlQuery($sql);
+        $logMessage .= "DELETE FROM `globals`: " . (empty($rtn) ? "Success" : "Failed") . "\n";

-        // return log messages to the MM to show user.
-        return text($logMessage);
-    }
-
-    public static function getModuleState($modId): bool
-    {
-        $sql = "SELECT `mod_active` FROM `modules` WHERE `mod_id` = ? OR `mod_directory` = ?";
-        $flag = sqlQuery($sql, array($modId, $modId));
-
-        return !empty($flag['mod_active']);
+        $sql = "DROP TABLE IF EXISTS `mod_claimrev_eligibility`";
+        $rtn = sqlQuery($sql);
+        $logMessage .= "DROP TABLE `mod_claimrev_eligibility`: " . (empty($rtn) ? "Success" : "Failed") . "\n";


Don't do this and leave it up to Brad to remove history by dropping tables or globals.
We are only worried about background services.
Please Please just add the enable and disable and unregister methods. I've explain enable and disabled with example in my comments. If you need a call let me know.

sjpadgett · 2024-05-23T18:57:24Z

Thanks for doing Brads job here @juggernautsei I appreciate it as well as all those users that enable the module then decide to disable.
I've seen on a user site this issue causing one to three fatal errors every time background service ran every one to two minutes.

I'm looking into making this class mandatory or module will not get initialized from boot.
Anyway good job my friend and I'll be merging

sjpadgett · 2024-05-23T18:59:18Z

woops! forgot to squash!

…nager Module uninstall (cherry picked from commit 4e8432a)

…7455) Module uninstall (cherry picked from commit 4e8432a)

juggernautsei · 2024-05-24T08:53:30Z

It is always a learning experience with you. I seek after as much. I will go back to some of my modules and revamp them to include this basic feature request starting with the Quest module. Always improving.

juggernautsei added 2 commits May 19, 2024 21:25

Module uninstall

b9e7550

Module uninstall PSR

d67e6fc

sjpadgett requested changes May 20, 2024

View reviewed changes

juggernautsei added 6 commits May 21, 2024 07:05

Not working to install

add592e

PSR

1dc24a6

It is working now.

22c5ff3

reset_module is not being called

eb74f87

reset_module removed and moved into

3654cce

forgot/missed one line

338ac46

sjpadgett reviewed May 22, 2024

View reviewed changes

juggernautsei added 2 commits May 22, 2024 14:31

understanding is hard to come by sometimes

7d4ed14

as requested

8d71c34

sjpadgett approved these changes May 23, 2024

View reviewed changes

sjpadgett merged commit 4e8432a into openemr:master May 23, 2024
25 checks passed

sjpadgett added a commit to sjpadgett/openemr that referenced this pull request May 23, 2024

Merge pull request openemr#7442 from juggernautsei/claimrev-module-ma…

cb4d179

…nager Module uninstall (cherry picked from commit 4e8432a)

sjpadgett added a commit that referenced this pull request May 23, 2024

Merge pull request #7442 from juggernautsei/claimrev-module-manager (#…

7588b4f

…7455) Module uninstall (cherry picked from commit 4e8432a)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Module uninstall #7442

Module uninstall #7442

juggernautsei commented May 20, 2024

sjpadgett commented May 20, 2024

sjpadgett left a comment

sjpadgett May 20, 2024

sjpadgett May 20, 2024

sjpadgett May 20, 2024

juggernautsei May 21, 2024

sjpadgett May 20, 2024

sjpadgett May 21, 2024

sjpadgett May 20, 2024

juggernautsei May 21, 2024

juggernautsei May 21, 2024

sjpadgett May 21, 2024

juggernautsei May 21, 2024

sjpadgett May 21, 2024

juggernautsei May 22, 2024

sjpadgett May 22, 2024

juggernautsei May 22, 2024

sjpadgett May 22, 2024

sjpadgett commented May 23, 2024

sjpadgett commented May 23, 2024

juggernautsei commented May 24, 2024

Module uninstall #7442

Module uninstall #7442

Conversation

juggernautsei commented May 20, 2024

Short description of what this resolves:

Changes proposed in this pull request:

sjpadgett commented May 20, 2024

sjpadgett left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sjpadgett commented May 23, 2024

sjpadgett commented May 23, 2024

juggernautsei commented May 24, 2024