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

Fix bugs in RESTFacadeImpl.java #1354

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix bugs in RESTFacadeImpl.java #1354

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion core/src/main/java/org/zstack/core/rest/RESTFacadeImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ void sendCommand(HttpServletRequest req, HttpServletResponse rsp) {
HttpEntity<String> entity = this.httpServletRequestToHttpEntity(req);
if (commandPath == null) {
rsp.sendError(HttpStatus.SC_BAD_REQUEST, "No 'commandPath' found in the header");
logger.warn(String.format("Received a command, but no 'taskUuid' found in headers. request body: %s", entity.getBody()));
logger.warn(String.format("Received a command, but no 'commandPath' found in headers. request body: %s", entity.getBody()));
return;
}

Copy link

Choose a reason for hiding this comment

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

The provided code snippet seems to handle sending a command and logging a warning if commandPath is not found in the headers. Here are some points for improvement and bug risks:

  1. Error Handling: The code correctly sends a 400 Bad Request response if commandPath is null, but it uses an alert message "No 'commandPath' found in the header" which can be improved for clarity.

  2. Logging: The logger message is inaccurately mentioning 'taskUuid' instead of 'commandPath'. It has been corrected in the code already, replacing 'taskUuid' with 'commandPath'.

  3. Null Safety: Ensure to check for null entities before calling entity.getBody() to prevent potential NullPointerException.

  4. Variable Naming: Variable names like req and rsp could be written out as request and response for better readability and maintainability.

  5. Consistency: Make sure to use consistent naming conventions throughout the codebase for variables and methods.

  6. Comments/Documentation: Add comments to explain complex or non-trivial logic for better understanding by other developers.

  7. Unit Tests: Ensure appropriate unit tests are in place to cover different scenarios, including handling null values, unexpected data types, etc.

  8. Input Validation: Include proper input validation for any user-controlled data to prevent security vulnerabilities like injection attacks.

  9. Code Formatting: Ensure consistent code formatting across the project to improve readability and maintainability.

  10. Logging Level: Consider using appropriate logging levels (e.g., INFO, DEBUG, ERROR) depending on the importance of the log message.

Overall, the provided code segment appears to be straightforward, with minor improvements suggested mainly around error handling, logging, and code readability.

Expand Down