From 33defd068794518146b379e365f4b32dfddc3775 Mon Sep 17 00:00:00 2001 From: Sofien Haj Chedhli Date: Tue, 30 Jan 2024 10:43:23 +0100 Subject: [PATCH] fix: Remove the import documents notification upgrade plugin - EXO-68085 --- ...ortDocumentsNotificationUpgradePlugin.java | 150 ------------------ .../resources/conf/portal/configuration.xml | 39 ----- ...ocumentsNotificationUpgradePluginTest.java | 85 ---------- 3 files changed, 274 deletions(-) delete mode 100644 data-upgrade-notifications/src/main/java/org/exoplatform/portal/upgrade/notification/ImportDocumentsNotificationUpgradePlugin.java delete mode 100644 data-upgrade-notifications/src/test/java/org/exoplatform/portal/upgrade/notification/ImportDocumentsNotificationUpgradePluginTest.java diff --git a/data-upgrade-notifications/src/main/java/org/exoplatform/portal/upgrade/notification/ImportDocumentsNotificationUpgradePlugin.java b/data-upgrade-notifications/src/main/java/org/exoplatform/portal/upgrade/notification/ImportDocumentsNotificationUpgradePlugin.java deleted file mode 100644 index da20e8239..000000000 --- a/data-upgrade-notifications/src/main/java/org/exoplatform/portal/upgrade/notification/ImportDocumentsNotificationUpgradePlugin.java +++ /dev/null @@ -1,150 +0,0 @@ -package org.exoplatform.portal.upgrade.notification; - -import java.util.List; -import java.util.Optional; - -import org.exoplatform.commons.api.notification.model.PluginInfo; -import org.exoplatform.commons.api.notification.model.UserSetting; -import org.exoplatform.commons.api.notification.service.setting.PluginSettingService; -import org.exoplatform.commons.api.notification.service.setting.UserSettingService; -import org.exoplatform.commons.api.settings.SettingService; -import org.exoplatform.commons.api.settings.data.Context; -import org.exoplatform.commons.persistence.impl.EntityManagerService; -import org.exoplatform.commons.upgrade.UpgradePluginExecutionContext; -import org.exoplatform.commons.upgrade.UpgradeProductPlugin; -import org.exoplatform.container.ExoContainer; -import org.exoplatform.container.ExoContainerContext; -import org.exoplatform.container.xml.InitParams; -import org.exoplatform.services.log.ExoLogger; -import org.exoplatform.services.log.Log; - -public class ImportDocumentsNotificationUpgradePlugin extends UpgradeProductPlugin { - - private static final Log LOG = ExoLogger.getLogger(ImportDocumentsNotificationUpgradePlugin.class); - - private static final String NOTIFICATION_PLUGIN = "notification.plugin.type"; - - private final SettingService settingService; - - private final UserSettingService userSettingService; - - private final PluginSettingService pluginSettingService; - - private final EntityManagerService entityManagerService; - - private String notificationPlugin; - - private int settingsUpdateCount; - - public ImportDocumentsNotificationUpgradePlugin(SettingService settingService, - UserSettingService userSettingService, - PluginSettingService pluginSettingService, - EntityManagerService entityManagerService, - InitParams initParams) { - super(settingService, initParams); - this.settingService = settingService; - this.userSettingService = userSettingService; - this.pluginSettingService = pluginSettingService; - this.entityManagerService = entityManagerService; - if (initParams.containsKey(NOTIFICATION_PLUGIN)) { - notificationPlugin = initParams.getValueParam(NOTIFICATION_PLUGIN).getValue(); - } - } - - @Override - public boolean shouldProceedToUpgrade(String newVersion, - String previousGroupVersion, - UpgradePluginExecutionContext previousUpgradePluginExecution) { - int executionCount = previousUpgradePluginExecution == null ? 0 : previousUpgradePluginExecution.getExecutionCount(); - return !isExecuteOnlyOnce() || executionCount == 0; - } - - @Override - public void processUpgrade(String s, String s1) { - if (notificationPlugin == null || notificationPlugin.isEmpty()) { - LOG.error("Couldn't process upgrade, the parameter '{}' is mandatory", NOTIFICATION_PLUGIN); - return; - } - ExoContainer currentContainer = ExoContainerContext.getCurrentContainer(); - int pageSize = 20; - int current = 0; - settingsUpdateCount = 0; - try { - LOG.info("=== Start initialisation of {} settings", notificationPlugin); - LOG.info(" Starting activating {} Notifications for users", notificationPlugin); - - Optional optionalPluginTypeConfig = - pluginSettingService.getAllPlugins() - .stream() - .filter(pluginInfo -> pluginInfo.getType().equals(notificationPlugin)) - .findFirst(); - PluginInfo pluginTypeConfig; - if (optionalPluginTypeConfig.isPresent()) { - pluginTypeConfig = optionalPluginTypeConfig.get(); - } else { - LOG.error("Couldn't process upgrade, the '{}' plugin is missing or not found", notificationPlugin); - return; - } - List usersContexts; - entityManagerService.startRequest(currentContainer); - long startTime = System.currentTimeMillis(); - do { - LOG.info(" Progression of users {} Notifications settings initialisation : {} users", notificationPlugin, current); - // Get all users who already update their notification settings - usersContexts = settingService.getContextNamesByType(Context.USER.getName(), current, pageSize); - if (usersContexts != null) { - for (String userName : usersContexts) { - try { - entityManagerService.endRequest(currentContainer); - entityManagerService.startRequest(currentContainer); - UserSetting userSetting = this.userSettingService.get(userName); - if (userSetting != null) { - int initialSettingUpdateCount = settingsUpdateCount; - updateSetting(userSetting, pluginTypeConfig); - boolean isUserSettingsUpdated = initialSettingUpdateCount < settingsUpdateCount; - // do not save the user settings if it isn't updated. - if (isUserSettingsUpdated) { - userSettingService.save(userSetting); - } - } - } catch (Exception e) { - LOG.error(" Error while activating {} Notifications for user {} ", notificationPlugin, userName, e); - } - } - current += usersContexts.size(); - } - // Log the number of users' notification settings updated per page - LOG.info(" Notifications settings initialized for : {} from {} users", settingsUpdateCount, current); - } while (usersContexts != null && !usersContexts.isEmpty()); - long endTime = System.currentTimeMillis(); - // Log total number of users' notification settings updated. - LOG.info(" Users {} Notifications settings initialised in {} ms", notificationPlugin, (endTime - startTime)); - } catch (Exception e) { - LOG.error("Error while initialisation of users {} Notifications settings - Cause :", notificationPlugin, e.getMessage(), e); - } finally { - entityManagerService.endRequest(currentContainer); - } - LOG.info("=== {} users with modified notifications settings have been found and processed successfully", settingsUpdateCount); - LOG.info("=== End initialisation of {} Notifications settings", notificationPlugin); - } - private void updateSetting(UserSetting userSetting, PluginInfo config) { - boolean isSettingUpdated = false; - for (String defaultConf : config.getDefaultConfig()) { - for (String channelId : userSetting.getChannelActives()) { - if (userSetting.getPlugins(channelId).contains(config.getType())) { - continue; - } - if (UserSetting.FREQUENCY.getFrequecy(defaultConf) == UserSetting.FREQUENCY.INSTANTLY) { - userSetting.addChannelPlugin(channelId, config.getType()); - isSettingUpdated = true; - } else { - userSetting.addPlugin(config.getType(), UserSetting.FREQUENCY.getFrequecy(defaultConf)); - isSettingUpdated = true; - } - } - } - if (isSettingUpdated) { - settingsUpdateCount += 1; - } - } -} diff --git a/data-upgrade-notifications/src/main/resources/conf/portal/configuration.xml b/data-upgrade-notifications/src/main/resources/conf/portal/configuration.xml index 0c99fa008..1b7a501bf 100644 --- a/data-upgrade-notifications/src/main/resources/conf/portal/configuration.xml +++ b/data-upgrade-notifications/src/main/resources/conf/portal/configuration.xml @@ -65,45 +65,6 @@ - - - ImportDocumentsNotificationUpgradePlugin - addUpgradePlugin - org.exoplatform.portal.upgrade.notification.ImportDocumentsNotificationUpgradePlugin - Import Documents Notification Upgrade Plugin - - - product.group.id - The groupId of the product - org.exoplatform.platform - - - plugin.execution.order - The plugin execution order - 1 - - - plugin.upgrade.execute.once - Execute this upgrade plugin only once - true - - - plugin.upgrade.target.version - Target version of the plugin - 6.5.1 - - - plugin.upgrade.async.execution - Execute this upgrade asynchronously - true - - - notification.plugin.type - the notification plugin type - ImportDocumentsPlugin - - - diff --git a/data-upgrade-notifications/src/test/java/org/exoplatform/portal/upgrade/notification/ImportDocumentsNotificationUpgradePluginTest.java b/data-upgrade-notifications/src/test/java/org/exoplatform/portal/upgrade/notification/ImportDocumentsNotificationUpgradePluginTest.java deleted file mode 100644 index 79c60b4c2..000000000 --- a/data-upgrade-notifications/src/test/java/org/exoplatform/portal/upgrade/notification/ImportDocumentsNotificationUpgradePluginTest.java +++ /dev/null @@ -1,85 +0,0 @@ -package org.exoplatform.portal.upgrade.notification; - -import static org.mockito.Mockito.*; - -import java.util.*; - -import org.junit.AfterClass; -import org.junit.Test; -import org.junit.runner.RunWith; -import org.mockito.Mock; -import org.mockito.MockedStatic; -import org.mockito.junit.MockitoJUnitRunner; - -import org.exoplatform.commons.api.notification.model.PluginInfo; -import org.exoplatform.commons.api.notification.model.UserSetting; -import org.exoplatform.commons.api.notification.service.setting.PluginSettingService; -import org.exoplatform.commons.api.notification.service.setting.UserSettingService; -import org.exoplatform.commons.api.settings.SettingService; -import org.exoplatform.commons.api.settings.data.Context; -import org.exoplatform.commons.persistence.impl.EntityManagerService; -import org.exoplatform.container.ExoContainerContext; -import org.exoplatform.container.PortalContainer; -import org.exoplatform.container.xml.InitParams; -import org.exoplatform.container.xml.ValueParam; - -@RunWith(MockitoJUnitRunner.class) -public class ImportDocumentsNotificationUpgradePluginTest { - - private static final MockedStatic EXO_CONTAINER_CONTEXT = mockStatic(ExoContainerContext.class); - - private static final MockedStatic PORTAL_CONTAINER = mockStatic(PortalContainer.class); - - @Mock - private EntityManagerService entityManagerService; - - @Mock - private SettingService settingService; - - @Mock - private UserSettingService userSettingService; - - @Mock - private PluginSettingService pluginSettingService; - - @AfterClass - public static void afterRunBare() throws Exception { // NOSONAR - EXO_CONTAINER_CONTEXT.close(); - PORTAL_CONTAINER.close(); - } - - @Test - public void processUpgrade() throws Exception { - InitParams initParams = new InitParams(); - ValueParam valueParam = new ValueParam(); - valueParam.setName("product.group.id"); - valueParam.setValue("org.exoplatform.platform"); - initParams.addParameter(valueParam); - valueParam.setName("notification.plugin.type"); - valueParam.setValue("ImportDocumentsPlugin"); - initParams.addParam(valueParam); - PortalContainer container = mock(PortalContainer.class); - EXO_CONTAINER_CONTEXT.when(() -> ExoContainerContext.getCurrentContainer()).thenReturn(container); - PluginInfo pluginTypeConfig = mock(PluginInfo.class); - when(pluginSettingService.getAllPlugins()).thenReturn(Collections.singletonList(pluginTypeConfig)); - when(settingService.getContextNamesByType(Context.USER.getName(), 0, 20)).thenReturn(List.of("userTest")); - UserSetting userSetting = mock(UserSetting.class); - Set channelActives = new HashSet<>(); - channelActives.add("MAIL_CHANNEL"); - when(userSetting.getChannelActives()).thenReturn(channelActives); - when(userSettingService.get("userTest")).thenReturn(userSetting); - when(pluginTypeConfig.getDefaultConfig()).thenReturn(Arrays.asList("daily", "Instantly")); - when(pluginTypeConfig.getType()).thenReturn("ImportDocumentsPlugin"); - ImportDocumentsNotificationUpgradePlugin notificationUpgradePlugin = - new ImportDocumentsNotificationUpgradePlugin(settingService, - userSettingService, - pluginSettingService, - entityManagerService, - initParams); - notificationUpgradePlugin.processUpgrade(null, null); - // - verify(userSetting, times(1)).addChannelPlugin("MAIL_CHANNEL", pluginTypeConfig.getType()); - verify(userSetting, times(1)).addPlugin(pluginTypeConfig.getType(), UserSetting.FREQUENCY.getFrequecy("daily")); - verify(userSettingService, times(1)).save(userSetting); - } -}