chore: clean code

Author: hui1601

cmd/server/main.go

@@ -16,7 +16,6 @@ import (
 	"mail-manager/internal/web"
 )
 
-// Config 구조체는 서비스 운영에 필요한 설정 항목들을 포함합니다.
 type Config struct {
 	Server struct {
 		Address string `yaml:"address"`
@@ -44,7 +43,6 @@ type Config struct {
 	} `yaml:"templates"`
 }
 
-// loadConfig 파일을 읽어 YAML로 파싱한 후 Config 구조체를 반환합니다.
 func loadConfig(path string) (*Config, error) {
 	data, err := os.ReadFile(path)
 	if err != nil {
@@ -58,23 +56,19 @@ func loadConfig(path string) (*Config, error) {
 }
 
 func main() {
-	// 커맨드라인 플래그에서 설정 파일 위치를 받습니다.
 	configFile := flag.String("config", "config/config.yaml", "path to the configuration file")
 	flag.Parse()
 
-	// 설정 파일 로드
 	cfg, err := loadConfig(*configFile)
 	if err != nil {
 		log.Fatalf("Error loading config: %v", err)
 	}
 	log.Printf("Configuration loaded: server will listen on %s", cfg.Server.Address)
 
-	// SESSION_KEY는 반드시 환경변수로 설정되어 있어야 함
 	if os.Getenv("SESSION_KEY") == "" {
 		log.Fatalf("환경변수 SESSION_KEY가 설정되어 있지 않습니다")
 	}
 
-	// OIDC 서비스 생성
 	oidcSvc, err := auth.NewOIDCService(&auth.OIDCConfig{
 		ProviderURL:  cfg.OIDC.ProviderURL,
 		ClientID:     cfg.OIDC.ClientID,
@@ -87,7 +81,6 @@ func main() {
 	}
 	log.Println("OIDC service initialized.")
 
-	// authentik 클라이언트 생성
 	authClient, err := auth.NewAuthentikClient(&auth.AuthentikConfig{
 		BaseURL:  cfg.Authentik.BaseURL,
 		ApiToken: cfg.Authentik.ApiToken,
@@ -97,7 +90,6 @@ func main() {
 	}
 	log.Println("Authentik client initialized.")
 
-	// SMTP 클라이언트 생성
 	smtpClient := email.NewSMTPClient(email.SMTPConfig{
 		Host:     cfg.SMTP.Host,
 		Port:     cfg.SMTP.Port,
@@ -107,9 +99,7 @@ func main() {
 	})
 	log.Println("SMTP client initialized.")
 
-	// 이메일 템플릿용 TemplateManager 생성
 	tmplManager := email.NewTemplateManager(cfg.Templates.Email)
-	// load all templates
 	files, err := os.ReadDir(cfg.Templates.Email)
 	if err != nil {
 		log.Fatalf("템플릿 디렉터리 읽기 실패: %v", err)
@@ -123,25 +113,19 @@ func main() {
 		}
 	}
 
-	// API 핸들러 생성
 	apiHandler := web.NewAPIHandler(oidcSvc, tmplManager, smtpClient, authClient)
 
 	mux := http.NewServeMux()
 
-	// 공개 엔드포인트 (OIDC 로그인 및 콜백)
 	mux.HandleFunc("/login", oidcSvc.LoginHandler)
 	mux.HandleFunc("/login/callback", oidcSvc.CallbackHandler)
 
-	// 보호된 API 엔드포인트 (OIDC 미들웨어로 인증 보호)
 	mux.Handle("/api/templates", oidcSvc.AuthMiddleware(http.HandlerFunc(apiHandler.TemplatesListHandler)))
 	mux.Handle("/api/templates/", oidcSvc.AuthMiddleware(http.HandlerFunc(apiHandler.TemplateHandler)))
-	// 추가: 미리보기용 엔드포인트 – URL 경로 형식: /api/templates/preview/{name}
 	mux.Handle("/api/templates/preview/", oidcSvc.AuthMiddleware(http.HandlerFunc(apiHandler.PreviewTemplateHandler)))
 	mux.Handle("/api/users", oidcSvc.AuthMiddleware(http.HandlerFunc(apiHandler.UsersHandler)))
 	mux.Handle("/api/email", oidcSvc.AuthMiddleware(http.HandlerFunc(apiHandler.EmailHandler)))
-	// 추가: 현재 로그인한 사용자 정보를 반환하는 엔드포인트
 	mux.Handle("/api/me", oidcSvc.AuthMiddleware(http.HandlerFunc(apiHandler.MeHandler)))
-	// 추가: 로그아웃 엔드포인트 (POST 요청)
 	mux.Handle("/logout", http.HandlerFunc(apiHandler.LogoutHandler))
 
 	// 전체 핸들러에 로깅 및 복구 미들웨어 적용

internal/auth/authentik.go

@@ -7,18 +7,15 @@ import (
 	authentik "goauthentik.io/api/v3"
 )
 
-// AuthentikConfig holds the configuration parameters for connecting to the authentik API.
 type AuthentikConfig struct {
-	BaseURL  string // Base URL of the authentik instance (https://sso.casper.or.kr)
-	ApiToken string // API token (Bearer) for authenticating with authentik
+	BaseURL  string
+	ApiToken string
 }
 
-// AuthentikClient provides methods to interact with the authentik API.
 type AuthentikClient struct {
 	client *authentik.APIClient
 }
 
-// NewAuthentikClient creates and configures an AuthentikClient with the provided settings.
 func NewAuthentikClient(cfg *AuthentikConfig) (*AuthentikClient, error) {
 	if cfg.BaseURL == "" || cfg.ApiToken == "" {
 		return nil, fmt.Errorf("invalid authentik config: missing BaseURL or ApiToken")
@@ -32,7 +29,6 @@ func NewAuthentikClient(cfg *AuthentikConfig) (*AuthentikClient, error) {
 	}, nil
 }
 
-// GetUserList retrieves the list of users from authentik.
 func (ac *AuthentikClient) GetUserList(ctx context.Context) ([]authentik.User, error) {
 	resp, httpResp, err := ac.client.CoreApi.CoreUsersList(ctx).Execute()
 	if err != nil {
@@ -47,7 +43,6 @@ func (ac *AuthentikClient) GetUserList(ctx context.Context) ([]authentik.User, e
 	return filteredUsers, nil
 }
 
-// GetUserByID retrieves a single user by its ID.
 func (ac *AuthentikClient) GetUserByID(ctx context.Context, id int32) (*authentik.User, error) {
 	user, httpResp, err := ac.client.CoreApi.CoreUsersRetrieve(ctx, id).Execute()
 	if err != nil {

internal/auth/oidc.go

@@ -107,7 +107,6 @@ func (s *OIDCService) LoginHandler(w http.ResponseWriter, r *http.Request) {
 // It validates the state parameter, exchanges the code for tokens, verifies the ID token,
 // and finally saves the authenticated user information in the session.
 func (s *OIDCService) CallbackHandler(w http.ResponseWriter, r *http.Request) {
-	// 세션에서 저장된 state 값 확인
 	session, err := s.Store.Get(r, "oidc-session")
 	if err != nil {
 		http.Error(w, "Failed to get session", http.StatusBadRequest)
@@ -130,14 +129,12 @@ func (s *OIDCService) CallbackHandler(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	// 코드를 토큰으로 교환
 	token, err := s.OAuth2Config.Exchange(r.Context(), code)
 	if err != nil {
 		http.Error(w, fmt.Sprintf("Failed to exchange token: %v", err), http.StatusInternalServerError)
 		return
 	}
 
-	// OAuth2 토큰에서 id_token을 추출
 	rawIDToken, ok := token.Extra("id_token").(string)
 	if !ok {
 		http.Error(w, "No id_token field in oauth2 token", http.StatusInternalServerError)
@@ -160,22 +157,19 @@ func (s *OIDCService) CallbackHandler(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	// 인증이 완료되었으므로 세션에 사용자 정보를 저장 (실제 서비스에서는 추가적인 사용자 저장 및 처리 필요)
 	session.Values["id_token"] = rawIDToken
 	session.Values["email"] = claims.Email
 	session.Values["name"] = claims.Name
-	// state 값은 더 이상 필요 없으므로 삭제
 	delete(session.Values, "state")
 	if err := session.Save(r, w); err != nil {
 		http.Error(w, "Failed to save session", http.StatusInternalServerError)
 		return
 	}
 
-	// 로그인 후 리디렉션할 URL을 지정 (예: 대시보드)
 	http.Redirect(w, r, "/", http.StatusFound)
 }
 
-// AuthMiddleware 보호된 엔드포인트에 접근할 때 세션에 id_token이 있는지 확인합니다.
+// AuthMiddleware checks if the user is authenticated by verifying the presence of an ID token in the session.
 func (s *OIDCService) AuthMiddleware(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		session, err := s.Store.Get(r, "oidc-session")

internal/web/handlers.go

@@ -18,15 +18,13 @@ import (
 	"mail-manager/internal/email"
 )
 
-// APIHandler는 템플릿, 사용자, 이메일 발송 등 API 엔드포인트에 필요한 의존성을 보관합니다.
 type APIHandler struct {
 	OIDCService     *auth.OIDCService
 	TemplateManager *email.TemplateManager
 	SMTPClient      *email.SMTPClient
 	AuthentikClient *auth.AuthentikClient
 }
 
-// NewAPIHandler는 APIHandler 인스턴스를 생성합니다.
 func NewAPIHandler(oidc *auth.OIDCService, tm *email.TemplateManager, smtp *email.SMTPClient, authClient *auth.AuthentikClient) *APIHandler {
 	return &APIHandler{
 		OIDCService:     oidc,
@@ -170,7 +168,6 @@ func (h *APIHandler) TemplateHandler(w http.ResponseWriter, r *http.Request) {
 }
 
 // PreviewTemplateHandler handles POST /api/templates/preview/{name}.
-// 클라이언트가 수정한 템플릿 내용을 받아 샘플 데이터로 렌더링한 HTML을 반환합니다.
 func (h *APIHandler) PreviewTemplateHandler(w http.ResponseWriter, r *http.Request) {
 	if r.Method != http.MethodPost {
 		http.Error(w, "지원하지 않는 메서드입니다.", http.StatusMethodNotAllowed)

internal/web/middleware.go

@@ -6,7 +6,6 @@ import (
 	"time"
 )
 
-// LoggingMiddleware 모든 요청에 대해 URL, 메서드 및 처리시간을 로깅합니다.
 func LoggingMiddleware(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		start := time.Now()
@@ -16,7 +15,6 @@ func LoggingMiddleware(next http.Handler) http.Handler {
 	})
 }
 
-// RecoveryMiddleware panic 발생 시 이를 복구하고 500 에러를 반환합니다.
 func RecoveryMiddleware(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		defer func() {