fetch_ml/internal/api/protocol.go
Jeremie Fraeys 7e5ceec069
feat(api): add groups and tokens handlers, refactor routes
Add new API endpoints and clean up handler interfaces:

- groups/handlers.go: New lab group management API
  * CRUD operations for lab groups
  * Member management with role assignment (admin/member/viewer)
  * Group listing and membership queries

- tokens/handlers.go: Token generation and validation endpoints
  * Create access tokens for public task sharing
  * Validate tokens for secure access
  * Token revocation and cleanup

- routes.go: Refactor handler registration
  * Integrate groups handler into WebSocket routes
  * Remove nil parameters from all handler constructors
  * Cleaner dependency injection pattern

- Handler interface cleanup across all modules:
  * jobs/handlers.go: Remove unused nil privacyEnforcer parameter
  * jupyter/handlers.go: Streamline initialization
  * scheduler/handlers.go: Consistent constructor signature
  * ws/handler.go: Add groups handler to dependencies
2026-03-08 12:51:25 -04:00

373 lines
9.3 KiB
Go

package api
import (
"encoding/binary"
"encoding/json"
"fmt"
"sync"
"time"
)
// safeUint64FromTime safely converts time.Time to uint64 timestamp
func safeUint64FromTime(t time.Time) uint64 {
unix := t.Unix()
if unix < 0 {
return 0
}
return uint64(unix)
}
var bufferPool = sync.Pool{
New: func() interface{} {
buf := make([]byte, 0, 256)
return &buf
},
}
// Response packet types
const (
PacketTypeSuccess = 0x00
PacketTypeError = 0x01
PacketTypeProgress = 0x02
PacketTypeStatus = 0x03
PacketTypeData = 0x04
PacketTypeLog = 0x05
)
// Error codes
const (
ErrorCodeUnknownError = 0x00
ErrorCodeInvalidRequest = 0x01
ErrorCodeAuthenticationFailed = 0x02
ErrorCodePermissionDenied = 0x03
ErrorCodeResourceNotFound = 0x04
ErrorCodeResourceAlreadyExists = 0x05
ErrorCodeServerOverloaded = 0x10
ErrorCodeDatabaseError = 0x11
ErrorCodeNetworkError = 0x12
ErrorCodeStorageError = 0x13
ErrorCodeTimeout = 0x14
ErrorCodeJobNotFound = 0x20
ErrorCodeJobAlreadyRunning = 0x21
ErrorCodeJobFailedToStart = 0x22
ErrorCodeJobExecutionFailed = 0x23
ErrorCodeJobCancelled = 0x24
ErrorCodeOutOfMemory = 0x30
ErrorCodeDiskFull = 0x31
ErrorCodeInvalidConfiguration = 0x32
ErrorCodeServiceUnavailable = 0x33
)
// Progress types
const (
ProgressTypePercentage = 0x00
ProgressTypeStage = 0x01
ProgressTypeMessage = 0x02
ProgressTypeBytesTransferred = 0x03
)
// Log levels
const (
LogLevelDebug = 0x00
LogLevelInfo = 0x01
LogLevelWarn = 0x02
LogLevelError = 0x03
)
// ResponsePacket represents a structured response packet
type ResponsePacket struct {
DataType string
SuccessMessage string
LogMessage string
ErrorMessage string
ErrorDetails string
ProgressMessage string
StatusData string
DataPayload []byte
Timestamp uint64
ProgressValue uint32
ProgressTotal uint32
ErrorCode byte
ProgressType byte
LogLevel byte
PacketType byte
}
// NewSuccessPacket creates a success response packet
func NewSuccessPacket(message string) *ResponsePacket {
return &ResponsePacket{
PacketType: PacketTypeSuccess,
Timestamp: safeUint64FromTime(time.Now()),
SuccessMessage: message,
}
}
// NewSuccessPacketWithPayload creates a success response packet with JSON payload
func NewSuccessPacketWithPayload(message string, payload interface{}) *ResponsePacket {
// Convert payload to JSON for the DataPayload field
payloadBytes, _ := json.Marshal(payload)
return &ResponsePacket{
PacketType: PacketTypeData,
Timestamp: safeUint64FromTime(time.Now()),
SuccessMessage: message,
DataType: "status",
DataPayload: payloadBytes,
}
}
// NewErrorPacket creates an error response packet
func NewErrorPacket(errorCode byte, message string, details string) *ResponsePacket {
return &ResponsePacket{
PacketType: PacketTypeError,
Timestamp: safeUint64FromTime(time.Now()),
ErrorCode: errorCode,
ErrorMessage: message,
ErrorDetails: details,
}
}
// NewProgressPacket creates a progress response packet
func NewProgressPacket(
progressType byte,
value uint32,
total uint32,
message string,
) *ResponsePacket {
return &ResponsePacket{
PacketType: PacketTypeProgress,
Timestamp: safeUint64FromTime(time.Now()),
ProgressType: progressType,
ProgressValue: value,
ProgressTotal: total,
ProgressMessage: message,
}
}
// NewStatusPacket creates a status response packet
func NewStatusPacket(data string) *ResponsePacket {
return &ResponsePacket{
PacketType: PacketTypeStatus,
Timestamp: safeUint64FromTime(time.Now()),
StatusData: data,
}
}
// NewDataPacket creates a data response packet
func NewDataPacket(dataType string, payload []byte) *ResponsePacket {
return &ResponsePacket{
PacketType: PacketTypeData,
Timestamp: safeUint64FromTime(time.Now()),
DataType: dataType,
DataPayload: payload,
}
}
// NewLogPacket creates a log response packet
func NewLogPacket(level byte, message string) *ResponsePacket {
return &ResponsePacket{
PacketType: PacketTypeLog,
Timestamp: safeUint64FromTime(time.Now()),
LogLevel: level,
LogMessage: message,
}
}
// Serialize converts the packet to binary format
func (p *ResponsePacket) Serialize() ([]byte, error) {
// For small packets, avoid pool overhead
if p.estimatedSize() <= 1024 {
buf := make([]byte, 0, p.estimatedSize())
return serializePacketToBuffer(p, buf)
}
// Use pool for larger packets
bufPtr := bufferPool.Get().(*[]byte)
defer func() {
*bufPtr = (*bufPtr)[:0]
bufferPool.Put(bufPtr)
}()
buf := *bufPtr
// Ensure buffer has enough capacity
if cap(buf) < p.estimatedSize() {
buf = make([]byte, 0, p.estimatedSize())
} else {
buf = buf[:0]
}
return serializePacketToBuffer(p, buf)
}
func serializePacketToBuffer(p *ResponsePacket, buf []byte) ([]byte, error) {
// Packet type
buf = append(buf, p.PacketType)
// Timestamp (8 bytes, big-endian)
var timestampBytes [8]byte
binary.BigEndian.PutUint64(timestampBytes[:], p.Timestamp)
buf = append(buf, timestampBytes[:]...)
// Packet-specific data
switch p.PacketType {
case PacketTypeSuccess:
buf = appendString(buf, p.SuccessMessage)
case PacketTypeError:
buf = append(buf, p.ErrorCode)
buf = appendString(buf, p.ErrorMessage)
buf = appendString(buf, p.ErrorDetails)
case PacketTypeProgress:
buf = append(buf, p.ProgressType)
buf = appendUint32(buf, p.ProgressValue)
buf = appendUint32(buf, p.ProgressTotal)
buf = appendString(buf, p.ProgressMessage)
case PacketTypeStatus:
buf = appendString(buf, p.StatusData)
case PacketTypeData:
buf = appendString(buf, p.DataType)
buf = appendBytes(buf, p.DataPayload)
case PacketTypeLog:
buf = append(buf, p.LogLevel)
buf = appendString(buf, p.LogMessage)
default:
return nil, fmt.Errorf("unknown packet type: %d", p.PacketType)
}
return buf, nil
}
// uint16ToBytes extracts high and low bytes from uint16 safely
func uint16ToBytes(v uint16) (high, low byte) {
var b [2]byte
binary.BigEndian.PutUint16(b[:], v)
return b[0], b[1]
}
// appendString writes a string with fixed 16-bit length prefix
func appendString(buf []byte, s string) []byte {
length := min(len(s), 65535)
// #nosec G115 -- length is bounded by min() to 65535, safe conversion
len16 := uint16(length)
high, low := uint16ToBytes(len16)
buf = append(buf, high, low)
buf = append(buf, s...)
return buf
}
// uint32ToBytes extracts 4 bytes from uint32 safely
func uint32ToBytes(v uint32) [4]byte {
var b [4]byte
binary.BigEndian.PutUint32(b[:], v)
return b
}
// appendBytes writes bytes with fixed 32-bit length prefix
func appendBytes(buf []byte, b []byte) []byte {
length := min(len(b), 4294967295)
// #nosec G115 -- length is bounded by min() to max uint32, safe conversion
len32 := uint32(length)
bytes := uint32ToBytes(len32)
buf = append(buf, bytes[:]...)
buf = append(buf, b...)
return buf
}
func appendUint32(buf []byte, value uint32) []byte {
var tmp [4]byte
binary.BigEndian.PutUint32(tmp[:], value)
return append(buf, tmp[:]...)
}
func (p *ResponsePacket) estimatedSize() int {
base := 1 + 8 // packet type + timestamp
switch p.PacketType {
case PacketTypeSuccess:
return base + 2 + len(p.SuccessMessage)
case PacketTypeError:
return base + 1 + 2 + len(p.ErrorMessage) + 2 + len(p.ErrorDetails)
case PacketTypeProgress:
return base + 1 + 4 + 4 + 2 + len(p.ProgressMessage)
case PacketTypeStatus:
return base + 2 + len(p.StatusData)
case PacketTypeData:
return base + 2 + len(p.DataType) + 4 + len(p.DataPayload)
case PacketTypeLog:
return base + 1 + 2 + len(p.LogMessage)
default:
return base
}
}
// GetErrorMessage returns a human-readable error message for an error code
func GetErrorMessage(code byte) string {
switch code {
case ErrorCodeUnknownError:
return "Unknown error occurred"
case ErrorCodeInvalidRequest:
return "Invalid request format"
case ErrorCodeAuthenticationFailed:
return "Authentication failed"
case ErrorCodePermissionDenied:
return "Permission denied"
case ErrorCodeResourceNotFound:
return "Resource not found"
case ErrorCodeResourceAlreadyExists:
return "Resource already exists"
case ErrorCodeServerOverloaded:
return "Server is overloaded"
case ErrorCodeDatabaseError:
return "Database error occurred"
case ErrorCodeNetworkError:
return "Network error occurred"
case ErrorCodeStorageError:
return "Storage error occurred"
case ErrorCodeTimeout:
return "Operation timed out"
case ErrorCodeJobNotFound:
return "Job not found"
case ErrorCodeJobAlreadyRunning:
return "Job is already running"
case ErrorCodeJobFailedToStart:
return "Job failed to start"
case ErrorCodeJobExecutionFailed:
return "Job execution failed"
case ErrorCodeJobCancelled:
return "Job was cancelled"
case ErrorCodeOutOfMemory:
return "Server out of memory"
case ErrorCodeDiskFull:
return "Server disk full"
case ErrorCodeInvalidConfiguration:
return "Invalid server configuration"
case ErrorCodeServiceUnavailable:
return "Service temporarily unavailable"
default:
return "Unknown error code"
}
}
// GetLogLevelName returns the name for a log level
func GetLogLevelName(level byte) string {
switch level {
case LogLevelDebug:
return "DEBUG"
case LogLevelInfo:
return "INFO"
case LogLevelWarn:
return "WARN"
case LogLevelError:
return "ERROR"
default:
return "UNKNOWN"
}
}