refactor(webui): extract the extensions resource module (#1778)
This commit is contained in:
2 files changed
+74
-57
No files matched your search
@@ -4,6 +4,7 @@ import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"log/slog"
|
||||
"net/http"
|
||||
"slices"
|
||||
"strings"
|
||||
@@ -13,6 +14,32 @@ import (
|
||||
"github.com/samcharles93/archie-core/internal/infrastructure/controlplanerpc"
|
||||
)
|
||||
|
||||
// extensionsAPI owns the /api/extensions routes. Handlers answer 503 until
|
||||
// both the package surface and the control plane are wired.
|
||||
type extensionsAPI struct {
|
||||
packages storepkg.Installations
|
||||
controlPlane controlpb.ControlPlaneServiceClient
|
||||
log *slog.Logger
|
||||
}
|
||||
|
||||
func newExtensionsAPI(s *Server) *extensionsAPI {
|
||||
return &extensionsAPI{packages: s.Packages, controlPlane: s.ControlPlane, log: s.Log}
|
||||
}
|
||||
|
||||
func (a *extensionsAPI) register(mux *http.ServeMux) {
|
||||
mux.HandleFunc("GET /api/extensions", a.handleExtensions)
|
||||
mux.HandleFunc("POST /api/extensions", a.handleExtensionInstall)
|
||||
mux.HandleFunc("GET /api/extensions/catalogue", a.handleCatalogue)
|
||||
mux.HandleFunc("POST /api/extensions/catalogue/{name}/install", a.handleCatalogueInstall)
|
||||
mux.HandleFunc("POST /api/extensions/{name}/accept", a.handleExtensionAccept)
|
||||
mux.HandleFunc("POST /api/extensions/{name}/update", a.handleExtensionUpdate)
|
||||
mux.HandleFunc("POST /api/extensions/{name}/approve-update", a.handleExtensionApproveUpdate)
|
||||
mux.HandleFunc("POST /api/extensions/{name}/rollback", a.handleExtensionRollback)
|
||||
mux.HandleFunc("PUT /api/extensions/{name}/update-policy", a.handleExtensionUpdatePolicy)
|
||||
mux.HandleFunc("PUT /api/extensions/{name}/enabled", a.handleExtensionEnabled)
|
||||
mux.HandleFunc("DELETE /api/extensions/{name}", a.handleExtensionRemove)
|
||||
}
|
||||
|
||||
type authorityView struct {
|
||||
CredentialServices []string `json:"credential_services"`
|
||||
EgressHosts []string `json:"egress_hosts"`
|
||||
@@ -107,9 +134,9 @@ func extensionView(p storepkg.Installed, enabled bool) ExtensionView {
|
||||
|
||||
// extensionSettings reads the extension-settings resource and the version a
|
||||
// replacement must name.
|
||||
func (s *Server) extensionSettings(ctx context.Context) (controlplanerpc.ExtensionSettings, int64, error) {
|
||||
func (a *extensionsAPI) extensionSettings(ctx context.Context) (controlplanerpc.ExtensionSettings, int64, error) {
|
||||
var doc controlplanerpc.ExtensionSettings
|
||||
response, err := s.ControlPlane.Query(ctx, &controlpb.QueryRequest{Kind: controlplanerpc.ExtensionSettingsKind})
|
||||
response, err := a.controlPlane.Query(ctx, &controlpb.QueryRequest{Kind: controlplanerpc.ExtensionSettingsKind})
|
||||
if err != nil {
|
||||
return doc, 0, err
|
||||
}
|
||||
@@ -123,7 +150,7 @@ func (s *Server) extensionSettings(ctx context.Context) (controlplanerpc.Extensi
|
||||
}
|
||||
|
||||
// putExtensionSettings replaces the extension-settings resource at version.
|
||||
func (s *Server) putExtensionSettings(ctx context.Context, doc controlplanerpc.ExtensionSettings, version int64) error {
|
||||
func (a *extensionsAPI) putExtensionSettings(ctx context.Context, doc controlplanerpc.ExtensionSettings, version int64) error {
|
||||
value, err := json.Marshal(doc)
|
||||
if err != nil {
|
||||
return err
|
||||
@@ -132,7 +159,7 @@ func (s *Server) putExtensionSettings(ctx context.Context, doc controlplanerpc.E
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
_, err = s.ControlPlane.Command(ctx, &controlpb.CommandRequest{
|
||||
_, err = a.controlPlane.Command(ctx, &controlpb.CommandRequest{
|
||||
Kind: controlplanerpc.ExtensionSettingsKind, Command: "replace", ValueJson: value,
|
||||
ExpectedVersion: version, Actor: string(audit.ActorID), Source: audit.Source, RequestId: audit.RequestID,
|
||||
})
|
||||
@@ -161,8 +188,8 @@ func withExtension(doc controlplanerpc.ExtensionSettings, name string, enabled *
|
||||
return next
|
||||
}
|
||||
|
||||
func (s *Server) extensionsReady(w http.ResponseWriter) bool {
|
||||
if s.Packages == nil || s.ControlPlane == nil {
|
||||
func (a *extensionsAPI) extensionsReady(w http.ResponseWriter) bool {
|
||||
if a.packages == nil || a.controlPlane == nil {
|
||||
http.Error(w, "extensions unavailable", http.StatusServiceUnavailable)
|
||||
return false
|
||||
}
|
||||
@@ -186,16 +213,16 @@ func writePackageError(w http.ResponseWriter, err error) {
|
||||
|
||||
// handleExtensions lists the installed packages with their authority and
|
||||
// enabled state.
|
||||
func (s *Server) handleExtensions(w http.ResponseWriter, r *http.Request) {
|
||||
if !s.extensionsReady(w) {
|
||||
func (a *extensionsAPI) handleExtensions(w http.ResponseWriter, r *http.Request) {
|
||||
if !a.extensionsReady(w) {
|
||||
return
|
||||
}
|
||||
installed, err := s.Packages.ListInstalled(r.Context())
|
||||
installed, err := a.packages.ListInstalled(r.Context())
|
||||
if err != nil {
|
||||
writePackageError(w, err)
|
||||
return
|
||||
}
|
||||
doc, _, err := s.extensionSettings(r.Context())
|
||||
doc, _, err := a.extensionSettings(r.Context())
|
||||
if err != nil {
|
||||
writeControlPlaneError(w, err)
|
||||
return
|
||||
@@ -219,15 +246,15 @@ type installExtensionRequest struct {
|
||||
|
||||
// handleExtensionInstall installs a digest-pinned package. It does not enable
|
||||
// it and does not accept its authority: both are separate operator actions.
|
||||
func (s *Server) handleExtensionInstall(w http.ResponseWriter, r *http.Request) {
|
||||
if !s.extensionsReady(w) {
|
||||
func (a *extensionsAPI) handleExtensionInstall(w http.ResponseWriter, r *http.Request) {
|
||||
if !a.extensionsReady(w) {
|
||||
return
|
||||
}
|
||||
request, ok := decodeBody[installExtensionRequest](w, r)
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
p, err := s.Packages.InstallPackage(r.Context(),
|
||||
p, err := a.packages.InstallPackage(r.Context(),
|
||||
strings.TrimSpace(request.Name), strings.TrimSpace(request.Reference), strings.TrimSpace(request.Digest))
|
||||
if err != nil {
|
||||
writePackageError(w, err)
|
||||
@@ -238,17 +265,17 @@ func (s *Server) handleExtensionInstall(w http.ResponseWriter, r *http.Request)
|
||||
|
||||
// handleExtensionAccept records the operator's acceptance of exactly the
|
||||
// authority the package declares.
|
||||
func (s *Server) handleExtensionAccept(w http.ResponseWriter, r *http.Request) {
|
||||
if !s.extensionsReady(w) {
|
||||
func (a *extensionsAPI) handleExtensionAccept(w http.ResponseWriter, r *http.Request) {
|
||||
if !a.extensionsReady(w) {
|
||||
return
|
||||
}
|
||||
name := r.PathValue("name")
|
||||
installed, err := s.Packages.GetInstalled(r.Context(), name)
|
||||
installed, err := a.packages.GetInstalled(r.Context(), name)
|
||||
if err != nil {
|
||||
writePackageError(w, err)
|
||||
return
|
||||
}
|
||||
p, err := s.Packages.AcceptPackageAuthority(r.Context(), name, installed.Descriptor.Authority)
|
||||
p, err := a.packages.AcceptPackageAuthority(r.Context(), name, installed.Descriptor.Authority)
|
||||
if err != nil {
|
||||
writePackageError(w, err)
|
||||
return
|
||||
@@ -258,20 +285,20 @@ func (s *Server) handleExtensionAccept(w http.ResponseWriter, r *http.Request) {
|
||||
|
||||
// handleExtensionUpdate moves a package to the catalogue's digest: an update
|
||||
// that adds no authority applies, one that does waits as pending.
|
||||
func (s *Server) handleExtensionUpdate(w http.ResponseWriter, r *http.Request) {
|
||||
s.packageTransition(w, r, s.Packages.UpdatePackage)
|
||||
func (a *extensionsAPI) handleExtensionUpdate(w http.ResponseWriter, r *http.Request) {
|
||||
a.packageTransition(w, r, a.packages.UpdatePackage)
|
||||
}
|
||||
|
||||
// handleExtensionApproveUpdate applies the pending update and accepts the
|
||||
// authority it declares.
|
||||
func (s *Server) handleExtensionApproveUpdate(w http.ResponseWriter, r *http.Request) {
|
||||
s.packageTransition(w, r, s.Packages.ApprovePackageUpdate)
|
||||
func (a *extensionsAPI) handleExtensionApproveUpdate(w http.ResponseWriter, r *http.Request) {
|
||||
a.packageTransition(w, r, a.packages.ApprovePackageUpdate)
|
||||
}
|
||||
|
||||
// handleExtensionRollback restores the previous digest and its accepted
|
||||
// authority.
|
||||
func (s *Server) handleExtensionRollback(w http.ResponseWriter, r *http.Request) {
|
||||
s.packageTransition(w, r, s.Packages.RollbackPackage)
|
||||
func (a *extensionsAPI) handleExtensionRollback(w http.ResponseWriter, r *http.Request) {
|
||||
a.packageTransition(w, r, a.packages.RollbackPackage)
|
||||
}
|
||||
|
||||
type updatePolicyRequest struct {
|
||||
@@ -280,15 +307,15 @@ type updatePolicyRequest struct {
|
||||
|
||||
// handleExtensionUpdatePolicy sets whether the State Store updates a package
|
||||
// on its own.
|
||||
func (s *Server) handleExtensionUpdatePolicy(w http.ResponseWriter, r *http.Request) {
|
||||
if !s.extensionsReady(w) {
|
||||
func (a *extensionsAPI) handleExtensionUpdatePolicy(w http.ResponseWriter, r *http.Request) {
|
||||
if !a.extensionsReady(w) {
|
||||
return
|
||||
}
|
||||
request, ok := decodeBody[updatePolicyRequest](w, r)
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
p, err := s.Packages.SetPackageUpdatePolicy(r.Context(), r.PathValue("name"), request.Policy)
|
||||
p, err := a.packages.SetPackageUpdatePolicy(r.Context(), r.PathValue("name"), request.Policy)
|
||||
if err != nil {
|
||||
writePackageError(w, err)
|
||||
return
|
||||
@@ -296,8 +323,8 @@ func (s *Server) handleExtensionUpdatePolicy(w http.ResponseWriter, r *http.Requ
|
||||
writeJSON(w, extensionView(p, false))
|
||||
}
|
||||
|
||||
func (s *Server) packageTransition(w http.ResponseWriter, r *http.Request, do func(context.Context, string) (storepkg.Installed, error)) {
|
||||
if !s.extensionsReady(w) {
|
||||
func (a *extensionsAPI) packageTransition(w http.ResponseWriter, r *http.Request, do func(context.Context, string) (storepkg.Installed, error)) {
|
||||
if !a.extensionsReady(w) {
|
||||
return
|
||||
}
|
||||
p, err := do(r.Context(), r.PathValue("name"))
|
||||
@@ -313,8 +340,8 @@ type extensionEnabledRequest struct {
|
||||
}
|
||||
|
||||
// handleExtensionEnabled enables or disables an installed extension.
|
||||
func (s *Server) handleExtensionEnabled(w http.ResponseWriter, r *http.Request) {
|
||||
if !s.extensionsReady(w) {
|
||||
func (a *extensionsAPI) handleExtensionEnabled(w http.ResponseWriter, r *http.Request) {
|
||||
if !a.extensionsReady(w) {
|
||||
return
|
||||
}
|
||||
request, ok := decodeBody[extensionEnabledRequest](w, r)
|
||||
@@ -322,16 +349,16 @@ func (s *Server) handleExtensionEnabled(w http.ResponseWriter, r *http.Request)
|
||||
return
|
||||
}
|
||||
name := r.PathValue("name")
|
||||
if _, err := s.Packages.GetInstalled(r.Context(), name); err != nil {
|
||||
if _, err := a.packages.GetInstalled(r.Context(), name); err != nil {
|
||||
writePackageError(w, err)
|
||||
return
|
||||
}
|
||||
doc, version, err := s.extensionSettings(r.Context())
|
||||
doc, version, err := a.extensionSettings(r.Context())
|
||||
if err != nil {
|
||||
writeControlPlaneError(w, err)
|
||||
return
|
||||
}
|
||||
if err := s.putExtensionSettings(r.Context(), withExtension(doc, name, &request.Enabled), version); err != nil {
|
||||
if err := a.putExtensionSettings(r.Context(), withExtension(doc, name, &request.Enabled), version); err != nil {
|
||||
writeControlPlaneError(w, err)
|
||||
return
|
||||
}
|
||||
@@ -340,18 +367,18 @@ func (s *Server) handleExtensionEnabled(w http.ResponseWriter, r *http.Request)
|
||||
|
||||
// handleExtensionRemove uninstalls an extension and drops its setting, so a
|
||||
// later reinstall does not start enabled.
|
||||
func (s *Server) handleExtensionRemove(w http.ResponseWriter, r *http.Request) {
|
||||
if !s.extensionsReady(w) {
|
||||
func (a *extensionsAPI) handleExtensionRemove(w http.ResponseWriter, r *http.Request) {
|
||||
if !a.extensionsReady(w) {
|
||||
return
|
||||
}
|
||||
name := r.PathValue("name")
|
||||
if err := s.Packages.RemoveInstalled(r.Context(), name); err != nil {
|
||||
if err := a.packages.RemoveInstalled(r.Context(), name); err != nil {
|
||||
writePackageError(w, err)
|
||||
return
|
||||
}
|
||||
if doc, version, err := s.extensionSettings(r.Context()); err == nil {
|
||||
if err := s.putExtensionSettings(r.Context(), withExtension(doc, name, nil), version); err != nil {
|
||||
s.Log.WarnContext(r.Context(), "drop extension setting", "name", name, "err", err)
|
||||
if doc, version, err := a.extensionSettings(r.Context()); err == nil {
|
||||
if err := a.putExtensionSettings(r.Context(), withExtension(doc, name, nil), version); err != nil {
|
||||
a.log.WarnContext(r.Context(), "drop extension setting", "name", name, "err", err)
|
||||
}
|
||||
}
|
||||
writeJSON(w, map[string]any{"name": name, "removed": true})
|
||||
@@ -365,16 +392,16 @@ type catalogueView struct {
|
||||
}
|
||||
|
||||
// handleCatalogue lists the packages the verified catalogue offers.
|
||||
func (s *Server) handleCatalogue(w http.ResponseWriter, r *http.Request) {
|
||||
if !s.extensionsReady(w) {
|
||||
func (a *extensionsAPI) handleCatalogue(w http.ResponseWriter, r *http.Request) {
|
||||
if !a.extensionsReady(w) {
|
||||
return
|
||||
}
|
||||
catalogue, err := s.Packages.ListCatalogue(r.Context())
|
||||
catalogue, err := a.packages.ListCatalogue(r.Context())
|
||||
if err != nil {
|
||||
http.Error(w, "catalogue unavailable: "+err.Error(), http.StatusBadGateway)
|
||||
return
|
||||
}
|
||||
installed, err := s.Packages.ListInstalled(r.Context())
|
||||
installed, err := a.packages.ListInstalled(r.Context())
|
||||
if err != nil {
|
||||
writePackageError(w, err)
|
||||
return
|
||||
@@ -392,11 +419,11 @@ func (s *Server) handleCatalogue(w http.ResponseWriter, r *http.Request) {
|
||||
|
||||
// handleCatalogueInstall installs one catalogue package by name, at the digest
|
||||
// the verified catalogue pins.
|
||||
func (s *Server) handleCatalogueInstall(w http.ResponseWriter, r *http.Request) {
|
||||
if !s.extensionsReady(w) {
|
||||
func (a *extensionsAPI) handleCatalogueInstall(w http.ResponseWriter, r *http.Request) {
|
||||
if !a.extensionsReady(w) {
|
||||
return
|
||||
}
|
||||
p, err := s.Packages.InstallFromCatalogue(r.Context(), r.PathValue("name"))
|
||||
p, err := a.packages.InstallFromCatalogue(r.Context(), r.PathValue("name"))
|
||||
if err != nil {
|
||||
writePackageError(w, err)
|
||||
return
|
||||
@@ -356,17 +356,7 @@ func (s *Server) registerHarnessRoutes(mux *http.ServeMux) {
|
||||
}
|
||||
|
||||
func (s *Server) registerConfigAndLogRoutes(mux *http.ServeMux) {
|
||||
mux.HandleFunc("GET /api/extensions", s.handleExtensions)
|
||||
mux.HandleFunc("POST /api/extensions", s.handleExtensionInstall)
|
||||
mux.HandleFunc("GET /api/extensions/catalogue", s.handleCatalogue)
|
||||
mux.HandleFunc("POST /api/extensions/catalogue/{name}/install", s.handleCatalogueInstall)
|
||||
mux.HandleFunc("POST /api/extensions/{name}/accept", s.handleExtensionAccept)
|
||||
mux.HandleFunc("POST /api/extensions/{name}/update", s.handleExtensionUpdate)
|
||||
mux.HandleFunc("POST /api/extensions/{name}/approve-update", s.handleExtensionApproveUpdate)
|
||||
mux.HandleFunc("POST /api/extensions/{name}/rollback", s.handleExtensionRollback)
|
||||
mux.HandleFunc("PUT /api/extensions/{name}/update-policy", s.handleExtensionUpdatePolicy)
|
||||
mux.HandleFunc("PUT /api/extensions/{name}/enabled", s.handleExtensionEnabled)
|
||||
mux.HandleFunc("DELETE /api/extensions/{name}", s.handleExtensionRemove)
|
||||
newExtensionsAPI(s).register(mux)
|
||||
mux.HandleFunc("GET /api/control-plane/catalog", s.handleControlPlaneCatalog)
|
||||
mux.HandleFunc("GET /api/control-plane/apply-status", instanceOnly(s.handleApplyStatus))
|
||||
mux.HandleFunc("GET /api/services", instanceOnly(s.handleServices))
|
||||
|
||||
Reference in new issue
Block a user