Skip to content

Fix stale terminology in workqueue READMEs - #91

Merged
pditommaso merged 1 commit into
masterfrom
docs/workqueue-terminology-fixes
Jul 20, 2026
Merged

Fix stale terminology in workqueue READMEs#91
pditommaso merged 1 commit into
masterfrom
docs/workqueue-terminology-fixes

Conversation

@pditommaso

Copy link
Copy Markdown
Contributor

Summary

Docs-only. Aligns two READMEs with the current source after the 0.7.0 / 1.0.0 work-queue rename.

  • lib-cmd-queue-redis/README.md: two leftover "stream" references → "work queue" (the 0.7.0 MessageStreamWorkQueue rename).
  • lib-data-workqueue/README.md: usage example used a non-existent API:
    • MessageConsumer.consume(...)accept(...) (actual interface method)
    • workQueue.consume(...)addConsumer(...) (the async dispatch registration the doc describes; consume() is only a one-shot synchronous pull)

lib-data-workqueue-redis/README.md was checked and needed no changes.

Test plan

Documentation only — no code changes.

🤖 Generated with Claude Code

- lib-cmd-queue-redis: "stream" -> "work queue" (0.7.0 MessageStream->WorkQueue rename)
- lib-data-workqueue: MessageConsumer.consume() -> accept(); workQueue.consume() -> addConsumer()

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@pditommaso
pditommaso requested a review from jordeu July 20, 2026 10:36
@pditommaso
pditommaso merged commit e8fe916 into master Jul 20, 2026
3 checks passed
pditommaso added a commit that referenced this pull request Jul 31, 2026
#100)

Restore both module trees to their state at 8bad0f5 ([release]
lib-data-stream-redis@1.5.0, 14 May 2026) — the commit where stream was 1.5.0
and cmd-queue 0.4.0 — undoing everything released on top of them:

- stream 2.0.0 / cmd-queue 0.5.0: async, non-blocking consumer processing with
  heartbeat lease and the poll/renew/ack/release SPI (PR #84, bdf9374), plus
  doc follow-ups 11fdd3a and 86ae9ac
- cmd-queue 0.5.1: retry command on handler exception (PR #87, 6c7b171)
- cmd-queue 0.6.0: error tracking on CommandState (PR #89, e54229e, 1f124f0)
- cmd-queue 0.7.0: migration to lib-data-workqueue(-redis) and the
  CommandStatus SUBMITTED->PENDING / RUNNING->PROCESSING rename (PR #86,
  f3f4ac4); README follow-up PR #91 (e8fe916)
- the parts of PR #94 (d38afb0) that touched these two modules' sources

cmd-queue therefore depends on lib-data-stream-redis again. lib-data-workqueue
and lib-data-workqueue-redis are left in place untouched — they carry the
lease-based design forward and were never published.

Two build-infra bits from PR #94 are deliberately kept rather than reverted,
since they are repo-wide conventions and not module API: the
io.seqera.micronaut-library-conventions plugin id (Java 25 target for Micronaut
modules) and Groovy 4.0.31 for stream's test dependencies (4.0.24 cannot run on
a JDK 25 toolchain).

The changelogs keep a REVERTED entry recording the withdrawn versions with
their PRs, and cmd-queue's notes the downgrade hazard: 0.7.0-persisted command
state uses PENDING/PROCESSING with a 7-day TTL, which this 0.4.0 code cannot
decode.

Pre-revert state is preserved on branch archive/workqueue-pre-revert (2ecc744),
which also carries the unmerged invocation-lease rework.

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants