Merge "Document how a plugin can force state update of UiAction" into stable-2.8

1 files changed, 43 insertions, 1 deletions

diff --git a/Documentation/dev-plugins.txt b/Documentation/dev-plugins.txt
index b71f9dbdd9..a0e41f8467 100644
--- a/Documentation/dev-plugins.txt
+++ b/Documentation/dev-plugins.txt
@@ -621,7 +621,7 @@ this can be specified by setting `scope = CapabilityScope.CORE`:
 UI Extension
 ------------
 
-Plugins can contribute their own UI commands on core Gerrit pages.
+Plugins can contribute their own UI actions on core Gerrit pages.
 This is useful for workflow customization or exposing plugin functionality
 through the UI in addition to SSH commands and the REST API.
 
@@ -678,6 +678,48 @@ class HelloWorldAction implements UiAction<RevisionResource>,
 }
 ----
 
+Sometimes plugins may want to be able to change the state of a patch set or
+change in the `UiAction.apply()` method and reflect these changes on the core
+UI. For example a buildbot plugin which exposes a 'Schedule' button on the
+patch set panel may want to disable that button after the build was scheduled
+and update the tooltip of that button. But because of Gerrit's caching
+strategy the following must be taken into consideration.
+
+The browser is allowed to cache the `UiAction` information until something on
+the change is modified. More accurately the change row needs to be modified in
+the database to have a more recent `lastUpdatedOn` or a new `rowVersion`, or
+the +refs/meta/config+ of the project or any parents needs to change to a new
+SHA-1. The ETag SHA-1 computation code can be found in the
+`ChangeResource.getETag()` method.
+
+The easiest way to accompilsh it is to update `lastUpdatedOn` of the change:
+
+[source,java]
+----
+@Override
+public Object apply(RevisionResource rcrs, Input in) {
+  // schedule a build
+  [...]
+  // update change
+  ReviewDb db = dbProvider.get();
+  db.changes().beginTransaction(change.getId());
+  try {
+    change = db.changes().atomicUpdate(
+      change.getId(),
+      new AtomicUpdate<Change>() {
+        @Override
+        public Change update(Change change) {
+          ChangeUtil.updated(change);
+          return change;
+        }
+      });
+    db.commit();
+  } finally {
+    db.rollback();
+  }
+}
+----
+
 `UiAction` must be bound in a plugin module:
 
 [source,java]