Merge pull request #272 from zanata/async-task-names

Give meaningful names to async tasks
zanata · Nov 15, 2013 · 617d40e · 617d40e
2 parents 64d4462 + 515f8b1
commit 617d40e
Show file tree

Hide file tree

Showing 12 changed files with 50 additions and 22 deletions.
diff --git a/zanata-war/src/main/java/org/zanata/action/ReindexAsyncBean.java b/zanata-war/src/main/java/org/zanata/action/ReindexAsyncBean.java
@@ -182,7 +182,8 @@ private class ReindexTask implements
         @Override
         public AsyncTaskHandle<Boolean> getHandle() {
             if (handle == null) {
-                handle = new AsyncTaskHandle<Boolean>();
+                String name = getClass().getSimpleName(); //+":"+indexingOptions
+                handle = new AsyncTaskHandle<Boolean>(name);
                 handle.setMaxProgress(getTotalOperations());
             }
             return handle;

diff --git a/zanata-war/src/main/java/org/zanata/action/TranslationMemoryAction.java b/zanata-war/src/main/java/org/zanata/action/TranslationMemoryAction.java
@@ -108,7 +108,8 @@ public boolean validateSlug(String slug, String componentId) {
     }
 
     public void clearTransMemory(final String transMemorySlug) {
-        asyncTaskManagerServiceImpl.startTask(new SimpleAsyncTask<Void>() {
+        String name = "TranslationMemoryAction.clearTransMemory: "+transMemorySlug;
+        asyncTaskManagerServiceImpl.startTask(new SimpleAsyncTask<Void>(name) {
             @Override
             public Void call() throws Exception {
                 TranslationMemoryResourceService tmResource =

diff --git a/zanata-war/src/main/java/org/zanata/async/AsyncTaskHandle.java b/zanata-war/src/main/java/org/zanata/async/AsyncTaskHandle.java
@@ -35,6 +35,10 @@
  *         href="mailto:camunoz@redhat.com">camunoz@redhat.com</a>
  */
 public class AsyncTaskHandle<V> extends AbstractFuture<V> {
+
+    @Getter
+    private final String taskName;
+
     @Getter
     @Setter
     public int maxProgress = 100;
@@ -47,6 +51,15 @@ public class AsyncTaskHandle<V> extends AbstractFuture<V> {
     @Setter
     public int currentProgress = 0;
 
+    public AsyncTaskHandle(String taskName) {
+        this.taskName = taskName;
+    }
+
+    @Override
+    public String toString() {
+        return getClass().getSimpleName()+"(taskName="+taskName+")";
+    }
+
     @Override
     protected boolean setException(Throwable throwable) {
         return super.setException(throwable);

diff --git a/zanata-war/src/main/java/org/zanata/async/SimpleAsyncTask.java b/zanata-war/src/main/java/org/zanata/async/SimpleAsyncTask.java
@@ -32,5 +32,10 @@
 public abstract class SimpleAsyncTask<V> implements
         AsyncTask<V, AsyncTaskHandle<V>> {
     @Getter
-    private final AsyncTaskHandle<V> handle = new AsyncTaskHandle<V>();
+    private final AsyncTaskHandle<V> handle;
+
+    public SimpleAsyncTask(String taskName) {
+        handle = new AsyncTaskHandle<V>(taskName);
+    }
+
 }
diff --git a/zanata-war/src/main/java/org/zanata/async/TimedAsyncHandle.java b/zanata-war/src/main/java/org/zanata/async/TimedAsyncHandle.java
@@ -38,6 +38,10 @@ public class TimedAsyncHandle<V> extends AsyncTaskHandle<V> {
     @Getter
     private long finishTime;
 
+    public TimedAsyncHandle(String taskName) {
+        super(taskName);
+    }
+
     public void startTiming() {
         startTime = System.currentTimeMillis();
     }

diff --git a/zanata-war/src/main/java/org/zanata/async/tasks/CopyTransTask.java b/zanata-war/src/main/java/org/zanata/async/tasks/CopyTransTask.java
@@ -40,10 +40,11 @@ public abstract class CopyTransTask implements
 
     protected HCopyTransOptions copyTransOptions;
 
-    private final CopyTransTaskHandle handle = new CopyTransTaskHandle();
+    private final CopyTransTaskHandle handle;
 
-    public CopyTransTask(HCopyTransOptions copyTransOptions) {
+    public CopyTransTask(HCopyTransOptions copyTransOptions, String taskName) {
         this.copyTransOptions = copyTransOptions;
+        this.handle = new CopyTransTaskHandle(taskName);
     }
 
     @Override
@@ -88,6 +89,10 @@ public static class CopyTransTaskHandle extends TimedAsyncHandle<Void> {
         @Setter
         private String triggeredBy;
 
+        public CopyTransTaskHandle(String taskName) {
+            super(taskName);
+        }
+
         /**
          * Increments the processed documents by 1
          */

diff --git a/zanata-war/src/main/java/org/zanata/async/tasks/DocumentCopyTransTask.java b/zanata-war/src/main/java/org/zanata/async/tasks/DocumentCopyTransTask.java
@@ -43,7 +43,7 @@ public class DocumentCopyTransTask extends CopyTransTask {
 
     public DocumentCopyTransTask(HDocument document,
             HCopyTransOptions copyTransOptions) {
-        super(copyTransOptions);
+        super(copyTransOptions, "DocumentCopyTransTask: "+document.getDocId());
         this.document = document;
     }
 

diff --git a/zanata-war/src/main/java/org/zanata/async/tasks/IterationCopyTransTask.java b/zanata-war/src/main/java/org/zanata/async/tasks/IterationCopyTransTask.java
@@ -43,7 +43,7 @@ public class IterationCopyTransTask extends CopyTransTask {
 
     public IterationCopyTransTask(HProjectIteration projectIteration,
             HCopyTransOptions options) {
-        super(options);
+        super(options, "IterationCopyTransTask: "+projectIteration.getSlug());
         this.projectIteration = projectIteration;
     }
 

diff --git a/zanata-war/src/main/java/org/zanata/async/tasks/ZipFileBuildTask.java b/zanata-war/src/main/java/org/zanata/async/tasks/ZipFileBuildTask.java
@@ -86,7 +86,8 @@ public AsyncTaskHandle<String> getHandle() {
     }
 
     private AsyncTaskHandle<String> buildHandle() {
-        AsyncTaskHandle<String> newHandle = new AsyncTaskHandle<String>();
+        String name = "ZipFileBuildTask: "+projectSlug+"-"+iterationSlug+"-"+localeId;
+        AsyncTaskHandle<String> newHandle = new AsyncTaskHandle<String>(name);
 
         // Max documents to process
         DocumentDAO documentDAO =

diff --git a/zanata-war/src/main/java/org/zanata/rest/service/AsynchronousProcessResourceService.java b/zanata-war/src/main/java/org/zanata/rest/service/AsynchronousProcessResourceService.java
@@ -118,21 +118,17 @@ public ProcessStatus startSourceDocCreation(final String idNoSlash,
             }
         }
 
-        SimpleAsyncTask<Void> task = new SimpleAsyncTask<Void>() {
+        String name = "SourceDocCreation: "+projectSlug+"-"+iterationSlug+"-"+idNoSlash;
+        SimpleAsyncTask<Void> task = new SimpleAsyncTask<Void>(name) {
             @Override
             public Void call() throws Exception {
                 DocumentService documentServiceImpl =
                         (DocumentService) Component
                                 .getInstance(DocumentServiceImpl.class);
                 documentServiceImpl.saveDocument(projectSlug, iterationSlug,
                         resource, extensions, copytrans, true);
-                getHandle().setCurrentProgress(getHandle().getMaxProgress()); // TODO
-                                                                              // This
-                                                                              // should
-                                                                              // update
-                                                                              // with
-                                                                              // real
-                                                                              // progress
+                // TODO This should update with real progress
+                getHandle().setCurrentProgress(getHandle().getMaxProgress());
                 return null;
             }
         };
@@ -153,7 +149,8 @@ public ProcessStatus startSourceDocCreationOrUpdate(final String idNoSlash,
 
         resourceUtils.validateExtensions(extensions); // gettext, comment
 
-        SimpleAsyncTask<Void> task = new SimpleAsyncTask<Void>() {
+        String name = "SourceDocCreationOrUpdate: "+projectSlug+"-"+iterationSlug+"-"+idNoSlash;
+        SimpleAsyncTask<Void> task = new SimpleAsyncTask<Void>(name) {
             @Override
             public Void call() throws Exception {
                 DocumentService documentServiceImpl =
@@ -198,8 +195,9 @@ public ProcessStatus startTranslatedDocCreationOrUpdate(
         final String id = URIHelper.convertFromDocumentURIId(idNoSlash);
         final MergeType finalMergeType = mergeType;
 
+        String name = "TranslatedDocCreationOrUpdate: "+projectSlug+"-"+iterationSlug+"-"+idNoSlash+"-"+locale;
         SimpleAsyncTask<List<String>> task =
-                new SimpleAsyncTask<List<String>>() {
+                new SimpleAsyncTask<List<String>>(name) {
                     @Override
                     public List<String> call() throws Exception {
                         TranslationService translationServiceImpl =

diff --git a/zanata-war/src/main/webapp/admin/processmanager.xhtml b/zanata-war/src/main/webapp/admin/processmanager.xhtml
@@ -44,7 +44,7 @@
         <rich:column>
           <f:facet
             name="header">#{messages['jsf.processmanager.Type']}</f:facet>
-          #{handle.getClass().getSimpleName()}
+          #{handle.getTaskName()}
         </rich:column>
         <rich:column>
           <f:facet name="header">#{messages['jsf.Status']}</f:facet>

diff --git a/zanata-war/src/test/java/org/zanata/async/AsyncTaskITCase.java b/zanata-war/src/test/java/org/zanata/async/AsyncTaskITCase.java
@@ -54,7 +54,7 @@ public void taskReturnsValue() throws Exception {
 
         // Start an asynchronous process
         AsyncTaskHandle<String> handle =
-                taskExecutor.startTask(new SimpleAsyncTask<String>() {
+                taskExecutor.startTask(new SimpleAsyncTask<String>("taskReturnsValue") {
                     @Override
                     public String call() throws Exception {
                         return expectedRetVal;
@@ -73,7 +73,7 @@ public String call() throws Exception {
     public void executionError() throws Exception {
         // Start an asynchronous process that throws an exception
         AsyncTaskHandle<String> handle =
-                taskExecutor.startTask(new SimpleAsyncTask<String>() {
+                taskExecutor.startTask(new SimpleAsyncTask<String>("executionError") {
                     @Override
                     public String call() throws Exception {
                         throw new RuntimeException("Expected Exception");
@@ -90,7 +90,7 @@ public String call() throws Exception {
     public void progressUpdates() throws Exception {
         final List<Integer> progressUpdates = Lists.newArrayList();
         // "Mock" the task handle so that progress updates are recorded
-        final AsyncTaskHandle<Void> taskHandle = new AsyncTaskHandle<Void>() {
+        final AsyncTaskHandle<Void> taskHandle = new AsyncTaskHandle<Void>("progressUpdates") {
             @Override
             public void setCurrentProgress(int progress) {
                 super.setCurrentProgress(progress);