Skip to content

chore: Internal Testing & Validation WPGraphQL Logging Plugin #456

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

Jump to bottom
Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
Draft

chore: Internal Testing & Validation WPGraphQL Logging Plugin #456

wants to merge 12 commits into from

Conversation

@theodesp
Copy link
Member

@theodesp theodesp commented Oct 22, 2025 •
edited by colinmurphy
Loading

Description

This PR performs internal testing and validation of the WPGraphQL Logging Plugin to ensure it is ready for GA.

Fixes in the PR

  • Implemented BufferHandler to batch write database entries for performance
  • Added missing indexes for performance
  • Added filters for caching configuration
  • Better error handling

Related Issue

Dependant PRs

Type of Change

  • ✅ Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactoring (no functional changes)
  • 📄 Example update (no functional changes)
  • 📝 Documentation update
  • 🔍 Performance improvement
  • 🧪 Test update

How Has This Been Tested?

Screenshots

Checklist

  • I have read the CONTRIBUTING document
  • My code follows the project's coding standards
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works (if applicable)
  • Any dependent changes have been highlighted, merged or published

@changeset-bot
Copy link

changeset-bot bot commented Oct 22, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: e921f18

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link

github-actions bot commented Oct 22, 2025 •
edited
Loading

📦 Plugin Artifacts Ready!

Download from GitHub Actions run

Available plugins:

  • ✅ wpgraphql-logging.zip

See the "Artifacts" section at the bottom of the Actions run page

@colinmurphy
Updated packages. Fixed some QA issues.
34ce41f
@colinmurphy
Fix for codeception to correctly workout percentage of code coverage.
ffd97dc
@colinmurphy
Update plugin docs and metadata for beta release. Updated PHP Doc Blo…
b53a0c4 
…cks.

Expanded and clarified the readme.txt with detailed features, requirements, installation, and FAQ for the WPGraphQL Logging plugin beta release. Updated contributor list, license, and tested PHP/WP versions. Added and improved PHPDoc blocks in templates and event class for consistency. Renamed TESTING.md to docs/how-to/run_tests.md for better documentation structure. Minor description update in main plugin file.
@colinmurphy
QA fix.
e191652
@colinmurphy
Rename admin view templates to WPGraphQLLogger*
6a5c3ab 
Renamed admin view template files to use the WPGraphQLLogger* naming convention for consistency. Updated all references in code, documentation, and psalm.xml to match the new filenames.
@colinmurphy
Refactored error_log to only log when WP_DEBUG is defined.
feadd4b
@colinmurphy
Make config cache duration filterable
99a6c7c 
Wrap CACHE_DURATION in apply_filters to allow customization of the configuration cache duration via the 'wpgraphql_logging_config_cache_duration' filter.
@colinmurphy
Add whitelist validation for ORDER BY in find_logs
cebd24d 
Introduces a filter 'wpgraphql_logging_allowed_orderby_columns' to whitelist allowed columns for ORDER BY in find_logs() queries, enhancing security against SQL injection. Documentation updated with usage details and examples; code now validates both column and direction, falling back to defaults if invalid values are provided.
@colinmurphy
Minor fixes. Fixed settings filter name.
da046e8
@colinmurphy
Add buffer handler to reduce database write operations for performance.
3823a78 
Introduces Monolog's BufferHandler for database logging and adds the 'wpgraphql_logging_default_buffer_limit' filter to customize buffer size. Updates tests to flush buffer before asserting log counts and documents the new filter. Also adds an index for 'level_name' in the database entity.
@colinmurphy
Fixed typo.
e921f18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@theodesp @colinmurphy