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.

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

feat: merge zeebe-grpc to pyzeebe #549

Merged
merged 9 commits into from
Dec 30, 2024
Merged

feat: merge zeebe-grpc to pyzeebe #549

merged 9 commits into from
Dec 30, 2024

Conversation

dimastbk
Copy link
Collaborator

@dimastbk dimastbk commented Dec 27, 2024

Merge zeebe-grpc to pyzeebe
Add mypy-stubs to bundled zeebe-grpc
Bump protobuf to 5.28 (breaking change?)

based on #476
close #475 close #476

cc @felicijus

@dimastbk
Copy link
Collaborator Author

MR on gitlab - one week w/o response.

@felicijus
Copy link
Contributor

Hi, can I help somehow ? Or is this already done?

Copy link

Pull Request Test Coverage Report for Build 12516152737

Details

  • 123 of 348 (35.34%) changed or added relevant lines in 7 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-14.6%) to 82.413%

Changes Missing Coverage Covered Lines Changed/Added Lines %
pyzeebe/proto/gateway_pb2_grpc.py 104 191 54.45%
pyzeebe/proto/gateway_pb2.py 13 151 8.61%
Totals Coverage Status
Change from base Build 12496073246: -14.6%
Covered Lines: 1209
Relevant Lines: 1467

💛 - Coveralls

@dimastbk
Copy link
Collaborator Author

Hi. I think it's done, need review.

@felicijus
Copy link
Contributor

Will do, in the meantime should the generated files be excluded from coverage ?

@dimastbk
Copy link
Collaborator Author

Yes, fixed

@felicijus
Copy link
Contributor

felicijus commented Dec 27, 2024

Looks good on first impression, like the addition with the update.py.

When does this get run, is it manually or during release/pre-commit ?

@dimastbk
Copy link
Collaborator Author

Manually

Copy link
Contributor

@felicijus felicijus left a comment

Choose a reason for hiding this comment

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

Code itself is solid.

But I think we can now avaid using custom type classes like in grpc_internals/types.py

update_proto.py Outdated Show resolved Hide resolved
@dimastbk
Copy link
Collaborator Author

But I think we can now avaid using custom type classes like in grpc_internals/types.py

I prefer don't expose transport types to clients.

@dimastbk dimastbk added the 4.0.0 Will be released in Zeebe 4.0.0 label Dec 30, 2024
@felicijus
Copy link
Contributor

Ok, I suppose I know what you mean.
I would like to test how the implementation, would look like when using the generated protobuf Message classes.

Reason for this is the protobuf documentation of Message:

Message provides methods you can use to check, manipulate, read, or write the entire message, including parsing from and serializing to binary strings.

Which would provide everything we need, with the added benefit of not being independent from the generated classes, which could lead to uncatched incompatibilities between the generated classes and the custom type classes.

PS. Will test this in #476

@dimastbk
Copy link
Collaborator Author

which could lead to uncatched incompatibilities between the generated classes and the custom type classes

It's can be caught with mypy and tests (or issues). Clients should not know anything about the transport. And it will be the breaking change, w/o changing Messages.

Any other comment? I would like to merge before NY.

@felicijus
Copy link
Contributor

felicijus commented Dec 30, 2024

I think it's fine for now, happy merging. 🎆

Copy link
Contributor

@felicijus felicijus left a comment

Choose a reason for hiding this comment

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

Will this be 4.x.x or 5.x.x ? 🎆

@dimastbk
Copy link
Collaborator Author

4.x.x

@dimastbk dimastbk merged commit 43dd741 into master Dec 30, 2024
20 checks passed
@dimastbk dimastbk deleted the merge-zeebe-grpc branch December 30, 2024 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4.0.0 Will be released in Zeebe 4.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate python class interface files from protobuf
2 participants