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

Jump to bottom

[ggj][codegen] fix: sort method signatures at proto parse time #385

Merged
merged 1 commit into from
Oct 9, 2020
Merged

[ggj][codegen] fix: sort method signatures at proto parse time #385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 1 addition & 21 deletions src/main/java/com/google/api/generator/gapic/composer/ServiceClientClassComposer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -503,27 +503,7 @@ private static List<MethodDefinition> createMethodVariants(
}

String methodInputTypeName = methodInputType.reference().name();

// Make the method signature order deterministic, which helps with unit testing and per-version
// diffs.
List<List<MethodArgument>> sortedMethodSignatures =
method.methodSignatures().stream()
.sorted(
(s1, s2) -> {
if (s1.size() != s2.size()) {
return s1.size() - s2.size();
}
for (int i = 0; i < s1.size(); i++) {
int compareVal = s1.get(i).compareTo(s2.get(i));
if (compareVal != 0) {
return compareVal;
}
}
return 0;
})
.collect(Collectors.toList());

for (List<MethodArgument> signature : sortedMethodSignatures) {
for (List<MethodArgument> signature : method.methodSignatures()) {
// Get the argument list.
List<VariableExpr> arguments =
signature.stream()
Expand Down
26 changes: 3 additions & 23 deletions src/main/java/com/google/api/generator/gapic/composer/ServiceClientTestClassComposer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,31 +437,11 @@ private static List<MethodDefinition> createTestMethods(
resourceNames,
messageTypes));
} else {
// Make the method signature order deterministic, which helps with unit testing and
// per-version
// diffs.
List<List<MethodArgument>> sortedMethodSignatures =
method.methodSignatures().stream()
.sorted(
(s1, s2) -> {
if (s1.size() != s2.size()) {
return s1.size() - s2.size();
}
for (int i = 0; i < s1.size(); i++) {
int compareVal = s1.get(i).compareTo(s2.get(i));
if (compareVal != 0) {
return compareVal;
}
}
return 0;
})
.collect(Collectors.toList());

for (int i = 0; i < sortedMethodSignatures.size(); i++) {
for (int i = 0; i < method.methodSignatures().size(); i++) {
javaMethods.add(
createRpcTestMethod(
method,
sortedMethodSignatures.get(i),
method.methodSignatures().get(i),
i,
service.name(),
classMemberVarExprs,
Expand All @@ -470,7 +450,7 @@ private static List<MethodDefinition> createTestMethods(
javaMethods.add(
createRpcExceptionTestMethod(
method,
sortedMethodSignatures.get(i),
method.methodSignatures().get(i),
i,
service.name(),
classMemberVarExprs,
Expand Down
24 changes: 23 additions & 1 deletion src/main/java/com/google/api/generator/gapic/protoparser/MethodSignatureParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,29 @@ public static List<List<MethodArgument>> parseMethodSignatures(
}
signatures.addAll(flattenMethodSignatureVariants(argumentNames, argumentNameToOverloads));
}
return signatures;

// Make the method signature order deterministic, which helps with unit testing and per-version
// diffs.
List<List<MethodArgument>> sortedMethodSignatures =
signatures.stream()
.sorted(
(s1, s2) -> {
// Sort by number of arguments first.
if (s1.size() != s2.size()) {
return s1.size() - s2.size();
}
// Then by MethodSignature properties.
for (int i = 0; i < s1.size(); i++) {
int compareVal = s1.get(i).compareTo(s2.get(i));
if (compareVal != 0) {
return compareVal;
}
}
return 0;
})
.collect(Collectors.toList());

return sortedMethodSignatures;
}

@VisibleForTesting
Expand Down
49 changes: 32 additions & 17 deletions src/test/java/com/google/api/generator/gapic/protoparser/ParserTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,11 +224,14 @@ public void parseMethodSignatures_basic() {
outputResourceNames);
assertEquals(7, methodSignatures.size());

// Signature contents: ["content"].
// Signature contents: ["parent"].
List<MethodArgument> methodArgs = methodSignatures.get(0);
assertEquals(1, methodArgs.size());
MethodArgument argument = methodArgs.get(0);
assertMethodArgumentEquals("content", TypeNode.STRING, ImmutableList.of(), argument);
TypeNode resourceNameType =
TypeNode.withReference(
ConcreteReference.withClazz(com.google.api.resourcenames.ResourceName.class));
assertMethodArgumentEquals("parent", resourceNameType, ImmutableList.of(), argument);

// Signature contents: ["error"].
methodArgs = methodSignatures.get(1);
Expand All @@ -237,33 +240,45 @@ public void parseMethodSignatures_basic() {
assertMethodArgumentEquals(
"error", TypeNode.withReference(createStatusReference()), ImmutableList.of(), argument);

// Signature contents: ["content", "severity"].
// Signature contents: ["name"], resource helper variant.
methodArgs = methodSignatures.get(2);
assertEquals(2, methodArgs.size());
assertEquals(1, methodArgs.size());
argument = methodArgs.get(0);
assertMethodArgumentEquals("content", TypeNode.STRING, ImmutableList.of(), argument);
argument = methodArgs.get(1);
assertMethodArgumentEquals(
"severity",
TypeNode foobarNameType =
TypeNode.withReference(
VaporReference.builder().setName("Severity").setPakkage(ECHO_PACKAGE).build()),
ImmutableList.of(),
argument);
VaporReference.builder().setName("FoobarName").setPakkage(ECHO_PACKAGE).build());
assertMethodArgumentEquals("name", foobarNameType, ImmutableList.of(), argument);

// Signature contents: ["name"], String variant.
// Signature contents: ["content"].
methodArgs = methodSignatures.get(3);
assertEquals(1, methodArgs.size());
argument = methodArgs.get(0);
assertMethodArgumentEquals("name", TypeNode.STRING, ImmutableList.of(), argument);
assertMethodArgumentEquals("content", TypeNode.STRING, ImmutableList.of(), argument);

// Signature contents: ["name"], resource helper variant.
// Signature contents: ["name"], String variant.
methodArgs = methodSignatures.get(4);
assertEquals(1, methodArgs.size());
argument = methodArgs.get(0);
TypeNode foobarNameType =
assertMethodArgumentEquals("name", TypeNode.STRING, ImmutableList.of(), argument);

// Signature contents: ["parent"], String variant.
methodArgs = methodSignatures.get(5);
assertEquals(1, methodArgs.size());
argument = methodArgs.get(0);
assertMethodArgumentEquals("parent", TypeNode.STRING, ImmutableList.of(), argument);

// Signature contents: ["content", "severity"].
methodArgs = methodSignatures.get(6);
assertEquals(2, methodArgs.size());
argument = methodArgs.get(0);
assertMethodArgumentEquals("content", TypeNode.STRING, ImmutableList.of(), argument);
argument = methodArgs.get(1);
assertMethodArgumentEquals(
"severity",
TypeNode.withReference(
VaporReference.builder().setName("FoobarName").setPakkage(ECHO_PACKAGE).build());
assertMethodArgumentEquals("name", foobarNameType, ImmutableList.of(), argument);
VaporReference.builder().setName("Severity").setPakkage(ECHO_PACKAGE).build()),
ImmutableList.of(),
argument);
}

@Test
Expand Down