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		resetTimer = true
321		r.room.Reveal(playerID, params.Row, params.Col)
322
323	case protocol.NewGameMethod:
324		var params protocol.NewGameParams
325		if err := json.Unmarshal(note.Params, &params); err != nil {
326			return err
327		}
328		resetTimer = true
329		r.room.NewGame()
330
331	case protocol.EndTurnMethod:
332		var params protocol.EndTurnParams
333		if err := json.Unmarshal(note.Params, &params); err != nil {
334			return err
335		}
336		resetTimer = true
337		r.room.EndTurn(playerID)
338
339	case protocol.RandomizeTeamsMethod:
340		var params protocol.RandomizeTeamsParams
341		if err := json.Unmarshal(note.Params, &params); err != nil {
342			return err
343		}
344		r.room.RandomizeTeams()
345
346	case protocol.ChangeTeamMethod:
347		var params protocol.ChangeTeamParams
348		if err := json.Unmarshal(note.Params, &params); err != nil {
349			return err
350		}
351		r.room.ChangeTeam(playerID, params.Team)
352
353	case protocol.ChangeNicknameMethod:
354		var params protocol.ChangeNicknameParams
355		if err := json.Unmarshal(note.Params, &params); err != nil {
356			return err
357		}
358
359		// Sync with protocol.go's validation method.
360		if len(params.Nickname) < 3 || len(params.Nickname) > 16 {
361			return nil
362		}
363
364		r.room.AddPlayer(playerID, params.Nickname)
365
366	case protocol.ChangeRoleMethod:
367		var params protocol.ChangeRoleParams
368		if err := json.Unmarshal(note.Params, &params); err != nil {
369			return err
370		}
371		r.room.ChangeRole(playerID, params.Spymaster)
372
373	case protocol.ChangePackMethod:
374		var params protocol.ChangePackParams
375		if err := json.Unmarshal(note.Params, &params); err != nil {
376			return err
377		}
378		r.room.ChangePack(params.Num, params.Enable)
379
380	case protocol.ChangeTurnModeMethod:
381		var params protocol.ChangeTurnModeParams
382		if err := json.Unmarshal(note.Params, &params); err != nil {
383			return err
384		}
385		r.changeTurnMode(params.Timed)
386
387	case protocol.ChangeTurnTimeMethod:
388		var params protocol.ChangeTurnTimeParams
389		if err := json.Unmarshal(note.Params, &params); err != nil {
390			return err
391		}
392		r.changeTurnTime(params.Seconds)
393
394	case protocol.AddPacksMethod:
395		var params protocol.AddPacksParams
396		if err := json.Unmarshal(note.Params, &params); err != nil {
397			return err
398		}
399		for _, p := range params.Packs {
400			if len(p.Words) < 25 {
401				continue
402			}
403			r.room.AddPack(p.Name, p.Words)
404		}
405
406	case protocol.RemovePackMethod:
407		var params protocol.RemovePackParams
408		if err := json.Unmarshal(note.Params, &params); err != nil {
409			return err
410		}
411		r.room.RemovePack(params.Num)
412
413	default:
414		log.Printf("unhandled method: %s", note.Method)
415	}
416
417	return nil
418}
419
420// Must be called with r.mu locked.
421func (r *Room) sendAll() {
422	for playerID, sender := range r.players {
423		r.sendOne(playerID, sender)
424	}
425}
426
427// Must be called with r.mu locked.
428func (r *Room) sendOne(playerID game.PlayerID, sender noteSender) {
429	state := r.createStateFor(playerID)
430	note := protocol.StateNote(state)
431	sender(note)
432}
433
434// Must be called with r.mu locked.
435func (r *Room) createStateFor(playerID game.PlayerID) *protocol.State {
436	if r.state == nil || r.state.version != r.room.Version {
437		r.state = r.createStateCache()
438	}
439
440	if r.room.Players[playerID].Spymaster {
441		return r.state.spymaster
442	}
443	return r.state.guesser
444}
445
446type stateCache struct {
447	version   int
448	guesser   *protocol.State
449	spymaster *protocol.State
450}
451
452func (r *Room) createStateCache() *stateCache {
453	return &stateCache{
454		version:   r.room.Version,
455		guesser:   r.createRoomState(false),
456		spymaster: r.createRoomState(true),
457	}
458}
459
460func (r *Room) createRoomState(spymaster bool) *protocol.State {
461	room := r.room
462
463	s := &protocol.State{
464		Version:   room.Version,
465		Teams:     make([][]*protocol.StatePlayer, len(room.Teams)),
466		Turn:      room.Turn,
467		Winner:    room.Winner,
468		Board:     make([][]*protocol.StateTile, room.Board.Rows),
469		WordsLeft: room.Board.WordCounts,
470		Lists:     make([]*protocol.StateWordList, len(room.WordLists)),
471	}
472
473	if r.turnDeadline != nil {
474		s.Timer = &protocol.StateTimer{
475			TurnTime: r.turnSeconds,
476			TurnEnd:  *r.turnDeadline,
477		}
478	}
479
480	for team, members := range room.Teams {
481		for _, id := range members {
482			p := room.Players[id]
483			s.Teams[team] = append(s.Teams[team], &protocol.StatePlayer{
484				PlayerID:  id,
485				Nickname:  p.Nickname,
486				Spymaster: p.Spymaster,
487			})
488		}
489
490		if s.Teams[team] == nil {
491			s.Teams[team] = []*protocol.StatePlayer{}
492		}
493	}
494
495	for row := range s.Board {
496		tiles := make([]*protocol.StateTile, room.Board.Cols)
497		for col := range tiles {
498			tile := room.Board.Get(row, col)
499			sTile := &protocol.StateTile{
500				Word:     tile.Word,
501				Revealed: tile.Revealed,
502			}
503
504			if spymaster || tile.Revealed || room.Winner != nil {
505				sTile.View = &protocol.StateView{
506					Team:    tile.Team,
507					Neutral: tile.Neutral,
508					Bomb:    tile.Bomb,
509				}
510			}
511
512			tiles[col] = sTile
513		}
514
515		s.Board[row] = tiles
516	}
517
518	for i, wl := range room.WordLists {
519		s.Lists[i] = &protocol.StateWordList{
520			Name:    wl.Name,
521			Count:   wl.List.Len(),
522			Custom:  wl.Custom,
523			Enabled: wl.Enabled,
524		}
525	}
526
527	return s
528}
529
530// Must be called with r.mu locked.
531func (r *Room) changeTurnMode(timed bool) {
532	if r.timed == timed {
533		return
534	}
535
536	r.timed = timed
537
538	if timed {
539		r.startTimer()
540	} else {
541		r.stopTimer()
542	}
543
544	r.room.Version++
545}
546
547// Must be called with r.mu locked.
548func (r *Room) changeTurnTime(seconds int) {
549	if seconds <= 0 || r.turnSeconds == seconds {
550		return
551	}
552
553	r.turnSeconds = seconds
554
555	if r.timed {
556		r.startTimer()
557	}
558
559	r.room.Version++
560}
561
562func (r *Room) timerEndTurn() {
563	r.mu.Lock()
564	defer r.mu.Unlock()
565
566	stopped := r.stopTimer()
567	if !stopped {
568		// Room was pruned.
569		return
570	}
571
572	r.turnTimer = nil
573	r.turnDeadline = nil
574
575	if r.room.Winner != nil || r.turnSeconds == 0 {
576		return
577	}
578
579	r.room.ForceEndTurn()
580	r.startTimer()
581	r.sendAll()
582}
583
584// Must be called with r.mu locked.
585func (r *Room) stopTimer() (stopped bool) {
586	if r.turnTimer != nil {
587		r.turnTimer.Stop()
588		stopped = true
589	}
590	r.turnTimer = nil
591	r.turnDeadline = nil
592	return stopped
593}
594
595// Must be called with r.mu locked.
596func (r *Room) startTimer() {
597	if !r.timed {
598		panic("startTimer called on non-timed room")
599	}
600
601	if r.turnTimer != nil {
602		r.turnTimer.Stop()
603	}
604
605	dur := time.Second * time.Duration(r.turnSeconds)
606	deadline := time.Now().Add(dur)
607	r.turnDeadline = &deadline
608	r.turnTimer = time.AfterFunc(dur, r.timerEndTurn)
609}