Skip to content

Complete renaming of links-mq to links-queue, and plan of beating up all the competition#6

Merged
konard merged 4 commits intomainfrom
issue-5-138b1701c6f2
Jan 11, 2026
Merged

Complete renaming of links-mq to links-queue, and plan of beating up all the competition#6
konard merged 4 commits intomainfrom
issue-5-138b1701c6f2

Conversation

@konard
Copy link
Copy Markdown
Member

@konard konard commented Jan 10, 2026

Summary

This PR completes the renaming of the project from links-mq to links-queue and adds comprehensive planning documentation to define the project vision, requirements, architecture, and roadmap.

Changes

1. Project Renaming (links-mq → links-queue)

  • Updated all package names in package.json, Cargo.toml, and package-lock.json
  • Updated all import statements and module references
  • Updated repository URLs and keywords
  • Updated all documentation references

2. New Planning Documents

Document Purpose
VISION.md Project vision - universal queue using links instead of messages
REQUIREMENTS.md Detailed functional and non-functional requirements
ARCHITECTURE.md System architecture with component diagrams
ROADMAP.md 10-phase development plan

3. Key Architectural Decisions

  • Link-Based Data Model: Each queue item is a link (source, target pair), not arbitrary messages
  • Four Operating Modes: Single-memory, single-stored, multi-memory, multi-stored
  • Configuration Over Code: Scale from embedded to distributed without code changes
  • Pluggable Storage: Memory backend, link-cli backend, custom backends
  • Links Notation Protocol: Text-based data exchange with planned binary format

Operating Modes

Mode Persistence Distribution Use Case
single-memory None Single node Development, testing
single-stored link-cli Single node Production single-node
multi-memory None Distributed Ephemeral high-throughput
multi-stored link-cli Distributed Production distributed

Development Phases

  1. Foundation & Planning ✅
  2. Core Link Operations
  3. Single-Node Queue
  4. Persistence (link-cli)
  5. Links Notation Protocol
  6. Server Mode
  7. Multi-Node Clustering
  8. Advanced Features
  9. Observability
  10. Binary Protocol
  11. Ecosystem & Integrations

Test Plan

  • Rust tests pass (cargo test)
  • Rust clippy passes (cargo clippy)
  • JavaScript tests pass (npm test)
  • JavaScript lint passes (npm run lint)
  • Pre-commit hooks pass
  • All references to links-mq renamed to links-queue

References

🤖 Generated with Claude Code

Adding CLAUDE.md with task information for AI processing.
This file will be removed when the task is complete.

Issue: #5
@konard konard self-assigned this Jan 10, 2026
…tation

This commit accomplishes the following:

1. Renamed project from links-mq to links-queue throughout the codebase:
   - Updated all package names, imports, and references
   - Updated repository URLs and keywords
   - Updated documentation to reflect new project identity

2. Added comprehensive planning documentation:
   - VISION.md: Project vision focusing on links as universal queue items
   - REQUIREMENTS.md: Detailed functional and non-functional requirements
   - ARCHITECTURE.md: System architecture with four operating modes
   - ROADMAP.md: 10-phase development plan from foundation to ecosystem

3. Updated COMPARISON.md:
   - Refreshed roadmap section to reference new planning documents
   - Updated all references from links-mq to Links Queue
   - Added operating modes table and development phases

The project now supports four operating modes (single-memory, single-stored,
multi-memory, multi-stored) configurable without code changes, positioning
Links Queue as a universal queue system using links instead of traditional
messages.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@konard konard changed the title [WIP] Complete renaming of links-mq to links-queue, and plan of beating up all the competition Complete renaming of links-mq to links-queue, and plan of beating up all the competition Jan 10, 2026
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@konard konard marked this pull request as ready for review January 10, 2026 19:49
@konard
Copy link
Copy Markdown
Member Author

konard commented Jan 10, 2026

🤖 Solution Draft Log

This log file contains the complete execution trace of the AI solution draft process.

💰 Cost estimation:

  • Public pricing estimate: $7.633266 USD
  • Calculated by Anthropic: $5.463974 USD
  • Difference: $-2.169292 (-28.42%)
    📎 Log file uploaded as GitHub Gist (1069KB)
    🔗 View complete solution draft log

Now working session is ended, feel free to review and add any feedback on the solution draft.

@konard
Copy link
Copy Markdown
Member Author

konard commented Jan 10, 2026

Please create issues in this repository to support our entire ROADMAP (adjust it as needed):

But keep in mind the entire ROADMAP, and use https://github.com/link-foundation/code-architecture-principles, to make sure the architecture will support entire ROADMAP.

Keep in mind that issues should be planned in such a way that we can work on each such issue separately without generating conflicts, so each team member can work separately without overlaps. Everything that overflaps like interface development, examples, tests and so on, should be done in separate issues, so once they are done we can come back to parallel development.

If these or links related projects (check http://github.com/link-foundation and http://github.com/linksplatform for useful tools and libraries) do not have enough features to simplify our implementation, we should report issues in respective repositories.

Each such issue must contain reproducible examples, workarounds and suggestions for fix the issue in code.

@konard konard marked this pull request as draft January 10, 2026 20:34
@konard
Copy link
Copy Markdown
Member Author

konard commented Jan 10, 2026

🤖 AI Work Session Started

Starting automated work session at 2026-01-10T20:34:06.255Z

The PR has been converted to draft mode while work is in progress.

This comment marks the beginning of an AI work session. Please wait working session to finish, and provide your feedback.

@konard
Copy link
Copy Markdown
Member Author

konard commented Jan 10, 2026

ROADMAP Issues Created

I have created 22 issues to support the ROADMAP for parallel development. The issues are structured to allow independent work without conflicts.

Issue Structure

Issues are organized by:

  1. Interface/API Contract issues - Must be completed first to establish the contract
  2. Language-specific implementation issues - Can be worked on in parallel (JS and Rust)
  3. Cross-cutting concerns - Tests, examples, documentation can be worked independently

Phase 1: Core Link Operations

Issue Description Dependencies
#7 Define Link and LinkStore interfaces/traits (API Contract) None
#8 Implement in-memory LinkStore backend (JavaScript) #7
#9 Implement in-memory LinkStore backend (Rust) #7

Phase 2: Single-Node Queue

Issue Description Dependencies
#10 Define Queue and QueueManager interfaces/traits (API Contract) #7
#11 Implement basic Queue and QueueManager (JavaScript) #7, #8, #10
#12 Implement basic Queue and QueueManager (Rust) #7, #9, #10

Phase 3: Persistence (link-cli)

Issue Description Dependencies
#13 Define StorageBackend interface/trait (API Contract) #7
#14 Implement link-cli storage backend (JavaScript) #7, #13
#15 Implement link-cli storage backend (Rust) #7, #13

Phase 4: Links Notation Protocol

Issue Description Dependencies
#16 Integrate links-notation for parsing and serialization #7

Phase 5: Server Mode

Issue Description Dependencies
#17 Implement TCP server mode (JavaScript) #7, #10, #11, #16
#18 Implement TCP server mode (Rust) #7, #10, #12, #16

Phase 6: Multi-Node Clustering

Issue Description Dependencies
#19 Define Cluster and Node interfaces/traits (API Contract) #7, #10
#20 Implement multi-node clustering (JavaScript) #11, #16, #17, #19
#21 Implement multi-node clustering (Rust) #12, #16, #18, #19

Phases 7-10: Advanced Features

Issue Phase Description
#25 7 Implement advanced queue features (scheduling, rate limiting, routing)
#26 8 Implement observability (metrics, logging, health checks)
#27 9 Design and implement Binary Links Notation protocol
#28 10 Create ecosystem integrations and deployment tools

Cross-cutting Issues (Can work independently)

Issue Description
#22 Create examples demonstrating real-world use cases
#23 Set up comprehensive test infrastructure
#24 Create API documentation and usage guides

Parallel Development Strategy

Team members can work independently on:

  1. JS Developer A: [Phase 1] Implement in-memory LinkStore backend (JavaScript) #8[Phase 2] Implement basic Queue and QueueManager (JavaScript) #11[Phase 3] Implement link-cli storage backend (JavaScript) #14[Phase 5] Implement TCP server mode (JavaScript) #17[Phase 6] Implement multi-node clustering (JavaScript) #20
  2. JS Developer B: [Cross-cutting] Create examples demonstrating real-world use cases #22 (examples), [Cross-cutting] Set up comprehensive test infrastructure #23 (tests)
  3. Rust Developer A: [Phase 1] Implement in-memory LinkStore backend (Rust) #9[Phase 2] Implement basic Queue and QueueManager (Rust) #12[Phase 3] Implement link-cli storage backend (Rust) #15[Phase 5] Implement TCP server mode (Rust) #18[Phase 6] Implement multi-node clustering (Rust) #21
  4. Rust Developer B: [Cross-cutting] Create examples demonstrating real-world use cases #22 (examples), [Cross-cutting] Set up comprehensive test infrastructure #23 (tests)
  5. Documentation: [Cross-cutting] Create API documentation and usage guides #24 (can start immediately with existing docs)

Interface issues (#7, #10, #13, #19) should be done first to establish the contract that both implementations follow.


Dependency Issues Reported

I also reported missing features in dependency repositories:

These are workarounds and suggestions that can simplify our implementation.

@konard konard marked this pull request as ready for review January 10, 2026 20:45
@konard
Copy link
Copy Markdown
Member Author

konard commented Jan 10, 2026

🤖 Solution Draft Log

This log file contains the complete execution trace of the AI solution draft process.

💰 Cost estimation:

  • Public pricing estimate: $3.869603 USD
  • Calculated by Anthropic: $3.246693 USD
  • Difference: $-0.622910 (-16.10%)
    📎 Log file uploaded as GitHub Gist (549KB)
    🔗 View complete solution draft log

Now working session is ended, feel free to review and add any feedback on the solution draft.

@konard konard merged commit 93da1d5 into main Jan 11, 2026
24 checks passed
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.

Complete renaming of links-mq to links-queue, and plan of beating up all the competition

1 participant