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

Resolving Endpoint Regression and Codebase Refinement #21

Merged
merged 14 commits into from
Feb 9, 2024

Conversation

benefacto
Copy link
Member

@benefacto benefacto commented Jan 12, 2024

Overview

This pull request delivers crucial fixes and improvements to the Homebase Lite Backend, primarily focusing on rectifying a regression issue that affected endpoint responses. Additionally, it includes enhancements to our testing framework and repository management. These changes are in response to the regression problem outlined in ZenHub Issue #756, aiming to bolster the reliability and maintainability of the project.

Key Changes

  • Regression Fix: Resolved the Swagger route overriding issue, ensuring endpoints now return correct JSON responses instead of Swagger HTML. This fix restores the critical functionality for DAOs JSON retrieval.
  • Testing Framework Enhancement: Expanded our testing suite with more comprehensive tests for the Choices, DAOs, Polls, and Swagger routes, thereby reinforcing the stability and reliability of our application.
  • Repository Cleanup: Removed node_modules from the source, aligning with best practices and simplifying future code reviews. The folder was already listed in .gitignore and its removal eliminates unnecessary bulk from the repository.
  • Additional Notes The removal of the node_modules directory significantly reduces the diff size, aiding in the review process. Reviewers can collapse this folder in the diff view for easier navigation. The yarn.lock file is retained to ensure build reproducibility.

Linked Issue

This pull request addresses the concerns and objectives laid out in the ZenHub issue: Homebase Lite Backend: Regression in Homebase Lite Backend Causing Incorrect Endpoint Response #756. The issue highlighted critical disruptions in API functionality due to incorrect endpoint responses, which this pull request aims to comprehensively resolve.

This format maintains the structure and style of your previous pull requests, ensuring consistency in your project documentation and communication.

@benefacto benefacto self-assigned this Jan 12, 2024
@benefacto benefacto changed the title Regression in Homebase Lite Backend Causing Incorrect Endpoint Response Resolving Endpoint Regression and Codebase Refinement Jan 16, 2024
@benefacto benefacto marked this pull request as ready for review January 16, 2024 01:23
@benefacto benefacto assigned ashutoshpw and unassigned benefacto Jan 17, 2024
.github/workflows/test.yml Show resolved Hide resolved
@EightRice EightRice removed the request for review from thenerdcat January 29, 2024 11:13
@Man-Jain Man-Jain merged commit 2c219f7 into main Feb 9, 2024
1 check passed
@Man-Jain Man-Jain deleted the 756-swagger-regression branch February 9, 2024 20:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants