Deprecate public APIs using Guava's ListenableFuture

Public methods:
- com.yahoo.processing.rendering.Renderer.render()
- com.yahoo.search.handler.HttpSearchResponse.waitableRender()
- com.yahoo.processing.rendering.AsynchronousSectionedRenderer.renderBeforeHandover()

6 files changed, 64 insertions, 33 deletions

diff --git a/container-core/abi-spec.json b/container-core/abi-spec.json
index e4b97c3c968..cdd6da944c5 100644
--- a/container-core/abi-spec.json
+++ b/container-core/abi-spec.json
@@ -3137,8 +3137,9 @@
       "public abstract void endResponse()",
       "public void <init>()",
       "public void <init>(java.util.concurrent.Executor)",
-      "public final com.google.common.util.concurrent.ListenableFuture render(java.io.OutputStream, com.yahoo.processing.Response, com.yahoo.processing.execution.Execution, com.yahoo.processing.Request)",
+      "public final java.util.concurrent.CompletableFuture renderResponse(java.io.OutputStream, com.yahoo.processing.Response, com.yahoo.processing.execution.Execution, com.yahoo.processing.Request)",
       "public void deconstruct()",
+      "public final java.util.concurrent.CompletableFuture renderResponseBeforeHandover(java.io.OutputStream, com.yahoo.processing.Response, com.yahoo.processing.execution.Execution, com.yahoo.processing.Request)",
       "public final com.google.common.util.concurrent.ListenableFuture renderBeforeHandover(java.io.OutputStream, com.yahoo.processing.Response, com.yahoo.processing.execution.Execution, com.yahoo.processing.Request)",
       "public com.yahoo.processing.execution.Execution getExecution()",
       "public com.yahoo.processing.Response getResponse()",
@@ -3184,7 +3185,8 @@
       "public void <init>()",
       "public com.yahoo.processing.rendering.Renderer clone()",
       "public void init()",
-      "public abstract com.google.common.util.concurrent.ListenableFuture render(java.io.OutputStream, com.yahoo.processing.Response, com.yahoo.processing.execution.Execution, com.yahoo.processing.Request)",
+      "public com.google.common.util.concurrent.ListenableFuture render(java.io.OutputStream, com.yahoo.processing.Response, com.yahoo.processing.execution.Execution, com.yahoo.processing.Request)",
+      "public java.util.concurrent.CompletableFuture renderResponse(java.io.OutputStream, com.yahoo.processing.Response, com.yahoo.processing.execution.Execution, com.yahoo.processing.Request)",
       "public abstract java.lang.String getEncoding()",
       "public abstract java.lang.String getMimeType()",
       "public bridge synthetic com.yahoo.component.AbstractComponent clone()",
diff --git a/container-core/src/main/java/com/yahoo/processing/handler/AbstractProcessingHandler.java b/container-core/src/main/java/com/yahoo/processing/handler/AbstractProcessingHandler.java
index 5119e69f72e..9b9224e70ef 100644
--- a/container-core/src/main/java/com/yahoo/processing/handler/AbstractProcessingHandler.java
+++ b/container-core/src/main/java/com/yahoo/processing/handler/AbstractProcessingHandler.java
@@ -244,7 +244,8 @@ public abstract class AbstractProcessingHandler<COMPONENT extends Processor> ext
 
             // Render if we have a renderer capable of it
             if (getRenderer() instanceof AsynchronousSectionedRenderer) {
-                ((AsynchronousSectionedRenderer) getRenderer()).renderBeforeHandover(new ContentChannelOutputStream(channel), response, execution, request);
+                ((AsynchronousSectionedRenderer) getRenderer()).renderResponseBeforeHandover(
+                        new ContentChannelOutputStream(channel), response, execution, request);
             }
         }
 
diff --git a/container-core/src/main/java/com/yahoo/processing/handler/ProcessingResponse.java b/container-core/src/main/java/com/yahoo/processing/handler/ProcessingResponse.java
index 54fbce9e177..28645b4bde0 100644
--- a/container-core/src/main/java/com/yahoo/processing/handler/ProcessingResponse.java
+++ b/container-core/src/main/java/com/yahoo/processing/handler/ProcessingResponse.java
@@ -1,19 +1,9 @@
 // Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
 package com.yahoo.processing.handler;
 
-import java.io.IOException;
-import java.io.OutputStream;
-import java.util.Collections;
-import java.util.LinkedHashSet;
-import java.util.List;
-import java.util.Set;
-import java.util.concurrent.Executor;
-
 import com.google.common.collect.ImmutableList;
 import com.yahoo.container.jdisc.AsyncHttpResponse;
-import com.yahoo.container.jdisc.HttpRequest;
 import com.yahoo.container.jdisc.VespaHeaders;
-import com.yahoo.container.logging.AccessLogEntry;
 import com.yahoo.jdisc.handler.CompletionHandler;
 import com.yahoo.jdisc.handler.ContentChannel;
 import com.yahoo.processing.Request;
@@ -26,6 +16,14 @@ import com.yahoo.processing.request.ErrorMessage;
 import com.yahoo.processing.response.Data;
 import com.yahoo.processing.response.DataList;
 
+import java.io.IOException;
+import java.io.OutputStream;
+import java.util.Collections;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Set;
+import java.util.concurrent.Executor;
+
 /**
  * A response from running a request through processing. This response is just a
  * wrapper of the knowhow needed to render the Response from processing.
@@ -62,7 +60,7 @@ public class ProcessingResponse extends AsyncHttpResponse {
             AsynchronousRenderer asyncRenderer = (AsynchronousRenderer)renderer;
             asyncRenderer.setNetworkWiring(channel, completionHandler);
         }
-        renderer.render(stream, processingResponse, execution, processingRequest);
+        renderer.renderResponse(stream, processingResponse, execution, processingRequest);
         // the stream is closed in AsynchronousSectionedRenderer, after all data
         // has arrived
     }
diff --git a/container-core/src/main/java/com/yahoo/processing/rendering/AsynchronousSectionedRenderer.java b/container-core/src/main/java/com/yahoo/processing/rendering/AsynchronousSectionedRenderer.java
index b77d493ea30..21375ee3d76 100644
--- a/container-core/src/main/java/com/yahoo/processing/rendering/AsynchronousSectionedRenderer.java
+++ b/container-core/src/main/java/com/yahoo/processing/rendering/AsynchronousSectionedRenderer.java
@@ -3,11 +3,10 @@ package com.yahoo.processing.rendering;
 
 import com.google.common.util.concurrent.ListenableFuture;
 import com.google.common.util.concurrent.MoreExecutors;
-import com.google.common.util.concurrent.SettableFuture;
+import com.yahoo.concurrent.CompletableFutures;
 import com.yahoo.concurrent.ThreadFactoryFactory;
 import com.yahoo.jdisc.handler.CompletionHandler;
 import com.yahoo.jdisc.handler.ContentChannel;
-import java.util.logging.Level;
 import com.yahoo.processing.Request;
 import com.yahoo.processing.Response;
 import com.yahoo.processing.execution.Execution;
@@ -23,12 +22,14 @@ import java.util.ArrayDeque;
 import java.util.Collections;
 import java.util.Deque;
 import java.util.List;
+import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Executor;
 import java.util.concurrent.LinkedBlockingQueue;
 import java.util.concurrent.RejectedExecutionException;
 import java.util.concurrent.ThreadPoolExecutor;
 import java.util.concurrent.TimeUnit;
+import java.util.logging.Level;
 import java.util.logging.Logger;
 
 /**
@@ -126,7 +127,7 @@ public abstract class AsynchronousSectionedRenderer<RESPONSE extends Response> e
         return executor;
     }
 
-    private SettableFuture<Boolean> success;
+    private CompletableFuture<Boolean> success;
 
     private ContentChannel channel;
     private CompletionHandler completionHandler;
@@ -173,8 +174,8 @@ public abstract class AsynchronousSectionedRenderer<RESPONSE extends Response> e
      * @return a future indicating whether rendering was successful
      */
     @Override
-    public final ListenableFuture<Boolean> render(OutputStream stream, RESPONSE response,
-                                                  Execution execution, Request request) {
+    public final CompletableFuture<Boolean> renderResponse(OutputStream stream, RESPONSE response,
+                                                           Execution execution, Request request) {
         if (beforeHandoverMode) { // rendering has already started or is already complete
             beforeHandoverMode = false;
             if ( ! dataListListenerStack.isEmpty() &&
@@ -215,22 +216,31 @@ public abstract class AsynchronousSectionedRenderer<RESPONSE extends Response> e
      * At this point the worker thread still owns the Response, so all this rendering must happen
      * on the caller thread invoking freeze (that is, on the thread calling this).
      */
-    public final ListenableFuture<Boolean> renderBeforeHandover(OutputStream stream, RESPONSE response,
-                                                                Execution execution, Request request) {
+    public final CompletableFuture<Boolean> renderResponseBeforeHandover(OutputStream stream, RESPONSE response,
+                                                                         Execution execution, Request request) {
         beforeHandoverMode = true;
         if ( ! isInitialized) throw new IllegalStateException("render() invoked before init().");
 
         return startRender(stream, response, execution, request);
     }
 
-    private ListenableFuture<Boolean> startRender(OutputStream stream, RESPONSE response,
+
+    /** @deprecated Use {@link #renderResponseBeforeHandover(OutputStream, Response, Execution, Request)} */
+    @Deprecated(forRemoval = true, since = "7")
+    @SuppressWarnings("removal")
+    public final ListenableFuture<Boolean> renderBeforeHandover(OutputStream stream, RESPONSE response,
+                                                                Execution execution, Request request) {
+        return CompletableFutures.toGuavaListenableFuture(renderResponseBeforeHandover(stream, response, execution, request));
+    }
+
+    private CompletableFuture<Boolean> startRender(OutputStream stream, RESPONSE response,
                                                   Execution execution, Request request) {
         this.response = response;
         this.stream = stream;
         this.execution = execution;
         DataListListener parentOfTopLevelListener = new DataListListener(new ParentOfTopLevel(request,response.data()), null);
         dataListListenerStack.addFirst(parentOfTopLevelListener);
-        success = SettableFuture.create();
+        success = new CompletableFuture<>();
         try {
             getExecutor().execute(parentOfTopLevelListener);
         } catch (RejectedExecutionException e) {
@@ -471,11 +481,11 @@ public abstract class AsynchronousSectionedRenderer<RESPONSE extends Response> e
                 logger.log(Level.WARNING, "Exception caught while closing stream to client.", e);
             } finally {
                 if (failed != null) {
-                    success.setException(failed);
+                    success.completeExceptionally(failed);
                 } else if (closeException != null) {
-                    success.setException(closeException);
+                    success.completeExceptionally(closeException);
                 } else {
-                    success.set(true);
+                    success.complete(true);
                 }
                 if (channel != null) {
                     channel.close(completionHandler);
@@ -541,7 +551,7 @@ public abstract class AsynchronousSectionedRenderer<RESPONSE extends Response> e
                             } catch (Exception ignored) {
                             }
                         }
-                        success.setException(e);
+                        success.completeExceptionally(e);
                     }
                 }
             } catch (Error e) {
diff --git a/container-core/src/main/java/com/yahoo/processing/rendering/Renderer.java b/container-core/src/main/java/com/yahoo/processing/rendering/Renderer.java
index 14ec3002b0a..8db4ed4f624 100644
--- a/container-core/src/main/java/com/yahoo/processing/rendering/Renderer.java
+++ b/container-core/src/main/java/com/yahoo/processing/rendering/Renderer.java
@@ -3,11 +3,13 @@ package com.yahoo.processing.rendering;
 
 import com.google.common.util.concurrent.ListenableFuture;
 import com.yahoo.component.AbstractComponent;
+import com.yahoo.concurrent.CompletableFutures;
 import com.yahoo.processing.Request;
 import com.yahoo.processing.Response;
 import com.yahoo.processing.execution.Execution;
 
 import java.io.OutputStream;
+import java.util.concurrent.CompletableFuture;
 
 /**
  * Renders a response to a stream. The renderers are cloned just before
@@ -41,6 +43,17 @@ public abstract class Renderer<RESPONSE extends Response> extends AbstractCompon
     }
 
     /**
+     * @deprecated Use/implement {@link #renderResponse(OutputStream, Response, Execution, Request)} instead.
+     *             Return type changed from {@link ListenableFuture} to {@link CompletableFuture}.
+     */
+    @Deprecated(forRemoval = true, since = "7")
+    @SuppressWarnings("removal")
+    public ListenableFuture<Boolean> render(OutputStream stream, RESPONSE response, Execution execution,
+                                            Request request) {
+        return CompletableFutures.toGuavaListenableFuture(renderResponse(stream, response, execution, request));
+    }
+
+    /**
      * Render a response to a stream. The stream also exposes a ByteBuffer API
      * for efficient transactions to JDisc. The returned future will throw the
      * exception causing failure wrapped in an ExecutionException if rendering
@@ -50,10 +63,13 @@ public abstract class Renderer<RESPONSE extends Response> extends AbstractCompon
      * @param response the response to render
      * @param execution the execution which created this response
      * @param request the request matching the response
-     * @return a ListenableFuture containing a boolean where true indicates a successful rendering
+     * @return a {@link CompletableFuture} containing a boolean where true indicates a successful rendering
      */
-    public abstract ListenableFuture<Boolean> render(OutputStream stream, RESPONSE response,
-                                                     Execution execution, Request request);
+    @SuppressWarnings("removal")
+    public CompletableFuture<Boolean> renderResponse(OutputStream stream, RESPONSE response,
+                                                     Execution execution, Request request) {
+        return CompletableFutures.toCompletableFuture(render(stream, response, execution, request));
+    }
 
     /**
      * Name of the output encoding, if applicable.
diff --git a/container-core/src/test/java/com/yahoo/processing/rendering/AsynchronousSectionedRendererTest.java b/container-core/src/test/java/com/yahoo/processing/rendering/AsynchronousSectionedRendererTest.java
index ce2b54ba6ff..50864c8b034 100644
--- a/container-core/src/test/java/com/yahoo/processing/rendering/AsynchronousSectionedRendererTest.java
+++ b/container-core/src/test/java/com/yahoo/processing/rendering/AsynchronousSectionedRendererTest.java
@@ -15,7 +15,6 @@ import com.yahoo.processing.response.DataList;
 import com.yahoo.processing.response.IncomingData;
 import com.yahoo.text.Utf8;
 import org.junit.Test;
-import static org.junit.Assert.*;
 
 import java.io.IOException;
 import java.io.OutputStream;
@@ -23,10 +22,15 @@ import java.nio.ByteBuffer;
 import java.nio.charset.Charset;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.concurrent.*;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Executor;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
 
 import static org.hamcrest.CoreMatchers.equalTo;
+import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertThat;
+import static org.junit.Assert.assertTrue;
 
 /**
  * @author <a href="mailto:einarmr@yahoo-inc.com">Einar M R Rosenvinge</a>
@@ -222,7 +226,7 @@ public class AsynchronousSectionedRendererTest {
         return render(renderer, data);
     }
 
-    @SuppressWarnings("unchecked")
+    @SuppressWarnings({"unchecked", "removal"})
     public String render(Renderer renderer, DataList data) throws InterruptedException, IOException {
         TestContentChannel contentChannel = new TestContentChannel();