feat(controller,app): add edge apps controller

internal/agent/controller/app/controller.go

@@ -0,0 +1,286 @@
+package app
+
+import (
+	"context"
+	"io"
+	"net/http"
+	"os"
+	"path/filepath"
+
+	"forge.cadoles.com/Cadoles/emissary/internal/agent"
+	"forge.cadoles.com/Cadoles/emissary/internal/spec/app"
+	"forge.cadoles.com/arcad/edge/pkg/bundle"
+	"forge.cadoles.com/arcad/edge/pkg/storage/sqlite"
+	"github.com/pkg/errors"
+	"gitlab.com/wpetit/goweb/logger"
+)
+
+type Controller struct {
+	currentSpecRevision int
+	client              *http.Client
+	downloadDir         string
+	dataDir             string
+	servers             map[string]*Server
+}
+
+// Name implements node.Controller.
+func (c *Controller) Name() string {
+	return "app-controller"
+}
+
+// Reconcile implements node.Controller.
+func (c *Controller) Reconcile(ctx context.Context, state *agent.State) error {
+	appSpec := app.NewSpec()
+
+	if err := state.GetSpec(app.NameApp, appSpec); err != nil {
+		if errors.Is(err, agent.ErrSpecNotFound) {
+			logger.Info(ctx, "could not find app spec, stopping all remaining apps")
+
+			c.stopAllApps(ctx)
+
+			return nil
+		}
+
+		return errors.WithStack(err)
+	}
+
+	logger.Info(ctx, "retrieved spec", logger.F("spec", appSpec.SpecName()), logger.F("revision", appSpec.SpecRevision()))
+
+	if c.currentSpecRevision == appSpec.SpecRevision() {
+		logger.Info(ctx, "spec revision did not change, doing nothing")
+
+		return nil
+	}
+
+	c.updateApps(ctx, appSpec)
+
+	return nil
+}
+
+func (c *Controller) stopAllApps(ctx context.Context) {
+	for appID, server := range c.servers {
+		logger.Info(ctx, "stopping app", logger.F("appID", appID))
+
+		if err := server.Stop(); err != nil {
+			logger.Error(
+				ctx, "error while stopping app",
+				logger.F("appID", appID),
+				logger.E(errors.WithStack(err)),
+			)
+
+			delete(c.servers, appID)
+		}
+	}
+}
+
+func (c *Controller) updateApps(ctx context.Context, spec *app.Spec) {
+	hadError := false
+
+	// Stop and remove obsolete apps
+	for appID, server := range c.servers {
+		if _, exists := spec.Apps[appID]; exists {
+			continue
+		}
+
+		logger.Info(ctx, "stopping app", logger.F("appID", appID))
+
+		if err := server.Stop(); err != nil {
+			logger.Error(
+				ctx, "error while stopping app",
+				logger.F("gatewayID", appID),
+				logger.E(errors.WithStack(err)),
+			)
+
+			delete(c.servers, appID)
+
+			hadError = true
+		}
+	}
+
+	// (Re)start apps
+	for appID, appSpec := range spec.Apps {
+		appCtx := logger.With(ctx, logger.F("appID", appID))
+
+		if err := c.updateApp(ctx, appID, appSpec); err != nil {
+			logger.Error(appCtx, "could not update app", logger.E(errors.WithStack(err)))
+
+			hadError = true
+
+			continue
+		}
+	}
+
+	if !hadError {
+		c.currentSpecRevision = spec.SpecRevision()
+		logger.Info(ctx, "updating current spec revision", logger.F("revision", c.currentSpecRevision))
+	}
+}
+
+func (c *Controller) updateApp(ctx context.Context, appID string, appSpec app.AppEntry) error {
+	bundle, sha256sum, err := c.ensureAppBundle(ctx, appID, appSpec)
+	if err != nil {
+		return errors.Wrap(err, "could not download app bundle")
+	}
+
+	dataDir, err := c.ensureAppDataDir(ctx, appID)
+	if err != nil {
+		return errors.Wrap(err, "could not retrieve app data dir")
+	}
+
+	server, exists := c.servers[appID]
+	if !exists {
+		logger.Info(ctx, "app currently not running")
+	} else if sha256sum != appSpec.SHA256Sum {
+		logger.Info(
+			ctx, "bundle hash mismatch, stopping app",
+			logger.F("currentHash", sha256sum),
+			logger.F("specHash", appSpec.SHA256Sum),
+		)
+
+		if err := server.Stop(); err != nil {
+			return errors.Wrap(err, "could not stop app")
+		}
+
+		server = nil
+	}
+
+	if server == nil {
+		dbFile := filepath.Join(dataDir, appID+".sqlite")
+		db, err := sqlite.Open(dbFile)
+		if err != nil {
+			return errors.Wrapf(err, "could not opend database file '%s'", dbFile)
+		}
+
+		server = NewServer(bundle, db)
+		c.servers[appID] = server
+	}
+
+	logger.Info(
+		ctx, "starting app",
+		logger.F("address", appSpec.Address),
+	)
+
+	if err := server.Start(ctx, appSpec.Address); err != nil {
+		delete(c.servers, appID)
+
+		return errors.Wrap(err, "could not start app")
+	}
+
+	return nil
+}
+
+func (c *Controller) ensureAppBundle(ctx context.Context, appID string, spec app.AppEntry) (bundle.Bundle, string, error) {
+	if err := os.MkdirAll(c.downloadDir, os.ModePerm); err != nil {
+		return nil, "", errors.WithStack(err)
+	}
+
+	bundlePath := filepath.Join(c.downloadDir, appID+"."+spec.Format)
+
+	_, err := os.Stat(bundlePath)
+	if err != nil && !errors.Is(err, os.ErrNotExist) {
+		return nil, "", errors.WithStack(err)
+	}
+
+	if errors.Is(err, os.ErrNotExist) {
+		if err := c.downloadFile(spec.URL, spec.SHA256Sum, bundlePath); err != nil {
+			return nil, "", errors.WithStack(err)
+		}
+	}
+
+	sha256sum, err := hash(bundlePath)
+	if err != nil {
+		return nil, "", errors.WithStack(err)
+	}
+
+	if sha256sum == spec.SHA256Sum {
+		bdle, err := bundle.FromPath(bundlePath)
+		if err != nil {
+			return nil, "", errors.WithStack(err)
+		}
+
+		return bdle, sha256sum, nil
+	}
+
+	logger.Info(ctx, "bundle hash mismatch, downloading app", logger.F("url", spec.URL))
+
+	if err := c.downloadFile(spec.URL, spec.SHA256Sum, bundlePath); err != nil {
+		return nil, "", errors.WithStack(err)
+	}
+
+	bdle, err := bundle.FromPath(bundlePath)
+	if err != nil {
+		return nil, "", errors.WithStack(err)
+	}
+
+	return bdle, "", nil
+}
+
+func (c *Controller) downloadFile(url string, sha256sum string, dest string) error {
+	res, err := c.client.Get(url)
+	if err != nil {
+		return errors.WithStack(err)
+	}
+
+	defer func() {
+		if err := res.Body.Close(); err != nil && !errors.Is(err, os.ErrClosed) {
+			panic(errors.WithStack(err))
+		}
+	}()
+
+	tmp, err := os.CreateTemp(filepath.Dir(dest), "download_")
+	if err != nil {
+		return errors.WithStack(err)
+	}
+
+	defer func() {
+		if err := os.Remove(tmp.Name()); err != nil && !os.IsNotExist(err) {
+			panic(errors.WithStack(err))
+		}
+	}()
+
+	if _, err := io.Copy(tmp, res.Body); err != nil {
+		return errors.WithStack(err)
+	}
+
+	tmpFileHash, err := hash(tmp.Name())
+	if err != nil {
+		return errors.WithStack(err)
+	}
+
+	if tmpFileHash != sha256sum {
+		return errors.Errorf("sha256 sum mismatch: expected '%s', got '%s'", sha256sum, tmpFileHash)
+	}
+
+	if err := os.Rename(tmp.Name(), dest); err != nil {
+		return errors.WithStack(err)
+	}
+
+	return nil
+}
+
+func (c *Controller) ensureAppDataDir(ctx context.Context, appID string) (string, error) {
+	dataDir := filepath.Join(c.dataDir, appID)
+
+	if err := os.MkdirAll(dataDir, os.ModePerm); err != nil {
+		return "", errors.WithStack(err)
+	}
+
+	return dataDir, nil
+}
+
+func NewController(funcs ...OptionFunc) *Controller {
+	opts := defaultOptions()
+	for _, fn := range funcs {
+		fn(opts)
+	}
+
+	return &Controller{
+		client:              opts.Client,
+		downloadDir:         opts.DownloadDir,
+		dataDir:             opts.DataDir,
+		currentSpecRevision: -1,
+		servers:             make(map[string]*Server),
+	}
+}
+
+var _ agent.Controller = &Controller{}

internal/agent/controller/app/hash.go

@@ -0,0 +1,31 @@
+package app
+
+import (
+	"crypto/sha256"
+	"encoding/hex"
+	"io"
+	"os"
+
+	"github.com/pkg/errors"
+)
+
+func hash(path string) (string, error) {
+	file, err := os.Open(path)
+	if err != nil {
+		return "", errors.WithStack(err)
+	}
+
+	hasher := sha256.New()
+
+	defer func() {
+		if err := file.Close(); err != nil {
+			panic(errors.WithStack(err))
+		}
+	}()
+
+	if _, err := io.Copy(hasher, file); err != nil {
+		return "", errors.WithStack(err)
+	}
+
+	return hex.EncodeToString(hasher.Sum(nil)), nil
+}

internal/agent/controller/app/options.go

@@ -0,0 +1,37 @@
+package app
+
+import "net/http"
+
+type Options struct {
+	DataDir     string
+	DownloadDir string
+	Client      *http.Client
+}
+
+func defaultOptions() *Options {
+	return &Options{
+		DataDir:     "apps/data",
+		DownloadDir: "apps/download",
+		Client:      &http.Client{},
+	}
+}
+
+type OptionFunc func(*Options)
+
+func WithDataDir(dataDir string) OptionFunc {
+	return func(o *Options) {
+		o.DataDir = dataDir
+	}
+}
+
+func WithDownloadDir(downloadDir string) OptionFunc {
+	return func(o *Options) {
+		o.DownloadDir = downloadDir
+	}
+}
+
+func WithClient(client *http.Client) OptionFunc {
+	return func(o *Options) {
+		o.Client = client
+	}
+}

internal/agent/controller/app/server.go

@@ -0,0 +1,125 @@
+package app
+
+import (
+	"context"
+	"database/sql"
+	"net/http"
+
+	"forge.cadoles.com/arcad/edge/pkg/app"
+	"forge.cadoles.com/arcad/edge/pkg/bus"
+	"forge.cadoles.com/arcad/edge/pkg/bus/memory"
+	edgeHTTP "forge.cadoles.com/arcad/edge/pkg/http"
+	"forge.cadoles.com/arcad/edge/pkg/module"
+	"forge.cadoles.com/arcad/edge/pkg/module/cast"
+	"forge.cadoles.com/arcad/edge/pkg/module/net"
+	"forge.cadoles.com/arcad/edge/pkg/storage"
+	"forge.cadoles.com/arcad/edge/pkg/storage/sqlite"
+
+	"forge.cadoles.com/arcad/edge/pkg/bundle"
+	"github.com/go-chi/chi/middleware"
+	"github.com/go-chi/chi/v5"
+	"github.com/pkg/errors"
+)
+
+type Server struct {
+	bundle bundle.Bundle
+	db     *sql.DB
+	server *http.Server
+}
+
+func (s *Server) Start(ctx context.Context, addr string) error {
+	if s.server != nil {
+		if err := s.Stop(); err != nil {
+			return errors.WithStack(err)
+		}
+	}
+
+	router := chi.NewRouter()
+
+	router.Use(middleware.Logger)
+
+	bus := memory.NewBus()
+	ds := sqlite.NewDocumentStoreWithDB(s.db)
+	bs := sqlite.NewBlobStoreWithDB(s.db)
+
+	handler := edgeHTTP.NewHandler(
+		edgeHTTP.WithBus(bus),
+		edgeHTTP.WithServerModules(s.getAppModules(bus, ds, bs)...),
+	)
+	if err := handler.Load(s.bundle); err != nil {
+		return errors.Wrap(err, "could not load app bundle")
+	}
+
+	router.Handle("/*", handler)
+
+	server := &http.Server{
+		Addr:    addr,
+		Handler: router,
+	}
+
+	go func() {
+		defer func() {
+			if err := s.Stop(); err != nil {
+				panic(errors.WithStack(err))
+			}
+		}()
+
+		if err := server.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {
+			panic(errors.WithStack(err))
+		}
+	}()
+
+	s.server = server
+
+	return nil
+}
+
+func (s *Server) Stop() error {
+	if s.server == nil {
+		return nil
+	}
+
+	defer func() {
+		s.server = nil
+	}()
+
+	if err := s.server.Close(); err != nil {
+		panic(errors.WithStack(err))
+	}
+
+	return nil
+}
+
+func (s *Server) getAppModules(bus bus.Bus, ds storage.DocumentStore, bs storage.BlobStore) []app.ServerModuleFactory {
+	return []app.ServerModuleFactory{
+		module.ContextModuleFactory(),
+		module.ConsoleModuleFactory(),
+		cast.CastModuleFactory(),
+		module.LifecycleModuleFactory(),
+		net.ModuleFactory(bus),
+		module.RPCModuleFactory(bus),
+		module.StoreModuleFactory(ds),
+		module.BlobModuleFactory(bus, bs),
+		// module.Extends(
+		// 	auth.ModuleFactory(
+		// 		auth.WithJWT(dummyKeyFunc),
+		// 	),
+		// 	func(o *goja.Object) {
+		// 		if err := o.Set("CLAIM_ROLE", "role"); err != nil {
+		// 			panic(errors.New("could not set 'CLAIM_ROLE' property"))
+		// 		}
+
+		// 		if err := o.Set("CLAIM_PREFERRED_USERNAME", "preferred_username"); err != nil {
+		// 			panic(errors.New("could not set 'CLAIM_PREFERRED_USERNAME' property"))
+		// 		}
+		// 	},
+		// ),
+	}
+}
+
+func NewServer(bundle bundle.Bundle, db *sql.DB) *Server {
+	return &Server{
+		bundle: bundle,
+		db:     db,
+	}
+}

internal/command/agent/run.go

@@ -4,6 +4,7 @@ import (
 	"time"
 
 	"forge.cadoles.com/Cadoles/emissary/internal/agent"
+	"forge.cadoles.com/Cadoles/emissary/internal/agent/controller/app"
 	"forge.cadoles.com/Cadoles/emissary/internal/agent/controller/gateway"
 	"forge.cadoles.com/Cadoles/emissary/internal/agent/controller/openwrt"
 	"forge.cadoles.com/Cadoles/emissary/internal/agent/controller/persistence"
@@ -59,6 +60,13 @@ func RunCommand() *cli.Command {
 				))
 			}
 
+			if ctrlConf.App.Enabled {
+				controllers = append(controllers, app.NewController(
+					app.WithDataDir(string(ctrlConf.App.DataDir)),
+					app.WithDownloadDir(string(ctrlConf.App.DownloadDir)),
+				))
+			}
+
 			key, err := jwk.LoadOrGenerate(string(conf.Agent.PrivateKeyPath), jwk.DefaultKeySize)
 			if err != nil {
 				return errors.WithStack(err)

internal/command/client/agent/spec/update.go

@@ -13,6 +13,11 @@ import (
 	jsonpatch "github.com/evanphx/json-patch/v5"
 	"github.com/pkg/errors"
 	"github.com/urfave/cli/v2"
+
+	// Import specs
+	_ "forge.cadoles.com/Cadoles/emissary/internal/spec/app"
+	_ "forge.cadoles.com/Cadoles/emissary/internal/spec/gateway"
+	_ "forge.cadoles.com/Cadoles/emissary/internal/spec/uci"
 )
 
 func UpdateCommand() *cli.Command {

internal/config/agent.go

@@ -19,6 +19,7 @@ type ControllersConfig struct {
 	Spec        SpecControllerConfig        `yaml:"spec"`
 	Gateway     GatewayControllerConfig     `yaml:"gateway"`
 	UCI         UCIControllerConfig         `yaml:"uci"`
+	App         AppControllerConfig         `yaml:"app"`
 }
 
 type PersistenceControllerConfig struct {
@@ -39,6 +40,12 @@ type UCIControllerConfig struct {
 	ConfigBackupFile InterpolatedString `yaml:"configBackupFile"`
 }
 
+type AppControllerConfig struct {
+	Enabled     InterpolatedBool   `yaml:"enabled"`
+	DataDir     InterpolatedString `yaml:"dataDir"`
+	DownloadDir InterpolatedString `yaml:"downloadDir"`
+}
+
 func NewDefaultAgentConfig() AgentConfig {
 	return AgentConfig{
 		ServerURL:              "http://127.0.0.1:3000",
@@ -60,6 +67,11 @@ func NewDefaultAgentConfig() AgentConfig {
 				ConfigBackupFile: "uci-backup.conf",
 				BinPath:          "uci",
 			},
+			App: AppControllerConfig{
+				Enabled:     true,
+				DataDir:     "apps/data",
+				DownloadDir: "apps/bundles",
+			},
 		},
 		Collectors: []ShellCollectorConfig{
 			{

internal/server/spec_api.go

@@ -10,6 +10,11 @@ import (
 	"github.com/pkg/errors"
 	"gitlab.com/wpetit/goweb/api"
 	"gitlab.com/wpetit/goweb/logger"
+
+	// Import specs
+	_ "forge.cadoles.com/Cadoles/emissary/internal/spec/app"
+	_ "forge.cadoles.com/Cadoles/emissary/internal/spec/gateway"
+	_ "forge.cadoles.com/Cadoles/emissary/internal/spec/uci"
 )
 
 const (

internal/spec/app/init.go

@@ -0,0 +1,17 @@
+package app
+
+import (
+	_ "embed"
+
+	"forge.cadoles.com/Cadoles/emissary/internal/spec"
+	"github.com/pkg/errors"
+)
+
+//go:embed schema.json
+var schema []byte
+
+func init() {
+	if err := spec.Register(NameApp, schema); err != nil {
+		panic(errors.WithStack(err))
+	}
+}

internal/spec/app/schema.json

@@ -0,0 +1,36 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://app.emissary.cadoles.com/spec.json",
+    "title": "AppSpec",
+    "description": "Emissary 'App' specification",
+    "type": "object",
+    "properties": {
+        "apps": {
+            "type": "object",
+            "patternProperties": {
+                ".*": {
+                    "type": "object",
+                    "properties": {
+                        "url": {
+                            "type": "string"
+                        },
+                        "sha256sum": {
+                            "type": "string"
+                        },
+                        "address": {
+                            "type": "string"
+                        },
+                        "format": {
+                            "type": "string",
+                            "enum": ["zip", "tar.gz"]
+                        }
+                    },
+                    "required": ["url", "sha256sum", "address", "format"],
+                    "additionalProperties": false
+                }
+            }
+        }
+    },
+    "required": ["apps"],
+    "additionalProperties": false
+}

internal/spec/app/spec.go

@@ -0,0 +1,39 @@
+package app
+
+import (
+	"forge.cadoles.com/Cadoles/emissary/internal/spec"
+)
+
+const NameApp spec.Name = "app.emissary.cadoles.com"
+
+type Spec struct {
+	Revision int `json:"revisions"`
+	Apps     map[string]AppEntry
+}
+
+type AppEntry struct {
+	URL       string `json:"url"`
+	SHA256Sum string `json:"sha256sum"`
+	Address   string `json:"address"`
+	Format    string `json:"format"`
+}
+
+func (s *Spec) SpecName() spec.Name {
+	return NameApp
+}
+
+func (s *Spec) SpecRevision() int {
+	return s.Revision
+}
+
+func (s *Spec) SpecData() map[string]any {
+	return map[string]any{
+		"apps": s.Apps,
+	}
+}
+
+func NewSpec() *Spec {
+	return &Spec{}
+}
+
+var _ spec.Spec = &Spec{}

internal/spec/app/testdata/spec-ok.json

@@ -0,0 +1,7 @@
+{
+    "name": "app.emissary.cadoles.com",
+    "data": {
+      "apps": {}
+    },
+    "revision": 0
+}

internal/spec/app/validator_test.go

@@ -0,0 +1,65 @@
+package app
+
+import (
+	"context"
+	"encoding/json"
+	"io/ioutil"
+	"testing"
+
+	"forge.cadoles.com/Cadoles/emissary/internal/spec"
+	"github.com/pkg/errors"
+)
+
+type validatorTestCase struct {
+	Name       string
+	Source     string
+	ShouldFail bool
+}
+
+var validatorTestCases = []validatorTestCase{
+	{
+		Name:       "SpecOK",
+		Source:     "testdata/spec-ok.json",
+		ShouldFail: false,
+	},
+}
+
+func TestValidator(t *testing.T) {
+	t.Parallel()
+
+	validator := spec.NewValidator()
+	if err := validator.Register(NameApp, schema); err != nil {
+		t.Fatalf("+%v", errors.WithStack(err))
+	}
+
+	for _, tc := range validatorTestCases {
+		func(tc validatorTestCase) {
+			t.Run(tc.Name, func(t *testing.T) {
+				t.Parallel()
+
+				rawSpec, err := ioutil.ReadFile(tc.Source)
+				if err != nil {
+					t.Fatalf("+%v", errors.WithStack(err))
+				}
+
+				var spec spec.RawSpec
+
+				if err := json.Unmarshal(rawSpec, &spec); err != nil {
+					t.Fatalf("+%v", errors.WithStack(err))
+				}
+
+				ctx := context.Background()
+
+				err = validator.Validate(ctx, &spec)
+
+				if !tc.ShouldFail && err != nil {
+					t.Errorf("+%v", errors.WithStack(err))
+				}
+
+				if tc.ShouldFail && err == nil {
+					t.Error("validation should have failed")
+				}
+			})
+		}(tc)
+	}
+}

internal/spec/gateway/spec.go

@@ -24,10 +24,10 @@ func (s *Spec) SpecRevision() int {
 	return s.Revision
 }
 
-func (s *Spec) SpecData() any {
-	return struct {
-		Gateways map[ID]GatewayEntry
-	}{Gateways: s.Gateways}
+func (s *Spec) SpecData() map[string]any {
+	return map[string]any{
+		"gateways": s.Gateways,
+	}
 }
 
 func NewSpec() *Spec {
@@ -35,3 +35,5 @@ func NewSpec() *Spec {
 		Gateways: make(map[ID]GatewayEntry),
 	}
 }
+
+var _ spec.Spec = &Spec{}

internal/spec/spec.go

@@ -1,17 +1,15 @@
 package spec
 
-import "forge.cadoles.com/Cadoles/emissary/internal/agent/metadata"
-
 type Spec interface {
 	SpecName() Name
 	SpecRevision() int
-	SpecData() metadata.Metadata
+	SpecData() map[string]any
 }
 
 type RawSpec struct {
-	Name     Name              `json:"name"`
-	Revision int               `json:"revision"`
-	Data     metadata.Metadata `json:"data"`
+	Name     Name           `json:"name"`
+	Revision int            `json:"revision"`
+	Data     map[string]any `json:"data"`
 }
 
 func (s *RawSpec) SpecName() Name {
@@ -22,6 +20,8 @@ func (s *RawSpec) SpecRevision() int {
 	return s.Revision
 }
 
-func (s *RawSpec) SpecData() metadata.Metadata {
+func (s *RawSpec) SpecData() map[string]any {
 	return s.Data
 }
+
+var _ Spec = &RawSpec{}

internal/spec/uci/spec.go

@@ -26,11 +26,11 @@ func (s *Spec) SpecRevision() int {
 	return s.Revision
 }
 
-func (s *Spec) SpecData() any {
-	return struct {
-		Config             *uci.UCI                `json:"config"`
-		PostImportCommands []*UCIPostImportCommand `json:"postImportCommands"`
-	}{Config: s.Config, PostImportCommands: s.PostImportCommands}
+func (s *Spec) SpecData() map[string]any {
+	return map[string]any{
+		"config":             s.Config,
+		"postImportCommands": s.PostImportCommands,
+	}
 }
 
 func NewSpec() *Spec {
@@ -38,3 +38,5 @@ func NewSpec() *Spec {
 		PostImportCommands: make([]*UCIPostImportCommand, 0),
 	}
 }
+
+var _ spec.Spec = &Spec{}