Add TraceFile creation

Author: Ethan Trepka

smithy-typescript-codegen/build.gradle.kts

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License").
  * You may not use this file except in compliance with the License.
@@ -18,6 +18,7 @@ extra["displayName"] = "Smithy :: Typescript :: Codegen"
 extra["moduleName"] = "software.amazon.smithy.typescript.codegen"
 
 dependencies {
-    api("software.amazon.smithy:smithy-codegen-core:[1.0.8, 2.0[")
+    api("software.amazon.smithy:smithy-codegen-core:[1.0.10, 2.0[")
+    api("software.amazon.smithy:smithy-aws-traits:[1.0.8, 2.0[")
     implementation("software.amazon.smithy:smithy-protocol-test-traits:[1.0.8, 2.0[")
 }

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

@@ -26,17 +26,23 @@
 import java.util.ServiceLoader;
 import java.util.Set;
 import java.util.TreeSet;
+import java.util.UUID;
 import java.util.logging.Logger;
 
+import software.amazon.smithy.aws.traits.ServiceTrait;
 import software.amazon.smithy.build.FileManifest;
 import software.amazon.smithy.build.PluginContext;
 import software.amazon.smithy.codegen.core.CodegenException;
 import software.amazon.smithy.codegen.core.Symbol;
 import software.amazon.smithy.codegen.core.SymbolDependency;
 import software.amazon.smithy.codegen.core.SymbolProvider;
+import software.amazon.smithy.codegen.core.trace.ArtifactDefinitions;
+import software.amazon.smithy.codegen.core.trace.TraceMetadata;
+import software.amazon.smithy.codegen.core.trace.TracingSymbolProvider;
 import software.amazon.smithy.model.Model;
 import software.amazon.smithy.model.knowledge.TopDownIndex;
 import software.amazon.smithy.model.neighbor.Walker;
+import software.amazon.smithy.model.node.Node;
 import software.amazon.smithy.model.shapes.MemberShape;
 import software.amazon.smithy.model.shapes.OperationShape;
 import software.amazon.smithy.model.shapes.ServiceShape;
@@ -100,21 +106,59 @@ class CodegenVisitor extends ShapeVisitor.Default<Void> {
                         runtimePlugins.add(runtimePlugin);
                     });
                 });
+
         // Sort the integrations in specified order.
         integrations.sort(Comparator.comparingInt(TypeScriptIntegration::getOrder));
 
+        // Resolve the nullable protocol generator and application protocol.
+        protocolGenerator = resolveProtocolGenerator(integrations, service, settings);
+        applicationProtocol = protocolGenerator == null
+                ? ApplicationProtocol.createDefaultHttpApplicationProtocol()
+                : protocolGenerator.getApplicationProtocol();
+
         // Decorate the symbol provider using integrations.
         SymbolProvider resolvedProvider = TypeScriptCodegenPlugin.createSymbolProvider(model);
         for (TypeScriptIntegration integration : integrations) {
             resolvedProvider = integration.decorateSymbolProvider(settings, model, resolvedProvider);
         }
-        symbolProvider = SymbolProvider.cache(resolvedProvider);
 
-        // Resolve the nullable protocol generator and application protocol.
-        protocolGenerator = resolveProtocolGenerator(integrations, service, settings);
-        applicationProtocol = protocolGenerator == null
-                ? ApplicationProtocol.createDefaultHttpApplicationProtocol()
-                : protocolGenerator.getApplicationProtocol();
+        //Make the symbol provider a cachingSymbolProvider
+        SymbolProvider cachedProvider = SymbolProvider.cache(resolvedProvider);
+        // Defining Definitions for TraceFile Generation
+        ArtifactDefinitions artifactDefinitions = ArtifactDefinitions.builder()
+                .addType(TypeScriptShapeLinkProvider.FIELD_TYPE,
+                        "Field declaration (includes enum constants)")
+                .addType(TypeScriptShapeLinkProvider.METHOD_TYPE, "Method declaration")
+                .addType(TypeScriptShapeLinkProvider.TYPE_TYPE,
+                        "Class, interface (including annotation type), or enum declaration")
+                .addTag(TypeScriptShapeLinkProvider.SERVICE_TAG, "Service client")
+                .addTag(TypeScriptShapeLinkProvider.REQUEST_TAG, "AWS SDK request type")
+                .addTag(TypeScriptShapeLinkProvider.RESPONSE_TAG, "AWS SDK response type")
+                .addTag(TypeScriptShapeLinkProvider.SERIALIZER_TAG, "Command serializer")
+                .addTag(TypeScriptShapeLinkProvider.DESERIALIZER_TAG, "Command deserializer")
+                .build();
+
+        String serviceId;
+        if (service.hasTrait(ServiceTrait.class)) {
+            serviceId = service.getTrait(ServiceTrait.class).get().getSdkId();
+        } else {
+            serviceId = service.getId().getName();
+        }
+        TraceMetadata artifactMetadata = TraceMetadata.builder()
+                .setTimestampAsNow()
+                .id(serviceId)
+                .version(UUID.randomUUID().toString())
+                .type("TypeScript")
+                .build();
+
+
+        // Decorate the symbol provider using the trace file generator
+        symbolProvider = TracingSymbolProvider.builder()
+                .symbolProvider(cachedProvider)
+                .metadata(artifactMetadata)
+                .artifactDefinitions(artifactDefinitions)
+                .shapeLinkCreator(new TypeScriptShapeLinkProvider())
+                .build();
 
         writers = new TypeScriptDelegator(settings, model, fileManifest, symbolProvider, integrations);
     }
@@ -187,6 +231,13 @@ void execute() {
             new HttpProtocolTestGenerator(settings, model, protocol, symbolProvider, writers).run();
         }
 
+        // Write the TraceFile.
+        TracingSymbolProvider traceProvider = (TracingSymbolProvider) symbolProvider;
+        String traceName = symbolProvider.toSymbol(service).getName().replace("Client", "")
+                .toLowerCase() + ".trace.json";
+        fileManifest.writeFile(traceName,
+                Node.prettyPrintJson(traceProvider.buildTraceFile().toNode()));
+
         // Write each pending writer.
         LOGGER.fine("Flushing TypeScript writers");
         List<SymbolDependency> dependencies = writers.getDependencies();
@@ -284,8 +335,9 @@ public Void serviceShape(ServiceShape shape) {
         boolean hasPaginatedOperation = false;
 
         for (OperationShape operation : containedOperations) {
+            OperationShape finalOperation = operation;
             writers.useShapeWriter(operation, commandWriter -> new CommandGenerator(
-                    settings, model, operation, symbolProvider, commandWriter,
+                    settings, model, finalOperation, symbolProvider, commandWriter,
                     runtimePlugins, protocolGenerator, applicationProtocol).run());
             if (operation.hasTrait(PaginatedTrait.ID)) {
                 hasPaginatedOperation = true;

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

@@ -231,6 +231,7 @@ public Symbol operationShape(OperationShape shape) {
         // Add input and output type symbols (XCommandInput / XCommandOutput).
         builder.putProperty("inputType", intermediate.toBuilder().name(commandName + "Input").build());
         builder.putProperty("outputType", intermediate.toBuilder().name(commandName + "Output").build());
+
         return builder.build();
     }
 
@@ -308,14 +309,20 @@ private Symbol.Builder addSmithyUseImport(Symbol.Builder builder, String name, S
 
     @Override
     public Symbol unionShape(UnionShape shape) {
-        return createObjectSymbolBuilder(shape).build();
+        return createObjectSymbolBuilder(shape)
+                .putProperty("SymbolProvider", this)
+                .build();
     }
 
     @Override
     public Symbol memberShape(MemberShape shape) {
         Shape targetShape = model.getShape(shape.getTarget())
                 .orElseThrow(() -> new CodegenException("Shape not found: " + shape.getTarget()));
-        Symbol targetSymbol = toSymbol(targetShape);
+        Symbol targetSymbol = toSymbol(targetShape)
+                .toBuilder()
+                .putProperty("model", model)
+                .putProperty("SymbolProvider", this)
+                .build();
 
         if (targetSymbol.getProperties().containsKey(EnumTrait.class.getName())) {
             return createMemberSymbolWithEnumTarget(targetSymbol);
@@ -363,14 +370,20 @@ private Symbol.Builder createObjectSymbolBuilder(Shape shape) {
     }
 
     private Symbol.Builder createSymbolBuilder(Shape shape, String typeName) {
-        return Symbol.builder().putProperty("shape", shape).name(typeName);
+        return Symbol.builder()
+                .putProperty("shape", shape)
+                .putProperty("traceFileNamespace", formatModuleName(shape.getType(), null))
+                .putProperty("traceFileNamespaceDelimiter", "/")
+                .name(typeName);
     }
 
     private Symbol.Builder createSymbolBuilder(Shape shape, String typeName, String namespace) {
         return Symbol.builder()
                 .putProperty("shape", shape)
                 .name(typeName)
-                .namespace(namespace, "/");
+                .namespace(namespace, "/")
+                .putProperty("traceFileNamespace", formatModuleName(shape.getType(), null))
+                .putProperty("traceFileNamespaceDelimiter", "/");
     }
 
     private Symbol.Builder createGeneratedSymbolBuilder(Shape shape, String typeName, String namespace) {