RFC 9113 conformance: use command queue to activate streams reserved with a push promise; improved server push test cases

Author: ok2c

httpcore5-h2/src/main/java/org/apache/hc/core5/http2/impl/nio/AbstractH2StreamMultiplexer.java

@@ -82,6 +82,7 @@
 import org.apache.hc.core5.http2.impl.BasicH2TransportMetrics;
 import org.apache.hc.core5.http2.nio.AsyncPingHandler;
 import org.apache.hc.core5.http2.nio.command.PingCommand;
+import org.apache.hc.core5.http2.nio.command.PushResponseCommand;
 import org.apache.hc.core5.io.CloseMode;
 import org.apache.hc.core5.reactor.Command;
 import org.apache.hc.core5.reactor.ProtocolIOSession;
@@ -499,7 +500,7 @@ public final void onOutput() throws HttpException, IOException {
         }
 
         if (connState.compareTo(ConnectionHandshake.ACTIVE) <= 0 && remoteSettingState == SettingsHandshake.ACKED) {
-            while (streams.size() < remoteConfig.getMaxConcurrentStreams()) {
+            while (streams.getLocalCount() < remoteConfig.getMaxConcurrentStreams()) {
                 final Command command = ioSession.poll();
                 if (command == null) {
                     break;
@@ -510,6 +511,8 @@ public final void onOutput() throws HttpException, IOException {
                     executePing((PingCommand) command);
                 } else if (command instanceof RequestExecutionCommand) {
                     executeRequest((RequestExecutionCommand) command);
+                } else if (command instanceof PushResponseCommand) {
+                    executePush((PushResponseCommand) command);
                 }
                 if (!outputQueue.isEmpty()) {
                     return;
@@ -638,6 +641,23 @@ private void executeRequest(final RequestExecutionCommand requestExecutionComman
         }
     }
 
+    private void executePush(final PushResponseCommand pushResponseCommand) throws IOException, HttpException {
+        if (pushResponseCommand.isCancelled()) {
+            return;
+        }
+        final H2Stream stream = streams.lookupSeen(pushResponseCommand.getStreamId());
+        if (stream != null && stream.isReserved()) {
+            if (!stream.isLocalClosed()) {
+                stream.activate();
+                if (stream.isOutputReady()) {
+                    stream.produceOutput();
+                }
+            } else {
+                stream.abort();
+            }
+        }
+    }
+
     public final void onException(final Exception cause) {
         try {
             for (;;) {
@@ -812,7 +832,7 @@ private void consumeFrame(final RawFrame frame) throws HttpException, IOExceptio
                 if (streamId == 0) {
                     throw new H2ConnectionException(H2Error.PROTOCOL_ERROR, "Illegal stream id: " + streamId);
                 }
-                final H2Stream stream = streams.lookupValidOrNull(streamId);
+                final H2Stream stream = streams.lookupSeen(streamId);
                 if (stream != null) {
                     final ByteBuffer payload = frame.getPayload();
                     if (payload == null || payload.remaining() != 4) {
@@ -1247,7 +1267,8 @@ void appendState(final StringBuilder buf) {
                 .append(", connInputWindow=").append(connInputWindow)
                 .append(", connOutputWindow=").append(connOutputWindow)
                 .append(", outputQueue=").append(outputQueue.size())
-                .append(", streams.size=").append(streams.size())
+                .append(", streams.localCoubt=").append(streams.getLocalCount())
+                .append(", streams.remoteCount=").append(streams.getRemoteCount())
                 .append(", streams.lastLocal=").append(streams.getLastLocalId())
                 .append(", streams.lastRemote=").append(streams.getLastRemoteId());
     }
@@ -1362,9 +1383,11 @@ public void push(final List<Header> headers, final AsyncPushProducer pushProduce
                 ensureNotClosed();
                 final int promisedStreamId = streams.generateStreamId();
                 final H2StreamChannel channel = createChannel(promisedStreamId);
-                streams.createReserved(channel, outgoingPushPromise(channel, pushProducer));
+                final H2Stream stream = streams.createReserved(channel, outgoingPushPromise(channel, pushProducer));
 
                 commitPushPromise(id, promisedStreamId, headers);
+                stream.markRemoteClosed();
+                submitCommand(new PushResponseCommand(promisedStreamId));
             } finally {
                 ioSession.getLock().unlock();
             }

httpcore5-h2/src/main/java/org/apache/hc/core5/http2/impl/nio/H2Stream.java

@@ -123,6 +123,10 @@ boolean isRemoteClosed() {
         return remoteClosed;
     }
 
+    void markRemoteClosed() {
+        remoteClosed = true;
+    }
+
     boolean isLocalClosed() {
         return channel.isLocalClosed();
     }
@@ -173,7 +177,7 @@ void consumeData(final ByteBuffer src, final boolean endOfStream) throws HttpExc
     }
 
     boolean isOutputReady() {
-        return !channel.isLocalClosed() && handler.isOutputReady();
+        return !reserved && !channel.isLocalClosed() && handler.isOutputReady();
     }
 
     void produceOutput() throws HttpException, IOException {

httpcore5-h2/src/main/java/org/apache/hc/core5/http2/impl/nio/H2Streams.java

@@ -60,10 +60,6 @@ public H2Streams(final StreamIdGenerator idGenerator) {
         this.remoteCount = new AtomicInteger(0);
     }
 
-    public int size() {
-        return streams.size();
-    }
-
     public boolean isEmpty() {
         return streams.isEmpty();
     }
@@ -80,6 +76,14 @@ public int getLastRemoteId() {
         return lastRemoteId.get();
     }
 
+    public int getLocalCount() {
+        return localCount.get();
+    }
+
+    public int getRemoteCount() {
+        return remoteCount.get();
+    }
+
     private H2Stream createStream(final H2StreamChannel channel, final H2StreamHandler streamHandler) {
         final int streamId = channel.getId();
         final boolean remoteStream = isOtherSide(streamId);

httpcore5-h2/src/main/java/org/apache/hc/core5/http2/nio/command/PushResponseCommand.java

@@ -0,0 +1,65 @@
+/*
+ * ====================================================================
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation.  For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+
+package org.apache.hc.core5.http2.nio.command;
+
+import java.util.concurrent.atomic.AtomicBoolean;
+
+import org.apache.hc.core5.annotation.Internal;
+import org.apache.hc.core5.reactor.Command;
+import org.apache.hc.core5.util.Args;
+
+/**
+ * Activates the stream reserved with a push promise
+ *
+ * @since 5.4
+ */
+@Internal
+public final class PushResponseCommand implements Command {
+
+    private final int streamId;
+    private final AtomicBoolean cancelled;
+
+    public PushResponseCommand(final int streamId) {
+        this.streamId = Args.positive(streamId, "Stream Id");
+        this.cancelled = new AtomicBoolean();
+    }
+
+    public int getStreamId() {
+        return streamId;
+    }
+
+    public boolean isCancelled() {
+        return cancelled.get();
+    }
+
+    @Override
+    public boolean cancel() {
+        return cancelled.compareAndSet(false, true);
+    }
+
+}