Datasets:

tiginamaria

/

bug-localization

like 2

grpc/grpc-java/1404/875

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/875

https://github.com/grpc/grpc-java/pull/1404

https://github.com/grpc/grpc-java/pull/1404

fixes

InProcessTransport doesn't call onReady

The in-process transport supports flow control and supports `isReady()`, but it never calls `onReady()`. It seems to be just an oversight/bug. Since the in-process transport connects immediately, `onReady()` should probably be called on the client immediately in `newStream()`. Locking will be a little interesting since for a single `request()` both client and server listeners may need to be called (because numMessages can be > 1). It looks like `{client,server}Requested()` could maybe return a boolean for whether `{client,server}Requested > 0 && {client,server}Requested <= numMessages`, which would imply `onReady()` should be called.

5b9726ea7dade0952d64796178dc0bdfd134d16d

86f2c9f2243a8aa34e5d9de78dcae11da80edff6

https://github.com/grpc/grpc-java/compare/5b9726ea7dade0952d64796178dc0bdfd134d16d...86f2c9f2243a8aa34e5d9de78dcae11da80edff6

diff --git a/core/src/main/java/io/grpc/inprocess/InProcessTransport.java b/core/src/main/java/io/grpc/inprocess/InProcessTransport.java index 3498173d6..f9ecf01ac 100644 --- a/core/src/main/java/io/grpc/inprocess/InProcessTransport.java +++ b/core/src/main/java/io/grpc/inprocess/InProcessTransport.java @@ -231,14 +231,27 @@ class InProcessTransport implements ServerTransport, ClientTransport { @Override public void request(int numMessages) { - clientStream.serverRequested(numMessages); + boolean onReady = clientStream.serverRequested(numMessages); + if (onReady) { + synchronized (this) { + if (!closed) { + clientStreamListener.onReady(); + } + } + } } // This method is the only reason we have to synchronize field accesses. - private synchronized void clientRequested(int numMessages) { + /** + * Client requested more messages. + * + * @return whether onReady should be called on the server + */ + private synchronized boolean clientRequested(int numMessages) { if (closed) { - return; + return false; } + boolean previouslyReady = clientRequested > 0; clientRequested += numMessages; while (clientRequested > 0 && !clientReceiveQueue.isEmpty()) { clientRequested--; @@ -246,12 +259,14 @@ class InProcessTransport implements ServerTransport, ClientTransport { } // Attempt being reentrant-safe if (closed) { - return; + return false; } if (clientReceiveQueue.isEmpty() && clientNotifyStatus != null) { closed = true; clientStreamListener.closed(clientNotifyStatus, clientNotifyTrailers); } + boolean nowReady = clientRequested > 0; + return !previouslyReady && nowReady; } private void clientCancelled(Status status) { @@ -366,14 +381,27 @@ class InProcessTransport implements ServerTransport, ClientTransport { @Override public void request(int numMessages) { - serverStream.clientRequested(numMessages); + boolean onReady = serverStream.clientRequested(numMessages); + if (onReady) { + synchronized (this) { + if (!closed) { + serverStreamListener.onReady(); + } + } + } } // This method is the only reason we have to synchronize field accesses. - private synchronized void serverRequested(int numMessages) { + /** + * Client requested more messages. + * + * @return whether onReady should be called on the server + */ + private synchronized boolean serverRequested(int numMessages) { if (closed) { - return; + return false; } + boolean previouslyReady = serverRequested > 0; serverRequested += numMessages; while (serverRequested > 0 && !serverReceiveQueue.isEmpty()) { serverRequested--; @@ -383,6 +411,8 @@ class InProcessTransport implements ServerTransport, ClientTransport { serverNotifyHalfClose = false; serverStreamListener.halfClosed(); } + boolean nowReady = serverRequested > 0; + return !previouslyReady && nowReady; } private void serverClosed(Status status) {

['core/src/main/java/io/grpc/inprocess/InProcessTransport.java']

{'.java': 1}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/1490/1476

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/1476

https://github.com/grpc/grpc-java/pull/1490

https://github.com/grpc/grpc-java/pull/1490

resolves

TransportSet should reset current index on transportReady

If we successfully make a connection to an address, then that should mean the address is good. If it later is disconnected due to GOAWAY or transient failure we should start at the top of the list instead of trying less-desirable IPs. This can cause errors, but any errors can already be gotten other ways, so it shouldn't be considered a major bug.

86bad4ffea5faf4d65cb943456bdf3d0d51d0766

643bb2c6b53d5a4516f13af856d98a85b334f0dc

https://github.com/grpc/grpc-java/compare/86bad4ffea5faf4d65cb943456bdf3d0d51d0766...643bb2c6b53d5a4516f13af856d98a85b334f0dc

diff --git a/core/src/main/java/io/grpc/internal/TransportSet.java b/core/src/main/java/io/grpc/internal/TransportSet.java index 0fa578476..d3f884e38 100644 --- a/core/src/main/java/io/grpc/internal/TransportSet.java +++ b/core/src/main/java/io/grpc/internal/TransportSet.java @@ -77,12 +77,11 @@ final class TransportSet { @GuardedBy("lock") private BackoffPolicy reconnectPolicy; - // The address index from which the current series of consecutive failing connection attempts - // started. -1 means the current series have not started. - // In the case of consecutive failures, the time between two attempts for this address is - // controlled by connectPolicy. + // True if the next connect attempt is the first attempt ever, or the one right after a successful + // connection (i.e., transportReady() was called). If true, the next connect attempt will start + // from the first address and will reset back-off. @GuardedBy("lock") - private int headIndex = -1; + private boolean firstAttempt = true; @GuardedBy("lock") private final Stopwatch backoffWatch; @@ -176,6 +175,9 @@ final class TransportSet { Preconditions.checkState(reconnectTask == null || reconnectTask.isDone(), "previous reconnectTask is not done"); + if (firstAttempt) { + nextAddressIndex = 0; + } final int currentAddressIndex = nextAddressIndex; List<SocketAddress> addrs = addressGroup.getAddresses(); final SocketAddress address = addrs.get(currentAddressIndex); @@ -192,7 +194,7 @@ final class TransportSet { boolean savedShutdown; synchronized (lock) { savedShutdown = shutdown; - if (currentAddressIndex == headIndex) { + if (currentAddressIndex == 0) { backoffWatch.reset().start(); } newActiveTransport = transportFactory.newClientTransport(address, authority); @@ -224,19 +226,18 @@ final class TransportSet { } }; - long delayMillis; - if (currentAddressIndex == headIndex) { - // Back to the first attempted address. Calculate back-off delay. - delayMillis = - reconnectPolicy.nextBackoffMillis() - backoffWatch.elapsed(TimeUnit.MILLISECONDS); - } else { - delayMillis = 0; - if (headIndex == -1) { + long delayMillis = 0; + if (currentAddressIndex == 0) { + if (firstAttempt) { // First connect attempt, or the first attempt since last successful connection. - headIndex = currentAddressIndex; reconnectPolicy = backoffPolicyProvider.get(); + } else { + // Back to the first address. Calculate back-off delay. + delayMillis = + reconnectPolicy.nextBackoffMillis() - backoffWatch.elapsed(TimeUnit.MILLISECONDS); } } + firstAttempt = false; if (delayMillis <= 0) { reconnectTask = null; // No back-off this time. @@ -333,7 +334,7 @@ final class TransportSet { super.transportReady(); synchronized (lock) { if (isAttachedToActiveTransport()) { - headIndex = -1; + firstAttempt = true; } } loadBalancer.handleTransportReady(addressGroup); diff --git a/core/src/test/java/io/grpc/internal/ManagedChannelImplTransportManagerTest.java b/core/src/test/java/io/grpc/internal/ManagedChannelImplTransportManagerTest.java index 27605559e..45f1a391b 100644 --- a/core/src/test/java/io/grpc/internal/ManagedChannelImplTransportManagerTest.java +++ b/core/src/test/java/io/grpc/internal/ManagedChannelImplTransportManagerTest.java @@ -248,7 +248,7 @@ public class ManagedChannelImplTransportManagerTest { // Second pick fails. This is the beginning of a series of failures. ClientTransport t2 = tm.getTransport(addressGroup); assertNotNull(t2); - verify(mockTransportFactory, times(++transportsAddr2)).newClientTransport(addr2, authority); + verify(mockTransportFactory, times(++transportsAddr1)).newClientTransport(addr1, authority); // Back-off policy was reset. verify(mockBackoffPolicyProvider, times(++backoffReset)).get(); transports.poll().listener.transportShutdown(Status.UNAVAILABLE); @@ -256,15 +256,15 @@ public class ManagedChannelImplTransportManagerTest { // Third pick fails too ClientTransport t3 = tm.getTransport(addressGroup); assertNotNull(t3); - verify(mockTransportFactory, times(++transportsAddr1)).newClientTransport(addr1, authority); + verify(mockTransportFactory, times(++transportsAddr2)).newClientTransport(addr2, authority); // Back-off policy was not reset. verify(mockBackoffPolicyProvider, times(backoffReset)).get(); transports.poll().listener.transportShutdown(Status.UNAVAILABLE); - // Forth pick is on addr2, back-off policy kicks in. + // Forth pick is on the first address, back-off policy kicks in. ClientTransport t4 = tm.getTransport(addressGroup); assertNotNull(t4); - verify(mockTransportFactory, times(++transportsAddr2)).newClientTransport(addr2, authority); + verify(mockTransportFactory, times(++transportsAddr1)).newClientTransport(addr1, authority); // Back-off policy was not reset, but was consulted. verify(mockBackoffPolicyProvider, times(backoffReset)).get(); verify(mockBackoffPolicy, times(++backoffConsulted)).nextBackoffMillis(); diff --git a/core/src/test/java/io/grpc/internal/TransportSetTest.java b/core/src/test/java/io/grpc/internal/TransportSetTest.java index a7ed5f9c5..702a84b45 100644 --- a/core/src/test/java/io/grpc/internal/TransportSetTest.java +++ b/core/src/test/java/io/grpc/internal/TransportSetTest.java @@ -176,82 +176,52 @@ public class TransportSetTest { transportSet.obtainActiveTransport(); verify(mockBackoffPolicyProvider, times(++backoffReset)).get(); verify(mockTransportFactory, times(++transportsAddr1)).newClientTransport(addr1, authority); - // Let this one through - transports.peek().listener.transportReady(); - // Then shut it down - transports.poll().listener.transportShutdown(Status.UNAVAILABLE); - - - ////// Now start a series of failing attempts, where addr2 is the head. - // First attempt after a connection closed. Reset back-off policy. - transportSet.obtainActiveTransport(); - verify(mockBackoffPolicyProvider, times(++backoffReset)).get(); - verify(mockTransportFactory, times(++transportsAddr2)).newClientTransport(addr2, authority); - // Fail this one + // Let this one fail without success transports.poll().listener.transportShutdown(Status.UNAVAILABLE); // Second attempt will start immediately. Keep back-off policy. transportSet.obtainActiveTransport(); verify(mockBackoffPolicyProvider, times(backoffReset)).get(); - verify(mockTransportFactory, times(++transportsAddr1)).newClientTransport(addr1, authority); + verify(mockTransportFactory, times(++transportsAddr2)).newClientTransport(addr2, authority); // Fail this one too transports.poll().listener.transportShutdown(Status.UNAVAILABLE); - // Third attempt is on head, thus controlled by the first back-off interval. + // Third attempt is the first address, thus controlled by the first back-off interval. transportSet.obtainActiveTransport(); - verify(mockBackoffPolicy2, times(++backoff2Consulted)).nextBackoffMillis(); + verify(mockBackoffPolicy1, times(++backoff1Consulted)).nextBackoffMillis(); verify(mockBackoffPolicyProvider, times(backoffReset)).get(); fakeClock.forwardMillis(9); - verify(mockTransportFactory, times(transportsAddr2)).newClientTransport(addr2, authority); + verify(mockTransportFactory, times(transportsAddr1)).newClientTransport(addr1, authority); fakeClock.forwardMillis(1); - verify(mockTransportFactory, times(++transportsAddr2)).newClientTransport(addr2, authority); + verify(mockTransportFactory, times(++transportsAddr1)).newClientTransport(addr1, authority); // Fail this one too transports.poll().listener.transportShutdown(Status.UNAVAILABLE); // Forth attempt will start immediately. Keep back-off policy. transportSet.obtainActiveTransport(); verify(mockBackoffPolicyProvider, times(backoffReset)).get(); - verify(mockTransportFactory, times(++transportsAddr1)).newClientTransport(addr1, authority); + verify(mockTransportFactory, times(++transportsAddr2)).newClientTransport(addr2, authority); // Fail this one too transports.poll().listener.transportShutdown(Status.UNAVAILABLE); - // Fifth attempt is on head, thus controlled by the second back-off interval. + // Fifth attempt for the first address, thus controlled by the second back-off interval. transportSet.obtainActiveTransport(); - verify(mockBackoffPolicy2, times(++backoff2Consulted)).nextBackoffMillis(); + verify(mockBackoffPolicy1, times(++backoff1Consulted)).nextBackoffMillis(); verify(mockBackoffPolicyProvider, times(backoffReset)).get(); fakeClock.forwardMillis(99); - verify(mockTransportFactory, times(transportsAddr2)).newClientTransport(addr2, authority); + verify(mockTransportFactory, times(transportsAddr1)).newClientTransport(addr1, authority); fakeClock.forwardMillis(1); - verify(mockTransportFactory, times(++transportsAddr2)).newClientTransport(addr2, authority); + verify(mockTransportFactory, times(++transportsAddr1)).newClientTransport(addr1, authority); // Let it through transports.peek().listener.transportReady(); // Then close it. transports.poll().listener.transportShutdown(Status.UNAVAILABLE); - - ////// Now start a series of failing attempts, where addr1 is the head. - // First attempt after a connection closed. Reset back-off policy. + // First attempt after a successful connection. Reset back-off policy, and start from the first + // address. transportSet.obtainActiveTransport(); verify(mockBackoffPolicyProvider, times(++backoffReset)).get(); verify(mockTransportFactory, times(++transportsAddr1)).newClientTransport(addr1, authority); - // Fail this one - transports.poll().listener.transportShutdown(Status.UNAVAILABLE); - - // Second attempt will start immediately. Keep back-off policy. - transportSet.obtainActiveTransport(); - verify(mockBackoffPolicyProvider, times(backoffReset)).get(); - verify(mockTransportFactory, times(++transportsAddr2)).newClientTransport(addr2, authority); - // Fail this one too - transports.poll().listener.transportShutdown(Status.UNAVAILABLE); - - // Third attempt is on head, thus controlled by the first back-off interval. - transportSet.obtainActiveTransport(); - verify(mockBackoffPolicy3, times(++backoff3Consulted)).nextBackoffMillis(); - verify(mockBackoffPolicyProvider, times(backoffReset)).get(); - fakeClock.forwardMillis(9); - verify(mockTransportFactory, times(transportsAddr1)).newClientTransport(addr1, authority); - fakeClock.forwardMillis(1); - verify(mockTransportFactory, times(++transportsAddr1)).newClientTransport(addr1, authority); // Final checks on invocations on back-off policies verify(mockBackoffPolicy1, times(backoff1Consulted)).nextBackoffMillis();

['core/src/test/java/io/grpc/internal/TransportSetTest.java', 'core/src/test/java/io/grpc/internal/ManagedChannelImplTransportManagerTest.java', 'core/src/main/java/io/grpc/internal/TransportSet.java']

{'.java': 3}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/1602/1546

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/1546

https://github.com/grpc/grpc-java/pull/1602

https://github.com/grpc/grpc-java/pull/1602

resolves

If DNS resolution fails, the Channel is permanently failed

We should probably update DnsNameResolver to continue retrying the DNS query until shutdown, at maybe a fixed rate of 1 minute or such. Overall, it's not a superb solution, but it fixes a lot of the problem and is expedient to implement.

575df76a8fa9a5c15213e49c3abb3de021239ace

2d15af53c7a9129b53c6ac6ac510d38f23276117

https://github.com/grpc/grpc-java/compare/575df76a8fa9a5c15213e49c3abb3de021239ace...2d15af53c7a9129b53c6ac6ac510d38f23276117

diff --git a/core/src/main/java/io/grpc/DnsNameResolver.java b/core/src/main/java/io/grpc/DnsNameResolver.java index ce787ebbe..ae5fa0457 100644 --- a/core/src/main/java/io/grpc/DnsNameResolver.java +++ b/core/src/main/java/io/grpc/DnsNameResolver.java @@ -31,16 +31,21 @@ package io.grpc; +import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Preconditions; -import io.grpc.internal.GrpcUtil; import io.grpc.internal.SharedResourceHolder; +import io.grpc.internal.SharedResourceHolder.Resource; import java.net.InetAddress; import java.net.InetSocketAddress; import java.net.URI; +import java.net.UnknownHostException; import java.util.ArrayList; import java.util.concurrent.ExecutorService; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.ScheduledFuture; +import java.util.concurrent.TimeUnit; import javax.annotation.Nullable; import javax.annotation.concurrent.GuardedBy; @@ -50,21 +55,33 @@ import javax.annotation.concurrent.GuardedBy; * * @see DnsNameResolverFactory */ -final class DnsNameResolver extends NameResolver { +class DnsNameResolver extends NameResolver { private final String authority; private final String host; private final int port; + private final Resource<ScheduledExecutorService> timerServiceResource; + private final Resource<ExecutorService> executorResource; + @GuardedBy("this") + private boolean shutdown; + @GuardedBy("this") + private ScheduledExecutorService timerService; @GuardedBy("this") private ExecutorService executor; @GuardedBy("this") + private ScheduledFuture<?> resolutionTask; + @GuardedBy("this") private boolean resolving; @GuardedBy("this") private Listener listener; - DnsNameResolver(@Nullable String nsAuthority, String name, Attributes params) { + DnsNameResolver(@Nullable String nsAuthority, String name, Attributes params, + Resource<ScheduledExecutorService> timerServiceResource, + Resource<ExecutorService> executorResource) { // TODO: if a DNS server is provided as nsAuthority, use it. // https://www.captechconsulting.com/blogs/accessing-the-dusty-corners-of-dns-with-java + this.timerServiceResource = timerServiceResource; + this.executorResource = executorResource; // Must prepend a "//" to the name when constructing a URI, otherwise it will be treated as an // opaque URI, thus the authority and host of the resulted URI would be null. URI nameUri = URI.create("//" + name); @@ -85,39 +102,55 @@ final class DnsNameResolver extends NameResolver { } @Override - public String getServiceAuthority() { + public final String getServiceAuthority() { return authority; } @Override - public synchronized void start(Listener listener) { - Preconditions.checkState(executor == null, "already started"); - executor = SharedResourceHolder.get(GrpcUtil.SHARED_CHANNEL_EXECUTOR); - this.listener = listener; + public final synchronized void start(Listener listener) { + Preconditions.checkState(this.listener == null, "already started"); + timerService = SharedResourceHolder.get(timerServiceResource); + executor = SharedResourceHolder.get(executorResource); + this.listener = Preconditions.checkNotNull(listener, "listener"); resolve(); } @Override - public synchronized void refresh() { - Preconditions.checkState(executor != null, "not started"); + public final synchronized void refresh() { + Preconditions.checkState(listener != null, "not started"); resolve(); } - @GuardedBy("this") - private void resolve() { - if (resolving) { - return; - } - resolving = true; - final Listener savedListener = Preconditions.checkNotNull(listener); - executor.execute(new Runnable() { + private final Runnable resolutionRunnable = new Runnable() { @Override public void run() { InetAddress[] inetAddrs; + Listener savedListener; + synchronized (DnsNameResolver.this) { + // If this task is started by refresh(), there might already be a scheduled task. + if (resolutionTask != null) { + resolutionTask.cancel(false); + resolutionTask = null; + } + if (shutdown) { + return; + } + savedListener = listener; + resolving = true; + } try { try { - inetAddrs = InetAddress.getAllByName(host); - } catch (Exception e) { + inetAddrs = getAllByName(host); + } catch (UnknownHostException e) { + synchronized (DnsNameResolver.this) { + if (shutdown) { + return; + } + // Because timerService is the single-threaded GrpcUtil.TIMER_SERVICE in production, + // we need to delegate the blocking work to the executor + resolutionTask = timerService.schedule(resolutionRunnableOnExecutor, + 1, TimeUnit.MINUTES); + } savedListener.onError(Status.UNAVAILABLE.withCause(e)); return; } @@ -135,17 +168,51 @@ final class DnsNameResolver extends NameResolver { } } } - }); + }; + + private final Runnable resolutionRunnableOnExecutor = new Runnable() { + @Override + public void run() { + synchronized (DnsNameResolver.this) { + if (!shutdown) { + executor.execute(resolutionRunnable); + } + } + } + }; + + // To be mocked out in tests + @VisibleForTesting + InetAddress[] getAllByName(String host) throws UnknownHostException { + return InetAddress.getAllByName(host); + } + + @GuardedBy("this") + private void resolve() { + if (resolving || shutdown) { + return; + } + executor.execute(resolutionRunnable); } @Override - public synchronized void shutdown() { + public final synchronized void shutdown() { + if (shutdown) { + return; + } + shutdown = true; + if (resolutionTask != null) { + resolutionTask.cancel(false); + } + if (timerService != null) { + timerService = SharedResourceHolder.release(timerServiceResource, timerService); + } if (executor != null) { - executor = SharedResourceHolder.release(GrpcUtil.SHARED_CHANNEL_EXECUTOR, executor); + executor = SharedResourceHolder.release(executorResource, executor); } } - int getPort() { + final int getPort() { return port; } } diff --git a/core/src/main/java/io/grpc/DnsNameResolverFactory.java b/core/src/main/java/io/grpc/DnsNameResolverFactory.java index 39c2238fc..6ee236d09 100644 --- a/core/src/main/java/io/grpc/DnsNameResolverFactory.java +++ b/core/src/main/java/io/grpc/DnsNameResolverFactory.java @@ -33,6 +33,8 @@ package io.grpc; import com.google.common.base.Preconditions; +import io.grpc.internal.GrpcUtil; + import java.net.URI; /** @@ -63,7 +65,8 @@ public final class DnsNameResolverFactory extends NameResolver.Factory { Preconditions.checkArgument(targetPath.startsWith("/"), "the path component (%s) of the target (%s) must start with '/'", targetPath, targetUri); String name = targetPath.substring(1); - return new DnsNameResolver(targetUri.getAuthority(), name, params); + return new DnsNameResolver(targetUri.getAuthority(), name, params, GrpcUtil.TIMER_SERVICE, + GrpcUtil.SHARED_CHANNEL_EXECUTOR); } else { return null; } diff --git a/core/src/main/java/io/grpc/internal/GrpcUtil.java b/core/src/main/java/io/grpc/internal/GrpcUtil.java index f604a87e4..0ed5d4e11 100644 --- a/core/src/main/java/io/grpc/internal/GrpcUtil.java +++ b/core/src/main/java/io/grpc/internal/GrpcUtil.java @@ -385,7 +385,7 @@ public final class GrpcUtil { }; /** - * Shared executor for managing channel timers. + * Shared single-threaded executor for managing channel timers. */ public static final Resource<ScheduledExecutorService> TIMER_SERVICE = new Resource<ScheduledExecutorService>() { diff --git a/core/src/test/java/io/grpc/DnsNameResolverTest.java b/core/src/test/java/io/grpc/DnsNameResolverTest.java index e034a6d01..92fad2b14 100644 --- a/core/src/test/java/io/grpc/DnsNameResolverTest.java +++ b/core/src/test/java/io/grpc/DnsNameResolverTest.java @@ -33,24 +33,82 @@ package io.grpc; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertSame; import static org.junit.Assert.fail; +import static org.mockito.Matchers.any; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.verifyNoMoreInteractions; +import io.grpc.internal.FakeClock; +import io.grpc.internal.SharedResourceHolder.Resource; + +import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; import org.junit.runners.JUnit4; +import org.mockito.ArgumentCaptor; +import org.mockito.Captor; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; +import java.net.InetAddress; +import java.net.InetSocketAddress; import java.net.URI; +import java.net.UnknownHostException; +import java.util.LinkedList; +import java.util.List; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.TimeUnit; /** Unit tests for {@link DnsNameResolver}. */ @RunWith(JUnit4.class) public class DnsNameResolverTest { - - private DnsNameResolverFactory factory = DnsNameResolverFactory.getInstance(); - private static final int DEFAULT_PORT = 887; private static final Attributes NAME_RESOLVER_PARAMS = Attributes.newBuilder().set(NameResolver.Factory.PARAMS_DEFAULT_PORT, DEFAULT_PORT).build(); + private final DnsNameResolverFactory factory = DnsNameResolverFactory.getInstance(); + private final FakeClock fakeClock = new FakeClock(); + private final Resource<ScheduledExecutorService> fakeTimerService = + new Resource<ScheduledExecutorService>() { + @Override + public ScheduledExecutorService create() { + return fakeClock.scheduledExecutorService; + } + + @Override + public void close(ScheduledExecutorService instance) { + assertSame(fakeClock, instance); + } + }; + + private final Resource<ExecutorService> fakeExecutor = + new Resource<ExecutorService>() { + @Override + public ExecutorService create() { + return fakeClock.scheduledExecutorService; + } + + @Override + public void close(ExecutorService instance) { + assertSame(fakeClock, instance); + } + }; + + @Mock + private NameResolver.Listener mockListener; + @Captor + private ArgumentCaptor<List<ResolvedServerInfo>> resultCaptor; + @Captor + private ArgumentCaptor<Status> statusCaptor; + + @Before + public void setUp() { + MockitoAnnotations.initMocks(this); + } + @Test public void invalidDnsName() throws Exception { testInvalidUri(new URI("dns", null, "/[invalid]", null)); @@ -73,6 +131,116 @@ public class DnsNameResolverTest { "foo.googleapis.com:456", 456); } + @Test + public void resolve() throws Exception { + InetAddress[] answer1 = createAddressList(2); + InetAddress[] answer2 = createAddressList(1); + String name = "foo.googleapis.com"; + MockResolver resolver = new MockResolver(name, 81, answer1, answer2); + resolver.start(mockListener); + verify(mockListener).onUpdate(resultCaptor.capture(), any(Attributes.class)); + assertEquals(name, resolver.invocations.poll()); + assertAnswerMatches(answer1, 81, resultCaptor.getValue()); + assertEquals(0, fakeClock.numPendingTasks()); + + resolver.refresh(); + verify(mockListener, times(2)).onUpdate(resultCaptor.capture(), any(Attributes.class)); + assertEquals(name, resolver.invocations.poll()); + assertAnswerMatches(answer2, 81, resultCaptor.getValue()); + assertEquals(0, fakeClock.numPendingTasks()); + + resolver.shutdown(); + } + + @Test + public void retry() throws Exception { + String name = "foo.googleapis.com"; + UnknownHostException error = new UnknownHostException(name); + InetAddress[] answer = createAddressList(2); + MockResolver resolver = new MockResolver(name, 81, error, error, answer); + resolver.start(mockListener); + verify(mockListener).onError(statusCaptor.capture()); + assertEquals(name, resolver.invocations.poll()); + Status status = statusCaptor.getValue(); + assertEquals(Status.Code.UNAVAILABLE, status.getCode()); + assertSame(error, status.getCause()); + + // First retry scheduled + assertEquals(1, fakeClock.numPendingTasks()); + fakeClock.forwardMillis(TimeUnit.MINUTES.toMillis(1) - 1); + assertEquals(1, fakeClock.numPendingTasks()); + + // First retry + fakeClock.forwardMillis(1); + verify(mockListener, times(2)).onError(statusCaptor.capture()); + assertEquals(name, resolver.invocations.poll()); + status = statusCaptor.getValue(); + assertEquals(Status.Code.UNAVAILABLE, status.getCode()); + assertSame(error, status.getCause()); + + // Second retry scheduled + assertEquals(1, fakeClock.numPendingTasks()); + fakeClock.forwardMillis(TimeUnit.MINUTES.toMillis(1) - 1); + assertEquals(1, fakeClock.numPendingTasks()); + + // Second retry + fakeClock.forwardMillis(1); + assertEquals(0, fakeClock.numPendingTasks()); + verify(mockListener).onUpdate(resultCaptor.capture(), any(Attributes.class)); + assertEquals(name, resolver.invocations.poll()); + assertAnswerMatches(answer, 81, resultCaptor.getValue()); + + verifyNoMoreInteractions(mockListener); + } + + @Test + public void refreshCancelsScheduledRetry() throws Exception { + String name = "foo.googleapis.com"; + UnknownHostException error = new UnknownHostException(name); + InetAddress[] answer = createAddressList(2); + MockResolver resolver = new MockResolver(name, 81, error, answer); + resolver.start(mockListener); + verify(mockListener).onError(statusCaptor.capture()); + assertEquals(name, resolver.invocations.poll()); + Status status = statusCaptor.getValue(); + assertEquals(Status.Code.UNAVAILABLE, status.getCode()); + assertSame(error, status.getCause()); + + // First retry scheduled + assertEquals(1, fakeClock.numPendingTasks()); + + resolver.refresh(); + // Refresh cancelled the retry + assertEquals(0, fakeClock.numPendingTasks()); + verify(mockListener).onUpdate(resultCaptor.capture(), any(Attributes.class)); + assertEquals(name, resolver.invocations.poll()); + assertAnswerMatches(answer, 81, resultCaptor.getValue()); + + verifyNoMoreInteractions(mockListener); + } + + @Test + public void shutdownCancelsScheduledRetry() throws Exception { + String name = "foo.googleapis.com"; + UnknownHostException error = new UnknownHostException(name); + MockResolver resolver = new MockResolver(name, 81, error); + resolver.start(mockListener); + verify(mockListener).onError(statusCaptor.capture()); + assertEquals(name, resolver.invocations.poll()); + Status status = statusCaptor.getValue(); + assertEquals(Status.Code.UNAVAILABLE, status.getCode()); + assertSame(error, status.getCause()); + + // Retry scheduled + assertEquals(1, fakeClock.numPendingTasks()); + + // Shutdown cancelled the retry + resolver.shutdown(); + assertEquals(0, fakeClock.numPendingTasks()); + + verifyNoMoreInteractions(mockListener); + } + private void testInvalidUri(URI uri) { try { factory.newNameResolver(uri, NAME_RESOLVER_PARAMS); @@ -88,4 +256,48 @@ public class DnsNameResolverTest { assertEquals(expectedPort, resolver.getPort()); assertEquals(exportedAuthority, resolver.getServiceAuthority()); } + + private byte lastByte = 0; + + private InetAddress[] createAddressList(int n) throws UnknownHostException { + InetAddress[] list = new InetAddress[n]; + for (int i = 0; i < n; i++) { + list[i] = InetAddress.getByAddress(new byte[] {127, 0, 0, ++lastByte}); + } + return list; + } + + private static void assertAnswerMatches(InetAddress[] addrs, int port, + List<ResolvedServerInfo> result) { + assertEquals(addrs.length, result.size()); + for (int i = 0; i < addrs.length; i++) { + InetSocketAddress socketAddr = (InetSocketAddress) result.get(i).getAddress(); + assertEquals("Addr " + i, port, socketAddr.getPort()); + assertEquals("Addr " + i, addrs[i], socketAddr.getAddress()); + } + } + + private class MockResolver extends DnsNameResolver { + final LinkedList<Object> answers = new LinkedList<Object>(); + final LinkedList<String> invocations = new LinkedList<String>(); + + MockResolver(String name, int defaultPort, Object ... answers) { + super(null, name, Attributes.newBuilder().set( + NameResolver.Factory.PARAMS_DEFAULT_PORT, defaultPort).build(), fakeTimerService, + fakeExecutor); + for (Object answer : answers) { + this.answers.add(answer); + } + } + + @Override + InetAddress[] getAllByName(String host) throws UnknownHostException { + invocations.add(host); + Object answer = answers.poll(); + if (answer instanceof UnknownHostException) { + throw (UnknownHostException) answer; + } + return (InetAddress[]) answer; + } + } } diff --git a/core/src/test/java/io/grpc/internal/FakeClock.java b/core/src/test/java/io/grpc/internal/FakeClock.java index 9f5f8cc40..d0db8f29e 100644 --- a/core/src/test/java/io/grpc/internal/FakeClock.java +++ b/core/src/test/java/io/grpc/internal/FakeClock.java @@ -47,9 +47,9 @@ import java.util.concurrent.TimeUnit; /** * A manipulated clock that exports a {@link Ticker} and a {@link ScheduledExecutorService}. */ -final class FakeClock { +public final class FakeClock { - final ScheduledExecutorService scheduledExecutorService = new ScheduledExecutorImpl(); + public final ScheduledExecutorService scheduledExecutorService = new ScheduledExecutorImpl(); final Ticker ticker = new Ticker() { @Override public long read() { return TimeUnit.MILLISECONDS.toNanos(currentTimeNanos); @@ -183,12 +183,16 @@ final class FakeClock { } } - void forwardTime(long value, TimeUnit unit) { + public void forwardTime(long value, TimeUnit unit) { currentTimeNanos += unit.toNanos(value); runDueTasks(); } - void forwardMillis(long millis) { + public void forwardMillis(long millis) { forwardTime(millis, TimeUnit.MILLISECONDS); } + + public int numPendingTasks() { + return tasks.size(); + } }

['core/src/main/java/io/grpc/DnsNameResolverFactory.java', 'core/src/main/java/io/grpc/internal/GrpcUtil.java', 'core/src/main/java/io/grpc/DnsNameResolver.java', 'core/src/test/java/io/grpc/DnsNameResolverTest.java', 'core/src/test/java/io/grpc/internal/FakeClock.java']

{'.java': 5}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/2258/2246

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/2246

https://github.com/grpc/grpc-java/pull/2258

https://github.com/grpc/grpc-java/pull/2258

resolves

Deadlock with TransportSet

Hello, I was testing Grpc with RoundRobinLB and a custom NameResolver when this deadlock happened: > Found one Java-level deadlock: > > "grpc-timer-0": > waiting to lock monitor 0x00007fa1b00062c8 (object 0x00000007397d7f88, a java.lang.Object), > which is held by "main" > "main": > waiting to lock monitor 0x00007fa1800087f8 (object 0x00000007397d7e00, a java.lang.Object), > which is held by "grpc-timer-0" > > "grpc-timer-0": > at io.grpc.internal.DelayedClientTransport.hasPendingStreams(DelayedClientTransport.java:284) > - waiting to lock <0x00000007397d7f88> (a java.lang.Object) > at io.grpc.internal.TransportSet$1EndOfCurrentBackoff.run(TransportSet.java:246) > - locked <0x00000007397d7e00> (a java.lang.Object) > at io.grpc.internal.LogExceptionRunnable.run(LogExceptionRunnable.java:56) > at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:511) > at java.util.concurrent.FutureTask.run(FutureTask.java:266) > at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.access$201(ScheduledThreadPoolExecutor.java:180) > at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:293) > at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142) > at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617) > at java.lang.Thread.run(Thread.java:745) > > "main": > at io.grpc.internal.InUseStateAggregator.updateObjectInUse(InUseStateAggregator.java:50) > - waiting to lock <0x00000007397d7e00> (a java.lang.Object) > at io.grpc.internal.TransportSet$BaseTransportListener.transportInUse(TransportSet.java:357) > at io.grpc.internal.DelayedClientTransport.newStream(DelayedClientTransport.java:128) > - locked <0x00000007397d7f88> (a java.lang.Object) > at io.grpc.internal.ClientCallImpl.start(ClientCallImpl.java:214) > at io.grpc.stub.ClientCalls.startCall(ClientCalls.java:273) > at io.grpc.stub.ClientCalls.asyncUnaryRequestCall(ClientCalls.java:252) > at io.grpc.stub.ClientCalls.futureUnaryCall(ClientCalls.java:189) > at io.grpc.stub.ClientCalls.blockingUnaryCall(ClientCalls.java:135) > at [...]remote.TestGrpc$TestBlockingStub.sayHello(TestGrpc.java:156) I don't know if it may relate to my own code or if the issue is on grpc side.

8b745d9114fe11b0b9c65b67006a8ad0b7a11325

3d4ae360746c7f95b42a685d1254e69d0f0061f4

https://github.com/grpc/grpc-java/compare/8b745d9114fe11b0b9c65b67006a8ad0b7a11325...3d4ae360746c7f95b42a685d1254e69d0f0061f4

diff --git a/core/src/main/java/io/grpc/internal/TransportSet.java b/core/src/main/java/io/grpc/internal/TransportSet.java index 025b83276..d89a8ac49 100644 --- a/core/src/main/java/io/grpc/internal/TransportSet.java +++ b/core/src/main/java/io/grpc/internal/TransportSet.java @@ -249,9 +249,14 @@ final class TransportSet implements WithLogId { delayedTransport.endBackoff(); boolean shutdownDelayedTransport = false; Runnable runnable = null; + // TransportSet as a channel layer class should not call into transport methods while + // holding the lock, thus we call hasPendingStreams() outside of the lock. It will cause + // a _benign_ race where the TransportSet may transition to CONNECTING when there is not + // pending stream. + boolean hasPendingStreams = delayedTransport.hasPendingStreams(); synchronized (lock) { reconnectTask = null; - if (delayedTransport.hasPendingStreams()) { + if (hasPendingStreams) { // Transition directly to CONNECTING runnable = startNewTransport(delayedTransport); } else {

['core/src/main/java/io/grpc/internal/TransportSet.java']

{'.java': 1}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/1896/1883

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/1883

https://github.com/grpc/grpc-java/pull/1896

https://github.com/grpc/grpc-java/pull/1896

resolves

java.lang.IllegalArgumentException when try to use ipv6

I guess this is caused by the scopeId: ``` java.lang.IllegalArgumentException: cannot find a NameResolver for directaddress:////0:0:0:0:0:0:0:0%0:10005 (Malformed escape pair at index 33: directaddress:////0:0:0:0:0:0:0:0%0:10005) at io.grpc.internal.ManagedChannelImpl.getNameResolver(ManagedChannelImpl.java:238) at io.grpc.internal.ManagedChannelImpl.(ManagedChannelImpl.java:159) at io.grpc.internal.AbstractManagedChannelImplBuilder.build(AbstractManagedChannelImplBuilder.java:205) ```

d25b65bb53258fc033e58cbaab4013a329ff45ce

631a9d5fac0257416d3f74e53c9729989b8cd8b2

https://github.com/grpc/grpc-java/compare/d25b65bb53258fc033e58cbaab4013a329ff45ce...631a9d5fac0257416d3f74e53c9729989b8cd8b2

diff --git a/core/src/main/java/io/grpc/internal/AbstractManagedChannelImplBuilder.java b/core/src/main/java/io/grpc/internal/AbstractManagedChannelImplBuilder.java index d14b09f1c..4cb74e9b9 100644 --- a/core/src/main/java/io/grpc/internal/AbstractManagedChannelImplBuilder.java +++ b/core/src/main/java/io/grpc/internal/AbstractManagedChannelImplBuilder.java @@ -33,6 +33,7 @@ package io.grpc.internal; import static com.google.common.base.MoreObjects.firstNonNull; +import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Preconditions; import com.google.common.util.concurrent.MoreExecutors; @@ -49,6 +50,7 @@ import io.grpc.SimpleLoadBalancerFactory; import java.net.SocketAddress; import java.net.URI; +import java.net.URISyntaxException; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; @@ -98,8 +100,23 @@ public abstract class AbstractManagedChannelImplBuilder this.directServerAddress = null; } + /** + * Returns a target string for the SocketAddress. It is only used as a placeholder, because + * DirectAddressNameResolverFactory will not actually try to use it. However, it must be a valid + * URI. + */ + @VisibleForTesting + static String makeTargetStringForDirectAddress(SocketAddress address) { + try { + return new URI(DIRECT_ADDRESS_SCHEME, "", "/" + address, null).toString(); + } catch (URISyntaxException e) { + // It should not happen. + throw new RuntimeException(e); + } + } + protected AbstractManagedChannelImplBuilder(SocketAddress directServerAddress, String authority) { - this.target = DIRECT_ADDRESS_SCHEME + ":///" + directServerAddress; + this.target = makeTargetStringForDirectAddress(directServerAddress); this.directServerAddress = directServerAddress; this.nameResolverFactory = new DirectAddressNameResolverFactory(directServerAddress, authority); } diff --git a/core/src/main/java/io/grpc/internal/ManagedChannelImpl.java b/core/src/main/java/io/grpc/internal/ManagedChannelImpl.java index d0c70192f..ff448d638 100644 --- a/core/src/main/java/io/grpc/internal/ManagedChannelImpl.java +++ b/core/src/main/java/io/grpc/internal/ManagedChannelImpl.java @@ -229,7 +229,7 @@ public final class ManagedChannelImpl extends ManagedChannel implements WithLogI // It doesn't look like a URI target. Maybe it's an authority string. Try with the default // scheme from the factory. try { - targetUri = new URI(nameResolverFactory.getDefaultScheme(), null, "/" + target, null); + targetUri = new URI(nameResolverFactory.getDefaultScheme(), "", "/" + target, null); } catch (URISyntaxException e) { // Should not be possible. throw new IllegalArgumentException(e); diff --git a/core/src/test/java/io/grpc/internal/ManagedChannelImplGetNameResolverTest.java b/core/src/test/java/io/grpc/internal/ManagedChannelImplGetNameResolverTest.java index dbbf078f6..13342593f 100644 --- a/core/src/test/java/io/grpc/internal/ManagedChannelImplGetNameResolverTest.java +++ b/core/src/test/java/io/grpc/internal/ManagedChannelImplGetNameResolverTest.java @@ -58,34 +58,38 @@ public class ManagedChannelImplGetNameResolverTest { @Test public void validTargetWithInvalidDnsName() throws Exception { - testValidTarget("[valid]", new URI("defaultscheme", null, "/[valid]", null)); + testValidTarget("[valid]", "defaultscheme:///%5Bvalid%5D", + new URI("defaultscheme", "", "/[valid]", null)); } @Test public void validAuthorityTarget() throws Exception { - testValidTarget("foo.googleapis.com:8080", - new URI("defaultscheme", null, "/foo.googleapis.com:8080", null)); + testValidTarget("foo.googleapis.com:8080", "defaultscheme:///foo.googleapis.com:8080", + new URI("defaultscheme", "", "/foo.googleapis.com:8080", null)); } @Test public void validUriTarget() throws Exception { - testValidTarget("scheme:///foo.googleapis.com:8080", - new URI("scheme", null, "/foo.googleapis.com:8080", null)); + testValidTarget("scheme:///foo.googleapis.com:8080", "scheme:///foo.googleapis.com:8080", + new URI("scheme", "", "/foo.googleapis.com:8080", null)); } @Test public void validIpv4AuthorityTarget() throws Exception { - testValidTarget("127.0.0.1:1234", new URI("defaultscheme", null, "/127.0.0.1:1234", null)); + testValidTarget("127.0.0.1:1234", "defaultscheme:///127.0.0.1:1234", + new URI("defaultscheme", "", "/127.0.0.1:1234", null)); } @Test public void validIpv4UriTarget() throws Exception { - testValidTarget("dns:///127.0.0.1:1234", new URI("dns", null, "/127.0.0.1:1234", null)); + testValidTarget("dns:///127.0.0.1:1234", "dns:///127.0.0.1:1234", + new URI("dns", "", "/127.0.0.1:1234", null)); } @Test public void validIpv6AuthorityTarget() throws Exception { - testValidTarget("[::1]:1234", new URI("defaultscheme", null, "/[::1]:1234", null)); + testValidTarget("[::1]:1234", "defaultscheme:///%5B::1%5D:1234", + new URI("defaultscheme", "", "/[::1]:1234", null)); } @Test @@ -95,7 +99,14 @@ public class ManagedChannelImplGetNameResolverTest { @Test public void validIpv6UriTarget() throws Exception { - testValidTarget("dns:///%5B::1%5D:1234", new URI("dns", null, "/[::1]:1234", null)); + testValidTarget("dns:///%5B::1%5D:1234", "dns:///%5B::1%5D:1234", + new URI("dns", "", "/[::1]:1234", null)); + } + + @Test + public void validTargetStartingWithSlash() throws Exception { + testValidTarget("/target", "defaultscheme:////target", + new URI("defaultscheme", "", "//target", null)); } @Test @@ -120,12 +131,13 @@ public class ManagedChannelImplGetNameResolverTest { } } - private void testValidTarget(String target, URI expectedUri) { + private void testValidTarget(String target, String expectedUriString, URI expectedUri) { Factory nameResolverFactory = new FakeNameResolverFactory(expectedUri.getScheme()); FakeNameResolver nameResolver = (FakeNameResolver) ManagedChannelImpl.getNameResolver( target, nameResolverFactory, NAME_RESOLVER_PARAMS); assertNotNull(nameResolver); assertEquals(expectedUri, nameResolver.uri); + assertEquals(expectedUriString, nameResolver.uri.toString()); } private void testInvalidTarget(String target) {

['core/src/main/java/io/grpc/internal/ManagedChannelImpl.java', 'core/src/main/java/io/grpc/internal/AbstractManagedChannelImplBuilder.java', 'core/src/test/java/io/grpc/internal/ManagedChannelImplGetNameResolverTest.java']

{'.java': 3}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/1979/1652

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/1652

https://github.com/grpc/grpc-java/pull/1979

https://github.com/grpc/grpc-java/pull/1979

fixes

Exceptions thrown in StreamObserver.onNext() may be swallowed

For unary calls it appears the exception is basically guaranteed to be swallowed. See #1638 for some discussion. Basically we try to fail the call with a Status, but if the call already completed successfully (which is especially likely for unary calls) the exception is thrown away.

6c59770a5bd54857290dfb0496fe0b81fc79bd57

46f418da9408bc6e9d5172ea3a7c467b30c6b358

https://github.com/grpc/grpc-java/compare/6c59770a5bd54857290dfb0496fe0b81fc79bd57...46f418da9408bc6e9d5172ea3a7c467b30c6b358

diff --git a/core/src/main/java/io/grpc/internal/ClientCallImpl.java b/core/src/main/java/io/grpc/internal/ClientCallImpl.java index 366d0f7b3..baa117507 100644 --- a/core/src/main/java/io/grpc/internal/ClientCallImpl.java +++ b/core/src/main/java/io/grpc/internal/ClientCallImpl.java @@ -414,8 +414,10 @@ final class ClientCallImpl<ReqT, RespT> extends ClientCall<ReqT, RespT> observer.onHeaders(headers); } catch (Throwable t) { - stream.cancel(Status.CANCELLED.withCause(t).withDescription("Failed to read headers")); - return; + Status status = + Status.CANCELLED.withCause(t).withDescription("Failed to read headers"); + stream.cancel(status); + close(status, new Metadata()); } } }); @@ -437,13 +439,28 @@ final class ClientCallImpl<ReqT, RespT> extends ClientCall<ReqT, RespT> message.close(); } } catch (Throwable t) { - stream.cancel(Status.CANCELLED.withCause(t).withDescription("Failed to read message.")); - return; + Status status = + Status.CANCELLED.withCause(t).withDescription("Failed to read message."); + stream.cancel(status); + close(status, new Metadata()); } } }); } + /** + * Must be called from application thread. + */ + private void close(Status status, Metadata trailers) { + closed = true; + cancelListenersShouldBeRemoved = true; + try { + observer.onClose(status, trailers); + } finally { + removeContextListenerAndCancelDeadlineFuture(); + } + } + @Override public void closed(Status status, Metadata trailers) { Deadline deadline = effectiveDeadline(); @@ -462,13 +479,11 @@ final class ClientCallImpl<ReqT, RespT> extends ClientCall<ReqT, RespT> callExecutor.execute(new ContextRunnable(context) { @Override public final void runInContext() { - try { - closed = true; - cancelListenersShouldBeRemoved = true; - observer.onClose(savedStatus, savedTrailers); - } finally { - removeContextListenerAndCancelDeadlineFuture(); + if (closed) { + // We intentionally don't keep the status or metadata from the server. + return; } + close(savedStatus, savedTrailers); } }); } @@ -478,7 +493,14 @@ final class ClientCallImpl<ReqT, RespT> extends ClientCall<ReqT, RespT> callExecutor.execute(new ContextRunnable(context) { @Override public final void runInContext() { - observer.onReady(); + try { + observer.onReady(); + } catch (Throwable t) { + Status status = + Status.CANCELLED.withCause(t).withDescription("Failed to call onReady."); + stream.cancel(status); + close(status, new Metadata()); + } } }); } diff --git a/core/src/test/java/io/grpc/internal/ClientCallImplTest.java b/core/src/test/java/io/grpc/internal/ClientCallImplTest.java index 8a73fb0b7..ed0773082 100644 --- a/core/src/test/java/io/grpc/internal/ClientCallImplTest.java +++ b/core/src/test/java/io/grpc/internal/ClientCallImplTest.java @@ -43,6 +43,7 @@ import static org.junit.Assert.fail; import static org.mockito.Matchers.any; import static org.mockito.Matchers.eq; import static org.mockito.Matchers.same; +import static org.mockito.Mockito.doThrow; import static org.mockito.Mockito.never; import static org.mockito.Mockito.timeout; import static org.mockito.Mockito.times; @@ -75,6 +76,7 @@ import org.junit.runner.RunWith; import org.junit.runners.JUnit4; import org.mockito.ArgumentCaptor; import org.mockito.Captor; +import org.mockito.Matchers; import org.mockito.Mock; import org.mockito.MockitoAnnotations; @@ -82,8 +84,11 @@ import java.io.ByteArrayInputStream; import java.io.IOException; import java.io.InputStream; import java.util.Set; +import java.util.concurrent.BlockingQueue; import java.util.concurrent.CountDownLatch; +import java.util.concurrent.Executor; import java.util.concurrent.Executors; +import java.util.concurrent.LinkedBlockingQueue; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.TimeUnit; import java.util.concurrent.atomic.AtomicBoolean; @@ -146,6 +151,103 @@ public class ClientCallImplTest { Context.ROOT.attach(); } + @Test + public void exceptionInOnMessageTakesPrecedenceOverServer() { + DelayedExecutor executor = new DelayedExecutor(); + ClientCallImpl<Void, Void> call = new ClientCallImpl<Void, Void>( + method, + executor, + CallOptions.DEFAULT, + provider, + deadlineCancellationExecutor); + call.start(callListener, new Metadata()); + verify(stream).start(listenerArgumentCaptor.capture()); + final ClientStreamListener streamListener = listenerArgumentCaptor.getValue(); + streamListener.headersRead(new Metadata()); + + RuntimeException failure = new RuntimeException("bad"); + doThrow(failure).when(callListener).onMessage(any(Void.class)); + + /* + * In unary calls, the server closes the call right after responding, so the onClose call is + * queued to run. When messageRead is called, an exception will occur and attempt to cancel the + * stream. However, since the server closed it "first" the second exception is lost leading to + * the call being counted as successful. + */ + streamListener.messageRead(new ByteArrayInputStream(new byte[]{})); + streamListener.closed(Status.OK, new Metadata()); + executor.release(); + + verify(callListener).onClose(statusArgumentCaptor.capture(), Matchers.isA(Metadata.class)); + assertThat(statusArgumentCaptor.getValue().getCode()).isEqualTo(Status.Code.CANCELLED); + assertThat(statusArgumentCaptor.getValue().getCause()).isSameAs(failure); + verify(stream).cancel(statusArgumentCaptor.getValue()); + } + + @Test + public void exceptionInOnHeadersTakesPrecedenceOverServer() { + DelayedExecutor executor = new DelayedExecutor(); + ClientCallImpl<Void, Void> call = new ClientCallImpl<Void, Void>( + method, + executor, + CallOptions.DEFAULT, + provider, + deadlineCancellationExecutor); + call.start(callListener, new Metadata()); + verify(stream).start(listenerArgumentCaptor.capture()); + final ClientStreamListener streamListener = listenerArgumentCaptor.getValue(); + + RuntimeException failure = new RuntimeException("bad"); + doThrow(failure).when(callListener).onHeaders(any(Metadata.class)); + + /* + * In unary calls, the server closes the call right after responding, so the onClose call is + * queued to run. When headersRead is called, an exception will occur and attempt to cancel the + * stream. However, since the server closed it "first" the second exception is lost leading to + * the call being counted as successful. + */ + streamListener.headersRead(new Metadata()); + streamListener.closed(Status.OK, new Metadata()); + executor.release(); + + verify(callListener).onClose(statusArgumentCaptor.capture(), Matchers.isA(Metadata.class)); + assertThat(statusArgumentCaptor.getValue().getCode()).isEqualTo(Status.Code.CANCELLED); + assertThat(statusArgumentCaptor.getValue().getCause()).isSameAs(failure); + verify(stream).cancel(statusArgumentCaptor.getValue()); + } + + @Test + public void exceptionInOnReadyTakesPrecedenceOverServer() { + DelayedExecutor executor = new DelayedExecutor(); + ClientCallImpl<Void, Void> call = new ClientCallImpl<Void, Void>( + method, + executor, + CallOptions.DEFAULT, + provider, + deadlineCancellationExecutor); + call.start(callListener, new Metadata()); + verify(stream).start(listenerArgumentCaptor.capture()); + final ClientStreamListener streamListener = listenerArgumentCaptor.getValue(); + + RuntimeException failure = new RuntimeException("bad"); + doThrow(failure).when(callListener).onReady(); + + /* + * In unary calls, the server closes the call right after responding, so the onClose call is + * queued to run. When onReady is called, an exception will occur and attempt to cancel the + * stream. However, since the server closed it "first" the second exception is lost leading to + * the call being counted as successful. + */ + streamListener.onReady(); + streamListener.closed(Status.OK, new Metadata()); + executor.release(); + + verify(callListener).onClose(statusArgumentCaptor.capture(), Matchers.isA(Metadata.class)); + assertThat(statusArgumentCaptor.getValue().getCode()).isEqualTo(Status.Code.CANCELLED); + assertThat(statusArgumentCaptor.getValue().getCause()).isSameAs(failure); + verify(stream).cancel(statusArgumentCaptor.getValue()); + } + @Test public void advertisedEncodingsAreSent() { ClientCallImpl<Void, Void> call = new ClientCallImpl<Void, Void>( @@ -668,5 +770,19 @@ public class ClientCallImplTest { assertTrue("timeout: " + timeout + " ns", timeout >= from); } + private static final class DelayedExecutor implements Executor { + private final BlockingQueue<Runnable> commands = new LinkedBlockingQueue<Runnable>(); + + @Override + public void execute(Runnable command) { + commands.add(command); + } + + void release() { + while (!commands.isEmpty()) { + commands.poll().run(); + } + } + } }

['core/src/main/java/io/grpc/internal/ClientCallImpl.java', 'core/src/test/java/io/grpc/internal/ClientCallImplTest.java']

{'.java': 2}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/2025/1947

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/1947

https://github.com/grpc/grpc-java/pull/2025

https://github.com/grpc/grpc-java/pull/2025

fixes

ServerCallImpl's use of metadata in sendHeaders is thread-unsafe

`ServerCallImpl` uses metadata to determine compression settings in [sendHeaders](https://github.com/grpc/grpc-java/blob/a2076f4/core/src/main/java/io/grpc/internal/ServerCallImpl.java#L111). However, that `Metadata` has already been passed to the application which is free to modify it. The `acceptEncodings` should just be saved as a field during the constructor instead.

0d6a9de54c3ef7800b76405ecd9ff581c90f6c7a

0e47be12878fe1dfb0504ed43ec8f363fe9eb1ce

https://github.com/grpc/grpc-java/compare/0d6a9de54c3ef7800b76405ecd9ff581c90f6c7a...0e47be12878fe1dfb0504ed43ec8f363fe9eb1ce

diff --git a/core/src/main/java/io/grpc/internal/ServerCallImpl.java b/core/src/main/java/io/grpc/internal/ServerCallImpl.java index 6e0707b32..d2a4e9029 100644 --- a/core/src/main/java/io/grpc/internal/ServerCallImpl.java +++ b/core/src/main/java/io/grpc/internal/ServerCallImpl.java @@ -62,7 +62,7 @@ final class ServerCallImpl<ReqT, RespT> extends ServerCall<ReqT, RespT> { private final ServerStream stream; private final MethodDescriptor<ReqT, RespT> method; private final Context.CancellableContext context; - private Metadata inboundHeaders; + private final String messageAcceptEncoding; private final DecompressorRegistry decompressorRegistry; private final CompressorRegistry compressorRegistry; @@ -78,7 +78,7 @@ final class ServerCallImpl<ReqT, RespT> extends ServerCall<ReqT, RespT> { this.stream = stream; this.method = method; this.context = context; - this.inboundHeaders = inboundHeaders; + this.messageAcceptEncoding = inboundHeaders.get(MESSAGE_ACCEPT_ENCODING_KEY); this.decompressorRegistry = decompressorRegistry; this.compressorRegistry = compressorRegistry; @@ -108,9 +108,9 @@ final class ServerCallImpl<ReqT, RespT> extends ServerCall<ReqT, RespT> { if (compressor == null) { compressor = Codec.Identity.NONE; } else { - if (inboundHeaders.containsKey(MESSAGE_ACCEPT_ENCODING_KEY)) { - String acceptEncodings = inboundHeaders.get(MESSAGE_ACCEPT_ENCODING_KEY); - List<String> acceptedEncodingsList = ACCEPT_ENCODING_SPLITER.splitToList(acceptEncodings); + if (messageAcceptEncoding != null) { + List<String> acceptedEncodingsList = + ACCEPT_ENCODING_SPLITER.splitToList(messageAcceptEncoding); if (!acceptedEncodingsList.contains(compressor.getMessageEncoding())) { // resort to using no compression. compressor = Codec.Identity.NONE; @@ -119,7 +119,6 @@ final class ServerCallImpl<ReqT, RespT> extends ServerCall<ReqT, RespT> { compressor = Codec.Identity.NONE; } } - inboundHeaders = null; // Always put compressor, even if it's identity. headers.put(MESSAGE_ENCODING_KEY, compressor.getMessageEncoding()); @@ -178,7 +177,6 @@ final class ServerCallImpl<ReqT, RespT> extends ServerCall<ReqT, RespT> { public void close(Status status, Metadata trailers) { checkState(!closeCalled, "call already closed"); closeCalled = true; - inboundHeaders = null; stream.close(status, trailers); }

['core/src/main/java/io/grpc/internal/ServerCallImpl.java']

{'.java': 1}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/2064/2036

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/2036

https://github.com/grpc/grpc-java/pull/2064

https://github.com/grpc/grpc-java/pull/2064

fixes

Metadata trailers are not passed to Status*Exception when using ClientCalls.blockingUnaryCall.

Trying to write a sample for #1295, but when calling unary rpc method on blocking stub, the trailers are not passed during `ClientCalls.getUnchecked` which is called from [ClientCalls.blockingUnaryCall](https://github.com/grpc/grpc-java/blob/master/stub/src/main/java/io/grpc/stub/ClientCalls.java#L141). Is this by design or bug ? Sample code is [here](https://github.com/chikei/grpc-java/commit/ea1ec3f5503a40d39c0ad10360c8a6ecbad46eca), the [blockingCall()](https://github.com/chikei/grpc-java/blob/ea1ec3f5503a40d39c0ad10360c8a6ecbad46eca/examples/src/main/java/io/grpc/examples/errorhandling/ErrorHandlingClient.java#L94) fails but others are good.

30c2b0eda023e05e431d7bc2cb977c958dab958e

26065c742d21bc10361aacce3c4e38e83bab579f

https://github.com/grpc/grpc-java/compare/30c2b0eda023e05e431d7bc2cb977c958dab958e...26065c742d21bc10361aacce3c4e38e83bab579f

diff --git a/stub/src/main/java/io/grpc/stub/ClientCalls.java b/stub/src/main/java/io/grpc/stub/ClientCalls.java index 529649763..b3cb880ac 100644 --- a/stub/src/main/java/io/grpc/stub/ClientCalls.java +++ b/stub/src/main/java/io/grpc/stub/ClientCalls.java @@ -31,6 +31,8 @@ package io.grpc.stub; +import static com.google.common.base.Preconditions.checkNotNull; + import com.google.common.base.Preconditions; import com.google.common.util.concurrent.AbstractFuture; import com.google.common.util.concurrent.ListenableFuture; @@ -38,9 +40,11 @@ import com.google.common.util.concurrent.ListenableFuture; import io.grpc.CallOptions; import io.grpc.Channel; import io.grpc.ClientCall; +import io.grpc.ExperimentalApi; import io.grpc.Metadata; import io.grpc.MethodDescriptor; import io.grpc.Status; +import io.grpc.StatusException; import io.grpc.StatusRuntimeException; import java.util.Iterator; @@ -205,8 +209,30 @@ public class ClientCalls { Thread.currentThread().interrupt(); throw Status.CANCELLED.withCause(e).asRuntimeException(); } catch (ExecutionException e) { - throw Status.fromThrowable(e).asRuntimeException(); + throw toStatusRuntimeException(e); + } + } + + /** + * Wraps the given {@link Throwable} in a {@link StatusRuntimeException}. If it contains an + * embedded {@link StatusException} or {@link StatusRuntimeException}, the returned exception will + * contain the embedded trailers and status, with the given exception as the cause. Otherwise, an + * exception will be generated from an {@link Status#UNKNOWN} status. + */ + private static StatusRuntimeException toStatusRuntimeException(Throwable t) { + Throwable cause = checkNotNull(t); + while (cause != null) { + // If we have an embedded status, use it and replace the cause + if (cause instanceof StatusException) { + StatusException se = (StatusException) cause; + return new StatusRuntimeException(se.getStatus().withCause(t), se.getTrailers()); + } else if (cause instanceof StatusRuntimeException) { + StatusRuntimeException se = (StatusRuntimeException) cause; + return new StatusRuntimeException(se.getStatus().withCause(t), se.getTrailers()); + } + cause = cause.getCause(); } + return Status.UNKNOWN.withCause(t).asRuntimeException(); } private static <ReqT, RespT> void asyncUnaryRequestCall( diff --git a/stub/src/test/java/io/grpc/stub/ClientCallsTest.java b/stub/src/test/java/io/grpc/stub/ClientCallsTest.java index 4547e9468..079a1d49a 100644 --- a/stub/src/test/java/io/grpc/stub/ClientCallsTest.java +++ b/stub/src/test/java/io/grpc/stub/ClientCallsTest.java @@ -36,6 +36,7 @@ import static org.junit.Assert.assertSame; import static org.junit.Assert.assertTrue; import static org.junit.Assert.fail; import static org.mockito.Matchers.any; +import static org.mockito.Mockito.doAnswer; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; @@ -44,6 +45,7 @@ import com.google.common.util.concurrent.SettableFuture; import io.grpc.CallOptions; import io.grpc.ClientCall; +import io.grpc.ClientCall.Listener; import io.grpc.ManagedChannel; import io.grpc.Metadata; import io.grpc.MethodDescriptor; @@ -51,6 +53,7 @@ import io.grpc.Server; import io.grpc.ServerServiceDefinition; import io.grpc.ServiceDescriptor; import io.grpc.Status; +import io.grpc.StatusRuntimeException; import io.grpc.inprocess.InProcessChannelBuilder; import io.grpc.inprocess.InProcessServerBuilder; import io.grpc.stub.ServerCalls.NoopStreamObserver; @@ -63,7 +66,10 @@ import org.junit.runner.RunWith; import org.junit.runners.JUnit4; import org.mockito.ArgumentCaptor; import org.mockito.Mock; +import org.mockito.Mockito; import org.mockito.MockitoAnnotations; +import org.mockito.invocation.InvocationOnMock; +import org.mockito.stubbing.Answer; import java.util.ArrayList; import java.util.Arrays; @@ -81,10 +87,11 @@ import java.util.concurrent.TimeUnit; @RunWith(JUnit4.class) public class ClientCallsTest { - static final MethodDescriptor<Integer, Integer> STREAMING_METHOD = MethodDescriptor.create( - MethodDescriptor.MethodType.BIDI_STREAMING, - "some/method", - new IntegerMarshaller(), new IntegerMarshaller()); + private static final MethodDescriptor<Integer, Integer> STREAMING_METHOD = MethodDescriptor + .create( + MethodDescriptor.MethodType.BIDI_STREAMING, + "some/method", + new IntegerMarshaller(), new IntegerMarshaller()); private Server server; private ManagedChannel channel; @@ -107,6 +114,53 @@ public class ClientCallsTest { } } + @Test + public void unaryBlockingCallSuccess() throws Exception { + Integer req = 2; + final String resp = "bar"; + final Status status = Status.OK; + final Metadata trailers = new Metadata(); + + doAnswer(new Answer<Void>() { + @Override + public Void answer(InvocationOnMock in) throws Throwable { + @SuppressWarnings("unchecked") + Listener<String> listener = (Listener<String>) in.getArguments()[0]; + listener.onMessage(resp); + listener.onClose(status, trailers); + return null; + } + }).when(call).start(Mockito.<Listener<String>>any(), any(Metadata.class)); + + String actualResponse = ClientCalls.blockingUnaryCall(call, req); + assertEquals(resp, actualResponse); + } + + @Test + public void unaryBlockingCallFailed() throws Exception { + Integer req = 2; + final Status status = Status.INTERNAL; + final Metadata trailers = new Metadata(); + + doAnswer(new Answer<Void>() { + @Override + public Void answer(InvocationOnMock in) throws Throwable { + @SuppressWarnings("unchecked") + Listener<String> listener = (Listener<String>) in.getArguments()[0]; + listener.onClose(status, trailers); + return null; + } + }).when(call).start(Mockito.<Listener<String>>any(), any(Metadata.class)); + + try { + ClientCalls.blockingUnaryCall(call, req); + fail("Should fail"); + } catch (StatusRuntimeException e) { + assertSame(status.getCode(), e.getStatus().getCode()); + assertSame(trailers, e.getTrailers()); + } + } + @Test public void unaryFutureCallSuccess() throws Exception { Integer req = 2; @@ -246,24 +300,24 @@ public class ClientCallsTest { ArgumentCaptor<ClientCall.Listener<String>> listenerCaptor = ArgumentCaptor.forClass(null); ClientResponseObserver<Integer, String> responseObserver = new ClientResponseObserver<Integer, String>() { - @Override - public void beforeStart(ClientCallStreamObserver<Integer> requestStream) { - requestStream.disableAutoInboundFlowControl(); - requestStream.request(5); - } + @Override + public void beforeStart(ClientCallStreamObserver<Integer> requestStream) { + requestStream.disableAutoInboundFlowControl(); + requestStream.request(5); + } - @Override - public void onNext(String value) { - } + @Override + public void onNext(String value) { + } - @Override - public void onError(Throwable t) { - } + @Override + public void onError(Throwable t) { + } - @Override - public void onCompleted() { - } - }; + @Override + public void onCompleted() { + } + }; ClientCalls.asyncServerStreamingCall(call, 1, responseObserver); verify(call).start(listenerCaptor.capture(), any(Metadata.class)); listenerCaptor.getValue().onMessage("message"); @@ -398,6 +452,7 @@ public class ClientCallsTest { public void beforeStart(final ClientCallStreamObserver<Integer> requestStream) { requestStream.setOnReadyHandler(new Runnable() { int iteration; + @Override public void run() { while (requestStream.isReady()) {

['stub/src/main/java/io/grpc/stub/ClientCalls.java', 'stub/src/test/java/io/grpc/stub/ClientCallsTest.java']

{'.java': 2}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/2154/2152

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/2152

https://github.com/grpc/grpc-java/pull/2154

https://github.com/grpc/grpc-java/pull/2154

resolves

Deadlock found in TransportSet

When running benchmarks where the client started up faster than the server, The first few calls failed as unavailable. Our internal deadlock detector seems to think there is a deadlock around here: ``` Deadlock(s) found: "grpc-client-net-1-32" daemon prio=5 Id=175 BLOCKED on java.lang.Object@7eeb2e6b owned by "grpc-client-app-5" Id=119 io.grpc.internal.DelayedClientTransport.startBackoff(DelayedClientTransport.java:323) io.grpc.internal.TransportSet.scheduleBackoff(TransportSet.java:235) io.grpc.internal.TransportSet.access$1500(TransportSet.java:61) io.grpc.internal.TransportSet$TransportListener.transportShutdown(TransportSet.java:440) io.grpc.netty.ClientTransportLifecycleManager.notifyShutdown(ClientTransportLifecycleManager.java:68) io.grpc.netty.ClientTransportLifecycleManager.notifyTerminated(ClientTransportLifecycleManager.java:84) io.grpc.netty.NettyClientTransport$4.operationComplete(NettyClientTransport.java:181) io.grpc.netty.NettyClientTransport$4.operationComplete(NettyClientTransport.java:175) io.netty.util.concurrent.DefaultPromise.notifyListener0(DefaultPromise.java:514) io.netty.util.concurrent.DefaultPromise.notifyListenersNow(DefaultPromise.java:488) io.netty.util.concurrent.DefaultPromise.notifyListeners(DefaultPromise.java:427) io.netty.util.concurrent.DefaultPromise.setFailure(DefaultPromise.java:120) io.netty.channel.DefaultChannelPromise.setFailure(DefaultChannelPromise.java:87) io.grpc.netty.ProtocolNegotiators$AbstractBufferingHandler.fail(ProtocolNegotiators.java:436) io.grpc.netty.ProtocolNegotiators$AbstractBufferingHandler.exceptionCaught(ProtocolNegotiators.java:376) io.netty.channel.AbstractChannelHandlerContext.invokeExceptionCaught(AbstractChannelHandlerContext.java:295) io.netty.channel.AbstractChannelHandlerContext.invokeExceptionCaught(AbstractChannelHandlerContext.java:274) io.netty.channel.AbstractChannelHandlerContext.fireExceptionCaught(AbstractChannelHandlerContext.java:266) io.grpc.netty.NettyClientTransport$3.operationComplete(NettyClientTransport.java:165) io.grpc.netty.NettyClientTransport$3.operationComplete(NettyClientTransport.java:156) io.netty.util.concurrent.DefaultPromise.notifyListener0(DefaultPromise.java:514) io.netty.util.concurrent.DefaultPromise.notifyListeners0(DefaultPromise.java:507) io.netty.util.concurrent.DefaultPromise.notifyListenersNow(DefaultPromise.java:486) io.netty.util.concurrent.DefaultPromise.notifyListeners(DefaultPromise.java:427) io.netty.util.concurrent.DefaultPromise.tryFailure(DefaultPromise.java:129) io.netty.channel.nio.AbstractNioChannel$AbstractNioUnsafe.fulfillConnectPromise(AbstractNioChannel.java:321) io.netty.channel.nio.AbstractNioChannel$AbstractNioUnsafe.finishConnect(AbstractNioChannel.java:337) io.netty.channel.nio.NioEventLoop.processSelectedKey(NioEventLoop.java:588) io.netty.channel.nio.NioEventLoop.processSelectedKeysOptimized(NioEventLoop.java:512) io.netty.channel.nio.NioEventLoop.processSelectedKeys(NioEventLoop.java:426) io.netty.channel.nio.NioEventLoop.run(NioEventLoop.java:398) io.netty.util.concurrent.SingleThreadEventExecutor$5.run(SingleThreadEventExecutor.java:877) io.netty.util.concurrent.DefaultThreadFactory$DefaultRunnableDecorator.run(DefaultThreadFactory.java:144) java.lang.Thread.run(Thread.java:745) "grpc-client-app-5" daemon prio=5 Id=119 BLOCKED on java.lang.Object@17902cf5 owned by "grpc-client-net-1-32" Id=175 io.grpc.internal.InUseStateAggregator.updateObjectInUse(InUseStateAggregator.java:51) io.grpc.internal.TransportSet$BaseTransportListener.transportInUse(TransportSet.java:345) io.grpc.internal.DelayedClientTransport.newStream(DelayedClientTransport.java:128) io.grpc.internal.DelayedClientTransport$PendingStream.createRealStream(DelayedClientTransport.java:382) io.grpc.internal.DelayedClientTransport$PendingStream.access$100(DelayedClientTransport.java:369) io.grpc.internal.DelayedClientTransport$2.run(DelayedClientTransport.java:261) java.util.concurrent.ForkJoinTask$RunnableExecuteAction.exec(ForkJoinTask.java:1402) java.util.concurrent.ForkJoinTask.doExec(ForkJoinTask.java:289) java.util.concurrent.ForkJoinPool$WorkQueue.runTask(ForkJoinPool.java:1056) java.util.concurrent.ForkJoinPool.runWorker(ForkJoinPool.java:1692) java.util.concurrent.ForkJoinWorkerThread.run(ForkJoinWorkerThread.java:157) ```

3879c6a8fa4b0ec25f211019ec26b0acee8976cb

7a33fae8e8cd4d36c4986b0644f13c8d8d2f2d6f

https://github.com/grpc/grpc-java/compare/3879c6a8fa4b0ec25f211019ec26b0acee8976cb...7a33fae8e8cd4d36c4986b0644f13c8d8d2f2d6f

diff --git a/core/src/main/java/io/grpc/internal/TransportSet.java b/core/src/main/java/io/grpc/internal/TransportSet.java index dc04c9497..025b83276 100644 --- a/core/src/main/java/io/grpc/internal/TransportSet.java +++ b/core/src/main/java/io/grpc/internal/TransportSet.java @@ -227,8 +227,10 @@ final class TransportSet implements WithLogId { * @param status the causal status when the channel begins transition to * TRANSIENT_FAILURE. */ + @CheckReturnValue @GuardedBy("lock") - private void scheduleBackoff(final DelayedClientTransport delayedTransport, Status status) { + private Runnable scheduleBackoff( + final DelayedClientTransport delayedTransport, final Status status) { Preconditions.checkState(reconnectTask == null, "previous reconnectTask is not done"); if (reconnectPolicy == null) { @@ -240,7 +242,6 @@ final class TransportSet implements WithLogId { log.log(Level.FINE, "[{0}] Scheduling backoff for {1} ms", new Object[]{getLogId(), delayMillis}); } - delayedTransport.startBackoff(status); class EndOfCurrentBackoff implements Runnable { @Override public void run() { @@ -281,6 +282,16 @@ final class TransportSet implements WithLogId { reconnectTask = scheduledExecutor.schedule( new LogExceptionRunnable(new EndOfCurrentBackoff()), delayMillis, TimeUnit.MILLISECONDS); + return new Runnable() { + @Override + public void run() { + // This must be run outside of lock. The TransportSet lock is a channel level lock. + // startBackoff() will acquire the delayed transport lock, which is a transport level + // lock. Our lock ordering mandates transport lock > channel lock. Otherwise a deadlock + // could happen (https://github.com/grpc/grpc-java/issues/2152). + delayedTransport.startBackoff(status); + } + }; } /** @@ -450,7 +461,7 @@ final class TransportSet implements WithLogId { allAddressesFailed = true; // Initiate backoff // Transition to TRANSIENT_FAILURE - scheduleBackoff(delayedTransport, s); + runnable = scheduleBackoff(delayedTransport, s); } else { // Still CONNECTING runnable = startNewTransport(delayedTransport);

['core/src/main/java/io/grpc/internal/TransportSet.java']

{'.java': 1}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/1260/1251

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/1251

https://github.com/grpc/grpc-java/pull/1260

https://github.com/grpc/grpc-java/pull/1260

fixes

Netty Server does not observe channelInactive

If the TCP connection goes down, gRPC isn't noticing because nothing is observing the `channelInactive()` notification on the channel pipeline. I confirmed that `channelInactive()` is called, but saw that an outstanding streaming RPC was not cancelled. This likely applies to both client-side and server-side; I only verified it broken on server-side.

8d0b5b0c4d40c5ee4dba7e74851c9eecc3bb400e

96f9cefda41bbbf1462bfe607864d451bc716219

https://github.com/grpc/grpc-java/compare/8d0b5b0c4d40c5ee4dba7e74851c9eecc3bb400e...96f9cefda41bbbf1462bfe607864d451bc716219

diff --git a/netty/src/main/java/io/grpc/netty/NettyServerHandler.java b/netty/src/main/java/io/grpc/netty/NettyServerHandler.java index e7d6ea2dd..06b5a3fb9 100644 --- a/netty/src/main/java/io/grpc/netty/NettyServerHandler.java +++ b/netty/src/main/java/io/grpc/netty/NettyServerHandler.java @@ -261,18 +261,21 @@ class NettyServerHandler extends AbstractNettyHandler { */ @Override public void channelInactive(ChannelHandlerContext ctx) throws Exception { - super.channelInactive(ctx); - // Any streams that are still active must be closed - connection().forEachActiveStream(new Http2StreamVisitor() { - @Override - public boolean visit(Http2Stream stream) throws Http2Exception { - NettyServerStream serverStream = serverStream(stream); - if (serverStream != null) { - serverStream.abortStream(GOAWAY_STATUS, false); + try { + // Any streams that are still active must be closed + connection().forEachActiveStream(new Http2StreamVisitor() { + @Override + public boolean visit(Http2Stream stream) throws Http2Exception { + NettyServerStream serverStream = serverStream(stream); + if (serverStream != null) { + serverStream.abortStream(GOAWAY_STATUS, false); + } + return true; } - return true; - } - }); + }); + } finally { + super.channelInactive(ctx); + } } WriteQueue getWriteQueue() { diff --git a/netty/src/test/java/io/grpc/netty/NettyServerHandlerTest.java b/netty/src/test/java/io/grpc/netty/NettyServerHandlerTest.java index 87078c2a4..52ec3fd40 100644 --- a/netty/src/test/java/io/grpc/netty/NettyServerHandlerTest.java +++ b/netty/src/test/java/io/grpc/netty/NettyServerHandlerTest.java @@ -237,6 +237,15 @@ public class NettyServerHandlerTest extends NettyHandlerTestBase<NettyServerHand assertFalse(channel().isOpen()); } + @Test + public void channelInactiveShouldCloseStreams() throws Exception { + createStream(); + handler().channelInactive(ctx()); + ArgumentCaptor<Status> captor = ArgumentCaptor.forClass(Status.class); + verify(streamListener).closed(captor.capture()); + assertFalse(captor.getValue().isOk()); + } + @Test public void shouldAdvertiseMaxConcurrentStreams() throws Exception { maxConcurrentStreams = 314;

['netty/src/test/java/io/grpc/netty/NettyServerHandlerTest.java', 'netty/src/main/java/io/grpc/netty/NettyServerHandler.java']

{'.java': 2}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/1262/1251

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/1251

https://github.com/grpc/grpc-java/pull/1262

https://github.com/grpc/grpc-java/pull/1262

fixes

Netty Server does not observe channelInactive

If the TCP connection goes down, gRPC isn't noticing because nothing is observing the `channelInactive()` notification on the channel pipeline. I confirmed that `channelInactive()` is called, but saw that an outstanding streaming RPC was not cancelled. This likely applies to both client-side and server-side; I only verified it broken on server-side.

999f408ff29b61d2bdd5cd723f614c70320adf16

3e0f44fb8c73e51927eb5e077fd69c8571f693ad

https://github.com/grpc/grpc-java/compare/999f408ff29b61d2bdd5cd723f614c70320adf16...3e0f44fb8c73e51927eb5e077fd69c8571f693ad

diff --git a/netty/src/main/java/io/grpc/netty/NettyServerHandler.java b/netty/src/main/java/io/grpc/netty/NettyServerHandler.java index 94f287629..7e53e731a 100644 --- a/netty/src/main/java/io/grpc/netty/NettyServerHandler.java +++ b/netty/src/main/java/io/grpc/netty/NettyServerHandler.java @@ -224,15 +224,18 @@ class NettyServerHandler extends Http2ConnectionHandler { */ @Override public void channelInactive(ChannelHandlerContext ctx) throws Exception { - super.channelInactive(ctx); - // Any streams that are still active must be closed - connection().forEachActiveStream(new Http2StreamVisitor() { - @Override - public boolean visit(Http2Stream stream) throws Http2Exception { - serverStream(stream).abortStream(GOAWAY_STATUS, false); - return true; - } - }); + try { + // Any streams that are still active must be closed + connection().forEachActiveStream(new Http2StreamVisitor() { + @Override + public boolean visit(Http2Stream stream) throws Http2Exception { + serverStream(stream).abortStream(GOAWAY_STATUS, false); + return true; + } + }); + } finally { + super.channelInactive(ctx); + } } WriteQueue getWriteQueue() { diff --git a/netty/src/test/java/io/grpc/netty/NettyServerHandlerTest.java b/netty/src/test/java/io/grpc/netty/NettyServerHandlerTest.java index 7293907ea..b3a99f228 100644 --- a/netty/src/test/java/io/grpc/netty/NettyServerHandlerTest.java +++ b/netty/src/test/java/io/grpc/netty/NettyServerHandlerTest.java @@ -249,6 +249,15 @@ public class NettyServerHandlerTest extends NettyHandlerTestBase<NettyServerHand assertFalse(channel().isOpen()); } + @Test + public void channelInactiveShouldCloseStreams() throws Exception { + createStream(); + handler().channelInactive(ctx()); + ArgumentCaptor<Status> captor = ArgumentCaptor.forClass(Status.class); + verify(streamListener).closed(captor.capture()); + assertFalse(captor.getValue().isOk()); + } + @Test public void shouldAdvertiseMaxConcurrentStreams() throws Exception { maxConcurrentStreams = 314;

['netty/src/test/java/io/grpc/netty/NettyServerHandlerTest.java', 'netty/src/main/java/io/grpc/netty/NettyServerHandler.java']

{'.java': 2}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/364/359

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/359

https://github.com/grpc/grpc-java/pull/364

https://github.com/grpc/grpc-java/pull/364

resolves

Http2ClientStream overwrites error message

[Http2ClientStream.transportHeadersReceived()](https://github.com/grpc/grpc-java/blob/d0aad72441f2f110910003599bb923db6f671f02/core/src/main/java/io/grpc/transport/Http2ClientStream.java#L102) is calling withDescription instead of augmentDescription. This hinders debugging what went wrong. @yang-g, since he is interested in when this is resolved.

41940f7ff7025ba703bf7d77f90fd376f825f75b

2b33598ec4b377a7cae8d55e8c020c1171d119a2

https://github.com/grpc/grpc-java/compare/41940f7ff7025ba703bf7d77f90fd376f825f75b...2b33598ec4b377a7cae8d55e8c020c1171d119a2

diff --git a/core/src/main/java/io/grpc/transport/Http2ClientStream.java b/core/src/main/java/io/grpc/transport/Http2ClientStream.java index badc7c0f2..85577cc8f 100644 --- a/core/src/main/java/io/grpc/transport/Http2ClientStream.java +++ b/core/src/main/java/io/grpc/transport/Http2ClientStream.java @@ -99,7 +99,7 @@ public abstract class Http2ClientStream extends AbstractClientStream<Integer> { if (transportError != null) { // Note we don't immediately report the transport error, instead we wait for more data on the // stream so we can accumulate more detail into the error before reporting it. - transportError = transportError.withDescription("\\n" + headers.toString()); + transportError = transportError.augmentDescription("\\n" + headers.toString()); errorCharset = extractCharset(headers); } else { stripTransportDetails(headers);

['core/src/main/java/io/grpc/transport/Http2ClientStream.java']

{'.java': 1}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/1112/1111

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/1111

https://github.com/grpc/grpc-java/pull/1112

https://github.com/grpc/grpc-java/pull/1112

fixes

transportShutdown() should be called before calling transportTerminated().

With the changes of TransportSet, transportShutdown() must be called before calling transportTerminated(). ``` 10-06 15:32:45.917 5126 5126 E AndroidRuntime: FATAL EXCEPTION: OkHttpClientTransport 10-06 15:32:45.917 5126 5126 E AndroidRuntime: Process: com.google.android.apps.fireball, PID: 5126 10-06 15:32:45.917 5126 5126 E AndroidRuntime: java.lang.IllegalStateException: Listener is still attached to activeTransportFuture. Seems transportTerminated was not called. 10-06 15:32:45.917 5126 5126 E AndroidRuntime: at com.google.common.base.Preconditions.checkState(Preconditions.java:173) 10-06 15:32:45.917 5126 5126 E AndroidRuntime: at io.grpc.internal.TransportSet$TransportListener.transportTerminated(TransportSet.java:249) 10-06 15:32:45.917 5126 5126 E AndroidRuntime: at io.grpc.okhttp.OkHttpClientTransport$ClientFrameHandler.run(OkHttpClientTransport.java:606) 10-06 15:32:45.917 5126 5126 E AndroidRuntime: at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1112) 10-06 15:32:45.917 5126 5126 E AndroidRuntime: at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:587) 10-06 15:32:45.917 5126 5126 E AndroidRuntime: at java.lang.Thread.run(Thread.java:818) 10-06 15:32:45.918 745 1319 W ActivityManager: Force finishing activity com.google.android.apps.fireball/.ui.photoviewer.FireballPhotoViewActivity ```

6474938fe7e9c9355a5fa1004f4cae39ad069797

72a0a38182bc7b1f32868cfc8c1fc3e2667a5f04

https://github.com/grpc/grpc-java/compare/6474938fe7e9c9355a5fa1004f4cae39ad069797...72a0a38182bc7b1f32868cfc8c1fc3e2667a5f04

diff --git a/core/src/main/java/io/grpc/internal/ClientTransport.java b/core/src/main/java/io/grpc/internal/ClientTransport.java index 8f287973c..c2c88e47b 100644 --- a/core/src/main/java/io/grpc/internal/ClientTransport.java +++ b/core/src/main/java/io/grpc/internal/ClientTransport.java @@ -114,6 +114,8 @@ public interface ClientTransport { /** * The transport completed shutting down. All resources have been released. + * + * <p> {@link #transportShutdown(Status)} must be called before calling this method. */ void transportTerminated(); diff --git a/okhttp/src/main/java/io/grpc/okhttp/OkHttpClientTransport.java b/okhttp/src/main/java/io/grpc/okhttp/OkHttpClientTransport.java index 1001f3eba..7779fb13b 100644 --- a/okhttp/src/main/java/io/grpc/okhttp/OkHttpClientTransport.java +++ b/okhttp/src/main/java/io/grpc/okhttp/OkHttpClientTransport.java @@ -144,9 +144,14 @@ class OkHttpClientTransport implements ClientTransport { private final int maxMessageSize; private int connectionUnacknowledgedBytesRead; private ClientFrameHandler clientFrameHandler; - // The status used to finish all active streams when the transport is closed. + // Indicates the transport is in go-away state: no new streams will be processed, + // but existing streams may continue. @GuardedBy("lock") private boolean goAway; + // Used to indicate the special phase while we are going to enter go-away state but before + // goAway is turned to true, see the comment at where this is set about why it is needed. + @GuardedBy("lock") + private boolean startedGoAway; @GuardedBy("lock") private Status goAwayStatus; @GuardedBy("lock") @@ -284,7 +289,7 @@ class OkHttpClientTransport implements ClientTransport { // Make sure nextStreamId greater than all used id, so that mayHaveCreatedStream() performs // correctly. nextStreamId = Integer.MAX_VALUE; - onGoAway(Integer.MAX_VALUE, Status.INTERNAL.withDescription("Stream ids exhausted")); + startGoAway(Integer.MAX_VALUE, Status.INTERNAL.withDescription("Stream ids exhausted")); } else { nextStreamId += 2; } @@ -449,7 +454,7 @@ class OkHttpClientTransport implements ClientTransport { // The GOAWAY is part of graceful shutdown. frameWriter.goAway(0, ErrorCode.NO_ERROR, new byte[0]); - onGoAway(Integer.MAX_VALUE, Status.UNAVAILABLE.withDescription("Transport stopped")); + startGoAway(Integer.MAX_VALUE, Status.UNAVAILABLE.withDescription("Transport stopped")); } /** @@ -477,8 +482,8 @@ class OkHttpClientTransport implements ClientTransport { * Finish all active streams due to an IOException, then close the transport. */ void onException(Throwable failureCause) { - log.log(Level.SEVERE, "Transport failed", failureCause); - onGoAway(0, Status.UNAVAILABLE.withCause(failureCause)); + log.log(Level.WARNING, "Transport failed", failureCause); + startGoAway(0, Status.UNAVAILABLE.withCause(failureCause)); } /** @@ -486,13 +491,24 @@ class OkHttpClientTransport implements ClientTransport { */ private void onError(ErrorCode errorCode, String moreDetail) { frameWriter.goAway(0, errorCode, new byte[0]); - onGoAway(0, toGrpcStatus(errorCode).augmentDescription(moreDetail)); + startGoAway(0, toGrpcStatus(errorCode).augmentDescription(moreDetail)); } - private void onGoAway(int lastKnownStreamId, Status status) { - boolean notifyShutdown; + private void startGoAway(int lastKnownStreamId, Status status) { + synchronized (lock) { + if (startedGoAway) { + // Another go-away is in progress, ignore this one. + return; + } + // We use startedGoAway here instead of goAway, because once the goAway becomes true, other + // thread in stopIfNecessary() may stop the transport and cause the + // listener.transportTerminated() be called before listener.transportShutdown(). + startedGoAway = true; + } + + listener.transportShutdown(status); + synchronized (lock) { - notifyShutdown = !goAway; goAway = true; goAwayStatus = status; Iterator<Map.Entry<Integer, OkHttpClientStream>> it = streams.entrySet().iterator(); @@ -510,12 +526,6 @@ class OkHttpClientTransport implements ClientTransport { pendingStreams.clear(); } - if (notifyShutdown) { - // TODO(madongfly): Another thread may called stopIfNecessary() and closed the socket, so that - // the reading thread calls listener.transportTerminated() and race with this call. - listener.transportShutdown(status); - } - stopIfNecessary(); } @@ -552,7 +562,7 @@ class OkHttpClientTransport implements ClientTransport { } /** - * When the transport is in goAway states, we should stop it once all active streams finish. + * When the transport is in goAway state, we should stop it once all active streams finish. */ void stopIfNecessary() { synchronized (lock) { @@ -624,6 +634,12 @@ class OkHttpClientTransport implements ClientTransport { // Read until the underlying socket closes. while (frameReader.nextFrame(this)) { } + // frameReader.nextFrame() returns false when the underlying read encounters an IOException, + // it may be triggered by the socket closing, in such case, the startGoAway() will do + // nothing, otherwise, we finish all streams since it's a real IO issue. + // We don't call onException() here since we don't want to log the warning in case this is + // triggered by socket closing. + startGoAway(0, Status.UNAVAILABLE); } catch (Exception t) { // TODO(madongfly): Send the exception message to the server. frameWriter.goAway(0, ErrorCode.PROTOCOL_ERROR, new byte[0]); @@ -770,7 +786,7 @@ class OkHttpClientTransport implements ClientTransport { // If a debug message was provided, use it. status.augmentDescription(debugData.utf8()); } - onGoAway(lastGoodStreamId, status); + startGoAway(lastGoodStreamId, status); } @Override diff --git a/okhttp/src/test/java/io/grpc/okhttp/OkHttpClientTransportTest.java b/okhttp/src/test/java/io/grpc/okhttp/OkHttpClientTransportTest.java index fbb19c684..ada890f68 100644 --- a/okhttp/src/test/java/io/grpc/okhttp/OkHttpClientTransportTest.java +++ b/okhttp/src/test/java/io/grpc/okhttp/OkHttpClientTransportTest.java @@ -234,6 +234,19 @@ public class OkHttpClientTransportTest { shutdownAndVerify(); } + @Test + public void nextFrameReturnFalse() throws Exception { + initTransport(); + MockStreamListener listener = new MockStreamListener(); + clientTransport.newStream(method, new Metadata(), listener).request(1); + frameReader.nextFrameAtEndOfStream(); + listener.waitUntilStreamClosed(); + assertEquals(Status.UNAVAILABLE.getCode(), listener.status.getCode()); + verify(transportListener, timeout(TIME_OUT_MS)).transportShutdown(isA(Status.class)); + verify(transportListener, timeout(TIME_OUT_MS)).transportTerminated(); + shutdownAndVerify(); + } + @Test public void readMessages() throws Exception { initTransport();

['core/src/main/java/io/grpc/internal/ClientTransport.java', 'okhttp/src/main/java/io/grpc/okhttp/OkHttpClientTransport.java', 'okhttp/src/test/java/io/grpc/okhttp/OkHttpClientTransportTest.java']

{'.java': 3}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/692/687

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/687

https://github.com/grpc/grpc-java/pull/692

https://github.com/grpc/grpc-java/pull/692

fixes

Fix UNKNOWN status without description

https://github.com/grpc/grpc-java/blob/d2b1b37ed7ba0087fd8a2920549118191ce22f95/core/src/main/java/io/grpc/ChannelImpl.java#L311 https://github.com/grpc/grpc-java/blob/3e26b993ce90901b32faa1b8b855abfdc2153bc6/netty/src/main/java/io/grpc/transport/netty/NettyClientHandler.java#L212 We should basically always provide a description, so that users have a hope of distinguishing whether an error is local or remote. The NettyClientHandler should be converting the HTTP/2 error code to a status.

384a80593d42cf3a4045e21b6a61fa601a81bbb1

248f575a59ec39be9e30f0b21984bea07dc8e775

https://github.com/grpc/grpc-java/compare/384a80593d42cf3a4045e21b6a61fa601a81bbb1...248f575a59ec39be9e30f0b21984bea07dc8e775

diff --git a/core/src/main/java/io/grpc/ChannelImpl.java b/core/src/main/java/io/grpc/ChannelImpl.java index 4e4acebb7..c50950d1a 100644 --- a/core/src/main/java/io/grpc/ChannelImpl.java +++ b/core/src/main/java/io/grpc/ChannelImpl.java @@ -308,7 +308,7 @@ public final class ChannelImpl extends Channel { activeTransport = null; } // TODO(notcarl): replace this with something more meaningful - transportShutdown(Status.UNKNOWN); + transportShutdown(Status.UNKNOWN.withDescription("transport shutdown for unknown reason")); transports.remove(transport); if (shutdown && transports.isEmpty()) { if (terminated) { diff --git a/netty/src/main/java/io/grpc/transport/netty/NettyClientHandler.java b/netty/src/main/java/io/grpc/transport/netty/NettyClientHandler.java index 7e73a392d..1f169179d 100644 --- a/netty/src/main/java/io/grpc/transport/netty/NettyClientHandler.java +++ b/netty/src/main/java/io/grpc/transport/netty/NettyClientHandler.java @@ -205,11 +205,10 @@ class NettyClientHandler extends Http2ConnectionHandler { /** * Handler for an inbound HTTP/2 RST_STREAM frame, terminating a stream. */ - private void onRstStreamRead(int streamId) - throws Http2Exception { - // TODO(nmittler): do something with errorCode? + private void onRstStreamRead(int streamId, long errorCode) throws Http2Exception { NettyClientStream stream = clientStream(requireHttp2Stream(streamId)); - stream.transportReportStatus(Status.UNKNOWN, false, new Metadata.Trailers()); + Status status = HttpUtil.Http2Error.statusForCode((int) errorCode); + stream.transportReportStatus(status, false, new Metadata.Trailers()); } @Override @@ -524,7 +523,7 @@ class NettyClientHandler extends Http2ConnectionHandler { @Override public void onRstStreamRead(ChannelHandlerContext ctx, int streamId, long errorCode) throws Http2Exception { - handler.onRstStreamRead(streamId); + handler.onRstStreamRead(streamId, errorCode); } @Override public void onPingAckRead(ChannelHandlerContext ctx, ByteBuf data)

['core/src/main/java/io/grpc/ChannelImpl.java', 'netty/src/main/java/io/grpc/transport/netty/NettyClientHandler.java']

{'.java': 2}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/1027/694

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/694

https://github.com/grpc/grpc-java/pull/1027

https://github.com/grpc/grpc-java/pull/1027

fixes

Double-closure of call during interop tests

I find it in the stderr of the test report of Netty, Netty local channel, and OkHttp. I see it printed out to my console once, so I think that may be from the InProcess test. This exception very likely means we have a bug and are double-closing. ``` java.lang.IllegalStateException: call already closed at com.google.common.base.Preconditions.checkState(Preconditions.java:173) at io.grpc.ServerImpl$ServerCallImpl.close(ServerImpl.java:507) at io.grpc.ForwardingServerCall.close(ForwardingServerCall.java:65) at io.grpc.testing.TestUtils$1$1.close(TestUtils.java:109) at io.grpc.stub.ServerCalls$ResponseObserver.onError(ServerCalls.java:237) at io.grpc.testing.integration.TestServiceImpl$ResponseDispatcher.dispatchChunk(TestServiceImpl.java:277) at io.grpc.testing.integration.TestServiceImpl$ResponseDispatcher.access$000(TestServiceImpl.java:207) at io.grpc.testing.integration.TestServiceImpl$ResponseDispatcher$1.run(TestServiceImpl.java:219) at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:511) at java.util.concurrent.FutureTask.run(FutureTask.java:266) at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.access$201(ScheduledThreadPoolExecutor.java:180) at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:293) at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142) at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617) at java.lang.Thread.run(Thread.java:745) ```

efa774b846ac493886509cd51f71db4554e92993

47ad6f81bfee08aefec15f6b42bef9e0d2c66863

https://github.com/grpc/grpc-java/compare/efa774b846ac493886509cd51f71db4554e92993...47ad6f81bfee08aefec15f6b42bef9e0d2c66863

diff --git a/interop-testing/src/main/java/io/grpc/testing/integration/TestServiceImpl.java b/interop-testing/src/main/java/io/grpc/testing/integration/TestServiceImpl.java index b3de8b624..d73aee095 100644 --- a/interop-testing/src/main/java/io/grpc/testing/integration/TestServiceImpl.java +++ b/interop-testing/src/main/java/io/grpc/testing/integration/TestServiceImpl.java @@ -35,6 +35,7 @@ import com.google.common.collect.Queues; import com.google.protobuf.ByteString; import com.google.protobuf.EmptyProtos; +import io.grpc.Status; import io.grpc.stub.StreamObserver; import io.grpc.testing.integration.Messages.PayloadType; import io.grpc.testing.integration.Messages.ResponseParameters; @@ -205,10 +206,11 @@ public class TestServiceImpl implements TestServiceGrpc.TestService { * available, the stream is half-closed. */ private class ResponseDispatcher { + private final Chunk completionChunk = new Chunk(0, 0, 0, false); private final Queue<Chunk> chunks; private final StreamObserver<StreamingOutputCallResponse> responseStream; - private volatile boolean isInputComplete; private boolean scheduled; + private Throwable failure; private Runnable dispatchTask = new Runnable() { @Override public void run() { @@ -247,6 +249,7 @@ public class TestServiceImpl implements TestServiceGrpc.TestService { * needed. */ public synchronized ResponseDispatcher enqueue(Queue<Chunk> moreChunks) { + assertNotFailed(); chunks.addAll(moreChunks); scheduleNextChunk(); return this; @@ -257,7 +260,8 @@ public class TestServiceImpl implements TestServiceGrpc.TestService { * remain to be scheduled for dispatch to the client. */ public ResponseDispatcher completeInput() { - isInputComplete = true; + assertNotFailed(); + chunks.add(completionChunk); scheduleNextChunk(); return this; } @@ -266,15 +270,24 @@ public class TestServiceImpl implements TestServiceGrpc.TestService { * Dispatches the current response chunk to the client. This is only called by the executor. At * any time, a given dispatch task should only be registered with the executor once. */ - private void dispatchChunk() { + private synchronized void dispatchChunk() { try { - // Pop off the next chunk and send it to the client. Chunk chunk = chunks.remove(); - responseStream.onNext(chunk.toResponse()); - + if (chunk == completionChunk) { + responseStream.onCompleted(); + } else { + responseStream.onNext(chunk.toResponse()); + } } catch (Throwable e) { - responseStream.onError(e); + failure = e; + if (Status.fromThrowable(e).getCode() == Status.CANCELLED.getCode()) { + // Stream was cancelled by client, responseStream.onError() might be called already or + // will be called soon by inbounding StreamObserver. + chunks.clear(); + } else { + responseStream.onError(e); + } } } @@ -297,14 +310,12 @@ public class TestServiceImpl implements TestServiceGrpc.TestService { return; } } + } - if (isInputComplete) { - // All of the response chunks have been enqueued but there is no chunks left. Close the - // stream. - responseStream.onCompleted(); + private void assertNotFailed() { + if (failure != null) { + throw new IllegalStateException("Stream already failed", failure); } - - // Otherwise, the input is not yet complete - wait for more chunks to arrive. } } diff --git a/stub/src/main/java/io/grpc/stub/ServerCalls.java b/stub/src/main/java/io/grpc/stub/ServerCalls.java index 9cf44508a..dc2a46044 100644 --- a/stub/src/main/java/io/grpc/stub/ServerCalls.java +++ b/stub/src/main/java/io/grpc/stub/ServerCalls.java @@ -202,10 +202,10 @@ public class ServerCalls { @Override public void onCancel() { + responseObserver.cancelled = true; if (!halfClosed) { requestObserver.onError(Status.CANCELLED.asException()); } - responseObserver.cancelled = true; } }; }

['interop-testing/src/main/java/io/grpc/testing/integration/TestServiceImpl.java', 'stub/src/main/java/io/grpc/stub/ServerCalls.java']

{'.java': 2}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/247/246

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/246

https://github.com/grpc/grpc-java/pull/247

https://github.com/grpc/grpc-java/pull/247

resolves

ClientAuthInterceptor synchronizes on wrong object

The "this" in synchronized (this), is not the correct object to synchronize on: https://github.com/grpc/grpc-java/blob/master/auth/src/main/java/io/grpc/auth/ClientAuthInterceptor.java#L77 It should be ClientAuthInterceptor.this instead. As the code stands, there is no synchronization between threads so you can see NullPointerExceptions as lastMetadata is set but not cached.

e515c772cd81cc4ee1b6f24c1c36afbaac1c2ebb

b48b4db3fb3577ed21da8f05e3c0428a991e3eed

https://github.com/grpc/grpc-java/compare/e515c772cd81cc4ee1b6f24c1c36afbaac1c2ebb...b48b4db3fb3577ed21da8f05e3c0428a991e3eed

diff --git a/auth/src/main/java/io/grpc/auth/ClientAuthInterceptor.java b/auth/src/main/java/io/grpc/auth/ClientAuthInterceptor.java index 17c3aaec5..3351aa715 100644 --- a/auth/src/main/java/io/grpc/auth/ClientAuthInterceptor.java +++ b/auth/src/main/java/io/grpc/auth/ClientAuthInterceptor.java @@ -74,7 +74,8 @@ public class ClientAuthInterceptor implements ClientInterceptor { @Override public void start(Listener<RespT> responseListener, Metadata.Headers headers) { try { - synchronized (this) { + Metadata.Headers cachedSaved; + synchronized (ClientAuthInterceptor.this) { // TODO(lryan): This is icky but the current auth library stores the same // metadata map until the next refresh cycle. This will be fixed once // https://github.com/google/google-auth-library-java/issues/3 @@ -83,8 +84,9 @@ public class ClientAuthInterceptor implements ClientInterceptor { lastMetadata = credentials.getRequestMetadata(); cached = toHeaders(lastMetadata); } + cachedSaved = cached; } - headers.merge(cached); + headers.merge(cachedSaved); super.start(responseListener, headers); } catch (IOException ioe) { responseListener.onClose(Status.fromThrowable(ioe), new Metadata.Trailers()); @@ -105,4 +107,4 @@ public class ClientAuthInterceptor implements ClientInterceptor { } return headers; } -} \\ No newline at end of file +}

['auth/src/main/java/io/grpc/auth/ClientAuthInterceptor.java']

{'.java': 1}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/249/239

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/239

https://github.com/grpc/grpc-java/pull/249

https://github.com/grpc/grpc-java/pull/249

resolves

Lacking preconditions for start() in ChannelImpl.CallImpl

For instance, calling request() before start() has been called results in a NullPointerException.

191dcd38ac8a5bb3e6ce4238d673200d6ff6f097

966e1200986c007666a7a4a74bbcb9c0a28742e9

https://github.com/grpc/grpc-java/compare/191dcd38ac8a5bb3e6ce4238d673200d6ff6f097...966e1200986c007666a7a4a74bbcb9c0a28742e9

diff --git a/core/src/main/java/io/grpc/ChannelImpl.java b/core/src/main/java/io/grpc/ChannelImpl.java index 033de038a..8baf9824f 100644 --- a/core/src/main/java/io/grpc/ChannelImpl.java +++ b/core/src/main/java/io/grpc/ChannelImpl.java @@ -265,6 +265,7 @@ public final class ChannelImpl implements Channel { @Override public void request(int numMessages) { + Preconditions.checkState(stream != null, "Not started"); stream.request(numMessages); }

['core/src/main/java/io/grpc/ChannelImpl.java']

{'.java': 1}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/250/238

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/238

https://github.com/grpc/grpc-java/pull/250

https://github.com/grpc/grpc-java/pull/250

resolves

Race in Server handler initialization

When initializing an incoming client connection, [we call startAsync()](https://github.com/grpc/grpc-java/blob/master/netty/src/main/java/io/grpc/transport/netty/NettyServer.java#L84) on the transport, which [registers the handler](https://github.com/grpc/grpc-java/blob/master/netty/src/main/java/io/grpc/transport/netty/NettyServerTransport.java#L108) on a separate thread. This is obviously a race, and it would have probably been fixed if I had finished Service removal in #35. Symptom: ``` DEBUG i.n.channel.DefaultChannelPipeline - Discarded inbound message SimpleLeakAwareByteBuf(PooledUnsafeDirectByteBuf(ridx: 0, widx: 259, cap: 1024)) that reached at the tail of the pipeline. Please check your pipeline configuration. ``` The quickest fix would be to call awaitRunning() from initChannel(). That reduces the rate new connections can connect, but is probably the most expedient solution, until #35 is finished. @nmittler, thoughts?

966e1200986c007666a7a4a74bbcb9c0a28742e9

9bd31daee673adfd3877bb2a6e1635e665231e9e

https://github.com/grpc/grpc-java/compare/966e1200986c007666a7a4a74bbcb9c0a28742e9...9bd31daee673adfd3877bb2a6e1635e665231e9e

diff --git a/netty/src/main/java/io/grpc/transport/netty/NettyServer.java b/netty/src/main/java/io/grpc/transport/netty/NettyServer.java index a96dce64b..c2c252789 100644 --- a/netty/src/main/java/io/grpc/transport/netty/NettyServer.java +++ b/netty/src/main/java/io/grpc/transport/netty/NettyServer.java @@ -81,7 +81,10 @@ public class NettyServer extends AbstractService { @Override public void initChannel(Channel ch) throws Exception { NettyServerTransport transport = new NettyServerTransport(ch, serverListener, sslContext); - transport.startAsync(); + // TODO(ejona86): Ideally we wouldn't handle handler registration asyncly and then be forced + // to block for completion on another thread. This should be resolved as part of removing + // Service from server transport. + transport.startAsync().awaitRunning(); // TODO(nmittler): Should we wait for transport shutdown before shutting down server? } };

['netty/src/main/java/io/grpc/transport/netty/NettyServer.java']

{'.java': 1}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/345/330

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/330

https://github.com/grpc/grpc-java/pull/345

https://github.com/grpc/grpc-java/pull/345

fixes

OkHttpClientTransport.onGoAway() races with startPendingStreams()

onGoAway has two phases: do things necessary under lock and final cleanup. In the first phase it collects the streams to terminate in the second and sets goAway. startPendingStreams() does not observe goAway and also creates new streams that should be failed due to the goAway. From an initial look, it seems it would be best to remove failPendingStreams() and simply integrate its two phases into onGoAway()'s two phases; that is, when holding the lock in onGoAway, replace pendingStreams with an empty list, and then when not holding the lock call transportReportStatus

986d221eaa70139206e035821e9951f822e01893

8a5d927a9a8d61431f7ed7fab97abaff03d23d2c

https://github.com/grpc/grpc-java/compare/986d221eaa70139206e035821e9951f822e01893...8a5d927a9a8d61431f7ed7fab97abaff03d23d2c

diff --git a/okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientTransport.java b/okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientTransport.java index 0e37a3884..04fd3612e 100644 --- a/okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientTransport.java +++ b/okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientTransport.java @@ -279,19 +279,6 @@ public class OkHttpClientTransport implements ClientTransport { return hasStreamStarted; } - private void failPendingStreams(Status status) { - LinkedList<PendingStream> streams; - synchronized (lock) { - streams = pendingStreams; - pendingStreams = new LinkedList<PendingStream>(); - } - for (PendingStream stream : streams) { - stream.clientStream.transportReportStatus( - status, true, new Metadata.Trailers()); - stream.createdFuture.set(null); - } - } - @Override public void start(Listener listener) { this.listener = Preconditions.checkNotNull(listener, "listener"); @@ -368,6 +355,7 @@ public class OkHttpClientTransport implements ClientTransport { private void onGoAway(int lastKnownStreamId, Status status) { boolean notifyShutdown; ArrayList<OkHttpClientStream> goAwayStreams = new ArrayList<OkHttpClientStream>(); + List<PendingStream> pendingStreamsCopy; synchronized (lock) { notifyShutdown = !goAway; goAway = true; @@ -382,6 +370,9 @@ public class OkHttpClientTransport implements ClientTransport { } } } + + pendingStreamsCopy = pendingStreams; + pendingStreams = new LinkedList<PendingStream>(); } if (notifyShutdown) { @@ -390,7 +381,12 @@ public class OkHttpClientTransport implements ClientTransport { for (OkHttpClientStream stream : goAwayStreams) { stream.transportReportStatus(status, false, new Metadata.Trailers()); } - failPendingStreams(status); + + for (PendingStream stream : pendingStreamsCopy) { + stream.clientStream.transportReportStatus( + status, true, new Metadata.Trailers()); + stream.createdFuture.set(null); + } stopIfNecessary(); }

['okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientTransport.java']

{'.java': 1}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/667/583

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/583

https://github.com/grpc/grpc-java/pull/667

https://github.com/grpc/grpc-java/pull/667

fixes

OkHttp's cancellation is not properly synchronized

[`OkHttpClientStream.sendCancel()` calls `finishStream()`](https://github.com/grpc/grpc-java/blob/master/okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientStream.java#L213) from an application thread. But `finishStream()` [calls transportReportStatus() without any lock held](https://github.com/grpc/grpc-java/blob/master/okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientTransport.java#L463). That is not synchronized correctly, as `transportReportStatus()` may only be called from the transport thread (i.e., while `lock` is held). It seems that all usages of `streams` is done while `lock` is held except for within `finishStream()` and [data()](https://github.com/grpc/grpc-java/blob/master/okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientTransport.java#L570). `data()` can actually race with `finishStream()` and end up sending DATA frames after the RST_STREAM. It seems it would be best to just have `stream` protected by `lock`, because it having its own synchronization isn't providing much benefit and isn't leading to correct code.

1ac64bd09ddcec60829d5291c4db4147aeb2328a

750f6265e21ffb83a0ee46d2120af92b30785b30

https://github.com/grpc/grpc-java/compare/1ac64bd09ddcec60829d5291c4db4147aeb2328a...750f6265e21ffb83a0ee46d2120af92b30785b30

diff --git a/okhttp/src/main/java/io/grpc/transport/okhttp/AsyncFrameWriter.java b/okhttp/src/main/java/io/grpc/transport/okhttp/AsyncFrameWriter.java index bbc6e79ca..8615e489b 100644 --- a/okhttp/src/main/java/io/grpc/transport/okhttp/AsyncFrameWriter.java +++ b/okhttp/src/main/java/io/grpc/transport/okhttp/AsyncFrameWriter.java @@ -32,7 +32,6 @@ package io.grpc.transport.okhttp; import com.google.common.base.Preconditions; -import com.google.common.util.concurrent.SettableFuture; import com.squareup.okhttp.internal.spdy.ErrorCode; import com.squareup.okhttp.internal.spdy.FrameWriter; @@ -44,11 +43,15 @@ import io.grpc.SerializingExecutor; import okio.Buffer; import java.io.IOException; +import java.net.Socket; import java.util.List; -import java.util.concurrent.ExecutionException; +import java.util.logging.Level; +import java.util.logging.Logger; class AsyncFrameWriter implements FrameWriter { + private static final Logger log = Logger.getLogger(OkHttpClientTransport.class.getName()); private FrameWriter frameWriter; + private Socket socket; // Although writes are thread-safe, we serialize them to prevent consuming many Threads that are // just waiting on each other. private final SerializingExecutor executor; @@ -60,12 +63,16 @@ class AsyncFrameWriter implements FrameWriter { } /** - * Set the real frameWriter, should only be called by thread of executor. + * Set the real frameWriter and the corresponding underlying socket, the socket is needed for + * closing. + * + * <p>should only be called by thread of executor. */ - void setFrameWriter(FrameWriter frameWriter) { + void becomeConnected(FrameWriter frameWriter, Socket socket) { Preconditions.checkState(this.frameWriter == null, "AsyncFrameWriter's setFrameWriter() should only be called once."); - this.frameWriter = frameWriter; + this.frameWriter = Preconditions.checkNotNull(frameWriter); + this.socket = Preconditions.checkNotNull(socket); } @Override @@ -207,30 +214,19 @@ class AsyncFrameWriter implements FrameWriter { @Override public void close() { - // Wait for the frameWriter to close. - final SettableFuture<?> closeFuture = SettableFuture.create(); executor.execute(new Runnable() { @Override public void run() { - try { - if (frameWriter != null) { + if (frameWriter != null) { + try { frameWriter.close(); + socket.close(); + } catch (IOException e) { + log.log(Level.WARNING, "Failed closing connection", e); } - } catch (IOException e) { - closeFuture.setException(e); - } finally { - closeFuture.set(null); } } }); - try { - closeFuture.get(); - } catch (InterruptedException e) { - Thread.currentThread().interrupt(); - throw new RuntimeException(e); - } catch (ExecutionException e) { - throw new RuntimeException(e); - } } private abstract class WriteRunnable implements Runnable { diff --git a/okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientStream.java b/okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientStream.java index 0f92bad3c..fa042944d 100644 --- a/okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientStream.java +++ b/okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientStream.java @@ -37,7 +37,6 @@ import static com.google.common.base.Preconditions.checkState; import com.squareup.okhttp.internal.spdy.ErrorCode; import com.squareup.okhttp.internal.spdy.Header; -import io.grpc.Metadata; import io.grpc.MethodDescriptor.MethodType; import io.grpc.Status; import io.grpc.transport.ClientStreamListener; @@ -69,8 +68,8 @@ class OkHttpClientStream extends Http2ClientStream { AsyncFrameWriter frameWriter, OkHttpClientTransport transport, OutboundFlowController outboundFlow, - MethodType type) { - return new OkHttpClientStream(listener, frameWriter, transport, outboundFlow, type); + MethodType type, Object lock) { + return new OkHttpClientStream(listener, frameWriter, transport, outboundFlow, type, lock); } @GuardedBy("lock") @@ -80,7 +79,7 @@ class OkHttpClientStream extends Http2ClientStream { private final AsyncFrameWriter frameWriter; private final OutboundFlowController outboundFlow; private final OkHttpClientTransport transport; - private final Object lock = new Object(); + private final Object lock; private Object outboundFlowState; private volatile Integer id; @@ -88,12 +87,14 @@ class OkHttpClientStream extends Http2ClientStream { AsyncFrameWriter frameWriter, OkHttpClientTransport transport, OutboundFlowController outboundFlow, - MethodType type) { + MethodType type, + Object lock) { super(new OkHttpWritableBufferAllocator(), listener); this.frameWriter = frameWriter; this.transport = transport; this.outboundFlow = outboundFlow; this.type = type; + this.lock = lock; } /** @@ -139,33 +140,30 @@ class OkHttpClientStream extends Http2ClientStream { onSentBytes(numBytes); } + /** + * Must be called with holding the transport lock. + */ public void transportHeadersReceived(List<Header> headers, boolean endOfStream) { - synchronized (lock) { - if (endOfStream) { - transportTrailersReceived(Utils.convertTrailers(headers)); - } else { - transportHeadersReceived(Utils.convertHeaders(headers)); - } + if (endOfStream) { + transportTrailersReceived(Utils.convertTrailers(headers)); + } else { + transportHeadersReceived(Utils.convertHeaders(headers)); } } /** - * We synchronized on "lock" for delivering frames and updating window size, because - * the {@link #request(int)} call can be called in other thread for delivering frames. + * Must be called with holding the transport lock. */ public void transportDataReceived(okio.Buffer frame, boolean endOfStream) { - synchronized (lock) { - long length = frame.size(); - window -= length; - if (window < 0) { - frameWriter.rstStream(id(), ErrorCode.FLOW_CONTROL_ERROR); - Status status = Status.INTERNAL.withDescription( - "Received data size exceeded our receiving window size"); - transport.finishStream(id(), status, null); - return; - } - super.transportDataReceived(new OkHttpReadableBuffer(frame), endOfStream); + long length = frame.size(); + window -= length; + if (window < 0) { + frameWriter.rstStream(id(), ErrorCode.FLOW_CONTROL_ERROR); + transport.finishStream(id(), Status.INTERNAL.withDescription( + "Received data size exceeded our receiving window size"), null); + return; } + super.transportDataReceived(new OkHttpReadableBuffer(frame), endOfStream); } @Override @@ -199,14 +197,6 @@ class OkHttpClientStream extends Http2ClientStream { } } - @Override - public void transportReportStatus(Status newStatus, boolean stopDelivery, - Metadata.Trailers trailers) { - synchronized (lock) { - super.transportReportStatus(newStatus, stopDelivery, trailers); - } - } - @Override protected void sendCancel(Status reason) { transport.finishStream(id(), reason, ErrorCode.CANCEL); diff --git a/okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientTransport.java b/okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientTransport.java index c62927156..c4ed67932 100644 --- a/okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientTransport.java +++ b/okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientTransport.java @@ -70,7 +70,6 @@ import okio.Okio; import java.io.IOException; import java.net.Socket; -import java.util.ArrayList; import java.util.Collections; import java.util.HashMap; import java.util.Iterator; @@ -93,6 +92,7 @@ import javax.net.ssl.SSLSocketFactory; class OkHttpClientTransport implements ClientTransport { private static final Map<ErrorCode, Status> ERROR_CODE_TO_STATUS; private static final Logger log = Logger.getLogger(OkHttpClientTransport.class.getName()); + private static final OkHttpClientStream[] EMPTY_STREAM_ARRAY = new OkHttpClientStream[0]; static { Map<ErrorCode, Status> errorToStatus = new HashMap<ErrorCode, Status>(); @@ -138,8 +138,9 @@ class OkHttpClientTransport implements ClientTransport { private final Object lock = new Object(); @GuardedBy("lock") private int nextStreamId; + @GuardedBy("lock") private final Map<Integer, OkHttpClientStream> streams = - Collections.synchronizedMap(new HashMap<Integer, OkHttpClientStream>()); + new HashMap<Integer, OkHttpClientStream>(); private final Executor executor; // Wrap on executor, to guarantee some operations be executed serially. private final SerializingExecutor serializingExecutor; @@ -245,8 +246,8 @@ class OkHttpClientTransport implements ClientTransport { Preconditions.checkNotNull(headers, "headers"); Preconditions.checkNotNull(listener, "listener"); - OkHttpClientStream clientStream = - OkHttpClientStream.newStream(listener, frameWriter, this, outboundFlow, method.getType()); + OkHttpClientStream clientStream = OkHttpClientStream.newStream( + listener, frameWriter, this, outboundFlow, method.getType(), lock); String defaultPath = "/" + method.getFullMethodName(); List<Header> requestHeaders = @@ -332,7 +333,7 @@ class OkHttpClientTransport implements ClientTransport { clientFrameHandler = new ClientFrameHandler(testFrameReader); executor.execute(clientFrameHandler); connectedCallback.run(); - frameWriter.setFrameWriter(testFrameWriter); + frameWriter.becomeConnected(testFrameWriter, socket); return; } BufferedSource source; @@ -369,7 +370,7 @@ class OkHttpClientTransport implements ClientTransport { Variant variant = new Http2(); rawFrameWriter = variant.newWriter(sink, true); - frameWriter.setFrameWriter(rawFrameWriter); + frameWriter.becomeConnected(rawFrameWriter, socket); try { // Do these with the raw FrameWriter, so that they will be done in this thread, @@ -390,25 +391,35 @@ class OkHttpClientTransport implements ClientTransport { @Override public void shutdown() { - boolean normalClose; synchronized (lock) { - normalClose = !goAway; + if (goAway) { + return; + } } - if (normalClose) { - // Send GOAWAY with lastGoodStreamId of 0, since we don't expect any server-initiated streams. - // The GOAWAY is part of graceful shutdown. - frameWriter.goAway(0, ErrorCode.NO_ERROR, new byte[0]); - onGoAway(Integer.MAX_VALUE, Status.UNAVAILABLE.withDescription("Transport stopped")); + // Send GOAWAY with lastGoodStreamId of 0, since we don't expect any server-initiated streams. + // The GOAWAY is part of graceful shutdown. + frameWriter.goAway(0, ErrorCode.NO_ERROR, new byte[0]); + + onGoAway(Integer.MAX_VALUE, Status.UNAVAILABLE.withDescription("Transport stopped")); + } + + /** + * Gets all active streams as an array. + */ + OkHttpClientStream[] getActiveStreams() { + synchronized (lock) { + return streams.values().toArray(EMPTY_STREAM_ARRAY); } - stopIfNecessary(); } + @VisibleForTesting ClientFrameHandler getHandler() { return clientFrameHandler; } + @VisibleForTesting Map<Integer, OkHttpClientStream> getStreams() { return streams; } @@ -438,37 +449,32 @@ class OkHttpClientTransport implements ClientTransport { private void onGoAway(int lastKnownStreamId, Status status) { boolean notifyShutdown; - ArrayList<OkHttpClientStream> goAwayStreams = new ArrayList<OkHttpClientStream>(); - List<PendingStream> pendingStreamsCopy; synchronized (lock) { notifyShutdown = !goAway; goAway = true; goAwayStatus = status; - synchronized (streams) { - Iterator<Map.Entry<Integer, OkHttpClientStream>> it = streams.entrySet().iterator(); - while (it.hasNext()) { - Map.Entry<Integer, OkHttpClientStream> entry = it.next(); - if (entry.getKey() > lastKnownStreamId) { - goAwayStreams.add(entry.getValue()); - it.remove(); - } + Iterator<Map.Entry<Integer, OkHttpClientStream>> it = streams.entrySet().iterator(); + while (it.hasNext()) { + Map.Entry<Integer, OkHttpClientStream> entry = it.next(); + if (entry.getKey() > lastKnownStreamId) { + it.remove(); + entry.getValue().transportReportStatus(status, false, new Metadata.Trailers()); } } - pendingStreamsCopy = pendingStreams; - pendingStreams = new LinkedList<PendingStream>(); + + for (PendingStream stream : pendingStreams) { + stream.clientStream.transportReportStatus(status, true, new Metadata.Trailers()); + stream.createdFuture.set(null); + } + pendingStreams.clear(); } if (notifyShutdown) { + // TODO(madongfly): Another thread may called stopIfNecessary() and closed the socket, so that + // the reading thread calls listener.transportTerminated() and race with this call. listener.transportShutdown(); } - for (OkHttpClientStream stream : goAwayStreams) { - stream.transportReportStatus(status, false, new Metadata.Trailers()); - } - for (PendingStream stream : pendingStreamsCopy) { - stream.clientStream.transportReportStatus( - status, true, new Metadata.Trailers()); - stream.createdFuture.set(null); - } + stopIfNecessary(); } @@ -486,19 +492,20 @@ class OkHttpClientTransport implements ClientTransport { * @param errorCode reset the stream with this ErrorCode if not null. */ void finishStream(int streamId, @Nullable Status status, @Nullable ErrorCode errorCode) { - OkHttpClientStream stream; - stream = streams.remove(streamId); - if (stream != null) { - if (errorCode != null) { - frameWriter.rstStream(streamId, ErrorCode.CANCEL); - } - if (status != null) { - boolean isCancelled = (status.getCode() == Code.CANCELLED - || status.getCode() == Code.DEADLINE_EXCEEDED); - stream.transportReportStatus(status, isCancelled, new Metadata.Trailers()); - } - if (!startPendingStreams()) { - stopIfNecessary(); + synchronized (lock) { + OkHttpClientStream stream = streams.remove(streamId); + if (stream != null) { + if (errorCode != null) { + frameWriter.rstStream(streamId, ErrorCode.CANCEL); + } + if (status != null) { + boolean isCancelled = (status.getCode() == Code.CANCELLED + || status.getCode() == Code.DEADLINE_EXCEEDED); + stream.transportReportStatus(status, isCancelled, new Metadata.Trailers()); + } + if (!startPendingStreams()) { + stopIfNecessary(); + } } } } @@ -507,39 +514,21 @@ class OkHttpClientTransport implements ClientTransport { * When the transport is in goAway states, we should stop it once all active streams finish. */ void stopIfNecessary() { - boolean shouldStop; - Http2Ping outstandingPing = null; - boolean socketConnected; synchronized (lock) { - shouldStop = (goAway && streams.size() == 0); - if (shouldStop) { - if (stopped) { - // We've already stopped, don't stop again. - shouldStop = false; - } else { + if (goAway && streams.size() == 0) { + if (!stopped) { stopped = true; - outstandingPing = ping; - ping = null; - } - } - socketConnected = socket != null; - } - if (shouldStop) { - // Wait for the frame writer to close. - frameWriter.close(); - if (socketConnected) { - // Close the socket to break out the reader thread, which will close the - // frameReader and notify the listener. - try { - socket.close(); - } catch (IOException e) { - log.log(Level.WARNING, "Failed closing socket", e); + // We will close the underlying socket in the writing thread to break out the reader + // thread, which will close the frameReader and notify the listener. + frameWriter.close(); + + if (ping != null) { + ping.failed(getPingFailure()); + ping = null; + } } } } - if (outstandingPing != null) { - outstandingPing.failed(getPingFailure()); - } } private Throwable getPingFailure() { @@ -558,6 +547,12 @@ class OkHttpClientTransport implements ClientTransport { } } + OkHttpClientStream getStream(int streamId) { + synchronized (lock) { + return streams.get(streamId); + } + } + /** * Returns a Grpc status corresponding to the given ErrorCode. */ @@ -607,8 +602,7 @@ class OkHttpClientTransport implements ClientTransport { @Override public void data(boolean inFinished, int streamId, BufferedSource in, int length) throws IOException { - final OkHttpClientStream stream; - stream = streams.get(streamId); + OkHttpClientStream stream = getStream(streamId); if (stream == null) { if (mayHaveCreatedStream(streamId)) { frameWriter.rstStream(streamId, ErrorCode.INVALID_STREAM); @@ -622,7 +616,9 @@ class OkHttpClientTransport implements ClientTransport { Buffer buf = new Buffer(); buf.write(in.buffer(), length); - stream.transportDataReceived(buf, inFinished); + synchronized (lock) { + stream.transportDataReceived(buf, inFinished); + } } // connection window update @@ -643,18 +639,23 @@ class OkHttpClientTransport implements ClientTransport { int associatedStreamId, List<Header> headerBlock, HeadersMode headersMode) { - OkHttpClientStream stream; - stream = streams.get(streamId); - if (stream == null) { - if (mayHaveCreatedStream(streamId)) { - frameWriter.rstStream(streamId, ErrorCode.INVALID_STREAM); + boolean unknownStream = false; + synchronized (lock) { + OkHttpClientStream stream = streams.get(streamId); + if (stream == null) { + if (mayHaveCreatedStream(streamId)) { + frameWriter.rstStream(streamId, ErrorCode.INVALID_STREAM); + } else { + unknownStream = true; + } } else { - // We don't expect any server-initiated streams. - onError(ErrorCode.PROTOCOL_ERROR, "Received header for unknown stream: " + streamId); + stream.transportHeadersReceived(headerBlock, inFinished); } - return; } - stream.transportHeadersReceived(headerBlock, inFinished); + if (unknownStream) { + // We don't expect any server-initiated streams. + onError(ErrorCode.PROTOCOL_ERROR, "Received header for unknown stream: " + streamId); + } } @Override @@ -748,7 +749,7 @@ class OkHttpClientTransport implements ClientTransport { return; } - OkHttpClientStream stream = streams.get(streamId); + OkHttpClientStream stream = getStream(streamId); if (stream != null) { outboundFlow.windowUpdate(stream, (int) delta); } else if (!mayHaveCreatedStream(streamId)) { diff --git a/okhttp/src/main/java/io/grpc/transport/okhttp/OutboundFlowController.java b/okhttp/src/main/java/io/grpc/transport/okhttp/OutboundFlowController.java index ebe062be0..3112c5635 100644 --- a/okhttp/src/main/java/io/grpc/transport/okhttp/OutboundFlowController.java +++ b/okhttp/src/main/java/io/grpc/transport/okhttp/OutboundFlowController.java @@ -54,7 +54,6 @@ import javax.annotation.Nullable; * streams. */ class OutboundFlowController { - private static final OkHttpClientStream[] EMPTY_STREAM_ARRAY = new OkHttpClientStream[0]; private final OkHttpClientTransport transport; private final FrameWriter frameWriter; private int initialWindowSize = DEFAULT_WINDOW_SIZE; @@ -72,7 +71,7 @@ class OutboundFlowController { int delta = newWindowSize - initialWindowSize; initialWindowSize = newWindowSize; - for (OkHttpClientStream stream : getActiveStreams()) { + for (OkHttpClientStream stream : transport.getActiveStreams()) { OutboundFlowState state = (OutboundFlowState) stream.getOutboundFlowState(); if (state == null) { // Create the OutboundFlowState with the new window size. @@ -116,7 +115,7 @@ class OutboundFlowController { throw new IllegalArgumentException("Invalid streamId: " + streamId); } - OkHttpClientStream stream = transport.getStreams().get(streamId); + OkHttpClientStream stream = transport.getStream(streamId); if (stream == null) { // This is possible for a stream that has received end-of-stream from server (but hasn't sent // end-of-stream), and was removed from the transport stream map. @@ -173,18 +172,11 @@ class OutboundFlowController { return state; } - /** - * Gets all active streams as an array. - */ - private OkHttpClientStream[] getActiveStreams() { - return transport.getStreams().values().toArray(EMPTY_STREAM_ARRAY); - } - /** * Writes as much data for all the streams as possible given the current flow control windows. */ private void writeStreams() { - OkHttpClientStream[] streams = getActiveStreams(); + OkHttpClientStream[] streams = transport.getActiveStreams(); int connectionWindow = connectionState.window(); for (int numStreams = streams.length; numStreams > 0 && connectionWindow > 0;) { int nextNumStreams = 0; @@ -210,7 +202,7 @@ class OutboundFlowController { // Now take one last pass through all of the streams and write any allocated bytes. WriteStatus writeStatus = new WriteStatus(); - for (OkHttpClientStream stream : getActiveStreams()) { + for (OkHttpClientStream stream : transport.getActiveStreams()) { OutboundFlowState state = state(stream); state.writeBytes(state.allocatedBytes(), writeStatus); state.clearAllocatedBytes(); diff --git a/okhttp/src/test/java/io/grpc/transport/okhttp/OkHttpClientTransportTest.java b/okhttp/src/test/java/io/grpc/transport/okhttp/OkHttpClientTransportTest.java index cec61987d..58a8b41d3 100644 --- a/okhttp/src/test/java/io/grpc/transport/okhttp/OkHttpClientTransportTest.java +++ b/okhttp/src/test/java/io/grpc/transport/okhttp/OkHttpClientTransportTest.java @@ -195,7 +195,7 @@ public class OkHttpClientTransportTest { assertEquals("Protocol error\\n" + NETWORK_ISSUE_MESSAGE, listener1.status.getDescription()); assertEquals(Status.INTERNAL.getCode(), listener2.status.getCode()); assertEquals("Protocol error\\n" + NETWORK_ISSUE_MESSAGE, listener2.status.getDescription()); - verify(transportListener).transportShutdown(); + verify(transportListener, timeout(TIME_OUT_MS)).transportShutdown(); verify(transportListener, timeout(TIME_OUT_MS)).transportTerminated(); }

['okhttp/src/main/java/io/grpc/transport/okhttp/OutboundFlowController.java', 'okhttp/src/main/java/io/grpc/transport/okhttp/AsyncFrameWriter.java', 'okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientStream.java', 'okhttp/src/main/java/io/grpc/transport/okhttp/OkHttpClientTransport.java', 'okhttp/src/test/java/io/grpc/transport/okhttp/OkHttpClientTransportTest.java']

{'.java': 5}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/787/786

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/786

https://github.com/grpc/grpc-java/pull/787

https://github.com/grpc/grpc-java/pull/787

fixes

okhttp: pending stream is broken due to stream id check.

`OkHttpClientTransport.mayHaveCreatedStream()` checks the stream id less than the `nextStreamId`, but the `nextStreamId` is not increased yet when the pending stream is being started. And `OkHttpClientTransport.mayHaveCreatedStream()` is wrong when the stream id greater than Integer.MAX_VALUE - 2.

b42122b035da900d10f4b9e41017ef98ef62880a

ddea7435c9952e4ee8ecaf8f52bda6733a7bc824

https://github.com/grpc/grpc-java/compare/b42122b035da900d10f4b9e41017ef98ef62880a...ddea7435c9952e4ee8ecaf8f52bda6733a7bc824

diff --git a/okhttp/src/main/java/io/grpc/okhttp/OkHttpClientTransport.java b/okhttp/src/main/java/io/grpc/okhttp/OkHttpClientTransport.java index f121f6a30..8c8ef855b 100644 --- a/okhttp/src/main/java/io/grpc/okhttp/OkHttpClientTransport.java +++ b/okhttp/src/main/java/io/grpc/okhttp/OkHttpClientTransport.java @@ -272,6 +272,9 @@ class OkHttpClientTransport implements ClientTransport { frameWriter.flush(); } if (nextStreamId >= Integer.MAX_VALUE - 2) { + // Make sure nextStreamId greater than all used id, so that mayHaveCreatedStream() performs + // correctly. + nextStreamId = Integer.MAX_VALUE; onGoAway(Integer.MAX_VALUE, Status.INTERNAL.withDescription("Stream ids exhausted")); } else { nextStreamId += 2; diff --git a/okhttp/src/main/java/io/grpc/okhttp/OutboundFlowController.java b/okhttp/src/main/java/io/grpc/okhttp/OutboundFlowController.java index b686667e0..259a5d75e 100644 --- a/okhttp/src/main/java/io/grpc/okhttp/OutboundFlowController.java +++ b/okhttp/src/main/java/io/grpc/okhttp/OutboundFlowController.java @@ -119,9 +119,6 @@ class OutboundFlowController { */ void data(boolean outFinished, int streamId, Buffer source, boolean flush) { Preconditions.checkNotNull(source, "source"); - if (streamId <= 0 || !transport.mayHaveCreatedStream(streamId)) { - throw new IllegalArgumentException("Invalid streamId: " + streamId); - } OkHttpClientStream stream = transport.getStream(streamId); if (stream == null) { diff --git a/okhttp/src/test/java/io/grpc/okhttp/OkHttpClientTransportTest.java b/okhttp/src/test/java/io/grpc/okhttp/OkHttpClientTransportTest.java index 6c8159a71..2a86c28ed 100644 --- a/okhttp/src/test/java/io/grpc/okhttp/OkHttpClientTransportTest.java +++ b/okhttp/src/test/java/io/grpc/okhttp/OkHttpClientTransportTest.java @@ -603,13 +603,28 @@ public class OkHttpClientTransportTest { int startId = Integer.MAX_VALUE - 2; initTransport(startId, new ConnectedCallback(false)); - MockStreamListener listener1 = new MockStreamListener(); - clientTransport.newStream(method, new Metadata.Headers(), listener1); + MockStreamListener listener = new MockStreamListener(); + clientTransport.newStream(method, new Metadata.Headers(), listener).request(1); + // New stream should be failed. assertNewStreamFail(); + // The alive stream should be functional, receives a message. + frameHandler().headers( + false, false, startId, 0, grpcResponseHeaders(), HeadersMode.HTTP_20_HEADERS); + assertNotNull(listener.headers); + String message = "hello"; + Buffer buffer = createMessageFrame(message); + frameHandler().data(false, startId, buffer, (int) buffer.size()); + getStream(startId).cancel(Status.CANCELLED); - listener1.waitUntilStreamClosed(); + // Receives the second message after be cancelled. + buffer = createMessageFrame(message); + frameHandler().data(false, startId, buffer, (int) buffer.size()); + + listener.waitUntilStreamClosed(); + // Should only have the first message delivered. + assertEquals(message, listener.messages.get(0)); verify(frameWriter, timeout(TIME_OUT_MS)).rstStream(eq(startId), eq(ErrorCode.CANCEL)); verify(transportListener).transportShutdown(isA(Status.class)); verify(transportListener, timeout(TIME_OUT_MS)).transportTerminated(); @@ -627,6 +642,12 @@ public class OkHttpClientTransportTest { // The second stream should be pending. OkHttpClientStream stream2 = clientTransport.newStream(method, new Metadata.Headers(), listener2); + String sentMessage = "hello"; + InputStream input = new ByteArrayInputStream(sentMessage.getBytes(UTF_8)); + assertEquals(5, input.available()); + stream2.writeMessage(input); + stream2.flush(); + stream2.halfClose(); waitForStreamPending(1); assertEquals(1, activeStreamCount()); @@ -635,10 +656,16 @@ public class OkHttpClientTransportTest { stream1.cancel(Status.CANCELLED); listener1.waitUntilStreamClosed(); - // The second stream should be active now. + // The second stream should be active now, and the pending data should be sent out. assertEquals(1, activeStreamCount()); assertEquals(0, clientTransport.getPendingStreamSize()); - stream2.cancel(Status.CANCELLED); + ArgumentCaptor<Buffer> captor = ArgumentCaptor.forClass(Buffer.class); + verify(frameWriter, timeout(TIME_OUT_MS)) + .data(eq(false), eq(5), captor.capture(), eq(5 + HEADER_LENGTH)); + Buffer sentFrame = captor.getValue(); + assertEquals(createMessageFrame(sentMessage), sentFrame); + verify(frameWriter, timeout(TIME_OUT_MS)).data(eq(true), eq(5), any(Buffer.class), eq(0)); + stream2.sendCancel(Status.CANCELLED); } @Test

['okhttp/src/main/java/io/grpc/okhttp/OkHttpClientTransport.java', 'okhttp/src/main/java/io/grpc/okhttp/OutboundFlowController.java', 'okhttp/src/test/java/io/grpc/okhttp/OkHttpClientTransportTest.java']

{'.java': 3}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/889/887

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/887

https://github.com/grpc/grpc-java/pull/889

https://github.com/grpc/grpc-java/pull/889

fixes

OkHttp: race between sendCancel and sendFrame.

If sendCancel is called (by timeout for example) before the stream is started, a following sendFrame will cause a NPE: ``` java.lang.NullPointerException at io.grpc.okhttp.OkHttpClientStream.sendFrame(OkHttpClientStream.java:197) at io.grpc.internal.AbstractClientStream.internalSendFrame(AbstractClientStream.java:199) at io.grpc.internal.AbstractStream$2.deliverFrame(AbstractStream.java:128) at io.grpc.internal.MessageFramer.commitToSink(MessageFramer.java:297) at io.grpc.internal.MessageFramer.flush(MessageFramer.java:255) at io.grpc.internal.AbstractStream.flush(AbstractStream.java:178) at io.grpc.ClientCallImpl.sendMessage(ClientCallImpl.java:213) at io.grpc.stub.ClientCalls$CallToStreamObserverAdapter.onNext(ClientCalls.java:210) at io.grpc.testing.integration.AbstractTransportTest.timeoutOnSleepingServer(AbstractTransportTest.java:843) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) at java.lang.reflect.Method.invoke(Method.java:606) at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:47) at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12) at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:44) at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17) at org.junit.internal.runners.statements.FailOnTimeout$StatementThread.run(FailOnTimeout.java:74) ```

080190c753a484559b5aace35561626c73d5fe8b

a3f2f6249e5fd7d809b780f8e160796c469dc045

https://github.com/grpc/grpc-java/compare/080190c753a484559b5aace35561626c73d5fe8b...a3f2f6249e5fd7d809b780f8e160796c469dc045

diff --git a/okhttp/src/main/java/io/grpc/okhttp/OkHttpClientStream.java b/okhttp/src/main/java/io/grpc/okhttp/OkHttpClientStream.java index ffa4b316b..9a299b595 100644 --- a/okhttp/src/main/java/io/grpc/okhttp/OkHttpClientStream.java +++ b/okhttp/src/main/java/io/grpc/okhttp/OkHttpClientStream.java @@ -190,11 +190,14 @@ class OkHttpClientStream extends Http2ClientStream { } synchronized (lock) { + if (cancelSent) { + return; + } if (pendingData != null) { // Stream is pending start, queue the data. pendingData.add(new PendingData(buffer, endOfStream, flush)); } else { - checkState(id() != 0, "streamId should be set"); + checkState(id() != null, "streamId should be set"); // If buffer > frameWriter.maxDataLength() the flow-controller will ensure that it is // properly chunked. outboundFlow.data(endOfStream, id(), buffer, flush); diff --git a/okhttp/src/test/java/io/grpc/okhttp/OkHttpClientTransportTest.java b/okhttp/src/test/java/io/grpc/okhttp/OkHttpClientTransportTest.java index cf81e9cce..997d4adf6 100644 --- a/okhttp/src/test/java/io/grpc/okhttp/OkHttpClientTransportTest.java +++ b/okhttp/src/test/java/io/grpc/okhttp/OkHttpClientTransportTest.java @@ -197,7 +197,7 @@ public class OkHttpClientTransportTest { startTransport(3, null, true, 1); MockStreamListener listener = new MockStreamListener(); - clientTransport.newStream(method, new Metadata.Headers(), listener).request(1); + clientTransport.newStream(method, new Metadata(), listener).request(1); assertContainStream(3); frameHandler().headers(false, false, 3, 0, grpcResponseHeaders(), HeadersMode.HTTP_20_HEADERS); assertNotNull(listener.headers);

['okhttp/src/main/java/io/grpc/okhttp/OkHttpClientStream.java', 'okhttp/src/test/java/io/grpc/okhttp/OkHttpClientTransportTest.java']

{'.java': 2}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/948/926

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/926

https://github.com/grpc/grpc-java/pull/948

https://github.com/grpc/grpc-java/pull/948

resolves

NettyServer prematurely releases worker event loop

777e928 causes flaky server shutdown, as the individual transports out-live the server.

d42559c6afa666ed7d96a1c324fe09f0d0f8f7ed

2a3ae36bd3730058d00564bca7e7502f84d099df

https://github.com/grpc/grpc-java/compare/d42559c6afa666ed7d96a1c324fe09f0d0f8f7ed...2a3ae36bd3730058d00564bca7e7502f84d099df

diff --git a/netty/src/main/java/io/grpc/netty/NettyServer.java b/netty/src/main/java/io/grpc/netty/NettyServer.java index bd083e49e..f1ba4df27 100644 --- a/netty/src/main/java/io/grpc/netty/NettyServer.java +++ b/netty/src/main/java/io/grpc/netty/NettyServer.java @@ -48,6 +48,8 @@ import io.netty.channel.EventLoopGroup; import io.netty.channel.ServerChannel; import io.netty.channel.socket.nio.NioServerSocketChannel; import io.netty.handler.ssl.SslContext; +import io.netty.util.AbstractReferenceCounted; +import io.netty.util.ReferenceCounted; import java.io.IOException; import java.net.SocketAddress; @@ -74,6 +76,7 @@ public class NettyServer implements Server { private Channel channel; private final int flowControlWindow; private final int maxMessageSize; + private final ReferenceCounted eventLoopReferenceCounter = new EventLoopReferenceCounter(); NettyServer(SocketAddress address, Class<? extends ServerChannel> channelType, @Nullable EventLoopGroup bossGroup, @Nullable EventLoopGroup workerGroup, @@ -108,6 +111,12 @@ public class NettyServer implements Server { b.childHandler(new ChannelInitializer<Channel>() { @Override public void initChannel(Channel ch) throws Exception { + eventLoopReferenceCounter.retain(); + ch.closeFuture().addListener(new ChannelFutureListener() { + public void operationComplete(ChannelFuture future) { + eventLoopReferenceCounter.release(); + } + }); NettyServerTransport transport = new NettyServerTransport(ch, sslContext, maxStreamsPerConnection, flowControlWindow, maxMessageSize); @@ -142,7 +151,7 @@ public class NettyServer implements Server { log.log(Level.WARNING, "Error shutting down server", future.cause()); } listener.serverShutdown(); - releaseSharedGroups(); + eventLoopReferenceCounter.release(); } }); } @@ -156,20 +165,28 @@ public class NettyServer implements Server { } } - private void releaseSharedGroups() { - try { - if (usingSharedBossGroup && bossGroup != null) { - SharedResourceHolder.release(Utils.DEFAULT_BOSS_EVENT_LOOP_GROUP, bossGroup); - } - } finally { - bossGroup = null; + class EventLoopReferenceCounter extends AbstractReferenceCounted { + @Override + protected void deallocate() { try { - if (usingSharedWorkerGroup && workerGroup != null) { - SharedResourceHolder.release(Utils.DEFAULT_WORKER_EVENT_LOOP_GROUP, workerGroup); + if (usingSharedBossGroup && bossGroup != null) { + SharedResourceHolder.release(Utils.DEFAULT_BOSS_EVENT_LOOP_GROUP, bossGroup); } } finally { - workerGroup = null; + bossGroup = null; + try { + if (usingSharedWorkerGroup && workerGroup != null) { + SharedResourceHolder.release(Utils.DEFAULT_WORKER_EVENT_LOOP_GROUP, workerGroup); + } + } finally { + workerGroup = null; + } } } + + @Override + public ReferenceCounted touch(Object hint) { + return this; + } } }

['netty/src/main/java/io/grpc/netty/NettyServer.java']

{'.java': 1}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/1018/1017

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/1017

https://github.com/grpc/grpc-java/pull/1018

https://github.com/grpc/grpc-java/pull/1018

fixes

The run-test-server.sh exits immediately

After changing to using daemon threads by default, this script stopped working. We need to update the server to keep alive until cancelled (e.g. ctrl+c).

abe5b8e5516042d8a5265f8502bfc10a13ac5639

49bb24c25f0225af92ab55086f3004d5838118da

https://github.com/grpc/grpc-java/compare/abe5b8e5516042d8a5265f8502bfc10a13ac5639...49bb24c25f0225af92ab55086f3004d5838118da

diff --git a/interop-testing/src/main/java/io/grpc/testing/integration/TestServiceServer.java b/interop-testing/src/main/java/io/grpc/testing/integration/TestServiceServer.java index 07ebefec6..f994c2cd5 100644 --- a/interop-testing/src/main/java/io/grpc/testing/integration/TestServiceServer.java +++ b/interop-testing/src/main/java/io/grpc/testing/integration/TestServiceServer.java @@ -74,6 +74,7 @@ public class TestServiceServer { }); server.start(); System.out.println("Server started on port " + server.port); + server.blockUntilShutdown(); } private int port = 8080; @@ -152,4 +153,13 @@ public class TestServiceServer { } MoreExecutors.shutdownAndAwaitTermination(executor, 5, TimeUnit.SECONDS); } + + /** + * Await termination on the main thread since the grpc library uses daemon threads. + */ + private void blockUntilShutdown() throws InterruptedException { + if (server != null) { + server.awaitTermination(); + } + } }

['interop-testing/src/main/java/io/grpc/testing/integration/TestServiceServer.java']

{'.java': 1}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

grpc/grpc-java/1023/999

grpc

grpc-java

https://github.com/grpc/grpc-java/issues/999

https://github.com/grpc/grpc-java/pull/1023

https://github.com/grpc/grpc-java/pull/1023

fixes

Possible race condition ServerImpl between start() and shutdown()

I believe it may be possible if start and stop are called concurrently that the shared executor may not get released. I'm not sure if this is an actual problem, but it does go against the @ ThreadSafe annotation.

45c75f2c96456cb7c1cd675c85a1c36ffdc51a9a

4b27e542e08abe5bccd48ebdc5c4d242fd12f662

https://github.com/grpc/grpc-java/compare/45c75f2c96456cb7c1cd675c85a1c36ffdc51a9a...4b27e542e08abe5bccd48ebdc5c4d242fd12f662

diff --git a/core/src/main/java/io/grpc/internal/ServerImpl.java b/core/src/main/java/io/grpc/internal/ServerImpl.java index 80523832f..e45a6cecb 100644 --- a/core/src/main/java/io/grpc/internal/ServerImpl.java +++ b/core/src/main/java/io/grpc/internal/ServerImpl.java @@ -31,6 +31,7 @@ package io.grpc.internal; +import static com.google.common.base.Preconditions.checkState; import static io.grpc.internal.GrpcUtil.TIMEOUT_KEY; import static io.grpc.internal.GrpcUtil.TIMER_SERVICE; @@ -114,9 +115,8 @@ public final class ServerImpl extends io.grpc.Server { @Override public ServerImpl start() throws IOException { synchronized (lock) { - if (started) { - throw new IllegalStateException("Already started"); - } + checkState(!started, "Already started"); + checkState(!shutdown, "Shutting down"); usingSharedExecutor = executor == null; if (usingSharedExecutor) { executor = SharedResourceHolder.get(GrpcUtil.SHARED_CHANNEL_EXECUTOR);

['core/src/main/java/io/grpc/internal/ServerImpl.java']

{'.java': 1}

Java

{'Java': 11734252, 'Shell': 64137, 'C++': 50003, 'Starlark': 45373, 'Batchfile': 6230, 'Dockerfile': 3878, 'Python': 1961}

Apache License 2.0

jhy/jsoup/292/290

jhy

jsoup

https://github.com/jhy/jsoup/issues/290

https://github.com/jhy/jsoup/pull/292

https://github.com/jhy/jsoup/pull/292

fixes

Element.clone() causes StackOverflowError when the element has excessively stacked children

This is similar to the issue I previously opened and was subsequently fixed in 1.7.2. Excessively stacked elements contained in a parent element, such as a couple hundred `<i>` tags wrapped around some text, cause `Element.clone()` to throw a `StackOverflowError` in `Node.doClone()` Consider this page: http://m.gamefaqs.com/boards/577800-one-man-and-his-droid/64768563 In that page's source, you can see this: ``` <blockquote><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i><i>censor f***ing bypass</i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></i></blockquote> ``` Now clearly, something like this isn't normal. And it isn't going to happen often. But, while this page is a recreation of the issue, it did occur naturally on a different board (I don't have access to this separate board, hence why it was recreated) This is on an Android device, where per-app stack allocation might be smaller than on a desktop or laptop.

834d3142304e0927dc659791da6a4521f271d7fd

586c85420990eab5e0f07c324fc26fcdae3af05c

https://github.com/jhy/jsoup/compare/834d3142304e0927dc659791da6a4521f271d7fd...586c85420990eab5e0f07c324fc26fcdae3af05c

diff --git a/src/main/java/org/jsoup/nodes/Node.java b/src/main/java/org/jsoup/nodes/Node.java index f3411a75..41a13fbf 100644 --- a/src/main/java/org/jsoup/nodes/Node.java +++ b/src/main/java/org/jsoup/nodes/Node.java @@ -10,6 +10,7 @@ import java.net.MalformedURLException; import java.net.URL; import java.util.ArrayList; import java.util.Collections; +import java.util.LinkedList; import java.util.List; /** @@ -593,11 +594,32 @@ public abstract class Node implements Cloneable { */ @Override public Node clone() { - return doClone(null); // splits for orphan + Node thisClone = doClone(null); // splits for orphan + + // Queue up nodes that need their children cloned (BFS). + LinkedList<Node> nodesToProcess = new LinkedList<Node>(); + nodesToProcess.add(thisClone); + + while (!nodesToProcess.isEmpty()) { + Node currParent = nodesToProcess.remove(); + + for (int i = 0; i < currParent.childNodes.size(); i++) { + Node childClone = currParent.childNodes.get(i).doClone(currParent); + currParent.childNodes.set(i, childClone); + nodesToProcess.add(childClone); + } + } + + return thisClone; } + /* + * Return a clone of the node using the given parent (which can be null). + * Not a deep copy of children. + */ protected Node doClone(Node parent) { Node clone; + try { clone = (Node) super.clone(); } catch (CloneNotSupportedException e) { @@ -609,8 +631,9 @@ public abstract class Node implements Cloneable { clone.attributes = attributes != null ? attributes.clone() : null; clone.baseUri = baseUri; clone.childNodes = new ArrayList<Node>(childNodes.size()); + for (Node child: childNodes) - clone.childNodes.add(child.doClone(clone)); // clone() creates orphans, doClone() keeps parent + clone.childNodes.add(child); return clone; } diff --git a/src/test/java/org/jsoup/nodes/DocumentTest.java b/src/test/java/org/jsoup/nodes/DocumentTest.java index e5b50d12..fc58b894 100644 --- a/src/test/java/org/jsoup/nodes/DocumentTest.java +++ b/src/test/java/org/jsoup/nodes/DocumentTest.java @@ -3,6 +3,7 @@ package org.jsoup.nodes; import org.jsoup.Jsoup; import org.jsoup.TextUtil; import org.junit.Test; +import org.junit.Ignore; import static org.junit.Assert.*; @@ -82,4 +83,16 @@ public class DocumentTest { TextUtil.stripNewlines(clone.html())); } + // Ignored since this test can take awhile to run. + @Ignore + @Test public void testOverflowClone() { + StringBuilder builder = new StringBuilder(); + for (int i = 0; i < 100000; i++) { + builder.insert(0, "<i>"); + builder.append("</i>"); + } + + Document doc = Jsoup.parse(builder.toString()); + doc.clone(); + } }

['src/main/java/org/jsoup/nodes/Node.java', 'src/test/java/org/jsoup/nodes/DocumentTest.java']

{'.java': 2}

Java

{'Java': 1474668, 'HTML': 316865}

MIT License

netflix/conductor/1973/1960

netflix

conductor

https://github.com/Netflix/conductor/issues/1960

https://github.com/Netflix/conductor/pull/1973

https://github.com/Netflix/conductor/pull/1973

fixes

Mismatched parameter naming for IsolationGroup

In IsolatedTaskQueueProducer ``` @VisibleForTesting void addTaskQueues() { Set<TaskDef> isolationTaskDefs = getIsolationExecutionNameSpaces(); logger.debug("Retrieved queues {}", isolationTaskDefs); Set<String> taskTypes = SystemTaskWorkerCoordinator.taskNameWorkflowTaskMapping.keySet(); for (TaskDef isolatedTaskDef : isolationTaskDefs) { for (String taskType : taskTypes) { String taskQueue = QueueUtils.getQueueName(taskType, null, isolatedTaskDef.getExecutionNameSpace(), isolatedTaskDef.getIsolationGroupId()); logger.debug("Adding taskQueue:'{}' to system task worker coordinator", taskQueue); SystemTaskWorkerCoordinator.queue.add(taskQueue); } } } ``` It gets the name for the isolated task by calling QueueUtils.getQueueName(with the following order - taskType - null (domain) - isolatedTaskDef.getExecutionNameSpace() - isolatedTaskDef.getIsolationGroupId() But the signature of QueueUtils.getQueueName is like ``` public static String getQueueName(String taskType, String domain, String isolationGroup, String executionNameSpace) { ... } ``` The order of `isolationGroup` and `executionNameSpace` is swapped. I think this might cause bug for IsolatedTask. Since other places are using it like ``` public static String getQueueName(Task task) { return getQueueName(task.getTaskType(), task.getDomain(), task.getIsolationGroupId(), task.getExecutionNameSpace()); } ``` Since I haven't experimented with IsolatedTasks, sorry I can't provide ways to observe the bug.

69d996d58657229712ecffaaca780831efda0a54

7a19487a7a0f778e116f29fe5a93170d26ba9a0c

https://github.com/netflix/conductor/compare/69d996d58657229712ecffaaca780831efda0a54...7a19487a7a0f778e116f29fe5a93170d26ba9a0c

diff --git a/core/src/main/java/com/netflix/conductor/core/execution/tasks/IsolatedTaskQueueProducer.java b/core/src/main/java/com/netflix/conductor/core/execution/tasks/IsolatedTaskQueueProducer.java index ce4477c5c..46dab7916 100644 --- a/core/src/main/java/com/netflix/conductor/core/execution/tasks/IsolatedTaskQueueProducer.java +++ b/core/src/main/java/com/netflix/conductor/core/execution/tasks/IsolatedTaskQueueProducer.java @@ -79,7 +79,7 @@ public class IsolatedTaskQueueProducer { for (TaskDef isolatedTaskDef : isolationTaskDefs) { for (String taskType : taskTypes) { String taskQueue = QueueUtils.getQueueName(taskType, null, - isolatedTaskDef.getExecutionNameSpace(), isolatedTaskDef.getIsolationGroupId()); + isolatedTaskDef.getIsolationGroupId(), isolatedTaskDef.getExecutionNameSpace()); logger.debug("Adding taskQueue:'{}' to system task worker coordinator", taskQueue); SystemTaskWorkerCoordinator.queue.add(taskQueue); }

['core/src/main/java/com/netflix/conductor/core/execution/tasks/IsolatedTaskQueueProducer.java']

{'.java': 1}

Java

{'Java': 3462518, 'Groovy': 850012, 'JavaScript': 390784, 'Go': 45821, 'Python': 27631, 'TypeScript': 8934, 'Dockerfile': 4469, 'SCSS': 4366, 'HTML': 2524, 'Shell': 2374, 'PLpgSQL': 1962, 'CSS': 1347, 'Makefile': 253}

Apache License 2.0

netflix/conductor/943/856

netflix

conductor

https://github.com/Netflix/conductor/issues/856

https://github.com/Netflix/conductor/pull/943

https://github.com/Netflix/conductor/pull/943

fix

NullPointerException when starting up (using dynomite)

Using conductor version 2.1.0 (downloaded from https://bintray.com/netflixoss/maven/conductor/2.1.0) Configuration is as follows (all IPs replaced with 1.2.3.4, they are unique in actual config) I have validated the dynomite cluster is functioning properly using redis-cli ``` db=dynomite workflow.dynomite.cluster=my-dyno workflow.dynomite.cluster.name=my-dyno workflow.dynomite.cluster.hosts=1.2.3.4:8102:us-west-2a:us-west-2;1.2.3.4:8102:us-west-2a:us-west-2;1.2.3.4:8102:us-east-1a:us-east-1;1.2.3.4:8102:us-east-1a:us-east-1;1.2.3.4:8102:eu-west-1a:eu-west-1;1.2.3.4:8102:eu-west-1a:eu-west-1 queues.dynomite.nonQuorum.port=8102 queues.dynomite.threads=10 workflow.namespace.prefix=my-conductor wworkflow.namespace.queue.prefix=my-conductor-queue # Elasticsearch workflow.elasticsearch.instanceType=memory # workflow.elasticsearch.url=my-elasticsearch.my.dom:9300 # workflow.elasticsearch.version=5 # workflow.elasticsearch.index.name=my-conductor-index # I tried running with and without this property EC2_AVAILABILITY_ZONE=us-east-1a ``` Stack Trace ``` 1) Error in custom provider, java.lang.RuntimeException: java.lang.NullPointerException while locating com.netflix.conductor.jedis.DynomiteJedisProvider at com.netflix.conductor.server.DynomiteClusterModule.configure(DynomiteClusterModule.java:25) while locating redis.clients.jedis.JedisCommands Caused by: java.lang.RuntimeException: java.lang.NullPointerException at com.netflix.dyno.jedis.DynoJedisClient$Builder.startConnectionPool(DynoJedisClient.java:4309) at com.netflix.dyno.jedis.DynoJedisClient$Builder.createConnectionPool(DynoJedisClient.java:4281) at com.netflix.dyno.jedis.DynoJedisClient$Builder.buildDynoJedisClient(DynoJedisClient.java:4257) at com.netflix.dyno.jedis.DynoJedisClient$Builder.build(DynoJedisClient.java:4186) at com.netflix.conductor.jedis.DynomiteJedisProvider.get(DynomiteJedisProvider.java:49) at com.netflix.conductor.jedis.DynomiteJedisProvider.get(DynomiteJedisProvider.java:14) at com.google.inject.internal.ProviderInternalFactory.provision(ProviderInternalFactory.java:81) at com.google.inject.internal.BoundProviderFactory.provision(BoundProviderFactory.java:72) at com.google.inject.internal.ProviderInternalFactory$1.call(ProviderInternalFactory.java:65) at com.google.inject.internal.ProvisionListenerStackCallback$Provision.provision(ProvisionListenerStackCallback.java:115) at com.netflix.governator.event.ApplicationEventModule$ApplicationEventSubscribingProvisionListener.onProvision(ApplicationEventModule.java:89) at com.google.inject.internal.ProvisionListenerStackCallback$Provision.provision(ProvisionListenerStackCallback.java:126) at com.google.inject.internal.ProvisionListenerStackCallback$Provision.provision(ProvisionListenerStackCallback.java:133) at com.google.inject.internal.ProvisionListenerStackCallback.provision(ProvisionListenerStackCallback.java:68) at com.google.inject.internal.ProviderInternalFactory.circularGet(ProviderInternalFactory.java:63) at com.google.inject.internal.BoundProviderFactory.get(BoundProviderFactory.java:62) at com.google.inject.internal.ProviderToInternalFactoryAdapter$1.call(ProviderToInternalFactoryAdapter.java:46) at com.google.inject.internal.InjectorImpl.callInContext(InjectorImpl.java:1092) at com.google.inject.internal.ProviderToInternalFactoryAdapter.get(ProviderToInternalFactoryAdapter.java:40) at com.google.inject.internal.SingletonScope$1.get(SingletonScope.java:194) at com.google.inject.internal.InternalFactoryToProviderAdapter.get(InternalFactoryToProviderAdapter.java:41) at com.google.inject.internal.InternalInjectorCreator$1.call(InternalInjectorCreator.java:205) at com.google.inject.internal.InternalInjectorCreator$1.call(InternalInjectorCreator.java:199) at com.google.inject.internal.InjectorImpl.callInContext(InjectorImpl.java:1085) at com.google.inject.internal.InternalInjectorCreator.loadEagerSingletons(InternalInjectorCreator.java:199) at com.google.inject.internal.InternalInjectorCreator.injectDynamically(InternalInjectorCreator.java:180) at com.google.inject.internal.InternalInjectorCreator.build(InternalInjectorCreator.java:110) at com.google.inject.Guice.createInjector(Guice.java:99) at com.google.inject.Guice.createInjector(Guice.java:73) at com.netflix.conductor.bootstrap.Main.main(Main.java:53) Caused by: java.lang.NullPointerException at com.netflix.dyno.connectionpool.impl.HostsUpdater.refreshHosts(HostsUpdater.java:111) at com.netflix.dyno.connectionpool.impl.ConnectionPoolImpl.start(ConnectionPoolImpl.java:486) at com.netflix.dyno.jedis.DynoJedisClient$Builder.startConnectionPool(DynoJedisClient.java:4292) ... 29 more ``` Full log (there are 51 "Error in custom provider" stack traces, mostly very similar) [server.log](https://github.com/Netflix/conductor/files/2558912/server.log)

aa036d49bb225e4bdc4c951a6cd0cb71d0753123

6669e5265fb5c29a574d1e0f18941a2521f1f49c

https://github.com/netflix/conductor/compare/aa036d49bb225e4bdc4c951a6cd0cb71d0753123...6669e5265fb5c29a574d1e0f18941a2521f1f49c

diff --git a/redis-persistence/src/main/java/com/netflix/conductor/jedis/TokenMapSupplierProvider.java b/redis-persistence/src/main/java/com/netflix/conductor/jedis/TokenMapSupplierProvider.java index 627fed072..92a7ef207 100644 --- a/redis-persistence/src/main/java/com/netflix/conductor/jedis/TokenMapSupplierProvider.java +++ b/redis-persistence/src/main/java/com/netflix/conductor/jedis/TokenMapSupplierProvider.java @@ -1,43 +1,53 @@ +/* + * Copyright 2016 Netflix, Inc. + * <p> + * Licensed 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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. + */ package com.netflix.conductor.jedis; -import com.google.common.collect.Lists; - import com.netflix.dyno.connectionpool.Host; -import com.netflix.dyno.connectionpool.HostSupplier; import com.netflix.dyno.connectionpool.TokenMapSupplier; import com.netflix.dyno.connectionpool.impl.lb.HostToken; - -import java.util.Arrays; -import java.util.List; -import java.util.Set; +import com.netflix.dyno.connectionpool.impl.utils.CollectionUtils; import javax.inject.Inject; import javax.inject.Provider; +import java.util.ArrayList; +import java.util.List; +import java.util.Set; public class TokenMapSupplierProvider implements Provider<TokenMapSupplier> { - private final HostSupplier hostSupplier; + private final List<HostToken> hostTokens; @Inject - public TokenMapSupplierProvider(HostSupplier hostSupplier) { - this.hostSupplier = hostSupplier; + public TokenMapSupplierProvider() { + this.hostTokens = new ArrayList<>(); } @Override public TokenMapSupplier get() { return new TokenMapSupplier() { - - // FIXME This isn't particularly safe, but it is equivalent to the existing code. - // FIXME It seems like we should be supply tokens for more than one host? - HostToken token = new HostToken(1L, Lists.newArrayList(hostSupplier.getHosts()).get(0)); - @Override public List<HostToken> getTokens(Set<Host> activeHosts) { - return Arrays.asList(token); + long i = activeHosts.size(); + for (Host host : activeHosts) { + HostToken hostToken = new HostToken(i, host); + hostTokens.add(hostToken); + i--; + } + return hostTokens; } @Override public HostToken getTokenForHost(Host host, Set<Host> activeHosts) { - return token; + return CollectionUtils.find(hostTokens, token -> token.getHost().compareTo(host) == 0); } }; }

['redis-persistence/src/main/java/com/netflix/conductor/jedis/TokenMapSupplierProvider.java']

{'.java': 1}

Java

{'Java': 3462518, 'Groovy': 850012, 'JavaScript': 390784, 'Go': 45821, 'Python': 27631, 'TypeScript': 8934, 'Dockerfile': 4469, 'SCSS': 4366, 'HTML': 2524, 'Shell': 2374, 'PLpgSQL': 1962, 'CSS': 1347, 'Makefile': 253}

Apache License 2.0

netflix/conductor/3495/3494

netflix

conductor

https://github.com/Netflix/conductor/issues/3494

https://github.com/Netflix/conductor/pull/3495

https://github.com/Netflix/conductor/pull/3495

fixes

Complete WAIT task inside for loop by TaskRef

See discussion https://github.com/Netflix/conductor/discussions/2873 Seems like it was partially fixed https://github.com/Netflix/conductor/pull/2883 for eventhandler actions, but did not get fixed for default WAIT task handlers.

719677de34ff323fc30578ad13436865e18ccbac

a72599fbd673408d62701fa376373f5154c7d948

https://github.com/netflix/conductor/compare/719677de34ff323fc30578ad13436865e18ccbac...a72599fbd673408d62701fa376373f5154c7d948

diff --git a/core/src/main/java/com/netflix/conductor/core/events/queue/DefaultEventQueueProcessor.java b/core/src/main/java/com/netflix/conductor/core/events/queue/DefaultEventQueueProcessor.java index 78abf836b..f1c508803 100644 --- a/core/src/main/java/com/netflix/conductor/core/events/queue/DefaultEventQueueProcessor.java +++ b/core/src/main/java/com/netflix/conductor/core/events/queue/DefaultEventQueueProcessor.java @@ -22,6 +22,7 @@ import org.springframework.stereotype.Component; import com.netflix.conductor.common.metadata.tasks.Task; import com.netflix.conductor.common.metadata.tasks.TaskResult; +import com.netflix.conductor.common.utils.TaskUtils; import com.netflix.conductor.core.exception.NotFoundException; import com.netflix.conductor.core.execution.WorkflowExecutor; import com.netflix.conductor.model.TaskModel; @@ -124,7 +125,10 @@ public class DefaultEventQueueProcessor { .filter( task -> !task.getStatus().isTerminal() - && task.getReferenceTaskName() + && TaskUtils + .removeIterationFromTaskRefName( + task + .getReferenceTaskName()) .equals( taskRefName)) .findFirst();

['core/src/main/java/com/netflix/conductor/core/events/queue/DefaultEventQueueProcessor.java']

{'.java': 1}

Java

{'Java': 3462518, 'Groovy': 850012, 'JavaScript': 390784, 'Go': 45821, 'Python': 27631, 'TypeScript': 8934, 'Dockerfile': 4469, 'SCSS': 4366, 'HTML': 2524, 'Shell': 2374, 'PLpgSQL': 1962, 'CSS': 1347, 'Makefile': 253}

Apache License 2.0

tootallnate/java-websocket/570/564

tootallnate

java-websocket

https://github.com/TooTallNate/Java-WebSocket/issues/564

https://github.com/TooTallNate/Java-WebSocket/pull/570

https://github.com/TooTallNate/Java-WebSocket/pull/570

fix

Continuous binary getting swallowed?

My WS JS hosted in Chrome seems to be sending the following frames: BINARY, isFin = false CONTINUOUS, isFin = true Java-WebSocket seems to drop the CONTINUOUS frame on the floor and the application never gets it: ```java // org/java_websocket/drafts/Draft_6455.java:542 } else if( frame.isFin() ) { if( current_continuous_frame == null ) throw new InvalidDataException( CloseFrame.PROTOCOL_ERROR, "Continuous frame sequence was not started." ); //Check if the whole payload is valid utf8, when the opcode indicates a text if( current_continuous_frame.getOpcode() == Framedata.Opcode.TEXT ) { //Checking a bit more from the frame before this one just to make sure all the code points are correct int off = Math.max( current_continuous_frame.getPayloadData().limit() - 64, 0 ); current_continuous_frame.append( frame ); if( !Charsetfunctions.isValidUTF8( current_continuous_frame.getPayloadData(), off ) ) { throw new InvalidDataException( CloseFrame.NO_UTF8 ); } } // **** What about if the current_continuous_frame.getOpcode() == Framedata.Opcode.BINARY ****// current_continuous_frame = null; ``` Is this expected? Is Chrome breaking the spec? Is this something Java-WebSocket should handle differently?

f33422e9951369ffd948d473c026ef0e6da6b8e4

32c1ce01c9064d68c8adcfa3b1b577d30bed8cb2

https://github.com/tootallnate/java-websocket/compare/f33422e9951369ffd948d473c026ef0e6da6b8e4...32c1ce01c9064d68c8adcfa3b1b577d30bed8cb2

diff --git a/src/main/java/org/java_websocket/WebSocketImpl.java b/src/main/java/org/java_websocket/WebSocketImpl.java index 74aca19..f794591 100644 --- a/src/main/java/org/java_websocket/WebSocketImpl.java +++ b/src/main/java/org/java_websocket/WebSocketImpl.java @@ -605,7 +605,7 @@ public class WebSocketImpl implements WebSocket { if( !isOpen() ) { throw new WebsocketNotConnectedException(); } - if( frames == null || frames.isEmpty() ) { + if( frames == null) { throw new IllegalArgumentException(); } ArrayList<ByteBuffer> outgoingFrames = new ArrayList<ByteBuffer>(); diff --git a/src/main/java/org/java_websocket/WebSocketListener.java b/src/main/java/org/java_websocket/WebSocketListener.java index d865504..fd19883 100644 --- a/src/main/java/org/java_websocket/WebSocketListener.java +++ b/src/main/java/org/java_websocket/WebSocketListener.java @@ -59,7 +59,7 @@ public interface WebSocketListener { * @throws InvalidDataException * Throwing this exception will cause this handshake to be rejected */ - public ServerHandshakeBuilder onWebsocketHandshakeReceivedAsServer( WebSocket conn, Draft draft, ClientHandshake request ) throws InvalidDataException; + ServerHandshakeBuilder onWebsocketHandshakeReceivedAsServer( WebSocket conn, Draft draft, ClientHandshake request ) throws InvalidDataException; /** * Called on the client side when the socket connection is first established, and the WebSocketImpl @@ -74,7 +74,7 @@ public interface WebSocketListener { * @throws InvalidDataException * Allows the client to reject the connection with the server in respect of its handshake response. */ - public void onWebsocketHandshakeReceivedAsClient( WebSocket conn, ClientHandshake request, ServerHandshake response ) throws InvalidDataException; + void onWebsocketHandshakeReceivedAsClient( WebSocket conn, ClientHandshake request, ServerHandshake response ) throws InvalidDataException; /** * Called on the client side when the socket connection is first established, and the WebSocketImpl @@ -87,7 +87,7 @@ public interface WebSocketListener { * @throws InvalidDataException * Allows the client to stop the connection from progressing */ - public void onWebsocketHandshakeSentAsClient( WebSocket conn, ClientHandshake request ) throws InvalidDataException; + void onWebsocketHandshakeSentAsClient( WebSocket conn, ClientHandshake request ) throws InvalidDataException; /** * Called when an entire text frame has been received. Do whatever you want @@ -98,7 +98,7 @@ public interface WebSocketListener { * @param message * The UTF-8 decoded message that was received. */ - public void onWebsocketMessage( WebSocket conn, String message ); + void onWebsocketMessage( WebSocket conn, String message ); /** * Called when an entire binary frame has been received. Do whatever you want @@ -109,16 +109,18 @@ public interface WebSocketListener { * @param blob * The binary message that was received. */ - public void onWebsocketMessage( WebSocket conn, ByteBuffer blob ); + void onWebsocketMessage( WebSocket conn, ByteBuffer blob ); /** * Called when a frame fragment has been recieved * + * This method will be removed in a future version since the lib will also call the respective onWebsocketMessage method * @param conn * The <tt>WebSocket</tt> instance this event is occurring on. * @param frame The fragmented frame */ - public void onWebsocketMessageFragment( WebSocket conn, Framedata frame ); + @Deprecated + void onWebsocketMessageFragment( WebSocket conn, Framedata frame ); /** * Called after <var>onHandshakeReceived</var> returns <var>true</var>. @@ -128,7 +130,7 @@ public interface WebSocketListener { * @param conn The <tt>WebSocket</tt> instance this event is occuring on. * @param d The handshake of the websocket instance */ - public void onWebsocketOpen( WebSocket conn, Handshakedata d ); + void onWebsocketOpen( WebSocket conn, Handshakedata d ); /** * Called after <tt>WebSocket#close</tt> is explicity called, or when the @@ -139,7 +141,7 @@ public interface WebSocketListener { * @param reason Additional information string * @param remote Returns whether or not the closing of the connection was initiated by the remote host. */ - public void onWebsocketClose( WebSocket ws, int code, String reason, boolean remote ); + void onWebsocketClose( WebSocket ws, int code, String reason, boolean remote ); /** Called as soon as no further frames are accepted * @@ -148,7 +150,7 @@ public interface WebSocketListener { * @param reason Additional information string * @param remote Returns whether or not the closing of the connection was initiated by the remote host. */ - public void onWebsocketClosing( WebSocket ws, int code, String reason, boolean remote ); + void onWebsocketClosing( WebSocket ws, int code, String reason, boolean remote ); /** send when this peer sends a close handshake * @@ -156,7 +158,7 @@ public interface WebSocketListener { * @param code The codes can be looked up here: {@link CloseFrame} * @param reason Additional information string */ - public void onWebsocketCloseInitiated( WebSocket ws, int code, String reason ); + void onWebsocketCloseInitiated( WebSocket ws, int code, String reason ); /** * Called if an exception worth noting occurred. @@ -167,7 +169,7 @@ public interface WebSocketListener { * The exception that occurred. <br> * Might be null if the exception is not related to any specific connection. For example if the server port could not be bound. */ - public void onWebsocketError( WebSocket conn, Exception ex ); + void onWebsocketError( WebSocket conn, Exception ex ); /** * Called a ping frame has been received. @@ -176,7 +178,7 @@ public interface WebSocketListener { * @param conn The <tt>WebSocket</tt> instance this event is occuring on. * @param f The ping frame. Control frames may contain payload. */ - public void onWebsocketPing( WebSocket conn, Framedata f ); + void onWebsocketPing( WebSocket conn, Framedata f ); /** * Called when a pong frame is received. @@ -184,7 +186,7 @@ public interface WebSocketListener { * @param conn The <tt>WebSocket</tt> instance this event is occuring on. * @param f The pong frame. Control frames may contain payload. **/ - public void onWebsocketPong( WebSocket conn, Framedata f ); + void onWebsocketPong( WebSocket conn, Framedata f ); /** * @see WebSocketAdapter#getFlashPolicy(WebSocket) @@ -192,12 +194,13 @@ public interface WebSocketListener { * @throws InvalidDataException thrown when some data that is required to generate the flash-policy like the websocket local port could not be obtained. * @return An XML String that comforts to Flash's security policy. You MUST not include the null char at the end, it is appended automatically. */ - public String getFlashPolicy( WebSocket conn ) throws InvalidDataException; + @Deprecated + String getFlashPolicy( WebSocket conn ) throws InvalidDataException; /** This method is used to inform the selector thread that there is data queued to be written to the socket. * @param conn The <tt>WebSocket</tt> instance this event is occuring on. */ - public void onWriteDemand( WebSocket conn ); + void onWriteDemand( WebSocket conn ); /** * @see WebSocket#getLocalSocketAddress() @@ -205,7 +208,7 @@ public interface WebSocketListener { * @param conn The <tt>WebSocket</tt> instance this event is occuring on. * @return Returns the address of the endpoint this socket is bound to. */ - public InetSocketAddress getLocalSocketAddress( WebSocket conn ); + InetSocketAddress getLocalSocketAddress( WebSocket conn ); /** * @see WebSocket#getRemoteSocketAddress() @@ -213,5 +216,5 @@ public interface WebSocketListener { * @param conn The <tt>WebSocket</tt> instance this event is occuring on. * @return Returns the address of the endpoint this socket is connected to, or{@code null} if it is unconnected. */ - public InetSocketAddress getRemoteSocketAddress( WebSocket conn ); + InetSocketAddress getRemoteSocketAddress( WebSocket conn ); } diff --git a/src/main/java/org/java_websocket/drafts/Draft_6455.java b/src/main/java/org/java_websocket/drafts/Draft_6455.java index e44e72f..03bb639 100644 --- a/src/main/java/org/java_websocket/drafts/Draft_6455.java +++ b/src/main/java/org/java_websocket/drafts/Draft_6455.java @@ -62,6 +62,11 @@ public class Draft_6455 extends Draft { */ private Framedata current_continuous_frame; + /** + * Attribute for the payload of the current continuous frame + */ + private List<ByteBuffer> byteBufferList; + /** * Attribute for the current incomplete frame */ @@ -96,6 +101,7 @@ public class Draft_6455 extends Draft { public Draft_6455( List<IExtension> inputExtensions ) { knownExtensions = new ArrayList<IExtension>(); boolean hasDefault = false; + byteBufferList = new ArrayList<ByteBuffer>(); for( IExtension inputExtension : inputExtensions ) { if( inputExtension.getClass().equals( DefaultExtension.class ) ) { hasDefault = true; @@ -548,19 +554,30 @@ public class Draft_6455 extends Draft { if( current_continuous_frame != null ) throw new InvalidDataException( CloseFrame.PROTOCOL_ERROR, "Previous continuous frame sequence not completed." ); current_continuous_frame = frame; + byteBufferList.add( frame.getPayloadData() ); } else if( frame.isFin() ) { if( current_continuous_frame == null ) throw new InvalidDataException( CloseFrame.PROTOCOL_ERROR, "Continuous frame sequence was not started." ); - //Check if the whole payload is valid utf8, when the opcode indicates a text + byteBufferList.add( frame.getPayloadData() ); if( current_continuous_frame.getOpcode() == Framedata.Opcode.TEXT ) { - //Checking a bit more from the frame before this one just to make sure all the code points are correct - int off = Math.max( current_continuous_frame.getPayloadData().limit() - 64, 0 ); - current_continuous_frame.append( frame ); - if( !Charsetfunctions.isValidUTF8( current_continuous_frame.getPayloadData(), off ) ) { - throw new InvalidDataException( CloseFrame.NO_UTF8 ); + ((FramedataImpl1) current_continuous_frame).setPayload( getPayloadFromByteBufferList() ); + ((FramedataImpl1) current_continuous_frame ).isValid(); + try { + webSocketImpl.getWebSocketListener().onWebsocketMessage( webSocketImpl, Charsetfunctions.stringUtf8( current_continuous_frame.getPayloadData() ) ); + } catch ( RuntimeException e ) { + webSocketImpl.getWebSocketListener().onWebsocketError( webSocketImpl, e ); + } + } else if( current_continuous_frame.getOpcode() == Framedata.Opcode.BINARY ) { + ((FramedataImpl1) current_continuous_frame).setPayload( getPayloadFromByteBufferList() ); + ((FramedataImpl1) current_continuous_frame ).isValid(); + try { + webSocketImpl.getWebSocketListener().onWebsocketMessage( webSocketImpl, current_continuous_frame.getPayloadData() ); + } catch ( RuntimeException e ) { + webSocketImpl.getWebSocketListener().onWebsocketError( webSocketImpl, e ); } } current_continuous_frame = null; + byteBufferList.clear(); } else if( current_continuous_frame == null ) { throw new InvalidDataException( CloseFrame.PROTOCOL_ERROR, "Continuous frame sequence was not started." ); } @@ -571,18 +588,8 @@ public class Draft_6455 extends Draft { } } //Checking if the current continous frame contains a correct payload with the other frames combined - if( curop == Framedata.Opcode.CONTINUOUS && current_continuous_frame != null && current_continuous_frame.getOpcode() == Framedata.Opcode.TEXT ) { - //Checking a bit more from the frame before this one just to make sure all the code points are correct - int off = Math.max( current_continuous_frame.getPayloadData().limit() - 64, 0 ); - current_continuous_frame.append( frame ); - if( !Charsetfunctions.isValidUTF8( current_continuous_frame.getPayloadData(), off ) ) { - throw new InvalidDataException( CloseFrame.NO_UTF8 ); - } - } - try { - webSocketImpl.getWebSocketListener().onWebsocketMessageFragment( webSocketImpl, frame ); - } catch ( RuntimeException e ) { - webSocketImpl.getWebSocketListener().onWebsocketError( webSocketImpl, e ); + if( curop == Framedata.Opcode.CONTINUOUS && current_continuous_frame != null ) { + byteBufferList.add( frame.getPayloadData() ); } return; } else if( current_continuous_frame != null ) { @@ -632,4 +639,25 @@ public class Draft_6455 extends Draft { public int hashCode() { return extension != null ? extension.hashCode() : 0; } + + /** + * Method to generate a full bytebuffer out of all the fragmented frame payload + * @return a bytebuffer containing all the data + * @throws LimitExedeedException will be thrown when the totalSize is bigger then Integer.MAX_VALUE due to not being able to allocate more + */ + private ByteBuffer getPayloadFromByteBufferList() throws LimitExedeedException { + long totalSize = 0; + for (ByteBuffer buffer : byteBufferList) { + totalSize +=buffer.limit(); + } + if (totalSize > Integer.MAX_VALUE) { + throw new LimitExedeedException( "Payloadsize is to big..." ); + } + ByteBuffer resultingByteBuffer = ByteBuffer.allocate( (int) totalSize ); + for (ByteBuffer buffer : byteBufferList) { + resultingByteBuffer.put( buffer ); + } + resultingByteBuffer.flip(); + return resultingByteBuffer; + } } diff --git a/src/main/java/org/java_websocket/server/WebSocketServer.java b/src/main/java/org/java_websocket/server/WebSocketServer.java index 872db60..38c2a6e 100644 --- a/src/main/java/org/java_websocket/server/WebSocketServer.java +++ b/src/main/java/org/java_websocket/server/WebSocketServer.java @@ -767,6 +767,7 @@ public abstract class WebSocketServer extends AbstractWebSocket implements Runna * The <tt>WebSocket</tt> instance this event is occurring on. * @param fragment The fragmented frame */ + @Deprecated public void onFragment( WebSocket conn, Framedata fragment ) { } diff --git a/src/test/java/org/java_websocket/example/AutobahnServerTest.java b/src/test/java/org/java_websocket/example/AutobahnServerTest.java index 1cc752d..e8749a4 100644 --- a/src/test/java/org/java_websocket/example/AutobahnServerTest.java +++ b/src/test/java/org/java_websocket/example/AutobahnServerTest.java @@ -48,7 +48,6 @@ import java.util.Collections; public class AutobahnServerTest extends WebSocketServer { private static int counter = 0; - public AutobahnServerTest( int port, Draft d ) throws UnknownHostException { super( new InetSocketAddress( port ), Collections.singletonList( d ) ); } @@ -83,17 +82,14 @@ public class AutobahnServerTest extends WebSocketServer { public void onMessage( WebSocket conn, String message ) { conn.send( message ); } - @Override - public void onMessage( WebSocket conn, ByteBuffer blob ) { - conn.send( blob ); + public void onFragment( WebSocket conn, Framedata fragment ) { + System.out.println( "received fragment: " + fragment ); } @Override - public void onWebsocketMessageFragment( WebSocket conn, Framedata frame ) { - FramedataImpl1 builder = ( FramedataImpl1 ) frame; - builder.setTransferemasked( false ); - conn.sendFrame( frame ); + public void onMessage( WebSocket conn, ByteBuffer blob ) { + conn.send( blob ); } public static void main( String[] args ) throws UnknownHostException {

['src/main/java/org/java_websocket/WebSocketListener.java', 'src/main/java/org/java_websocket/WebSocketImpl.java', 'src/main/java/org/java_websocket/drafts/Draft_6455.java', 'src/main/java/org/java_websocket/server/WebSocketServer.java', 'src/test/java/org/java_websocket/example/AutobahnServerTest.java']

{'.java': 5}

Java

{'Java': 920046, 'HTML': 673666, 'Gherkin': 1433}

MIT License

tootallnate/java-websocket/470/465

tootallnate

java-websocket

https://github.com/TooTallNate/Java-WebSocket/issues/465

https://github.com/TooTallNate/Java-WebSocket/pull/470

https://github.com/TooTallNate/Java-WebSocket/pull/470

fix

Bad rsv 4 on android

Hello, our team using this library for connecting websocket server on Android platform, sometimes, there are 'bad rsv 4' errors occurred. Seems same problem with #430. ``` 04-27 14:26:09.960 I/System.out( 1564): D/WebsocketChannel: 000000 48 54 54 50 2f 31 2e 31 20 31 30 31 20 53 77 69 74 63 HTTP/1.1 101 Switc 04-27 14:26:09.960 D/WebSocketChannel( 1564): onError:org.java_websocket.exceptions.InvalidFrameException: bad rsv 4 ``` The debug log above shows the **WebSocketImpl** treat the handshake response as normal websocket frame and decode it, then throw an InvalidFrameException. Our client tries to reconnect to server endlessly when it is in condition of unstable network environment. So is it possible that method **org.java_websocket.WebSocketImpl#decode** was invoked after **WebSocketClient** closed in some extreme cases?

b983c881b2dfb9f4c607f4b8b8201666e3491a12

2daee16dacbf1e0a9186f260310400a03c10803d

https://github.com/tootallnate/java-websocket/compare/b983c881b2dfb9f4c607f4b8b8201666e3491a12...2daee16dacbf1e0a9186f260310400a03c10803d

diff --git a/src/main/java/org/java_websocket/WebSocketImpl.java b/src/main/java/org/java_websocket/WebSocketImpl.java index f3c3142..560651d 100644 --- a/src/main/java/org/java_websocket/WebSocketImpl.java +++ b/src/main/java/org/java_websocket/WebSocketImpl.java @@ -151,7 +151,9 @@ public class WebSocketImpl implements WebSocket { System.out.println( "process(" + socketBuffer.remaining() + "): {" + ( socketBuffer.remaining() > 1000 ? "too big to display" : new String( socketBuffer.array(), socketBuffer.position(), socketBuffer.remaining() ) ) + "}" ); if( readystate != READYSTATE.NOT_YET_CONNECTED ) { - decodeFrames( socketBuffer ); + if ( readystate == READYSTATE.OPEN ) { + decodeFrames( socketBuffer ); + } } else { if( decodeHandshake( socketBuffer ) ) { assert ( tmpHandshakeBytes.hasRemaining() != socketBuffer.hasRemaining() || !socketBuffer.hasRemaining() ); // the buffers will never have remaining bytes at the same time

['src/main/java/org/java_websocket/WebSocketImpl.java']

{'.java': 1}

Java

{'Java': 920046, 'HTML': 673666, 'Gherkin': 1433}

MIT License

tootallnate/java-websocket/276/171

tootallnate

java-websocket

https://github.com/TooTallNate/Java-WebSocket/issues/171

https://github.com/TooTallNate/Java-WebSocket/pull/276

https://github.com/TooTallNate/Java-WebSocket/pull/276

fix

Endless loop in client upon close() when using wss

First, thanks so much for creating the library, it's really useful. I am using this via gottox/socket-io (client) and have run into this nasty problem of an endless loop in SSLSocketChannel2.java when closing a connection (maybe after the other side closed first). A couple of these failures is all it takes to pin the CPU at 100% as the threads that execute these loops pile up. I doubt this is the correct fix, but what I did was change the following in SSLSocketChannel2.readRemaining(), which seems to work. ``` java if( inCrypt.hasRemaining() ) { unwrap(); int amount = transfereTo( inData, dst ); >>> if (engineStatus == SSLEngineResult.Status.CLOSED) { >>> return -1; >>> } if( amount > 0 ) return amount; } ``` EDIT by @Davidisudadi: formatted code

05d2e2ed045d955947d944d7111ce3e6758843b6

ea7e061369477bfdf5a0c32bad920c91f8af61fb

https://github.com/tootallnate/java-websocket/compare/05d2e2ed045d955947d944d7111ce3e6758843b6...ea7e061369477bfdf5a0c32bad920c91f8af61fb

diff --git a/src/main/java/org/java_websocket/SSLSocketChannel2.java b/src/main/java/org/java_websocket/SSLSocketChannel2.java index ba8d8f8..e540612 100644 --- a/src/main/java/org/java_websocket/SSLSocketChannel2.java +++ b/src/main/java/org/java_websocket/SSLSocketChannel2.java @@ -5,6 +5,13 @@ */ package org.java_websocket; +import javax.net.ssl.SSLEngine; +import javax.net.ssl.SSLEngineResult; +import javax.net.ssl.SSLEngineResult.HandshakeStatus; +import javax.net.ssl.SSLEngineResult.Status; +import javax.net.ssl.SSLException; +import javax.net.ssl.SSLSession; +import java.io.EOFException; import java.io.IOException; import java.net.Socket; import java.net.SocketAddress; @@ -20,13 +27,6 @@ import java.util.concurrent.ExecutionException; import java.util.concurrent.ExecutorService; import java.util.concurrent.Future; -import javax.net.ssl.SSLEngine; -import javax.net.ssl.SSLEngineResult; -import javax.net.ssl.SSLEngineResult.HandshakeStatus; -import javax.net.ssl.SSLEngineResult.Status; -import javax.net.ssl.SSLException; -import javax.net.ssl.SSLSession; - /** * Implements the relevant portions of the SocketChannel interface with the SSLEngine wrapper. */ @@ -213,6 +213,9 @@ public class SSLSocketChannel2 implements ByteChannel, WrappedByteChannel { // createBuffers( sslEngine.getSession() ); //} int num = socketChannel.write( wrap( src ) ); + if (writeEngineResult.getStatus() == SSLEngineResult.Status.CLOSED) { + throw new EOFException("Connection is closed"); + } return num; } @@ -286,6 +289,9 @@ public class SSLSocketChannel2 implements ByteChannel, WrappedByteChannel { if( inCrypt.hasRemaining() ) { unwrap(); int amount = transfereTo( inData, dst ); + if (readEngineResult.getStatus() == SSLEngineResult.Status.CLOSED) { + return -1; + } if( amount > 0 ) return amount; }

['src/main/java/org/java_websocket/SSLSocketChannel2.java']

{'.java': 1}

Java

{'Java': 920046, 'HTML': 673666, 'Gherkin': 1433}

MIT License

tootallnate/java-websocket/567/390

tootallnate

java-websocket

https://github.com/TooTallNate/Java-WebSocket/issues/390

https://github.com/TooTallNate/Java-WebSocket/pull/567

https://github.com/TooTallNate/Java-WebSocket/issues/390#issuecomment-335473419

fixes

Websocket server returning 401; can't handle on client side

I have a websocket server that returns 401 on the http handshake I can't figure out how to get that information on the websocket client Two things I can't figure out: 1. Where can I get the http status code returned form the server (401 in this case) onClose is called but with irrelevant code (-1) which I saw in your code that it means "never connected" 2. onError is called but for totally different reason. I get onError ssl == null why would the client library continue to try to decode the handshake, or something like that, when the socket wasn't upgraded (101)? why not just stop there? The ssl error is irrelevant here and is fired do to the fact that the server did not upgrade the socket What I did to get the status code from the server was to subclass my own Draft, implement acceptHandshakeAsClient and copyInsance; this gave me access to the handshake response When I see that the status code is 401 I return NOT_MATCHED This is the only place I saw I can get the status code, but it makes me do ugly things like saving the status code in a variable to be used by onClose and onError which are then called (but with irrelevant data - code == -1 and error exception is ssl == null) Thanks

37b4610cd6c5b5f717b8c4ca196947019a0ed8b1

f1eeff4c3b677a503d04d260475b9725445a82d6

https://github.com/tootallnate/java-websocket/compare/37b4610cd6c5b5f717b8c4ca196947019a0ed8b1...f1eeff4c3b677a503d04d260475b9725445a82d6

diff --git a/src/main/java/org/java_websocket/WebSocketImpl.java b/src/main/java/org/java_websocket/WebSocketImpl.java index 74aca19..7cc3330 100644 --- a/src/main/java/org/java_websocket/WebSocketImpl.java +++ b/src/main/java/org/java_websocket/WebSocketImpl.java @@ -447,11 +447,11 @@ public class WebSocketImpl implements WebSocket { } else if( code == CloseFrame.FLASHPOLICY ) { assert ( remote ); flushAndClose( CloseFrame.FLASHPOLICY, message, true ); + } else if( code == CloseFrame.PROTOCOL_ERROR ) { // this endpoint found a PROTOCOL_ERROR + flushAndClose( code, message, remote ); } else { flushAndClose( CloseFrame.NEVER_CONNECTED, message, false ); } - if( code == CloseFrame.PROTOCOL_ERROR )// this endpoint found a PROTOCOL_ERROR - flushAndClose( code, message, remote ); readystate = READYSTATE.CLOSING; tmpHandshakeBytes = null; return;

['src/main/java/org/java_websocket/WebSocketImpl.java']

{'.java': 1}

Java

{'Java': 920046, 'HTML': 673666, 'Gherkin': 1433}

MIT License

tootallnate/java-websocket/1232/1230

tootallnate

java-websocket

https://github.com/TooTallNate/Java-WebSocket/issues/1230

https://github.com/TooTallNate/Java-WebSocket/pull/1232

https://github.com/TooTallNate/Java-WebSocket/pull/1232

fixes

CONTINUOUS should be decoded depending on the first frame

**Describe the bug** Due to changes with #1165 a return was introduced to handle not decode messages where no RSV1 is set. This is however the case for a frame with opcode CONTINUOUS. It is a valid framing and should therefore work **To Reproduce** Steps to reproduce the behavior: 1. Run autobahn testsuite **Expected behavior** autoban testsuite passes

2c9b09127fbbc6d73438097a961a1337dd0d8a65

8f1f8e4462b8939f4f1706681d934658c6794bc4

https://github.com/tootallnate/java-websocket/compare/2c9b09127fbbc6d73438097a961a1337dd0d8a65...8f1f8e4462b8939f4f1706681d934658c6794bc4

diff --git a/src/main/java/org/java_websocket/drafts/Draft_6455.java b/src/main/java/org/java_websocket/drafts/Draft_6455.java index 68feb61..eb48799 100644 --- a/src/main/java/org/java_websocket/drafts/Draft_6455.java +++ b/src/main/java/org/java_websocket/drafts/Draft_6455.java @@ -115,13 +115,23 @@ public class Draft_6455 extends Draft { /** * Attribute for the used extension in this draft */ - private IExtension extension = new DefaultExtension(); + private IExtension negotiatedExtension = new DefaultExtension(); + + /** + * Attribute for the default extension + */ + private IExtension defaultExtension = new DefaultExtension(); /** * Attribute for all available extension in this draft */ private List<IExtension> knownExtensions; + /** + * Current active extension used to decode messages + */ + private IExtension currentDecodingExtension; + /** * Attribute for the used protocol in this draft */ @@ -241,10 +251,11 @@ public class Draft_6455 extends Draft { knownExtensions.addAll(inputExtensions); //We always add the DefaultExtension to implement the normal RFC 6455 specification if (!hasDefault) { - knownExtensions.add(this.knownExtensions.size(), extension); + knownExtensions.add(this.knownExtensions.size(), negotiatedExtension); } knownProtocols.addAll(inputProtocols); maxFrameSize = inputMaxFrameSize; + currentDecodingExtension = null; } @Override @@ -259,9 +270,9 @@ public class Draft_6455 extends Draft { String requestedExtension = handshakedata.getFieldValue(SEC_WEB_SOCKET_EXTENSIONS); for (IExtension knownExtension : knownExtensions) { if (knownExtension.acceptProvidedExtensionAsServer(requestedExtension)) { - extension = knownExtension; + negotiatedExtension = knownExtension; extensionState = HandshakeState.MATCHED; - log.trace("acceptHandshakeAsServer - Matching extension found: {}", extension); + log.trace("acceptHandshakeAsServer - Matching extension found: {}", negotiatedExtension); break; } } @@ -316,9 +327,9 @@ public class Draft_6455 extends Draft { String requestedExtension = response.getFieldValue(SEC_WEB_SOCKET_EXTENSIONS); for (IExtension knownExtension : knownExtensions) { if (knownExtension.acceptProvidedExtensionAsClient(requestedExtension)) { - extension = knownExtension; + negotiatedExtension = knownExtension; extensionState = HandshakeState.MATCHED; - log.trace("acceptHandshakeAsClient - Matching extension found: {}", extension); + log.trace("acceptHandshakeAsClient - Matching extension found: {}", negotiatedExtension); break; } } @@ -337,7 +348,7 @@ public class Draft_6455 extends Draft { * @return the extension which is used or null, if handshake is not yet done */ public IExtension getExtension() { - return extension; + return negotiatedExtension; } /** @@ -562,8 +573,20 @@ public class Draft_6455 extends Draft { frame.setRSV3(rsv3); payload.flip(); frame.setPayload(payload); - getExtension().isFrameValid(frame); - getExtension().decodeFrame(frame); + if (frame.getOpcode() != Opcode.CONTINUOUS) { + // Prioritize the negotiated extension + if (frame.isRSV1() || frame.isRSV2() || frame.isRSV3()) { + currentDecodingExtension = getExtension(); + } else { + // No encoded message, so we can use the default one + currentDecodingExtension = defaultExtension; + } + } + if (currentDecodingExtension == null) { + currentDecodingExtension = defaultExtension; + } + currentDecodingExtension.isFrameValid(frame); + currentDecodingExtension.decodeFrame(frame); if (log.isTraceEnabled()) { log.trace("afterDecoding({}): {}", frame.getPayloadData().remaining(), (frame.getPayloadData().remaining() > 1000 ? "too big to display" @@ -780,10 +803,10 @@ public class Draft_6455 extends Draft { @Override public void reset() { incompleteframe = null; - if (extension != null) { - extension.reset(); + if (negotiatedExtension != null) { + negotiatedExtension.reset(); } - extension = new DefaultExtension(); + negotiatedExtension = new DefaultExtension(); protocol = null; } @@ -1116,7 +1139,7 @@ public class Draft_6455 extends Draft { if (maxFrameSize != that.getMaxFrameSize()) { return false; } - if (extension != null ? !extension.equals(that.getExtension()) : that.getExtension() != null) { + if (negotiatedExtension != null ? !negotiatedExtension.equals(that.getExtension()) : that.getExtension() != null) { return false; } return protocol != null ? protocol.equals(that.getProtocol()) : that.getProtocol() == null; @@ -1124,7 +1147,7 @@ public class Draft_6455 extends Draft { @Override public int hashCode() { - int result = extension != null ? extension.hashCode() : 0; + int result = negotiatedExtension != null ? negotiatedExtension.hashCode() : 0; result = 31 * result + (protocol != null ? protocol.hashCode() : 0); result = 31 * result + (maxFrameSize ^ (maxFrameSize >>> 32)); return result; diff --git a/src/main/java/org/java_websocket/extensions/permessage_deflate/PerMessageDeflateExtension.java b/src/main/java/org/java_websocket/extensions/permessage_deflate/PerMessageDeflateExtension.java index 824ceb6..f24f9b6 100644 --- a/src/main/java/org/java_websocket/extensions/permessage_deflate/PerMessageDeflateExtension.java +++ b/src/main/java/org/java_websocket/extensions/permessage_deflate/PerMessageDeflateExtension.java @@ -142,15 +142,15 @@ public class PerMessageDeflateExtension extends CompressionExtension { return; } + if (!inputFrame.isRSV1() && inputFrame.getOpcode() != Opcode.CONTINUOUS) { + return; + } + // RSV1 bit must be set only for the first frame. if (inputFrame.getOpcode() == Opcode.CONTINUOUS && inputFrame.isRSV1()) { throw new InvalidDataException(CloseFrame.POLICY_VALIDATION, "RSV1 bit can only be set for the first frame."); } - // If rsv1 is not set, we dont have a compressed message - if (!inputFrame.isRSV1()) { - return; - } // Decompressed output buffer. ByteArrayOutputStream output = new ByteArrayOutputStream(); @@ -181,11 +181,6 @@ public class PerMessageDeflateExtension extends CompressionExtension { throw new InvalidDataException(CloseFrame.POLICY_VALIDATION, e.getMessage()); } - // RSV1 bit must be cleared after decoding, so that other extensions don't throw an exception. - if (inputFrame.isRSV1()) { - ((DataFrame) inputFrame).setRSV1(false); - } - // Set frames payload to the new decompressed data. ((FramedataImpl1) inputFrame) .setPayload(ByteBuffer.wrap(output.toByteArray(), 0, output.size()));

['src/main/java/org/java_websocket/drafts/Draft_6455.java', 'src/main/java/org/java_websocket/extensions/permessage_deflate/PerMessageDeflateExtension.java']

{'.java': 2}

Java

{'Java': 920046, 'HTML': 673666, 'Gherkin': 1433}

MIT License

tootallnate/java-websocket/1133/1132

tootallnate

java-websocket

https://github.com/TooTallNate/Java-WebSocket/issues/1132

https://github.com/TooTallNate/Java-WebSocket/pull/1133

https://github.com/TooTallNate/Java-WebSocket/pull/1133

fixes

Draft_6455 flagged by Veracode CWE-331 replace Random with SecureRandom

Our veracode scan flagged usage of `Random` in Draft_6455.java as a vulnerability. https://cwe.mitre.org/data/definitions/331.html According to Websocket Protocol: For example, each masking could be drawn from a cryptographically strong random number generator. If the same key is used or a decipherable pattern exists for how the next key is chosen, the attacker can send a message that, when masked, could appear to be an HTTP request (by taking the message the attacker wishes to see on the wire and masking it with the next masking key to be used, the masking key will effectively unmask the data when the client applies it). According to this specification the library should be using SecureRandom to prevent brute force attacks. **Environment(please complete the following information):** - Version used: 1.5.1 - Java version: 1.8 - Operating System and version: Android - Endpoint Name and version: - Link to your project: **Additional context** Add any other context about the problem here.

32d5656ffd0aa4ba6caba830ac0205c7bf2609e3

feec867c81d1a426815717b489147894a19826e5

https://github.com/tootallnate/java-websocket/compare/32d5656ffd0aa4ba6caba830ac0205c7bf2609e3...feec867c81d1a426815717b489147894a19826e5

diff --git a/src/main/java/org/java_websocket/drafts/Draft_6455.java b/src/main/java/org/java_websocket/drafts/Draft_6455.java index 06c964d..68feb61 100644 --- a/src/main/java/org/java_websocket/drafts/Draft_6455.java +++ b/src/main/java/org/java_websocket/drafts/Draft_6455.java @@ -29,6 +29,7 @@ import java.math.BigInteger; import java.nio.ByteBuffer; import java.security.MessageDigest; import java.security.NoSuchAlgorithmException; +import java.security.SecureRandom; import java.text.SimpleDateFormat; import java.util.ArrayList; import java.util.Calendar; @@ -36,7 +37,6 @@ import java.util.Collections; import java.util.LinkedList; import java.util.List; import java.util.Locale; -import java.util.Random; import java.util.TimeZone; import org.java_websocket.WebSocketImpl; import org.java_websocket.enums.CloseHandshakeType; @@ -150,7 +150,7 @@ public class Draft_6455 extends Draft { /** * Attribute for the reusable random instance */ - private final Random reuseableRandom = new Random(); + private final SecureRandom reuseableRandom = new SecureRandom(); /** * Attribute for the maximum allowed size of a frame

['src/main/java/org/java_websocket/drafts/Draft_6455.java']

{'.java': 1}

Java

{'Java': 920046, 'HTML': 673666, 'Gherkin': 1433}

MIT License

tootallnate/java-websocket/1014/1011

tootallnate

java-websocket

https://github.com/TooTallNate/Java-WebSocket/issues/1011

https://github.com/TooTallNate/Java-WebSocket/pull/1014

https://github.com/TooTallNate/Java-WebSocket/pull/1014

fixes

Crash on Android due to missing method `setEndpointIdentificationAlgorithm` on 1.5.0.

Websocket library 1.5.0 The same code was not crashing on 1.4.1 This is the entire stack trace. I got it through Crashlytics so I cannot describe steps that led to it. ``` Fatal Exception: java.lang.NoSuchMethodError: No virtual method setEndpointIdentificationAlgorithm(Ljava/lang/String;)V in class Ljavax/net/ssl/SSLParameters; or its super classes (declaration of 'javax.net.ssl.SSLParameters' appears in /system/framework/core-libart.jar) at org.java_websocket.client.WebSocketClient.run(WebSocketClient.java:476) at java.lang.Thread.run(Thread.java:831) ``` Android 5.0.1 (API 21). Brand: HUAWEI Model: P8 Lite

c207fb8a7c28e7c49bf42e8da7e7866e7db60043

877ad764e5d01166d754e611a4139e816cc04d0d

https://github.com/tootallnate/java-websocket/compare/c207fb8a7c28e7c49bf42e8da7e7866e7db60043...877ad764e5d01166d754e611a4139e816cc04d0d

diff --git a/src/main/java/org/java_websocket/client/WebSocketClient.java b/src/main/java/org/java_websocket/client/WebSocketClient.java index 0bbcfe5..4d735de 100644 --- a/src/main/java/org/java_websocket/client/WebSocketClient.java +++ b/src/main/java/org/java_websocket/client/WebSocketClient.java @@ -472,8 +472,6 @@ public abstract class WebSocketClient extends AbstractWebSocket implements Runna if (socket instanceof SSLSocket) { SSLSocket sslSocket = (SSLSocket)socket; SSLParameters sslParameters = sslSocket.getSSLParameters(); - // Make sure we perform hostname validation - sslParameters.setEndpointIdentificationAlgorithm("HTTPS"); onSetSSLParameters(sslParameters); sslSocket.setSSLParameters(sslParameters); } @@ -520,10 +518,14 @@ public abstract class WebSocketClient extends AbstractWebSocket implements Runna /** * Apply specific SSLParameters + * If you override this method make sure to always call super.onSetSSLParameters() to ensure the hostname validation is active * * @param sslParameters the SSLParameters which will be used for the SSLSocket */ protected void onSetSSLParameters(SSLParameters sslParameters) { + // If you run into problem on Android (NoSuchMethodException), check out the wiki https://github.com/TooTallNate/Java-WebSocket/wiki/No-such-method-error-setEndpointIdentificationAlgorithm + // Perform hostname validation + sslParameters.setEndpointIdentificationAlgorithm("HTTPS"); } /** diff --git a/src/test/java/org/java_websocket/issues/Issue997Test.java b/src/test/java/org/java_websocket/issues/Issue997Test.java index 0fc81bc..493dd69 100644 --- a/src/test/java/org/java_websocket/issues/Issue997Test.java +++ b/src/test/java/org/java_websocket/issues/Issue997Test.java @@ -143,6 +143,8 @@ public class Issue997Test { @Override protected void onSetSSLParameters(SSLParameters sslParameters) { + // Always call super to ensure hostname validation is active by default + super.onSetSSLParameters(sslParameters); if (endpointIdentificationAlgorithm != null) { sslParameters.setEndpointIdentificationAlgorithm(endpointIdentificationAlgorithm); }

['src/test/java/org/java_websocket/issues/Issue997Test.java', 'src/main/java/org/java_websocket/client/WebSocketClient.java']

{'.java': 2}

Java

{'Java': 920046, 'HTML': 673666, 'Gherkin': 1433}

MIT License

tootallnate/java-websocket/901/905

tootallnate

java-websocket

https://github.com/TooTallNate/Java-WebSocket/issues/905

https://github.com/TooTallNate/Java-WebSocket/pull/901

https://github.com/TooTallNate/Java-WebSocket/pull/901

fixes

IOException wrapped in InternalError not handled properly

**Describe the bug** The call to `socket.connect(...)` at `WebSocketClient:436` can throw a `java.lang.InternalError` that is currently not handled in the enclosing try/catch as it extends `java.lang.Error` and not `java.lang.Exception` This `InternalError` wraps a `java.lang.IOException` that contains useful information to the websocket engine to hande this case. **To Reproduce** Steps to reproduce the behavior: 1. Install a proxy, i.e. squid 2. Make it deny connections **Example application to reproduce the issue** Use the previously installed proxy in the `ProxyClientExample` **Expected behavior** An IOException handled by the underlying websocket engine **Debug log** ``` Exception in thread "WebSocketConnectReadThread-11" java.lang.InternalError: Should not reach here at java.net.HttpConnectSocketImpl.doTunneling(HttpConnectSocketImpl.java:181) at java.net.HttpConnectSocketImpl.doTunnel(HttpConnectSocketImpl.java:168) at java.net.HttpConnectSocketImpl.access$200(HttpConnectSocketImpl.java:44) at java.net.HttpConnectSocketImpl$2.run(HttpConnectSocketImpl.java:151) at java.net.HttpConnectSocketImpl$2.run(HttpConnectSocketImpl.java:149) at java.security.AccessController.doPrivileged(Native Method) at java.net.HttpConnectSocketImpl.privilegedDoTunnel(HttpConnectSocketImpl.java:148) at java.net.HttpConnectSocketImpl.connect(HttpConnectSocketImpl.java:111) at java.net.Socket.connect(Socket.java:589) at org.java_websocket.client.WebSocketClient.run(WebSocketClient.java:436) at java.lang.Thread.run(Thread.java:748) Caused by: java.lang.reflect.InvocationTargetException at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) at java.lang.reflect.Method.invoke(Method.java:498) at java.net.HttpConnectSocketImpl.doTunneling(HttpConnectSocketImpl.java:179) ... 10 more Caused by: java.io.IOException: Unable to tunnel through proxy. Proxy returns "HTTP/1.1 403 Forbidden" at sun.net.www.protocol.http.HttpURLConnection.doTunneling(HttpURLConnection.java:2142) ... 15 more ``` **Environment(please complete the following information):** - Version used: 1.4.0 - Java version: 1.8.0_181 - Operating System and version: Ubuntu 16.04 LTS - Endpoint Name and version: "ws://echo.websocket.org" - Link to your project: ProxyClientExample in the examples folder **Additional context** This is my first time reporting an issue on a open source project. I'm open to feedback :)

c9e75337940cd041e935191e3dbec0005a622c64

f73cca0f3faf1bc5d72ba44d0ee42a1b6dabe28e

https://github.com/tootallnate/java-websocket/compare/c9e75337940cd041e935191e3dbec0005a622c64...f73cca0f3faf1bc5d72ba44d0ee42a1b6dabe28e

diff --git a/src/main/java/org/java_websocket/client/WebSocketClient.java b/src/main/java/org/java_websocket/client/WebSocketClient.java index f5cd9b1..7a93a0a 100644 --- a/src/main/java/org/java_websocket/client/WebSocketClient.java +++ b/src/main/java/org/java_websocket/client/WebSocketClient.java @@ -28,6 +28,7 @@ package org.java_websocket.client; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; +import java.lang.reflect.InvocationTargetException; import java.net.InetAddress; import java.net.InetSocketAddress; import java.net.Proxy; @@ -480,6 +481,15 @@ public abstract class WebSocketClient extends AbstractWebSocket implements Runna onWebsocketError( engine, e ); engine.closeConnection( CloseFrame.NEVER_CONNECTED, e.getMessage() ); return; + } catch (InternalError e) { + // https://bugs.openjdk.java.net/browse/JDK-8173620 + if (e.getCause() instanceof InvocationTargetException && e.getCause().getCause() instanceof IOException) { + IOException cause = (IOException) e.getCause().getCause(); + onWebsocketError(engine, cause); + engine.closeConnection(CloseFrame.NEVER_CONNECTED, cause.getMessage()); + return; + } + throw e; } writeThread = new Thread( new WebsocketWriteThread(this) );

['src/main/java/org/java_websocket/client/WebSocketClient.java']

{'.java': 1}

Java

{'Java': 920046, 'HTML': 673666, 'Gherkin': 1433}

MIT License

tootallnate/java-websocket/683/685

tootallnate

java-websocket

https://github.com/TooTallNate/Java-WebSocket/issues/685

https://github.com/TooTallNate/Java-WebSocket/pull/683

https://github.com/TooTallNate/Java-WebSocket/pull/683

fixes

Exclude default port from wss host

<!--- Provide a general summary of the issue in the Title above --> I'm working with a server balanced by a proxy that redirect my request to the targeted server depends on the URL I requested. One of these servers has a secure Websocket (I mean wss) and it works on the default port (443). In your client (class WebSocketClient.java) you avoid to include the port in the host by: `port != WebSocket.DEFAULT_PORT ? ":" + port : ""`, but this works only for ws default port and not for wss that now is including ":443" at the end of the host. In my app, for example I want to connect to "wss://app.example.com" and without this check it's trying to connect to "wss://app.example.com:443" and the proxy cannot resolve this host. ## Possible Solution Adding a check for DEFAULT_WSS_PORT as well as the check for DEFAULT_PORT it solves the problem. ```java String host = uri.getHost() + ( (port != WebSocket.DEFAULT_PORT && port != WbSocket.DEFAULT_WSS_PORT) ? ":" + port : "" ); ```

c08be4e43f2414d34ecd5b2fa9985f9e4ff48263

8a9df49a0e9fb7bedc0a08e10bed0862a28b9440

https://github.com/tootallnate/java-websocket/compare/c08be4e43f2414d34ecd5b2fa9985f9e4ff48263...8a9df49a0e9fb7bedc0a08e10bed0862a28b9440

diff --git a/src/main/java/org/java_websocket/client/WebSocketClient.java b/src/main/java/org/java_websocket/client/WebSocketClient.java index da30d5b..00e40fd 100644 --- a/src/main/java/org/java_websocket/client/WebSocketClient.java +++ b/src/main/java/org/java_websocket/client/WebSocketClient.java @@ -434,7 +434,10 @@ public abstract class WebSocketClient extends AbstractWebSocket implements Runna if( part2 != null ) path += '?' + part2; int port = getPort(); - String host = uri.getHost() + ( port != WebSocket.DEFAULT_PORT ? ":" + port : "" ); + String host = uri.getHost() + ( + (port != WebSocket.DEFAULT_PORT && port != WebSocket.DEFAULT_WSS_PORT) + ? ":" + port + : "" ); HandshakeImpl1Client handshake = new HandshakeImpl1Client(); handshake.setResourceDescriptor( path );

['src/main/java/org/java_websocket/client/WebSocketClient.java']

{'.java': 1}

Java

{'Java': 920046, 'HTML': 673666, 'Gherkin': 1433}

MIT License

tootallnate/java-websocket/329/259

tootallnate

java-websocket

https://github.com/TooTallNate/Java-WebSocket/issues/259

https://github.com/TooTallNate/Java-WebSocket/pull/329

https://github.com/TooTallNate/Java-WebSocket/pull/329

fixes

WebSocketServer freezes in stop() method

Hello, first I would like to thank you for creating a great and useful library. I'am using it in Android application to communicate with website. When I try to stop the server, the application sometimes stops responding. The main thread is indefinitely waiting in "WebSocketServer.stop()" method in "selectorThread.join()" line, because the "selectorThread" never ends. This happens because "selectorThread" is waiting in "run()" method in "selector.select()" line. Do you know what could be the cause of this behavior? Thank you all in advance for any help you can provide. Regards, Vito

ac45d846806ad662de48c206896d1248acbb53ff

e4c248a69f0cb36f87e5b3d3100bd2b46e027289

https://github.com/tootallnate/java-websocket/compare/ac45d846806ad662de48c206896d1248acbb53ff...e4c248a69f0cb36f87e5b3d3100bd2b46e027289

diff --git a/src/main/java/org/java_websocket/server/WebSocketServer.java b/src/main/java/org/java_websocket/server/WebSocketServer.java index 5fc6a39..12cea2f 100644 --- a/src/main/java/org/java_websocket/server/WebSocketServer.java +++ b/src/main/java/org/java_websocket/server/WebSocketServer.java @@ -216,16 +216,10 @@ public abstract class WebSocketServer extends WebSocketAdapter implements Runnab } synchronized ( this ) { - if( selectorthread != null ) { - if( Thread.currentThread() != selectorthread ) { - - } - if( selectorthread != Thread.currentThread() ) { - if( socketsToClose.size() > 0 ) - selectorthread.join( timeout );// isclosed will tell the selectorthread to go down after the last connection was closed - selectorthread.interrupt();// in case the selectorthread did not terminate in time we send the interrupt - selectorthread.join(); - } + if( selectorthread != null && selectorthread != Thread.currentThread() ) { + selector.wakeup(); + selectorthread.interrupt(); + selectorthread.join( timeout ); } } }

['src/main/java/org/java_websocket/server/WebSocketServer.java']

{'.java': 1}

Java

{'Java': 920046, 'HTML': 673666, 'Gherkin': 1433}

MIT License

square/moshi/500/277

square

moshi

https://github.com/square/moshi/issues/277

https://github.com/square/moshi/pull/500

https://github.com/square/moshi/pull/500

closes

Error where map key doesn’t encode as a string is incoherent

When a map key doesn’t have a natural string encoding we crash with a difficult exception. [For example](https://bitbucket.org/robeden/moshi-test), when writing a `Map<Matcher,String> identifiers` we crash like so: ``` Exception in thread "main" java.lang.IllegalStateException: Nesting problem. at com.squareup.moshi.JsonUtf8Writer.beforeValue(JsonUtf8Writer.java:367) at com.squareup.moshi.JsonUtf8Writer.open(JsonUtf8Writer.java:102) at com.squareup.moshi.JsonUtf8Writer.beginObject(JsonUtf8Writer.java:89) at com.squareup.moshi.ClassJsonAdapter.toJson(ClassJsonAdapter.java:177) at com.squareup.moshi.JsonAdapter$2.toJson(JsonAdapter.java:134) at com.squareup.moshi.MapJsonAdapter.toJson(MapJsonAdapter.java:56) ``` Instead we should say “Matcher cannot be used as a map key in JSON.” The fix for the above example is a JSON adapter, like so: ``` class MatcherJsonAdapter { @ToJson String matcherToJson(Matcher m) { return m.type + ":" + m.match; } @FromJson Matcher matcherFromJson(String s) { String[] parts = s.split(":", 1); return new Matcher(MatchType.valueOf(parts[0]), parts[1]); } } ```

1c68437f3c62a0092fab16afab84c19f5127a35c

44e6fbd067404dc8b56fe75648aaf0f3d812670d

https://github.com/square/moshi/compare/1c68437f3c62a0092fab16afab84c19f5127a35c...44e6fbd067404dc8b56fe75648aaf0f3d812670d

diff --git a/moshi/src/main/java/com/squareup/moshi/JsonUtf8Writer.java b/moshi/src/main/java/com/squareup/moshi/JsonUtf8Writer.java index 4fa074d..5cedfe1 100644 --- a/moshi/src/main/java/com/squareup/moshi/JsonUtf8Writer.java +++ b/moshi/src/main/java/com/squareup/moshi/JsonUtf8Writer.java @@ -77,6 +77,10 @@ final class JsonUtf8Writer extends JsonWriter { } @Override public JsonWriter beginArray() throws IOException { + if (promoteValueToName) { + throw new IllegalStateException( + "Array cannot be used as a map key in JSON at path " + getPath()); + } writeDeferredName(); return open(EMPTY_ARRAY, "["); } @@ -86,6 +90,10 @@ final class JsonUtf8Writer extends JsonWriter { } @Override public JsonWriter beginObject() throws IOException { + if (promoteValueToName) { + throw new IllegalStateException( + "Object cannot be used as a map key in JSON at path " + getPath()); + } writeDeferredName(); return open(EMPTY_OBJECT, "{"); } @@ -171,6 +179,10 @@ final class JsonUtf8Writer extends JsonWriter { } @Override public JsonWriter nullValue() throws IOException { + if (promoteValueToName) { + throw new IllegalStateException( + "null cannot be used as a map key in JSON at path " + getPath()); + } if (deferredName != null) { if (serializeNulls) { writeDeferredName(); @@ -186,6 +198,10 @@ final class JsonUtf8Writer extends JsonWriter { } @Override public JsonWriter value(boolean value) throws IOException { + if (promoteValueToName) { + throw new IllegalStateException( + "Boolean cannot be used as a map key in JSON at path " + getPath()); + } writeDeferredName(); beforeValue(); sink.writeUtf8(value ? "true" : "false"); diff --git a/moshi/src/main/java/com/squareup/moshi/JsonValueWriter.java b/moshi/src/main/java/com/squareup/moshi/JsonValueWriter.java index 9879739..9bc06b3 100644 --- a/moshi/src/main/java/com/squareup/moshi/JsonValueWriter.java +++ b/moshi/src/main/java/com/squareup/moshi/JsonValueWriter.java @@ -47,6 +47,10 @@ final class JsonValueWriter extends JsonWriter { } @Override public JsonWriter beginArray() throws IOException { + if (promoteValueToName) { + throw new IllegalStateException( + "Array cannot be used as a map key in JSON at path " + getPath()); + } checkStack(); List<Object> list = new ArrayList<>(); add(list); @@ -67,6 +71,10 @@ final class JsonValueWriter extends JsonWriter { } @Override public JsonWriter beginObject() throws IOException { + if (promoteValueToName) { + throw new IllegalStateException( + "Object cannot be used as a map key in JSON at path " + getPath()); + } checkStack(); Map<String, Object> map = new LinkedHashTreeMap<>(); add(map); @@ -116,18 +124,30 @@ final class JsonValueWriter extends JsonWriter { } @Override public JsonWriter nullValue() throws IOException { + if (promoteValueToName) { + throw new IllegalStateException( + "null cannot be used as a map key in JSON at path " + getPath()); + } add(null); pathIndices[stackSize - 1]++; return this; } @Override public JsonWriter value(boolean value) throws IOException { + if (promoteValueToName) { + throw new IllegalStateException( + "Boolean cannot be used as a map key in JSON at path " + getPath()); + } add(value); pathIndices[stackSize - 1]++; return this; } @Override public JsonWriter value(@Nullable Boolean value) throws IOException { + if (promoteValueToName) { + throw new IllegalStateException( + "Boolean cannot be used as a map key in JSON at path " + getPath()); + } add(value); pathIndices[stackSize - 1]++; return this; diff --git a/moshi/src/test/java/com/squareup/moshi/MapJsonAdapterTest.java b/moshi/src/test/java/com/squareup/moshi/MapJsonAdapterTest.java index dd3e796..c967047 100644 --- a/moshi/src/test/java/com/squareup/moshi/MapJsonAdapterTest.java +++ b/moshi/src/test/java/com/squareup/moshi/MapJsonAdapterTest.java @@ -141,6 +141,65 @@ public final class MapJsonAdapterTest { assertThat(jsonAdapter.fromJsonValue(jsonObject)).isEqualTo(map); } + @Test public void booleanKeyTypeHasCoherentErrorMessage() { + Map<Boolean, String> map = new LinkedHashMap<>(); + map.put(true, ""); + JsonAdapter<Map<Boolean, String>> adapter = mapAdapter(Boolean.class, String.class); + try { + adapter.toJson(map); + fail(); + } catch (IllegalStateException expected) { + assertThat(expected).hasMessage("Boolean cannot be used as a map key in JSON at path $."); + } + try { + adapter.toJsonValue(map); + fail(); + } catch (IllegalStateException expected) { + assertThat(expected).hasMessage("Boolean cannot be used as a map key in JSON at path $."); + } + } + + static final class Key { + } + + @Test public void objectKeyTypeHasCoherentErrorMessage() { + Map<Key, String> map = new LinkedHashMap<>(); + map.put(new Key(), ""); + JsonAdapter<Map<Key, String>> adapter = mapAdapter(Key.class, String.class); + try { + adapter.toJson(map); + fail(); + } catch (IllegalStateException expected) { + assertThat(expected).hasMessage("Object cannot be used as a map key in JSON at path $."); + } + try { + adapter.toJsonValue(map); + fail(); + } catch (IllegalStateException expected) { + assertThat(expected).hasMessage("Object cannot be " + + "used as a map key in JSON at path $."); + } + } + + @Test public void arrayKeyTypeHasCoherentErrorMessage() { + Map<String[], String> map = new LinkedHashMap<>(); + map.put(new String[0], ""); + JsonAdapter<Map<String[], String>> adapter = + mapAdapter(Types.arrayOf(String.class), String.class); + try { + adapter.toJson(map); + fail(); + } catch (IllegalStateException expected) { + assertThat(expected).hasMessage("Array cannot be used as a map key in JSON at path $."); + } + try { + adapter.toJsonValue(map); + fail(); + } catch (IllegalStateException expected) { + assertThat(expected).hasMessage("Array cannot be used as a map key in JSON at path $."); + } + } + private <K, V> String toJson(Type keyType, Type valueType, Map<K, V> value) throws IOException { JsonAdapter<Map<K, V>> jsonAdapter = mapAdapter(keyType, valueType); Buffer buffer = new Buffer(); diff --git a/moshi/src/test/java/com/squareup/moshi/PromoteNameToValueTest.java b/moshi/src/test/java/com/squareup/moshi/PromoteNameToValueTest.java index c50005d..335e9d0 100644 --- a/moshi/src/test/java/com/squareup/moshi/PromoteNameToValueTest.java +++ b/moshi/src/test/java/com/squareup/moshi/PromoteNameToValueTest.java @@ -252,7 +252,7 @@ public final class PromoteNameToValueTest { writer.value(true); fail(); } catch (IllegalStateException e) { - assertThat(e).hasMessage("Nesting problem."); + assertThat(e).hasMessage("Boolean cannot be used as a map key in JSON at path $."); } writer.value("true"); assertThat(writer.getPath()).isEqualTo("$.true"); @@ -283,7 +283,7 @@ public final class PromoteNameToValueTest { writer.nullValue(); fail(); } catch (IllegalStateException e) { - assertThat(e).hasMessage("Nesting problem."); + assertThat(e).hasMessage("null cannot be used as a map key in JSON at path $."); } writer.value("null"); assertThat(writer.getPath()).isEqualTo("$.null");

['moshi/src/test/java/com/squareup/moshi/PromoteNameToValueTest.java', 'moshi/src/test/java/com/squareup/moshi/MapJsonAdapterTest.java', 'moshi/src/main/java/com/squareup/moshi/JsonUtf8Writer.java', 'moshi/src/main/java/com/squareup/moshi/JsonValueWriter.java']

{'.java': 4}

Kotlin

{'Kotlin': 638860, 'Java': 422224, 'Shell': 785}

Apache License 2.0

square/moshi/493/128

square

moshi

https://github.com/square/moshi/issues/128

https://github.com/square/moshi/pull/493

https://github.com/square/moshi/pull/493

closes

Android: failing to find adapter for a 'GenericArrayTypeImpl' type

We have an adapter in place to process `byte[]` as a base64 / base32 string. Everything works fine when a class has a `byte[]` field, but parsing json fails on Android when we have a field of type `Map<String, byte[]>`. The code below works in the standard JVM but fails on Android. ``` java class Base32Adapter extends JsonAdapter<byte[]> { @Override public byte[] fromJson(JsonReader reader) throws IOException { String string = reader.nextString(); return new BigInteger(string, 32).toByteArray(); } @Override public void toJson(JsonWriter writer, byte[] bytes) throws IOException { String string = new BigInteger(bytes).toString(32); writer.value(string); } } static class FavoriteBytes { @Json(name = "Bytes") public Map<String, byte[]> keys; } @Test public void customAdapter() throws Exception { String jsonString = "{\\"Bytes\\":{\\"jesse\\":\\"a\\",\\"jake\\":\\"1\\"}}"; Moshi binaryMoshi = new Moshi.Builder().add(byte[].class, new Base32Adapter()).build(); FavoriteBytes fav = binaryMoshi.adapter(FavoriteBytes.class).fromJson(jsonString); assertThat(fav.keys).containsOnlyKeys("jesse", "jake"); assertThat(fav.keys.get("jesse")).isEqualTo(new byte[] { 0xa }); assertThat(fav.keys.get("jake")).isEqualTo(new byte[] { 0x1 }); } ``` On Android, this fails with exception: ``` E/MoshiTest(18268): com.squareup.moshi.JsonDataException: Expected BEGIN_ARRAY but was STRING at path $.Keys.jesse E/MoshiTest(18268): at com.squareup.moshi.JsonReader.beginArray(JsonReader.java:346) E/MoshiTest(18268): at com.squareup.moshi.ArrayJsonAdapter.fromJson(ArrayJsonAdapter.java:53) E/MoshiTest(18268): at com.squareup.moshi.JsonAdapter$1.fromJson(JsonAdapter.java:68) E/MoshiTest(18268): at com.squareup.moshi.MapJsonAdapter.fromJson(MapJsonAdapter.java:68) E/MoshiTest(18268): at com.squareup.moshi.MapJsonAdapter.fromJson(MapJsonAdapter.java:29) E/MoshiTest(18268): at com.squareup.moshi.JsonAdapter$1.fromJson(JsonAdapter.java:68) E/MoshiTest(18268): at com.squareup.moshi.ClassJsonAdapter$FieldBinding.read(ClassJsonAdapter.java:183) E/MoshiTest(18268): at com.squareup.moshi.ClassJsonAdapter.fromJson(ClassJsonAdapter.java:144) E/MoshiTest(18268): at com.squareup.moshi.JsonAdapter$1.fromJson(JsonAdapter.java:68) E/MoshiTest(18268): at com.squareup.moshi.JsonAdapter.fromJson(JsonAdapter.java:33) E/MoshiTest(18268): at com.squareup.moshi.JsonAdapter.fromJson(JsonAdapter.java:37) ... ```

2cc878da8158741c31492240c172c36eb4824bb9

fa1f10dc77b764022acdb6a1bcc54049a3f7214f

https://github.com/square/moshi/compare/2cc878da8158741c31492240c172c36eb4824bb9...fa1f10dc77b764022acdb6a1bcc54049a3f7214f

diff --git a/moshi/src/main/java/com/squareup/moshi/internal/Util.java b/moshi/src/main/java/com/squareup/moshi/internal/Util.java index 0744728..e16980a 100644 --- a/moshi/src/main/java/com/squareup/moshi/internal/Util.java +++ b/moshi/src/main/java/com/squareup/moshi/internal/Util.java @@ -45,7 +45,7 @@ public final class Util { public static boolean typesMatch(Type pattern, Type candidate) { // TODO: permit raw types (like Set.class) to match non-raw candidates (like Set<Long>). - return pattern.equals(candidate); + return Types.equals(pattern, candidate); } public static Set<? extends Annotation> jsonAnnotations(AnnotatedElement annotatedElement) {

['moshi/src/main/java/com/squareup/moshi/internal/Util.java']

{'.java': 1}

Kotlin

{'Kotlin': 638860, 'Java': 422224, 'Shell': 785}

Apache License 2.0

square/moshi/80/79

square

moshi

https://github.com/square/moshi/issues/79

https://github.com/square/moshi/pull/80

https://github.com/square/moshi/pull/80

fixes

Parsing fails on NULL field values

This JSON { "id":"2", "name":"glpi", "firstname":null } fails: Expected a value but was NULL at path $.firstname class ObjectJsonAdapter in file StandardJsonAdapters.java has switch (reader.peek()) {} there are BEGIN_ARRAY, BEGIN_OBJECT, STRING, NUMBER, BOOLEAN and noooooo NULL value among cases !!!

2a05fe4d692d4daf6621ffa6a5721c33b6d81619

80953219bda3eeac4da5a7ee7ac6ad9497ea8e38

https://github.com/square/moshi/compare/2a05fe4d692d4daf6621ffa6a5721c33b6d81619...80953219bda3eeac4da5a7ee7ac6ad9497ea8e38

diff --git a/moshi/src/main/java/com/squareup/moshi/StandardJsonAdapters.java b/moshi/src/main/java/com/squareup/moshi/StandardJsonAdapters.java index 9283680..7e9c763 100644 --- a/moshi/src/main/java/com/squareup/moshi/StandardJsonAdapters.java +++ b/moshi/src/main/java/com/squareup/moshi/StandardJsonAdapters.java @@ -239,6 +239,9 @@ final class StandardJsonAdapters { case BOOLEAN: return reader.nextBoolean(); + case NULL: + return reader.nextNull(); + default: throw new IllegalStateException("Expected a value but was " + reader.peek() + " at path " + reader.getPath()); diff --git a/moshi/src/test/java/com/squareup/moshi/ObjectAdapterTest.java b/moshi/src/test/java/com/squareup/moshi/ObjectAdapterTest.java index eea2669..d85daad 100644 --- a/moshi/src/test/java/com/squareup/moshi/ObjectAdapterTest.java +++ b/moshi/src/test/java/com/squareup/moshi/ObjectAdapterTest.java @@ -84,6 +84,17 @@ public final class ObjectAdapterTest { assertThat(adapter.fromJson("[0, 1]")).isEqualTo(Arrays.asList(0d, 1d)); } + @Test public void fromJsonDoesNotFailOnNullValues() throws Exception { + Map<Object, Object> emptyDelivery = new LinkedHashMap<>(); + emptyDelivery.put("address", null); + emptyDelivery.put("items", null); + + Moshi moshi = new Moshi.Builder().build(); + JsonAdapter<Object> adapter = moshi.adapter(Object.class); + assertThat(adapter.fromJson("{\\"address\\":null, \\"items\\":null}")) + .isEqualTo(emptyDelivery); + } + @Test public void toJsonCoercesRuntimeTypeForCollections() throws Exception { Collection<String> collection = new AbstractCollection<String>() { @Override public Iterator<String> iterator() {

['moshi/src/main/java/com/squareup/moshi/StandardJsonAdapters.java', 'moshi/src/test/java/com/squareup/moshi/ObjectAdapterTest.java']

{'.java': 2}

Kotlin

{'Kotlin': 638860, 'Java': 422224, 'Shell': 785}

Apache License 2.0

square/okio/124/105

square

okio

https://github.com/square/okio/issues/105

https://github.com/square/okio/pull/124

https://github.com/square/okio/pull/124

closes

BufferedSink.write(Source, long) hides bugs

It calls `source.read(buffer, byteCount)` which might not read `byteCount` bytes and also might return -1 (which is ignored). Our API should make it hard to write buggy code, and this one tripped me up forcing use of the inverse API which correctly reported read count.

9f2c6e38cd0ffc25d1df7337d71bafcd63504f3c

828384545b72ddc005d35b33c2ebd674548c77df

https://github.com/square/okio/compare/9f2c6e38cd0ffc25d1df7337d71bafcd63504f3c...828384545b72ddc005d35b33c2ebd674548c77df

diff --git a/okio/src/main/java/okio/Buffer.java b/okio/src/main/java/okio/Buffer.java index 92097b9e..44cfbf29 100644 --- a/okio/src/main/java/okio/Buffer.java +++ b/okio/src/main/java/okio/Buffer.java @@ -826,8 +826,10 @@ public final class Buffer implements BufferedSource, BufferedSink, Cloneable { } @Override public BufferedSink write(Source source, long byteCount) throws IOException { - if (byteCount > 0) { - source.read(this, byteCount); + while (byteCount > 0) { + long read = source.read(this, byteCount); + if (read == -1) throw new EOFException(); + byteCount -= read; } return this; } diff --git a/okio/src/main/java/okio/RealBufferedSink.java b/okio/src/main/java/okio/RealBufferedSink.java index d5d4799d..1902fd80 100644 --- a/okio/src/main/java/okio/RealBufferedSink.java +++ b/okio/src/main/java/okio/RealBufferedSink.java @@ -15,6 +15,7 @@ */ package okio; +import java.io.EOFException; import java.io.IOException; import java.io.OutputStream; import java.nio.charset.Charset; @@ -86,8 +87,11 @@ final class RealBufferedSink implements BufferedSink { } @Override public BufferedSink write(Source source, long byteCount) throws IOException { - if (byteCount > 0) { - source.read(buffer, byteCount); + while (byteCount > 0) { + long read = source.read(buffer, byteCount); + if (read == -1) throw new EOFException(); + byteCount -= read; + emitCompleteSegments(); } return this; } diff --git a/okio/src/test/java/okio/BufferedSinkTest.java b/okio/src/test/java/okio/BufferedSinkTest.java index 879ecbdb..73a5cfbc 100644 --- a/okio/src/test/java/okio/BufferedSinkTest.java +++ b/okio/src/test/java/okio/BufferedSinkTest.java @@ -1,5 +1,6 @@ package okio; +import java.io.EOFException; import java.io.IOException; import java.io.OutputStream; import java.math.BigInteger; @@ -170,6 +171,33 @@ public class BufferedSinkTest { assertEquals("ef", source.readUtf8()); } + @Test public void writeSourceReadsFully() throws Exception { + Source source = new ForwardingSource(new Buffer()) { + @Override public long read(Buffer sink, long byteCount) throws IOException { + sink.writeUtf8("abcd"); + return 4; + } + }; + + sink.write(source, 8); + sink.flush(); + assertEquals("abcdabcd", data.readUtf8()); + } + + @Test public void writeSourcePropagatesEof() throws IOException { + Source source = new Buffer().writeUtf8("abcd"); + + try { + sink.write(source, 8); + fail(); + } catch (EOFException expected) { + } + + // Ensure that whatever was available was correctly written. + sink.flush(); + assertEquals("abcd", data.readUtf8()); + } + @Test public void writeSourceWithZeroIsNoOp() throws IOException { // This test ensures that a zero byte count never calls through to read the source. It may be // tied to something like a socket which will potentially block trying to read a segment when

['okio/src/main/java/okio/RealBufferedSink.java', 'okio/src/main/java/okio/Buffer.java', 'okio/src/test/java/okio/BufferedSinkTest.java']

{'.java': 3}

Kotlin

{'Kotlin': 1473930, 'Java': 43685, 'Shell': 1180}

Apache License 2.0

square/okio/130/129

square

okio

https://github.com/square/okio/issues/129

https://github.com/square/okio/pull/130

https://github.com/square/okio/pull/130

closes

DeflaterSink, InflaterSource may leave behind an empty tail

Both of these allocate a segment if necessary, but may end up not writing to that segment. We should write tests that exercise this situation and make sure we don't have a 0-byte segment still in a Buffer.

d07412cc7cb917f852442d3d8ea056e374bad402

2526e7650dd965122e2a4a76d0f3c757d8e70353

https://github.com/square/okio/compare/d07412cc7cb917f852442d3d8ea056e374bad402...2526e7650dd965122e2a4a76d0f3c757d8e70353

diff --git a/okio/src/main/java/okio/DeflaterSink.java b/okio/src/main/java/okio/DeflaterSink.java index 3b23655c..a5bca15d 100644 --- a/okio/src/main/java/okio/DeflaterSink.java +++ b/okio/src/main/java/okio/DeflaterSink.java @@ -99,7 +99,12 @@ public final class DeflaterSink implements Sink { buffer.size += deflated; sink.emitCompleteSegments(); } else if (deflater.needsInput()) { - return; // TODO(jwilson): do we have a dangling empty tail segment here? + if (s.pos == s.limit) { + // We allocated a tail segment, but didn't end up needing it. Recycle! + buffer.head = s.pop(); + SegmentPool.recycle(s); + } + return; } } } diff --git a/okio/src/main/java/okio/InflaterSource.java b/okio/src/main/java/okio/InflaterSource.java index c38819dc..4011ca02 100644 --- a/okio/src/main/java/okio/InflaterSource.java +++ b/okio/src/main/java/okio/InflaterSource.java @@ -70,9 +70,13 @@ public final class InflaterSource implements Source { sink.size += bytesInflated; return bytesInflated; } - // TODO(jwilson): do we have an empty tail? if (inflater.finished() || inflater.needsDictionary()) { releaseInflatedBytes(); + if (tail.pos == tail.limit) { + // We allocated a tail segment, but didn't end up needing it. Recycle! + sink.head = tail.pop(); + SegmentPool.recycle(tail); + } return -1; } if (sourceExhausted) throw new EOFException("source exhausted prematurely"); diff --git a/okio/src/main/java/okio/Okio.java b/okio/src/main/java/okio/Okio.java index 8df1fde8..2b68d48b 100644 --- a/okio/src/main/java/okio/Okio.java +++ b/okio/src/main/java/okio/Okio.java @@ -130,6 +130,7 @@ public final class Okio { return new Source() { @Override public long read(Buffer sink, long byteCount) throws IOException { if (byteCount < 0) throw new IllegalArgumentException("byteCount < 0: " + byteCount); + if (byteCount == 0) return 0; timeout.throwIfReached(); Segment tail = sink.writableSegment(1); int maxToCopy = (int) Math.min(byteCount, Segment.SIZE - tail.limit); diff --git a/okio/src/test/java/okio/DeflaterSinkTest.java b/okio/src/test/java/okio/DeflaterSinkTest.java index 87d6c598..b6cafb21 100644 --- a/okio/src/test/java/okio/DeflaterSinkTest.java +++ b/okio/src/test/java/okio/DeflaterSinkTest.java @@ -87,6 +87,24 @@ public final class DeflaterSinkTest { assertEquals(repeat('a', byteCount), inflate(buffer).readUtf8(byteCount)); } + @Test public void deflateIntoNonemptySink() throws Exception { + String original = "They're moving in herds. They do move in herds."; + + // Exercise all possible offsets for the outgoing segment. + for (int i = 0; i < Segment.SIZE; i++) { + Buffer data = new Buffer().writeUtf8(original); + Buffer sink = new Buffer().writeUtf8(repeat('a', i)); + + DeflaterSink deflaterSink = new DeflaterSink(sink, new Deflater()); + deflaterSink.write(data, data.size()); + deflaterSink.close(); + + sink.skip(i); + Buffer inflated = inflate(sink); + assertEquals(original, inflated.readUtf8()); + } + } + /** * This test deflates a single segment of without compression because that's * the easiest way to force close() to emit a large amount of data to the @@ -121,7 +139,9 @@ public final class DeflaterSinkTest { byte[] buffer = new byte[8192]; while (!inflater.needsInput() || deflated.size() > 0 || deflatedIn.available() > 0) { int count = inflatedIn.read(buffer, 0, buffer.length); - result.write(buffer, 0, count); + if (count != -1) { + result.write(buffer, 0, count); + } } return result; } diff --git a/okio/src/test/java/okio/InflaterSourceTest.java b/okio/src/test/java/okio/InflaterSourceTest.java index e32f18f2..d09d6d33 100644 --- a/okio/src/test/java/okio/InflaterSourceTest.java +++ b/okio/src/test/java/okio/InflaterSourceTest.java @@ -17,6 +17,7 @@ package okio; import java.io.EOFException; import java.io.IOException; +import java.util.zip.Deflater; import java.util.zip.DeflaterOutputStream; import java.util.zip.Inflater; import org.junit.Test; @@ -74,6 +75,19 @@ public final class InflaterSourceTest { assertEquals(original, inflated.readByteString()); } + @Test public void inflateIntoNonemptySink() throws Exception { + for (int i = 0; i < Segment.SIZE; i++) { + Buffer inflated = new Buffer().writeUtf8(repeat('a', i)); + Buffer deflated = decodeBase64( + "eJxzz09RyEjNKVAoLdZRKE9VL0pVyMxTKMlIVchIzEspVshPU0jNS8/MS00tKtYDAF6CD5s="); + InflaterSource source = new InflaterSource(deflated, new Inflater()); + while (source.read(inflated, Integer.MAX_VALUE) != -1) { + } + inflated.skip(i); + assertEquals("God help us, we're in the hands of engineers.", inflated.readUtf8()); + } + } + private Buffer decodeBase64(String s) { return new Buffer().write(ByteString.decodeBase64(s)); }

['okio/src/main/java/okio/InflaterSource.java', 'okio/src/test/java/okio/InflaterSourceTest.java', 'okio/src/main/java/okio/DeflaterSink.java', 'okio/src/main/java/okio/Okio.java', 'okio/src/test/java/okio/DeflaterSinkTest.java']

{'.java': 5}