feat: refactor to use interfaces

.gitignore

@@ -20,3 +20,6 @@
 
 # Go workspace file
 go.work
+
+# jetbrains editor
+.idea

cmd/federation.go

@@ -11,17 +11,24 @@ import (
 )
 
 func main() {
+	// bootstrap logger
+	logger := log.NewLogger()
+
 	// Load connection string from .env file
 	err := godotenv.Load()
 	if err != nil {
-		log.Warn(fmt.Sprintf("failed to load env, %v", err))
+		logger.Warn(fmt.Sprintf("failed to load env, %v", err))
 	}
+
 	conn, err := db.Connect()
+	defer conn.Close()
 	if err != nil {
-		log.Fatal("failed connecting to db", err)
+		logger.Fatal("failed connecting to db", err)
 	}
-	defer conn.Close()
 	db.RunMigrations(conn)
-	http.RunServer()
+
+	s := http.NewServer(logger)
+	s.RunServer()
+
 	os.Exit(0)
 }

internal/db/migrate.go

@@ -17,18 +17,19 @@ import (
 var migrations embed.FS
 
 func RunMigrations(db *sql.DB) {
-	log.Debug("Running migrations...")
+	logger := log.NewLogger()
+	logger.Debug("Running migrations...")
 	driver, err := mysql.WithInstance(db, &mysql.Config{})
 	if err != nil {
-		log.Fatal("Error getting MySQL driver", err)
+		logger.Fatal("Error getting MySQL driver", err)
 	}
 	source, _ := iofs.New(migrations, "migrations")
 	m, err := migrate.NewWithInstance("iofs", source, "mysql", driver)
 	if err != nil {
-		log.Fatal("Error connecting to database", err)
+		logger.Fatal("Error connecting to database", err)
 	}
 	if err := m.Up(); err != nil && fmt.Sprintf("%s", err) != "no change" {
-		log.Fatal("Error running migrations", err)
+		logger.Fatal("Error running migrations", err)
 	}
-	log.Debug("Done!")
+	logger.Debug("Done!")
 }

internal/http/routes/activity.go → internal/http/activity.go

@@ -1,33 +1,31 @@
-package routes
+package http
 
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 	"net/http"
 	"sublinks/sublinks-federation/internal/activitypub"
 	"sublinks/sublinks-federation/internal/lemmy"
-	"sublinks/sublinks-federation/internal/log"
-
-	"fmt"
 
 	"golang.org/x/text/cases"
 	"golang.org/x/text/language"
 
 	"github.com/gorilla/mux"
 )
 
-func SetupActivityRoutes(r *mux.Router) {
-	r.HandleFunc("/activities/{action}/{id}", getActivityHandler).Methods("GET")
+func (s Server) SetupActivityRoutes() {
+	s.Router.HandleFunc("/activities/{action}/{id}", s.getActivityHandler).Methods("GET")
 }
 
-func getActivityHandler(w http.ResponseWriter, r *http.Request) {
+func (s Server) getActivityHandler(w http.ResponseWriter, r *http.Request) {
 	vars := mux.Vars(r)
 	var content []byte
 	switch vars["action"] {
 	case "create":
-		obj, err := GetPostActivityObject(vars["id"])
+		obj, err := s.GetPostActivityObject(vars["id"])
 		if err != nil {
-			log.Error("Error reading object", err)
+			s.Logger.Error("Error reading object", err)
 			w.WriteHeader(http.StatusInternalServerError)
 			return
 		}
@@ -54,12 +52,12 @@ func getActivityHandler(w http.ResponseWriter, r *http.Request) {
 	w.Write(content)
 }
 
-func GetPostActivityObject(id string) (*activitypub.Post, error) {
+func (s Server) GetPostActivityObject(id string) (*activitypub.Post, error) {
 	ctx := context.Background()
 	c := lemmy.GetLemmyClient(ctx)
 	post, err := c.GetPost(ctx, id)
 	if err != nil {
-		log.Error("Error reading post", err)
+		s.Logger.Error("Error reading post", err)
 		return nil, err
 	}
 	return activitypub.ConvertPostToApub(post), nil

internal/http/apub.go

@@ -0,0 +1,32 @@
+package http
+
+import (
+	"net/http"
+)
+
+func (s Server) SetupApubRoutes() {
+	s.Router.HandleFunc("/users/{user}/inbox", s.getInboxHandler).Methods("GET")
+	s.Router.HandleFunc("/users/{user}/inbox", s.postInboxHandler).Methods("POST")
+	s.Router.HandleFunc("/users/{user}/outbox", s.getOutboxHandler).Methods("GET")
+	s.Router.HandleFunc("/users/{user}/outbox", s.postOutboxHandler).Methods("POST")
+}
+
+func (s Server) getInboxHandler(w http.ResponseWriter, r *http.Request) {
+	w.WriteHeader(http.StatusOK)
+	w.Header().Add("content-type", "application/activity+json")
+}
+
+func (s Server) postInboxHandler(w http.ResponseWriter, r *http.Request) {
+	w.WriteHeader(http.StatusOK)
+	w.Header().Add("content-type", "application/activity+json")
+}
+
+func (s Server) getOutboxHandler(w http.ResponseWriter, r *http.Request) {
+	w.WriteHeader(http.StatusOK)
+	w.Header().Add("content-type", "application/activity+json")
+}
+
+func (s Server) postOutboxHandler(w http.ResponseWriter, r *http.Request) {
+	w.WriteHeader(http.StatusOK)
+	w.Header().Add("content-type", "application/activity+json")
+}

internal/http/middleware.go

@@ -0,0 +1,33 @@
+package http
+
+import (
+	"encoding/json"
+	"net/http"
+)
+
+type RequestError struct {
+	Msg string `json:"message"`
+}
+
+func (s Server) logMiddleware(next http.Handler) http.Handler {
+	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		s.Logger.Request("", r)
+		next.ServeHTTP(w, r)
+	})
+}
+
+func (s Server) notFound(w http.ResponseWriter, r *http.Request) {
+	s.Logger.Request("404 Not Found", r)
+	w.WriteHeader(http.StatusNotFound)
+	w.Header().Add("content-type", "application/activity+json")
+	content, _ := json.Marshal(RequestError{Msg: "not found"})
+	w.Write(content)
+}
+
+func (s Server) notAllowedMethod(w http.ResponseWriter, r *http.Request) {
+	s.Logger.Request("405 Method Not Allowed", r)
+	w.WriteHeader(http.StatusNotFound)
+	w.Header().Add("content-type", "application/activity+json")
+	content, _ := json.Marshal(RequestError{Msg: "method not allowed"})
+	w.Write(content)
+}

internal/http/routes/post.go → internal/http/post.go

@@ -1,27 +1,25 @@
-package routes
+package http
 
 import (
 	"context"
 	"encoding/json"
+	"github.com/gorilla/mux"
 	"net/http"
 	"sublinks/sublinks-federation/internal/activitypub"
 	"sublinks/sublinks-federation/internal/lemmy"
-	"sublinks/sublinks-federation/internal/log"
-
-	"github.com/gorilla/mux"
 )
 
-func SetupPostRoutes(r *mux.Router) {
-	r.HandleFunc("/post/{postId}", getPostHandler).Methods("GET")
+func (s Server) SetupPostRoutes() {
+	s.Router.HandleFunc("/post/{postId}", s.getPostHandler).Methods("GET")
 }
 
-func getPostHandler(w http.ResponseWriter, r *http.Request) {
+func (s Server) getPostHandler(w http.ResponseWriter, r *http.Request) {
 	vars := mux.Vars(r)
 	ctx := context.Background()
 	c := lemmy.GetLemmyClient(ctx)
 	post, err := c.GetPost(ctx, vars["postId"])
 	if err != nil {
-		log.Error("Error reading post", err)
+		s.Logger.Error("Error reading post", err)
 		return
 	}
 	postLd := activitypub.ConvertPostToApub(post)

internal/http/server.go

@@ -3,35 +3,56 @@ package http
 import (
 	"context"
 	"flag"
+	"github.com/gorilla/mux"
 	"net/http"
 	"os"
 	"os/signal"
-	"sublinks/sublinks-federation/internal/http/routes"
 	"sublinks/sublinks-federation/internal/log"
 	"time"
 )
 
-func RunServer() {
+type Server struct {
+	*mux.Router
+	log.Logger
+}
+
+func NewServer(logger log.Logger) *Server {
+	r := mux.NewRouter()
+
+	return &Server{
+		Router: r,
+		Logger: logger,
+	}
+}
+
+func (s Server) RunServer() {
 	var wait time.Duration
 	flag.DurationVar(&wait, "graceful-timeout", time.Second*15, "the duration for which the server gracefully wait for existing connections to finish - e.g. 15s or 1m")
 	flag.Parse()
 
-	r := routes.SetupRoutes()
+	s.SetupUserRoutes()
+	s.SetupPostRoutes()
+	s.SetupApubRoutes()
+	s.SetupActivityRoutes()
+	s.NotFoundHandler = http.HandlerFunc(s.notFound)
+	s.MethodNotAllowedHandler = http.HandlerFunc(s.notAllowedMethod)
+	s.Use(s.logMiddleware)
 
 	srv := &http.Server{
 		Addr: "0.0.0.0:8080",
 		// Good practice to set timeouts to avoid Slowloris attacks.
 		WriteTimeout: time.Second * 15,
 		ReadTimeout:  time.Second * 15,
 		IdleTimeout:  time.Second * 60,
-		Handler:      r, // Pass our instance of gorilla/mux in.
+		// pass embed of Server for *mux
+		Handler: s,
 	}
 
 	// Run our server in a goroutine so that it doesn't block.
 	go func() {
-		log.Info("Starting server")
+		s.Logger.Info("Starting server")
 		if err := srv.ListenAndServe(); err != nil {
-			log.Error("Error starting server", err)
+			s.Logger.Error("Error starting server", err)
 		}
 	}()
 
@@ -52,5 +73,5 @@ func RunServer() {
 	// Optionally, you could run srv.Shutdown in a goroutine and block on
 	// <-ctx.Done() if your application should wait for other services
 	// to finalize based on context cancellation.
-	log.Info("shutting down")
+	s.Logger.Info("shutting down")
 }