Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add source name and or id to emails missing both #7118

Merged
merged 6 commits into from
Oct 31, 2024
Merged

add source name and or id to emails missing both #7118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e07961a
add source name and or id to emails missing both
auumgn Oct 30, 2024
76fcc8c
add unfinished test
auumgn Oct 30, 2024
f15956c
Remove dup bean definition from child object
amontenegro Oct 31, 2024
1ddf5e2
add tests
auumgn Oct 31, 2024
8689e4a
fix tests
auumgn Oct 31, 2024
6209755
update email count in test
auumgn Oct 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions orcid-web/src/main/java/org/orcid/frontend/web/controllers/ManageProfileController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,6 @@ public class ManageProfileController extends BaseWorkspaceController {
@Resource
private GivenPermissionToManager givenPermissionToManager;

@Resource(name = "emailManagerReadOnlyV3")
private EmailManagerReadOnly emailManagerReadOnly;

@Resource(name = "profileEmailDomainManagerReadOnly")
private ProfileEmailDomainManagerReadOnly profileEmailDomainManagerReadOnly;

Expand Down Expand Up @@ -536,7 +533,17 @@ public ModelAndView confirmDeactivateOrcidAccount(HttpServletRequest request, Ht
if (Features.EMAIL_DOMAINS.isActive()) {
emailDomains = profileEmailDomainManagerReadOnly.getEmailDomains(getCurrentUserOrcid());
}
return org.orcid.pojo.ajaxForm.Emails.valueOf(v2Emails, emailDomains);
org.orcid.pojo.ajaxForm.Emails emails = org.orcid.pojo.ajaxForm.Emails.valueOf(v2Emails, emailDomains);
// Old emails are missing the source name and id -- assign the user as the source
for (org.orcid.pojo.ajaxForm.Email email: emails.getEmails()) {
if (email.getSource() == null && email.getSourceName() == null) {
String orcid = getCurrentUserOrcid();
String displayName = getPersonDetails(orcid, true).getDisplayName();
email.setSource(orcid);
email.setSourceName(displayName);
}
}
return emails;
}

@RequestMapping(value = "/emails.json", method = RequestMethod.POST)
Expand Down
12 changes: 10 additions & 2 deletions orcid-web/src/main/java/org/orcid/frontend/web/controllers/PublicRecordController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,8 +202,16 @@ PublicRecord getRecord(String orcid) {
if (Features.EMAIL_DOMAINS.isActive()) {
emailDomains = profileEmailDomainManagerReadOnly.getPublicEmailDomains(orcid);
}

publicRecord.setEmails(org.orcid.pojo.ajaxForm.Emails.valueOf(filteredEmails, emailDomains));

org.orcid.pojo.ajaxForm.Emails emails = org.orcid.pojo.ajaxForm.Emails.valueOf(filteredEmails, emailDomains);
// Old emails are missing the source name and id -- assign the user as the source
for (org.orcid.pojo.ajaxForm.Email email: emails.getEmails()) {
if (email.getSource() == null && email.getSourceName() == null) {
email.setSource(orcid);
email.setSourceName(publicRecord.getDisplayName());
}
}
publicRecord.setEmails(emails);

// Fill external identifiers
PersonExternalIdentifiers publicPersonExternalIdentifiers;
Expand Down
134 changes: 119 additions & 15 deletions orcid-web/src/test/java/org/orcid/frontend/web/controllers/ManageProfileControllerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,13 @@
import org.orcid.core.manager.v3.OrcidSecurityManager;
import org.orcid.core.manager.v3.ProfileEntityManager;
import org.orcid.core.manager.v3.RecordNameManager;
import org.orcid.core.manager.v3.read_only.GivenPermissionToManagerReadOnly;
import org.orcid.core.manager.v3.read_only.ProfileEntityManagerReadOnly;
import org.orcid.core.manager.v3.read_only.RecordNameManagerReadOnly;
import org.orcid.core.manager.v3.read_only.*;
import org.orcid.core.oauth.OrcidProfileUserDetails;
import org.orcid.core.security.OrcidWebRole;
import org.orcid.jaxb.model.v3.release.common.*;
import org.orcid.utils.DateUtils;
import org.orcid.core.utils.v3.OrcidIdentifierUtils;
import org.orcid.frontend.email.RecordEmailSender;
import org.orcid.jaxb.model.v3.release.common.CreditName;
import org.orcid.jaxb.model.v3.release.common.OrcidIdentifier;
import org.orcid.jaxb.model.v3.release.common.Visibility;
import org.orcid.jaxb.model.v3.release.record.Biography;
import org.orcid.jaxb.model.v3.release.record.Email;
import org.orcid.jaxb.model.v3.release.record.Emails;
Expand Down Expand Up @@ -84,6 +80,7 @@ public class ManageProfileControllerTest {
private static final String USER_ORCID = "0000-0000-0000-0001";
private static final String DEPRECATED_USER_ORCID = "0000-0000-0000-0002";
private static final String DEPRECATED_USER_ORCID_URL = "https://localhost:8443/0000-0000-0000-0002";
private static final String USER_CREDIT_NAME = "Credit Name";

@Mock
private ProfileEntityCacheManager mockProfileEntityCacheManager;
Expand All @@ -94,6 +91,9 @@ public class ManageProfileControllerTest {
@Mock
private EmailManager mockEmailManager;

@Mock
private ProfileEmailDomainManagerReadOnly mockProfileEmailDomainManagerReadOnly;

@Mock
private LocaleManager mockLocaleManager;

Expand Down Expand Up @@ -127,6 +127,21 @@ public class ManageProfileControllerTest {
@Mock(name="profileEntityManagerReadOnlyV3")
private ProfileEntityManagerReadOnly mockProfileEntityManagerReadOnly;

@Mock
private PersonalDetailsManagerReadOnly mockPersonalDetailsManagerReadOnly;

@Mock
private AddressManagerReadOnly mockAddressManagerReadOnly;

@Mock
private ProfileKeywordManagerReadOnly mockKeywordManagerReadOnly;

@Mock
private ResearcherUrlManagerReadOnly mockResearcherUrlManagerReadOnly;

@Mock
private ExternalIdentifierManagerReadOnly mockExternalIdentifierManagerReadOnly;

@Before
public void initMocks() throws Exception {
controller = new ManageProfileController();
Expand All @@ -136,6 +151,7 @@ public void initMocks() throws Exception {
TargetProxyHelper.injectIntoProxy(controller, "encryptionManager", mockEncryptionManager);
TargetProxyHelper.injectIntoProxy(controller, "emailManager", mockEmailManager);
TargetProxyHelper.injectIntoProxy(controller, "emailManagerReadOnly", mockEmailManager);
TargetProxyHelper.injectIntoProxy(controller, "profileEmailDomainManagerReadOnly", mockProfileEmailDomainManagerReadOnly);
TargetProxyHelper.injectIntoProxy(controller, "localeManager", mockLocaleManager);
TargetProxyHelper.injectIntoProxy(controller, "profileEntityManager", mockProfileEntityManager);
TargetProxyHelper.injectIntoProxy(controller, "givenPermissionToManager", mockGivenPermissionToManager);
Expand All @@ -147,6 +163,12 @@ public void initMocks() throws Exception {
TargetProxyHelper.injectIntoProxy(controller, "twoFactorAuthenticationManager", twoFactorAuthenticationManager);
TargetProxyHelper.injectIntoProxy(controller, "recordEmailSender", mockRecordEmailSender);
TargetProxyHelper.injectIntoProxy(controller, "profileEntityManagerReadOnly", mockProfileEntityManagerReadOnly);
TargetProxyHelper.injectIntoProxy(controller, "personalDetailsManagerReadOnly", mockPersonalDetailsManagerReadOnly);
TargetProxyHelper.injectIntoProxy(controller, "addressManagerReadOnly", mockAddressManagerReadOnly);
TargetProxyHelper.injectIntoProxy(controller, "keywordManagerReadOnly", mockKeywordManagerReadOnly);
TargetProxyHelper.injectIntoProxy(controller, "researcherUrlManagerReadOnly", mockResearcherUrlManagerReadOnly);
TargetProxyHelper.injectIntoProxy(controller, "externalIdentifierManagerReadOnly", mockExternalIdentifierManagerReadOnly);


when(mockOrcidSecurityManager.isPasswordConfirmationRequired()).thenReturn(true);
when(mockEncryptionManager.hashMatches(Mockito.anyString(), Mockito.anyString())).thenReturn(true);
Expand Down Expand Up @@ -192,13 +214,23 @@ public Emails answer(InvocationOnMock invocation) throws Throwable {
Emails emails = new Emails();
Email email1 = new Email();
email1.setEmail(invocation.getArgument(0) + "[email protected]");
email1.setSource(new Source());
email1.setVisibility(Visibility.PUBLIC);
emails.getEmails().add(email1);

Email email2 = new Email();
email2.setEmail(invocation.getArgument(0) + "[email protected]");
email2.setSource(new Source());
email2.getSource().setSourceName(new SourceName(USER_CREDIT_NAME));
email2.setVisibility(Visibility.PUBLIC);
emails.getEmails().add(email2);

Email email3 = new Email();
email3.setEmail(invocation.getArgument(0) + "[email protected]");
email3.setSource(new Source());
email3.getSource().setSourceClientId(new SourceClientId(USER_ORCID));
email3.setVisibility(Visibility.PUBLIC);
emails.getEmails().add(email3);
return emails;
}

Expand Down Expand Up @@ -387,16 +419,18 @@ public void testValidateDeprecateProfileWithValidData() {
assertNotNull(deprecateProfile.getDeprecatingEmails());
assertEquals("0000-0000-0000-0002", deprecateProfile.getDeprecatingOrcid());
assertEquals("0000-0000-0000-0002 Given Names 0000-0000-0000-0002 Family Name", deprecateProfile.getDeprecatingAccountName());
assertEquals(2, deprecateProfile.getDeprecatingEmails().size());
assertEquals(3, deprecateProfile.getDeprecatingEmails().size());
assertTrue(deprecateProfile.getDeprecatingEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getDeprecatingEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getDeprecatingEmails().contains("[email protected]"));

assertEquals("0000-0000-0000-0001", deprecateProfile.getPrimaryOrcid());
assertEquals("0000-0000-0000-0001 Given Names 0000-0000-0000-0001 Family Name", deprecateProfile.getPrimaryAccountName());
assertNotNull(deprecateProfile.getPrimaryEmails());
assertEquals(2, deprecateProfile.getPrimaryEmails().size());
assertEquals(3, deprecateProfile.getPrimaryEmails().size());
assertTrue(deprecateProfile.getPrimaryEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getPrimaryEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getPrimaryEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getErrors().isEmpty());

// Using orcid
Expand All @@ -409,16 +443,19 @@ public void testValidateDeprecateProfileWithValidData() {
assertNotNull(deprecateProfile.getDeprecatingEmails());
assertEquals("0000-0000-0000-0002", deprecateProfile.getDeprecatingOrcid());
assertEquals("0000-0000-0000-0002 Given Names 0000-0000-0000-0002 Family Name", deprecateProfile.getDeprecatingAccountName());
assertEquals(2, deprecateProfile.getDeprecatingEmails().size());
assertEquals(3, deprecateProfile.getDeprecatingEmails().size());
assertTrue(deprecateProfile.getDeprecatingEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getDeprecatingEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getDeprecatingEmails().contains("[email protected]"));


assertEquals("0000-0000-0000-0001", deprecateProfile.getPrimaryOrcid());
assertEquals("0000-0000-0000-0001 Given Names 0000-0000-0000-0001 Family Name", deprecateProfile.getPrimaryAccountName());
assertNotNull(deprecateProfile.getPrimaryEmails());
assertEquals(2, deprecateProfile.getPrimaryEmails().size());
assertEquals(3, deprecateProfile.getPrimaryEmails().size());
assertTrue(deprecateProfile.getPrimaryEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getPrimaryEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getPrimaryEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getErrors().isEmpty());

// Using orcid URL
Expand All @@ -431,16 +468,19 @@ public void testValidateDeprecateProfileWithValidData() {
assertNotNull(deprecateProfile.getDeprecatingEmails());
assertEquals("0000-0000-0000-0002", deprecateProfile.getDeprecatingOrcid());
assertEquals("0000-0000-0000-0002 Given Names 0000-0000-0000-0002 Family Name", deprecateProfile.getDeprecatingAccountName());
assertEquals(2, deprecateProfile.getDeprecatingEmails().size());
assertEquals(3, deprecateProfile.getDeprecatingEmails().size());
assertTrue(deprecateProfile.getDeprecatingEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getDeprecatingEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getDeprecatingEmails().contains("[email protected]"));

assertEquals("0000-0000-0000-0001", deprecateProfile.getPrimaryOrcid());
assertEquals("0000-0000-0000-0001 Given Names 0000-0000-0000-0001 Family Name", deprecateProfile.getPrimaryAccountName());
assertNotNull(deprecateProfile.getPrimaryEmails());
assertEquals(2, deprecateProfile.getPrimaryEmails().size());
assertEquals(3, deprecateProfile.getPrimaryEmails().size());
assertTrue(deprecateProfile.getPrimaryEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getPrimaryEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getPrimaryEmails().contains("[email protected]"));

assertTrue(deprecateProfile.getErrors().isEmpty());

// Using orcid trim space
Expand All @@ -454,16 +494,19 @@ public void testValidateDeprecateProfileWithValidData() {
assertEquals("0000-0000-0000-0002", deprecateProfile.getDeprecatingOrcid());
assertEquals("0000-0000-0000-0002 Given Names 0000-0000-0000-0002 Family Name", deprecateProfile.getDeprecatingAccountName());

assertEquals(2, deprecateProfile.getDeprecatingEmails().size());
assertEquals(3, deprecateProfile.getDeprecatingEmails().size());
assertTrue(deprecateProfile.getDeprecatingEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getDeprecatingEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getDeprecatingEmails().contains("[email protected]"));


assertEquals("0000-0000-0000-0001", deprecateProfile.getPrimaryOrcid());
assertEquals("0000-0000-0000-0001 Given Names 0000-0000-0000-0001 Family Name", deprecateProfile.getPrimaryAccountName());
assertNotNull(deprecateProfile.getPrimaryEmails());
assertEquals(2, deprecateProfile.getPrimaryEmails().size());
assertEquals(3, deprecateProfile.getPrimaryEmails().size());
assertTrue(deprecateProfile.getPrimaryEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getPrimaryEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getPrimaryEmails().contains("[email protected]"));
assertTrue(deprecateProfile.getErrors().isEmpty());
}

Expand Down Expand Up @@ -1116,7 +1159,68 @@ public void testEditEmail_primaryEmailChange() {

verify(mockRecordEmailSender, Mockito.times(1)).sendVerificationEmail(eq(USER_ORCID), eq("[email protected]"), eq(true));
}


@Test
public void testEmptyEmailSource() {
SecurityContextHolder.getContext().setAuthentication(getAuthentication(USER_ORCID));
when(mockProfileEmailDomainManagerReadOnly.getEmailDomains(eq(USER_ORCID))).thenReturn(null);
when(mockEmailManager.getPublicEmails(eq(USER_ORCID))).thenReturn(new Emails());
MockHttpServletRequest mockRequest = new MockHttpServletRequest();
MockHttpSession mockSession = new MockHttpSession();
mockRequest.setSession(mockSession);
org.orcid.pojo.ajaxForm.Emails emails = controller.getEmails(mockRequest);

assertEquals(3, emails.getEmails().size());

org.orcid.pojo.ajaxForm.Email email1 = emails.getEmails().get(0);
assertEquals(email1.getValue(), USER_ORCID + "[email protected]");
assertEquals(email1.getSource(), USER_ORCID);
assertNull(email1.getSourceName());

org.orcid.pojo.ajaxForm.Email email2 = emails.getEmails().get(1);
assertEquals(email2.getValue(), USER_ORCID + "[email protected]");
assertNull(email2.getSource());
assertEquals(email2.getSourceName(), USER_CREDIT_NAME);
}

@Test
public void testEmailSourceWithSourceName() {
SecurityContextHolder.getContext().setAuthentication(getAuthentication(USER_ORCID));
when(mockProfileEmailDomainManagerReadOnly.getEmailDomains(eq(USER_ORCID))).thenReturn(null);
when(mockEmailManager.getPublicEmails(eq(USER_ORCID))).thenReturn(new Emails());
MockHttpServletRequest mockRequest = new MockHttpServletRequest();
MockHttpSession mockSession = new MockHttpSession();
mockRequest.setSession(mockSession);
org.orcid.pojo.ajaxForm.Emails emails = controller.getEmails(mockRequest);

assertEquals(3, emails.getEmails().size());

org.orcid.pojo.ajaxForm.Email email2 = emails.getEmails().get(1);
assertEquals(email2.getValue(), USER_ORCID + "[email protected]");
assertNull(email2.getSource());
assertEquals(email2.getSourceName(), USER_CREDIT_NAME);
}

@Test
public void testEmailSourceWithSourceId() {
SecurityContextHolder.getContext().setAuthentication(getAuthentication(USER_ORCID));
when(mockProfileEmailDomainManagerReadOnly.getEmailDomains(eq(USER_ORCID))).thenReturn(null);
when(mockEmailManager.getPublicEmails(eq(USER_ORCID))).thenReturn(new Emails());
MockHttpServletRequest mockRequest = new MockHttpServletRequest();
MockHttpSession mockSession = new MockHttpSession();
mockRequest.setSession(mockSession);
org.orcid.pojo.ajaxForm.Emails emails = controller.getEmails(mockRequest);

assertEquals(3, emails.getEmails().size());

org.orcid.pojo.ajaxForm.Email email3 = emails.getEmails().get(2);
assertEquals(email3.getValue(), USER_ORCID + "[email protected]");
assertNull(email3.getSourceName());
assertEquals(email3.getSource(), USER_ORCID);
}



protected Authentication getAuthentication(String orcid) {
List<OrcidWebRole> roles = Arrays.asList(OrcidWebRole.ROLE_USER);
OrcidProfileUserDetails details = new OrcidProfileUserDetails(orcid, "[email protected]", null, roles);
Expand Down
Loading