Merge branch 'main' into mjp/data

Author: mattjohnsonpint

datasource_test.go

@@ -18,7 +18,8 @@ import (
 	"time"
 
 	"hmruntime/config"
-	"hmruntime/server"
+	"hmruntime/httpserver"
+	"hmruntime/services"
 
 	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/api/types/image"
@@ -100,14 +101,14 @@ func TestMain(m *testing.M) {
 	config.Port = httpListenPort
 
 	// setup runtime services
-	initRuntimeServices(context.Background())
-	defer stopRuntimeServices(context.Background())
+	services.Start(context.Background())
+	defer services.Stop(context.Background())
 
 	// start HTTP server
 	ctx, stop := context.WithCancel(context.Background())
 	done := make(chan struct{})
 	go func() {
-		server.Start(ctx, true)
+		httpserver.Start(ctx, true)
 		close(done)
 	}()
 

server/admin.go renamed to httpserver/admin.go

@@ -2,7 +2,7 @@
  * Copyright 2024 Hypermode, Inc.
  */
 
-package server
+package httpserver
 
 import (
 	"encoding/json"

server/server.go renamed to httpserver/server.go

@@ -2,7 +2,7 @@
  * Copyright 2024 Hypermode, Inc.
  */
 
-package server
+package httpserver
 
 import (
 	"context"

main.go

@@ -13,20 +13,11 @@ import (
 	"path/filepath"
 	"runtime"
 
-	"hmruntime/aws"
-	"hmruntime/collections"
 	"hmruntime/config"
-	"hmruntime/db"
-	"hmruntime/graphql"
-	"hmruntime/hostfunctions"
+	"hmruntime/httpserver"
 	"hmruntime/logger"
-	"hmruntime/manifestdata"
-	"hmruntime/pluginmanager"
-	"hmruntime/secrets"
-	"hmruntime/server"
-	"hmruntime/storage"
+	"hmruntime/services"
 	"hmruntime/utils"
-	"hmruntime/wasmhost"
 
 	"github.com/joho/godotenv"
 )
@@ -54,64 +45,19 @@ func main() {
 	utils.InitSentry(rootSourcePath)
 	defer utils.FlushSentryEvents()
 
-	// Initialize the runtime services
+	// Create the main background context
 	ctx := context.Background()
-	initRuntimeServices(ctx)
-	defer stopRuntimeServices(ctx)
+
+	// Start the runtime services
+	services.Start(ctx)
+	defer services.Stop(ctx)
 
 	// Set local mode if debugging is enabled
 	local := utils.HypermodeDebugEnabled()
 
 	// Start the HTTP server to listen for requests.
 	// Note, this function blocks, and handles shutdown gracefully.
-	server.Start(ctx, local)
-}
-
-func initRuntimeServices(ctx context.Context) {
-	transaction, ctx := utils.NewSentryTransactionForCurrentFunc(ctx)
-	defer transaction.Finish()
-
-	// Initialize the WebAssembly runtime
-	wasmhost.InitWasmHost(ctx)
-
-	// Register the host functions with the runtime
-	hostfunctions.RegisterHostFunctions(ctx)
-
-	// Initialize AWS functionality
-	aws.Initialize(ctx)
-
-	// Initialize the secrets provider
-	secrets.Initialize(ctx)
-
-	// Initialize the storage provider
-	storage.Initialize(ctx)
-
-	// Initialize the metadata database
-	db.Initialize(ctx)
-
-	// Initialize in mem vector factory
-	collections.InitializeIndexFactory(ctx)
-
-	// Load app data and monitor for changes
-	onChange := func([]error) {
-		hostfunctions.ShutdownPools()
-	}
-	manifestdata.MonitorManifestFile(ctx, onChange)
-
-	// Load plugins and monitor for changes
-	pluginmanager.MonitorPlugins(ctx)
-
-	// Initialize the GraphQL engine
-	graphql.Initialize()
-}
-
-func stopRuntimeServices(ctx context.Context) {
-	collections.CloseIndexFactory(ctx)
-	wasmhost.RuntimeInstance.Close(ctx)
-	logger.Close()
-
-	db.Stop()
-	hostfunctions.ShutdownPools()
+	httpserver.Start(ctx, local)
 }
 
 func getRootSourcePath() string {

metrics/metrics_test.go

@@ -14,7 +14,7 @@ import (
 	"testing"
 
 	"hmruntime/config"
-	"hmruntime/server"
+	"hmruntime/httpserver"
 
 	"github.com/prometheus/common/expfmt"
 )
@@ -64,7 +64,7 @@ func TestRuntimeMetrics(t *testing.T) {
 
 	setupRuntime()
 
-	mux := server.GetHandlerMux()
+	mux := httpserver.GetHandlerMux()
 	s := httptest.NewServer(mux)
 	defer s.Close()
 

services/services.go

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2024 Hypermode, Inc.
+ */
+
+package services
+
+import (
+	"context"
+
+	"hmruntime/aws"
+	"hmruntime/collections"
+	"hmruntime/db"
+	"hmruntime/graphql"
+	"hmruntime/hostfunctions"
+	"hmruntime/logger"
+	"hmruntime/manifestdata"
+	"hmruntime/pluginmanager"
+	"hmruntime/secrets"
+	"hmruntime/storage"
+	"hmruntime/utils"
+	"hmruntime/wasmhost"
+)
+
+// Starts any services that need to be started when the runtime starts.
+func Start(ctx context.Context) {
+	transaction, ctx := utils.NewSentryTransactionForCurrentFunc(ctx)
+	defer transaction.Finish()
+
+	// None of these should block. If they need to do background work, they should start a goroutine internally.
+
+	// NOTE: Initialization order is important in some cases.
+	// If you need to change the order or add new services, be sure to test thoroughly.
+	// Generally, new services should be added to the end of the list, unless there is a specific reason to do otherwise.
+
+	wasmhost.InitWasmHost(ctx)
+	hostfunctions.RegisterHostFunctions(ctx)
+	aws.Initialize(ctx)
+	secrets.Initialize(ctx)
+	storage.Initialize(ctx)
+	db.Initialize(ctx)
+	collections.InitializeIndexFactory(ctx)
+	manifestdata.MonitorManifestFile(ctx, func([]error) { hostfunctions.ShutdownPools() })
+	pluginmanager.MonitorPlugins(ctx)
+	graphql.Initialize()
+}
+
+// Stops any services that need to be stopped when the runtime stops.
+func Stop(ctx context.Context) {
+
+	// NOTE: Stopping services also has an order dependency.
+	// If you need to change the order or add new services, be sure to test thoroughly.
+
+	// Unlike start, these should each block until they are fully stopped.
+
+	collections.CloseIndexFactory(ctx)
+	wasmhost.RuntimeInstance.Close(ctx)
+	logger.Close()
+
+	db.Stop()
+	hostfunctions.ShutdownPools()
+}