Add option to the protoc code generator to avoid generating deprecated code #3089

mgodave · 2024-11-06T22:02:32Z

Motivation

The generated ServiceTalk gRPC stubs make use of deprecated calls. This causes a problem when -Werror is used to build the code since it will automatically fail the build. We should allow users who have already migrated their code to prevent the protoc compiler from generating and using deprecated references.

Modifications

Add an option, skipDeprecated, as part of the protoc compiler configuration, to tell the generator to leave out deprecated references.

Result

Example: Tester.java before/after (option enabled) https://gist.github.com/mgodave/5772193156ca740ea90ca11bafb3da56
Example: Tester.java before/after (option disabled) https://gist.github.com/mgodave/dcff4574f0b70cb39c3bd97a859565ac

Remove

initSerializationProvider, reason: ContentCodec is deprecated
isSupportedMessageCodingsEmpty, reason ContentCodec is deprecated
Deprecated ServiceFactory constructors
ServiceFactory::Builder references to ContentCodec
Generated client metadata and associated methods, reason: deprecated

Testing

Manually tested:

Add new option to ServiceTalk/examples/grpc/protoc-options and use it to generate test_service.proto which covers all combinations of streaming (or not) services.

bryce-anderson

Token approval: this looks fine to me but please wait for a more experienced reviewer before merging.

How was it tested? I presume manually, but it would be good to document it in the PR description.

servicetalk-grpc-protoc/src/main/java/io/servicetalk/grpc/protoc/Main.java

servicetalk-grpc-protoc/src/main/java/io/servicetalk/grpc/protoc/Generator.java

…ing-deprecated-calls

…est full scope of generation

mgodave · 2024-11-14T23:45:13Z

New diff from test_service.proto: https://gist.github.com/mgodave/5772193156ca740ea90ca11bafb3da56

…oc/Main.java Co-authored-by: Idel Pivnitskiy <idel.pivnitskiy@apple.com>

idelpivnitskiy

Really good progress! New generated code looks much better than without skipDeprecated option.
Just a few adjustments for the final findings and we are ready to ship:

servicetalk-examples/grpc/protoc-options/src/main/proto/test_service.proto

servicetalk-examples/grpc/protoc-options/build.gradle

servicetalk-grpc-api/src/main/java/io/servicetalk/grpc/api/GrpcRoutes.java

servicetalk-grpc-protoc/src/main/java/io/servicetalk/grpc/protoc/Generator.java

idelpivnitskiy

Great work!

The generated code with skipDeprecated=true looks good. I also checked diff for default behavior. Many things changed their order, which is ok. Couldn't spot anything suspicious, but would be great if someone can have another look at the diff @bryce-anderson. We need to make sure current users won't be affected.

servicetalk-grpc-protoc/src/main/java/io/servicetalk/grpc/protoc/Generator.java

…oc/Generator.java

mgodave · 2024-11-18T16:27:00Z

Great work!

The generated code with skipDeprecated=true looks good. I also checked diff for default behavior. Many things changed their order, which is ok. Couldn't spot anything suspicious, but would be great if someone can have another look at the diff @bryce-anderson. We need to make sure current users won't be affected.

The ordering is probably based on me trying to keep the blocks of skipDeprecated code together so that, at some point, we can more easily identify which sections can just be deleted. It should be fine, javapoet appears to at least do basic stuff like keep fields on top, etc... The only way current users would be affected would be if we changed anything else without the option. I didn't do a diff of a before and after. Let me do that as a quick check.

bryce-anderson

I also looked at a diff of the generated code and didn't see anything suspicious. That said, it's a lot of generated code. 😅

…d code (apple#3089) ### Motivation The generated ServiceTalk gRPC stubs make use of deprecated calls. This causes a problem when `-Werror` is used to build the code since it will automatically fail the build. We should allow users who have already migrated their code to prevent the protoc compiler from generating and using deprecated references. ### Modifications Add an option, `skipDeprecated`, as part of the protoc compiler configuration, to tell the generator to leave out deprecated references. Remove - initSerializationProvider, reason: ContentCodec is deprecated - isSupportedMessageCodingsEmpty, reason ContentCodec is deprecated - Deprecated ServiceFactory constructors - ServiceFactory::Builder references to ContentCodec - Generated client metadata and associated methods, reason: deprecated ### Result Users can generate gRPC stubs without deprecated code. ### Testing Manually tested: - Add new option to ServiceTalk/examples/grpc/protoc-options and use it to generate test_service.proto which covers all combinations of streaming (or not) services.

mgodave added 2 commits November 6, 2024 14:56

Omit deprecated calls where possible if given the option

5363852

Generate deprecated code by default

8176099

mgodave marked this pull request as ready for review November 7, 2024 15:10

mgodave requested review from bryce-anderson and idelpivnitskiy November 7, 2024 23:11

bryce-anderson approved these changes Nov 7, 2024

View reviewed changes

idelpivnitskiy requested changes Nov 12, 2024

View reviewed changes

servicetalk-grpc-protoc/src/main/java/io/servicetalk/grpc/protoc/Main.java Outdated Show resolved Hide resolved

servicetalk-grpc-protoc/src/main/java/io/servicetalk/grpc/protoc/Generator.java Show resolved Hide resolved

mgodave added 3 commits November 12, 2024 10:29

Merge remote-tracking branch 'upstream/main' into drusek/skip-generat…

0255ac5

…ing-deprecated-calls

Address some feedback from Idel and bring in test_services.proto to t…

26b234b

…est full scope of generation

Do not generated deprecated methods on FunctionalInterfaces

ad1a341

mgodave and others added 2 commits November 15, 2024 09:06

Update servicetalk-grpc-protoc/src/main/java/io/servicetalk/grpc/prot…

17b6bb1

…oc/Main.java Co-authored-by: Idel Pivnitskiy <idel.pivnitskiy@apple.com>

Update docs

050c0f1

mgodave requested a review from idelpivnitskiy November 15, 2024 16:52

idelpivnitskiy reviewed Nov 15, 2024

View reviewed changes

mgodave added 2 commits November 15, 2024 17:14

Address feedback from Idel

ee093ac

Formatting

f548516

idelpivnitskiy approved these changes Nov 16, 2024

View reviewed changes

servicetalk-grpc-protoc/src/main/java/io/servicetalk/grpc/protoc/Generator.java Outdated Show resolved Hide resolved

idelpivnitskiy requested a review from bryce-anderson November 16, 2024 01:32

Update servicetalk-grpc-protoc/src/main/java/io/servicetalk/grpc/prot…

538216c

…oc/Generator.java

Remove test_service.proto

17bd89b

bryce-anderson approved these changes Nov 19, 2024

View reviewed changes

idelpivnitskiy merged commit f8abe11 into apple:main Nov 19, 2024
11 checks passed

mgodave deleted the drusek/skip-generating-deprecated-calls branch November 19, 2024 16:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add option to the protoc code generator to avoid generating deprecated code #3089

Add option to the protoc code generator to avoid generating deprecated code #3089

mgodave commented Nov 6, 2024 •

edited

Loading

bryce-anderson left a comment

mgodave commented Nov 14, 2024

idelpivnitskiy left a comment

idelpivnitskiy left a comment •

edited

Loading

mgodave commented Nov 18, 2024

bryce-anderson left a comment

Add option to the protoc code generator to avoid generating deprecated code #3089

Add option to the protoc code generator to avoid generating deprecated code #3089

Conversation

mgodave commented Nov 6, 2024 • edited Loading

Motivation

Modifications

Result

Testing

bryce-anderson left a comment

Choose a reason for hiding this comment

mgodave commented Nov 14, 2024

idelpivnitskiy left a comment

Choose a reason for hiding this comment

idelpivnitskiy left a comment • edited Loading

Choose a reason for hiding this comment

mgodave commented Nov 18, 2024

bryce-anderson left a comment

Choose a reason for hiding this comment

mgodave commented Nov 6, 2024 •

edited

Loading

idelpivnitskiy left a comment •

edited

Loading