WIP

Author: hayato24s

.vscode/settings.json

@@ -10,7 +10,20 @@
       "source.organizeImports": "explicit"
     }
   },
-  "black-formatter.args": ["--line-length", "88"],
-  "flake8.args": ["--max-line-length", "88", "--extend-ignore", "E203,E701"],
-  "isort.args": ["--profile", "black", "--line-length", "88"]
-}
+  "black-formatter.args": [
+    "--line-length",
+    "88"
+  ],
+  "flake8.args": [
+    "--max-line-length",
+    "88",
+    "--extend-ignore",
+    "E203,E501,E701"
+  ],
+  "isort.args": [
+    "--profile",
+    "black",
+    "--line-length",
+    "88"
+  ]
+}

base/collection.go

@@ -1,6 +1,8 @@
 package base
 
-import "fmt"
+import (
+	"fmt"
+)
 
 func CopySlice[T any](collection []T) []T {
 	ret := make([]T, len(collection))

cmd/serve.go

@@ -18,7 +18,10 @@ import (
 	authfactory "github.com/twin-te/twinte-back/module/auth/factory"
 	authrepository "github.com/twin-te/twinte-back/module/auth/repository"
 	authusecase "github.com/twin-te/twinte-back/module/auth/usecase"
-	donationmodule "github.com/twin-te/twinte-back/module/donation"
+	donationfactory "github.com/twin-te/twinte-back/module/donation/factory"
+	donationgateway "github.com/twin-te/twinte-back/module/donation/gateway"
+	donationrepository "github.com/twin-te/twinte-back/module/donation/repository"
+	donationusecase "github.com/twin-te/twinte-back/module/donation/usecase"
 	schoolcalendarrepository "github.com/twin-te/twinte-back/module/schoolcalendar/repository"
 	schoolcalendarusecase "github.com/twin-te/twinte-back/module/schoolcalendar/usecase"
 	timetablefactory "github.com/twin-te/twinte-back/module/timetable/factory"
@@ -57,11 +60,10 @@ var serveCmd = &cobra.Command{
 			log.Fatalln(err)
 		}
 
-		var dummyDonationUseCase donationmodule.UseCase
-		// donationFactory := donationfactory.New()
-		// donationGateway := donationgateway.New()
-		// donationRepository := donationrepository.New(db)
-		// donationUseCase := donationusecase.New(accessController, donationFactory, donationGateway, donationRepository)
+		donationFactory := donationfactory.New()
+		donationGateway := donationgateway.New()
+		donationRepository := donationrepository.New(db)
+		donationUseCase := donationusecase.New(accessController, donationFactory, donationGateway, donationRepository)
 
 		schoolcalendarRepository := schoolcalendarrepository.New()
 		schoolcalendarUseCase := schoolcalendarusecase.New(accessController, schoolcalendarRepository)
@@ -93,7 +95,7 @@ var serveCmd = &cobra.Command{
 			accessController,
 			announcementUsecase,
 			authUseCase,
-			dummyDonationUseCase,
+			donationUseCase,
 			schoolcalendarUseCase,
 			timetableUseCase,
 		)

codegen/error/definition.csv

@@ -0,0 +1,52 @@
+from typing import NewType
+
+ConnectErrorCode = NewType("ConnectErrorCode", str)
+
+Canceled = ConnectErrorCode("Canceled")
+Unknown = ConnectErrorCode("Unknown")
+InvalidArgument = ConnectErrorCode("InvalidArgument")
+DeadlineExceeded = ConnectErrorCode("DeadlineExceeded")
+NotFound = ConnectErrorCode("NotFound")
+AlreadyExists = ConnectErrorCode("AlreadyExists")
+PermissionDenied = ConnectErrorCode("PermissionDenied")
+ResourceExhausted = ConnectErrorCode("ResourceExhausted")
+FailedPrecondition = ConnectErrorCode("FailedPrecondition")
+Aborted = ConnectErrorCode("Aborted")
+OutOfRange = ConnectErrorCode("OutOfRange")
+Unimplemented = ConnectErrorCode("Unimplemented")
+Internal = ConnectErrorCode("Internal")
+Unavailable = ConnectErrorCode("Unavailable")
+DataLoss = ConnectErrorCode("DataLoss")
+Unauthenticated = ConnectErrorCode("Unauthenticated")
+
+definition: dict[str, list[tuple[str, ConnectErrorCode]]] = {
+    "announcement": [
+        ("AnnouncementNotFound", NotFound),
+    ],
+    "auth": [
+        ("UserAuthenticationAlreadyExists", AlreadyExists),
+        ("UserAuthenticationNotAssociated", FailedPrecondition),
+        ("UserHasAtLeastOneAuthentication", FailedPrecondition),
+        (
+            "UserHasAtMostOneAuthenticationFromSameProvider",
+            FailedPrecondition,
+        ),
+    ],
+    "donation": [("SubscriptionNotFound", NotFound)],
+    "schoolcalendar": [
+        ("ModuleNotFound", NotFound),
+    ],
+    "shared": [
+        ("AlreadyExists", AlreadyExists),
+        ("InvalidArgument", InvalidArgument),
+        ("NotFound", NotFound),
+        ("Unauthenticated", Unauthenticated),
+        ("Unauthorized", PermissionDenied),
+    ],
+    "timetable": [
+        ("CourseNotFound", NotFound),
+        ("RegisteredCourseAlreadyExists", AlreadyExists),
+        ("RegisteredCourseNotFound", NotFound),
+        ("TagNotFound", NotFound),
+    ],
+}

codegen/error/definition.py

@@ -1,66 +1,82 @@
-import csv
 import pathlib
+import re
 
-module_name_to_error_codes: dict[str, list[str]] = {}
-error_code_to_description: dict[str, str] = {}
+from definition import definition
 
 
-def generate_go_code(module_name: str) -> str:
-    error_codes = module_name_to_error_codes[module_name]
+def convert_pascal_case_to_snake_case(s: str) -> str:
+    """Convert PascalCase to snake_case.
 
+    cf. https://stackoverflow.com/questions/1175208/elegant-python-function-to-convert-camelcase-to-snake-case
+    """
+    s = re.sub("(.)([A-Z][a-z]+)", r"\1_\2", s)
+    s = re.sub("([a-z0-9])([A-Z])", r"\1_\2", s).lower()
+    return s
+
+
+def convert_pascal_case_to_upper_snake_case(s: str) -> str:
+    s = convert_pascal_case_to_snake_case(s)
+    s = s.upper()
+    return s
+
+
+def generate_go_error_definition(module: str) -> str:
     ret = f"""// Code generated by codegen/error/generate.py; DO NOT EDIT.
 
-package {module_name}err
+package {module}err
 
 import "github.com/twin-te/twinte-back/apperr"
 
 const (
 """
 
+    error_codes = [error_code for error_code, _ in definition[module]]
+
     max_length = max(map(len, error_codes))
+
     for error_code in error_codes:
-        ret += f'\tCode{error_code.ljust(max_length)} apperr.Code = "{module_name}.{error_code}"\n'
+        ret += f'\tCode{error_code.ljust(max_length)} apperr.Code = "{module}.{error_code}"\n'
 
     ret += """)
 """
 
     return ret
 
 
-def generate_markdown_list() -> str:
-    ret = """<!-- Code generated by codegen/error/generate.py; DO NOT EDIT. -->
+def generate_go_error_code_map() -> str:
+    ret = """// Code generated by codegen/error/generate.py; DO NOT EDIT.
 
-## Error Code List
+package interceptor
 
-"""
+import (
+	"github.com/bufbuild/connect-go"
+	"github.com/twin-te/twinte-back/apperr"
+"""  # noqa: E101, W191
 
-    for module_name, error_codes in module_name_to_error_codes.items():
-        ret += f"""### {module_name}
-| Error Code | Description |
-| :---: | :---: |
+    for module in definition.keys():
+        ret += f"""	{module}err "github.com/twin-te/twinte-back/module/{module}/err"
 """
-        for error_code in error_codes:
-            description = error_code_to_description[error_code]
-            ret += f"| `{module_name}.{error_code}` | {description} |\n"
-        ret += "\n"
-
-    return ret
-
 
-def load_definition() -> None:
-    definition_file_path = pathlib.Path(__file__).parent.joinpath("definition.csv")
+    ret += """)
 
-    with definition_file_path.open("r") as f:
-        reader = csv.reader(f)
-        rows = [row for row in reader][1:]  # exclude header
+var AppErrorCodeToConnectErrorCode = map[apperr.Code]connect.Code{
+"""
+    for i, module in enumerate(definition):
+        if i > 0:
+            ret += "\n"
+
+        for app_error_code, connect_error_code in definition[module]:
+            max_length = max(
+                [len(app_error_code) for app_error_code, _ in definition[module]]
+            )
+            num_spaces = max_length - len(app_error_code)
+            ret += f"""	{module}err.Code{app_error_code}:{" " * num_spaces} connect.Code{connect_error_code},
+"""
 
-    for module_name, error_code, description in rows:
-        if module_name not in module_name_to_error_codes:
-            module_name_to_error_codes[module_name] = []
-        module_name_to_error_codes[module_name].append(error_code)
-        error_code_to_description[error_code] = description
+    ret += """}
+"""
 
-    print(f"load definition from {definition_file_path.as_posix()}")
+    return ret
 
 
 def output_to_file(output_file_path: pathlib.Path, content: str) -> None:
@@ -71,22 +87,20 @@ def output_to_file(output_file_path: pathlib.Path, content: str) -> None:
 
 
 def main() -> None:
-    load_definition()
-
-    # Go Code
-    for module_name in module_name_to_error_codes:
-        output_go_file_path = (
-            pathlib.Path(__file__)
-            .parents[2]
-            .joinpath(f"module/{module_name}/err/code.gen.go")
-        )
-        content = generate_go_code(module_name)
+    root_path = pathlib.Path(__file__).parents[2]
+
+    # Generate go error definition
+    for module in definition.keys():
+        output_go_file_path = root_path.joinpath(f"module/{module}/err/code_gen.go")
+        content = generate_go_error_definition(module)
         output_to_file(output_go_file_path, content)
 
-    # Markdown List
-    output_markdown_list_path = pathlib.Path(__file__).parent.joinpath("list.gen.md")
-    content = generate_markdown_list()
-    output_to_file(output_markdown_list_path, content)
+    # Generate go error code map
+    content = generate_go_error_code_map()
+    output_file_path = root_path.joinpath(
+        "handler/common/interceptor/error_code_map_gen.go"
+    )
+    output_to_file(output_file_path, content)
 
 
 if __name__ == "__main__":

codegen/error/generate.py

@@ -11,6 +11,7 @@ require (
 	github.com/oapi-codegen/runtime v1.1.1
 	github.com/rs/cors v1.10.1
 	github.com/samber/lo v1.39.0
+	github.com/samber/mo v1.11.0
 	github.com/spf13/cobra v1.8.0
 	github.com/stretchr/testify v1.8.4
 	github.com/stripe/stripe-go/v76 v76.18.0

codegen/error/list.gen.md

@@ -138,6 +138,8 @@ github.com/rs/cors v1.10.1/go.mod h1:XyqrcTp5zjWr1wsJ8PIRZssZ8b/WMcMf71DJnit4EMU
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/samber/lo v1.39.0 h1:4gTz1wUhNYLhFSKl6O+8peW0v2F4BCY034GRpU9WnuA=
 github.com/samber/lo v1.39.0/go.mod h1:+m/ZKRl6ClXCE2Lgf3MsQlWfh4bn1bz6CXEOxnEXnEA=
+github.com/samber/mo v1.11.0 h1:ZOiSkrGGpNhVv/1dxP02risztdMTIwE8KSW9OG4k5bY=
+github.com/samber/mo v1.11.0/go.mod h1:BfkrCPuYzVG3ZljnZB783WIJIGk1mcZr9c9CPf8tAxs=
 github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0=
 github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho=
 github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=

go.mod

@@ -10,7 +10,6 @@ import (
 	"github.com/twin-te/twinte-back/apperr"
 	authmodule "github.com/twin-te/twinte-back/module/auth"
 	"github.com/twin-te/twinte-back/module/shared/domain/idtype"
-	sharederr "github.com/twin-te/twinte-back/module/shared/err"
 )
 
 func getSessionIDFromHeader(header http.Header) (id idtype.SessionID, ok bool) {
@@ -51,17 +50,8 @@ func NewErrorInterceptor() connect.UnaryInterceptorFunc {
 		) (connect.AnyResponse, error) {
 			res, err := next(ctx, req)
 			if aerr, ok := apperr.As(err); ok {
-				switch aerr.Code {
-				case sharederr.CodeAlreadyExists:
-					err = connect.NewError(connect.CodeAlreadyExists, err)
-				case sharederr.CodeInvalidArgument:
-					err = connect.NewError(connect.CodeInvalidArgument, err)
-				case sharederr.CodeNotFound:
-					err = connect.NewError(connect.CodeNotFound, err)
-				case sharederr.CodeUnauthorized:
-					err = connect.NewError(connect.CodePermissionDenied, err)
-				case sharederr.CodeUnauthenticated:
-					err = connect.NewError(connect.CodeUnauthenticated, err)
+				if connectErrorCode, ok := AppErrorCodeToConnectErrorCode[aerr.Code]; ok {
+					err = connect.NewError(connectErrorCode, err)
 				}
 			}
 			return res, err