feature: Add log for sending add works reminder to profile_event …

…table
ORCID · Dec 15, 2023 · 2d1d09e · 2d1d09e
1 parent 085f3c8
commit 2d1d09e
Show file tree

Hide file tree

Showing 23 changed files with 158 additions and 58 deletions.
diff --git a/orcid-core/src/main/java/org/orcid/core/manager/impl/NotificationManagerImpl.java b/orcid-core/src/main/java/org/orcid/core/manager/impl/NotificationManagerImpl.java
@@ -49,6 +49,7 @@
 import org.orcid.persistence.dao.GenericDao;
 import org.orcid.persistence.dao.NotificationDao;
 import org.orcid.persistence.dao.ProfileDao;
+import org.orcid.persistence.dao.ProfileEventDao;
 import org.orcid.persistence.jpa.entities.ActionableNotificationEntity;
 import org.orcid.persistence.jpa.entities.ClientDetailsEntity;
 import org.orcid.persistence.jpa.entities.ClientRedirectUriEntity;
@@ -83,7 +84,7 @@ public class NotificationManagerImpl extends ManagerReadOnlyBaseImpl implements
     private EncryptionManager encryptionManager;
 
     @Resource
-    private GenericDao<ProfileEventEntity, Long> profileEventDao;
+    private ProfileEventDao profileEventDao;
 
     @Resource
     private ProfileDao profileDao;
@@ -128,7 +129,7 @@ public void setEncryptionManager(EncryptionManager encryptionManager) {
         this.encryptionManager = encryptionManager;
     }
 
-    public void setProfileEventDao(GenericDao<ProfileEventEntity, Long> profileEventDao) {
+    public void setProfileEventDao(ProfileEventDao profileEventDao) {
         this.profileEventDao = profileEventDao;
     }
 

diff --git a/orcid-core/src/main/java/org/orcid/core/manager/impl/TwoFactorAuthenticationManagerImpl.java b/orcid-core/src/main/java/org/orcid/core/manager/impl/TwoFactorAuthenticationManagerImpl.java
@@ -13,8 +13,8 @@
 import org.orcid.core.manager.TwoFactorAuthenticationManager;
 import org.orcid.core.manager.read_only.EmailManagerReadOnly;
 import org.orcid.jaxb.model.record_v2.Email;
-import org.orcid.persistence.dao.GenericDao;
 import org.orcid.persistence.dao.ProfileDao;
+import org.orcid.persistence.dao.ProfileEventDao;
 import org.orcid.persistence.jpa.entities.ProfileEntity;
 import org.orcid.persistence.jpa.entities.ProfileEventEntity;
 import org.orcid.persistence.jpa.entities.ProfileEventType;
@@ -40,7 +40,7 @@ public class TwoFactorAuthenticationManagerImpl implements TwoFactorAuthenticati
     private BackupCodeManager backupCodeManager;
 
     @Resource
-    private GenericDao<ProfileEventEntity, Long> profileEventDao;
+    private ProfileEventDao profileEventDao;
 
     @Resource
     private ProfileDao profileDao;

diff --git a/orcid-core/src/main/java/org/orcid/core/manager/v3/impl/NotificationManagerImpl.java b/orcid-core/src/main/java/org/orcid/core/manager/v3/impl/NotificationManagerImpl.java
@@ -55,6 +55,7 @@
 import org.orcid.persistence.dao.GenericDao;
 import org.orcid.persistence.dao.NotificationDao;
 import org.orcid.persistence.dao.ProfileDao;
+import org.orcid.persistence.dao.ProfileEventDao;
 import org.orcid.persistence.jpa.entities.ActionableNotificationEntity;
 import org.orcid.persistence.jpa.entities.ClientDetailsEntity;
 import org.orcid.persistence.jpa.entities.ClientRedirectUriEntity;
@@ -101,7 +102,7 @@ public class NotificationManagerImpl extends ManagerReadOnlyBaseImpl implements
     private EncryptionManager encryptionManager;
 
     @Resource
-    private GenericDao<ProfileEventEntity, Long> profileEventDao;
+    private ProfileEventDao profileEventDao;
 
     @Resource
     private ProfileDao profileDao;
@@ -175,7 +176,7 @@ public void setEncryptionManager(EncryptionManager encryptionManager) {
         this.encryptionManager = encryptionManager;
     }
 
-    public void setProfileEventDao(GenericDao<ProfileEventEntity, Long> profileEventDao) {
+    public void setProfileEventDao(ProfileEventDao profileEventDao) {
         this.profileEventDao = profileEventDao;
     }
 

diff --git a/...core/src/main/java/org/orcid/core/profileEvent/EmailFrequencyServiceAnnouncement2018.java b/...core/src/main/java/org/orcid/core/profileEvent/EmailFrequencyServiceAnnouncement2018.java
@@ -19,14 +19,15 @@
 import org.kohsuke.args4j.CmdLineException;
 import org.kohsuke.args4j.CmdLineParser;
 import org.kohsuke.args4j.Option;
-import org.orcid.core.manager.NotificationManager;
 import org.orcid.core.manager.TemplateManager;
 import org.orcid.core.manager.impl.OrcidUrlManager;
 import org.orcid.core.manager.v3.RecordNameManager;
 import org.orcid.jaxb.model.notification_v2.NotificationType;
 import org.orcid.persistence.dao.GenericDao;
 import org.orcid.persistence.dao.NotificationDao;
 import org.orcid.persistence.dao.ProfileDao;
+import org.orcid.persistence.dao.ProfileEventDao;
+import org.orcid.persistence.dao.impl.ProfileEventDaoImpl;
 import org.orcid.persistence.jpa.entities.NotificationServiceAnnouncementEntity;
 import org.orcid.persistence.jpa.entities.ProfileEntity;
 import org.orcid.persistence.jpa.entities.ProfileEventEntity;
@@ -54,7 +55,7 @@ public class EmailFrequencyServiceAnnouncement2018 {
 
     private TemplateManager templateManager;
 
-    private GenericDao<ProfileEventEntity, Long> profileEventDao;    
+    private ProfileEventDao profileEventDao;    
 
     private NotificationDao notificationDao;
 
@@ -100,7 +101,7 @@ private void init() {
         profileDaoReadOnly = (ProfileDao) context.getBean("profileDaoReadOnly");
         messages = (MessageSource) context.getBean("messageSource");
         templateManager = (TemplateManager) context.getBean("templateManager");
-        profileEventDao = (GenericDao) context.getBean("profileEventDao");
+        profileEventDao = (ProfileEventDao) context.getBean("profileEventDao");
         notificationDao = (NotificationDao) context.getBean("notificationDao");
         orcidUrlManager = (OrcidUrlManager) context.getBean("orcidUrlManager");
         recordNameManager = (RecordNameManager) context.getBean("recordNameManagerV3");

diff --git a/orcid-core/src/main/java/org/orcid/core/profileEvent/ProfileEventManager.java b/orcid-core/src/main/java/org/orcid/core/profileEvent/ProfileEventManager.java
@@ -15,8 +15,8 @@
 import org.kohsuke.args4j.CmdLineException;
 import org.kohsuke.args4j.CmdLineParser;
 import org.kohsuke.args4j.Option;
-import org.orcid.persistence.dao.GenericDao;
 import org.orcid.persistence.dao.ProfileDao;
+import org.orcid.persistence.dao.ProfileEventDao;
 import org.orcid.persistence.jpa.entities.ProfileEventEntity;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -37,7 +37,7 @@ public class ProfileEventManager {
     private ProfileDao profileDao;
 
     @Resource
-    private GenericDao<ProfileEventEntity, Long> profileEventDao;
+    private ProfileEventDao profileEventDao;
 
     @Resource
     private TransactionTemplate transactionTemplate;
@@ -136,11 +136,11 @@ public void setProfileDao(ProfileDao profileDao) {
         this.profileDao = profileDao;
     }
 
-    public GenericDao<ProfileEventEntity, Long> getProfileEventDao() {
+    public ProfileEventDao getProfileEventDao() {
         return profileEventDao;
     }
 
-    public void setProfileEventDao(GenericDao<ProfileEventEntity, Long> profileEventDao) {
+    public void setProfileEventDao(ProfileEventDao profileEventDao) {
         this.profileEventDao = profileEventDao;
     }
 

diff --git a/...ava/org/orcid/core/profileEvent/quarterlyNotifications/QuarterlyNotificationsManager.java b/...ava/org/orcid/core/profileEvent/quarterlyNotifications/QuarterlyNotificationsManager.java
@@ -22,6 +22,7 @@
 import org.orcid.persistence.dao.GenericDao;
 import org.orcid.persistence.dao.NotificationDao;
 import org.orcid.persistence.dao.ProfileDao;
+import org.orcid.persistence.dao.ProfileEventDao;
 import org.orcid.persistence.jpa.entities.EmailFrequencyEntity;
 import org.orcid.persistence.jpa.entities.NotificationTipEntity;
 import org.orcid.persistence.jpa.entities.ProfileEntity;
@@ -41,7 +42,7 @@ public abstract class QuarterlyNotificationsManager {
 
     private static Logger LOG = LoggerFactory.getLogger(QuarterlyNotificationsManager.class);
 
-    private GenericDao<ProfileEventEntity, Long> profileEventDao;
+    private ProfileEventDao profileEventDao;
 
     private ProfileDao profileDaoReadOnly;
 
@@ -89,7 +90,7 @@ public QuarterlyNotificationsManager(ProfileEventType created, ProfileEventType
         notificationDao = (NotificationDao) context.getBean("notificationDao");        
         orcidUrlManager = (OrcidUrlManager) context.getBean("orcidUrlManager");
         emailFrequencyDao = (EmailFrequencyDao) context.getBean("emailFrequencyDao");
-        profileEventDao = (GenericDao) context.getBean("profileEventDao");
+        profileEventDao = (ProfileEventDao) context.getBean("profileEventDao");
         encryptionManager = (EncryptionManager) context.getBean("encryptionManager");
         messages = (MessageSource) context.getBean("messageSource");
         transactionTemplate = (TransactionTemplate) context.getBean("transactionTemplate");

diff --git a/orcid-core/src/test/java/org/orcid/core/manager/NotificationManagerTest.java b/orcid-core/src/test/java/org/orcid/core/manager/NotificationManagerTest.java
@@ -55,6 +55,7 @@
 import org.orcid.persistence.dao.GenericDao;
 import org.orcid.persistence.dao.NotificationDao;
 import org.orcid.persistence.dao.ProfileDao;
+import org.orcid.persistence.dao.ProfileEventDao;
 import org.orcid.persistence.dao.impl.NotificationDaoImpl;
 import org.orcid.persistence.jpa.entities.ClientDetailsEntity;
 import org.orcid.persistence.jpa.entities.NotificationEntity;
@@ -80,7 +81,7 @@ public class NotificationManagerTest extends DBUnitTest {
 
 
     @Mock
-    private GenericDao<ProfileEventEntity, Long> profileEventDao;
+    private ProfileEventDao profileEventDao;
 
     @Mock
     private SourceManager sourceManager;

diff --git a/orcid-core/src/test/java/org/orcid/core/manager/TwoFactorAuthenticationManagerTest.java b/orcid-core/src/test/java/org/orcid/core/manager/TwoFactorAuthenticationManagerTest.java
@@ -28,6 +28,7 @@
 import org.orcid.jaxb.model.record_v2.Email;
 import org.orcid.persistence.dao.GenericDao;
 import org.orcid.persistence.dao.ProfileDao;
+import org.orcid.persistence.dao.ProfileEventDao;
 import org.orcid.persistence.jpa.entities.ProfileEntity;
 import org.orcid.persistence.jpa.entities.ProfileEventEntity;
 
@@ -49,7 +50,7 @@ public class TwoFactorAuthenticationManagerTest {
     private ProfileDao profileDao;
 
     @Mock
-    private GenericDao<ProfileEventEntity, Long> profileEventDao;
+    private ProfileEventDao profileEventDao;
 
     @InjectMocks
     private TwoFactorAuthenticationManagerImpl twoFactorAuthenticationManager;

diff --git a/orcid-core/src/test/java/org/orcid/core/manager/v3/NotificationManagerTest.java b/orcid-core/src/test/java/org/orcid/core/manager/v3/NotificationManagerTest.java
@@ -64,6 +64,7 @@
 import org.orcid.persistence.dao.GenericDao;
 import org.orcid.persistence.dao.NotificationDao;
 import org.orcid.persistence.dao.ProfileDao;
+import org.orcid.persistence.dao.ProfileEventDao;
 import org.orcid.persistence.dao.impl.NotificationDaoImpl;
 import org.orcid.persistence.jpa.entities.ClientDetailsEntity;
 import org.orcid.persistence.jpa.entities.EmailEventEntity;
@@ -90,7 +91,7 @@ public class NotificationManagerTest extends DBUnitTest {
             "/data/BiographyEntityData.xml");
 
     @Mock
-    private GenericDao<ProfileEventEntity, Long> profileEventDao;
+    private ProfileEventDao profileEventDao;
 
     @Mock
     private SourceManager mockSourceManager;

diff --git a/orcid-persistence/src/main/java/org/orcid/persistence/dao/ProfileDao.java b/orcid-persistence/src/main/java/org/orcid/persistence/dao/ProfileDao.java
@@ -164,5 +164,5 @@ public interface ProfileDao extends GenericDao<ProfileEntity, String> {
 
     boolean haveMemberPushedWorksOrAffiliationsToRecord(String orcid, String clientId);
 
-    public List<Pair<String, String>> findEmailsToSendAddWorksEmail();
+    public List<Pair<String, String>> findEmailsToSendAddWorksEmail(int profileCreatedNumberOfDaysAgo);
 }
diff --git a/orcid-persistence/src/main/java/org/orcid/persistence/dao/ProfileEventDao.java b/orcid-persistence/src/main/java/org/orcid/persistence/dao/ProfileEventDao.java
@@ -0,0 +1,15 @@
+package org.orcid.persistence.dao;
+
+import org.orcid.persistence.jpa.entities.ProfileEventEntity;
+import org.orcid.persistence.jpa.entities.ProfileEventType;
+
+/**
+ *
+ * @author Daniel Palafox
+ *
+ */
+public interface ProfileEventDao extends GenericDao<ProfileEventEntity, Long> {
+
+    boolean isAttemptSend(String orcid, ProfileEventType eventType);
+
+}
diff --git a/orcid-persistence/src/main/java/org/orcid/persistence/dao/impl/ProfileDaoImpl.java b/orcid-persistence/src/main/java/org/orcid/persistence/dao/impl/ProfileDaoImpl.java
@@ -842,18 +842,19 @@ public boolean haveMemberPushedWorksOrAffiliationsToRecord(String orcid, String
     }
 
     @Override
-    public List<Pair<String, String>> findEmailsToSendAddWorksEmail() {
+    public List<Pair<String, String>> findEmailsToSendAddWorksEmail(int profileCreatedNumberOfDaysAgo) {
         StringBuilder qs = new StringBuilder("SELECT e.email, p.orcid FROM email e ");
         qs.append("LEFT JOIN email_frequency ef ON e.orcid = ef.orcid ");
         qs.append("LEFT OUTER JOIN work w ON e.orcid = w.orcid ");
         qs.append("JOIN profile p on p.orcid = e.orcid and p.claimed = true AND p.deprecated_date is null AND ");
         qs.append("p.profile_deactivation_date is null AND p.account_expiry is null ");
         qs.append("WHERE ");
-        qs.append(getWorkCreatedNumberOfDaysAgo("7"));
-        qs.append("OR ");
-        qs.append(getWorkCreatedNumberOfDaysAgo("28"));
-        qs.append("OR ");
-        qs.append(getWorkCreatedNumberOfDaysAgo("90"));
+        qs.append("e.is_verified = true and e.is_primary = true and ");
+        qs.append("ef.send_quarterly_tips = true and ");
+        qs.append("w.orcid is null and ");
+        qs.append("CAST(p.date_created as date) = CAST(CURRENT_DATE - INTERVAL '");
+        qs.append(profileCreatedNumberOfDaysAgo);
+        qs.append("' day as date) ");
         qs.append("GROUP BY e.email, p.orcid");
 
         Query query = entityManager.createNativeQuery(qs.toString());
@@ -866,10 +867,4 @@ public List<Pair<String, String>> findEmailsToSendAddWorksEmail() {
         return results;
     }
 
-    private String getWorkCreatedNumberOfDaysAgo(String days) {
-        return "e.is_verified = true and e.is_primary = true and\n" +
-                "      ef.send_quarterly_tips = true and\n" +
-                "      w.orcid is null and\n" +
-                "      CAST(p.date_created as date) = CAST(CURRENT_DATE - INTERVAL '"+ days +"' day as date) ";
-    }
 }
diff --git a/orcid-persistence/src/main/java/org/orcid/persistence/dao/impl/ProfileEventDaoImpl.java b/orcid-persistence/src/main/java/org/orcid/persistence/dao/impl/ProfileEventDaoImpl.java
@@ -0,0 +1,28 @@
+package org.orcid.persistence.dao.impl;
+
+import org.orcid.persistence.dao.ProfileEventDao;
+import org.orcid.persistence.jpa.entities.ProfileEventEntity;
+import org.orcid.persistence.jpa.entities.ProfileEventType;
+
+import javax.persistence.Query;
+import java.math.BigInteger;
+import java.util.List;
+
+/**
+ *
+ * @author Daniel Palafox
+ *
+ */
+public class ProfileEventDaoImpl extends GenericDaoImpl<ProfileEventEntity, Long> implements ProfileEventDao {
+
+    public ProfileEventDaoImpl() { super(ProfileEventEntity.class); }
+
+    @Override
+    public boolean isAttemptSend(String orcid, ProfileEventType eventType) {
+        Query query = entityManager.createNativeQuery("select count(*) from profile_event where orcid=:orcid and profile_event_type=:eventType");
+        query.setParameter("orcid", orcid);
+        query.setParameter("eventType", eventType.toString());
+        Long result = ((BigInteger)query.getSingleResult()).longValue();
+        return (result != null && result > 0);
+    }
+}
diff --git a/orcid-persistence/src/main/java/org/orcid/persistence/jpa/entities/EmailEventType.java b/orcid-persistence/src/main/java/org/orcid/persistence/jpa/entities/EmailEventType.java
@@ -12,7 +12,5 @@ public enum EmailEventType {
     VERIFY_EMAIL_7_DAYS_SENT_SKIPPED, /* we are going to skip notifying email address that where already in the system before launching this */
     VERIFY_EMAIL_2_DAYS_SENT,
     VERIFY_EMAIL_2_DAYS_SENT_SKIPPED,
-    VERIFY_EMAIL_TOO_OLD,
-    ENCOURAGE_USER_TO_ADD_WORKS_EMAIL_SENT,
-    ENCOURAGE_USER_TO_ADD_WORKS_EMAIL_SENT_SKIPPED;
+    VERIFY_EMAIL_TOO_OLD;
 }
diff --git a/orcid-persistence/src/main/java/org/orcid/persistence/jpa/entities/ProfileEventType.java b/orcid-persistence/src/main/java/org/orcid/persistence/jpa/entities/ProfileEventType.java
@@ -36,5 +36,13 @@ public enum ProfileEventType {
     EMAIL_VIS_2019_SENT, EMAIL_VIS_2019_SKIPPED, EMAIL_VIS_2019_FAILED,
 
     // 2FA enable/disable events
-    PROFILE_2FA_ENABLED, PROFILE_2FA_DISABLED, PROFILE_2FA_DISABLED_BY_ADMIN;
+    PROFILE_2FA_ENABLED, PROFILE_2FA_DISABLED, PROFILE_2FA_DISABLED_BY_ADMIN,
+
+    //Send email to encourage users to add works to their record
+    ADD_WORKS_FIRST_REMINDER_SENT,
+    ADD_WORKS_FIRST_REMINDER_SENT_SKIPPED,
+    ADD_WORKS_SECOND_REMINDER_SENT,
+    ADD_WORKS_SECOND_REMINDER_SENT_SKIPPED,
+    ADD_WORKS_THIRD_REMINDER_SENT,
+    ADD_WORKS_THIRD_REMINDER_SENT_SKIPPED;
 }
diff --git a/orcid-persistence/src/main/resources/orcid-persistence-context.xml b/orcid-persistence/src/main/resources/orcid-persistence-context.xml
@@ -207,9 +207,7 @@
         <constructor-arg value="org.orcid.persistence.jpa.entities.CountryIsoEntity" />
     </bean>
 
-    <bean id="profileEventDao" class="org.orcid.persistence.dao.impl.GenericDaoImpl">
-        <constructor-arg value="org.orcid.persistence.jpa.entities.ProfileEventEntity" />
-    </bean>    
+    <bean id="profileEventDao" class="org.orcid.persistence.dao.impl.ProfileEventDaoImpl" />
 
     <bean id="emailEventDao" class="org.orcid.persistence.dao.impl.GenericDaoImpl">
         <constructor-arg value="org.orcid.persistence.jpa.entities.EmailEventEntity" />

diff --git a/orcid-persistence/src/test/java/org/orcid/persistence/dao/ProfileDaoTest.java b/orcid-persistence/src/test/java/org/orcid/persistence/dao/ProfileDaoTest.java
@@ -61,7 +61,7 @@ public class ProfileDaoTest extends DBUnitTest {
     private ClientDetailsDao clientDetailsDao;
 
     @Resource
-    private GenericDao<ProfileEventEntity, Long> profileEventDao;
+    private ProfileEventDao profileEventDao;
 
     @Resource(name="entityManager")
     protected EntityManager entityManager;
@@ -381,12 +381,12 @@ public void testDisable2FA() {
 
     @Test
     @Transactional
-    public void findEmailsToSendAddWorksEmail() {
+    public void findEmailsToSendAddWorksFirstAttemptEmail() {
         String orcid = "4444-4444-4444-4441";
 
         updateProfileWithDateCreated(orcid, LocalDateTime.now().minusDays(7).toDate());
 
-        List<Pair<String, String>> results = profileDao.findEmailsToSendAddWorksEmail();
+        List<Pair<String, String>> results = profileDao.findEmailsToSendAddWorksEmail(7);
         assertNotNull(results);
         assertEquals(1, results.size());
     }