test/jdk/java/net/httpclient/http3/H3ServerPushCancel.java - master - githubmirror/panama-vector

test/jdk/java/net/httpclient/http3/H3ServerPushCancel.java
608 строк28 KB
Daisuke Yamazaki
8372325: Refactor tests under jdk/java/net/httpclient to use ${test.main.class}
09 апр 2026, 13:51
09 апр 2026, 13:51261011a
/*
 * Copyright (c) 2023, 2026, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

/*
 * @test
 * @library /test/lib /test/jdk/java/net/httpclient/lib
 * @build jdk.test.lib.net.SimpleSSLContext jdk.httpclient.test.lib.http2.Http2TestServer
 * @run junit/othervm
 *      -Djdk.internal.httpclient.debug=true
 *      -Djdk.httpclient.HttpClient.log=errors,requests,responses,trace
 *      -Djdk.httpclient.http3.maxConcurrentPushStreams=45
 *      ${test.main.class}
 * @summary This test checks that the client deals correctly with a
 *      CANCEL_PUSH frame sent by the server
 */

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InterruptedIOException;
import java.io.OutputStream;
import java.io.PrintStream;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpClient.Builder;
import java.net.http.HttpHeaders;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandler;
import java.net.http.HttpResponse.BodyHandlers;
import java.net.http.HttpResponse.PushPromiseHandler;
import java.net.http.HttpResponse.PushPromiseHandler.PushId;
import java.net.http.HttpResponse.PushPromiseHandler.PushId.Http3PushId;
import java.nio.channels.ClosedChannelException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionException;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.locks.ReentrantLock;
import java.util.function.Function;
import java.util.function.Supplier;

import jdk.httpclient.test.lib.common.HttpServerAdapters;
import jdk.internal.net.http.common.Utils;
import jdk.test.lib.net.SimpleSSLContext;

import static java.net.http.HttpClient.Version.HTTP_2;
import static java.net.http.HttpClient.Version.HTTP_3;
import static java.net.http.HttpOption.Http3DiscoveryMode.ALT_SVC;
import static java.net.http.HttpOption.Http3DiscoveryMode.ANY;
import static java.net.http.HttpOption.H3_DISCOVERY;
import static java.nio.charset.StandardCharsets.UTF_8;

import org.junit.jupiter.api.AfterAll;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;

public class H3ServerPushCancel implements HttpServerAdapters {

    // dummy hack to prevent the IDE complaining that calling
    // println will throw NPE
    static final PrintStream err = System.err;
    static final PrintStream out = System.out;

    static final Map<String,String> PUSH_PROMISES = Map.of(
            "/x/y/z/1", "the first push promise body",
            "/x/y/z/2", "the second push promise body",
            "/x/y/z/3", "the third push promise body",
            "/x/y/z/4", "the fourth push promise body",
            "/x/y/z/5", "the fifth push promise body",
            "/x/y/z/6", "the sixth push promise body",
            "/x/y/z/7", "the seventh push promise body",
            "/x/y/z/8", "the eight push promise body",
            "/x/y/z/9", "the ninth push promise body"
    );
    static final String MAIN_RESPONSE_BODY = "the main response body";
    static final int REQUESTS = 5;

    private static HttpTestServer server;
    private static URI uri;
    private static URI headURI;
    private static ServerPushHandler pushHandler;

    @BeforeAll
    public static void setup() throws Exception {
        server = HttpTestServer.create(ANY, SimpleSSLContext.findSSLContext());
        pushHandler = new ServerPushHandler(MAIN_RESPONSE_BODY, PUSH_PROMISES);
        server.addHandler(pushHandler, "/push/");
        server.addHandler(new HttpHeadOrGetHandler(), "/head/");
        server.start();
        err.println("Server listening on port " + server.serverAuthority());
        uri = new URI("https://" + server.serverAuthority() + "/push/a/b/c");
        headURI = new URI("https://" + server.serverAuthority() + "/head/x");
    }

    @AfterAll
    public static void teardown() {
        server.stop();
    }

    static <T> HttpResponse<T> assert200ResponseCode(HttpResponse<T> response) {
        assertEquals(200, response.statusCode());
        assertEquals(HTTP_3, response.version());
        return response;
    }

    private void sendHeadRequest(HttpClient client) throws IOException, InterruptedException {
        HttpRequest headRequest = HttpRequest.newBuilder(headURI)
                .HEAD().version(HTTP_2).build();
        var headResponse = client.send(headRequest, BodyHandlers.ofString());
        assertEquals(200, headResponse.statusCode());
        assertEquals(HTTP_2, headResponse.version());
    }

    static final class TestPushPromiseHandler<T> implements PushPromiseHandler<T> {
        record NotifiedPromise(PushId pushId, HttpRequest initiatingRequest) {}
        final Map<HttpRequest, PushId> requestToPushId = new ConcurrentHashMap<>();
        final Map<PushId, HttpRequest> pushIdToRequest = new ConcurrentHashMap<>();
        final List<AssertionError> errors = new CopyOnWriteArrayList<>();
        final List<NotifiedPromise> notified = new CopyOnWriteArrayList<>();
        final ConcurrentMap<HttpRequest, CompletableFuture<HttpResponse<T>>> promises
                = new ConcurrentHashMap<>();
        final Supplier<BodyHandler<T>> bodyHandlerSupplier;
        final PushPromiseHandler<T> pph;
        TestPushPromiseHandler(Supplier<BodyHandler<T>> bodyHandlerSupplier) {
            this.bodyHandlerSupplier = bodyHandlerSupplier;
            this.pph = PushPromiseHandler.of((r) -> bodyHandlerSupplier.get(), promises);
        }

        @Override
        public void applyPushPromise(HttpRequest initiatingRequest,
                                     HttpRequest pushPromiseRequest,
                                     Function<BodyHandler<T>, CompletableFuture<HttpResponse<T>>> acceptor) {
            errors.add(new AssertionError("no pushID provided for: " + pushPromiseRequest));
        }

        @Override
        public void notifyAdditionalPromise(HttpRequest initiatingRequest, PushId pushid) {
            notified.add(new NotifiedPromise(pushid, initiatingRequest));
            out.println("notifyPushPromise: pushId=" + pushid);
            pph.notifyAdditionalPromise(initiatingRequest, pushid);
        }

        @Override
        public void applyPushPromise(HttpRequest initiatingRequest,
                                     HttpRequest pushPromiseRequest,
                                     PushId pushid,
                                     Function<BodyHandler<T>, CompletableFuture<HttpResponse<T>>> acceptor) {
            out.println("applyPushPromise: " + pushPromiseRequest + ", pushId=" + pushid);
            requestToPushId.putIfAbsent(pushPromiseRequest, pushid);
            if (pushIdToRequest.putIfAbsent(pushid, pushPromiseRequest) != null) {
                errors.add(new AssertionError("pushId already used: " + pushid));
            }
            pph.applyPushPromise(initiatingRequest, pushPromiseRequest, pushid, acceptor);
        }

    }

    <T> T join(CompletableFuture<T> cf) {
        try {
            return cf.join();
        } catch (CompletionException c) {
            throw new AssertionError(c.getCause());
        } catch (Throwable t) {
            throw new AssertionError(t);
        }
    }

    String describeBody(CompletableFuture<HttpResponse<String>> cf) {
        return cf.thenApply(HttpResponse::body).exceptionally(Throwable::toString).join();
    }

    String describeKey(TestPushPromiseHandler<String> pph, HttpRequest request) {
        if (PUSH_PROMISES.containsKey(request.uri().getPath())) {
            var pushId = pph.requestToPushId.get(request);
            if (pushId instanceof Http3PushId h3id) {
                return "[push=%s]".formatted(h3id.pushId()) + request;
            } else return "[push=%s]".formatted(pushId) + request;
        } else {
            return "[main] " + request;
        }
    }

    @Test
    public void testServerCancelPushes() throws Exception {
        int maxPushes = Utils.getIntegerProperty("jdk.httpclient.http3.maxConcurrentPushStreams", -1);
        out.println("maxPushes: " + maxPushes);
        assertTrue(maxPushes > 0);
        try (HttpClient client = newClientBuilderForH3()
                .proxy(Builder.NO_PROXY)
                .version(HTTP_3)
                .sslContext(SimpleSSLContext.findSSLContext())
                .build()) {

            sendHeadRequest(client);

            // Send with promise handler
            TestPushPromiseHandler<String> custom = new TestPushPromiseHandler<>(BodyHandlers::ofString);
            var promises = custom.promises;
            Set<PushId> expectedPushIds = new HashSet<>();

            for (int j=0; j < 2; j++) {
                if (j == 0) out.println("\ntestCancel: First time around");
                else out.println("\ntestCancel: Second time around: should be a new connection");

                // now make sure there's an HTTP/3 connection
                client.send(HttpRequest.newBuilder(headURI).version(HTTP_3)
                        .setOption(H3_DISCOVERY, ALT_SVC)
                        .HEAD().build(), BodyHandlers.discarding());

                int waitForPushId;
                List<CompletableFuture<HttpResponse<String>>> responses = new ArrayList<>();
                for (int i = 0; i < REQUESTS; i++) {
                    waitForPushId = Math.min(PUSH_PROMISES.size(), maxPushes) + 1;
                    CompletableFuture<HttpResponse<String>> main = client.sendAsync(
                            HttpRequest.newBuilder(uri.resolve("?i=%s,j=%s".formatted(i, j)))
                                    .header("X-WaitForPushId", String.valueOf(waitForPushId))
                                    .build(),
                            BodyHandlers.ofString(),
                            custom);
                    responses.add(main);
                }

                join(CompletableFuture.allOf(responses.toArray(CompletableFuture<?>[]::new)));

                responses.forEach(cf -> {
                    var main = join(cf);
                    var old = promises.put(main.request(), CompletableFuture.completedFuture(main));
                    assertNull(old, "unexpected mapping for: " + old);
                });

                promises.forEach((key, value) -> out.println(describeKey(custom, key) + ":" + describeBody(value)));

                promises.forEach((request, value) -> {
                    if (PUSH_PROMISES.containsKey(request.uri().getPath())) {
                        var pushId = custom.requestToPushId.get(request);
                        assertNotNull(pushId, "no pushId for " + request);
                        if (pushId instanceof Http3PushId h3id) {
                            long id = h3id.pushId();
                            long mod = id % PUSH_PROMISES.size();
                            if (mod > 0 && mod < 4) {
                                // should have been cancelled by server, so
                                // we should have an IO for these
                                Throwable ex = value.exceptionNow();
                                var msg = ex.getMessage();
                                var expected = "Push promise cancelled: %s".formatted(id);
                                if (!(ex instanceof IOException)) {
                                    throw new AssertionError(ex);
                                } else if (!msg.contains(expected)) {
                                    throw new AssertionError("Unexpected message: " + msg, ex);
                                }
                            } else {
                                assertEquals(PUSH_PROMISES.get(request.uri().getPath()), join(value).body());
                            }
                            expectedPushIds.add(pushId);
                        } else assertEquals(Http3PushId.class, pushId.getClass());
                    } else {
                        HttpResponse<String> response = join(value);
                        assertEquals(200, response.statusCode());
                        assertEquals(MAIN_RESPONSE_BODY, response.body());
                    }
                });

                int maxExpectedPushes = Math.min(PUSH_PROMISES.size(), maxPushes);
                int minExpectedPushes = maxExpectedPushes - 3;
                int countpushes = promises.size() - REQUESTS;
                assert countpushes >= 0;
                if (maxExpectedPushes < countpushes || minExpectedPushes > countpushes) {
                    throw new AssertionError("unexpected number of pushes %s should be in [%s,%s]"
                            .formatted(countpushes, minExpectedPushes, maxExpectedPushes));
                }

                promises.clear();
                custom.requestToPushId.clear();

                // Send with no promise handler
                try {
                    client.sendAsync(HttpRequest.newBuilder(uri).build(), BodyHandlers.ofString())
                            .thenApply(H3ServerPushCancel::assert200ResponseCode)
                            .thenApply(HttpResponse::body)
                            .thenAccept(body -> assertEquals(MAIN_RESPONSE_BODY, body))
                            .join();
                } catch (CompletionException c) {
                    throw new AssertionError(c.getCause());
                }
                assertEquals(0, promises.size());

                // Send with no promise handler, but use pushId bigger than allowed.
                // This should cause the connection to get closed
                long usePushId = maxPushes * 3 + 10;
                try {
                    HttpRequest bigger = HttpRequest.newBuilder(uri)
                            .header("X-UsePushId", String.valueOf(usePushId))
                            .build();
                    client.sendAsync(bigger, BodyHandlers.ofString())
                            .thenApply(H3ServerPushCancel::assert200ResponseCode)
                            .thenApply(HttpResponse::body)
                            .thenAccept(body -> assertEquals(MAIN_RESPONSE_BODY, body))
                            .join();
                    throw new AssertionError("Expected IOException not thrown");
                } catch (CompletionException c) {
                    boolean success = false;
                    if (c.getCause() instanceof IOException io) {
                        if (io.getMessage() != null &&
                                io.getMessage().contains("Max pushId exceeded (%s >= %s)"
                                        .formatted(usePushId, maxPushes))) {
                            success = true;
                        }
                        if (success) {
                            out.println("Got expected IOException: " + io);
                        } else throw new AssertionError(io);
                    }
                    if (!success) {
                        throw new AssertionError("Unexpected exception: " + c.getCause(), c.getCause());
                    }
                }
                assertEquals(0, promises.size());

                // the next time around we should have a new connection,
                // so we can restart from scratch
                pushHandler.reset();
            }
            var errors = custom.errors;
            errors.forEach(t -> t.printStackTrace(System.out));
            var error = errors.stream().findFirst().orElse(null);
            if (error != null) throw error;
            var notified = custom.notified;
            int count = 0;
            Set<PushId> uniqueIds = new HashSet<>();
            Set<String> cIds = new HashSet<>();
            for (var npp : notified) {
                uniqueIds.add(npp.pushId);
                if (npp.pushId instanceof Http3PushId h3id) {
                    long id = h3id.pushId();
                    cIds.add(h3id.connectionLabel());
                    long mod = id % PUSH_PROMISES.size();
                    // we can't count the cancelled pushes as
                    // how many notifs we might get for those is racy.
                    if (mod == 0 || mod >= 4) {
                        // was not cancelled
                        count++;
                    }
                }
            }

            if (!uniqueIds.equals(expectedPushIds)) {
                int problems = 0;
                int missed = 0;
                for (var id : uniqueIds) {
                    if (!expectedPushIds.contains(id)) {
                        problems++;
                        out.printf("%s was not expected%n", id);
                    }
                }
                for (var id : expectedPushIds) {
                    if (!uniqueIds.contains(id)) {
                        if (id instanceof Http3PushId h3id) {
                            long mod = h3id.pushId() % PUSH_PROMISES.size();
                            if (mod > 0 && mod < 4) {
                                // this one was cancelled, so it might not
                                // have been notified
                                missed++;
                                continue;
                            }
                        }
                        problems++;
                        out.printf("%s was expected but not notified%n", id);
                    }
                }
                if (problems > 0) {
                    throw new AssertionError("%s unexpected problems with ids have been found"
                            .formatted(problems));
                }
            }
            // excluding those that got cancelled,
            // we should have received REQUEST-1 notifications
            // per push promise and per connection
            assertEquals((PUSH_PROMISES.size()-3)*2*(REQUESTS-1), count,
                    "Unexpected notification: " + notified);
        }
    }


    // --- server push handler ---
    static class ServerPushHandler implements HttpTestHandler {

        private final String mainResponseBody;
        private final Map<String,String> promises;
        private final ReentrantLock lock = new ReentrantLock();
        private final Map<String, PendingPromise> sentPromises = new ConcurrentHashMap<>();
        record PendingPromise(long pushId, CountDownLatch latch) {
            PendingPromise(long pushId) {
                this(pushId, new CountDownLatch(REQUESTS));
            }
        }

        public ServerPushHandler(String mainResponseBody,
                                 Map<String,String> promises)
            throws Exception
        {
            Objects.requireNonNull(promises);
            this.mainResponseBody = mainResponseBody;
            this.promises = promises;
        }

        // The assumption is that there will be several concurrent
        // exchanges, but all on the same connection
        // The first exchange that emits a PushPromise sends
        // a push promise frame + open the push response stream.
        // The other exchanges will simply send a push promise
        // frame, with the pushId allocated by the previous exchange.
        // The sentPromises map is used to store that pushId.
        // This obviously only works if we have a single HTTP/3 connection.
        final AtomicInteger count = new AtomicInteger();
        public void handle(HttpTestExchange exchange) throws IOException {
            long count = -1;
            try {
                count = this.count.incrementAndGet();
                err.println("Server: handle " + exchange +
                        " on " + exchange.getConnectionKey());
                out.println("Server: handle " + exchange.getRequestURI() +
                        " on " + exchange.getConnectionKey());
                try (InputStream is = exchange.getRequestBody()) {
                    is.readAllBytes();
                }

                if (exchange.serverPushAllowed()) {
                    pushPromises(exchange);
                }

                // response data for the main response
                try (OutputStream os = exchange.getResponseBody()) {
                    byte[] bytes = mainResponseBody.getBytes(UTF_8);
                    exchange.sendResponseHeaders(200, bytes.length);
                    os.write(bytes);
                } catch (ClosedChannelException ex) {
                    out.printf("handling exchange %s, %s: %s%n", count,
                            exchange.getRequestURI(), exchange.getRequestHeaders());
                    out.printf("Got closed channel exception sending response after sent=%s allowed=%s%n",
                            sent, allowed);
                }
            } finally {
                out.printf("handled exchange %s, %s: %s%n", count,
                        exchange.getRequestURI(), exchange.getRequestHeaders());
            }
        }

        volatile long allowed = -1;
        volatile int sent = 0;
        volatile int nsent = 0;
        void reset() {
            lock.lock();
            try {
                allowed = -1;
                sent = 0;
                nsent = 0;
                sentPromises.clear();
            } finally {
                lock.unlock();
            }
        }

        private void pushPromises(HttpTestExchange exchange) throws IOException {
            URI requestURI = exchange.getRequestURI();
            long waitForPushId = exchange.getRequestHeaders()
                    .firstValueAsLong("X-WaitForPushId").orElse(-1);
            long usePushId = exchange.getRequestHeaders()
                    .firstValueAsLong("X-UsePushId").orElse(-1);
            if (waitForPushId >= 0) {
                while (allowed <= waitForPushId) {
                    try {
                        err.printf("Server: waiting for pushId sent=%s allowed=%s: %s%n",
                                sent, allowed, waitForPushId);
                        var allowed = exchange.waitForHttp3MaxPushId(waitForPushId);
                        err.println("Server: Got maxPushId: " + allowed);
                        out.println("Server: Got maxPushId: " + allowed);
                        lock.lock();
                        if (allowed > this.allowed) this.allowed = allowed;
                        lock.unlock();
                    } catch (InterruptedException ie) {
                        ie.printStackTrace();
                    }
                }
            }
            for (Map.Entry<String,String> promise : promises.entrySet()) {
                // if usePushId != -1 we send a single push promise,
                // without checking that it's allowed.
                // Otherwise, we stop sending promises when we have consumed
                // the whole window
                if (usePushId == -1 && allowed > 0 && sent >= allowed) {
                    err.println("Server: sent all allowed promises: " + sent);
                    break;
                }

                if (waitForPushId >= 0) {
                    while (allowed <= waitForPushId) {
                        try {
                            err.printf("Server: waiting for pushId sent=%s allowed=%s: %s%n",
                                    sent, allowed, waitForPushId);
                            var allowed = exchange.waitForHttp3MaxPushId(waitForPushId);
                            err.println("Server: Got maxPushId: " + allowed);
                            out.println("Server: Got maxPushId: " + allowed);
                            lock.lock();
                            if (allowed > this.allowed) this.allowed = allowed;
                            lock.unlock();
                        } catch (InterruptedException ie) {
                            ie.printStackTrace();
                        }
                    }
                }
                URI uri = requestURI.resolve(promise.getKey());
                InputStream is = new ByteArrayInputStream(promise.getValue().getBytes(UTF_8));
                HttpHeaders headers = HttpHeaders.of(Collections.emptyMap(), (x, y) -> true);
                if (usePushId == -1) {
                    long pushId;
                    boolean send = false;
                    lock.lock();
                    PendingPromise pendingPromise;
                    try {
                        pendingPromise = sentPromises.get(promise.getKey());
                        if (pendingPromise == null) {
                            pushId = exchange.sendHttp3PushPromiseFrame(-1, uri, headers);
                            waitForPushId = pushId + 1;
                            pendingPromise = new PendingPromise(pushId);
                            sentPromises.put(promise.getKey(), pendingPromise);
                            sent += 1;
                            send = true;
                        } else {
                            pushId = pendingPromise.pushId;
                            exchange.sendHttp3PushPromiseFrame(pushId, uri, headers);
                        }
                    } finally {
                        lock.unlock();
                    }
                    pendingPromise.latch.countDown();
                    long mod = pushId % promises.size();
                    if (send) {
                        if (mod == 1) {
                            // var stream = exchange.openPushIdStream(pushId);
                            // err.println("Server: Opened push stream: " + pushId);
                        }
                        if (mod > 0 && mod < 4) {
                            try {
                                pendingPromise.latch.await();
                            } catch (InterruptedException e) {
                                throw new InterruptedIOException("" + e);
                            }
                            exchange.sendHttp3CancelPushFrame(pendingPromise.pushId);
                            err.println("Server: Cancelled push promise: " + pushId);
                            out.println("Server: Cancelled push promise: " + pushId);
                        } else {
                            exchange.sendHttp3PushResponse(pushId, uri, headers, headers, is);
                            out.println("Server: Sent push promise with response: " + pushId);
                            err.println("Server: Sent push promise with response: " + pushId);
                        }
                    } else {
                        err.println("Server: Sent push promise frame: " + pushId);
                    }
                    if (pushId >= waitForPushId) waitForPushId = pushId + 1;
                } else {
                    exchange.sendHttp3PushPromiseFrame(usePushId, uri, headers);
                    err.println("Server: Sent push promise frame: " + usePushId);
                    exchange.sendHttp3PushResponse(usePushId, uri, headers, headers, is);
                    err.println("Server: Sent push promise response: " + usePushId);
                    lock.lock();
                    sent += 1;
                    lock.unlock();
                    return;
                }
            }
            err.println("Server: All pushes sent");
        }
    }
}