feat(server/did): serve did:web docs (#57)

* serve did:web

* fix settings.yaml reload

* better error

Author: yashgorana

internal/server/datasite/datasite.go

@@ -184,7 +184,11 @@ func (d *DatasiteService) ReloadVanityDomains(email string) error {
 // handleBlobChange handles blob change notifications and reloads settings if needed
 func (d *DatasiteService) handleBlobChange(key string, eventType blob.BlobEventType) {
 	// ignore events other than put and delete or non-acl files
-	if eventType&(blob.BlobEventPut|blob.BlobEventDelete) == 0 || !strings.Contains(key, aclspec.ACLFileName) {
+	if eventType&(blob.BlobEventPut|blob.BlobEventDelete) == 0 {
+		return
+	}
+
+	if !strings.Contains(key, aclspec.ACLFileName) && !strings.Contains(key, SettingsFileName) {
 		return
 	}
 

internal/server/handlers/did/did.go

@@ -0,0 +1,60 @@
+package did
+
+import (
+	"fmt"
+	"io"
+	"net/http"
+
+	"github.com/gin-gonic/gin"
+	"github.com/openmined/syftbox/internal/server/blob"
+	"github.com/openmined/syftbox/internal/server/handlers/api"
+	"github.com/openmined/syftbox/internal/utils"
+)
+
+type DIDHandler struct {
+	blobService *blob.BlobService
+}
+
+func NewDIDHandler(blobService *blob.BlobService) *DIDHandler {
+	return &DIDHandler{blobService: blobService}
+}
+
+func (h *DIDHandler) GetDID(c *gin.Context) {
+	user := c.Param("user")
+
+	// check if user is a valid email
+	if !utils.IsValidEmail(user) {
+		api.ServeErrorHTML(c, http.StatusBadRequest, "Invalid Request", "<b><code>"+user+"</code></b> is not a valid user.")
+		return
+	}
+
+	didKey := fmt.Sprintf("%s/public/did.json", user)
+
+	// check if it exists in blob index
+	_, exists := h.blobService.Index().Get(didKey)
+	if !exists {
+		api.Serve404HTML(c)
+		return
+	}
+
+	resp, err := h.blobService.Backend().GetObject(c.Request.Context(), didKey)
+	if err != nil {
+		c.Error(err)
+		api.Serve500HTML(c, err)
+		return
+	}
+	defer resp.Body.Close()
+
+	// resp.ContentType may not have the correct MIME type
+	contentType := utils.DetectContentType(didKey)
+	c.Header("Content-Type", contentType)
+	c.Status(http.StatusOK)
+
+	// Stream response body directly
+	_, err = io.Copy(c.Writer, resp.Body)
+	if err != nil {
+		c.Error(err)
+		api.Serve500HTML(c, fmt.Errorf("failed to read file: %w", err))
+		return
+	}
+}

internal/server/handlers/explorer/explorer_handler.go

@@ -5,7 +5,6 @@ import (
 	"io"
 	"log/slog"
 	"maps"
-	"mime"
 	"net/http"
 	"path/filepath"
 	"slices"
@@ -23,6 +22,7 @@ import (
 	"github.com/openmined/syftbox/internal/server/datasite"
 	"github.com/openmined/syftbox/internal/server/handlers/api"
 	"github.com/openmined/syftbox/internal/server/middlewares"
+	"github.com/openmined/syftbox/internal/utils"
 )
 
 //go:embed index.html.tmpl
@@ -235,38 +235,22 @@ func (e *ExplorerHandler) serveFile(c *gin.Context, key string) {
 	defer resp.Body.Close()
 
 	// resp.ContentType may not have the correct MIME type
-	contentType := e.detectContentType(key)
+	contentType := utils.DetectContentType(key)
 	c.Header("Content-Type", contentType)
 	c.Status(http.StatusOK)
 
 	// Stream response body directly
 	_, err = io.Copy(c.Writer, resp.Body)
 	if err != nil {
-		api.Serve500HTML(c, fmt.Errorf("failed to stream file: %w", err))
+		api.Serve500HTML(c, fmt.Errorf("failed to read file: %w", err))
 		return
 	}
 }
 
-func (e *ExplorerHandler) detectContentType(key string) string {
-	if isTextLike(key) {
-		return "text/plain; charset=utf-8"
-	} else if mimeType := mime.TypeByExtension(filepath.Ext(key)); mimeType != "" {
-		return mimeType
-	}
-	return "application/octet-stream"
-}
-
 func datasiteFromPath(path string) string {
 	parts := strings.Split(path, "/")
 	if len(parts) > 1 {
 		return parts[0]
 	}
 	return ""
 }
-
-func isTextLike(key string) bool {
-	return strings.HasSuffix(key, ".yaml") ||
-		strings.HasSuffix(key, ".yml") ||
-		strings.HasSuffix(key, ".toml") ||
-		strings.HasSuffix(key, ".md")
-}

internal/server/routes.go

@@ -14,6 +14,7 @@ import (
 	"github.com/openmined/syftbox/internal/server/handlers/auth"
 	"github.com/openmined/syftbox/internal/server/handlers/blob"
 	"github.com/openmined/syftbox/internal/server/handlers/datasite"
+	"github.com/openmined/syftbox/internal/server/handlers/did"
 	"github.com/openmined/syftbox/internal/server/handlers/explorer"
 	"github.com/openmined/syftbox/internal/server/handlers/install"
 	"github.com/openmined/syftbox/internal/server/handlers/send"
@@ -58,6 +59,7 @@ func SetupRoutes(cfg *Config, svc *Services, hub *ws.WebsocketHub) http.Handler
 	authH := auth.New(svc.Auth)
 	aclH := acl.NewACLHandler(svc.ACL)
 	sendH := send.New(send.NewWSMsgDispatcher(hub), send.NewBlobMsgStore(svc.Blob))
+	didH := did.NewDIDHandler(svc.Blob)
 
 	// --------------------------- routes ---------------------------
 
@@ -71,6 +73,7 @@ func SetupRoutes(cfg *Config, svc *Services, hub *ws.WebsocketHub) http.Handler
 	r.GET("/install.ps1", install.ServePS1)
 	r.GET("/datasites/*filepath", explorerH.Handler)
 	r.StaticFS("/releases", http.Dir("./releases"))
+	r.GET("/users/:user/did.json", didH.GetDID)
 
 	auth := r.Group("/auth")
 	auth.Use(middlewares.RateLimiter("10-M")) // 10 req/min

internal/utils/content_type.go

@@ -0,0 +1,23 @@
+package utils
+
+import (
+	"mime"
+	"path/filepath"
+	"strings"
+)
+
+func DetectContentType(key string) string {
+	if isTextLike(key) {
+		return "text/plain; charset=utf-8"
+	} else if mimeType := mime.TypeByExtension(filepath.Ext(key)); mimeType != "" {
+		return mimeType
+	}
+	return "application/octet-stream"
+}
+
+func isTextLike(key string) bool {
+	return strings.HasSuffix(key, ".yaml") ||
+		strings.HasSuffix(key, ".yml") ||
+		strings.HasSuffix(key, ".toml") ||
+		strings.HasSuffix(key, ".md")
+}