forked from cuttle-cards/cuttle
-
Notifications
You must be signed in to change notification settings - Fork 0
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
Refactoring api/controllers/game/draw.js to extract the game logic to helper methods #16
Open
Hakaabi
wants to merge
19
commits into
main
Choose a base branch
from
backend-endpoints-helpers
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains 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
…he way game-state.js folder is being tested
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.
Issue number
Relevant issue number
Please check the following
Please describe additional details for testing this change
Description:
with this pull request I aimed to introduce significant enhancement and refactoring to the backend game logic for better modularity, reusability, and maintainability according to the description written in the original issue cuttle-cards#505 in the of the original repository (cuttle-cards#505). Additionally, I have implemented unit tests h to validate the functionality of the refactored helper methods, ensuring style consistency with the existing test units.
Modification made to the files:
-Code Refactoring:
I extracted the omplex game logic from api/controllers/game/draw.js into and turned them into helper methods under the api/helpers/game-logic/ folder.
In this folder I created modular helper functions:
the was done with the aim of Improving readability, reusability, and for separation of concerns across the backend logic.
Lastly, Unit Testing:
I wrote a test suite located in tests/unit/specs/gameLogicHelpers.spec.js to validate each helper method:
validateDrawConditions, to ensure proper validation for various game scenarios.
updateGameStateAfterDraw, this confirms accurate updates to the game state.
publishGameState, validates correct broadcasting of game state changes.
errorHandling, Tests appropriate error response handling.