Janady13/missionmatch / internal/modules/termalias/termalias.go

1// Package termalias is the admin surface for the acronym and term expansion layer: list the 2// global GovCon seed plus the tenant's own additions, add a tenant term, remove a tenant term. 3// The RLS policies on term_expansions make the global seed read only to every tenant: an insert or 4// delete can only ever touch rows carrying the caller's own organization id. 5package termalias 6 7import ( 8 "context" 9 "encoding/json" 10 "errors" 11 "fmt" 12 "io" 13 "net/http" 14 "strings" 15 "time" 16 17 "github.com/go-chi/chi/v5" 18 "github.com/google/uuid" 19 "github.com/jackc/pgx/v5" 20 21 "github.com/missionworkforce/missionmatch/internal/platform/security" 22 "github.com/missionworkforce/missionmatch/internal/platform/tenant" 23) 24 25var ( 26 ErrBadRequest = errors.New("termalias: bad request") 27 ErrNoDatabase = errors.New("termalias: no database configured") 28 ErrNotFound = errors.New("termalias: not found") 29) 30 31type Service struct { 32 db *tenant.DB 33} 34 35func NewService(db *tenant.DB) *Service { return &Service{db: db} } 36 37// TermView is one alias row. Global seed rows carry global true and cannot be deleted by a tenant. 38type TermView struct { 39 ID uuid.UUID `json:"id"` 40 Alias string `json:"alias"` 41 Expansion string `json:"expansion"` 42 Global bool `json:"global"` 43 CreatedAt time.Time `json:"createdAt"` 44} 45 46func (s *Service) List(ctx context.Context) ([]TermView, error) { 47 if s.db == nil { 48 return nil, ErrNoDatabase 49 } 50 out := []TermView{} 51 err := s.db.RunInTenantTx(ctx, func(ctx context.Context, tx pgx.Tx) error { 52 rows, err := tx.Query(ctx, ` 53 SELECT id, alias, expansion, organization_id IS NULL, created_at 54 FROM term_expansions 55 ORDER BY organization_id NULLS FIRST, lower(alias), lower(expansion)`) 56 if err != nil { 57 return err 58 } 59 defer rows.Close() 60 for rows.Next() { 61 var v TermView 62 if err := rows.Scan(&v.ID, &v.Alias, &v.Expansion, &v.Global, &v.CreatedAt); err != nil { 63 return err 64 } 65 out = append(out, v) 66 } 67 return rows.Err() 68 }) 69 return out, err 70} 71 72func (s *Service) Add(ctx context.Context, alias, expansion string) (TermView, error) { 73 if s.db == nil { 74 return TermView{}, ErrNoDatabase 75 } 76 alias, expansion = strings.TrimSpace(alias), strings.TrimSpace(expansion) 77 if alias == "" || len(alias) > 80 || len(expansion) < 2 || len(expansion) > 200 { 78 return TermView{}, fmt.Errorf("%w: alias must be 1 to 80 characters and expansion 2 to 200", ErrBadRequest) 79 } 80 var actor *uuid.UUID 81 if p, ok := tenant.UserFromContext(ctx); ok { 82 if id, err := uuid.Parse(p.UserID); err == nil { 83 actor = &id 84 } 85 } 86 var out TermView 87 err := s.db.RunInTenantTx(ctx, func(ctx context.Context, tx pgx.Tx) error { 88 return tx.QueryRow(ctx, ` 89 INSERT INTO term_expansions (organization_id, alias, expansion, created_by) 90 VALUES (NULLIF(current_setting('app.current_org_id', true), '')::uuid, $1, $2, $3) 91 ON CONFLICT DO NOTHING 92 RETURNING id, alias, expansion, false, created_at`, 93 alias, expansion, actor, 94 ).Scan(&out.ID, &out.Alias, &out.Expansion, &out.Global, &out.CreatedAt) 95 }) 96 if errors.Is(err, pgx.ErrNoRows) { 97 return TermView{}, fmt.Errorf("%w: that alias and expansion pair already exists", ErrBadRequest) 98 } 99 return out, err 100} 101 102func (s *Service) Delete(ctx context.Context, id uuid.UUID) error { 103 if s.db == nil { 104 return ErrNoDatabase 105 } 106 return s.db.RunInTenantTx(ctx, func(ctx context.Context, tx pgx.Tx) error { 107 // RLS: the delete policy reaches only the caller org's rows, so a global seed id (or another 108 // tenant's id) deletes zero rows and reports not found, never touching the row. 109 tag, err := tx.Exec(ctx, `DELETE FROM term_expansions WHERE id = $1`, id) 110 if err != nil { 111 return err 112 } 113 if tag.RowsAffected() == 0 { 114 return ErrNotFound 115 } 116 return nil 117 }) 118} 119 120// ---------- HTTP ---------- 121 122type Handler struct { 123 svc *Service 124} 125 126func NewHandler(svc *Service) *Handler { return &Handler{svc: svc} } 127 128// Routes: reading the table is open to anyone who can run a screen (the expansions explain 129// matches); adding and removing tenant terms is an org settings write, the admin gate. 130func (h *Handler) Routes(r chi.Router) { 131 r.With(security.RequireCapability(security.CapSearchRun)).Get("/aliases", h.list) 132 r.With(security.RequireCapability(security.CapOrgSettings)).Post("/aliases", h.add) 133 r.With(security.RequireCapability(security.CapOrgSettings)).Delete("/aliases/{id}", h.remove) 134} 135 136func (h *Handler) list(w http.ResponseWriter, r *http.Request) { 137 out, err := h.svc.List(r.Context()) 138 if err != nil { 139 h.err(w, err) 140 return 141 } 142 h.json(w, http.StatusOK, map[string]any{"terms": out}) 143} 144 145func (h *Handler) add(w http.ResponseWriter, r *http.Request) { 146 var req struct { 147 Alias string `json:"alias"` 148 Expansion string `json:"expansion"` 149 } 150 if err := json.NewDecoder(io.LimitReader(r.Body, 8*1024)).Decode(&req); err != nil { 151 h.json(w, http.StatusBadRequest, map[string]string{"error": "invalid json body"}) 152 return 153 } 154 out, err := h.svc.Add(r.Context(), req.Alias, req.Expansion) 155 if err != nil { 156 h.err(w, err) 157 return 158 } 159 h.json(w, http.StatusCreated, out) 160} 161 162func (h *Handler) remove(w http.ResponseWriter, r *http.Request) { 163 id, err := uuid.Parse(chi.URLParam(r, "id")) 164 if err != nil { 165 h.json(w, http.StatusBadRequest, map[string]string{"error": "invalid id"}) 166 return 167 } 168 if err := h.svc.Delete(r.Context(), id); err != nil { 169 h.err(w, err) 170 return 171 } 172 w.WriteHeader(http.StatusNoContent) 173} 174 175func (h *Handler) err(w http.ResponseWriter, err error) { 176 switch { 177 case errors.Is(err, ErrBadRequest): 178 h.json(w, http.StatusBadRequest, map[string]string{"error": err.Error()}) 179 case errors.Is(err, ErrNotFound): 180 h.json(w, http.StatusNotFound, map[string]string{"error": "no such tenant term (the global seed cannot be removed)"}) 181 case errors.Is(err, ErrNoDatabase): 182 h.json(w, http.StatusServiceUnavailable, map[string]string{"error": "no database configured"}) 183 default: 184 h.json(w, http.StatusInternalServerError, map[string]string{"error": "internal error"}) 185 } 186} 187 188func (h *Handler) json(w http.ResponseWriter, status int, v any) { 189 w.Header().Set("Content-Type", "application/json") 190 w.WriteHeader(status) 191 _ = json.NewEncoder(w).Encode(v) 192} 193