From 34592a45efd9ceb0579c8eae1ba752da7f625950 Mon Sep 17 00:00:00 2001 From: nsfisis Date: Sat, 17 Aug 2024 19:35:47 +0900 Subject: refactor(backend): move fortee package --- backend/auth/auth.go | 4 +- backend/auth/fortee/fortee.go | 46 ------ backend/auth/fortee/generated.go | 292 --------------------------------------- 3 files changed, 2 insertions(+), 340 deletions(-) delete mode 100644 backend/auth/fortee/fortee.go delete mode 100644 backend/auth/fortee/generated.go (limited to 'backend/auth') diff --git a/backend/auth/auth.go b/backend/auth/auth.go index 0e55d8d..10906f5 100644 --- a/backend/auth/auth.go +++ b/backend/auth/auth.go @@ -8,8 +8,8 @@ import ( "github.com/jackc/pgx/v5" "golang.org/x/crypto/bcrypt" - "github.com/nsfisis/iosdc-japan-2024-albatross/backend/auth/fortee" "github.com/nsfisis/iosdc-japan-2024-albatross/backend/db" + "github.com/nsfisis/iosdc-japan-2024-albatross/backend/fortee" ) var ( @@ -119,7 +119,7 @@ func verifyForteeAccount(ctx context.Context, username string, password string) ctx, cancel := context.WithTimeout(ctx, forteeAPITimeout) defer cancel() - canonicalizedUsername, err := fortee.LoginFortee(ctx, username, password) + canonicalizedUsername, err := fortee.Login(ctx, username, password) if errors.Is(err, context.DeadlineExceeded) { return "", ErrForteeLoginTimeout } diff --git a/backend/auth/fortee/fortee.go b/backend/auth/fortee/fortee.go deleted file mode 100644 index 25ca9c5..0000000 --- a/backend/auth/fortee/fortee.go +++ /dev/null @@ -1,46 +0,0 @@ -package fortee - -import ( - "context" - "errors" - "net/http" -) - -const ( - apiEndpoint = "https://fortee.jp" -) - -var ( - ErrLoginFailed = errors.New("fortee login failed") -) - -func LoginFortee(ctx context.Context, username string, password string) (string, error) { - client, err := NewClientWithResponses(apiEndpoint, WithRequestEditorFn(addAcceptHeader)) - if err != nil { - return "", err - } - res, err := client.PostLoginWithFormdataBodyWithResponse(ctx, PostLoginFormdataRequestBody{ - Username: username, - Password: password, - }) - if err != nil { - return "", err - } - if res.StatusCode() != http.StatusOK { - return "", ErrLoginFailed - } - resOk := res.JSON200 - if !resOk.LoggedIn { - return "", ErrLoginFailed - } - if resOk.User == nil { - return "", ErrLoginFailed - } - return resOk.User.Username, nil -} - -// fortee API denies requests without Accept header. -func addAcceptHeader(_ context.Context, req *http.Request) error { - req.Header.Set("Accept", "application/json") - return nil -} diff --git a/backend/auth/fortee/generated.go b/backend/auth/fortee/generated.go deleted file mode 100644 index 53529f9..0000000 --- a/backend/auth/fortee/generated.go +++ /dev/null @@ -1,292 +0,0 @@ -// Package fortee provides primitives to interact with the openapi HTTP API. -// -// Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.3.0 DO NOT EDIT. -package fortee - -import ( - "context" - "encoding/json" - "fmt" - "io" - "net/http" - "net/url" - "strings" - - "github.com/oapi-codegen/runtime" -) - -// PostLoginFormdataBody defines parameters for PostLogin. -type PostLoginFormdataBody struct { - Password string `form:"password" json:"password"` - Username string `form:"username" json:"username"` -} - -// PostLoginFormdataRequestBody defines body for PostLogin for application/x-www-form-urlencoded ContentType. -type PostLoginFormdataRequestBody PostLoginFormdataBody - -// RequestEditorFn is the function signature for the RequestEditor callback function -type RequestEditorFn func(ctx context.Context, req *http.Request) error - -// Doer performs HTTP requests. -// -// The standard http.Client implements this interface. -type HttpRequestDoer interface { - Do(req *http.Request) (*http.Response, error) -} - -// Client which conforms to the OpenAPI3 specification for this service. -type Client struct { - // The endpoint of the server conforming to this interface, with scheme, - // https://api.deepmap.com for example. This can contain a path relative - // to the server, such as https://api.deepmap.com/dev-test, and all the - // paths in the swagger spec will be appended to the server. - Server string - - // Doer for performing requests, typically a *http.Client with any - // customized settings, such as certificate chains. - Client HttpRequestDoer - - // A list of callbacks for modifying requests which are generated before sending over - // the network. - RequestEditors []RequestEditorFn -} - -// ClientOption allows setting custom parameters during construction -type ClientOption func(*Client) error - -// Creates a new Client, with reasonable defaults -func NewClient(server string, opts ...ClientOption) (*Client, error) { - // create a client with sane default values - client := Client{ - Server: server, - } - // mutate client and add all optional params - for _, o := range opts { - if err := o(&client); err != nil { - return nil, err - } - } - // ensure the server URL always has a trailing slash - if !strings.HasSuffix(client.Server, "/") { - client.Server += "/" - } - // create httpClient, if not already present - if client.Client == nil { - client.Client = &http.Client{} - } - return &client, nil -} - -// WithHTTPClient allows overriding the default Doer, which is -// automatically created using http.Client. This is useful for tests. -func WithHTTPClient(doer HttpRequestDoer) ClientOption { - return func(c *Client) error { - c.Client = doer - return nil - } -} - -// WithRequestEditorFn allows setting up a callback function, which will be -// called right before sending the request. This can be used to mutate the request. -func WithRequestEditorFn(fn RequestEditorFn) ClientOption { - return func(c *Client) error { - c.RequestEditors = append(c.RequestEditors, fn) - return nil - } -} - -// The interface specification for the client above. -type ClientInterface interface { - // PostLoginWithBody request with any body - PostLoginWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) - - PostLoginWithFormdataBody(ctx context.Context, body PostLoginFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) -} - -func (c *Client) PostLoginWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) { - req, err := NewPostLoginRequestWithBody(c.Server, contentType, body) - if err != nil { - return nil, err - } - req = req.WithContext(ctx) - if err := c.applyEditors(ctx, req, reqEditors); err != nil { - return nil, err - } - return c.Client.Do(req) -} - -func (c *Client) PostLoginWithFormdataBody(ctx context.Context, body PostLoginFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) { - req, err := NewPostLoginRequestWithFormdataBody(c.Server, body) - if err != nil { - return nil, err - } - req = req.WithContext(ctx) - if err := c.applyEditors(ctx, req, reqEditors); err != nil { - return nil, err - } - return c.Client.Do(req) -} - -// NewPostLoginRequestWithFormdataBody calls the generic PostLogin builder with application/x-www-form-urlencoded body -func NewPostLoginRequestWithFormdataBody(server string, body PostLoginFormdataRequestBody) (*http.Request, error) { - var bodyReader io.Reader - bodyStr, err := runtime.MarshalForm(body, nil) - if err != nil { - return nil, err - } - bodyReader = strings.NewReader(bodyStr.Encode()) - return NewPostLoginRequestWithBody(server, "application/x-www-form-urlencoded", bodyReader) -} - -// NewPostLoginRequestWithBody generates requests for PostLogin with any type of body -func NewPostLoginRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error) { - var err error - - serverURL, err := url.Parse(server) - if err != nil { - return nil, err - } - - operationPath := fmt.Sprintf("/api/user/login") - if operationPath[0] == '/' { - operationPath = "." + operationPath - } - - queryURL, err := serverURL.Parse(operationPath) - if err != nil { - return nil, err - } - - req, err := http.NewRequest("POST", queryURL.String(), body) - if err != nil { - return nil, err - } - - req.Header.Add("Content-Type", contentType) - - return req, nil -} - -func (c *Client) applyEditors(ctx context.Context, req *http.Request, additionalEditors []RequestEditorFn) error { - for _, r := range c.RequestEditors { - if err := r(ctx, req); err != nil { - return err - } - } - for _, r := range additionalEditors { - if err := r(ctx, req); err != nil { - return err - } - } - return nil -} - -// ClientWithResponses builds on ClientInterface to offer response payloads -type ClientWithResponses struct { - ClientInterface -} - -// NewClientWithResponses creates a new ClientWithResponses, which wraps -// Client with return type handling -func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error) { - client, err := NewClient(server, opts...) - if err != nil { - return nil, err - } - return &ClientWithResponses{client}, nil -} - -// WithBaseURL overrides the baseURL. -func WithBaseURL(baseURL string) ClientOption { - return func(c *Client) error { - newBaseURL, err := url.Parse(baseURL) - if err != nil { - return err - } - c.Server = newBaseURL.String() - return nil - } -} - -// ClientWithResponsesInterface is the interface specification for the client with responses above. -type ClientWithResponsesInterface interface { - // PostLoginWithBodyWithResponse request with any body - PostLoginWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostLoginResponse, error) - - PostLoginWithFormdataBodyWithResponse(ctx context.Context, body PostLoginFormdataRequestBody, reqEditors ...RequestEditorFn) (*PostLoginResponse, error) -} - -type PostLoginResponse struct { - Body []byte - HTTPResponse *http.Response - JSON200 *struct { - LoggedIn bool `json:"loggedIn"` - User *struct { - Username string `json:"username"` - } `json:"user,omitempty"` - } -} - -// Status returns HTTPResponse.Status -func (r PostLoginResponse) Status() string { - if r.HTTPResponse != nil { - return r.HTTPResponse.Status - } - return http.StatusText(0) -} - -// StatusCode returns HTTPResponse.StatusCode -func (r PostLoginResponse) StatusCode() int { - if r.HTTPResponse != nil { - return r.HTTPResponse.StatusCode - } - return 0 -} - -// PostLoginWithBodyWithResponse request with arbitrary body returning *PostLoginResponse -func (c *ClientWithResponses) PostLoginWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostLoginResponse, error) { - rsp, err := c.PostLoginWithBody(ctx, contentType, body, reqEditors...) - if err != nil { - return nil, err - } - return ParsePostLoginResponse(rsp) -} - -func (c *ClientWithResponses) PostLoginWithFormdataBodyWithResponse(ctx context.Context, body PostLoginFormdataRequestBody, reqEditors ...RequestEditorFn) (*PostLoginResponse, error) { - rsp, err := c.PostLoginWithFormdataBody(ctx, body, reqEditors...) - if err != nil { - return nil, err - } - return ParsePostLoginResponse(rsp) -} - -// ParsePostLoginResponse parses an HTTP response from a PostLoginWithResponse call -func ParsePostLoginResponse(rsp *http.Response) (*PostLoginResponse, error) { - bodyBytes, err := io.ReadAll(rsp.Body) - defer func() { _ = rsp.Body.Close() }() - if err != nil { - return nil, err - } - - response := &PostLoginResponse{ - Body: bodyBytes, - HTTPResponse: rsp, - } - - switch { - case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: - var dest struct { - LoggedIn bool `json:"loggedIn"` - User *struct { - Username string `json:"username"` - } `json:"user,omitempty"` - } - if err := json.Unmarshal(bodyBytes, &dest); err != nil { - return nil, err - } - response.JSON200 = &dest - - } - - return response, nil -} -- cgit v1.2.3-70-g09d2 From 95dd5f0c346d10c9a9497daf88cd199ce71c8122 Mon Sep 17 00:00:00 2001 From: nsfisis Date: Sat, 17 Aug 2024 19:35:56 +0900 Subject: feat(backend): fetch user icon from fortee --- backend/account/icon.go | 85 ++++++++++++++++++++++++++++++++++++++ backend/admin/handler.go | 26 ++++++++++++ backend/admin/templates/users.html | 3 ++ backend/auth/auth.go | 9 ++++ backend/db/query.sql.go | 16 +++++++ backend/fortee/fortee.go | 6 +-- backend/main.go | 9 ++++ backend/query.sql | 5 +++ compose.local.yaml | 3 ++ compose.prod.yaml | 4 ++ nginx.conf | 4 ++ 11 files changed, 167 insertions(+), 3 deletions(-) create mode 100644 backend/account/icon.go (limited to 'backend/auth') diff --git a/backend/account/icon.go b/backend/account/icon.go new file mode 100644 index 0000000..40632c6 --- /dev/null +++ b/backend/account/icon.go @@ -0,0 +1,85 @@ +package account + +import ( + "context" + "fmt" + "io" + "net/http" + "net/url" + "os" + "path" + "path/filepath" + "time" + + "github.com/nsfisis/iosdc-japan-2024-albatross/backend/db" + "github.com/nsfisis/iosdc-japan-2024-albatross/backend/fortee" +) + +func FetchIcon( + ctx context.Context, + q *db.Queries, + userID int, +) error { + ctx, cancel := context.WithTimeout(ctx, 15*time.Second) + defer cancel() + + // Fetch user. + user, err := q.GetUserByID(ctx, int32(userID)) + if err != nil { + return fmt.Errorf("failed to fetch user icon (uid=%d): %w", userID, err) + } + // Fetch user icon URL. + avatarURL, err := fortee.GetUserAvatarURL(ctx, user.Username) + if err != nil { + return fmt.Errorf("failed to fetch user icon (uid=%d): %w", userID, err) + } + // Download user icon file. + filePath := fmt.Sprintf("/files/%s/icon%s", url.PathEscape(user.Username), path.Ext(avatarURL)) + if err := downloadFile(ctx, fortee.Endpoint+avatarURL, "/data"+filePath); err != nil { + return fmt.Errorf("failed to fetch user icon (uid=%d): %w", userID, err) + } + // Save user icon path. + if err := q.UpdateUserIconPath(ctx, db.UpdateUserIconPathParams{ + UserID: int32(userID), + IconPath: &filePath, + }); err != nil { + return fmt.Errorf("failed to fetch user icon (uid=%d): %w", userID, err) + } + return nil +} + +func downloadFile(ctx context.Context, url string, filePath string) error { + req, err := http.NewRequestWithContext(ctx, "GET", url, nil) + if err != nil { + return fmt.Errorf("failed to download file (%s): %w", url, err) + } + + client := &http.Client{} + res, err := client.Do(req) + if err != nil { + return fmt.Errorf("failed to download file (%s): %w", url, err) + } + defer res.Body.Close() + + if res.StatusCode != http.StatusOK { + return fmt.Errorf("failed to download file (%s): status %d", url, res.StatusCode) + } + + fileDir := filepath.Dir(filePath) + if err := os.MkdirAll(fileDir, 0755); err != nil { + return fmt.Errorf("failed to create directory (%s): %w", fileDir, err) + } + + file, err := os.Create(filePath) + if err != nil { + return fmt.Errorf("failed to open file (%s): %w", filePath, err) + } + defer file.Close() + + _, err = io.Copy(file, res.Body) + if err != nil { + return fmt.Errorf("failed to save file (%s): %w", filePath, err) + } + + return nil +} diff --git a/backend/admin/handler.go b/backend/admin/handler.go index 41eacd4..1b60de5 100644 --- a/backend/admin/handler.go +++ b/backend/admin/handler.go @@ -1,7 +1,9 @@ package admin import ( + "context" "errors" + "log" "net/http" "strconv" "time" @@ -10,6 +12,7 @@ import ( "github.com/jackc/pgx/v5/pgtype" "github.com/labstack/echo/v4" + "github.com/nsfisis/iosdc-japan-2024-albatross/backend/account" "github.com/nsfisis/iosdc-japan-2024-albatross/backend/auth" "github.com/nsfisis/iosdc-japan-2024-albatross/backend/db" ) @@ -58,6 +61,7 @@ func (h *Handler) RegisterHandlers(g *echo.Group) { g.GET("/dashboard", h.getDashboard) g.GET("/users", h.getUsers) g.GET("/users/:userID", h.getUserEdit) + g.POST("/users/:userID/fetch-icon", h.postUserFetchIcon) g.GET("/games", h.getGames) g.GET("/games/:gameID", h.getGameEdit) g.POST("/games/:gameID", h.postGameEdit) @@ -116,6 +120,28 @@ func (h *Handler) getUserEdit(c echo.Context) error { }) } +func (h *Handler) postUserFetchIcon(c echo.Context) error { + userID, err := strconv.Atoi(c.Param("userID")) + if err != nil { + return echo.NewHTTPError(http.StatusBadRequest, "Invalid user id") + } + row, err := h.q.GetUserByID(c.Request().Context(), int32(userID)) + if err != nil { + if errors.Is(err, pgx.ErrNoRows) { + return echo.NewHTTPError(http.StatusNotFound) + } + return echo.NewHTTPError(http.StatusInternalServerError, err.Error()) + } + go func() { + err := account.FetchIcon(context.Background(), h.q, int(row.UserID)) + if err != nil { + log.Printf("%v", err) + // The failure is intentionally ignored. Retry manually if needed. + } + }() + return c.Redirect(http.StatusSeeOther, "/iosdc-japan/2024/code-battle/admin/users") +} + func (h *Handler) getGames(c echo.Context) error { rows, err := h.q.ListGames(c.Request().Context()) if err != nil { diff --git a/backend/admin/templates/users.html b/backend/admin/templates/users.html index 3543457..3dc03c0 100644 --- a/backend/admin/templates/users.html +++ b/backend/admin/templates/users.html @@ -11,6 +11,9 @@ {{ .DisplayName }} (id={{ .UserID }} username={{ .Username }}){{ if .IsAdmin }} admin{{ end }} +
+ +
{{ end }} diff --git a/backend/auth/auth.go b/backend/auth/auth.go index 10906f5..2266c50 100644 --- a/backend/auth/auth.go +++ b/backend/auth/auth.go @@ -3,11 +3,13 @@ package auth import ( "context" "errors" + "log" "time" "github.com/jackc/pgx/v5" "golang.org/x/crypto/bcrypt" + "github.com/nsfisis/iosdc-japan-2024-albatross/backend/account" "github.com/nsfisis/iosdc-japan-2024-albatross/backend/db" "github.com/nsfisis/iosdc-japan-2024-albatross/backend/fortee" ) @@ -98,6 +100,13 @@ func signup( }); err != nil { return 0, err } + go func() { + err := account.FetchIcon(context.Background(), queries, int(userID)) + if err != nil { + log.Printf("%v", err) + // The failure is intentionally ignored. Retry manually if needed. + } + }() return int(userID), nil } diff --git a/backend/db/query.sql.go b/backend/db/query.sql.go index 02e660a..35b7edd 100644 --- a/backend/db/query.sql.go +++ b/backend/db/query.sql.go @@ -584,3 +584,19 @@ func (q *Queries) UpdateGameState(ctx context.Context, arg UpdateGameStateParams _, err := q.db.Exec(ctx, updateGameState, arg.GameID, arg.State) return err } + +const updateUserIconPath = `-- name: UpdateUserIconPath :exec +UPDATE users +SET icon_path = $2 +WHERE user_id = $1 +` + +type UpdateUserIconPathParams struct { + UserID int32 + IconPath *string +} + +func (q *Queries) UpdateUserIconPath(ctx context.Context, arg UpdateUserIconPathParams) error { + _, err := q.db.Exec(ctx, updateUserIconPath, arg.UserID, arg.IconPath) + return err +} diff --git a/backend/fortee/fortee.go b/backend/fortee/fortee.go index 79ba065..cfe4eff 100644 --- a/backend/fortee/fortee.go +++ b/backend/fortee/fortee.go @@ -7,7 +7,7 @@ import ( ) const ( - apiEndpoint = "https://fortee.jp" + Endpoint = "https://fortee.jp" ) var ( @@ -16,7 +16,7 @@ var ( ) func Login(ctx context.Context, username string, password string) (string, error) { - client, err := NewClientWithResponses(apiEndpoint, WithRequestEditorFn(addAcceptHeader)) + client, err := NewClientWithResponses(Endpoint, WithRequestEditorFn(addAcceptHeader)) if err != nil { return "", err } @@ -41,7 +41,7 @@ func Login(ctx context.Context, username string, password string) (string, error } func GetUserAvatarURL(ctx context.Context, username string) (string, error) { - client, err := NewClientWithResponses(apiEndpoint, WithRequestEditorFn(addAcceptHeader)) + client, err := NewClientWithResponses(Endpoint, WithRequestEditorFn(addAcceptHeader)) if err != nil { return "", err } diff --git a/backend/main.go b/backend/main.go index 3296957..890e666 100644 --- a/backend/main.go +++ b/backend/main.go @@ -96,6 +96,15 @@ func main() { return c.Redirect(http.StatusPermanentRedirect, "http://localhost:5173/iosdc-japan/2024/code-battle/logout") }) + // For local dev: This is never used in production because the reverse + // proxy directly handles /files. + filesGroup := e.Group("/iosdc-japan/2024/code-battle/files") + filesGroup.Use(middleware.StaticWithConfig(middleware.StaticConfig{ + Root: "/", + Filesystem: http.Dir("/data/files"), + IgnoreBase: true, + })) + go gameHubs.Run() go func() { diff --git a/backend/query.sql b/backend/query.sql index 6b0ecdd..dc5f384 100644 --- a/backend/query.sql +++ b/backend/query.sql @@ -13,6 +13,11 @@ INSERT INTO users (username, display_name, is_admin) VALUES ($1, $1, false) RETURNING user_id; +-- name: UpdateUserIconPath :exec +UPDATE users +SET icon_path = $2 +WHERE user_id = $1; + -- name: ListUsers :many SELECT * FROM users ORDER BY users.user_id; diff --git a/compose.local.yaml b/compose.local.yaml index cfcb41e..bf7c0c6 100644 --- a/compose.local.yaml +++ b/compose.local.yaml @@ -4,6 +4,8 @@ services: context: ./backend ports: - '127.0.0.1:8002:80' + volumes: + - files-data:/data/files:rw depends_on: db: condition: service_healthy @@ -67,3 +69,4 @@ services: volumes: db-data: + files-data: diff --git a/compose.prod.yaml b/compose.prod.yaml index 07ff19e..a3b840c 100644 --- a/compose.prod.yaml +++ b/compose.prod.yaml @@ -5,6 +5,7 @@ services: - '127.0.0.1:8002:80' volumes: - ./nginx.conf:/etc/nginx/nginx.conf:ro + - files-data:/var/www/files:ro depends_on: - api-server - app-server @@ -15,6 +16,8 @@ services: context: ./backend expose: - 80 + volumes: + - files-data:/data/files:rw depends_on: db: condition: service_healthy @@ -77,3 +80,4 @@ services: volumes: db-data: + files-data: diff --git a/nginx.conf b/nginx.conf index b54d6ae..f421647 100644 --- a/nginx.conf +++ b/nginx.conf @@ -12,6 +12,10 @@ http { server { listen 80; + location /iosdc-japan/2024/code-battle/files/ { + alias /var/www/files/; + } + location /iosdc-japan/2024/code-battle/api/ { proxy_pass http://api-server; proxy_set_header Host $host; -- cgit v1.2.3-70-g09d2