Update for Smithy 1.0.0

This commit updates the build plugin to version 0.2.0.

This commit updates to the GA version of Smithy tooling. It includes
necessary updates to handle changes in protocol traits, enums, streaming
components, and other assorted breaks.

Minor updates to the HttpProtocolTestGenerator have been made so that
tests are generated for supported protocols even if not specified
explicitly in the smithy-build.json file.

A .travis.yml configuration file has also been added.

Author: kstich

.travis.yml

@@ -0,0 +1,14 @@
+language: java
+
+jdk:
+- oraclejdk8
+- openjdk8
+- openjdk11
+
+sudo: true
+
+dist: trusty
+
+install: /bin/true
+
+script: ./gradlew clean build -Plog-tests

build.gradle.kts

@@ -25,7 +25,7 @@ plugins {
 
 allprojects {
     group = "software.amazon.smithy"
-    version = "0.1.0"
+    version = "0.2.0"
 }
 
 // The root project doesn't produce a JAR.
@@ -204,6 +204,19 @@ subprojects {
 
         tasks["checkstyleTest"].enabled = false
 
+        /*
+         * Tests
+         * ====================================================
+         *
+         * Configure the running of tests.
+         */
+        // Log on passed, skipped, and failed test events if the `-Plog-tests` property is set.
+        if (project.hasProperty("log-tests")) {
+            tasks.test {
+                testLogging.events("passed", "skipped", "failed")
+            }
+        }
+
         /*
          * Code coverage
          * ====================================================

smithy-typescript-codegen-test/build.gradle.kts

@@ -19,7 +19,7 @@ extra["moduleName"] = "software.amazon.smithy.typescript.codegen.test"
 tasks["jar"].enabled = false
 
 plugins {
-    id("software.amazon.smithy").version("0.4.3")
+    id("software.amazon.smithy").version("0.5.1")
 }
 
 repositories {
@@ -29,5 +29,5 @@ repositories {
 
 dependencies {
     implementation(project(":smithy-typescript-codegen"))
-    implementation("software.amazon.smithy:smithy-protocol-test-traits:0.9.9")
+    implementation("software.amazon.smithy:smithy-protocol-test-traits:1.0.5")
 }

smithy-typescript-codegen-test/model/main.smithy

@@ -1,11 +1,11 @@
-$version: "0.4.0"
+$version: "1.0"
 namespace example.weather
 
 use smithy.test#httpRequestTests
 use smithy.test#httpResponseTests
 
 /// Provides weather forecasts.
-@protocols([{name: "aws.rest-json-1.1"}])
+@fakeProtocol
 @paginated(inputToken: "nextToken", outputToken: "nextToken", pageSize: "pageSize")
 service Weather {
     version: "2006-03-01",
@@ -18,6 +18,7 @@ resource City {
     read: GetCity,
     list: ListCities,
     resources: [Forecast, CityImage],
+    operations: [GetCityAnnouncements]
 }
 
 resource Forecast {
@@ -47,7 +48,7 @@ apply GetCity @httpRequestTests([
     {
         id: "WriteGetCityAssertions",
         documentation: "Does something",
-        protocol: "aws.rest-json-1.1",
+        protocol: "example.weather#fakeProtocol",
         method: "GET",
         uri: "/cities/123",
         body: "",
@@ -61,7 +62,7 @@ apply GetCity @httpResponseTests([
     {
         id: "WriteGetCityResponseAssertions",
         documentation: "Does something",
-        protocol: "aws.rest-json-1.1",
+        protocol: "example.weather#fakeProtocol",
         code: 200,
         body: """
             {
@@ -139,7 +140,7 @@ apply NoSuchResource @httpResponseTests([
     {
         id: "WriteNoSuchResourceAssertions",
         documentation: "Does something",
-        protocol: "aws.rest-json-1.1",
+        protocol: "example.weather#fakeProtocol",
         code: 404,
         body: """
             {
@@ -168,7 +169,7 @@ apply ListCities @httpRequestTests([
     {
         id: "WriteListCitiesAssertions",
         documentation: "Does something",
-        protocol: "aws.rest-json-1.1",
+        protocol: "example.weather#fakeProtocol",
         method: "GET",
         uri: "/cities",
         body: "",
@@ -241,6 +242,7 @@ structure GetForecastInput {
 
 structure GetForecastOutput {
     chanceOfRain: Float,
+    precipitation: Precipitation,
 }
 
 union Precipitation {
@@ -251,15 +253,16 @@ union Precipitation {
     mixed: TypedYesNo,
     other: OtherStructure,
     blob: Blob,
+    foo: example.weather.nested#Foo,
     baz: example.weather.nested.more#Baz,
 }
 
 structure OtherStructure {}
 
-@enum("YES": {}, "NO": {})
+@enum([{value: "YES"}, {value: "NO"}])
 string SimpleYesNo
 
-@enum("YES": {name: "YES"}, "NO": {name: "NO"})
+@enum([{value: "YES", name: "YES"}, {value: "NO", name: "NO"}])
 string TypedYesNo
 
 map StringMap {
@@ -281,9 +284,49 @@ structure GetCityImageInput {
 }
 
 structure GetCityImageOutput {
-    @streaming
     @httpPayload
     image: CityImageData,
 }
 
+@streaming
 blob CityImageData
+
+@readonly
+@http(method: "GET", uri: "/cities/{cityId}/announcements")
+operation GetCityAnnouncements {
+    input: GetCityAnnouncementsInput,
+    output: GetCityAnnouncementsOutput,
+    errors: [NoSuchResource]
+}
+
+
+structure GetCityAnnouncementsInput {
+    @required
+    @httpLabel
+    cityId: CityId,
+}
+
+structure GetCityAnnouncementsOutput {
+    @httpHeader("x-last-updated")
+    lastUpdated: Timestamp,
+
+    @httpPayload
+    announcements: Announcements
+}
+
+@streaming
+union Announcements {
+    police: Message,
+    fire: Message,
+    health: Message
+}
+
+structure Message {
+    message: String,
+    author: String
+}
+
+// Define a fake protocol trait for use.
+@trait
+@protocolDefinition
+structure fakeProtocol {}

smithy-typescript-codegen-test/model/more-nesting.smithy

@@ -1,4 +1,4 @@
-$version: "0.4.0"
+$version: "1.0"
 namespace example.weather.nested.more
 
 structure Baz {

smithy-typescript-codegen-test/model/nested.smithy

@@ -1,4 +1,4 @@
-$version: "0.4.0"
+$version: "1.0"
 namespace example.weather.nested
 
 structure Foo {

smithy-typescript-codegen-test/smithy-build.json

@@ -6,7 +6,6 @@
             "targetNamespace": "Weather",
             "package": "weather",
             "packageVersion": "0.0.1",
-            "protocol": "aws.rest-json-1.1",
             "packageJson": {
                 "license": "Apache-2.0"
             }

smithy-typescript-codegen/build.gradle.kts

@@ -18,6 +18,6 @@ extra["displayName"] = "Smithy :: Typescript :: Codegen"
 extra["moduleName"] = "software.amazon.smithy.typescript.codegen"
 
 dependencies {
-    api("software.amazon.smithy:smithy-codegen-core:0.9.9")
-    implementation("software.amazon.smithy:smithy-protocol-test-traits:0.9.9")
+    api("software.amazon.smithy:smithy-codegen-core:1.0.5")
+    implementation("software.amazon.smithy:smithy-protocol-test-traits:1.0.5")
 }

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CodegenVisitor.java

@@ -115,22 +115,22 @@ class CodegenVisitor extends ShapeVisitor.Default<Void> {
         writers = new TypeScriptDelegator(settings, model, fileManifest, symbolProvider, integrations);
     }
 
-    private static ProtocolGenerator resolveProtocolGenerator(
+    private ProtocolGenerator resolveProtocolGenerator(
             Collection<TypeScriptIntegration> integrations,
             ServiceShape service,
             TypeScriptSettings settings
     ) {
         // Collect all of the supported protocol generators.
-        Map<String, ProtocolGenerator> generators = new HashMap<>();
+        Map<ShapeId, ProtocolGenerator> generators = new HashMap<>();
         for (TypeScriptIntegration integration : integrations) {
             for (ProtocolGenerator generator : integration.getProtocolGenerators()) {
-                generators.put(generator.getName(), generator);
+                generators.put(generator.getProtocol(), generator);
             }
         }
 
-        String protocolName;
+        ShapeId protocolName;
         try {
-            protocolName = settings.resolveServiceProtocol(service, generators.keySet());
+            protocolName = settings.resolveServiceProtocol(model, service, generators.keySet());
         } catch (UnresolvableProtocolException e) {
             LOGGER.warning("Unable to find a protocol generator for " + service.getId() + ": " + e.getMessage());
             protocolName = null;
@@ -178,7 +178,10 @@ void execute() {
         IndexGenerator.writeIndex(settings, model, symbolProvider, fileManifest);
 
         // Generate protocol tests IFF found in the model.
-        new HttpProtocolTestGenerator(settings, model, symbolProvider, writers).run();
+        if (protocolGenerator != null) {
+            ShapeId protocol = protocolGenerator.getProtocol();
+            new HttpProtocolTestGenerator(settings, model, protocol, symbolProvider, writers).run();
+        }
 
         // Write each pending writer.
         LOGGER.fine("Flushing TypeScript writers");
@@ -256,7 +259,7 @@ public Void stringShape(StringShape shape) {
     @Override
     public Void serviceShape(ServiceShape shape) {
         if (!Objects.equals(service, shape)) {
-            LOGGER.fine(() -> "Skipping `" + service.getId() + "` because it is not `" + service.getId() + "`");
+            LOGGER.fine(() -> "Skipping `" + shape.getId() + "` because it is not `" + service.getId() + "`");
             return null;
         }
 

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CommandGenerator.java

@@ -25,6 +25,7 @@
 import software.amazon.smithy.model.shapes.MemberShape;
 import software.amazon.smithy.model.shapes.OperationShape;
 import software.amazon.smithy.model.shapes.ServiceShape;
+import software.amazon.smithy.model.shapes.Shape;
 import software.amazon.smithy.model.shapes.StructureShape;
 import software.amazon.smithy.model.traits.StreamingTrait;
 import software.amazon.smithy.typescript.codegen.integration.ProtocolGenerator;
@@ -172,11 +173,11 @@ private void addInputAndOutputTypes() {
     private void writeInputType(String typeName, Optional<StructureShape> inputShape) {
         if (inputShape.isPresent()) {
             StructureShape input = inputShape.get();
-            List<MemberShape> streamingMembers = getStreamingMembers(input);
-            if (streamingMembers.isEmpty()) {
+            List<MemberShape> blobStreamingMembers = getBlobStreamingMembers(input);
+            if (blobStreamingMembers.isEmpty()) {
                 writer.write("export type $L = $T;", typeName, symbolProvider.toSymbol(input));
             } else {
-                writeStreamingInputType(typeName, input, streamingMembers.get(0));
+                writeStreamingInputType(typeName, input, blobStreamingMembers.get(0));
             }
         } else {
             // If the input is non-existent, then use an empty object.
@@ -196,8 +197,14 @@ private void writeOutputType(String typeName, Optional<StructureShape> outputSha
         }
     }
 
-    private List<MemberShape> getStreamingMembers(StructureShape shape) {
-        return shape.getAllMembers().values().stream().filter(memberShape -> memberShape.hasTrait(StreamingTrait.class))
+    private List<MemberShape> getBlobStreamingMembers(StructureShape shape) {
+        return shape.getAllMembers().values().stream()
+                .filter(memberShape -> {
+                    // Streaming blobs need to have their types modified
+                    // See `writeStreamingInputType`
+                    Shape target = model.expectShape(memberShape.getTarget());
+                    return target.isBlobShape() && target.hasTrait(StreamingTrait.class);
+                })
                 .collect(Collectors.toList());
     }
 
@@ -209,11 +216,10 @@ private List<MemberShape> getStreamingMembers(StructureShape shape) {
      */
     private void writeStreamingInputType(String typeName, StructureShape inputShape, MemberShape streamingMember) {
         Symbol inputSymbol = symbolProvider.toSymbol(inputShape);
-        writer.openBlock("export type $L = Omit<$T, $S> & {", "};", typeName, inputSymbol,
-                streamingMember.getMemberName(), () -> {
-            writer.write("$1L$2L: $3T[$1S]|string|Uint8Array|Buffer;", streamingMember.getMemberName(),
-                    streamingMember.isRequired() ? "" : "?", inputSymbol);
-        });
+        String memberName = streamingMember.getMemberName();
+        String optionalSuffix = streamingMember.isRequired() ? "" : "?";
+        writer.openBlock("export type $L = Omit<$T, $S> & {", "};", typeName, inputSymbol, memberName, () ->
+            writer.write("$1L$2L: $3T[$1S]|string|Uint8Array|Buffer;", memberName, optionalSuffix, inputSymbol));
     }
 
     private void addCommandSpecificPlugins() {