Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: response structure and base service exception #757

Merged
merged 2 commits into from
May 3, 2023
Merged

docs: response structure and base service exception #757

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0fea156
docs: response structure and base service exception
MYoung25 May 1, 2023
7208389
change comment style for structural examples
MYoung25 May 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions ...escript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CodegenUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,12 @@
import java.util.stream.Collectors;
import software.amazon.smithy.codegen.core.CodegenException;
import software.amazon.smithy.codegen.core.Symbol;
import software.amazon.smithy.codegen.core.SymbolProvider;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.knowledge.EventStreamIndex;
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;
Expand Down Expand Up @@ -237,4 +239,17 @@ static void writeInlineStreamingMemberType(
writer.writeInline("Omit<$1T, $2S> & { $2L$3L: $1T[$2S]|string|Uint8Array|Buffer }",
containerSymbol, memberName, optionalSuffix);
}

public static String getServiceName(
TypeScriptSettings settings,
Model model,
SymbolProvider symbolProvider
) {
ServiceShape service = settings.getService(model);
return symbolProvider.toSymbol(service).getName().replaceAll("(Client)$", "");
}

public static String getServiceExceptionName(String serviceName) {
return serviceName + "ServiceException";
}
}
12 changes: 10 additions & 2 deletions ...ipt-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CommandGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,10 +177,13 @@ private String getCommandExample(String serviceName, String configName, String c
+ String.format("const client = new %s(config);%n", serviceName)
+ String.format("const input = %s%n",
StructureExampleGenerator.generateStructuralHintDocumentation(
model.getShape(operation.getInputShape()).get(), model))
model.getShape(operation.getInputShape()).get(), model, false))
+ String.format("const command = new %s(input);%n", commandName)
+ "const response = await client.send(command);\n"
+ "```\n"
+ String.format("%s%n",
StructureExampleGenerator.generateStructuralHintDocumentation(
model.getShape(operation.getOutputShape()).get(), model, true))
+ "\n```\n"
MYoung25 marked this conversation as resolved.
Show resolved Hide resolved
+ "\n"
+ String.format("@param %s - {@link %s}%n", commandInput, commandInput)
+ String.format("@returns {@link %s}%n", commandOutput)
Expand All @@ -206,6 +209,11 @@ private String getThrownExceptions() {
}
buffer.append("\n\n");
}

String name = CodegenUtils.getServiceName(settings, model, symbolProvider);
buffer.append(String.format("@throws {@link %s}%n", CodegenUtils.getServiceExceptionName(name)));
buffer.append(String.format("<p>Base exception class for all service exceptions from %s service.</p>%n", name));

return buffer.toString();
}

Expand Down
6 changes: 3 additions & 3 deletions ...va/software/amazon/smithy/typescript/codegen/documentation/StructureExampleGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public abstract class StructureExampleGenerator {
* };
* ```
*/
public static String generateStructuralHintDocumentation(Shape shape, Model model) {
public static String generateStructuralHintDocumentation(Shape shape, Model model, boolean isComment) {
StringBuilder buffer = new StringBuilder();
shape(shape, buffer, model, 0, new ShapeTracker());

Expand All @@ -56,9 +56,9 @@ public static String generateStructuralHintDocumentation(Shape shape, Model mode
"([\\w\\\",:\\[\\{] )\\s+",
"$1")
.replaceAll("\\s+$", ""))
.collect(Collectors.joining("\n"));
.collect(Collectors.joining((isComment) ? "\n// " : "\n"));

return s.replaceAll(",$", ";");
return ((isComment) ? "// " : "") + s.replaceAll(",$", ";");
}

private static void structure(StructureShape structureShape,
Expand Down
25 changes: 6 additions & 19 deletions ...a/software/amazon/smithy/typescript/codegen/integration/AddBaseServiceExceptionClass.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
import software.amazon.smithy.codegen.core.SymbolProvider;
import software.amazon.smithy.codegen.core.SymbolReference;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.shapes.ServiceShape;
import software.amazon.smithy.model.traits.ErrorTrait;
import software.amazon.smithy.typescript.codegen.CodegenUtils;
import software.amazon.smithy.typescript.codegen.TypeScriptCodegenContext;
Expand Down Expand Up @@ -59,8 +58,8 @@ private void writeAdditionalFiles(
) {
boolean isClientSdk = settings.generateClient();
if (isClientSdk) {
String serviceName = getServiceName(settings, model, symbolProvider);
String serviceExceptionName = getServiceExceptionName(serviceName);
String serviceName = CodegenUtils.getServiceName(settings, model, symbolProvider);
String serviceExceptionName = CodegenUtils.getServiceExceptionName(serviceName);
writerFactory.accept(
Paths.get(CodegenUtils.SOURCE_FOLDER, "models", serviceExceptionName + ".ts").toString(),
writer -> {
Expand Down Expand Up @@ -89,8 +88,8 @@ private void writeAdditionalExports(
) {
boolean isClientSdk = settings.generateClient();
if (isClientSdk) {
String serviceName = getServiceName(settings, model, symbolProvider);
String serviceExceptionName = getServiceExceptionName(serviceName);
String serviceName = CodegenUtils.getServiceName(settings, model, symbolProvider);
String serviceExceptionName = CodegenUtils.getServiceExceptionName(serviceName);
writer.write("export { $1L } from \"./models/$1L\";", serviceExceptionName);
}
}
Expand All @@ -110,11 +109,11 @@ public SymbolProvider decorateSymbolProvider(
return shape -> {
Symbol symbol = symbolProvider.toSymbol(shape);
if (shape.hasTrait(ErrorTrait.class)) {
String serviceName = getServiceName(settings, model, symbolProvider);
String serviceName = CodegenUtils.getServiceName(settings, model, symbolProvider);
String baseExceptionAlias = "__BaseException";
SymbolReference reference;
if (settings.generateClient()) {
String serviceExceptionName = getServiceExceptionName(serviceName);
String serviceExceptionName = CodegenUtils.getServiceExceptionName(serviceName);
String namespace = Paths.get(".", "src", "models", serviceExceptionName).toString();
Symbol serviceExceptionSymbol = Symbol.builder()
.name(serviceExceptionName)
Expand All @@ -138,16 +137,4 @@ public SymbolProvider decorateSymbolProvider(
};
}

private String getServiceName(
TypeScriptSettings settings,
Model model,
SymbolProvider symbolProvider
) {
ServiceShape service = settings.getService(model);
return symbolProvider.toSymbol(service).getName().replaceAll("(Client)$", "");
}

private String getServiceExceptionName(String serviceName) {
return serviceName + "ServiceException";
}
}
50 changes: 47 additions & 3 deletions ...oftware/amazon/smithy/typescript/codegen/documentation/StructureExampleGeneratorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ public class StructureExampleGeneratorTest {
@Test
public void generatesStructuralHintDocumentation_map() {
assertThat(
StructureExampleGenerator.generateStructuralHintDocumentation(map, model),
StructureExampleGenerator.generateStructuralHintDocumentation(map, model, false),
equalTo("""
{ // map
"<keys>": "STRING_VALUE",
Expand All @@ -104,7 +104,7 @@ public void generatesStructuralHintDocumentation_map() {
@Test
public void generatesStructuralHintDocumentation_structure() {
assertThat(
StructureExampleGenerator.generateStructuralHintDocumentation(structure, model),
StructureExampleGenerator.generateStructuralHintDocumentation(structure, model, false),
equalTo("""
{ // structure
string: "STRING_VALUE",
Expand Down Expand Up @@ -144,11 +144,55 @@ public void generatesStructuralHintDocumentation_structure() {
},
};"""));
}

@Test
public void generatesStructuralHintDocumentation_structure_asComment() {
assertThat(
StructureExampleGenerator.generateStructuralHintDocumentation(structure, model, true),
equalTo("""
// { // structure
// string: "STRING_VALUE",
// list: [ // list
// "STRING_VALUE",
// ],
// map: { // map
// "<keys>": "STRING_VALUE",
// },
// list2: [
// "STRING_VALUE",
// ],
// list3: [
// "STRING_VALUE",
// ],
// list4: [
// "STRING_VALUE",
// ],
// list5: [
// "STRING_VALUE",
// ],
// list6: "<list>",
// list7: "<list>",
// structure: {
// string: "STRING_VALUE",
// list: "<list>",
// map: {
// "<keys>": "STRING_VALUE",
// },
// list2: "<list>",
// list3: "<list>",
// list4: "<list>",
// list5: "<list>",
// list6: "<list>",
// list7: "<list>",
// structure: "<structure>",
// },
// };"""));
}

@Test
public void generatesStructuralHintDocumentation_list() {
assertThat(
StructureExampleGenerator.generateStructuralHintDocumentation(list, model),
StructureExampleGenerator.generateStructuralHintDocumentation(list, model, false),
equalTo("""
[ // list
"STRING_VALUE",
Expand Down