Add service schema to clients

Clients now get access to the schema of the service, providing the shape
ID and traits of the service allowed for code generation. This can be
used to know what service is being called for telemetry, or implement things
like endpoint resolvers or custom auth handling based on traits applied to a
service.

Each generated ApiOperation now provides a getter called `service()` to
get the generated ApiService for the client. Resources get this method
too. The generated ApiService only provides the schema of the service.
It doesn't provide a full accounting of every operation or resource
within the service as there isn't a clear use for that, it adds
complexity due to bidirectional references, and we want to avoid eagerly
loading every shape in a service when the ApiService is loaded.
This commit also simplifies the generated ApiResource for this same
reason, removing the operation and sub-resource schemas.

DynamicClient will now automatically generate an ApiService based on the
Smithy model.

Author: mtdowling

client/client-core/src/main/java/software/amazon/smithy/java/client/core/Client.java

@@ -47,14 +47,9 @@ protected Client(Builder<?, ?> builder) {
         }
 
         this.config = configBuilder.build();
-
         this.pipeline = ClientPipeline.of(config.protocol(), config.transport());
-
-        // TODO: Add an interceptor to throw service-specific exceptions (e.g., PersonDirectoryClientException).
         this.interceptor = ClientInterceptor.chain(config.interceptors());
-
         this.identityResolvers = IdentityResolvers.of(config.identityResolvers());
-
         this.typeRegistry = typeRegistry();
 
         if (config.retryStrategy() != null) {
@@ -184,7 +179,9 @@ public <T> B putConfigIfAbsent(Context.Key<T> key, T value) {
          */
         @SuppressWarnings("unchecked")
         public B withConfiguration(ClientConfig config) {
-            configBuilder.transport(config.transport())
+            configBuilder
+                    .service(config.service())
+                    .transport(config.transport())
                     .protocol(config.protocol())
                     .endpointResolver(config.endpointResolver())
                     .authSchemeResolver(config.authSchemeResolver())

client/client-core/src/main/java/software/amazon/smithy/java/client/core/ClientConfig.java

@@ -19,6 +19,7 @@
 import software.amazon.smithy.java.client.core.endpoint.EndpointResolver;
 import software.amazon.smithy.java.client.core.interceptors.ClientInterceptor;
 import software.amazon.smithy.java.context.Context;
+import software.amazon.smithy.java.core.schema.ApiService;
 import software.amazon.smithy.java.logging.InternalLogger;
 import software.amazon.smithy.java.retries.api.RetryStrategy;
 
@@ -48,6 +49,7 @@ public final class ClientConfig {
     private final List<IdentityResolver<?>> identityResolvers;
     private final Context context;
     private final Set<Class<? extends ClientPlugin>> appliedPlugins;
+    private final ApiService service;
 
     private final RetryStrategy retryStrategy;
     private final String retryScope;
@@ -86,6 +88,7 @@ private ClientConfig(Builder builder) {
 
         this.context = Context.unmodifiableCopy(builder.context);
         this.appliedPlugins = Collections.unmodifiableSet(new LinkedHashSet<>(builder.appliedPlugins));
+        this.service = Objects.requireNonNull(builder.service, "Missing required service schema");
     }
 
     /**
@@ -113,6 +116,15 @@ public Set<Class<? extends ClientPlugin>> appliedPlugins() {
         return appliedPlugins;
     }
 
+    /**
+     * Get the configured service schema.
+     *
+     * @return the service schema.
+     */
+    public ApiService service() {
+        return service;
+    }
+
     /**
      * @return Transport for client to use to send data to an endpoint.
      */
@@ -244,6 +256,7 @@ private void applyOverrides(Builder builder, RequestOverrideConfig overrideConfi
      * Static builder for ClientConfiguration.
      */
     public static final class Builder {
+        private ApiService service;
         private ClientTransport<?, ?> transport;
         private ClientProtocol<?, ?> protocol;
         private EndpointResolver endpointResolver;
@@ -258,6 +271,7 @@ public static final class Builder {
 
         private Builder copyBuilder() {
             Builder builder = new Builder();
+            builder.service = service;
             builder.transport = transport;
             builder.protocol = protocol;
             builder.endpointResolver = endpointResolver;
@@ -272,6 +286,13 @@ private Builder copyBuilder() {
             return builder;
         }
 
+        /**
+         * @return Get the service schema.
+         */
+        public ApiService service() {
+            return service;
+        }
+
         /**
          * @return Get the transport.
          */
@@ -342,6 +363,17 @@ public String retryScope() {
             return retryScope;
         }
 
+        /**
+         * Set the service schema.
+         *
+         * @param service The service schema.
+         * @return Returns the builder.
+         */
+        public Builder service(ApiService service) {
+            this.service = service;
+            return this;
+        }
+
         /**
          * Set the transport used to send requests.
          *

client/client-core/src/test/java/software/amazon/smithy/java/client/core/endpoint/EndpointResolverTest.java

@@ -11,6 +11,7 @@
 import org.hamcrest.Matchers;
 import org.junit.jupiter.api.Test;
 import software.amazon.smithy.java.core.schema.ApiOperation;
+import software.amazon.smithy.java.core.schema.ApiService;
 import software.amazon.smithy.java.core.schema.PreludeSchemas;
 import software.amazon.smithy.java.core.schema.Schema;
 import software.amazon.smithy.java.core.schema.SerializableStruct;
@@ -155,6 +156,11 @@ public TypeRegistry errorRegistry() {
         public List<ShapeId> effectiveAuthSchemes() {
             throw new UnsupportedOperationException();
         }
+
+        @Override
+        public ApiService service() {
+            return null;
+        }
     }
 
     private static final class TestOperationStaticPrefix implements
@@ -191,6 +197,11 @@ public Schema outputSchema() {
             throw new UnsupportedOperationException();
         }
 
+        @Override
+        public ApiService service() {
+            return null;
+        }
+
         @Override
         public TypeRegistry errorRegistry() {
             throw new UnsupportedOperationException();

client/client-core/src/test/java/software/amazon/smithy/java/client/core/interceptors/TestStructs.java

@@ -7,6 +7,7 @@
 
 import java.util.List;
 import software.amazon.smithy.java.core.schema.ApiOperation;
+import software.amazon.smithy.java.core.schema.ApiService;
 import software.amazon.smithy.java.core.schema.PreludeSchemas;
 import software.amazon.smithy.java.core.schema.Schema;
 import software.amazon.smithy.java.core.schema.SerializableStruct;
@@ -54,6 +55,11 @@ public TypeRegistry errorRegistry() {
         public List<ShapeId> effectiveAuthSchemes() {
             return List.of();
         }
+
+        @Override
+        public ApiService service() {
+            return null;
+        }
     };
 
     static final class Foo implements SerializableStruct {

client/client-core/src/test/java/software/amazon/smithy/java/client/core/pagination/models/PaginationService.java

@@ -0,0 +1,17 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package software.amazon.smithy.java.client.core.pagination.models;
+
+import software.amazon.smithy.java.core.schema.ApiService;
+import software.amazon.smithy.java.core.schema.Schema;
+import software.amazon.smithy.model.shapes.ShapeId;
+
+public final class PaginationService implements ApiService {
+    @Override
+    public Schema schema() {
+        return Schema.createService(ShapeId.from("smithy.example#Pagination"));
+    }
+}

client/client-core/src/test/java/software/amazon/smithy/java/client/core/pagination/models/TestOperationPaginated.java

@@ -7,6 +7,7 @@
 
 import java.util.List;
 import software.amazon.smithy.java.core.schema.ApiOperation;
+import software.amazon.smithy.java.core.schema.ApiService;
 import software.amazon.smithy.java.core.schema.Schema;
 import software.amazon.smithy.java.core.schema.ShapeBuilder;
 import software.amazon.smithy.java.core.serde.TypeRegistry;
@@ -57,4 +58,9 @@ public TypeRegistry errorRegistry() {
     public List<ShapeId> effectiveAuthSchemes() {
         throw new UnsupportedOperationException();
     }
+
+    @Override
+    public ApiService service() {
+        return new PaginationService();
+    }
 }

client/client-http/src/test/java/software/amazon/smithy/java/client/http/JavaHttpClientTest.java

@@ -19,6 +19,7 @@
 import software.amazon.smithy.java.aws.client.awsjson.AwsJson1Protocol;
 import software.amazon.smithy.java.client.core.ClientConfig;
 import software.amazon.smithy.java.client.core.endpoint.EndpointResolver;
+import software.amazon.smithy.java.core.schema.Schema;
 import software.amazon.smithy.model.shapes.ShapeId;
 
 public class JavaHttpClientTest {
@@ -82,6 +83,8 @@ public void automaticallyAppliesUserAgentPlugin() throws URISyntaxException {
         builder.protocol(new AwsJson1Protocol(ShapeId.from("foo#Bar")));
         builder.transport(new JavaHttpClientTransport());
         builder.endpointResolver(EndpointResolver.staticEndpoint(new URI("localhost:8080")));
+        var serviceSchema = Schema.createService(ShapeId.from("foo#Bar"));
+        builder.service(() -> serviceSchema);
         var config = builder.build();
 
         assertThat(config.interceptors(), not(empty()));

client/client-http/src/test/java/software/amazon/smithy/java/client/http/plugins/UserAgentPluginTest.java

@@ -20,6 +20,7 @@
 import software.amazon.smithy.java.client.core.interceptors.RequestHook;
 import software.amazon.smithy.java.context.Context;
 import software.amazon.smithy.java.core.schema.ApiOperation;
+import software.amazon.smithy.java.core.schema.ApiService;
 import software.amazon.smithy.java.core.schema.Schema;
 import software.amazon.smithy.java.core.schema.SerializableStruct;
 import software.amazon.smithy.java.core.schema.ShapeBuilder;
@@ -135,6 +136,11 @@ public Schema outputSchema() {
                 return null;
             }
 
+            @Override
+            public ApiService service() {
+                return null;
+            }
+
             @Override
             public TypeRegistry errorRegistry() {
                 return null;

client/client-waiters/src/test/java/software/amazon/smithy/java/client/waiters/models/TestOperationWaitable.java

@@ -7,6 +7,7 @@
 
 import java.util.List;
 import software.amazon.smithy.java.core.schema.ApiOperation;
+import software.amazon.smithy.java.core.schema.ApiService;
 import software.amazon.smithy.java.core.schema.Schema;
 import software.amazon.smithy.java.core.schema.ShapeBuilder;
 import software.amazon.smithy.java.core.serde.TypeRegistry;
@@ -49,4 +50,9 @@ public TypeRegistry errorRegistry() {
     public List<ShapeId> effectiveAuthSchemes() {
         throw new UnsupportedOperationException();
     }
+
+    @Override
+    public ApiService service() {
+        return new WaiterApiService();
+    }
 }

client/client-waiters/src/test/java/software/amazon/smithy/java/client/waiters/models/WaiterApiService.java

@@ -0,0 +1,17 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package software.amazon.smithy.java.client.waiters.models;
+
+import software.amazon.smithy.java.core.schema.ApiService;
+import software.amazon.smithy.java.core.schema.Schema;
+import software.amazon.smithy.model.shapes.ShapeId;
+
+public final class WaiterApiService implements ApiService {
+    @Override
+    public Schema schema() {
+        return Schema.createService(ShapeId.from("smithy.example#Waiter"));
+    }
+}

client/dynamic-client/src/main/java/software/amazon/smithy/java/dynamicclient/DynamicClient.java

@@ -25,6 +25,7 @@
 import software.amazon.smithy.java.core.error.CallException;
 import software.amazon.smithy.java.core.error.ModeledException;
 import software.amazon.smithy.java.core.schema.ApiOperation;
+import software.amazon.smithy.java.core.schema.ApiService;
 import software.amazon.smithy.java.core.schema.Schema;
 import software.amazon.smithy.java.core.schema.SerializableStruct;
 import software.amazon.smithy.java.core.serde.TypeRegistry;
@@ -70,11 +71,11 @@ public final class DynamicClient extends Client {
     private final Map<String, OperationShape> operationNames = new HashMap<>();
     private final TypeRegistry serviceErrorRegistry;
 
-    private DynamicClient(Builder builder, ServiceShape shape, Model model) {
+    private DynamicClient(Builder builder, SchemaConverter converter, ServiceShape shape, Model model) {
         super(builder);
         this.model = model;
         this.service = shape;
-        this.schemaConverter = new SchemaConverter(model);
+        this.schemaConverter = converter;
 
         // Create a lookup table of operation names to the operation shape IDs.
         for (var operation : TopDownIndex.of(model).getContainedOperations(service)) {
@@ -234,7 +235,7 @@ private ApiOperation<WrappedDocument, WrappedDocument> getApiOperation(String na
             }
 
             return new DynamicOperation(
-                    service.getId(),
+                    config().service(),
                     operationSchema,
                     inputSchema,
                     outputSchema,
@@ -264,7 +265,19 @@ public DynamicClient build() {
                 autoDetectProtocol();
             }
 
-            return new DynamicClient(this, shape, model);
+            var converter = new SchemaConverter(model);
+
+            // Create the schema for the service and put it in the config.
+            var serviceSchema = converter.getSchema(shape);
+            var apiService = new ApiService() {
+                @Override
+                public Schema schema() {
+                    return serviceSchema;
+                }
+            };
+            configBuilder().service(apiService);
+
+            return new DynamicClient(this, converter, shape, model);
         }
 
         @SuppressWarnings("unchecked")

client/dynamic-client/src/main/java/software/amazon/smithy/java/dynamicclient/DynamicOperation.java

@@ -8,6 +8,7 @@
 import java.util.List;
 import java.util.Set;
 import software.amazon.smithy.java.core.schema.ApiOperation;
+import software.amazon.smithy.java.core.schema.ApiService;
 import software.amazon.smithy.java.core.schema.Schema;
 import software.amazon.smithy.java.core.schema.ShapeBuilder;
 import software.amazon.smithy.java.core.schema.TraitKey;
@@ -18,7 +19,7 @@
 
 final class DynamicOperation implements ApiOperation<WrappedDocument, WrappedDocument> {
 
-    private final ShapeId service;
+    private final ApiService service;
     private final Schema operationSchema;
     private final Schema inputSchema;
     private final Schema outputSchema;
@@ -27,7 +28,7 @@ final class DynamicOperation implements ApiOperation<WrappedDocument, WrappedDoc
     private final List<ShapeId> effectiveAuthSchemes;
 
     public DynamicOperation(
-            ShapeId service,
+            ApiService service,
             Schema operationSchema,
             Schema inputSchema,
             Schema outputSchema,
@@ -59,6 +60,11 @@ public Schema schema() {
         return operationSchema;
     }
 
+    @Override
+    public ApiService service() {
+        return service;
+    }
+
     @Override
     public Schema inputSchema() {
         return inputSchema;
@@ -71,12 +77,12 @@ public Schema outputSchema() {
 
     @Override
     public ShapeBuilder<WrappedDocument> inputBuilder() {
-        return SchemaConverter.createDocumentBuilder(inputSchema(), service);
+        return SchemaConverter.createDocumentBuilder(inputSchema(), service.schema().id());
     }
 
     @Override
     public ShapeBuilder<WrappedDocument> outputBuilder() {
-        return SchemaConverter.createDocumentBuilder(outputSchema(), service);
+        return SchemaConverter.createDocumentBuilder(outputSchema(), service.schema().id());
     }
 
     @Override