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

Grpc.Tools: support generated filename corner cases #18470

Merged
merged 3 commits into from Mar 22, 2019
Merged

Grpc.Tools: support generated filename corner cases #18470

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cbb70f5
C# tools: support generated filename corner cases
Mar 22, 2019
50aed8d
fixup! C# tools: support generated filename corner cases
Mar 22, 2019
aa40424
fixup! C# tools: support generated filename corner cases
Mar 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 8 additions & 6 deletions src/csharp/Grpc.Tools.Tests/CSharpGeneratorTest.cs
View file
Open in desktop
Expand Up @@ -33,12 +33,14 @@ public new void SetUp()
[TestCase("foo.proto", "Foo.cs", "FooGrpc.cs")]
[TestCase("sub/foo.proto", "Foo.cs", "FooGrpc.cs")]
[TestCase("one_two.proto", "OneTwo.cs", "OneTwoGrpc.cs")]
[TestCase("__one_two!.proto", "OneTwo!.cs", "OneTwo!Grpc.cs")]
[TestCase("one(two).proto", "One(two).cs", "One(two)Grpc.cs")]
[TestCase("one_(two).proto", "One(two).cs", "One(two)Grpc.cs")]
[TestCase("one two.proto", "One two.cs", "One twoGrpc.cs")]
[TestCase("one_ two.proto", "One two.cs", "One twoGrpc.cs")]
[TestCase("one .proto", "One .cs", "One Grpc.cs")]
[TestCase("ONE_TWO.proto", "ONETWO.cs", "ONETWOGrpc.cs")]
[TestCase("one.two.proto", "OneTwo.cs", "One.twoGrpc.cs")]
[TestCase("__one_two!.proto", "OneTwo.cs", "OneTwo!Grpc.cs")]
[TestCase("one(two).proto", "OneTwo.cs", "One(two)Grpc.cs")]
[TestCase("one_(two).proto", "OneTwo.cs", "One(two)Grpc.cs")]
[TestCase("one two.proto", "OneTwo.cs", "One twoGrpc.cs")]
[TestCase("one_ two.proto", "OneTwo.cs", "One twoGrpc.cs")]
[TestCase("one .proto", "One.cs", "One Grpc.cs")]
public void NameMangling(string proto, string expectCs, string expectGrpcCs)
{
var poss = _generator.GetPossibleOutputs(Utils.MakeItem(proto, "grpcservices", "both"));
Expand Down
45 changes: 32 additions & 13 deletions src/csharp/Grpc.Tools/GeneratorServices.cs
View file
Open in desktop
Expand Up @@ -66,29 +66,28 @@ internal class CSharpGeneratorServices : GeneratorServices
public override string[] GetPossibleOutputs(ITaskItem protoItem)
{
bool doGrpc = GrpcOutputPossible(protoItem);
string filename = LowerUnderscoreToUpperCamel(
Path.GetFileNameWithoutExtension(protoItem.ItemSpec));

var outputs = new string[doGrpc ? 2 : 1];
string basename = Path.GetFileNameWithoutExtension(protoItem.ItemSpec);

string outdir = protoItem.GetMetadata(Metadata.OutputDir);
string fileStem = Path.Combine(outdir, filename);
outputs[0] = fileStem + ".cs";
string filename = LowerUnderscoreToUpperCamelProtocWay(basename);
outputs[0] = Path.Combine(outdir, filename) + ".cs";

if (doGrpc)
{
// Override outdir if kGrpcOutputDir present, default to proto output.
outdir = protoItem.GetMetadata(Metadata.GrpcOutputDir);
if (outdir != "")
{
fileStem = Path.Combine(outdir, filename);
}
outputs[1] = fileStem + "Grpc.cs";
string grpcdir = protoItem.GetMetadata(Metadata.GrpcOutputDir);
filename = LowerUnderscoreToUpperCamelGrpcWay(basename);
outputs[1] = Path.Combine(
grpcdir != "" ? grpcdir : outdir, filename) + "Grpc.cs";
}
return outputs;
}

string LowerUnderscoreToUpperCamel(string str)
// This is how the gRPC codegen currently construct its output filename.
// See src/compiler/generator_helpers.h:118.
string LowerUnderscoreToUpperCamelGrpcWay(string str)
{
// See src/compiler/generator_helpers.h:118
var result = new StringBuilder(str.Length, str.Length);
bool cap = true;
foreach (char c in str)
Expand All @@ -109,6 +108,26 @@ string LowerUnderscoreToUpperCamel(string str)
}
return result.ToString();
}

// This is how the protoc codegen constructs its output filename.
// See protobuf/compiler/csharp/csharp_helpers.cc:356.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for comparison, the logic is here:
https://github.com/protocolbuffers/protobuf/blob/3a3956e8a258784461270961c6577341356bce52/src/google/protobuf/compiler/csharp/csharp_helpers.cc#L137 with cap_next_letter=true and preserve_period=false

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, this is where I got it from. Looks like I gave a wrong line number, will fix in a moment.

I do not understand what is this last # check at the very end of the function, but it does not seem to be important?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

// Note that protoc explicitly discards non-ASCII letters.
string LowerUnderscoreToUpperCamelProtocWay(string str)
{
var result = new StringBuilder(str.Length, str.Length);
bool cap = true;
foreach (char c in str)
{
char upperC = char.ToUpperInvariant(c);
bool isAsciiLetter = 'A' <= upperC && upperC <= 'Z';
if (isAsciiLetter || ('0' <= c && c <= '9'))
{
result.Append(cap ? upperC : c);
}
cap = !isAsciiLetter;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe there's still a subtle problem - after a digit, protoc will still capitalize the next letter:
I tested and one123two.cs generates One123Two.cs and One123twoGrpc.cs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uhhhh, thanks! I'll take care of this.

Copy link
Contributor Author

@kkm000 kkm000 Mar 22, 2019 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This passes, I added a test and verified a real build, too. cap = !isAsciiLetter; will be true after a digit, as well as after any (non-emitted) other character. I'll push the test case tho, so that we have it, just in case.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, aa40424.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, thanks for clarification!

}
return result.ToString();
}
};

// C++ generator services.
Expand Down