Generate service config with method config containing timeout configuration that falls back to LDS's http protocol option max stream duration.

Author: voidzcy

xds/src/main/java/io/grpc/xds/XdsNameResolver.java

@@ -86,7 +86,7 @@ final class XdsNameResolver extends NameResolver {
   private final ConcurrentMap<String, AtomicInteger> clusterRefs = new ConcurrentHashMap<>();
   private final ConfigSelector configSelector = new ConfigSelector();
 
-  private volatile List<Route> currentRoutes = Collections.emptyList();
+  private volatile RoutingConfig routingConfig = RoutingConfig.empty;
   private Listener2 listener;
   private ObjectPool<XdsClient> xdsClientPool;
   private XdsClient xdsClient;
@@ -326,7 +326,7 @@ public Result selectConfig(PickSubchannelArgs args) {
       String cluster = null;
       Route selectedRoute = null;
       do {
-        for (Route route : currentRoutes) {
+        for (Route route : routingConfig.routes) {
           if (route.getRouteMatch().matches(
               "/" + args.getMethodDescriptor().getFullMethodName(), asciiHeaders)) {
             selectedRoute = route;
@@ -359,8 +359,13 @@ public Result selectConfig(PickSubchannelArgs args) {
       // TODO(chengyuanzhang): avoid service config generation and parsing for each call.
       Map<String, ?> rawServiceConfig = Collections.emptyMap();
       if (enableTimeout) {
-        rawServiceConfig = generateServiceConfigWithMethodTimeoutConfig(
-            selectedRoute.getRouteAction().getTimeoutNano());
+        long timeoutNano = selectedRoute.getRouteAction().getTimeoutNano();
+        if (timeoutNano == 0) {
+          timeoutNano = routingConfig.fallbackTimeoutNano;
+        }
+        if (timeoutNano > 0) {
+          rawServiceConfig = generateServiceConfigWithMethodTimeoutConfig(timeoutNano);
+        }
       }
       ConfigOrError parsedServiceConfig = serviceConfigParser.parseServiceConfig(rawServiceConfig);
       Object config = parsedServiceConfig.getConfig();
@@ -430,10 +435,12 @@ private class ResolveState implements LdsResourceWatcher {
     private String rdsResource;
     @Nullable
     private RdsResourceWatcher rdsWatcher;
+    private long httpMaxStreamDurationNano;
 
     @Override
     public void onChanged(LdsUpdate update) {
       logger.log(XdsLogLevel.INFO, "Receive LDS resource update: {0}", update);
+      httpMaxStreamDurationNano = update.getHttpMaxStreamDurationNano();
       List<VirtualHost> virtualHosts = update.getVirtualHosts();
       String rdsName = update.getRdsName();
       if (rdsName != null && rdsName.equals(rdsResource)) {
@@ -479,6 +486,8 @@ private void stop() {
     private void updateRoutes(List<VirtualHost> virtualHosts) {
       VirtualHost virtualHost = findVirtualHostForHostName(virtualHosts, authority);
       if (virtualHost == null) {
+        logger.log(XdsLogLevel.WARNING,
+            "Failed to find virtual host matching hostname {0}", authority);
         listener.onResult(emptyResult);
         return;
       }
@@ -515,7 +524,7 @@ private void updateRoutes(List<VirtualHost> virtualHosts) {
       }
       // Make newly added clusters selectable by config selector and deleted clusters no longer
       // selectable.
-      currentRoutes = routes;
+      routingConfig = new RoutingConfig(httpMaxStreamDurationNano, routes);
       shouldUpdateResult = false;
       for (String cluster : deletedClusters) {
         int count = clusterRefs.get(cluster).decrementAndGet();
@@ -560,4 +569,19 @@ public void onResourceDoesNotExist(String resourceName) {
       }
     }
   }
+
+  /**
+   * Grouping of the list of usable routes and their corresponding fallback timeout value.
+   */
+  private static class RoutingConfig {
+    private long fallbackTimeoutNano;
+    private List<Route> routes;
+
+    private static RoutingConfig empty = new RoutingConfig(0L, Collections.<Route>emptyList());
+
+    private RoutingConfig(long fallbackTimeoutNano, List<Route> routes) {
+      this.fallbackTimeoutNano = fallbackTimeoutNano;
+      this.routes = routes;
+    }
+  }
 }

xds/src/test/java/io/grpc/xds/XdsNameResolverTest.java

@@ -264,7 +264,7 @@ public void resolving_encounterErrorLdsAndRdsWatchers() {
   public void resolving_matchingVirtualHostNotFoundInLdsResource() {
     resolver.start(mockListener);
     FakeXdsClient xdsClient = (FakeXdsClient) resolver.getXdsClient();
-    xdsClient.deliverVirtualHostsViaLds(AUTHORITY, buildUnmatchedVirtualHosts());
+    xdsClient.deliverLdsUpdate(AUTHORITY, 0L, buildUnmatchedVirtualHosts());
     assertEmptyResolutionResult();
   }
 
@@ -275,7 +275,7 @@ public void resolving_matchingVirtualHostNotFoundInRdsResource() {
     FakeXdsClient xdsClient = (FakeXdsClient) resolver.getXdsClient();
     xdsClient.deliverRdsName(AUTHORITY, rdsResource);
     assertThat(xdsClient.rdsWatcher).isNotNull();
-    xdsClient.deliverVirtualHostsViaRds(rdsResource, buildUnmatchedVirtualHosts());
+    xdsClient.deliverRdsUpdate(rdsResource, buildUnmatchedVirtualHosts());
     assertEmptyResolutionResult();
   }
 
@@ -291,6 +291,43 @@ private List<VirtualHost> buildUnmatchedVirtualHosts() {
             Collections.singletonList(route2)));
   }
 
+  @SuppressWarnings("unchecked")
+  @Test
+  public void resolved_noTimeout() {
+    resolver.start(mockListener);
+    FakeXdsClient xdsClient = (FakeXdsClient) resolver.getXdsClient();
+    Route route = new Route(new RouteMatch(null, call1.getFullMethodNameForPath()),
+        new RouteAction(0L, cluster1, null));  // per-route timeout unset
+    VirtualHost virtualHost = new VirtualHost("does not matter",
+        Collections.singletonList(AUTHORITY), Collections.singletonList(route));
+    xdsClient.deliverLdsUpdate(AUTHORITY, 0L, Collections.singletonList(virtualHost));
+    verify(mockListener).onResult(resolutionResultCaptor.capture());
+    ResolutionResult result = resolutionResultCaptor.getValue();
+    InternalConfigSelector configSelector = result.getAttributes().get(InternalConfigSelector.KEY);
+    Result selectResult = configSelector.selectConfig(
+        new PickSubchannelArgsImpl(call1.methodDescriptor, new Metadata(), CallOptions.DEFAULT));
+    assertThat(selectResult.getStatus().isOk()).isTrue();
+    assertThat(selectResult.getCallOptions().getOption(XdsNameResolver.CLUSTER_SELECTION_KEY))
+        .isEqualTo(cluster1);
+    assertThat((Map<String, ?>) selectResult.getConfig()).isEmpty();
+  }
+
+  @Test
+  public void resolved_fallbackToHttpMaxStreamDurationAsTimeout() {
+    resolver.start(mockListener);
+    FakeXdsClient xdsClient = (FakeXdsClient) resolver.getXdsClient();
+    Route route = new Route(new RouteMatch(null, call1.getFullMethodNameForPath()),
+        new RouteAction(0L, cluster1, null));  // per-route timeout unset
+    VirtualHost virtualHost = new VirtualHost("does not matter",
+        Collections.singletonList(AUTHORITY), Collections.singletonList(route));
+    xdsClient.deliverLdsUpdate(AUTHORITY, TimeUnit.SECONDS.toNanos(5L),
+        Collections.singletonList(virtualHost));
+    verify(mockListener).onResult(resolutionResultCaptor.capture());
+    ResolutionResult result = resolutionResultCaptor.getValue();
+    InternalConfigSelector configSelector = result.getAttributes().get(InternalConfigSelector.KEY);
+    assertCallSelectResult(call1, configSelector, cluster1, 5.0);
+  }
+
   @Test
   public void resolved_simpleCallSucceeds() {
     InternalConfigSelector configSelector = resolveToClusters();
@@ -320,7 +357,7 @@ public void resolved_resourceUpdateAfterCallStarted() {
 
     reset(mockListener);
     FakeXdsClient xdsClient = (FakeXdsClient) resolver.getXdsClient();
-    xdsClient.deliverRoutesViaLds(
+    xdsClient.deliverLdsUpdate(
         AUTHORITY,
         Arrays.asList(
             new Route(
@@ -355,7 +392,7 @@ public void resolved_resourceUpdatedBeforeCallStarted() {
     InternalConfigSelector configSelector = resolveToClusters();
     reset(mockListener);
     FakeXdsClient xdsClient = (FakeXdsClient) resolver.getXdsClient();
-    xdsClient.deliverRoutesViaLds(
+    xdsClient.deliverLdsUpdate(
         AUTHORITY,
         Arrays.asList(
             new Route(
@@ -386,7 +423,7 @@ public void resolved_raceBetweenCallAndRepeatedResourceUpdate() {
 
     reset(mockListener);
     FakeXdsClient xdsClient = (FakeXdsClient) resolver.getXdsClient();
-    xdsClient.deliverRoutesViaLds(
+    xdsClient.deliverLdsUpdate(
         AUTHORITY,
         Arrays.asList(
             new Route(
@@ -402,7 +439,7 @@ public void resolved_raceBetweenCallAndRepeatedResourceUpdate() {
         Arrays.asList(cluster1, cluster2, "another-cluster"),
         (Map<String, ?>) result.getServiceConfig().getConfig());
 
-    xdsClient.deliverRoutesViaLds(
+    xdsClient.deliverLdsUpdate(
         AUTHORITY,
         Arrays.asList(
             new Route(
@@ -420,13 +457,13 @@ public void resolved_raceBetweenClusterReleasedAndResourceUpdateAddBackAgain() {
     InternalConfigSelector configSelector = resolveToClusters();
     Result result = assertCallSelectResult(call1, configSelector, cluster1, 15.0);
     FakeXdsClient xdsClient = (FakeXdsClient) resolver.getXdsClient();
-    xdsClient.deliverRoutesViaLds(
+    xdsClient.deliverLdsUpdate(
         AUTHORITY,
         Collections.singletonList(
             new Route(
                 new RouteMatch(null, call2.getFullMethodNameForPath()),
                 new RouteAction(TimeUnit.SECONDS.toNanos(15L), cluster2, null))));
-    xdsClient.deliverRoutesViaLds(
+    xdsClient.deliverLdsUpdate(
         AUTHORITY,
         Arrays.asList(
             new Route(
@@ -445,7 +482,7 @@ public void resolved_simpleCallSucceeds_routeToWeightedCluster() {
     when(mockRandom.nextInt(anyInt())).thenReturn(90, 10);
     resolver.start(mockListener);
     FakeXdsClient xdsClient = (FakeXdsClient) resolver.getXdsClient();
-    xdsClient.deliverRoutesViaLds(
+    xdsClient.deliverLdsUpdate(
         AUTHORITY,
         Arrays.asList(
             new Route(
@@ -501,7 +538,7 @@ private static Result assertCallSelectResult(
   private InternalConfigSelector resolveToClusters() {
     resolver.start(mockListener);
     FakeXdsClient xdsClient = (FakeXdsClient) resolver.getXdsClient();
-    xdsClient.deliverRoutesViaLds(
+    xdsClient.deliverLdsUpdate(
         AUTHORITY,
         Arrays.asList(
             new Route(
@@ -761,7 +798,7 @@ void shutdown() {
       // no-op
     }
 
-    void deliverVirtualHostsViaLds(final String resourceName,
+    void deliverLdsUpdate(final String resourceName, final long httpMaxStreamDurationNano,
         final List<VirtualHost> virtualHosts) {
       syncContext.execute(new Runnable() {
         @Override
@@ -770,6 +807,7 @@ public void run() {
             return;
           }
           LdsUpdate.Builder updateBuilder = LdsUpdate.newBuilder();
+          updateBuilder.setHttpMaxStreamDurationNano(httpMaxStreamDurationNano);
           for (VirtualHost virtualHost : virtualHosts) {
             updateBuilder.addVirtualHost(virtualHost);
           }
@@ -778,7 +816,7 @@ public void run() {
       });
     }
 
-    void deliverRoutesViaLds(final String resourceName, final List<Route> routes) {
+    void deliverLdsUpdate(final String resourceName, final List<Route> routes) {
       syncContext.execute(new Runnable() {
         @Override
         public void run() {
@@ -816,8 +854,7 @@ public void run() {
       });
     }
 
-    void deliverVirtualHostsViaRds(final String resourceName,
-        final List<VirtualHost> virtualHosts) {
+    void deliverRdsUpdate(final String resourceName, final List<VirtualHost> virtualHosts) {
       syncContext.execute(new Runnable() {
         @Override
         public void run() {
@@ -829,20 +866,6 @@ public void run() {
       });
     }
 
-    void deliverRoutesViaRds(final String resourceName, final List<Route> routes) {
-      syncContext.execute(new Runnable() {
-        @Override
-        public void run() {
-          if (!resourceName.equals(rdsResource)) {
-            return;
-          }
-          VirtualHost virtualHost =
-              new VirtualHost("virtual-host", Collections.singletonList(AUTHORITY), routes);
-          rdsWatcher.onChanged(RdsUpdate.fromVirtualHosts(Collections.singletonList(virtualHost)));
-        }
-      });
-    }
-
     void deliverRdsResourceNotFound(final String resourceName) {
       syncContext.execute(new Runnable() {
         @Override