octo-server: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code when working with code in this repository.

Project Overview

Octo-server is the Go backend for DMWork (enterprise IM platform). It handles business logic on top of WuKongIM for messaging transport.

• Go Module: github.com/Mininglamp-OSS/octo-server
• Go Version: 1.25
• Shared Library: github.com/Mininglamp-OSS/octo-lib (config, wkhttp, testutil, register, model)
• Default Branch: main

Common Commands

# Build
docker build -t octo-server .

# Run tests (single module)
go test ./modules/group/...
go test ./modules/message/ -run TestSendMsg

# Run all tests
go test ./...

# Lint
golangci-lint run ./...

Architecture

Request Flow

HTTP (Gin/wkhttp) → Auth Middleware (pkg/auth/) → Space Middleware → API Handler → Service → DB (MySQL/DBR)
                                                                          ↓
                                                                    WuKongIM (gRPC)

Module System

27 modules in modules/, each auto-registered via init() + register.AddModule().

Standard module structure:

• 1module.go — registration entry (init() + register.AddModule())
• api*.go — HTTP handlers implementing register.APIRouter.Route(r *wkhttp.WKHttp)
• service.go — business logic, typically defines IService interface
• db*.go — database operations using gocraft/dbr
• model.go — data models and response structs
• sql/ — SQL migrations embedded via //go:embed sql

Key Packages

Package	Purpose
pkg/auth/	Token parsing, CacheTokenParser, auth middleware
pkg/errcode/	Error code definitions per module (group.go, message.go, user.go, oidc.go)
pkg/httperr/	ResponseErrorL / ResponseErrorLWithStatus error facades
pkg/i18n/	Localization SDK: codes registry, localizer, renderer, language negotiation, locales/
internal/	Internal wiring, module imports
modules/base/event/	Async event system