server.go

  1package server
  2
  3import (
  4	"context"
  5	"encoding/json"
  6	"errors"
  7	"log"
  8	"sync"
  9	"time"
 10
 11	"github.com/gofrs/uuid"
 12	"github.com/speps/go-hashids"
 13	"github.com/zikaeroh/codies/internal/game"
 14	"github.com/zikaeroh/codies/internal/protocol"
 15	"go.uber.org/atomic"
 16	"golang.org/x/sync/errgroup"
 17	"nhooyr.io/websocket"
 18	"nhooyr.io/websocket/wsjson"
 19)
 20
 21const maxRooms = 1000
 22
 23var (
 24	ErrRoomExists   = errors.New("server: rooms exist")
 25	ErrTooManyRooms = errors.New("server: too many rooms")
 26)
 27
 28type Server struct {
 29	clientCount atomic.Int64
 30	roomCount   atomic.Int64
 31	doPrune     chan struct{}
 32	ready       chan struct{}
 33
 34	mu sync.Mutex
 35
 36	ctx     context.Context
 37	rooms   map[string]*Room
 38	roomIDs map[string]*Room
 39
 40	hid    *hashids.HashID
 41	nextID int64
 42}
 43
 44func NewServer() *Server {
 45	hd := hashids.NewData()
 46	hd.MinLength = 8
 47	hd.Salt = uuid.Must(uuid.NewV4()).String() // IDs are only valid for this server instance; ok to randomize salt.
 48	hid, err := hashids.NewWithData(hd)
 49	if err != nil {
 50		panic(err)
 51	}
 52
 53	return &Server{
 54		ready:   make(chan struct{}),
 55		doPrune: make(chan struct{}, 1),
 56		rooms:   make(map[string]*Room),
 57		roomIDs: make(map[string]*Room),
 58		hid:     hid,
 59	}
 60}
 61
 62func (s *Server) Run(ctx context.Context) error {
 63	s.ctx = ctx
 64
 65	close(s.ready)
 66	ticker := time.NewTicker(5 * time.Minute)
 67	defer ticker.Stop()
 68
 69	for {
 70		select {
 71		case <-ctx.Done():
 72			return ctx.Err()
 73
 74		case <-s.doPrune:
 75			s.prune()
 76
 77		case <-ticker.C:
 78			s.prune()
 79		}
 80	}
 81}
 82
 83func (s *Server) FindRoom(name string) *Room {
 84	<-s.ready
 85
 86	s.mu.Lock()
 87	defer s.mu.Unlock()
 88	return s.rooms[name]
 89}
 90
 91func (s *Server) FindRoomByID(id string) *Room {
 92	<-s.ready
 93
 94	s.mu.Lock()
 95	defer s.mu.Unlock()
 96	return s.roomIDs[id]
 97}
 98
 99func (s *Server) CreateRoom(name, password string) (*Room, error) {
100	<-s.ready
101
102	s.mu.Lock()
103	defer s.mu.Unlock()
104
105	room := s.rooms[name]
106	if room != nil {
107		return nil, ErrRoomExists
108	}
109
110	if len(s.rooms) >= maxRooms {
111		return nil, ErrTooManyRooms
112	}
113
114	id, err := s.hid.EncodeInt64([]int64{s.nextID})
115	if err != nil {
116		return nil, err
117	}
118	s.nextID++
119
120	ctx, cancel := context.WithCancel(s.ctx)
121
122	room = &Room{
123		Name:        name,
124		Password:    password,
125		ID:          id,
126		clientCount: &s.clientCount,
127		roomCount:   &s.roomCount,
128		ctx:         ctx,
129		cancel:      cancel,
130		room:        game.NewRoom(nil),
131		players:     make(map[game.PlayerID]noteSender),
132		turnSeconds: 60,
133	}
134
135	room.lastSeen.Store(time.Now())
136
137	room.room.NewGame()
138
139	s.rooms[name] = room
140	s.roomIDs[room.ID] = room
141	s.roomCount.Inc()
142
143	log.Printf("created new room '%s' (%s)", name, room.ID)
144
145	if s.nextID%100 == 0 {
146		s.triggerPrune()
147	}
148
149	return room, nil
150}
151
152func (s *Server) triggerPrune() {
153	select {
154	case s.doPrune <- struct{}{}:
155	default:
156	}
157}
158
159func (s *Server) prune() {
160	s.mu.Lock()
161	defer s.mu.Unlock()
162
163	toRemove := make([]string, 0, 1)
164
165	for name, room := range s.rooms {
166		lastSeen := room.lastSeen.Load().(time.Time)
167		if time.Since(lastSeen) > 10*time.Minute {
168			toRemove = append(toRemove, name)
169		}
170	}
171
172	if len(toRemove) == 0 {
173		return
174	}
175
176	for _, name := range toRemove {
177		room := s.rooms[name]
178		room.mu.Lock()
179		room.stopTimer()
180		room.mu.Unlock()
181
182		room.cancel()
183		delete(s.rooms, name)
184		delete(s.roomIDs, room.ID)
185		s.roomCount.Dec()
186	}
187
188	log.Printf("pruned %d rooms", len(toRemove))
189}
190
191func (s *Server) Stats() (rooms, clients int) {
192	s.mu.Lock()
193	defer s.mu.Unlock()
194	return len(s.rooms), int(s.clientCount.Load())
195}
196
197type Room struct {
198	Name     string
199	Password string
200	ID       string
201
202	ctx         context.Context
203	cancel      context.CancelFunc
204	clientCount *atomic.Int64
205	roomCount   *atomic.Int64
206
207	mu       sync.Mutex
208	room     *game.Room
209	players  map[game.PlayerID]noteSender
210	state    *stateCache
211	lastSeen atomic.Value
212
213	timed        bool
214	turnSeconds  int
215	turnDeadline *time.Time
216	turnTimer    *time.Timer
217}
218
219type noteSender func(protocol.ServerNote)
220
221func (r *Room) HandleConn(playerID uuid.UUID, nickname string, c *websocket.Conn) {
222	clientCount := r.clientCount.Inc()
223	log.Printf("client connected to room '%s' (%s); %v clients currently connected to %v rooms", r.Name, r.ID, clientCount, r.roomCount.Load())
224
225	defer func() {
226		clientCount := r.clientCount.Dec()
227		log.Printf("client disconnected from room '%s' (%s); %v clients currently connected to %v rooms", r.Name, r.ID, clientCount, r.roomCount.Load())
228	}()
229
230	defer c.Close(websocket.StatusGoingAway, "going away")
231	g, ctx := errgroup.WithContext(r.ctx)
232
233	r.mu.Lock()
234	r.players[playerID] = func(s protocol.ServerNote) {
235		g.Go(func() error {
236			ctx, cancel := context.WithTimeout(ctx, time.Second)
237			defer cancel()
238			return wsjson.Write(ctx, c, &s)
239		})
240	}
241	r.room.AddPlayer(playerID, nickname)
242	r.sendAll()
243	r.mu.Unlock()
244
245	defer func() {
246		r.mu.Lock()
247		defer r.mu.Unlock()
248		delete(r.players, playerID)
249		r.room.RemovePlayer(playerID)
250		r.sendAll()
251	}()
252
253	g.Go(func() error {
254		ticker := time.NewTicker(time.Minute)
255		defer ticker.Stop()
256
257		for {
258			select {
259			case <-ctx.Done():
260				return ctx.Err()
261			case <-ticker.C:
262			}
263
264			if err := c.Ping(ctx); err != nil {
265				return err
266			}
267
268			r.lastSeen.Store(time.Now())
269		}
270	})
271
272	g.Go(func() error {
273		for {
274			var note protocol.ClientNote
275
276			if err := wsjson.Read(ctx, c, &note); err != nil {
277				return err
278			}
279
280			r.lastSeen.Store(time.Now())
281
282			if err := r.handleNote(playerID, &note); err != nil {
283				log.Println("error handling note:", err)
284				return err
285			}
286		}
287	})
288
289	_ = g.Wait()
290}
291
292func (r *Room) handleNote(playerID game.PlayerID, note *protocol.ClientNote) error {
293	r.mu.Lock()
294	defer r.mu.Unlock()
295
296	// The client's version was wrong; reject and send them the current state.
297	if note.Version != r.room.Version {
298		r.sendOne(playerID, r.players[playerID])
299		return nil
300	}
301
302	before := r.room.Version
303	resetTimer := false
304
305	defer func() {
306		if r.room.Version != before {
307			if r.timed && resetTimer {
308				r.startTimer()
309			}
310			r.sendAll()
311		}
312	}()
313
314	switch note.Method {
315	case protocol.RevealMethod:
316		var params protocol.RevealParams
317		if err := json.Unmarshal(note.Params, &params); err != nil {
318			return err
319		}
320		prevTurn := r.room.Turn
321		r.room.Reveal(playerID, params.Row, params.Col)
322		resetTimer = prevTurn != r.room.Turn
323
324	case protocol.NewGameMethod:
325		var params protocol.NewGameParams
326		if err := json.Unmarshal(note.Params, &params); err != nil {
327			return err
328		}
329		resetTimer = true
330		r.room.NewGame()
331
332	case protocol.EndTurnMethod:
333		var params protocol.EndTurnParams
334		if err := json.Unmarshal(note.Params, &params); err != nil {
335			return err
336		}
337		resetTimer = true
338		r.room.EndTurn(playerID)
339
340	case protocol.RandomizeTeamsMethod:
341		var params protocol.RandomizeTeamsParams
342		if err := json.Unmarshal(note.Params, &params); err != nil {
343			return err
344		}
345		r.room.RandomizeTeams()
346
347	case protocol.ChangeTeamMethod:
348		var params protocol.ChangeTeamParams
349		if err := json.Unmarshal(note.Params, &params); err != nil {
350			return err
351		}
352		r.room.ChangeTeam(playerID, params.Team)
353
354	case protocol.ChangeNicknameMethod:
355		var params protocol.ChangeNicknameParams
356		if err := json.Unmarshal(note.Params, &params); err != nil {
357			return err
358		}
359
360		// Sync with protocol.go's validation method.
361		if len(params.Nickname) < 3 || len(params.Nickname) > 16 {
362			return nil
363		}
364
365		r.room.AddPlayer(playerID, params.Nickname)
366
367	case protocol.ChangeRoleMethod:
368		var params protocol.ChangeRoleParams
369		if err := json.Unmarshal(note.Params, &params); err != nil {
370			return err
371		}
372		r.room.ChangeRole(playerID, params.Spymaster)
373
374	case protocol.ChangePackMethod:
375		var params protocol.ChangePackParams
376		if err := json.Unmarshal(note.Params, &params); err != nil {
377			return err
378		}
379		r.room.ChangePack(params.Num, params.Enable)
380
381	case protocol.ChangeTurnModeMethod:
382		var params protocol.ChangeTurnModeParams
383		if err := json.Unmarshal(note.Params, &params); err != nil {
384			return err
385		}
386		r.changeTurnMode(params.Timed)
387
388	case protocol.ChangeTurnTimeMethod:
389		var params protocol.ChangeTurnTimeParams
390		if err := json.Unmarshal(note.Params, &params); err != nil {
391			return err
392		}
393		r.changeTurnTime(params.Seconds)
394
395	case protocol.AddPacksMethod:
396		var params protocol.AddPacksParams
397		if err := json.Unmarshal(note.Params, &params); err != nil {
398			return err
399		}
400		for _, p := range params.Packs {
401			if len(p.Words) < 25 {
402				continue
403			}
404			r.room.AddPack(p.Name, p.Words)
405		}
406
407	case protocol.RemovePackMethod:
408		var params protocol.RemovePackParams
409		if err := json.Unmarshal(note.Params, &params); err != nil {
410			return err
411		}
412		r.room.RemovePack(params.Num)
413
414	default:
415		log.Printf("unhandled method: %s", note.Method)
416	}
417
418	return nil
419}
420
421// Must be called with r.mu locked.
422func (r *Room) sendAll() {
423	for playerID, sender := range r.players {
424		r.sendOne(playerID, sender)
425	}
426}
427
428// Must be called with r.mu locked.
429func (r *Room) sendOne(playerID game.PlayerID, sender noteSender) {
430	state := r.createStateFor(playerID)
431	note := protocol.StateNote(state)
432	sender(note)
433}
434
435// Must be called with r.mu locked.
436func (r *Room) createStateFor(playerID game.PlayerID) *protocol.State {
437	if r.state == nil || r.state.version != r.room.Version {
438		r.state = r.createStateCache()
439	}
440
441	if r.room.Players[playerID].Spymaster {
442		return r.state.spymaster
443	}
444	return r.state.guesser
445}
446
447type stateCache struct {
448	version   int
449	guesser   *protocol.State
450	spymaster *protocol.State
451}
452
453func (r *Room) createStateCache() *stateCache {
454	return &stateCache{
455		version:   r.room.Version,
456		guesser:   r.createRoomState(false),
457		spymaster: r.createRoomState(true),
458	}
459}
460
461func (r *Room) createRoomState(spymaster bool) *protocol.State {
462	room := r.room
463
464	s := &protocol.State{
465		Version:   room.Version,
466		Teams:     make([][]*protocol.StatePlayer, len(room.Teams)),
467		Turn:      room.Turn,
468		Winner:    room.Winner,
469		Board:     make([][]*protocol.StateTile, room.Board.Rows),
470		WordsLeft: room.Board.WordCounts,
471		Lists:     make([]*protocol.StateWordList, len(room.WordLists)),
472	}
473
474	if r.turnDeadline != nil {
475		s.Timer = &protocol.StateTimer{
476			TurnTime: r.turnSeconds,
477			TurnEnd:  *r.turnDeadline,
478		}
479	}
480
481	for team, members := range room.Teams {
482		for _, id := range members {
483			p := room.Players[id]
484			s.Teams[team] = append(s.Teams[team], &protocol.StatePlayer{
485				PlayerID:  id,
486				Nickname:  p.Nickname,
487				Spymaster: p.Spymaster,
488			})
489		}
490
491		if s.Teams[team] == nil {
492			s.Teams[team] = []*protocol.StatePlayer{}
493		}
494	}
495
496	for row := range s.Board {
497		tiles := make([]*protocol.StateTile, room.Board.Cols)
498		for col := range tiles {
499			tile := room.Board.Get(row, col)
500			sTile := &protocol.StateTile{
501				Word:     tile.Word,
502				Revealed: tile.Revealed,
503			}
504
505			if spymaster || tile.Revealed || room.Winner != nil {
506				sTile.View = &protocol.StateView{
507					Team:    tile.Team,
508					Neutral: tile.Neutral,
509					Bomb:    tile.Bomb,
510				}
511			}
512
513			tiles[col] = sTile
514		}
515
516		s.Board[row] = tiles
517	}
518
519	for i, wl := range room.WordLists {
520		s.Lists[i] = &protocol.StateWordList{
521			Name:    wl.Name,
522			Count:   wl.List.Len(),
523			Custom:  wl.Custom,
524			Enabled: wl.Enabled,
525		}
526	}
527
528	return s
529}
530
531// Must be called with r.mu locked.
532func (r *Room) changeTurnMode(timed bool) {
533	if r.timed == timed {
534		return
535	}
536
537	r.timed = timed
538
539	if timed {
540		r.startTimer()
541	} else {
542		r.stopTimer()
543	}
544
545	r.room.Version++
546}
547
548// Must be called with r.mu locked.
549func (r *Room) changeTurnTime(seconds int) {
550	if seconds <= 0 || r.turnSeconds == seconds {
551		return
552	}
553
554	r.turnSeconds = seconds
555
556	if r.timed {
557		r.startTimer()
558	}
559
560	r.room.Version++
561}
562
563func (r *Room) timerEndTurn() {
564	r.mu.Lock()
565	defer r.mu.Unlock()
566
567	stopped := r.stopTimer()
568	if !stopped {
569		// Room was pruned.
570		return
571	}
572
573	r.turnTimer = nil
574	r.turnDeadline = nil
575
576	if r.room.Winner != nil || r.turnSeconds == 0 {
577		return
578	}
579
580	r.room.ForceEndTurn()
581	r.startTimer()
582	r.sendAll()
583}
584
585// Must be called with r.mu locked.
586func (r *Room) stopTimer() (stopped bool) {
587	if r.turnTimer != nil {
588		r.turnTimer.Stop()
589		stopped = true
590	}
591	r.turnTimer = nil
592	r.turnDeadline = nil
593	return stopped
594}
595
596// Must be called with r.mu locked.
597func (r *Room) startTimer() {
598	if !r.timed {
599		panic("startTimer called on non-timed room")
600	}
601
602	if r.turnTimer != nil {
603		r.turnTimer.Stop()
604	}
605
606	dur := time.Second * time.Duration(r.turnSeconds)
607	deadline := time.Now().Add(dur)
608	r.turnDeadline = &deadline
609	r.turnTimer = time.AfterFunc(dur, r.timerEndTurn)
610}