fix: Add reflect and server endpoints

Author: AchoArnold

README.md

@@ -3,7 +3,7 @@
 [![Build](https://github.com/NdoleStudio/httpmock/actions/workflows/ci.yml/badge.svg)](https://github.com/NdoleStudio/httpmock/actions/workflows/ci.yml)
 [![GitHub contributors](https://img.shields.io/github/contributors/NdoleStudio/httpmock)](https://github.com/NdoleStudio/httpmock/graphs/contributors)
 [![GitHub license](https://img.shields.io/github/license/NdoleStudio/httpmock?color=brightgreen)](https://github.com/NdoleStudio/httpmock/blob/master/LICENSE)
-![Docker Pulls](https://img.shields.io/docker/pulls/ndolestudio/httpmock)
+[![Docker Pulls](https://img.shields.io/docker/pulls/ndolestudio/httpmock)](https://hub.docker.com/r/ndolestudio/httpmock)
 [![Netlify Status](https://api.netlify.com/api/v1/badges/6a751c80-ac38-4fa0-a470-3d2a69f98dfc/deploy-status)](https://app.netlify.com/sites/httpmock/deploys)
 
 This is a mock http server which can be used to test HTTP requests and responses when building an HTTP client.

api/pkg/di/container.go

@@ -143,7 +143,14 @@ func (container *Container) App() (app *fiber.App) {
 		},
 	))
 	app.Use(cors.New())
-	app.Use(middlewares.RequestRouter(container.Tracer(), container.Logger(), os.Getenv("APP_HOSTNAME"), container.ProjectEndpointRequestService()))
+	app.Use(middlewares.RequestRouter(
+		container.Tracer(),
+		container.Logger(),
+		os.Getenv("APP_HOSTNAME"),
+		container.ProjectEndpointRequestService(),
+		container.ServerHandler().Handle,
+		container.ReflectHandler().Handle,
+	))
 	app.Use(healthcheck.New())
 
 	container.app = app
@@ -152,6 +159,8 @@ func (container *Container) App() (app *fiber.App) {
 	container.RegisterProjectRoutes()
 	container.RegisterProjectEndpointRoutes()
 	container.RegisterProjectEndpointRequestRoutes()
+	container.RegisterReflectRoutes()
+	container.RegisterServerRoutes()
 
 	// UnAuthenticated routes
 	container.RegisterLemonsqueezyRoutes()
@@ -296,6 +305,18 @@ func (container *Container) RegisterProjectEndpointRequestRoutes() {
 	container.ProjectEndpointRequestHandler().RegisterRoutes(container.App(), container.ClerkBearerAuthMiddlewares())
 }
 
+// RegisterReflectRoutes registers routes for the /reflect
+func (container *Container) RegisterReflectRoutes() {
+	container.logger.Debug(fmt.Sprintf("registering %T routes", &handlers.ReflectHandler{}))
+	container.ReflectHandler().RegisterRoutes(container.App())
+}
+
+// RegisterServerRoutes registers routes for the /server
+func (container *Container) RegisterServerRoutes() {
+	container.logger.Debug(fmt.Sprintf("registering %T routes", &handlers.ServerHandler{}))
+	container.ServerHandler().RegisterRoutes(container.App())
+}
+
 // ProjectHandler creates a new instance of handlers.ProjectHandler
 func (container *Container) ProjectHandler() (handler *handlers.ProjectHandler) {
 	container.logger.Debug(fmt.Sprintf("creating %T", handler))
@@ -319,6 +340,24 @@ func (container *Container) ProjectEndpointHandler() (handler *handlers.ProjectE
 	)
 }
 
+// ReflectHandler creates a new instance of handlers.ReflectHandler
+func (container *Container) ReflectHandler() (handler *handlers.ReflectHandler) {
+	container.logger.Debug(fmt.Sprintf("creating %T", handler))
+	return handlers.NewReflectHandler(
+		container.Logger(),
+		container.Tracer(),
+	)
+}
+
+// ServerHandler creates a new instance of handlers.ServerHandler
+func (container *Container) ServerHandler() (handler *handlers.ServerHandler) {
+	container.logger.Debug(fmt.Sprintf("creating %T", handler))
+	return handlers.NewServerHandler(
+		container.Logger(),
+		container.Tracer(),
+	)
+}
+
 // ProjectEndpointRequestHandler creates a new instance of handlers.ProjectEndpointRequestHandler
 func (container *Container) ProjectEndpointRequestHandler() (handler *handlers.ProjectEndpointRequestHandler) {
 	container.logger.Debug(fmt.Sprintf("creating %T", handler))

api/pkg/handlers/reflect_handler.go

@@ -0,0 +1,84 @@
+package handlers
+
+import (
+	"errors"
+	"fmt"
+	"strconv"
+	"strings"
+
+	"github.com/NdoleStudio/httpmock/pkg/telemetry"
+	"github.com/gofiber/fiber/v2"
+	"github.com/palantir/stacktrace"
+)
+
+// ReflectHandler handles requests to the /reflect* endpoints
+type ReflectHandler struct {
+	handler
+	logger telemetry.Logger
+	tracer telemetry.Tracer
+}
+
+// NewReflectHandler creates a new ServerHandler
+func NewReflectHandler(
+	logger telemetry.Logger,
+	tracer telemetry.Tracer,
+) (h *ReflectHandler) {
+	return &ReflectHandler{
+		logger: logger.WithCodeNamespace(fmt.Sprintf("%T", h)),
+		tracer: tracer,
+	}
+}
+
+// RegisterRoutes registers the routes for the MessageHandler
+func (h *ReflectHandler) RegisterRoutes(app *fiber.App) {
+	router := app.Group("/reflect")
+	router.All("/*", h.Handle)
+}
+
+// Handle handles the request
+func (h *ReflectHandler) Handle(c *fiber.Ctx) error {
+	_, span, ctxLogger := h.tracer.StartFromFiberCtxWithLogger(c, h.logger)
+	defer span.End()
+
+	for _, header := range h.getResponseHeaders(c) {
+		for key, value := range header {
+			c.Response().Header.Set(key, value)
+		}
+	}
+
+	c.Response().SetStatusCode(h.getResponseStatus(ctxLogger, c))
+
+	if len(c.Body()) > 0 {
+		if _, err := c.Response().BodyWriter().Write(c.Body()); err != nil {
+			msg := fmt.Sprintf("error while writing response body [%s] for request [%s] with method [%s]", c.Body(), c.BaseURL()+c.OriginalURL(), c.Method())
+			ctxLogger.Error(h.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg)))
+		}
+	}
+
+	return nil
+}
+
+func (h *ReflectHandler) getResponseStatus(ctxLogger telemetry.Logger, c *fiber.Ctx) int {
+	status := strings.TrimSpace(c.Get("response-status"))
+	if status == "" {
+		return fiber.StatusOK
+	}
+
+	statusCode, err := strconv.Atoi(status)
+	if err != nil || statusCode < 100 || statusCode > 599 {
+		msg := fmt.Sprintf("The request has an invalid 'response-status' header [%s], defaulting to [%d]", c.Get("response-status"), fiber.StatusOK)
+		ctxLogger.Warn(errors.New(msg))
+		return fiber.StatusOK
+	}
+	return statusCode
+}
+
+func (h *ReflectHandler) getResponseHeaders(c *fiber.Ctx) []map[string]string {
+	var headers []map[string]string
+	for key, value := range c.GetReqHeaders() {
+		for _, header := range value {
+			headers = append(headers, map[string]string{key: header})
+		}
+	}
+	return headers
+}

api/pkg/handlers/server_handler.go

@@ -0,0 +1,114 @@
+package handlers
+
+import (
+	"encoding/json"
+	"errors"
+	"fmt"
+	"strconv"
+	"strings"
+	"time"
+
+	"github.com/NdoleStudio/httpmock/pkg/telemetry"
+	"github.com/gofiber/fiber/v2"
+	"github.com/palantir/stacktrace"
+)
+
+// ServerHandler handles requests to the /server* endpoints
+type ServerHandler struct {
+	handler
+	logger telemetry.Logger
+	tracer telemetry.Tracer
+}
+
+// NewServerHandler creates a new ServerHandler
+func NewServerHandler(
+	logger telemetry.Logger,
+	tracer telemetry.Tracer,
+) (h *ServerHandler) {
+	return &ServerHandler{
+		logger: logger.WithCodeNamespace(fmt.Sprintf("%T", h)),
+		tracer: tracer,
+	}
+}
+
+// RegisterRoutes registers the routes for the MessageHandler
+func (h *ServerHandler) RegisterRoutes(app *fiber.App) {
+	router := app.Group("/server")
+	router.All("/*", h.Handle)
+}
+
+// Handle handles the request
+func (h *ServerHandler) Handle(c *fiber.Ctx) error {
+	_, span, ctxLogger := h.tracer.StartFromFiberCtxWithLogger(c, h.logger)
+	defer span.End()
+
+	stopwatch := time.Now()
+	headers := h.getResponseHeaders(ctxLogger, c)
+
+	delay := h.getResponseDelay(ctxLogger, c) - time.Since(stopwatch)
+	if delay > 0 {
+		time.Sleep(delay)
+	}
+
+	ctxLogger.Debug(fmt.Sprintf("finished handling request with URL [%s] in [%s]", c.BaseURL()+c.OriginalURL(), time.Since(stopwatch).String()))
+
+	for _, header := range headers {
+		for key, value := range header {
+			c.Response().Header.Set(key, value)
+		}
+	}
+
+	c.Response().SetStatusCode(h.getResponseStatus(ctxLogger, c))
+
+	responseBody := strings.TrimSpace(c.Get("response-body"))
+	if responseBody != "" {
+		if _, err := c.Response().BodyWriter().Write([]byte(responseBody)); err != nil {
+			msg := fmt.Sprintf("error while writing response body for request [%s] with method [%s]", c.BaseURL()+c.OriginalURL(), c.Method())
+			ctxLogger.Error(h.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg)))
+		}
+	}
+
+	return nil
+}
+
+func (h *ServerHandler) getResponseHeaders(ctxLogger telemetry.Logger, c *fiber.Ctx) []map[string]string {
+	var headers []map[string]string
+
+	headersString := strings.TrimSpace(c.Get("response-headers"))
+	if headersString == "" {
+		return headers
+	}
+
+	if err := json.Unmarshal([]byte(headersString), &headers); err != nil {
+		msg := fmt.Sprintf("Failed to parse headers [%s] into type [%T]", headersString, headers)
+		ctxLogger.Warn(errors.New(msg))
+		return headers
+	}
+
+	return headers
+}
+
+func (h *ServerHandler) getResponseDelay(ctxLogger telemetry.Logger, c *fiber.Ctx) time.Duration {
+	delay, err := strconv.Atoi(strings.TrimSpace(c.Get("response-delay")))
+	if err != nil || delay < 0 || delay > 100000 {
+		msg := fmt.Sprintf("The request has an invalid 'response-delay' header [%s], defaulting to 0", c.Get("response-delay"))
+		ctxLogger.Warn(errors.New(msg))
+		return 0
+	}
+	return time.Duration(delay) * time.Millisecond
+}
+
+func (h *ServerHandler) getResponseStatus(ctxLogger telemetry.Logger, c *fiber.Ctx) int {
+	status := strings.TrimSpace(c.Get("response-status"))
+	if status == "" {
+		return fiber.StatusOK
+	}
+
+	statusCode, err := strconv.Atoi(status)
+	if err != nil || statusCode < 100 || statusCode > 599 {
+		msg := fmt.Sprintf("The request has an invalid 'response-status' header [%s], defaulting to [%d]", c.Get("response-status"), fiber.StatusOK)
+		ctxLogger.Warn(errors.New(msg))
+		return fiber.StatusOK
+	}
+	return statusCode
+}

api/pkg/middlewares/request_router_middleware.go

@@ -2,6 +2,8 @@ package middlewares
 
 import (
 	"fmt"
+	"strconv"
+	"strings"
 	"time"
 
 	"github.com/NdoleStudio/httpmock/pkg/repositories"
@@ -12,7 +14,14 @@ import (
 )
 
 // RequestRouter handles requests to the server
-func RequestRouter(tracer telemetry.Tracer, logger telemetry.Logger, hostname string, requestService *services.ProjectEndpointRequestService) fiber.Handler {
+func RequestRouter(
+	tracer telemetry.Tracer,
+	logger telemetry.Logger,
+	hostname string,
+	requestService *services.ProjectEndpointRequestService,
+	serverHandler fiber.Handler,
+	reflectHandler fiber.Handler,
+) fiber.Handler {
 	return func(c *fiber.Ctx) error {
 		stopwatch := time.Now()
 
@@ -29,6 +38,10 @@ func RequestRouter(tracer telemetry.Tracer, logger telemetry.Logger, hostname st
 			return c.Next()
 		}
 
+		if len(c.Subdomains()[0]) < 8 {
+			return handleNamedSubdomains(c, strings.TrimSpace(c.Subdomains()[0]), serverHandler, reflectHandler)
+		}
+
 		endpoint, err := requestService.LoadByRequest(ctx, c.Subdomains()[0], c.Method(), c.Path())
 		if stacktrace.GetCode(err) == repositories.ErrCodeNotFound {
 			return c.Status(fiber.StatusNotFound).JSON(fiber.Map{
@@ -51,3 +64,22 @@ func RequestRouter(tracer telemetry.Tracer, logger telemetry.Logger, hostname st
 		return nil
 	}
 }
+
+func handleNamedSubdomains(c *fiber.Ctx, subdomain string, serverHandler fiber.Handler, reflectHandler fiber.Handler) error {
+	switch subdomain {
+	case "reflect":
+		return reflectHandler(c)
+	case "server":
+		return serverHandler(c)
+	}
+
+	if status, err := strconv.Atoi(subdomain); err == nil && status >= 100 && status <= 599 {
+		c.Request().Header.Set("response-status", subdomain)
+		return serverHandler(c)
+	}
+
+	return c.Status(fiber.StatusNotFound).JSON(fiber.Map{
+		"status":  "error",
+		"message": fmt.Sprintf("We cannot find a registered mock for URL [%s] and HTTP method [%s]", c.BaseURL()+c.OriginalURL(), c.Method()),
+	})
+}

api/pkg/validators/project_handler_validator.go

@@ -55,7 +55,7 @@ func (validator *ProjectHandlerValidator) ValidateUpdate(ctx context.Context, re
 			"subdomain": []string{
 				"required",
 				"alpha_dash",
-				"min:7",
+				"min:8",
 				"max:30",
 			},
 			"description": []string{
@@ -102,7 +102,7 @@ func (validator *ProjectHandlerValidator) ValidateCreate(ctx context.Context, re
 			"subdomain": []string{
 				"required",
 				"alpha_dash",
-				"min:7",
+				"min:8",
 				"max:30",
 			},
 			"description": []string{

web/src/app/projects/[project-id]/endpoints/[endpoint-id]/page.tsx

@@ -226,7 +226,7 @@ export default function EndpointShow() {
     }
     try {
       return JSON.stringify(JSON.parse(body), null, 4);
-    } catch (e) {
+    } catch (_) {
       return body;
     }
   };