Merge pull request #14 from naohito-T/feature/logger

Feature/logger
naohito-T · Sep 22, 2024 · 3f31b7a · 3f31b7a
2 parents f120aeb + 32487d1
commit 3f31b7a
Show file tree

Hide file tree

Showing 28 changed files with 643 additions and 459 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -15,5 +15,6 @@
   "markdownlint.config": {
     "MD013": false,
     "MD033": false
-  }
+  },
+  "makefile.configureOnOpen": false
 }
diff --git a/backend/api/openapi.yaml b/backend/api/openapi.yaml
@@ -48,13 +48,6 @@ components:
     ErrorModel:
       additionalProperties: false
       properties:
-        $schema:
-          description: A URL to the JSON Schema for this object.
-          examples:
-            - http://localhost:6500/api/v1/schemas/ErrorModel.json
-          format: uri
-          readOnly: true
-          type: string
         detail:
           description: A human-readable explanation specific to this occurrence of the problem.
           examples:
@@ -64,7 +57,9 @@ components:
           description: Optional list of individual error details
           items:
             $ref: "#/components/schemas/ErrorDetail"
-          type: array
+          type:
+            - array
+            - "null"
         instance:
           description: A URI reference that identifies the specific occurrence of the problem.
           examples:
@@ -114,13 +109,6 @@ components:
     HealthCheckResponseBody:
       additionalProperties: false
       properties:
-        $schema:
-          description: A URL to the JSON Schema for this object.
-          examples:
-            - http://localhost:6500/api/v1/schemas/HealthCheckResponseBody.json
-          format: uri
-          readOnly: true
-          type: string
         message:
           type: string
       required:
@@ -132,42 +120,71 @@ components:
       scheme: bearer
       type: http
 info:
+  contact:
+    email: [email protected]
+    name: naohito-T
+    url: https://naohito-t.github.io/
+  description: This is a simple URL shortener service.
+  license:
+    name: MIT
+    url: https://opensource.org/licenses/MIT
   title: TinyURL API
   version: 1.0.0
 openapi: 3.1.0
 paths:
   /health:
     get:
       description: Check the health of the service.
-      operationId: health
+      operationId: health-check
       parameters:
-        - description: Optional database check parameter
+        - description: Optional DynamoDB check parameter
           explode: false
           in: query
           name: q
           schema:
-            description: Optional database check parameter
+            description: Optional DynamoDB check parameter
             type: boolean
       responses:
         "200":
           content:
             application/json:
+              example: "{message: ok}"
               schema:
-                $ref: "#/components/schemas/HealthCheckResponseBody"
-          description: OK
-        default:
+                properties:
+                  message:
+                    type: string
+                type: object
+          description: Health check successful
+        "503":
           content:
             application/problem+json:
               schema:
-                $ref: "#/components/schemas/ErrorModel"
-          description: Error
+                properties:
+                  detail:
+                    type: string
+                  status:
+                    type: integer
+                  title:
+                    type: string
+                  type:
+                    format: uri
+                    type: string
+                type: object
+          description: Service unavailable
       summary: Health Check
       tags:
         - Public
   /urls:
     post:
       description: Create a short URL.
       operationId: create-tinyurl
+      parameters:
+        - description: ID of the short URL
+          in: path
+          name: id
+          required: true
+          schema:
+            type: string
       requestBody:
         content:
           application/json:
@@ -181,12 +198,20 @@ paths:
               schema:
                 $ref: "#/components/schemas/CreateTinyURLResponseBody"
           description: OK
-        default:
+        "201":
+          description: Created short URL
+          headers:
+            Location:
+              description: Location of the original URL
+              schema:
+                format: uri
+                type: string
+        "500":
           content:
-            application/problem+json:
+            text/plain:
               schema:
-                $ref: "#/components/schemas/ErrorModel"
-          description: Error
+                type: string
+          description: Failed to create short URL
       summary: Create a short URL
       tags:
         - Public
@@ -226,14 +251,26 @@ paths:
               schema:
                 type: string
           description: Short URL not found
+        "500":
+          content:
+            text/plain:
+              schema:
+                type: string
+          description: Failed to Get short URL
       summary: Redirect to original URL
       tags:
         - Public
-  /urls/info/:id:
+  /urls/:id/info:
     get:
       description: Get Info tinyurl
       operationId: info-tinyurl
       parameters:
+        - description: ID of the short URL
+          in: path
+          name: id
+          required: true
+          schema:
+            type: string
         - in: path
           name: id
           required: true
@@ -246,15 +283,20 @@ paths:
               schema:
                 $ref: "#/components/schemas/GetInfoTinyURLResponseBody"
           description: OK
-        default:
+        "404":
           content:
-            application/problem+json:
+            text/plain:
               schema:
-                $ref: "#/components/schemas/ErrorModel"
-          description: Error
+                type: string
+          description: Short URL not found
       summary: Get Info tinyurl
       tags:
         - Public
 servers:
-  - url: http://localhost:6500/api/v1
+  - description: Local API Server
+    url: http://localhost:6500/api/v1
+  - description: Dev API Server
+    url: http://localhost:6500/api/v1
+  - description: Prod API Server
+    url: http://localhost:6500/api/v1
 
diff --git a/backend/cmd/api/main.go b/backend/cmd/api/main.go
@@ -9,7 +9,8 @@ import (
 	"github.com/danielgtaylor/huma/v2/humacli"
 	"github.com/labstack/echo/v4"
 	"github.com/naohito-T/tinyurl/backend/configs"
-	"github.com/naohito-T/tinyurl/backend/internal/infrastructure"
+	infra "github.com/naohito-T/tinyurl/backend/internal/infrastructure"
+	"github.com/naohito-T/tinyurl/backend/internal/rest/container"
 	"github.com/naohito-T/tinyurl/backend/internal/rest/middleware"
 	"github.com/naohito-T/tinyurl/backend/internal/rest/router"
 	appSchema "github.com/naohito-T/tinyurl/backend/schema/api"
@@ -33,16 +34,20 @@ type Options struct {
 // private（管理者）
 
 func main() {
-	var api huma.API
-	var c configs.AppEnvironment
-	logger := infrastructure.NewLogger()
+	var publicAPI huma.API
+	// var privateAPI huma.API
+	var c *configs.AppEnvironment
 
 	cli := humacli.New(func(hooks humacli.Hooks, opts *Options) {
 		e := echo.New()
 		c = configs.NewAppEnvironment()
 
 		middleware.CustomMiddleware(e, c)
-		api = router.NewPublicRouter(humaecho.NewWithGroup(e, e.Group("/api/v1"), appSchema.NewHumaConfig()), logger)
+
+		public := e.Group("/v1/public")
+		// private := e.Group("/v1/private")
+		publicAPI = router.NewPublicRouter(humaecho.NewWithGroup(e, public, appSchema.NewHumaConfig()), container.PublicContainer, infra.RouterLogger)
+		// privateAPI = router.NewPublicRouter(humaecho.NewWithGroup(e, private, appSchema.NewHumaConfig()), container.PublicContainer, infra.RouterLogger)
 		// 未定義のルート用のキャッチオールハンドラ
 		e.Any("/*", func(c echo.Context) error {
 			return c.JSON(http.StatusNotFound, map[string]string{"message": "route_not_found"})
@@ -53,13 +58,17 @@ func main() {
 		})
 	})
 
+	// Command
 	cli.Root().AddCommand(&cobra.Command{
 		Use:   "openapi",
 		Short: "Print the OpenAPI spec",
 		Run: func(_ *cobra.Command, _ []string) {
-			b, _ := api.OpenAPI().YAML()
+			b, _ := publicAPI.OpenAPI().YAML()
+			// privateAPI.OpenAPI().YAML()
 			fmt.Println(string(b))
 		},
 	})
+
+	// Run the CLI
 	cli.Run()
 }
diff --git a/backend/configs/environment.go b/backend/configs/environment.go
@@ -12,18 +12,19 @@ type AppEnvironment struct {
 	tinyURLCollection string `default:"offline-tinyurls"`
 }
 
-var newOnceLogger = sync.OnceValue(func() AppEnvironment {
-	var ae AppEnvironment
-	if err := envconfig.Process("", &ae); err != nil {
+// コピーで返す場合
+// 構造体のコピーを返すだけなので生成も一度だけでコストは低い。
+// ただし、構造体が大きい場合はコピーのコストがかかるので注意。
+// 参照で返す場合
+// 構造体のコピーを作成せずに参照を返すため、コストは低い。
+var newOnceEnvironment = sync.OnceValue(func() *AppEnvironment {
+	var appEnvironment AppEnvironment
+	if err := envconfig.Process("", &appEnvironment); err != nil {
 		panic(fmt.Sprintf("Failed to process environment config: %v", err))
 	}
-	return ae
-})
 
-// SEE: https://pkg.go.dev/github.com/kelseyhightower/envconfig
-func NewAppEnvironment() AppEnvironment {
-	return newOnceLogger()
-}
+	return &appEnvironment
+})
 
 func (a *AppEnvironment) IsTest() bool {
 	return a.stage == "test"
@@ -44,3 +45,8 @@ func (a *AppEnvironment) IsProd() bool {
 func (a *AppEnvironment) GetTinyURLCollectionName() string {
 	return a.tinyURLCollection
 }
+
+// SEE: https://pkg.go.dev/github.com/kelseyhightower/envconfig
+func NewAppEnvironment() *AppEnvironment {
+	return newOnceEnvironment()
+}
diff --git a/backend/configs/router.go b/backend/configs/router.go
@@ -10,12 +10,12 @@ type path = string
 const (
 	// /api/v1/health
 	Health path = "/health"
-	// リダイレクト用エンドポイント
-	GetShortURL path = "/urls/:id"
+	// すべてのURLを取得するエンドポイント
+	GetURLs path = "/urls"
 	// 短縮URLを作成するためのエンドポイント
 	CreateShortURL path = "/urls"
-	// すべてのURLをリストするためのエンドポイント
-	ListShortURLs path = "/urls/list"
-	//  特定の短縮URLの詳細情報を取得
-	GetOnlyShortURL path = "/urls/info/:id"
+	// リダイレクト用エンドポイント
+	GetShortURL path = "/urls/:id"
+	//  特定の短縮URLの詳細情報を取得（リダイレクトなし）
+	GetOnlyShortURL path = "/urls/:id/info"
 )
diff --git a/backend/internal/infrastructure/dynamo.go b/backend/internal/infrastructure/dynamo.go
@@ -17,11 +17,11 @@ type Client interface {
 
 type Connection struct {
 	*dynamodb.Client
-	ILogger
-	configs.AppEnvironment
+	ILabelLogger
+	*configs.AppEnvironment
 }
 
-func NewDynamoConnection(logger ILogger, env configs.AppEnvironment) *Connection {
+func NewDynamoConnection(logger ILabelLogger, env *configs.AppEnvironment) *Connection {
 	// https://zenn.dev/y16ra/articles/40ff14e8d2a4db
 	customResolver := aws.EndpointResolverFunc(func(service, region string) (aws.Endpoint, error) {
 		return aws.Endpoint{
@@ -35,7 +35,9 @@ func NewDynamoConnection(logger ILogger, env configs.AppEnvironment) *Connection
 		config.WithEndpointResolver(customResolver),
 	)
 	if err != nil {
-		logger.Error("unable to load SDK config, %v", err)
+		logger.Error("unable to load SDK config", map[string]interface{}{}, map[string]interface{}{
+			"error": err,
+		})
 	}
 
 	return &Connection{
@@ -46,26 +48,26 @@ func NewDynamoConnection(logger ILogger, env configs.AppEnvironment) *Connection
 }
 
 func (c *Connection) Get(ctx context.Context, params *dynamodb.GetItemInput) (*dynamodb.GetItemOutput, error) {
-	c.Info("GetItemInput: %v", params)
+	// c.Info("GetItemInput: %v", params)
 	if result, err := c.GetItem(ctx, &dynamodb.GetItemInput{
 		TableName: aws.String(c.GetTinyURLCollectionName()),
 		Key:       params.Key,
 	}); err != nil {
-		c.Error("Get error: %v", err)
+		// c.Error("Get error: %v", err)
 		return nil, err
 	} else {
 		return result, nil
 	}
 }
 
 func (c *Connection) Put(ctx context.Context, params *dynamodb.PutItemInput, optFns ...func(*dynamodb.Options)) (*dynamodb.PutItemOutput, error) {
-	c.Info("PutItemInput: %v", params)
+	// c.Info("PutItemInput: %v", params)
 	if result, err := c.PutItem(ctx, &dynamodb.PutItemInput{
 		// rateLimitなどテーブルnameは上から渡したほうがいいかも
 		TableName: aws.String(c.GetTinyURLCollectionName()),
 		Item:      params.Item,
 	}, optFns...); err != nil {
-		c.Error("Put error: %v", err)
+		// c.Error("Put error: %v", err)
 		return nil, err
 	} else {
 		return result, nil
@@ -83,9 +85,9 @@ func (c *Connection) Put(ctx context.Context, params *dynamodb.PutItemInput, opt
 //		},
 //	}
 func (c *Connection) Search(ctx context.Context, params *dynamodb.QueryInput, optFns ...func(*dynamodb.Options)) (*dynamodb.QueryOutput, error) {
-	c.Info("SearchItemInput: %v", params)
+	// c.Info("SearchItemInput: %v", params)
 	if result, err := c.Query(ctx, params, optFns...); err != nil {
-		c.Error("Query error: %v", err)
+		// c.Error("Query error: %v", err)
 		return nil, err
 	} else {
 		return result, nil