Package com.google.gerrit.server

Class DeleteZombieComments<KeyT>

java.lang.Object

com.google.gerrit.server.DeleteZombieComments<KeyT>

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

DeleteZombieCommentsRefs

public abstract class DeleteZombieComments<KeyT>
extends Object
implements AutoCloseable

This class can be used to clean zombie draft comments. More context in https://gerrit-review.googlesource.com/c/gerrit/+/246233

The implementation has two cases for detecting zombie drafts:

• An earlier bug in the deletion of draft comments caused some draft refs to remain empty but not get deleted.
• Inspecting all draft-comments. Check for each draft if there exists a published comment with the same UUID. These comments are called zombie drafts. If the program is run in dryRun mode, the zombie draft IDs will only be logged for tracking, otherwise they will also be deleted.

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	dryRun

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DeleteZombieComments(Integer cleanupPercentage, boolean dryRun, Consumer<String> uiConsumer, GitRepositoryManager repoManager, DraftCommentsReader draftCommentsReader, ChangeNotes.Factory changeNotesFactory, CommentsUtil commentsUtil)

Method Summary

Modifier and Type	Method	Description
abstract void	close()
protected abstract void	deleteEmptyDraftsByKey(Collection<KeyT> keys)
protected abstract void	deleteZombieDrafts(com.google.common.collect.ListMultimap<KeyT,HumanComment> drafts)
int	execute()	Deletes all draft comments.
protected abstract Account.Id	getAccountId(KeyT key)
protected abstract Change.Id	getChangeId(KeyT key)
protected ChangeNotes	getChangeNotes(Change.Id changeId)
protected abstract List<KeyT>	listAllDrafts()
com.google.common.collect.ListMultimap<KeyT,HumanComment>	listDraftCommentsThatAreAlsoPublished()
protected abstract List<KeyT>	listEmptyDrafts()
protected abstract String	loggable(KeyT key)
protected void	logInfo(String message)
abstract void	setup()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

dryRun

protected final boolean dryRun

Constructor Details

DeleteZombieComments

protected DeleteZombieComments(Integer cleanupPercentage,
 boolean dryRun,
 Consumer<String> uiConsumer,
 GitRepositoryManager repoManager,
 DraftCommentsReader draftCommentsReader,
 ChangeNotes.Factory changeNotesFactory,
 CommentsUtil commentsUtil)

Method Details

execute

@CanIgnoreReturnValue
public int execute()
            throws IOException

Deletes all draft comments. Returns the number of zombie draft comments that were deleted.

Throws:

IOException

setup

public abstract void setup()
                    throws IOException

Throws:

IOException

close

public abstract void close()
                    throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException

listAllDrafts

protected abstract List<KeyT> listAllDrafts()
                                     throws IOException

Throws:

IOException

listEmptyDrafts

protected abstract List<KeyT> listEmptyDrafts()
                                       throws IOException

Throws:

IOException

deleteEmptyDraftsByKey

protected abstract void deleteEmptyDraftsByKey(Collection<KeyT> keys)
                                        throws IOException

Throws:

IOException

deleteZombieDrafts

protected abstract void deleteZombieDrafts(com.google.common.collect.ListMultimap<KeyT,HumanComment> drafts)
                                    throws IOException

Throws:

IOException

getChangeId

protected abstract Change.Id getChangeId(KeyT key)

getAccountId

protected abstract Account.Id getAccountId(KeyT key)

loggable

protected abstract String loggable(KeyT key)

getChangeNotes

protected ChangeNotes getChangeNotes(Change.Id changeId)

listDraftCommentsThatAreAlsoPublished

public com.google.common.collect.ListMultimap<KeyT,HumanComment> listDraftCommentsThatAreAlsoPublished()
                                                                                                throws IOException

Throws:

IOException

logInfo

protected void logInfo(String message)