Refactor VoteStorageService to use poll_id instead of block_id #9
Conversation
This file contains hidden or 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
- Updated the VoteStorageService class to change the parameter and variable names from `block_id` to `poll_id` for clarity and consistency with the new database schema. - Modified the `record_vote` method to insert votes using `poll_id` and updated the error handling for duplicate votes to check against the new unique constraint on `(poll_id, hashed_token)`. - Adjusted the `get_aggregate` method to retrieve aggregate data based on `poll_id` instead of `block_id`. - Changed the `get_user_vote` method to use `poll_id` for fetching the user's vote. - Updated the corresponding test cases in VoteStorageServiceTest and AggregationTest to reflect the changes in the database schema and ensure proper functionality. Enhance test safety and isolation - Added a constant `PHPUNIT_TEST` in the bootstrap file to prevent migrations during PHPUnit tests, ensuring that tests run against a stable schema without altering production data. - Implemented checks in the test bootstrap to truncate the vote table only if the database prefix indicates a test environment, preventing accidental data loss during development. - Updated the test cases to ensure they correctly handle the new schema and constraints, including changes to how duplicates are checked and how results are aggregated. Create comprehensive testing documentation - Added a detailed `TESTING.md` file outlining the testing setup, including safe testing practices, running tests with a clean database, and CI/CD configuration. - Included instructions for setting up a separate test database and how to run tests safely without affecting production data. - Documented the test database setup process in `TEST-DATABASE-SETUP.md`, providing examples and best practices for developers. Implement a DatabaseManager for schema management - Introduced a new `DatabaseManager` class to handle database operations, including table creation and schema migrations, ensuring a consistent state across different environments. - The `DatabaseManager` uses a singleton pattern to manage the database connection and operations, preventing multiple instances and ensuring thread safety. - Implemented methods for initializing the database, ensuring the table exists, and running migrations as needed, with checks to prevent data loss during testing. Overall, these changes improve code clarity, enhance testing safety, and provide a robust framework for managing database interactions within the ContentPoll AI plugin.
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.
This pull request introduces major improvements to testing safety and database management, as well as critical bug fixes for the ContentPoll plugin. The most significant changes ensure that running tests can no longer delete production vote data, with robust protections and documentation for safe test execution. Additionally, the release notes in
CHANGELOG.mddetail a series of critical bug fixes and architectural changes across recent versions, particularly focused on preventing data loss during migrations and plugin updates.Testing Safety and Documentation Improvements:
PHPUNIT_TESTconstant, database migration safeguards, and explicit checks for test database prefixes or a confirmation flag.run-tests.sh) supporting both safe and explicit truncation modes, and added comprehensive testing documentation (TESTING.md,tests/README.md,docs/TEST-DATABASE-SETUP.md). [1] [2]test_*,phpunit_*), or if explicitly confirmed by the user.README.mdwith clear instructions for safe test execution and database safety configuration.Database and Migration Robustness:
DatabaseManagerclass using the singleton pattern, and moved initialization to theplugins_loadedhook with semantic versioning for migration tracking.Block Attribute and Asset Updates:
pollIdattribute to the vote block, further decoupling poll identity from the internalblockIdand supporting future enhancements. [1] [2]Changelog and Release Notes:
CHANGELOG.mdwith detailed entries for versions 0.7.0 through 0.7.6, documenting all critical fixes, architectural changes, and new features, as well as providing links for version comparisons. [1] [2]Test Result Artifacts:
.phpunit.cache/test-resultsto reflect the expanded and improved test coverage.These changes collectively make the plugin much safer to develop and test, while also improving the maintainability and reliability of database migrations and poll identity handling.