Skip to content

feat: allow relying on manually defined user ID when resolving users/email #954

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

Open
GerkinDev wants to merge 4 commits into
base: master
Choose a base branch
from
Open

feat: allow relying on manually defined user ID when resolving users/email #954

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f0f1918
feat: allow relying on manually defined user ID when resolving users/…
Mar 30, 2024
4c37513
test: add tests
GerkinDev Apr 2, 2024
2407b29
chore: more logs & test
GerkinDev Apr 2, 2024
aa74955
chore: try fix issues
GerkinDev Apr 2, 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
162 changes: 141 additions & 21 deletions src/main/java/jenkins/plugins/slack/user/EmailSlackUserIdResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,16 @@
import hudson.tasks.MailAddressResolver;
import java.io.IOException;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apache.commons.lang.StringUtils;
import org.apache.http.HttpEntity;
Expand Down Expand Up @@ -91,44 +96,82 @@ public void setMailAddressResolvers(List<MailAddressResolver> mailAddressResolve
this.mailAddressResolvers = mailAddressResolvers;
}

protected String resolveUserId(User user) {
Optional<String> userId = Optional.ofNullable(mailAddressResolvers)
.map(Collection::stream)
.orElseGet(Stream::empty)
.map(resolver -> {
try {
return resolver.findMailAddressFor(user);
} catch (Exception ex) {
LOGGER.log(Level.WARNING, String.format(
"The email resolver '%s' failed", resolver.getClass().getName()), ex);
return null;
}
})
.filter(StringUtils::isNotEmpty)
.map(this::resolveUserIdForEmailAddress)
.filter(StringUtils::isNotEmpty)
.findAny();
private String resolveUserEmail(User user){
return Optional.ofNullable(mailAddressResolvers)
.map(Collection::stream)
.orElseGet(Stream::empty)
.map(resolver -> {
try {
String email = resolver.findMailAddressFor(user);
LOGGER.log(Level.FINEST, String.format(
"The email resolver '%s' resolved %s as %s", resolver.getClass().getName(), user.getId(), email));
return email;
} catch (Exception ex) {
LOGGER.log(Level.WARNING, String.format(
"The email resolver '%s' failed", resolver.getClass().getName()), ex);
return null;
}
})
.filter(StringUtils::isNotEmpty)
.findAny()
.orElse(null);
}

protected SlackUserProperty fetchUserSlackProperty(User user) {
String userEmail = resolveUserEmail(user);

SlackUserProperty userProperty = null;
if(userEmail != null){
userProperty = resolveSlackPropertyFromEmailViaSlack(userEmail);
}

// Return value can be null, so Optional.orElseGet(Supplier) doesn't work.
if (userId.isPresent()) {
return userId.get();
if (userProperty != null) {
return userProperty;
} else if (defaultMailAddressResolver != null){
return resolveUserIdForEmailAddress(defaultMailAddressResolver.apply(user));
return resolveSlackPropertyFromEmailViaSlack(defaultMailAddressResolver.apply(user));
} else {
return null;
}
}

public String resolveUserIdForEmailAddress(String emailAddress) {
SlackUserProperty userProperty = resolveSlackProperty(emailAddress);
if(userProperty == null){
return null;
}
if(userProperty.getDisableNotifications()){
return null;
}
return userProperty.getUserId();
}

private SlackUserProperty resolveSlackProperty(String emailAddress) {
if (StringUtils.isEmpty(emailAddress)) {
LOGGER.fine("Email address was empty");
return null;
}

SlackUserProperty userProperty = resolveSlackPropertyFromEmailViaSlack(emailAddress);
if(userProperty == null) {
userProperty = resolveSlackPropertyFromEmailViaInferredUsername(emailAddress);
}
if(userProperty == null) {
userProperty = resolveSlackPropertyFromEmailViaUsers(emailAddress);
}

return userProperty;
}

private SlackUserProperty resolveSlackPropertyFromEmailViaSlack(String emailAddress){
if (StringUtils.isEmpty(authToken)) {
LOGGER.fine("Auth token was empty");
return null;
}
if (StringUtils.isEmpty(emailAddress)) {
LOGGER.fine("Auth token was empty");
return null;
}

String slackUserId = null;
final String url = String.format(LOOKUP_BY_EMAIL_METHOD_URL_FORMAT, emailAddress);
Expand All @@ -149,7 +192,84 @@ public String resolveUserIdForEmailAddress(String emailAddress) {
} catch (IOException | ParseException | JSONException ex) {
LOGGER.log(Level.WARNING, "Error getting userId from Slack", ex);
}
return slackUserId;

SlackUserProperty userProperty = null;
if(slackUserId != null){
LOGGER.fine(String.format("Found Slack ID '%s' for email '%s'", slackUserId, emailAddress));
userProperty = new SlackUserProperty();
userProperty.setDisableNotifications(false);
userProperty.setUserId(slackUserId);
} else {
LOGGER.log(Level.INFO, String.format("Failed to resolve userId from Slack from email '%s'", emailAddress));
}
return userProperty;
}

private SlackUserProperty resolveSlackPropertyFromEmailViaInferredUsername(String emailAddress){
if (StringUtils.isEmpty(emailAddress)) {
return null;
}

String baseUsername = emailAddress.split("@")[0];

User user = User.get(baseUsername, false, Collections.emptyMap());
if(user == null){
LOGGER.log(Level.INFO, String.format("Could not find user with name '%s' from email '%s'", baseUsername, emailAddress));
return null;
}
String userEmail = resolveUserEmail(user);
if(userEmail != null && !emailAddress.equals(userEmail)){
LOGGER.log(Level.INFO, String.format("User with name '%s' does not match expected email '%s': have '%s'", baseUsername, emailAddress, userEmail));
return null;
}
SlackUserProperty userProperty = user.getProperty(SlackUserProperty.class);
if(userProperty == null){
LOGGER.log(Level.INFO, String.format("User with name '%s' does not have slack property", baseUsername));
} else {
LOGGER.fine(String.format("Found Slack ID '%s' for user '%s'", userProperty.getUserId(), baseUsername));
}
return userProperty;
}

private SlackUserProperty resolveSlackPropertyFromEmailViaUsers(String emailAddress){
if (StringUtils.isEmpty(emailAddress)) {
return null;
}

List<User> usersWithEmailAddress = User.getAll().stream()
.filter(user -> emailAddress.equals(resolveUserEmail(user)))
.collect(Collectors.toList());
List<ResolvedUserConfig> usersPerId = usersWithEmailAddress.stream()
.map(user -> new ResolvedUserConfig(user))
.filter(user -> user.slackProperty != null && user.slackProperty.getUserId() != null)
.filter(distinctSlackUserProperties())
.collect(Collectors.toList());
if(usersPerId.size() > 1) {
List<String> conflictingUsersDisplayName = usersPerId.stream()
.map(resolved -> resolved.user.getDisplayName())
.collect(Collectors.toList());
LOGGER.log(Level.WARNING, String.format(
"Multiple users found with email '%s' having different slack IDs or configuration: %s", emailAddress, String.join(",", conflictingUsersDisplayName)));
}
Optional<ResolvedUserConfig> pickedUser = usersPerId.stream().findFirst();
if(pickedUser.isPresent()) {
return pickedUser.get().slackProperty;
}
return null;
}

private static class ResolvedUserConfig {
private User user;
private SlackUserProperty slackProperty;
public ResolvedUserConfig(User user) {
this.user = user;
this.slackProperty = user.getProperty(SlackUserProperty.class);
}
}

public static Predicate<ResolvedUserConfig> distinctSlackUserProperties() {
Set<String> seen = ConcurrentHashMap.newKeySet();
return t -> seen.add(String.format("%s-%b", t.slackProperty.getUserId(), t.slackProperty.getDisableNotifications()));
}

@Extension
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/jenkins/plugins/slack/user/NoSlackUserIdResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public NoSlackUserIdResolver() {
super(null, null);
}

protected String resolveUserId(User user) {
protected SlackUserProperty fetchUserSlackProperty(User user) {
return null;
}

Expand Down
17 changes: 5 additions & 12 deletions src/main/java/jenkins/plugins/slack/user/SlackUserIdResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,18 +58,11 @@ protected SlackUserIdResolver(String authToken, CloseableHttpClient httpClient)
}

public final String findOrResolveUserId(User user) {
String userId = null;
SlackUserProperty userProperty = user.getProperty(SlackUserProperty.class);
if (userProperty != null) {
userId = userProperty.getUserId();
} else {
userProperty = new SlackUserProperty();
}

if (StringUtils.isEmpty(userId)) {
userId = resolveUserId(user);
if (userId != null) {
userProperty.setUserId(userId);
if (userProperty == null || StringUtils.isEmpty(userProperty.getUserId())) {
userProperty = fetchUserSlackProperty(user);
if (userProperty.getUserId() != null) {
try {
user.addProperty(userProperty);
} catch (IOException ex) {
Expand All @@ -79,10 +72,10 @@ public final String findOrResolveUserId(User user) {
}

final boolean enableNotifications = !userProperty.getDisableNotifications();
return enableNotifications ? userId : null;
return enableNotifications ? userProperty.getUserId() : null;
}

protected abstract String resolveUserId(User user);
protected abstract SlackUserProperty fetchUserSlackProperty(User user);

@SuppressWarnings("unchecked")
public List<String> resolveUserIdsForRun(Run run) {
Expand Down
Loading