opendev
/
gerrit
Code Issues Proposed changes

Add hashtags to events and query results 

Hashtags are only available through the dedicated REST API GetHashtags.
This change make them also available in the change structure reported by
events and query results.

That way it should give a chance for change consumers to use hashtags
in a similar fashion to the topic field without much overhead.

Change-Id: I763623b7f69e5d14f287c491c34e4cc489f6e621
This commit is contained in:
Bertrand Roussel 2018-07-13 14:27:51 +02:00
parent 2971c421db
commit 75a3af6bce
5 changed files with 49 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/json.txt
View File

@ -29,6 +29,8 @@ url:: Canonical URL to reach this change.
commitMessage:: The full commit message for the change's current patch
set.
hashtags:: List of hashtags associated with this change.
createdOn:: Time in seconds since the UNIX epoch when this change
was created.

1
java/com/google/gerrit/server/data/ChangeAttribute.java
View File

@ -30,6 +30,7 @@ public class ChangeAttribute {
public AccountAttribute assignee;
public String url;
public String commitMessage;
public List<String> hashtags;
public Long createdOn;
public Long lastUpdated;

22
java/com/google/gerrit/server/events/EventFactory.java
View File

@ -130,9 +130,9 @@ public class EventFactory {
* @param change
* @return object suitable for serialization to JSON
*/
public ChangeAttribute asChangeAttribute(Change change) {
public ChangeAttribute asChangeAttribute(Change change, ChangeNotes notes) {
try (ReviewDb db = schema.open()) {
return asChangeAttribute(db, change);
return asChangeAttribute(db, change, notes);
} catch (OrmException e) {
logger.atSevere().withCause(e).log("Cannot open database connection");
return new ChangeAttribute();
@ -170,6 +170,24 @@ public class EventFactory {
return a;
}
/**
* Create a ChangeAttribute for the given change suitable for serialization to JSON.
*
* @param db Review database
* @param change
* @param notes
* @return object suitable for serialization to JSON
*/
public ChangeAttribute asChangeAttribute(ReviewDb db, Change change, ChangeNotes notes)
throws OrmException {
ChangeAttribute a = asChangeAttribute(db, change);
Set<String> hashtags = notes.load().getHashtags();
if (!hashtags.isEmpty()) {
a.hashtags = new ArrayList<String>(hashtags.size());
a.hashtags.addAll(hashtags);
}
return a;
}
/**
* Create a RefUpdateAttribute for the given old ObjectId, new ObjectId, and branch that is
* suitable for serialization to JSON.

45
java/com/google/gerrit/server/events/StreamEventsApiListener.java
View File

@ -156,12 +156,12 @@ public class StreamEventsApiListener
return psUtil.get(db.get(), notes, PatchSet.Id.fromRef(info.ref));
}
private Supplier<ChangeAttribute> changeAttributeSupplier(Change change) {
private Supplier<ChangeAttribute> changeAttributeSupplier(Change change, ChangeNotes notes) {
return Suppliers.memoize(
new Supplier<ChangeAttribute>() {
@Override
public ChangeAttribute get() {
return eventFactory.asChangeAttribute(change);
return eventFactory.asChangeAttribute(change, notes);
}
});
}
@ -257,10 +257,11 @@ public class StreamEventsApiListener
@Override
public void onAssigneeChanged(AssigneeChangedListener.Event ev) {
try {
Change change = getChange(ev.getChange());
ChangeNotes notes = getNotes(ev.getChange());
Change change = notes.getChange();
AssigneeChangedEvent event = new AssigneeChangedEvent(change);
event.change = changeAttributeSupplier(change);
event.change = changeAttributeSupplier(change, notes);
event.changer = accountAttributeSupplier(ev.getWho());
event.oldAssignee = accountAttributeSupplier(ev.getOldAssignee());
@ -273,10 +274,11 @@ public class StreamEventsApiListener
@Override
public void onTopicEdited(TopicEditedListener.Event ev) {
try {
Change change = getChange(ev.getChange());
ChangeNotes notes = getNotes(ev.getChange());
Change change = notes.getChange();
TopicChangedEvent event = new TopicChangedEvent(change);
event.change = changeAttributeSupplier(change);
event.change = changeAttributeSupplier(change, notes);
event.changer = accountAttributeSupplier(ev.getWho());
event.oldTopic = ev.getOldTopic();
@ -294,7 +296,7 @@ public class StreamEventsApiListener
PatchSet patchSet = getPatchSet(notes, ev.getRevision());
PatchSetCreatedEvent event = new PatchSetCreatedEvent(change);
event.change = changeAttributeSupplier(change);
event.change = changeAttributeSupplier(change, notes);
event.patchSet = patchSetAttributeSupplier(change, patchSet);
event.uploader = accountAttributeSupplier(ev.getWho());
@ -310,7 +312,7 @@ public class StreamEventsApiListener
ChangeNotes notes = getNotes(ev.getChange());
Change change = notes.getChange();
ReviewerDeletedEvent event = new ReviewerDeletedEvent(change);
event.change = changeAttributeSupplier(change);
event.change = changeAttributeSupplier(change, notes);
event.patchSet = patchSetAttributeSupplier(change, psUtil.current(db.get(), notes));
event.reviewer = accountAttributeSupplier(ev.getReviewer());
event.remover = accountAttributeSupplier(ev.getWho());
@ -331,7 +333,7 @@ public class StreamEventsApiListener
Change change = notes.getChange();
ReviewerAddedEvent event = new ReviewerAddedEvent(change);
event.change = changeAttributeSupplier(change);
event.change = changeAttributeSupplier(change, notes);
event.patchSet = patchSetAttributeSupplier(change, psUtil.current(db.get(), notes));
for (AccountInfo reviewer : ev.getReviewers()) {
event.reviewer = accountAttributeSupplier(reviewer);
@ -354,10 +356,11 @@ public class StreamEventsApiListener
@Override
public void onHashtagsEdited(HashtagsEditedListener.Event ev) {
try {
Change change = getChange(ev.getChange());
ChangeNotes notes = getNotes(ev.getChange());
Change change = notes.getChange();
HashtagsChangedEvent event = new HashtagsChangedEvent(change);
event.change = changeAttributeSupplier(change);
event.change = changeAttributeSupplier(change, notes);
event.editor = accountAttributeSupplier(ev.getWho());
event.hashtags = hashtagArray(ev.getHashtags());
event.added = hashtagArray(ev.getAddedHashtags());
@ -402,7 +405,7 @@ public class StreamEventsApiListener
PatchSet ps = getPatchSet(notes, ev.getRevision());
CommentAddedEvent event = new CommentAddedEvent(change);
event.change = changeAttributeSupplier(change);
event.change = changeAttributeSupplier(change, notes);
event.author = accountAttributeSupplier(ev.getWho());
event.patchSet = patchSetAttributeSupplier(change, ps);
event.comment = ev.getComment();
@ -421,7 +424,7 @@ public class StreamEventsApiListener
Change change = notes.getChange();
ChangeRestoredEvent event = new ChangeRestoredEvent(change);
event.change = changeAttributeSupplier(change);
event.change = changeAttributeSupplier(change, notes);
event.restorer = accountAttributeSupplier(ev.getWho());
event.patchSet = patchSetAttributeSupplier(change, psUtil.current(db.get(), notes));
event.reason = ev.getReason();
@ -439,7 +442,7 @@ public class StreamEventsApiListener
Change change = notes.getChange();
ChangeMergedEvent event = new ChangeMergedEvent(change);
event.change = changeAttributeSupplier(change);
event.change = changeAttributeSupplier(change, notes);
event.submitter = accountAttributeSupplier(ev.getWho());
event.patchSet = patchSetAttributeSupplier(change, psUtil.current(db.get(), notes));
event.newRev = ev.getNewRevisionId();
@ -457,7 +460,7 @@ public class StreamEventsApiListener
Change change = notes.getChange();
ChangeAbandonedEvent event = new ChangeAbandonedEvent(change);
event.change = changeAttributeSupplier(change);
event.change = changeAttributeSupplier(change, notes);
event.abandoner = accountAttributeSupplier(ev.getWho());
event.patchSet = patchSetAttributeSupplier(change, psUtil.current(db.get(), notes));
event.reason = ev.getReason();
@ -471,10 +474,11 @@ public class StreamEventsApiListener
@Override
public void onWorkInProgressStateChanged(WorkInProgressStateChangedListener.Event ev) {
try {
Change change = getChange(ev.getChange());
ChangeNotes notes = getNotes(ev.getChange());
Change change = notes.getChange();
WorkInProgressStateChangedEvent event = new WorkInProgressStateChangedEvent(change);
event.change = changeAttributeSupplier(change);
event.change = changeAttributeSupplier(change, notes);
event.changer = accountAttributeSupplier(ev.getWho());
dispatcher.get().postEvent(change, event);
@ -486,10 +490,11 @@ public class StreamEventsApiListener
@Override
public void onPrivateStateChanged(PrivateStateChangedListener.Event ev) {
try {
Change change = getChange(ev.getChange());
ChangeNotes notes = getNotes(ev.getChange());
Change change = notes.getChange();
PrivateStateChangedEvent event = new PrivateStateChangedEvent(change);
event.change = changeAttributeSupplier(change);
event.change = changeAttributeSupplier(change, notes);
event.changer = accountAttributeSupplier(ev.getWho());
dispatcher.get().postEvent(change, event);
@ -505,7 +510,7 @@ public class StreamEventsApiListener
Change change = notes.getChange();
VoteDeletedEvent event = new VoteDeletedEvent(change);
event.change = changeAttributeSupplier(change);
event.change = changeAttributeSupplier(change, notes);
event.patchSet = patchSetAttributeSupplier(change, psUtil.current(db.get(), notes));
event.comment = ev.getMessage();
event.reviewer = accountAttributeSupplier(ev.getReviewer());

2
java/com/google/gerrit/server/query/change/OutputStreamQuery.java
View File

@ -237,7 +237,7 @@ public class OutputStreamQuery {
ChangeData d, Map<Project.NameKey, Repository> repos, Map<Project.NameKey, RevWalk> revWalks)
throws OrmException, IOException {
LabelTypes labelTypes = d.getLabelTypes();
ChangeAttribute c = eventFactory.asChangeAttribute(db, d.change());
ChangeAttribute c = eventFactory.asChangeAttribute(db, d.change(), d.notes());
eventFactory.extend(c, d.change());
if (!trackingFooters.isEmpty()) {