uik: save most recent request to universal integration key

expflag/flags.go

@@ -7,11 +7,13 @@ type Flag string
 const (
 	Example  Flag = "example"
 	UnivKeys Flag = "univ-keys"
+	UikLogs  Flag = "uik-logs"
 )
 
 var desc = map[Flag]string{
 	Example:  "An example experimental flag to demonstrate usage.",
 	UnivKeys: "Universal integration key support.",
+	UikLogs:  "Logs support for universal integration keys.",
 }
 
 // AllFlags returns a slice of all experimental flags sorted by name.

integrationkey/queries.sql

@@ -48,6 +48,27 @@ WHERE
     id = $1
 FOR UPDATE;
 
+-- name: IntKeyLog :exec
+INSERT INTO uik_logs (
+    integration_key_id,
+    content_type,
+    user_agent,
+    raw_body,
+    status,
+    error_message,
+    received_at
+) VALUES (
+    $1, $2, $3, $4, $5, $6, $7
+)
+ON CONFLICT (integration_key_id) DO UPDATE
+SET
+    content_type = EXCLUDED.content_type,
+    user_agent = EXCLUDED.user_agent,
+    raw_body = EXCLUDED.raw_body,
+    status = EXCLUDED.status,
+    error_message = EXCLUDED.error_message,
+    received_at = EXCLUDED.received_at;
+
 -- name: IntKeySetConfig :exec
 INSERT INTO uik_config(id, config)
     VALUES ($1, $2)

integrationkey/uik/handler.go

@@ -8,6 +8,7 @@ import (
 	"io"
 	"net/http"
 	"strings"
+	"unicode/utf8"
 
 	"github.com/expr-lang/expr/vm"
 	"github.com/google/uuid"
@@ -33,6 +34,13 @@ type TxAble interface {
 	BeginTx(ctx context.Context, opts *sql.TxOptions) (*sql.Tx, error)
 }
 
+const (
+	LogStatusSuccess    = "success"
+	LogStatusParseError = "parse_error"
+	LogStatusExecError  = "exec_error"
+	LogStatusSendError  = "send_error"
+)
+
 func NewHandler(db TxAble, intStore *integrationkey.Store, aStore *alert.Store, evt *event.Bus) *Handler {
 	return &Handler{intStore: intStore, db: db, alertStore: aStore, evt: evt}
 }
@@ -88,6 +96,48 @@ func (h *Handler) handleAction(ctx context.Context, act gadb.UIKActionV1) (inser
 	return didInsertSignals, nil
 }
 
+// upsertUikLog will save a log of the most recent request to a universal integration key in the db
+func (h *Handler) upsertUikLog(
+	ctx context.Context,
+	keyID uuid.UUID,
+	req *http.Request,
+	rawBody []byte,
+	status string,
+	errMsg string,
+) error {
+	if !expflag.ContextHas(ctx, expflag.UikLogs) {
+		return nil
+	}
+	const maxSize = 2048
+	if len(rawBody) > maxSize {
+		rawBody = rawBody[:maxSize]
+	}
+
+	err := gadb.New(h.db).IntKeyLog(ctx, gadb.IntKeyLogParams{
+		IntegrationKeyID: keyID,
+		Status:           status,
+		RawBody:          rawBody,
+		ContentType: sql.NullString{
+			String: req.Header.Get("Content-Type"),
+			Valid:  req.Header.Get("Content-Type") != "",
+		},
+		UserAgent: sql.NullString{
+			String: req.UserAgent(),
+			Valid:  req.UserAgent() != "",
+		},
+		ErrorMessage: sql.NullString{
+			String: errMsg,
+			Valid:  errMsg != "",
+		},
+	})
+
+	if err != nil {
+		fmt.Println("failed to log UIK request: ", err)
+		return err
+	}
+	return nil
+}
+
 // EventNewSignals is an event that is triggered when new signals are generated for a service.
 type EventNewSignals struct {
 	ServiceID uuid.UUID
@@ -117,11 +167,20 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
 	}
 	data, err := io.ReadAll(req.Body)
 	if errutil.HTTPError(ctx, w, err) {
+		_ = h.upsertUikLog(ctx, keyID, req, nil, LogStatusParseError, "read error: "+err.Error())
+		return
+	}
+
+	if !utf8.Valid(data) {
+		_ = h.upsertUikLog(ctx, keyID, req, nil, LogStatusParseError, "invalid UTF-8")
+		errutil.HTTPError(ctx, w, validation.NewGenericError("invalid UTF-8 in request body"))
 		return
 	}
+
 	var body any
 	err = json.Unmarshal(data, &body)
 	if errutil.HTTPError(ctx, w, validation.WrapError(err)) {
+		_ = h.upsertUikLog(ctx, keyID, req, data, LogStatusParseError, "invalid json: "+err.Error())
 		return
 	}
 
@@ -156,13 +215,16 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
 	var vm vm.VM
 	actions, err := compiled.Run(&vm, env)
 	if errutil.HTTPError(ctx, w, validation.WrapError(err)) {
+		_ = h.upsertUikLog(ctx, keyID, req, data, LogStatusExecError, "expression execution failed: "+err.Error())
 		return
 	}
 
 	var insertedAny bool
 	for _, act := range actions {
 		inserted, err := h.handleAction(ctx, act)
-		if errutil.HTTPError(ctx, w, err) {
+		if err != nil {
+			_ = h.upsertUikLog(ctx, keyID, req, data, LogStatusSendError, "action failed: "+err.Error())
+			errutil.HTTPError(ctx, w, err)
 			return
 		}
 		insertedAny = insertedAny || inserted
@@ -172,5 +234,6 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
 		event.Send(ctx, h.evt, EventNewSignals{ServiceID: permission.ServiceNullUUID(ctx).UUID})
 	}
 
+	_ = h.upsertUikLog(ctx, keyID, req, data, LogStatusSuccess, "")
 	w.WriteHeader(http.StatusNoContent)
 }

migrate/migrations/20250722142521-uik-logs.sql

@@ -0,0 +1,24 @@
+-- +migrate Up
+
+CREATE TABLE uik_logs (
+    id uuid PRIMARY KEY DEFAULT gen_random_uuid(),
+    integration_key_id uuid NOT NULL REFERENCES integration_keys(id) ON DELETE CASCADE,
+    received_at timestamptz NOT NULL DEFAULT now(),
+
+    status text NOT NULL CHECK (status IN (
+        'success', 
+        'parse_error', 
+        'exec_error', 
+        'send_error'
+    )),
+
+    raw_body bytea,
+    content_type text,
+    user_agent text,
+    error_message text
+);
+
+CREATE UNIQUE INDEX uik_logs_unique_key_id ON uik_logs (integration_key_id);
+
+-- +migrate Down
+DROP TABLE IF EXISTS uik_logs;

migrate/schema.sql

@@ -1,7 +1,7 @@
 -- This file is auto-generated by "make db-schema"; DO NOT EDIT
--- DATA=50f009ab810d42724027d31ec49f2584a1c8ecd647194c2455de853975d40bd0  -
--- DISK=2f8c154346b509ddac6e6d36a7a4f1bc86c047dcd1f98eb3ee5846bdf4bcf687  -
--- PSQL=2f8c154346b509ddac6e6d36a7a4f1bc86c047dcd1f98eb3ee5846bdf4bcf687  -
+-- DATA=79a04167bec00db3465859780ff258857275b706408e83226c1bf579a33b5479  -
+-- DISK=1072aa5cb3367eb1bc0e91e1bed2d100cfd6c4cd1f974cf062fe61e73abc967f  -
+-- PSQL=1072aa5cb3367eb1bc0e91e1bed2d100cfd6c4cd1f974cf062fe61e73abc967f  -
 --
 -- pgdump-lite database dump
 --
@@ -2523,6 +2523,24 @@ CREATE UNIQUE INDEX uik_config_primary_token_key ON public.uik_config USING btre
 CREATE UNIQUE INDEX uik_config_secondary_token_key ON public.uik_config USING btree (secondary_token);
 
 
+CREATE TABLE uik_logs (
+	content_type text,
+	error_message text,
+	id uuid DEFAULT gen_random_uuid() NOT NULL,
+	integration_key_id uuid NOT NULL,
+	raw_body bytea,
+	received_at timestamp with time zone DEFAULT now() NOT NULL,
+	status text NOT NULL,
+	user_agent text,
+	CONSTRAINT uik_logs_integration_key_id_fkey FOREIGN KEY (integration_key_id) REFERENCES integration_keys(id) ON DELETE CASCADE,
+	CONSTRAINT uik_logs_pkey PRIMARY KEY (id),
+	CONSTRAINT uik_logs_status_check CHECK (status = ANY (ARRAY['success'::text, 'parse_error'::text, 'exec_error'::text, 'send_error'::text]))
+);
+
+CREATE UNIQUE INDEX uik_logs_pkey ON public.uik_logs USING btree (id);
+CREATE UNIQUE INDEX uik_logs_unique_key_id ON public.uik_logs USING btree (integration_key_id);
+
+
 CREATE TABLE user_calendar_subscriptions (
 	config jsonb NOT NULL,
 	created_at timestamp with time zone DEFAULT now() NOT NULL,

web/src/expflag.d.ts

@@ -1,3 +1,3 @@
 // Code generated by expflag/cmd/tsgen DO NOT EDIT.
 
-type ExpFlag = 'example' | 'univ-keys'
+type ExpFlag = 'example' | 'uik-logs' | 'univ-keys'