Refactor Item Details Endpoints and Clean Code

[PramithaMJ]

Pull Request: Refactor Item Details Endpoints and Clean Code

Title

Refactor Item Details Endpoints and Clean Code

Description

This pull request refactors the /get-item-all-details-by-id/{id} and /get-item-details-by-id/{id} endpoints to provide consistent response structures and includes various code cleanups to remove duplication and enhance maintainability.

Changes Made

Endpoint Changes:

1. Refactor /get-item-all-details-by-id/{id} Endpoint:

   • Modified the response structure to include the itemGetAllResponseDTO wrapper.
   • Kept existing structures for itemCategoryDTO, supplierDTO, and supplierCompanyDTO.

2. Refactor /get-item-details-by-id/{id} Endpoint:

   • Modified the response structure to include the itemGetAllResponseDTO wrapper.
   • Kept the existing structure for itemCategoryDTO.

Code Cleanups:

• Removed code duplication.
• Refactored common logic to ensure maintainability and readability.

Example Changes in Code:

Controller Methods:

@GetMapping(path = "/get-item-all-details-by-id/{id}")
public ResponseEntity<StandardResponse> getItemAllDetailsById(@PathVariable(value = "id") long itemId) {
    ItemGetAllResponseDTO itemGetAllResponseDTO = itemService.getAllDetailsItemById(itemId);
    return new ResponseEntity<>(
            new StandardResponse(200, "Success", itemGetAllResponseDTO),
            HttpStatus.OK
    );
}

@GetMapping(path = "/get-item-details-by-id/{id}")
public ResponseEntity<StandardResponse> getItemWithCategoryById(@PathVariable(value = "id") long itemId) {
    ItemGetAllResponseDTO itemGetAllResponseDTO = itemService.getItemById(itemId);
    return new ResponseEntity<>(
            new StandardResponse(200, "Success", itemGetAllResponseDTO),
            HttpStatus.OK
    );
}

Sample Responses:

/get-item-all-details-by-id/{id} Response:

{
    "code": 200,
    "message": "Success",
    "data": {
        "itemGetAllResponseDTO": {
            "itemId": 316,
            // Other item details
        },
        "itemCategoryDTO": {
            // Category details
        },
        "supplierDTO": {
            // Supplier details
        },
        "supplierCompanyDTO": {
            // Supplier company details
        }
    }
}

/get-item-details-by-id/{id} Response:

{
    "code": 200,
    "message": "Success",
    "data": {
        "itemGetAllResponseDTO": {
            "itemId": 316,
            "brandId": 0,
            "itemName": "new2",
            "sellingPrice": 100.0,
            // Other item details
        },
        "itemCategoryDTO": {
            // Category details
        }
    }
}

Impact Analysis

• Consistency: Ensured consistent response structures across endpoints.
• Maintainability: Improved code readability and reduced duplication.

Affected Files

• ItemController.java (Refactored endpoints)
• ItemService.java (Modified service methods)
• ItemGetAllResponseDTO.java (DTO used in response)

Test Plan

• Unit Tests:

  • Verify the response structure for both endpoints.
  • Ensure that the itemGetAllResponseDTO and other nested DTOs are correctly populated.

• API Tests:

  • Test the endpoints using a tool like Postman to ensure the responses match the expected format.
  • Validate the presence and correctness of fields in the JSON response.

• Manual Testing:

  • Test the endpoints locally to verify the correct behavior and response format.

• Automate testing:

• qodana Results

• 

• LifePill Pos System backend qodana Report

Related Issues

• Ensured no StackOverflowError occurs in the entity toString methods due to circular references.

• 100 #97

Checklist

• [x] Refactored endpoint methods to provide consistent responses.
• [x] Removed code duplication and improved maintainability.
• [x] Updated and verified unit tests.
• [x] Tested endpoints manually and using Postman.

Conclusion

This pull request refactors the item details endpoints to ensure consistent response structures and includes various code cleanups for better maintainability. Please review the changes and provide feedback or approval for merging.

Best regards,
Pramitha Jayasooriya Backend Developer at LifePill https://pramithamj.me

[sonarcloud[bot]]

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarCloud