chore: WPGraphQL Logging Snags & Automated Tests

[colinmurphy]

Description

This pull request introduces several improvements and refactors to the WPGraphQL Logging plugin's settings infrastructure, focusing on standardizing tab interfaces, improving configuration access, and simplifying code. The changes enhance maintainability and testability, and bring coverage above 90%.

Settings Tab Interface and Usage Standardization:

• Refactored SettingsTabInterface to require static get_name() and get_label() methods, and updated all tab classes (BasicConfigurationTab, DataManagementTab) and their usages to use these static methods instead of instance methods. This ensures consistent tab identification and labeling across the codebase. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]

Configuration Helper Improvements:

• Updated ConfigurationHelper methods to use static tab names and labels, improving reliability and reducing hardcoded strings. Added a new get_option_value() method for more direct option retrieval, and removed the unused reload_config() method. [1] [2] [3] [4] [5] [6] [7]

Codebase Simplification and Cleanup:

• Removed the now-redundant LoggingSettingsService class, consolidating configuration access through ConfigurationHelper.
• Updated SettingsFormManager to accept a ConfigurationHelper instance in its constructor for improved dependency injection and testability. [1] [2]

Field and Input Handling:

• Simplified the TextInputField::sanitize_field() method to always use sanitize_text_field, removing special handling for email and URL input types.
• Updated field construction in tab classes to use static tab names, further supporting the interface refactor. [1] [2] [3] [4] [5] [6] [7] [8] [9]

Other Notable Changes:

• Minor documentation and example cleanups, and a correction to a placeholder example in the UI.
• Added and updated PHPUnit tests, raising coverage above 90%. (.changeset/eight-moons-help.md)

These changes collectively make the settings architecture more robust, easier to extend, and better covered by tests.

Related Issue

#412

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]

🦋 Changeset detected

Latest commit: ef373fa

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@wpengine/wpgraphql-logging-wordpress-plugin	Patch

Not sure what this means? Click here to learn what changesets are.

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

[github-actions]

📦 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