opendev/gerrit
Code Issues Proposed changes

Improve names of constructor arguments in OutgoingEmail and subclasses

Browse Source 
I had to navigate up a long class hierachy just to find out that 'mc'
means message class. Improve the readability by giving the constructor
arguments better names.

Names in the email classes are generally bad. This change isn't fixing
everything, but it's a start.

Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: I05271a09687959ef40b3c1bc942ddb21044aa999
This commit is contained in:
Edwin Kempin
2019-07-24 17:14:18 +02:00
parent e62fd2e27d
commit 4be1649081
21 changed files with 74 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
java/com/google/gerrit/server/mail/send/AbandonedSender.java
View File

@@ -25,13 +25,13 @@ import com.google.inject.assistedinject.Assisted;
public class AbandonedSender extends ReplyToChangeSender {
public interface Factory extends ReplyToChangeSender.Factory<AbandonedSender> {
@Override
AbandonedSender create(Project.NameKey project, Change.Id change);
AbandonedSender create(Project.NameKey project, Change.Id changeId);
}
@Inject
public AbandonedSender(
EmailArguments ea, @Assisted Project.NameKey project, @Assisted Change.Id id) {
super(ea, "abandon", ChangeEmail.newChangeData(ea, project, id));
EmailArguments args, @Assisted Project.NameKey project, @Assisted Change.Id changeId) {
super(args, "abandon", ChangeEmail.newChangeData(args, project, changeId));
}
@Override

8
java/com/google/gerrit/server/mail/send/AddKeySender.java
View File

@@ -37,8 +37,8 @@ public class AddKeySender extends OutgoingEmail {
@AssistedInject
public AddKeySender(
EmailArguments ea, @Assisted IdentifiedUser user, @Assisted AccountSshKey sshKey) {
super(ea, "addkey");
EmailArguments args, @Assisted IdentifiedUser user, @Assisted AccountSshKey sshKey) {
super(args, "addkey");
this.user = user;
this.sshKey = sshKey;
this.gpgKeys = null;
@@ -46,8 +46,8 @@ public class AddKeySender extends OutgoingEmail {
@AssistedInject
public AddKeySender(
EmailArguments ea, @Assisted IdentifiedUser user, @Assisted List<String> gpgKeys) {
super(ea, "addkey");
EmailArguments args, @Assisted IdentifiedUser user, @Assisted List<String> gpgKeys) {
super(args, "addkey");
this.user = user;
this.sshKey = null;
this.gpgKeys = gpgKeys;

6
java/com/google/gerrit/server/mail/send/AddReviewerSender.java
View File

@@ -23,13 +23,13 @@ import com.google.inject.assistedinject.Assisted;
/** Asks a user to review a change. */
public class AddReviewerSender extends NewChangeSender {
public interface Factory {
AddReviewerSender create(Project.NameKey project, Change.Id id);
AddReviewerSender create(Project.NameKey project, Change.Id changeId);
}
@Inject
public AddReviewerSender(
EmailArguments ea, @Assisted Project.NameKey project, @Assisted Change.Id id) {
super(ea, newChangeData(ea, project, id));
EmailArguments args, @Assisted Project.NameKey project, @Assisted Change.Id changeId) {
super(args, newChangeData(args, project, changeId));
}
@Override

10
java/com/google/gerrit/server/mail/send/ChangeEmail.java
View File

@@ -84,11 +84,11 @@ public abstract class ChangeEmail extends NotificationEmail {
protected Set<Account.Id> authors;
protected boolean emailOnlyAuthors;
protected ChangeEmail(EmailArguments ea, String mc, ChangeData cd) {
super(ea, mc, cd.change().getDest());
changeData = cd;
change = cd.change();
emailOnlyAuthors = false;
protected ChangeEmail(EmailArguments args, String messageClass, ChangeData changeData) {
super(args, messageClass, changeData.change().getDest());
this.changeData = changeData;
this.change = changeData.change();
this.emailOnlyAuthors = false;
}
@Override

8
java/com/google/gerrit/server/mail/send/CommentSender.java
View File

@@ -63,7 +63,7 @@ public class CommentSender extends ReplyToChangeSender {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
public interface Factory {
CommentSender create(Project.NameKey project, Change.Id id);
CommentSender create(Project.NameKey project, Change.Id changeId);
}
private class FileCommentGroup {
@@ -111,12 +111,12 @@ public class CommentSender extends ReplyToChangeSender {
@Inject
public CommentSender(
EmailArguments ea,
EmailArguments args,
CommentsUtil commentsUtil,
@GerritServerConfig Config cfg,
@Assisted Project.NameKey project,
@Assisted Change.Id id) {
super(ea, "comment", newChangeData(ea, project, id));
@Assisted Change.Id changeId) {
super(args, "comment", newChangeData(args, project, changeId));
this.commentsUtil = commentsUtil;
this.incomingEmailEnabled =
cfg.getEnum("receiveemail", null, "protocol", Protocol.NONE).ordinal()

8
java/com/google/gerrit/server/mail/send/CreateChangeSender.java
View File

@@ -34,18 +34,18 @@ public class CreateChangeSender extends NewChangeSender {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
public interface Factory {
CreateChangeSender create(Project.NameKey project, Change.Id id);
CreateChangeSender create(Project.NameKey project, Change.Id changeId);
}
private final PermissionBackend permissionBackend;
@Inject
public CreateChangeSender(
EmailArguments ea,
EmailArguments args,
PermissionBackend permissionBackend,
@Assisted Project.NameKey project,
@Assisted Change.Id id) {
super(ea, newChangeData(ea, project, id));
@Assisted Change.Id changeId) {
super(args, newChangeData(args, project, changeId));
this.permissionBackend = permissionBackend;
}

10
java/com/google/gerrit/server/mail/send/DeleteKeySender.java
View File

@@ -38,8 +38,8 @@ public class DeleteKeySender extends OutgoingEmail {
@AssistedInject
public DeleteKeySender(
EmailArguments ea, @Assisted IdentifiedUser user, @Assisted AccountSshKey sshKey) {
super(ea, "deletekey");
EmailArguments args, @Assisted IdentifiedUser user, @Assisted AccountSshKey sshKey) {
super(args, "deletekey");
this.user = user;
this.gpgKeyFingerprints = Collections.emptyList();
this.sshKey = sshKey;
@@ -47,8 +47,10 @@ public class DeleteKeySender extends OutgoingEmail {
@AssistedInject
public DeleteKeySender(
EmailArguments ea, @Assisted IdentifiedUser user, @Assisted List<String> gpgKeyFingerprints) {
super(ea, "deletekey");
EmailArguments args,
@Assisted IdentifiedUser user,
@Assisted List<String> gpgKeyFingerprints) {
super(args, "deletekey");
this.user = user;
this.gpgKeyFingerprints = gpgKeyFingerprints;
this.sshKey = null;

6
java/com/google/gerrit/server/mail/send/DeleteReviewerSender.java
View File

@@ -36,13 +36,13 @@ public class DeleteReviewerSender extends ReplyToChangeSender {
public interface Factory extends ReplyToChangeSender.Factory<DeleteReviewerSender> {
@Override
DeleteReviewerSender create(Project.NameKey project, Change.Id change);
DeleteReviewerSender create(Project.NameKey project, Change.Id changeId);
}
@Inject
public DeleteReviewerSender(
EmailArguments ea, @Assisted Project.NameKey project, @Assisted Change.Id id) {
super(ea, "deleteReviewer", newChangeData(ea, project, id));
EmailArguments args, @Assisted Project.NameKey project, @Assisted Change.Id changeId) {
super(args, "deleteReviewer", newChangeData(args, project, changeId));
}
public void addReviewers(Collection<Account.Id> cc) {

6
java/com/google/gerrit/server/mail/send/DeleteVoteSender.java
View File

@@ -25,13 +25,13 @@ import com.google.inject.assistedinject.Assisted;
public class DeleteVoteSender extends ReplyToChangeSender {
public interface Factory extends ReplyToChangeSender.Factory<DeleteVoteSender> {
@Override
DeleteVoteSender create(Project.NameKey project, Change.Id change);
DeleteVoteSender create(Project.NameKey project, Change.Id changeId);
}
@Inject
protected DeleteVoteSender(
EmailArguments ea, @Assisted Project.NameKey project, @Assisted Change.Id id) {
super(ea, "deleteVote", newChangeData(ea, project, id));
EmailArguments args, @Assisted Project.NameKey project, @Assisted Change.Id changeId) {
super(args, "deleteVote", newChangeData(args, project, changeId));
}
@Override

4
java/com/google/gerrit/server/mail/send/HttpPasswordUpdateSender.java
View File

@@ -31,8 +31,8 @@ public class HttpPasswordUpdateSender extends OutgoingEmail {
@AssistedInject
public HttpPasswordUpdateSender(
EmailArguments ea, @Assisted IdentifiedUser user, @Assisted String operation) {
super(ea, "HttpPasswordUpdate");
EmailArguments args, @Assisted IdentifiedUser user, @Assisted String operation) {
super(args, "HttpPasswordUpdate");
this.user = user;
this.operation = operation;
}

7
java/com/google/gerrit/server/mail/send/InboundEmailRejectionSender.java
View File

@@ -46,8 +46,11 @@ public class InboundEmailRejectionSender extends OutgoingEmail {
@Inject
public InboundEmailRejectionSender(
EmailArguments ea, @Assisted Address to, @Assisted String threadId, @Assisted Error reason) {
super(ea, "error");
EmailArguments args,
@Assisted Address to,
@Assisted String threadId,
@Assisted Error reason) {
super(args, "error");
this.to = requireNonNull(to);
this.threadId = requireNonNull(threadId);
this.reason = requireNonNull(reason);

6
java/com/google/gerrit/server/mail/send/MergedSender.java
View File

@@ -32,15 +32,15 @@ import com.google.inject.assistedinject.Assisted;
/** Send notice about a change successfully merged. */
public class MergedSender extends ReplyToChangeSender {
public interface Factory {
MergedSender create(Project.NameKey project, Change.Id id);
MergedSender create(Project.NameKey project, Change.Id changeId);
}
private final LabelTypes labelTypes;
@Inject
public MergedSender(
EmailArguments ea, @Assisted Project.NameKey project, @Assisted Change.Id id) {
super(ea, "merged", newChangeData(ea, project, id));
EmailArguments args, @Assisted Project.NameKey project, @Assisted Change.Id changeId) {
super(args, "merged", newChangeData(args, project, changeId));
labelTypes = changeData.getLabelTypes();
}

4
java/com/google/gerrit/server/mail/send/NewChangeSender.java
View File

@@ -32,8 +32,8 @@ public abstract class NewChangeSender extends ChangeEmail {
private final Set<Account.Id> extraCC = new HashSet<>();
private final Set<Address> extraCCByEmail = new HashSet<>();
protected NewChangeSender(EmailArguments ea, ChangeData cd) {
super(ea, "newchange", cd);
protected NewChangeSender(EmailArguments args, ChangeData changeData) {
super(args, "newchange", changeData);
}
public void addReviewers(Collection<Account.Id> cc) {

4
java/com/google/gerrit/server/mail/send/NotificationEmail.java
View File

@@ -35,8 +35,8 @@ public abstract class NotificationEmail extends OutgoingEmail {
protected BranchNameKey branch;
protected NotificationEmail(EmailArguments ea, String mc, BranchNameKey branch) {
super(ea, mc);
protected NotificationEmail(EmailArguments args, String messageClass, BranchNameKey branch) {
super(args, messageClass);
this.branch = branch;
}

8
java/com/google/gerrit/server/mail/send/OutgoingEmail.java
View File

@@ -71,10 +71,10 @@ public abstract class OutgoingEmail {
protected Account.Id fromId;
protected NotifyResolver.Result notify = NotifyResolver.Result.all();
protected OutgoingEmail(EmailArguments ea, String mc) {
args = ea;
messageClass = mc;
headers = new LinkedHashMap<>();
protected OutgoingEmail(EmailArguments args, String messageClass) {
this.args = args;
this.messageClass = messageClass;
this.headers = new LinkedHashMap<>();
}
public void setFrom(Account.Id id) {

12
java/com/google/gerrit/server/mail/send/RegisterNewEmailSender.java
View File

@@ -36,14 +36,14 @@ public class RegisterNewEmailSender extends OutgoingEmail {
@Inject
public RegisterNewEmailSender(
EmailArguments ea,
EmailTokenVerifier etv,
EmailArguments args,
EmailTokenVerifier tokenVerifier,
IdentifiedUser callingUser,
@Assisted final String address) {
super(ea, "registernewemail");
tokenVerifier = etv;
user = callingUser;
addr = address;
super(args, "registernewemail");
this.tokenVerifier = tokenVerifier;
this.user = callingUser;
this.addr = address;
}
@Override

6
java/com/google/gerrit/server/mail/send/ReplacePatchSetSender.java
View File

@@ -32,7 +32,7 @@ import java.util.Set;
/** Send notice of new patch sets for reviewers. */
public class ReplacePatchSetSender extends ReplyToChangeSender {
public interface Factory {
ReplacePatchSetSender create(Project.NameKey project, Change.Id id);
ReplacePatchSetSender create(Project.NameKey project, Change.Id changeId);
}
private final Set<Account.Id> reviewers = new HashSet<>();
@@ -40,8 +40,8 @@ public class ReplacePatchSetSender extends ReplyToChangeSender {
@Inject
public ReplacePatchSetSender(
EmailArguments ea, @Assisted Project.NameKey project, @Assisted Change.Id id) {
super(ea, "newpatchset", newChangeData(ea, project, id));
EmailArguments args, @Assisted Project.NameKey project, @Assisted Change.Id changeId) {
super(args, "newpatchset", newChangeData(args, project, changeId));
}
public void addReviewers(Collection<Account.Id> cc) {

4
java/com/google/gerrit/server/mail/send/ReplyToChangeSender.java
View File

@@ -26,8 +26,8 @@ public abstract class ReplyToChangeSender extends ChangeEmail {
T create(Project.NameKey project, Change.Id id);
}
protected ReplyToChangeSender(EmailArguments ea, String mc, ChangeData cd) {
super(ea, mc, cd);
protected ReplyToChangeSender(EmailArguments args, String messageClass, ChangeData changeData) {
super(args, messageClass, changeData);
}
@Override

6
java/com/google/gerrit/server/mail/send/RestoredSender.java
View File

@@ -25,13 +25,13 @@ import com.google.inject.assistedinject.Assisted;
public class RestoredSender extends ReplyToChangeSender {
public interface Factory extends ReplyToChangeSender.Factory<RestoredSender> {
@Override
RestoredSender create(Project.NameKey project, Change.Id id);
RestoredSender create(Project.NameKey project, Change.Id changeId);
}
@Inject
public RestoredSender(
EmailArguments ea, @Assisted Project.NameKey project, @Assisted Change.Id id) {
super(ea, "restore", ChangeEmail.newChangeData(ea, project, id));
EmailArguments args, @Assisted Project.NameKey project, @Assisted Change.Id changeId) {
super(args, "restore", ChangeEmail.newChangeData(args, project, changeId));
}
@Override

6
java/com/google/gerrit/server/mail/send/RevertedSender.java
View File

@@ -24,13 +24,13 @@ import com.google.inject.assistedinject.Assisted;
/** Send notice about a change being reverted. */
public class RevertedSender extends ReplyToChangeSender {
public interface Factory {
RevertedSender create(Project.NameKey project, Change.Id id);
RevertedSender create(Project.NameKey project, Change.Id changeId);
}
@Inject
public RevertedSender(
EmailArguments ea, @Assisted Project.NameKey project, @Assisted Change.Id id) {
super(ea, "revert", ChangeEmail.newChangeData(ea, project, id));
EmailArguments args, @Assisted Project.NameKey project, @Assisted Change.Id changeId) {
super(args, "revert", ChangeEmail.newChangeData(args, project, changeId));
}
@Override

8
java/com/google/gerrit/server/mail/send/SetAssigneeSender.java
View File

@@ -24,18 +24,18 @@ import com.google.inject.assistedinject.Assisted;
public class SetAssigneeSender extends ChangeEmail {
public interface Factory {
SetAssigneeSender create(Project.NameKey project, Change.Id id, Account.Id assignee);
SetAssigneeSender create(Project.NameKey project, Change.Id changeId, Account.Id assignee);
}
private final Account.Id assignee;
@Inject
public SetAssigneeSender(
EmailArguments ea,
EmailArguments args,
@Assisted Project.NameKey project,
@Assisted Change.Id id,
@Assisted Change.Id changeId,
@Assisted Account.Id assignee) {
super(ea, "setassignee", newChangeData(ea, project, id));
super(args, "setassignee", newChangeData(args, project, changeId));
this.assignee = assignee;
}