Skip to content

CHANGELOG.md

Latest commit

 

History

History
119 lines (92 loc) · 5.68 KB

CHANGELOG.md

File metadata and controls

119 lines (92 loc) · 5.68 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and adheres to Semantic Versioning.

[2.0.1] - 2025-10-14

Added

  • Filter redis_queue_show_test_jobs_page lets administrators (or site integrators) hide the "Test Jobs" admin submenu/page in production or restricted environments.
  • Documentation: New docs/filters.md reference listing all public plugin filters with signatures & examples.

Changed

  • Minor defensive check added to prevent direct access to the Test Jobs page when disabled by filter.

Notes

  • This is a non-breaking incremental release over 2.0.0 focused on admin customization.
  • Added dedicated Filters Reference doc for easier extensibility.

[2.0.0] - 2025-10-13

Breaking Changes

  • Plugin renamed: "Redis Queue Demo" → "Redis Queue"
  • Namespace changed: Soderlind\RedisQueueDemo → Soderlind\RedisQueue across all classes
  • Function names changed: redis_queue_demo_*() → redis_queue_*()
  • Filter/action names changed: redis_queue_demo_* → redis_queue_*
  • Text domain changed: redis-queue-demo → redis-queue
  • GitHub repository: URLs updated from redis-queue-demo to redis-queue
  • Composer package: Will be soderlind/redis-queue (currently soderlind/redis-queue-demo)
  • Download file name: Changed from redis-queue-demo.zip to redis-queue.zip
  • No backward compatibility: Legacy class aliases and function names have been completely removed

Migration Guide

To migrate from 1.x to 2.0.0:

  1. Update namespace imports:

    • Old: use Soderlind\RedisQueueDemo\Core\Redis_Queue_Manager;
    • New: use Soderlind\RedisQueue\Core\Redis_Queue_Manager;

  2. Update function calls:

    • Old: redis_queue_demo()
    • New: redis_queue()
    • Old: redis_queue_demo_create_job filter
    • New: redis_queue_create_job filter

  3. Update action/filter hooks:

    • Old: add_filter('redis_queue_demo_token_allowed_routes', ...)
    • New: add_filter('redis_queue_token_allowed_routes', ...)

  4. Update options migration: A one-time migration automatically renames options from redis_queue_demo_* to redis_queue_* on first activation of 2.0.0.

Changed

  • Complete documentation overhaul to reflect new plugin name and namespace
  • All code examples updated to use new function and filter names
  • REST API namespace remains redis-queue/v1 for API stability

Post-release Adjustments (2.0.0)

These refinements were made after the initial 2.0.0 tag without changing the version number (non‑breaking / UI & internal only):

Added

  • Noscript warning block on the Test Jobs admin page to inform users when JavaScript is disabled.

Changed

  • Improved test job submission UX: enforce a short minimum "Processing…" state for better visual feedback.
  • Replaced previous loading spinner with a subtle button fade animation (no color inversion, preserves native WP button styling).
  • More resilient admin asset loading by switching from relative ../../assets/... URLs to plugins_url() (avoids edge cases with path traversal or CDN rewriting).

Fixed

  • Admin JS not reliably loading in some environments due to relative path (../../) usage from within namespaced class directory.
  • Intermittent perception that form submission did "nothing" because the processing state was too brief—now perceptible.

Internal

  • Minor housekeeping in admin UI scripts (added lightweight inline preload marker for debugging).

[1.2.0] - 2025-10-10

Removed

  • Dropped all legacy global class aliases (previous class_alias guards) now that backward compatibility is not required.
  • Removed deprecated includes/ directory and emptied legacy interface stubs.
  • Removed legacy job_type inference variants (e.g. email_job, Email_Job, image_processing_job, api_sync_job); only canonical keys email, image_processing, api_sync are accepted now.
  • Removed bootstrap fallback to legacy global Sync_Worker (namespaced worker is now required).
  • Deleted development-only debug.php script (replaced by internal diagnostics via Redis_Queue_Manager::diagnostic()).

Changed

  • Codebase now exclusively uses namespaced classes; no global fallbacks remain.
  • Documentation updated to remove legacy references (includes/ directory, global class name variants) and reflect canonical job type usage only.

[1.0.2] - 2025-10-10

Added

  • GitHub updater integration and release workflows (.github/workflows/*, class-github-plugin-updater.php).
  • Funding configuration (.github/FUNDING.yml).
  • Expanded root README with direct links to documentation set.
  • Composer metadata: enriched description & keywords.

Changed

  • Bumped plugin version to 1.0.2.

Fixed

  • Minor documentation cross-link clarity improvements.

[1.0.1] - 2025-10-10

Added

  • Documentation restructuring: Added docs/README.md index, docs/extending-jobs.md, and docs/usage.md.
  • New filter examples for token scope & route customization in worker-rest-api.md.
  • Advanced guidance: created scaling & maintenance docs placeholders (to be added) and extensibility guide.
  • Rate limiting, token scopes, and request logging documented.

Changed

  • Refactored README.md to concise overview with links.
  • Improved failure handling semantics (null-safe exception handling in jobs).

Fixed

  • Minor doc inconsistencies and clarified token scope behavior.

[1.0.0] - 2025-10-01

Added

  • Initial release: core Redis-backed queue system (priority, delay, retries).
  • Built-in jobs: Email, Image Processing, API Sync.
  • Admin dashboard, job browser, test tools, purge utilities.
  • REST API with job management, stats, health, worker trigger.
  • Basic logging and retry backoff strategies.