octo-server AGENTS.md

AGENTS.md

This file provides guidance to coding agents when working in this repository.

Project Overview

Octo-server is the Go backend for DMWork, an 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 for config, wkhttp, testutil, register, and model packages
• Default branch: main

Common Commands

# Build
docker build -t octo-server .

# Run tests for a 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)
                                                                                       |
                                                                                       v
                                                                                  WuKongIM (gRPC)

Module System

Modules live in modules/. Each module is auto-registered with init() and register.AddModule().

Standard module layout:

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

Key Packages

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