Create and use ServerSerdeContext interface

Author: JordonPhillips

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

@@ -180,8 +180,8 @@ private void writeErrorChecker() {
     }
 
     private void writeErrorHandler() {
-        writer.addImport("SerdeContext", null, "@aws-sdk/types");
-        writer.openBlock("serializeError(error: $T, ctx: Omit<SerdeContext, 'endpoint'>): Promise<$T> {", "}",
+        writer.addImport("ServerSerdeContext", null, "@aws-smithy/server-common");
+        writer.openBlock("serializeError(error: $T, ctx: ServerSerdeContext): Promise<$T> {", "}",
                 errorsType, applicationProtocol.getResponseType(), () -> {
             if (operation.getErrors().isEmpty()) {
                 writer.write("throw error;");

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

@@ -52,6 +52,7 @@ static void generateServiceHandler(SymbolProvider symbolProvider,
         Symbol serviceSymbol = symbolProvider.toSymbol(serviceShape);
         Symbol handlerSymbol = serviceSymbol.expectProperty("handler", Symbol.class);
         Symbol operationsType = serviceSymbol.expectProperty("operations", Symbol.class);
+        writer.addImport("ServerSerdeContext", null, "@aws-smithy/server-common");
 
         writeSerdeContextBase(writer);
         writeHandleFunction(writer);
@@ -62,7 +63,7 @@ static void generateServiceHandler(SymbolProvider symbolProvider,
             writer.write("private serializerFactory: <T extends $T>(operation: T) => "
                             + "__OperationSerializer<$T, T, __SmithyException>;", operationsType, serviceSymbol);
             writer.write("private serializeFrameworkException: (e: __SmithyFrameworkException, "
-                            + "ctx: Omit<SerdeContext, 'endpoint'>) => Promise<__HttpResponse>;");
+                            + "ctx: ServerSerdeContext) => Promise<__HttpResponse>;");
             writer.writeDocs(() -> {
                 writer.write("Construct a $T handler.", serviceSymbol);
                 writer.write("@param service The {@link $1T} implementation that supplies the business logic for $1T",
@@ -81,8 +82,8 @@ static void generateServiceHandler(SymbolProvider symbolProvider,
                 writer.write("mux: __Mux<$S, $T>,", serviceShape.getId().getName(), operationsType);
                 writer.write("serializerFactory:<T extends $T>(op: T) => "
                                 + "__OperationSerializer<$T, T, __SmithyException>,", operationsType, serviceSymbol);
-                writer.write("serializeFrameworkException: (e: __SmithyFrameworkException, ctx: Omit<SerdeContext, "
-                        + "'endpoint'>) => Promise<__HttpResponse>");
+                writer.write("serializeFrameworkException: (e: __SmithyFrameworkException, ctx: ServerSerdeContext) => "
+                        + "Promise<__HttpResponse>");
             });
             writer.indent();
             writer.write("this.service = service;");
@@ -127,14 +128,15 @@ static void generateOperationHandler(SymbolProvider symbolProvider,
         Symbol outputSymbol = operationSymbol.expectProperty("outputType", Symbol.class);
         Symbol handlerSymbol = operationSymbol.expectProperty("handler", Symbol.class);
         Symbol errorsSymbol = operationSymbol.expectProperty("errorsType", Symbol.class);
+        writer.addImport("ServerSerdeContext", null, "@aws-smithy/server-common");
 
         writer.openBlock("export class $L implements __ServiceHandler {", "}", handlerSymbol.getName(), () -> {
             writer.write("private operation: __Operation<$T, $T>;", inputSymbol, outputSymbol);
             writer.write("private mux: __Mux<$S, $S>;", serviceShape.getId().getName(), operationName);
             writer.write("private serializer: __OperationSerializer<$T, $S, $T>;",
                     serviceSymbol, operationName, errorsSymbol);
             writer.write("private serializeFrameworkException: (e: __SmithyFrameworkException, "
-                    + "ctx: Omit<SerdeContext, 'endpoint'>) => Promise<__HttpResponse>;");
+                    + "ctx: ServerSerdeContext) => Promise<__HttpResponse>;");
             writer.writeDocs(() -> {
                 writer.write("Construct a $T handler.", operationSymbol);
                 writer.write("@param service The {@link __Operation} implementation that supplies the business "
@@ -152,8 +154,8 @@ static void generateOperationHandler(SymbolProvider symbolProvider,
                 writer.write("mux: __Mux<$S, $S>,", serviceShape.getId().getName(), operationName);
                 writer.write("serializer: __OperationSerializer<$T, $S, $T>,",
                         serviceSymbol, operationName, errorsSymbol);
-                writer.write("serializeFrameworkException: (e: __SmithyFrameworkException, ctx: Omit<SerdeContext, "
-                        + "'endpoint'>) => Promise<__HttpResponse>");
+                writer.write("serializeFrameworkException: (e: __SmithyFrameworkException, ctx: ServerSerdeContext) => "
+                        + "Promise<__HttpResponse>");
             });
             writer.indent();
             writer.write("this.operation = operation;");
@@ -198,7 +200,7 @@ private static void writeHandleFunction(TypeScriptWriter writer) {
             writer.write("serializer: __OperationSerializer<S, O, __SmithyException>,");
             writer.write("operation: __Operation<__OperationInput<S[O]>, __OperationOutput<S[O]>>,");
             writer.write("serializeFrameworkException: (e: __SmithyFrameworkException, "
-                    + "ctx: Omit<SerdeContext, 'endpoint'>) => Promise<__HttpResponse>");
+                    + "ctx: ServerSerdeContext) => Promise<__HttpResponse>");
         });
         writer.indent();
         writer.write("let input;");

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/HttpBindingProtocolGenerator.java

@@ -218,10 +218,11 @@ public void generateFrameworkErrorSerializer(GenerationContext inputContext) {
 
         writer.addImport("SmithyFrameworkException", "__SmithyFrameworkException", "@aws-smithy/server-common");
         writer.addUseImports(responseType);
+        writer.addImport("ServerSerdeContext", null, "@aws-smithy/server-common");
 
         writer.openBlock("export const serializeFrameworkException = async(\n"
                 + "  input: __SmithyFrameworkException,\n"
-                + "  ctx: Omit<__SerdeContext, 'endpoint'>\n"
+                + "  ctx: ServerSerdeContext\n"
                 + "): Promise<$T> => {", "}", responseType, () -> {
 
             writeEmptyEndpoint(context);
@@ -419,10 +420,11 @@ private void generateOperationResponseSerializer(
         String methodName = ProtocolGenerator.getGenericSerFunctionName(symbol) + "Response";
         Symbol outputType = symbol.expectProperty("outputType", Symbol.class);
         String contextType = CodegenUtils.getOperationSerializerContextType(writer, context.getModel(), operation);
+        writer.addImport("ServerSerdeContext", null, "@aws-smithy/server-common");
 
         writer.openBlock("export const $L = async(\n"
                 + "  input: $T,\n"
-                + "  ctx: Omit<$L, 'endpoint'>\n"
+                + "  ctx: ServerSerdeContext\n"
                 + "): Promise<$T> => {", "}", methodName, outputType, contextType, responseType, () -> {
             writeEmptyEndpoint(context);
             writeOperationStatusCode(context, operation, bindingIndex, trait);
@@ -459,10 +461,11 @@ private void generateErrorSerializer(GenerationContext context, StructureShape e
 
         writer.addUseImports(responseType);
         String methodName = ProtocolGenerator.getGenericSerFunctionName(symbol) + "Error";
+        writer.addImport("ServerSerdeContext", null, "@aws-smithy/server-common");
 
         writer.openBlock("export const $L = async(\n"
                 + "  input: $T,\n"
-                + "  ctx: Omit<__SerdeContext, 'endpoint'>\n"
+                + "  ctx: ServerSerdeContext\n"
                 + "): Promise<$T> => {", "}", methodName, symbol, responseType, () -> {
             writeEmptyEndpoint(context);
             generateErrorSerializationImplementation(context, error, responseType, bindingIndex);

smithy-typescript-ssdk-libs/server-common/src/index.ts

@@ -26,10 +26,10 @@ export type OperationInput<T> = T extends Operation<infer I, any> ? I : never;
 export type OperationOutput<T> = T extends Operation<any, infer O> ? O : never;
 
 export interface OperationSerializer<T, K extends keyof T, E extends SmithyException> {
-  serialize(input: OperationOutput<T[K]>, ctx: Omit<SerdeContext, "endpoint">): Promise<HttpResponse>;
+  serialize(input: OperationOutput<T[K]>, ctx: ServerSerdeContext): Promise<HttpResponse>;
   deserialize(input: HttpRequest, ctx: SerdeContext): Promise<OperationInput<T[K]>>;
   isOperationError(error: any): error is E;
-  serializeError(error: E, ctx: Omit<SerdeContext, "endpoint">): Promise<HttpResponse>;
+  serializeError(error: E, ctx: ServerSerdeContext): Promise<HttpResponse>;
 }
 
 export interface ServiceHandler<RequestType = HttpRequest, ResponseType = HttpResponse> {
@@ -43,3 +43,5 @@ export interface ServiceCoordinate<S extends string, O extends string> {
 export interface Mux<S extends string, O extends string> {
   match(req: HttpRequest): ServiceCoordinate<S, O> | undefined;
 }
+
+export interface ServerSerdeContext extends Omit<SerdeContext, "endpoint"> {}