Add persistent store implementation (replace in-memory store)

未关闭
#7 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
go
领域
backend, databases

调研方向

Start with pkg/domain/environment/repository.go, pkg/infra/store/memory.go, and its memory_test.go to understand the five-method contract, copy semantics, and error behavior. Then inspect cmd/waggle/main.go:59 for wiring and configuration. Done means a persistent implementation, parallel table-driven coverage, context handling, and updated default wiring satisfy the listed acceptance criteria.

由索引模型根据 Issue 内容生成。

描述

enhancement

Summary

Waggle currently uses an in-memory MemoryStore (pkg/infra/store/memory.go) that implements the environment.Repository interface. All environment state is lost on restart. We need a persistent store so environments can survive server restarts and support operational use cases like auditing.

Current Architecture (DDD)

The codebase follows Domain-Driven Design with clean separation:

  • Domain interface: pkg/domain/environment/repository.go defines Repository with 5 methods: Save, FindByID, FindAll, Delete, Count
  • Current adapter: pkg/infra/store/memory.go implements Repository with a map[string]*Environment + sync.RWMutex
  • Service layer: pkg/service/environment.go depends on the Repository interface (not the concrete store)
  • Wiring: cmd/waggle/main.go:59 instantiates store.NewMemoryStore() and injects it

The service layer calls Save() after every state transition (Creating, Running, Error, Destroying) and Delete() on destroy. FindByID() and FindAll() are read-only. All methods accept context.Context.

Critical contract: copy semantics

The MemoryStore returns copies on both Save() and FindByID() to prevent aliasing bugs. The persistent store must maintain equivalent isolation — a mutated *Environment returned from FindByID() must not affect the stored state until Save() is called again.

Approach

New adapter in pkg/infra/store/

Add a new file (e.g., bolt.go or sqlite.go) implementing environment.Repository. The implementation choice depends on requirements:

Option Pros Cons
bbolt (embedded KV) Zero config, single file, no external deps No SQL, limited query flexibility
SQLite (embedded SQL) SQL queries, mature, well-understood CGO dependency (unless modernc)

For a single-binary MCP server, bbolt or modernc SQLite (pure Go) are good fits — no external database to manage.

Serialization

The Environment struct needs to be serialized/deserialized. Options:

  • JSON (simple, human-readable, already used in MCP responses)
  • Protobuf (compact, schema-versioned — overkill for now)
Wiring change

Only cmd/waggle/main.go needs to change:

// Before
repo := store.NewMemoryStore()

// After (example with bbolt)
repo, err := store.NewBoltStore(cfg.DataDir + "/waggle.db")
if err != nil {
    return fmt.Errorf("open store: %w", err)
}
defer repo.Close()
Configuration

Add a WAGGLE_STORE_PATH env var (or reuse DataDir) for the database file path. The MemoryStore should remain available for testing and as a fallback.

Acceptance Criteria

  • New Repository implementation in pkg/infra/store/ with persistent storage
  • Implements all 5 methods: Save, FindByID, FindAll, Delete, Count
  • Returns environment.ErrNotFound for missing entities (matching MemoryStore contract)
  • Copy semantics maintained (returned *Environment is independent of stored state)
  • Context respected for cancellation/timeout on all operations
  • MemoryStore kept for tests (not deleted)
  • Wiring in main.go updated to use persistent store by default
  • Configuration via environment variable for store path
  • Table-driven parallel unit tests matching memory_test.go coverage
  • doc.go with SPDX headers if new package created
主要语言
Go
星标
4
派生
1
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

stacklok/waggle 的其他 Issue

查看 stacklok/waggle 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。