codegen: use service closure to cache shape queries in schema generation (#1803)

* codegen: use service closure to cache shape queries in schema generation

* handle conflicting synthetic base exception name

Author: kuhe

Makefile

@@ -22,8 +22,8 @@ generate-protocol-tests:
 	yarn turbo run build -F="./private/*" --only
 
 test-protocols:
-	(cd ./private/smithy-rpcv2-cbor && npx vitest run --globals)
-	(cd ./private/smithy-rpcv2-cbor-schema && npx vitest run --globals)
+	(cd ./private/smithy-rpcv2-cbor && npx vitest run --globals && yarn test:index)
+	(cd ./private/smithy-rpcv2-cbor-schema && npx vitest run --globals && yarn test:index)
 
 test-unit:
 	yarn g:vitest run -c vitest.config.mts

private/my-local-model-schema/test/index-objects.spec.mjs

@@ -1,9 +1,14 @@
 import {
+  CodedThrottlingError,
   GetNumbersCommand,
+  HaltError,
+  MysteryThrottlingError,
+  RetryableError,
   TradeEventStreamCommand,
   XYZService,
   XYZServiceClient,
   XYZServiceServiceException,
+  XYZServiceSyntheticServiceException,
 } from "../dist-cjs/index.js";
 import assert from "node:assert";
 // clients
@@ -13,5 +18,10 @@ assert(typeof XYZService === "function");
 assert(typeof GetNumbersCommand === "function");
 assert(typeof TradeEventStreamCommand === "function");
 // errors
-assert(XYZServiceServiceException.prototype instanceof Error);
+assert(CodedThrottlingError.prototype instanceof XYZServiceSyntheticServiceException);
+assert(HaltError.prototype instanceof XYZServiceSyntheticServiceException);
+assert(MysteryThrottlingError.prototype instanceof XYZServiceSyntheticServiceException);
+assert(RetryableError.prototype instanceof XYZServiceSyntheticServiceException);
+assert(XYZServiceServiceException.prototype instanceof XYZServiceSyntheticServiceException);
+assert(XYZServiceSyntheticServiceException.prototype instanceof Error);
 console.log(`XYZService index test passed.`);

private/my-local-model-schema/test/index-types.ts

@@ -14,6 +14,10 @@ export type {
   TradeEvents,
   TradeEventStreamRequest,
   TradeEventStreamResponse,
-  Unit,
+  CodedThrottlingError,
+  HaltError,
+  MysteryThrottlingError,
+  RetryableError,
   XYZServiceServiceException,
+  XYZServiceSyntheticServiceException,
 } from "../dist-types/index.d";

private/smithy-rpcv2-cbor-schema/test/index-objects.spec.mjs

@@ -1,10 +1,12 @@
 import {
+  ComplexError,
   EmptyInputOutputCommand,
   Float16Command,
   FooEnum,
   FractionalSecondsCommand,
   GreetingWithErrorsCommand,
   IntegerEnum,
+  InvalidGreeting,
   NoInputOutputCommand,
   OperationWithDefaultsCommand,
   OptionalInputOutputCommand,
@@ -19,6 +21,7 @@ import {
   SparseNullsOperationCommand,
   TestEnum,
   TestIntEnum,
+  ValidationException,
 } from "../dist-cjs/index.js";
 import assert from "node:assert";
 // clients
@@ -44,5 +47,8 @@ assert(typeof TestIntEnum === "object");
 assert(typeof FooEnum === "object");
 assert(typeof IntegerEnum === "object");
 // errors
+assert(ValidationException.prototype instanceof RpcV2ProtocolServiceException);
+assert(ComplexError.prototype instanceof RpcV2ProtocolServiceException);
+assert(InvalidGreeting.prototype instanceof RpcV2ProtocolServiceException);
 assert(RpcV2ProtocolServiceException.prototype instanceof Error);
 console.log(`RpcV2Protocol index test passed.`);

private/smithy-rpcv2-cbor-schema/test/index-types.ts

@@ -45,7 +45,9 @@ export type {
   TestIntEnum,
   FooEnum,
   IntegerEnum,
+  ValidationExceptionField,
   ClientOptionalDefaults,
+  ComplexNestedErrorData,
   Defaults,
   EmptyStructure,
   Float16Output,
@@ -64,5 +66,8 @@ export type {
   SparseNullsOperationInputOutput,
   StructureListMember,
   GreetingStruct,
+  ValidationException,
+  ComplexError,
+  InvalidGreeting,
   RpcV2ProtocolServiceException,
 } from "../dist-types/index.d";

private/smithy-rpcv2-cbor/test/index-objects.spec.mjs

@@ -1,10 +1,12 @@
 import {
+  ComplexError,
   EmptyInputOutputCommand,
   Float16Command,
   FooEnum,
   FractionalSecondsCommand,
   GreetingWithErrorsCommand,
   IntegerEnum,
+  InvalidGreeting,
   NoInputOutputCommand,
   OperationWithDefaultsCommand,
   OptionalInputOutputCommand,
@@ -19,6 +21,7 @@ import {
   SparseNullsOperationCommand,
   TestEnum,
   TestIntEnum,
+  ValidationException,
 } from "../dist-cjs/index.js";
 import assert from "node:assert";
 // clients
@@ -44,5 +47,8 @@ assert(typeof TestIntEnum === "object");
 assert(typeof FooEnum === "object");
 assert(typeof IntegerEnum === "object");
 // errors
+assert(ValidationException.prototype instanceof RpcV2ProtocolServiceException);
+assert(ComplexError.prototype instanceof RpcV2ProtocolServiceException);
+assert(InvalidGreeting.prototype instanceof RpcV2ProtocolServiceException);
 assert(RpcV2ProtocolServiceException.prototype instanceof Error);
 console.log(`RpcV2Protocol index test passed.`);

private/smithy-rpcv2-cbor/test/index-types.ts

@@ -45,7 +45,9 @@ export type {
   TestIntEnum,
   FooEnum,
   IntegerEnum,
+  ValidationExceptionField,
   ClientOptionalDefaults,
+  ComplexNestedErrorData,
   Defaults,
   EmptyStructure,
   Float16Output,
@@ -64,5 +66,8 @@ export type {
   SparseNullsOperationInputOutput,
   StructureListMember,
   GreetingStruct,
+  ValidationException,
+  ComplexError,
+  InvalidGreeting,
   RpcV2ProtocolServiceException,
 } from "../dist-types/index.d";

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

@@ -30,7 +30,7 @@ public final class PackageApiValidationGenerator {
     private final TypeScriptSettings settings;
     private final Model model;
     private final SymbolProvider symbolProvider;
-    private final ServiceClosure serviceClosure;
+    private final ServiceClosure closure;
 
     public PackageApiValidationGenerator(
         TypeScriptWriter writer,
@@ -42,7 +42,7 @@ public PackageApiValidationGenerator(
         this.settings = settings;
         this.model = model;
         this.symbolProvider = symbolProvider;
-        serviceClosure = ServiceClosure.of(model, settings.getService(model));
+        closure = ServiceClosure.of(model, settings.getService(model));
     }
 
     /**
@@ -75,31 +75,32 @@ public void writeTypeIndexTest() {
                 }
 
                 // enums
-                TreeSet<Shape> enumShapes = serviceClosure.getEnums();
+                TreeSet<Shape> enumShapes = closure.getEnums();
                 for (Shape enumShape : enumShapes) {
                     writer.write("$L,", symbolProvider.toSymbol(enumShape).getName());
                 }
 
                 // structure & union types & modeled errors
-                TreeSet<Shape> structuralShapes = serviceClosure.getStructuralNonErrorShapes();
+                TreeSet<Shape> structuralShapes = closure.getStructuralNonErrorShapes();
                 for (Shape structuralShape : structuralShapes) {
                     writer.write("$L,", symbolProvider.toSymbol(structuralShape).getName());
                 }
 
-                TreeSet<Shape> errorShapes = serviceClosure.getErrorShapes();
+                TreeSet<Shape> errorShapes = closure.getErrorShapes();
                 for (Shape errorShape : errorShapes) {
                     writer.write("$L,", symbolProvider.toSymbol(errorShape).getName());
                 }
 
                 // synthetic base exception
-                writer.write("$L,", aggregateClientName + "ServiceException");
+                String baseExceptionName = CodegenUtils.getSyntheticBaseExceptionName(aggregateClientName, model);
+                writer.write("$L,", baseExceptionName);
 
                 // waiters
-                serviceClosure.getWaiterNames().forEach(waiter -> {
+                closure.getWaiterNames().forEach(waiter -> {
                     writer.write("$L,", waiter);
                 });
                 // paginators
-                serviceClosure.getPaginatorNames().forEach(paginator -> {
+                closure.getPaginatorNames().forEach(paginator -> {
                     writer.write("$L,", paginator);
                 });
             }
@@ -150,7 +151,7 @@ public void writeRuntimeIndexTest() {
 
         // string shapes with enum trait do not generate anything if
         // any enum value does not have a name.
-        TreeSet<Shape> enumShapes = serviceClosure.getEnums().stream()
+        TreeSet<Shape> enumShapes = closure.getEnums().stream()
             .filter(shape -> shape
                 .getTrait(EnumTrait.class)
                 .map(EnumTrait::hasNames)
@@ -169,11 +170,11 @@ public void writeRuntimeIndexTest() {
             );
         }
 
-        String baseExceptionName = aggregateClientName + "ServiceException";
+        String baseExceptionName = CodegenUtils.getSyntheticBaseExceptionName(aggregateClientName, model);
 
         // modeled errors and synthetic base error
         writer.write("// errors");
-        TreeSet<Shape> errors = serviceClosure.getErrorShapes();
+        TreeSet<Shape> errors = closure.getErrorShapes();
         for (Shape error : errors) {
             Symbol errorSymbol = symbolProvider.toSymbol(error);
             writer.addRelativeImport(errorSymbol.getName(), null, cjsIndex);
@@ -187,7 +188,7 @@ public void writeRuntimeIndexTest() {
         writer.write("assert($L.prototype instanceof Error);", baseExceptionName);
 
         // waiters & paginators
-        TreeSet<String> waiterNames = serviceClosure.getWaiterNames();
+        TreeSet<String> waiterNames = closure.getWaiterNames();
         if (!waiterNames.isEmpty()) {
             writer.write("// waiters");
         }
@@ -198,7 +199,7 @@ public void writeRuntimeIndexTest() {
                 waiter
             );
         });
-        TreeSet<String> paginatorNames = serviceClosure.getPaginatorNames();
+        TreeSet<String> paginatorNames = closure.getPaginatorNames();
         if (!paginatorNames.isEmpty()) {
             writer.write("// paginators");
         }