Pull request 1870: nextapi-frontend-fs

Merge in DNS/adguard-home from nextapi-frontend-fs to master

Squashed commit of the following:

commit 3ed959f21939cf5590c27426af46906cbffed502
Merge: e60bbdd04 9fda7bfd3
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Tue Jun 13 13:37:00 2023 +0300

    Merge branch 'master' into nextapi-frontend-fs

commit e60bbdd04ce841c1aaaa198cc9dc85ae14799ffa
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Fri Jun 9 14:53:09 2023 +0300

    next: support frontend fs

internal/next/websvc/http.go

@@ -53,6 +53,7 @@ func (svc *Service) handlePatchSettingsHTTP(w http.ResponseWriter, r *http.Reque
 
 	newConf := &Config{
 		ConfigManager:   svc.confMgr,
+		Frontend:        svc.frontend,
 		TLS:             svc.tls,
 		Addresses:       req.Addresses,
 		SecureAddresses: req.SecureAddresses,

internal/next/websvc/http_test.go

@@ -24,21 +24,20 @@ func TestService_HandlePatchSettingsHTTP(t *testing.T) {
 		ForceHTTPS:      false,
 	}
 
+	svc, err := websvc.New(&websvc.Config{
+		TLS: &tls.Config{
+			Certificates: []tls.Certificate{{}},
+		},
+		Addresses:       []netip.AddrPort{netip.MustParseAddrPort("127.0.0.1:80")},
+		SecureAddresses: []netip.AddrPort{netip.MustParseAddrPort("127.0.0.1:443")},
+		Timeout:         5 * time.Second,
+		ForceHTTPS:      true,
+	})
+	require.NoError(t, err)
+
 	confMgr := newConfigManager()
-	confMgr.onWeb = func() (s agh.ServiceWithConfig[*websvc.Config]) {
-		return websvc.New(&websvc.Config{
-			TLS: &tls.Config{
-				Certificates: []tls.Certificate{{}},
-			},
-			Addresses:       []netip.AddrPort{netip.MustParseAddrPort("127.0.0.1:80")},
-			SecureAddresses: []netip.AddrPort{netip.MustParseAddrPort("127.0.0.1:443")},
-			Timeout:         5 * time.Second,
-			ForceHTTPS:      true,
-		})
-	}
-	confMgr.onUpdateWeb = func(ctx context.Context, c *websvc.Config) (err error) {
-		return nil
-	}
+	confMgr.onWeb = func() (s agh.ServiceWithConfig[*websvc.Config]) { return svc }
+	confMgr.onUpdateWeb = func(ctx context.Context, c *websvc.Config) (err error) { return nil }
 
 	_, addr := newTestServer(t, confMgr)
 	u := &url.URL{
@@ -56,7 +55,7 @@ func TestService_HandlePatchSettingsHTTP(t *testing.T) {
 
 	respBody := httpPatch(t, u, req, http.StatusOK)
 	resp := &websvc.HTTPAPIHTTPSettings{}
-	err := json.Unmarshal(respBody, resp)
+	err = json.Unmarshal(respBody, resp)
 	require.NoError(t, err)
 
 	assert.Equal(t, wantWeb, resp)

internal/next/websvc/middleware.go

@@ -2,9 +2,11 @@ package websvc
 
 import (
 	"net/http"
+	"time"
 
 	"github.com/AdguardTeam/AdGuardHome/internal/aghhttp"
 	"github.com/AdguardTeam/golibs/httphdr"
+	"github.com/AdguardTeam/golibs/log"
 )
 
 // Middlewares
@@ -19,3 +21,18 @@ func jsonMw(h http.Handler) (wrapped http.HandlerFunc) {
 
 	return http.HandlerFunc(f)
 }
+
+// logMw logs the queries with level debug.
+func logMw(h http.Handler) (wrapped http.HandlerFunc) {
+	f := func(w http.ResponseWriter, r *http.Request) {
+		start := time.Now()
+		m, u := r.Method, r.RequestURI
+
+		log.Debug("websvc: %s %s started", m, u)
+		defer func() { log.Debug("websvc: %s %s finished in %s", m, u, time.Since(start)) }()
+
+		h.ServeHTTP(w, r)
+	}
+
+	return http.HandlerFunc(f)
+}

internal/next/websvc/path.go

@@ -2,6 +2,9 @@ package websvc
 
 // Path constants
 const (
+	PathRoot     = "/"
+	PathFrontend = "/*filepath"
+
 	PathHealthCheck = "/health-check"
 
 	PathV1SettingsAll  = "/api/v1/settings/all"

internal/next/websvc/settings_test.go

@@ -46,16 +46,19 @@ func TestService_HandleGetSettingsAll(t *testing.T) {
 		return c
 	}
 
+	svc, err := websvc.New(&websvc.Config{
+		TLS: &tls.Config{
+			Certificates: []tls.Certificate{{}},
+		},
+		Addresses:       wantWeb.Addresses,
+		SecureAddresses: wantWeb.SecureAddresses,
+		Timeout:         time.Duration(wantWeb.Timeout),
+		ForceHTTPS:      true,
+	})
+	require.NoError(t, err)
+
 	confMgr.onWeb = func() (s agh.ServiceWithConfig[*websvc.Config]) {
-		return websvc.New(&websvc.Config{
-			TLS: &tls.Config{
-				Certificates: []tls.Certificate{{}},
-			},
-			Addresses:       wantWeb.Addresses,
-			SecureAddresses: wantWeb.SecureAddresses,
-			Timeout:         time.Duration(wantWeb.Timeout),
-			ForceHTTPS:      true,
-		})
+		return svc
 	}
 
 	_, addr := newTestServer(t, confMgr)
@@ -67,7 +70,7 @@ func TestService_HandleGetSettingsAll(t *testing.T) {
 
 	body := httpGet(t, u, http.StatusOK)
 	resp := &websvc.RespGetV1SettingsAll{}
-	err := json.Unmarshal(body, resp)
+	err = json.Unmarshal(body, resp)
 	require.NoError(t, err)
 
 	assert.Equal(t, wantDNS, resp.DNS)

internal/next/websvc/websvc.go

@@ -11,6 +11,7 @@ import (
 	"crypto/tls"
 	"fmt"
 	"io"
+	"io/fs"
 	"net"
 	"net/http"
 	"net/netip"
@@ -39,6 +40,10 @@ type Config struct {
 	// dynamically reconfigure them.
 	ConfigManager ConfigManager
 
+	// Frontend is the filesystem with the frontend and other statically
+	// compiled files.
+	Frontend fs.FS
+
 	// TLS is the optional TLS configuration.  If TLS is not nil,
 	// SecureAddresses must not be empty.
 	TLS *tls.Config
@@ -67,6 +72,7 @@ type Config struct {
 // [agh.Service] that does nothing.
 type Service struct {
 	confMgr    ConfigManager
+	frontend   fs.FS
 	tls        *tls.Config
 	start      time.Time
 	servers    []*http.Server
@@ -77,13 +83,22 @@ type Service struct {
 // New returns a new properly initialized *Service.  If c is nil, svc is a nil
 // *Service that does nothing.  The fields of c must not be modified after
 // calling New.
-func New(c *Config) (svc *Service) {
+//
+// TODO(a.garipov): Get rid of this special handling of nil or explain it
+// better.
+func New(c *Config) (svc *Service, err error) {
 	if c == nil {
-		return nil
+		return nil, nil
+	}
+
+	frontend, err := fs.Sub(c.Frontend, "build/static")
+	if err != nil {
+		return nil, fmt.Errorf("frontend fs: %w", err)
 	}
 
 	svc = &Service{
 		confMgr:    c.ConfigManager,
+		frontend:   frontend,
 		tls:        c.TLS,
 		start:      c.Start,
 		timeout:    c.Timeout,
@@ -121,7 +136,7 @@ func New(c *Config) (svc *Service) {
 		})
 	}
 
-	return svc
+	return svc, nil
 }
 
 // newMux returns a new HTTP request multiplexor for the AdGuard Home web
@@ -132,41 +147,54 @@ func newMux(svc *Service) (mux *httptreemux.ContextMux) {
 	routes := []struct {
 		handler http.HandlerFunc
 		method  string
-		path    string
+		pattern string
 		isJSON  bool
 	}{{
 		handler: svc.handleGetHealthCheck,
 		method:  http.MethodGet,
-		path:    PathHealthCheck,
+		pattern: PathHealthCheck,
+		isJSON:  false,
+	}, {
+		handler: http.FileServer(http.FS(svc.frontend)).ServeHTTP,
+		method:  http.MethodGet,
+		pattern: PathFrontend,
+		isJSON:  false,
+	}, {
+		handler: http.FileServer(http.FS(svc.frontend)).ServeHTTP,
+		method:  http.MethodGet,
+		pattern: PathRoot,
 		isJSON:  false,
 	}, {
 		handler: svc.handleGetSettingsAll,
 		method:  http.MethodGet,
-		path:    PathV1SettingsAll,
+		pattern: PathV1SettingsAll,
 		isJSON:  true,
 	}, {
 		handler: svc.handlePatchSettingsDNS,
 		method:  http.MethodPatch,
-		path:    PathV1SettingsDNS,
+		pattern: PathV1SettingsDNS,
 		isJSON:  true,
 	}, {
 		handler: svc.handlePatchSettingsHTTP,
 		method:  http.MethodPatch,
-		path:    PathV1SettingsHTTP,
+		pattern: PathV1SettingsHTTP,
 		isJSON:  true,
 	}, {
 		handler: svc.handleGetV1SystemInfo,
 		method:  http.MethodGet,
-		path:    PathV1SystemInfo,
+		pattern: PathV1SystemInfo,
 		isJSON:  true,
 	}}
 
 	for _, r := range routes {
+		var hdlr http.Handler
 		if r.isJSON {
-			mux.Handle(r.method, r.path, jsonMw(r.handler))
+			hdlr = jsonMw(r.handler)
 		} else {
-			mux.Handle(r.method, r.path, r.handler)
+			hdlr = r.handler
 		}
+
+		mux.Handle(r.method, r.pattern, logMw(hdlr))
 	}
 
 	return mux

internal/next/websvc/websvc_test.go

@@ -5,12 +5,14 @@ import (
 	"context"
 	"encoding/json"
 	"io"
+	"io/fs"
 	"net/http"
 	"net/netip"
 	"net/url"
 	"testing"
 	"time"
 
+	"github.com/AdguardTeam/AdGuardHome/internal/aghtest"
 	"github.com/AdguardTeam/AdGuardHome/internal/next/agh"
 	"github.com/AdguardTeam/AdGuardHome/internal/next/dnssvc"
 	"github.com/AdguardTeam/AdGuardHome/internal/next/websvc"
@@ -87,7 +89,10 @@ func newTestServer(
 	t.Helper()
 
 	c := &websvc.Config{
-		ConfigManager:   confMgr,
+		ConfigManager: confMgr,
+		Frontend: &aghtest.FS{
+			OnOpen: func(_ string) (_ fs.File, _ error) { return nil, fs.ErrNotExist },
+		},
 		TLS:             nil,
 		Addresses:       []netip.AddrPort{netip.MustParseAddrPort("127.0.0.1:0")},
 		SecureAddresses: nil,
@@ -96,9 +101,10 @@ func newTestServer(
 		ForceHTTPS:      false,
 	}
 
-	svc = websvc.New(c)
+	svc, err := websvc.New(c)
+	require.NoError(t, err)
 
-	err := svc.Start()
+	err = svc.Start()
 	require.NoError(t, err)
 	t.Cleanup(func() {
 		ctx, cancel := context.WithTimeout(context.Background(), testTimeout)