Conversation
Signed-off-by: Josh Wulf <josh.wulf@camunda.com>
Signed-off-by: Josh Wulf <josh.wulf@camunda.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces protocol-based configuration for ZEEBE_GRPC_ADDRESS with explicit TLS handling, moving away from legacy configuration patterns. The changes enhance the SDK to support grpc:// and grpcs:// protocols for clearer connection configuration.
Key Changes
- Enhanced ZEEBE_GRPC_ADDRESS to support protocol-based configuration (grpc:// for insecure, grpcs:// for secure connections)
- Added comprehensive validation and warning system for deprecated configuration options
- Updated test suite and documentation to use the new protocol-based addressing
Reviewed Changes
Copilot reviewed 19 out of 20 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/lib/ZeebeGrpcAddressUtils.ts | New utility module for parsing and validating ZEEBE_GRPC_ADDRESS with protocol support |
| src/zeebe/zb/ZeebeGrpcClient.ts | Updated client to handle protocol-based TLS configuration from ZEEBE_GRPC_ADDRESS |
| src/lib/Configuration.ts | Enhanced configuration merging with validation, warnings, and default handling |
| src/c8/lib/CamundaRestClient.ts | Updated JSDoc comment to remove alpha status notation |
| src/c8/lib/C8Dto.ts | Added documentation comments for ProcessDeployment fields |
| Multiple test files | Updated tests to use new ZEEBE_GRPC_ADDRESS format and improved test reliability |
| README.md | Updated documentation examples to use protocol-based addressing |
| GitHub workflows | Updated CI configuration to use new addressing format |
Comments suppressed due to low confidence (1)
src/tests/c8/rest/refreshBearerToken.unit.spec.ts:41
- [nitpick] The parameter name 'call' is generic and could be more descriptive. Consider renaming to 'grpcCall' or 'request' to better indicate its purpose.
Topology: (call, callback) => {
Signed-off-by: Josh Wulf <josh.wulf@camunda.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of the change
This PR introduces protocol-based configuration for ZEEBE_GRPC_ADDRESS with explicit TLS handling, moving away from legacy configuration patterns. The changes enhance the SDK to support grpc:// and grpcs:// protocols for clearer connection configuration.
Key Changes
Type of change
Checklist
alphabranch