Draft: big refactor

server/backend/api/getLobbyUsers.go

@@ -0,0 +1,29 @@
+package api
+
+import (
+	"net/http"
+
+	"gitea.konchin.com/ytshih/inp2025/game/server/middlewares"
+	"github.com/uptrace/bunrouter"
+)
+
+// GetLobbyUsers
+//
+//	@Router	/api/lobby/users [get]
+func (self *Handlers) GetLobbyUsers(
+	w http.ResponseWriter,
+	req bunrouter.Request,
+) error {
+	ctx := req.Context()
+
+	userStatuses, err := self.db.GetUserStatuses(ctx)
+	if err != nil {
+		return middlewares.HTTPError{
+			StatusCode:  http.StatusInternalServerError,
+			Message:     "failed to get user statuses",
+			OriginError: err,
+		}
+	}
+
+	return bunrouter.JSON(w, userStatuses)
+}

server/backend/api/getUser.go

@@ -0,0 +1,55 @@
+package api
+
+import (
+	"database/sql"
+	"net/http"
+
+	"gitea.konchin.com/ytshih/inp2025/game/server/middlewares"
+	"github.com/uptrace/bunrouter"
+)
+
+type GetUserOutput struct {
+	Username string `json:"username"`
+}
+
+// GetUser
+//
+//	@Accept		json
+//	@Param		username	query	string	true	"Username to be queried"
+//	@Success	200
+//	@Failure	400
+//	@Router		/api/user [get]
+func (self *Handlers) GetUser(
+	w http.ResponseWriter,
+	req bunrouter.Request,
+) error {
+	ctx := req.Context()
+
+	username := req.URL.Query().Get("username")
+	if username == "" {
+		return middlewares.HTTPError{
+			StatusCode: http.StatusBadRequest,
+			Message:    "must provide username",
+		}
+	}
+
+	user, err := self.db.GetUser(ctx, username)
+	if err != nil {
+		if err == sql.ErrNoRows {
+			return middlewares.HTTPError{
+				StatusCode:  http.StatusNotFound,
+				Message:     "user not exist",
+				OriginError: err,
+			}
+		}
+		return middlewares.HTTPError{
+			StatusCode:  http.StatusInternalServerError,
+			Message:     "failed to get user",
+			OriginError: err,
+		}
+	}
+
+	return bunrouter.JSON(w, GetUserOutput{
+		Username: user.Username,
+	})
+}

server/backend/api/handlers.go

@@ -0,0 +1,13 @@
+package api
+
+import (
+	"gitea.konchin.com/ytshih/inp2025/game/interfaces"
+)
+
+type Handlers struct {
+	db interfaces.Database
+}
+
+func NewHandlers(db interfaces.Database) *Handlers {
+	return &Handlers{db: db}
+}

server/backend/auth/getLogin.go

@@ -0,0 +1,37 @@
+package auth
+
+import (
+	"net/http"
+
+	"gitea.konchin.com/ytshih/inp2025/game/models"
+	"gitea.konchin.com/ytshih/inp2025/game/server/middlewares"
+	"gitea.konchin.com/ytshih/inp2025/game/types"
+	"gitea.konchin.com/ytshih/inp2025/game/utils"
+	"github.com/uptrace/bunrouter"
+)
+
+func (self *Handlers) GetLogin(
+	w http.ResponseWriter,
+	req bunrouter.Request,
+) error {
+	ctx := req.Context()
+	user, ok := ctx.Value(types.User("")).(models.User)
+	if !ok {
+		return middlewares.HTTPError{
+			StatusCode: http.StatusUnauthorized,
+			Message:    "user not found",
+		}
+	}
+
+	err := self.db.InsertUserStatus(ctx,
+		models.UserStatus{Username: user.Username})
+	if err != nil {
+		return middlewares.HTTPError{
+			StatusCode:  http.StatusInternalServerError,
+			Message:     "failed to update user status",
+			OriginError: err,
+		}
+	}
+
+	return utils.Success(w)
+}

server/backend/auth/handlers.go

@@ -0,0 +1,13 @@
+package auth
+
+import (
+	"gitea.konchin.com/ytshih/inp2025/game/interfaces"
+)
+
+type Handlers struct {
+	db interfaces.Database
+}
+
+func NewHandlers(db interfaces.Database) *Handlers {
+	return &Handlers{db: db}
+}

server/backend/auth/postLogout.go

@@ -0,0 +1,40 @@
+package auth
+
+import (
+	"net/http"
+
+	"gitea.konchin.com/ytshih/inp2025/game/models"
+	"gitea.konchin.com/ytshih/inp2025/game/server/middlewares"
+	"gitea.konchin.com/ytshih/inp2025/game/types"
+	"gitea.konchin.com/ytshih/inp2025/game/utils"
+	"github.com/uptrace/bunrouter"
+)
+
+// PostLogout
+//
+//	@Success	200
+//	@Router		/auth/logout [post]
+func (self *Handlers) PostLogout(
+	w http.ResponseWriter,
+	req bunrouter.Request,
+) error {
+	ctx := req.Context()
+
+	user, ok := ctx.Value(types.User("")).(models.User)
+	if !ok {
+		return middlewares.HTTPError{
+			StatusCode: http.StatusBadRequest,
+			Message:    "missing user",
+		}
+	}
+
+	if err := self.db.DeleteUserStatus(ctx, user.Username); err != nil {
+		return middlewares.HTTPError{
+			StatusCode:  http.StatusInternalServerError,
+			Message:     "failed to delete user status",
+			OriginError: err,
+		}
+	}
+
+	return utils.Success(w)
+}

server/backend/auth/postRegister.go

@@ -0,0 +1,62 @@
+package auth
+
+import (
+	"encoding/json"
+	"io"
+	"net/http"
+
+	"gitea.konchin.com/ytshih/inp2025/game/models"
+	"gitea.konchin.com/ytshih/inp2025/game/server/middlewares"
+	"gitea.konchin.com/ytshih/inp2025/game/types"
+	"gitea.konchin.com/ytshih/inp2025/game/utils"
+	"github.com/uptrace/bunrouter"
+)
+
+// PostRegister
+//
+//	@Accept		json
+//	@Param		request	body	models.User	true	"query params"
+//	@Success	200
+//	@Failure	400
+//	@Router		/auth/register [post]
+func (self *Handlers) PostRegister(
+	w http.ResponseWriter,
+	req bunrouter.Request,
+) error {
+	ctx := req.Context()
+
+	b, err := io.ReadAll(req.Body)
+	if err != nil {
+		return middlewares.HTTPError{
+			StatusCode:  http.StatusBadRequest,
+			Message:     "failed to read body payload",
+			OriginError: err,
+		}
+	}
+
+	var user models.User
+	if err := json.Unmarshal(b, &user); err != nil {
+		return middlewares.HTTPError{
+			StatusCode:  http.StatusBadRequest,
+			Message:     "failed to unmarshal json into user",
+			OriginError: err,
+		}
+	}
+
+	if err := self.db.InsertUser(ctx, user); err != nil {
+		if err == types.UsernameConflictError {
+			return middlewares.HTTPError{
+				StatusCode:  http.StatusBadRequest,
+				Message:     "username already exist",
+				OriginError: err,
+			}
+		}
+		return middlewares.HTTPError{
+			StatusCode:  http.StatusInternalServerError,
+			Message:     "failed to insert user",
+			OriginError: err,
+		}
+	}
+
+	return utils.Success(w)
+}

server/docs/docs.go

@@ -0,0 +1,122 @@
+// Package docs Code generated by swaggo/swag. DO NOT EDIT
+package docs
+
+import "github.com/swaggo/swag"
+
+const docTemplate = `{
+    "schemes": {{ marshal .Schemes }},
+    "swagger": "2.0",
+    "info": {
+        "description": "{{escape .Description}}",
+        "title": "{{.Title}}",
+        "contact": {},
+        "license": {
+            "name": "0BSD"
+        },
+        "version": "{{.Version}}"
+    },
+    "host": "{{.Host}}",
+    "basePath": "{{.BasePath}}",
+    "paths": {
+        "/api/lobby/users": {
+            "get": {
+                "responses": {}
+            }
+        },
+        "/api/user": {
+            "get": {
+                "consumes": [
+                    "application/json"
+                ],
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Username to be queried",
+                        "name": "username",
+                        "in": "query",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK"
+                    },
+                    "400": {
+                        "description": "Bad Request"
+                    }
+                }
+            }
+        },
+        "/auth/logout": {
+            "post": {
+                "responses": {
+                    "200": {
+                        "description": "OK"
+                    }
+                }
+            }
+        },
+        "/auth/register": {
+            "post": {
+                "consumes": [
+                    "application/json"
+                ],
+                "parameters": [
+                    {
+                        "description": "query params",
+                        "name": "request",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/models.User"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK"
+                    },
+                    "400": {
+                        "description": "Bad Request"
+                    }
+                }
+            }
+        }
+    },
+    "definitions": {
+        "models.User": {
+            "type": "object",
+            "properties": {
+                "password": {
+                    "type": "string"
+                },
+                "username": {
+                    "type": "string"
+                }
+            }
+        }
+    },
+    "securityDefinitions": {
+        "BasicAuth": {
+            "type": "basic"
+        }
+    }
+}`
+
+// SwaggerInfo holds exported Swagger Info so clients can modify it
+var SwaggerInfo = &swag.Spec{
+	Version:          "0.0.1-alpha",
+	Host:             "",
+	BasePath:         "/",
+	Schemes:          []string{},
+	Title:            "Intro. to Network Programming Game",
+	Description:      "",
+	InfoInstanceName: "swagger",
+	SwaggerTemplate:  docTemplate,
+	LeftDelim:        "{{",
+	RightDelim:       "}}",
+}
+
+func init() {
+	swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
+}

server/docs/swagger.json

@@ -0,0 +1,96 @@
+{
+    "swagger": "2.0",
+    "info": {
+        "title": "Intro. to Network Programming Game",
+        "contact": {},
+        "license": {
+            "name": "0BSD"
+        },
+        "version": "0.0.1-alpha"
+    },
+    "basePath": "/",
+    "paths": {
+        "/api/lobby/users": {
+            "get": {
+                "responses": {}
+            }
+        },
+        "/api/user": {
+            "get": {
+                "consumes": [
+                    "application/json"
+                ],
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Username to be queried",
+                        "name": "username",
+                        "in": "query",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK"
+                    },
+                    "400": {
+                        "description": "Bad Request"
+                    }
+                }
+            }
+        },
+        "/auth/logout": {
+            "post": {
+                "responses": {
+                    "200": {
+                        "description": "OK"
+                    }
+                }
+            }
+        },
+        "/auth/register": {
+            "post": {
+                "consumes": [
+                    "application/json"
+                ],
+                "parameters": [
+                    {
+                        "description": "query params",
+                        "name": "request",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/models.User"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK"
+                    },
+                    "400": {
+                        "description": "Bad Request"
+                    }
+                }
+            }
+        }
+    },
+    "definitions": {
+        "models.User": {
+            "type": "object",
+            "properties": {
+                "password": {
+                    "type": "string"
+                },
+                "username": {
+                    "type": "string"
+                }
+            }
+        }
+    },
+    "securityDefinitions": {
+        "BasicAuth": {
+            "type": "basic"
+        }
+    }
+}

server/docs/swagger.yaml

@@ -0,0 +1,59 @@
+basePath: /
+definitions:
+  models.User:
+    properties:
+      password:
+        type: string
+      username:
+        type: string
+    type: object
+info:
+  contact: {}
+  license:
+    name: 0BSD
+  title: Intro. to Network Programming Game
+  version: 0.0.1-alpha
+paths:
+  /api/lobby/users:
+    get:
+      responses: {}
+  /api/user:
+    get:
+      consumes:
+      - application/json
+      parameters:
+      - description: Username to be queried
+        in: query
+        name: username
+        required: true
+        type: string
+      responses:
+        "200":
+          description: OK
+        "400":
+          description: Bad Request
+  /auth/logout:
+    post:
+      responses:
+        "200":
+          description: OK
+  /auth/register:
+    post:
+      consumes:
+      - application/json
+      parameters:
+      - description: query params
+        in: body
+        name: request
+        required: true
+        schema:
+          $ref: '#/definitions/models.User'
+      responses:
+        "200":
+          description: OK
+        "400":
+          description: Bad Request
+securityDefinitions:
+  BasicAuth:
+    type: basic
+swagger: "2.0"

server/middlewares/accessLog.go

@@ -0,0 +1,18 @@
+package middlewares
+
+import (
+	"net/http"
+
+	"gitea.konchin.com/ytshih/inp2025/game/tracing"
+	"github.com/uptrace/bunrouter"
+)
+
+func (self *Handlers) AccessLog(
+	next bunrouter.HandlerFunc,
+) bunrouter.HandlerFunc {
+	return func(w http.ResponseWriter, req bunrouter.Request) error {
+		tracing.Logger.
+			Info(req.Method + " " + req.Params().Route())
+		return next(w, req)
+	}
+}

server/middlewares/auth.go

@@ -0,0 +1,56 @@
+package middlewares
+
+import (
+	"context"
+	"net/http"
+
+	"gitea.konchin.com/ytshih/inp2025/game/models"
+	"gitea.konchin.com/ytshih/inp2025/game/tracing"
+	"gitea.konchin.com/ytshih/inp2025/game/types"
+	"github.com/uptrace/bunrouter"
+	"go.uber.org/zap"
+)
+
+func (self *Handlers) Auth(
+	next bunrouter.HandlerFunc,
+) bunrouter.HandlerFunc {
+	return func(w http.ResponseWriter, req bunrouter.Request) error {
+		ctx := req.Context()
+
+		username, password, ok := req.BasicAuth()
+		if !ok {
+			return HTTPError{
+				StatusCode: http.StatusBadRequest,
+				Message:    "basic auth wrong format",
+			}
+		}
+
+		dbUser, err := self.db.GetUser(ctx, username)
+		if err != nil {
+			return HTTPError{
+				StatusCode:  http.StatusBadRequest,
+				Message:     "username not exist",
+				OriginError: err,
+			}
+		}
+
+		if dbUser.Password != password {
+			tracing.Logger.
+				Debug("password input",
+					zap.String("input.password", password),
+					zap.String("dbuser.password", dbUser.Password))
+			return HTTPError{
+				StatusCode: http.StatusUnauthorized,
+				Message:    "password incorrect",
+			}
+		}
+
+		user := models.User{
+			Username: username,
+			Password: password,
+		}
+
+		ctx = context.WithValue(ctx, types.User(""), user)
+		return next(w, req.WithContext(ctx))
+	}
+}

server/middlewares/bunrouterOtel.go

@@ -0,0 +1,50 @@
+package middlewares
+
+import (
+	"net/http"
+
+	"gitea.konchin.com/ytshih/inp2025/game/utils"
+	"github.com/uptrace/bunrouter"
+	"go.opentelemetry.io/otel/attribute"
+	semconv "go.opentelemetry.io/otel/semconv/v1.17.0"
+	"go.opentelemetry.io/otel/trace"
+)
+
+func (self *Handlers) BunrouterOtel(
+	next bunrouter.HandlerFunc,
+) bunrouter.HandlerFunc {
+	return func(w http.ResponseWriter, req bunrouter.Request) error {
+		span := trace.SpanFromContext(req.Context())
+		if !span.IsRecording() {
+			return next(w, req)
+		}
+
+		params := req.Params()
+		span.SetName(req.Method + " " + params.Route())
+
+		paramSlice := params.Slice()
+		attrs := make([]attribute.KeyValue, 0, 3+len(paramSlice))
+
+		attrs = append(attrs, semconv.HTTPRouteKey.String(req.Route()))
+
+		if req.URL != nil {
+			attrs = append(attrs, semconv.HTTPTargetKey.String(req.URL.RequestURI()))
+		} else {
+			// This should never occur if the request was generated by the net/http
+			// package. Fail gracefully, if it does though.
+			attrs = append(attrs, semconv.HTTPTargetKey.String(req.RequestURI))
+		}
+
+		attrs = append(attrs, semconv.HTTPClientIPKey.String(
+			utils.GetRemoteAddr(req)))
+
+		for _, param := range paramSlice {
+			attrs = append(attrs, attribute.String("http.route.param."+param.Key,
+				param.Value))
+		}
+
+		span.SetAttributes(attrs...)
+
+		return next(w, req)
+	}
+}

server/middlewares/errorHandler.go

@@ -0,0 +1,87 @@
+package middlewares
+
+import (
+	"net/http"
+
+	"gitea.konchin.com/ytshih/inp2025/game/tracing"
+	"github.com/uptrace/bunrouter"
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/codes"
+	"go.opentelemetry.io/otel/trace"
+	"go.uber.org/zap"
+)
+
+type HTTPError struct {
+	StatusCode  int    `json:"code"`
+	Message     string `json:"message"`
+	OriginError error  `json:"-"`
+}
+
+func (e HTTPError) Error() string {
+	return e.Message
+}
+
+func NewHTTPError(err error) HTTPError {
+	return HTTPError{
+		StatusCode:  http.StatusInternalServerError,
+		Message:     "Internal server error with unknown reason",
+		OriginError: err,
+	}
+}
+
+func (self *Handlers) ErrorHandler(
+	next bunrouter.HandlerFunc,
+) bunrouter.HandlerFunc {
+	return func(w http.ResponseWriter, req bunrouter.Request) error {
+		err := next(w, req)
+		ctx := req.Context()
+
+		var httpErr HTTPError
+		switch err := err.(type) {
+		case nil:
+			return nil
+
+		case HTTPError:
+			httpErr = err
+
+		default:
+			tracing.Logger.
+				Error("unhandled error",
+					zap.Error(err))
+			httpErr = NewHTTPError(err)
+		}
+
+		// https://opentelemetry.io/docs/specs/semconv/http/http-spans/#status
+		span := trace.SpanFromContext(ctx)
+		span.SetAttributes(
+			attribute.Int("http.response.status_code", httpErr.StatusCode),
+		)
+
+		if 500 <= httpErr.StatusCode && httpErr.StatusCode <= 599 {
+			span.SetStatus(codes.Error, err.Error())
+			if httpErr.OriginError == nil {
+				tracing.Logger.
+					Error(httpErr.Message)
+			} else {
+				tracing.Logger.
+					Error(httpErr.Message,
+						zap.Error(httpErr.OriginError))
+			}
+		} else {
+			span.SetStatus(codes.Ok, "")
+			if httpErr.OriginError == nil {
+				tracing.Logger.
+					Warn(httpErr.Message)
+			} else {
+				tracing.Logger.
+					Warn(httpErr.Message,
+						zap.Error(httpErr.OriginError))
+			}
+		}
+
+		w.WriteHeader(httpErr.StatusCode)
+		_ = bunrouter.JSON(w, httpErr)
+
+		return err
+	}
+}

server/middlewares/handler.go

@@ -0,0 +1,11 @@
+package middlewares
+
+import "gitea.konchin.com/ytshih/inp2025/game/interfaces"
+
+type Handlers struct {
+	db interfaces.Database
+}
+
+func NewHandlers(db interfaces.Database) *Handlers {
+	return &Handlers{db: db}
+}

server/wordle/handlers.go

@@ -0,0 +1,60 @@
+package wordle
+
+import (
+	"gitea.konchin.com/ytshih/inp2025/game/types"
+	"github.com/gorilla/websocket"
+)
+
+type OperationType int
+
+const (
+	OperationTypeGuess OperationType = iota
+)
+
+type Operation struct {
+	Type     OperationType
+	Username string
+	Guess    string
+}
+
+type Handlers struct {
+	state    types.WordleState
+	ans      string
+	upgrader websocket.Upgrader
+
+	opCh chan Operation
+	subs []*chan types.WordleState
+}
+
+func NewHandlers() *Handlers {
+	ret := &Handlers{
+		upgrader: websocket.Upgrader{
+			ReadBufferSize:  1024,
+			WriteBufferSize: 1024,
+		},
+
+		subs: nil,
+	}
+	go ret.GameFlow()
+	return ret
+}
+
+func (self *Handlers) GameFlow() {
+	for op := range self.opCh {
+		switch op.Type {
+		case OperationTypeGuess:
+			self.state.CurrentGuess++
+			if self.state.CurrentGuess >= len(self.state.Users) {
+				for username, user := range self.state.Users {
+					user.History = append(user.History,
+						types.NewWord(op.Guess, self.ans))
+					self.state.Users[username] = user
+				}
+
+				for _, sub := range self.subs {
+					*sub <- self.state
+				}
+			}
+		}
+	}
+}

server/wordle/wsGetState.go

@@ -0,0 +1,44 @@
+package wordle
+
+import (
+	"net/http"
+
+	"gitea.konchin.com/ytshih/inp2025/game/server/middlewares"
+	"gitea.konchin.com/ytshih/inp2025/game/types"
+	"gitea.konchin.com/ytshih/inp2025/game/utils"
+	"github.com/gorilla/websocket"
+	"github.com/uptrace/bunrouter"
+	"github.com/vmihailenco/msgpack/v5"
+)
+
+func (self *Handlers) WSGetState(
+	w http.ResponseWriter,
+	req bunrouter.Request,
+) error {
+	c, err := self.upgrader.Upgrade(w, req.Request, nil)
+	if err != nil {
+		return middlewares.HTTPError{
+			StatusCode:  http.StatusInternalServerError,
+			Message:     "failed to upgrade websocket",
+			OriginError: err,
+		}
+	}
+	defer c.Close()
+
+	dataCh := make(chan types.WordleState)
+	self.subs = append(self.subs, &dataCh)
+
+	for data := range dataCh {
+		b, err := msgpack.Marshal(data)
+		if err != nil {
+			return middlewares.HTTPError{
+				StatusCode:  http.StatusInternalServerError,
+				Message:     "failed to marshal data into msgpack",
+				OriginError: err,
+			}
+		}
+		c.WriteMessage(websocket.BinaryMessage, b)
+	}
+
+	return utils.Success(w)
+}