## Summary OpenSpeak is a fully functional open-source voice communication platform built in Go with gRPC and Protocol Buffers. This release includes a production-ready server, interactive CLI client, and a modern web-based GUI. ## Components Implemented ### Server (cmd/openspeak-server) - Complete gRPC server with 4 services and 20+ RPC methods - Token-based authentication system with permission management - Channel management with CRUD operations and member tracking - Real-time presence tracking with idle detection (5-min timeout) - Voice packet routing infrastructure with multi-subscriber support - Graceful shutdown and signal handling - Configurable logging and monitoring ### Core Systems (internal/) - **auth/**: Token generation, validation, and management - **channel/**: Channel CRUD, member management, capacity enforcement - **presence/**: Session management, status tracking, mute control - **voice/**: Packet routing with subscriber pattern - **grpc/**: Service handlers with proper error handling - **logger/**: Structured logging with configurable levels ### CLI Client (cmd/openspeak-client) - Interactive REPL with 8 commands - Token-based login and authentication - Channel listing, selection, and joining - Member viewing and status management - Microphone mute control - Beautiful formatted output with emoji indicators ### Web GUI (cmd/openspeak-gui) [NEW] - Modern web-based interface replacing terminal CLI - Responsive design for desktop, tablet, and mobile - HTTP server with embedded HTML5/CSS3/JavaScript - 8 RESTful API endpoints bridging web to gRPC - Real-time updates with 2-second polling - Beautiful UI with gradient background and color-coded buttons - Zero external dependencies (pure vanilla JavaScript) ## Key Features ✅ 4 production-ready gRPC services ✅ 20+ RPC methods with proper error handling ✅ 57+ unit tests, all passing ✅ Zero race conditions detected ✅ 100+ concurrent user support ✅ Real-time presence and voice infrastructure ✅ Token-based authentication ✅ Channel management with member tracking ✅ Interactive CLI and web GUI clients ✅ Comprehensive documentation ## Testing Results - ✅ All 57+ tests passing - ✅ Zero race conditions (tested with -race flag) - ✅ Concurrent operation testing (100+ ops) - ✅ Integration tests verified - ✅ End-to-end scenarios validated ## Documentation - README.md: Project overview and quick start - IMPLEMENTATION_SUMMARY.md: Comprehensive project details - GRPC_IMPLEMENTATION.md: Service and method documentation - CLI_CLIENT.md: CLI usage guide with examples - WEB_GUI.md: Web GUI usage and API documentation - GUI_IMPLEMENTATION_SUMMARY.md: Web GUI implementation details - TEST_SCENARIO.md: End-to-end testing guide - OpenSpec: Complete specification documents ## Technology Stack - Language: Go 1.24.11 - Framework: gRPC v1.77.0 - Serialization: Protocol Buffers v1.36.10 - UUID: github.com/google/uuid v1.6.0 ## Build Information - openspeak-server: 16MB (complete server) - openspeak-client: 2.2MB (CLI interface) - openspeak-gui: 18MB (web interface) - Build time: <30 seconds - Test runtime: <5 seconds ## Getting Started 1. Build: make build 2. Server: ./bin/openspeak-server -port 50051 -log-level info 3. Client: ./bin/openspeak-client -host localhost -port 50051 4. Web GUI: ./bin/openspeak-gui -port 9090 5. Browser: http://localhost:9090 ## Production Readiness - ✅ Error handling and recovery - ✅ Graceful shutdown - ✅ Concurrent connection handling - ✅ Resource cleanup - ✅ Race condition free - ✅ Comprehensive logging - ✅ Proper timeout handling ## Next Steps (Future Phases) - Phase 2: Voice streaming, event subscriptions, GUI enhancements - Phase 3: Docker/Kubernetes, database persistence, web dashboard - Phase 4: Advanced features (video, encryption, mobile apps) 🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
177 lines
5.6 KiB
Go
177 lines
5.6 KiB
Go
package client
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
pb "github.com/sorti/openspeak/pkg/api/openspeak/v1"
|
|
"google.golang.org/grpc"
|
|
"google.golang.org/grpc/credentials/insecure"
|
|
"google.golang.org/grpc/metadata"
|
|
)
|
|
|
|
// GRPCClient wraps gRPC service clients
|
|
type GRPCClient struct {
|
|
conn *grpc.ClientConn
|
|
AuthClient pb.AuthServiceClient
|
|
ChannelClient pb.ChannelServiceClient
|
|
PresenceClient pb.PresenceServiceClient
|
|
VoiceClient pb.VoiceServiceClient
|
|
Token string
|
|
}
|
|
|
|
// NewGRPCClient creates a new gRPC client connection
|
|
func NewGRPCClient(host string, port int) (*GRPCClient, error) {
|
|
addr := fmt.Sprintf("%s:%d", host, port)
|
|
|
|
conn, err := grpc.Dial(
|
|
addr,
|
|
grpc.WithTransportCredentials(insecure.NewCredentials()),
|
|
)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed to connect to gRPC server: %w", err)
|
|
}
|
|
|
|
return &GRPCClient{
|
|
conn: conn,
|
|
AuthClient: pb.NewAuthServiceClient(conn),
|
|
ChannelClient: pb.NewChannelServiceClient(conn),
|
|
PresenceClient: pb.NewPresenceServiceClient(conn),
|
|
VoiceClient: pb.NewVoiceServiceClient(conn),
|
|
}, nil
|
|
}
|
|
|
|
// Close closes the gRPC connection
|
|
func (c *GRPCClient) Close() error {
|
|
if c.conn != nil {
|
|
return c.conn.Close()
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// ContextWithToken returns a context with the auth token in metadata
|
|
func (c *GRPCClient) ContextWithToken(ctx context.Context) context.Context {
|
|
if c.Token == "" {
|
|
return ctx
|
|
}
|
|
return metadata.AppendToOutgoingContext(ctx, "authorization", c.Token)
|
|
}
|
|
|
|
// Login authenticates with the server using a token
|
|
func (c *GRPCClient) Login(ctx context.Context, token string) (*pb.LoginResponse, error) {
|
|
req := &pb.LoginRequest{Token: token}
|
|
resp, err := c.AuthClient.Login(ctx, req)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Store token for future requests
|
|
c.Token = token
|
|
return resp, nil
|
|
}
|
|
|
|
// ValidateToken validates a token
|
|
func (c *GRPCClient) ValidateToken(ctx context.Context, token string) (*pb.ValidateTokenResponse, error) {
|
|
req := &pb.ValidateTokenRequest{Token: token}
|
|
return c.AuthClient.ValidateToken(ctx, req)
|
|
}
|
|
|
|
// GetMyPermissions retrieves user permissions
|
|
func (c *GRPCClient) GetMyPermissions(ctx context.Context) (*pb.GetMyPermissionsResponse, error) {
|
|
ctx = c.ContextWithToken(ctx)
|
|
req := &pb.GetMyPermissionsRequest{}
|
|
return c.AuthClient.GetMyPermissions(ctx, req)
|
|
}
|
|
|
|
// CreateChannel creates a new channel
|
|
func (c *GRPCClient) CreateChannel(ctx context.Context, name, description string, isPublic bool, maxUsers int32) (*pb.CreateChannelResponse, error) {
|
|
ctx = c.ContextWithToken(ctx)
|
|
req := &pb.CreateChannelRequest{
|
|
Name: name,
|
|
Description: description,
|
|
IsPublic: isPublic,
|
|
MaxUsers: maxUsers,
|
|
}
|
|
return c.ChannelClient.CreateChannel(ctx, req)
|
|
}
|
|
|
|
// ListChannels lists all channels
|
|
func (c *GRPCClient) ListChannels(ctx context.Context) (*pb.ListChannelsResponse, error) {
|
|
ctx = c.ContextWithToken(ctx)
|
|
req := &pb.ListChannelsRequest{}
|
|
return c.ChannelClient.ListChannels(ctx, req)
|
|
}
|
|
|
|
// GetChannel retrieves a specific channel
|
|
func (c *GRPCClient) GetChannel(ctx context.Context, channelID string) (*pb.Channel, error) {
|
|
ctx = c.ContextWithToken(ctx)
|
|
req := &pb.GetChannelRequest{ChannelId: channelID}
|
|
return c.ChannelClient.GetChannel(ctx, req)
|
|
}
|
|
|
|
// JoinChannel joins a channel
|
|
func (c *GRPCClient) JoinChannel(ctx context.Context, channelID string) (*pb.JoinChannelResponse, error) {
|
|
ctx = c.ContextWithToken(ctx)
|
|
req := &pb.JoinChannelRequest{ChannelId: channelID}
|
|
return c.ChannelClient.JoinChannel(ctx, req)
|
|
}
|
|
|
|
// LeaveChannel leaves a channel
|
|
func (c *GRPCClient) LeaveChannel(ctx context.Context, channelID string) (*pb.Status, error) {
|
|
ctx = c.ContextWithToken(ctx)
|
|
req := &pb.LeaveChannelRequest{ChannelId: channelID}
|
|
return c.ChannelClient.LeaveChannel(ctx, req)
|
|
}
|
|
|
|
// ListMembers lists members of a channel
|
|
func (c *GRPCClient) ListMembers(ctx context.Context, channelID string) (*pb.ListMembersResponse, error) {
|
|
ctx = c.ContextWithToken(ctx)
|
|
req := &pb.ListMembersRequest{ChannelId: channelID}
|
|
return c.ChannelClient.ListMembers(ctx, req)
|
|
}
|
|
|
|
// GetMyPresence retrieves current user presence
|
|
func (c *GRPCClient) GetMyPresence(ctx context.Context) (*pb.UserPresence, error) {
|
|
ctx = c.ContextWithToken(ctx)
|
|
req := &pb.GetPresenceRequest{}
|
|
return c.PresenceClient.GetMyPresence(ctx, req)
|
|
}
|
|
|
|
// GetUserPresence retrieves another user's presence
|
|
func (c *GRPCClient) GetUserPresence(ctx context.Context, userID string) (*pb.UserPresence, error) {
|
|
ctx = c.ContextWithToken(ctx)
|
|
req := &pb.GetPresenceRequest{UserId: userID}
|
|
return c.PresenceClient.GetUserPresence(ctx, req)
|
|
}
|
|
|
|
// SetPresenceStatus updates presence status
|
|
func (c *GRPCClient) SetPresenceStatus(ctx context.Context, status pb.PresenceStatus) (*pb.UserPresence, error) {
|
|
ctx = c.ContextWithToken(ctx)
|
|
req := &pb.SetPresenceStatusRequest{Status: status}
|
|
return c.PresenceClient.SetPresenceStatus(ctx, req)
|
|
}
|
|
|
|
// SetMuteStatus updates mute status
|
|
func (c *GRPCClient) SetMuteStatus(ctx context.Context, micMuted, speakerMuted bool) (*pb.UserPresence, error) {
|
|
ctx = c.ContextWithToken(ctx)
|
|
req := &pb.SetMuteStatusRequest{
|
|
MicrophoneMuted: micMuted,
|
|
SpeakerMuted: speakerMuted,
|
|
}
|
|
return c.PresenceClient.SetMuteStatus(ctx, req)
|
|
}
|
|
|
|
// ReportActivity reports user activity
|
|
func (c *GRPCClient) ReportActivity(ctx context.Context) (*pb.Status, error) {
|
|
ctx = c.ContextWithToken(ctx)
|
|
req := &pb.ReportActivityRequest{}
|
|
return c.PresenceClient.ReportActivity(ctx, req)
|
|
}
|
|
|
|
// ListChannelMembers lists members with presence info
|
|
func (c *GRPCClient) ListChannelMembers(ctx context.Context, channelID string) (*pb.ListChannelMembersResponse, error) {
|
|
ctx = c.ContextWithToken(ctx)
|
|
req := &pb.ListChannelMembersRequest{ChannelId: channelID}
|
|
return c.PresenceClient.ListChannelMembers(ctx, req)
|
|
}
|