feat: add Health Proto and Update gRPC/HTTP Health Registration #1632
Conversation
WalkthroughThe pull request introduces significant changes to the API documentation and health check functionality. Key modifications include renaming the Changes
Possibly related PRs
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Outside diff range and nitpick comments (5)
internal/servers/healthServer.go (1)
27-27: LGTM: Watch method signature updated correctly. Consider addressing the TODO comment.The Watch method signature has been successfully updated to use the new
v1types, which is consistent with the changes in the rest of the file.There's a TODO comment above this method. Would you like assistance in implementing the Watch method or creating a GitHub issue to track this task?
internal/servers/server.go (1)
305-307: LGTM: Health handler registration added for HTTP serverThe health handler is now properly registered for the HTTP server using
grpcV1.RegisterHealthHandler. This change aligns with the PR objectives of updating the HTTP health registration.For consistency with other handler registrations, consider refactoring the error handling to a single line:
- if err = grpcV1.RegisterHealthHandler(ctx, mux, conn); err != nil { - return err - } + if err = grpcV1.RegisterHealthHandler(ctx, mux, conn); err != nil { return err }This change would make the health handler registration consistent with the style used for other handlers in this file.
docs/api-reference/openapiv2/apidocs.swagger.json (1)
3079-3087: Well-defined ServingStatus enum addedThe addition of the
ServingStatusenum is a welcome improvement, providing a clear and standardized set of possible values for the health check status. This enhances the API's clarity and usability.However, to improve the documentation:
Consider adding descriptions for the "SERVING" and "NOT_SERVING" values as well, to provide a complete understanding of when each status is used. For example:
"ServingStatus": { "type": "string", "enum": [ "SERVING", "NOT_SERVING", "SERVICE_UNKNOWN" ], - "description": " - SERVICE_UNKNOWN: Used only by the Watch method." + "description": " - SERVING: The service is operational and ready to handle requests.\n - NOT_SERVING: The service is not operational and cannot handle requests.\n - SERVICE_UNKNOWN: Used only by the Watch method when the service status cannot be determined." }docs/api-reference/apidocs.swagger.json (2)
68-75: LGTM: Added optional 'service' parameter to health check endpointThe addition of the optional
servicequery parameter to the/healthzendpoint is a valuable enhancement. It allows for more granular health checks by enabling the specification of a particular service. This change is in line with the PR objectives of updating the gRPC/HTTP health registration.Consider updating the API documentation to include information about this new parameter, explaining its purpose and usage.
3099-3109: LGTM: Added ServingStatus definitionThe addition of the
ServingStatusdefinition as a string enum with clear status options (UNKNOWN, SERVING, NOT_SERVING, SERVICE_UNKNOWN) is a valuable enhancement. This provides a standardized set of statuses for health check responses, improving the API's consistency and usability.Consider adding descriptions for the other status values (UNKNOWN, SERVING, NOT_SERVING) to provide complete documentation for API users. For example:
"ServingStatus": { "type": "string", "enum": [ "UNKNOWN", "SERVING", "NOT_SERVING", "SERVICE_UNKNOWN" ], "default": "UNKNOWN", "description": "Enum representing the serving status of the service.", + "enumDescriptions": [ + "The serving status is unknown.", + "The service is serving.", + "The service is not serving.", + "Used only by the Watch method." + ] }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
🔇 Files ignored due to path filters (6)
pkg/pb/base/v1/health.pb.gois excluded by!**/*.pb.gopkg/pb/base/v1/health.pb.gw.gois excluded by!**/*.pb.gw.gopkg/pb/base/v1/health_grpc.pb.gois excluded by!**/*.pb.gopkg/pb/base/v1/service.pb.gois excluded by!**/*.pb.gopkg/pb/base/v1/service.pb.gw.gois excluded by!**/*.pb.gw.gopkg/pb/base/v1/service_grpc.pb.gois excluded by!**/*.pb.go
📒 Files selected for processing (8)
- docs/api-reference/apidocs.swagger.json (6 hunks)
- docs/api-reference/openapiv2/apidocs.swagger.json (6 hunks)
- internal/servers/healthServer.go (2 hunks)
- internal/servers/server.go (2 hunks)
- pkg/pb/base/v1/health.pb.validate.go (1 hunks)
- pkg/pb/base/v1/service.pb.validate.go (0 hunks)
- proto/base/v1/health.proto (1 hunks)
- proto/base/v1/service.proto (0 hunks)
💤 Files not reviewed due to no reviewable changes (2)
- pkg/pb/base/v1/service.pb.validate.go
- proto/base/v1/service.proto
✅ Files skipped from review due to trivial changes (1)
- pkg/pb/base/v1/health.pb.validate.go
🧰 Additional context used
buf
proto/base/v1/health.proto
4-4: import "google/api/annotations.proto": file does not exist
(COMPILE)
🔇 Additional comments not posted (13)
internal/servers/healthServer.go (4)
6-6: LGTM: Import statement updated correctly.The new import statement for the
v1package is consistent with the transition fromgrpc_health_v1to the new package as mentioned in the PR summary.
13-13: LGTM: HealthServer struct updated correctly.The HealthServer struct now correctly embeds
v1.UnimplementedHealthServer, which is in line with the transition to the newv1package and follows gRPC best practices for forward compatibility.
22-23: LGTM: Check method updated correctly with improved implementation.The Check method has been successfully updated to use the new
v1types. The implementation now returns a concretev1.HealthCheckResponsewith a SERVING status, which is an improvement over the previous implementation.
Line range hint
1-37: Summary: Health server implementation successfully updated to use new v1 package.The changes in this file successfully transition the health server implementation from using
grpc_health_v1to the newv1package fromgithub.com/Permify/permify/pkg/pb/base/v1. This update includes:
- Updated import statements
- Modified HealthServer struct to embed the new UnimplementedHealthServer
- Updated Check and Watch method signatures
- Improved Check method implementation to return a concrete response
These changes align well with the PR objectives and improve the overall health check functionality. The only remaining item is the unimplemented Watch method, which has been noted.
proto/base/v1/health.proto (2)
15-23: LGTM: HealthCheckResponse and ServingStatus are well-definedThe
HealthCheckResponsemessage andServingStatusenum are well-structured and cover all necessary states for a health check response. The use of an enum for the status ensures type safety and clear semantics.
25-94: LGTM: Health service is well-structuredThe
Healthservice definition follows gRPC best practices. The inclusion of bothCheckandWatchmethods provides flexibility for different health monitoring scenarios. The HTTP and OpenAPI annotations for theCheckmethod facilitate easy integration with RESTful APIs and API documentation tools.internal/servers/server.go (3)
184-184: LGTM: Health server registration addedThe health server is now properly registered for the main gRPC server using
grpcV1.RegisterHealthServer. This change aligns with the PR objectives of updating the gRPC health registration.
191-191: LGTM: Health server registration added for invoke serverThe health server is now properly registered for the invoke server, maintaining consistency with the main gRPC server. This ensures that health check functionality is available for both servers.
Line range hint
184-307: Summary: Health check implementation successfully updatedThe changes in this file successfully implement the health check functionality across all server types (gRPC, invoke, and HTTP). The implementation is consistent and aligns with the PR objectives. These updates will improve the robustness and reliability of health monitoring within the application.
Key improvements:
- Health server registration for the main gRPC server
- Health server registration for the invoke server
- Health handler registration for the HTTP server
These changes ensure that clients can utilize both the Check and Watch methods for monitoring the health of the service, as mentioned in the PR objectives.
docs/api-reference/openapiv2/apidocs.swagger.json (2)
2198-2204: Improved type safety for HealthCheckResponse statusThe modification of the
statusproperty in theHealthCheckResponsedefinition to reference#/definitions/ServingStatusinstead of a simple string type is a positive change. This update likely provides better type safety and potentially more detailed status information, improving the API's robustness and clarity.
1382-1382: Updated reference to Watch.WatchBodyThe change in reference from
#/definitions/WatchBodyto#/definitions/Watch.WatchBodyis likely part of a reorganization of the API definitions. This change can improve clarity by grouping related definitions.To ensure this change doesn't introduce any issues, please run the following verification:
✅ Verification successful
Watch.WatchBody Reference Updated Successfully
The reference to
#/definitions/Watch.WatchBodyhas been verified in all instances ofapidocs.swagger.json. TheWatch.WatchBodydefinition exists, and there are no remaining references to the oldWatchBodydefinition.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify that the Watch.WatchBody definition exists and is correctly referenced # Check if the Watch.WatchBody definition exists if jq -e '.definitions["Watch.WatchBody"]' apidocs.swagger.json > /dev/null; then echo "Watch.WatchBody definition exists." else echo "Error: Watch.WatchBody definition not found." exit 1 fi # Check if there are any remaining references to the old WatchBody definition if jq -e '.. | objects | select(has("$ref")) | select(.["$ref"] == "#/definitions/WatchBody")' apidocs.swagger.json > /dev/null; then echo "Warning: Found references to old WatchBody definition. These should be updated." else echo "No references to old WatchBody definition found." fiLength of output: 249
Script:
#!/bin/bash # Locate apidocs.swagger.json in the repository FILE_PATH=$(fd --search-path . --type f --name "apidocs.swagger.json") if [ -z "$FILE_PATH" ]; then echo "Error: apidocs.swagger.json not found in the repository." exit 1 else echo "Found apidocs.swagger.json at: $FILE_PATH" fi # Verify that the Watch.WatchBody definition exists and is correctly referenced if jq -e '.definitions["Watch.WatchBody"]' "$FILE_PATH" > /dev/null; then echo "Watch.WatchBody definition exists." else echo "Error: Watch.WatchBody definition not found." exit 1 fi # Check if there are any remaining references to the old WatchBody definition if jq -e '.. | objects | select(has("$ref")) | select(.["$ref"] == "#/definitions/WatchBody")' "$FILE_PATH" > /dev/null; then echo "Warning: Found references to old WatchBody definition. These should be updated." else echo "No references to old WatchBody definition found." fiLength of output: 498
Script:
#!/bin/bash # Locate apidocs.swagger.json in the repository using correct fd syntax FILE_PATH=$(fd "apidocs.swagger.json" --type f) if [ -z "$FILE_PATH" ]; then echo "Error: apidocs.swagger.json not found in the repository." exit 1 else echo "Found apidocs.swagger.json at: $FILE_PATH" fi # Verify that the Watch.WatchBody definition exists and is correctly referenced if jq -e '.definitions["Watch.WatchBody"]' "$FILE_PATH" > /dev/null; then echo "Watch.WatchBody definition exists." else echo "Error: Watch.WatchBody definition not found." exit 1 fi # Check if there are any remaining references to the old WatchBody definition if jq -e '.. | objects | select(has("$ref")) | select(.["$ref"] == "#/definitions/WatchBody")' "$FILE_PATH" > /dev/null; then echo "Warning: Found references to old WatchBody definition. These should be updated." else echo "No references to old WatchBody definition found." fiLength of output: 885
Script:
#!/bin/bash # Locate all instances of apidocs.swagger.json in the repository using correct fd syntax FILE_PATHS=$(fd "apidocs.swagger.json" --type f) if [ -z "$FILE_PATHS" ]; then echo "Error: apidocs.swagger.json not found in the repository." exit 1 else echo "Found apidocs.swagger.json at:" echo "$FILE_PATHS" fi # Iterate over each found file path while IFS= read -r FILE_PATH; do echo "Processing $FILE_PATH..." # Verify that the Watch.WatchBody definition exists and is correctly referenced if jq -e '.definitions["Watch.WatchBody"]' "$FILE_PATH" > /dev/null; then echo " - Watch.WatchBody definition exists." else echo " - Error: Watch.WatchBody definition not found in $FILE_PATH." exit 1 fi # Check if there are any remaining references to the old WatchBody definition if jq -e '.. | objects | select(has("$ref")) | select(.["$ref"] == "#/definitions/WatchBody")' "$FILE_PATH" > /dev/null; then echo " - Warning: Found references to old WatchBody definition in $FILE_PATH. These should be updated." else echo " - No references to old WatchBody definition found in $FILE_PATH." fi done <<< "$FILE_PATHS"Length of output: 1888
docs/api-reference/apidocs.swagger.json (2)
58-58: LGTM: Updated health check response schemaThe change from
HealthResponsetoHealthCheckResponsein the/healthzendpoint's response schema aligns well with the PR objectives. This update ensures consistency in naming conventions across the API and reflects the enhanced health check functionality.
2208-2214: LGTM: Added HealthCheckResponse definitionThe addition of the
HealthCheckResponsedefinition with astatusfield referencingServingStatusis a positive enhancement. This change supports the PR objectives of updating the health check functionality and allows for more detailed health status reporting.Please ensure that the
#/definitions/ServingStatusdefinition exists and is correctly defined in the schema. Run the following command to verify:#!/bin/bash # Verify the existence and content of the ServingStatus definition jq '.definitions.ServingStatus' docs/api-reference/apidocs.swagger.json
| syntax = "proto3"; | ||
| package base.v1; | ||
|
|
||
| import "google/api/annotations.proto"; | ||
| import "protoc-gen-openapiv2/options/annotations.proto"; | ||
| import "validate/validate.proto"; | ||
|
|
||
| option go_package = "github.com/Permify/permify/pkg/pb/base/v1"; | ||
|
|
There was a problem hiding this comment.
Verify the import for "google/api/annotations.proto"
The file structure and package naming follow best practices. However, there's an issue with one of the imports.
The static analysis tool indicates that the file "google/api/annotations.proto" does not exist. This could lead to compilation errors. Please ensure that this dependency is correctly installed and the import path is accurate.
To resolve this:
- Check if the
google/apipackage is installed in your project. - If it's not installed, you may need to add it to your project dependencies.
- If it is installed, verify the import path is correct.
If you need assistance with installing or configuring the dependency, please let me know.
🧰 Tools
buf
4-4: import "google/api/annotations.proto": file does not exist
(COMPILE)
| message HealthCheckRequest { | ||
| string service = 1; | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider adding validation to the service field
The HealthCheckRequest message structure is simple and appropriate. However, to improve robustness, consider adding validation to the service field.
You could use the validate.rules option to ensure the service field is not empty when provided. Here's an example of how you could modify the message:
message HealthCheckRequest {
- string service = 1;
+ string service = 1 [(validate.rules).string = {min_len: 1}];
}This change would ensure that if a service name is provided, it's not an empty string.
Committable suggestion was skipped due to low confidence.
| option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { | ||
| summary: "health api" | ||
| tags: ["Health"] | ||
| operation_id: "health.check" | ||
| description: "" | ||
| extensions: { | ||
| key: "x-codeSamples" | ||
| value: { | ||
| list_value: { | ||
| values: { | ||
| struct_value: { | ||
| fields: { | ||
| key: "lang" | ||
| value: {string_value: ""} | ||
| } | ||
| fields: { | ||
| key: "label" | ||
| value: {string_value: ""} | ||
| } | ||
| fields: { | ||
| key: "source" | ||
| value: {string_value: ""} | ||
| } | ||
| } | ||
| } | ||
| values: { | ||
| struct_value: { | ||
| fields: { | ||
| key: "lang" | ||
| value: {string_value: ""} | ||
| } | ||
| fields: { | ||
| key: "label" | ||
| value: {string_value: ""} | ||
| } | ||
| fields: { | ||
| key: "source" | ||
| value: {string_value: ""} | ||
| } | ||
| } | ||
| } | ||
| values: { | ||
| struct_value: { | ||
| fields: { | ||
| key: "lang" | ||
| value: {string_value: ""} | ||
| } | ||
| fields: { | ||
| key: "label" | ||
| value: {string_value: ""} | ||
| } | ||
| fields: { | ||
| key: "source" | ||
| value: {string_value: ""} | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance OpenAPI annotations for better documentation
While the OpenAPI annotations are present, some fields are left empty. Improving these annotations would enhance the API documentation.
Consider updating the following fields in the OpenAPI annotations:
- Add a more detailed description for the operation.
- Provide example requests and responses.
- Include information about possible error responses.
Here's an example of how you could improve the annotations:
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "health api"
tags: ["Health"]
operation_id: "health.check"
- description: ""
+ description: "Checks the health status of the requested service"
extensions: {
key: "x-codeSamples"
value: {
list_value: {
values: {
struct_value: {
fields: {
key: "lang"
- value: {string_value: ""}
+ value: {string_value: "curl"}
}
fields: {
key: "label"
- value: {string_value: ""}
+ value: {string_value: "cURL"}
}
fields: {
key: "source"
- value: {string_value: ""}
+ value: {string_value: "curl -X GET \"https://api.example.com/healthz?service=myservice\""}
}
}
}
}
}
}
+ responses: {
+ key: "200"
+ value: {
+ description: "Successful health check response"
+ schema: {
+ json_schema: {
+ ref: "#/definitions/base.v1.HealthCheckResponse"
+ }
+ }
+ }
+ }
+ responses: {
+ key: "404"
+ value: {
+ description: "Service not found"
+ }
+ }
};These improvements will make the API documentation more informative and user-friendly.
Committable suggestion was skipped due to low confidence.
| @@ -1371,7 +1379,7 @@ | |||
| "in": "body", | |||
| "required": true, | |||
| "schema": { | |||
| "$ref": "#/definitions/WatchBody" | |||
| "$ref": "#/definitions/Watch.WatchBody" | |||
There was a problem hiding this comment.
💡 Codebase verification
Issue: Watch.WatchBody definition not found
The referenced definition #/definitions/Watch.WatchBody does not exist in apidocs.swagger.json. Please verify the definition name or update the reference accordingly.
🔗 Analysis chain
LGTM: Updated Watch method request body reference
The change in the request body reference for the Watch method from WatchBody to Watch.WatchBody appears to be part of a definition restructuring. This update is in line with the PR objectives of improving the API documentation.
Please ensure that the #/definitions/Watch.WatchBody definition exists and is correctly defined in the schema. Run the following command to verify:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Verify the existence of the Watch.WatchBody definition
jq '.definitions["Watch.WatchBody"]' docs/api-reference/apidocs.swagger.json
Length of output: 277
tolgaOzen
changed the title
This PR introduces several updates related to the health check. Specifically, it adds a new health.proto, and updates the registration of both gRPC and HTTP health checks. The API documentation has also been revised to reflect these changes.
Changes:
Introduced a new health.proto file to define HealthCheckRequest and HealthCheckResponse messages, along with the Health service, in alignment with gRPC health check standards.
Modified the gRPC service registration to integrate the health checking functionality. Now, the health service is correctly registered, allowing clients to use both Check and Watch methods for monitoring service health.
Summary by CodeRabbit
New Features
Checkmethod and aWatchmethod for continuous health status updates.serviceto the health check endpoint.ServingStatusfor clearer service health representation.Bug Fixes
HealthResponsetoHealthCheckResponsefor consistency in the API documentation.Chores