Skip to content

Open-source LLM knowledge platform: turn raw documents into a queryable RAG, an autonomous reasoning agent, and a self-maintaining Wiki.

15.4 KB
Raw Blame
package handler

import (
	"context"
	"encoding/json"
	"fmt"
	"net/http"
	"net/http/httptest"
	"testing"

	"github.com/gin-gonic/gin"

	"github.com/Tencent/WeKnora/internal/middleware"
	"github.com/Tencent/WeKnora/internal/types"
	"github.com/Tencent/WeKnora/internal/types/interfaces"
)

// stubAuditService implements just AuditLogService.List for the
// handler tests. Embeds the interface so any other call panics —
// surfaces a contract drift loudly instead of silently working.
type stubAuditService struct {
	interfaces.AuditLogService
	list func(ctx context.Context, tenantID uint64, q *interfaces.AuditLogQuery) ([]*types.AuditLog, error)
}

func (s *stubAuditService) List(
	ctx context.Context, tenantID uint64, q *interfaces.AuditLogQuery,
) ([]*types.AuditLog, error) {
	return s.list(ctx, tenantID, q)
}

// newAuditHandlerTestRouter mounts the handler with the production
// ErrorHandler so c.Error renders the canonical envelope. Path :id is
// resolved by parseTenantIDFromPath; tenant context is not required by
// the handler (PathTenantMatch is stripped from this layer because the
// tests focus on the handler's own surface).
func newAuditHandlerTestRouter(svc interfaces.AuditLogService) *gin.Engine {
	gin.SetMode(gin.TestMode)
	r := gin.New()
	r.Use(middleware.ErrorHandler())
	h := NewAuditLogHandler(svc)
	r.GET("/tenants/:id/audit-log", h.ListTenantAuditLog)
	return r
}

func TestAuditLogHandler_ReturnsEnvelopeAndCursor(t *testing.T) {
	// Two rows: smallest id appears in the next_cursor field so the
	// frontend can re-request older pages without re-parsing the body.
	svc := &stubAuditService{
		list: func(_ context.Context, tenantID uint64, q *interfaces.AuditLogQuery) ([]*types.AuditLog, error) {
			if tenantID != 7 {
				t.Fatalf("expected tenant 7, got %d", tenantID)
			}
			return []*types.AuditLog{
				{ID: 102, TenantID: 7, Action: types.AuditActionMemberAdded},
				{ID: 95, TenantID: 7, Action: types.AuditActionAccessDenied, Outcome: types.AuditOutcomeDenied},
			}, nil
		},
	}
	w := httptest.NewRecorder()
	req := httptest.NewRequest(http.MethodGet, "/tenants/7/audit-log", nil)
	newAuditHandlerTestRouter(svc).ServeHTTP(w, req)

	if w.Code != http.StatusOK {
		t.Fatalf("expected 200, got %d body=%s", w.Code, w.Body.String())
	}
	var got auditLogListResponse
	if err := json.Unmarshal(w.Body.Bytes(), &got); err != nil {
		t.Fatalf("unmarshal: %v", err)
	}
	if !got.Success {
		t.Fatalf("expected success=true")
	}
	if len(got.Data) != 2 {
		t.Fatalf("expected 2 entries, got %d", len(got.Data))
	}
	if got.NextCursor != 95 {
		t.Fatalf("expected next_cursor to be the smallest id (95), got %d", got.NextCursor)
	}
}

func TestAuditLogHandler_PassesQueryFiltersThrough(t *testing.T) {
	// The handler must propagate after_id / limit / action / outcome /
	// actor exactly as the service expects them. A regression here
	// would silently drop a filter and over-return rows on the wire.
	svc := &stubAuditService{
		list: func(_ context.Context, _ uint64, q *interfaces.AuditLogQuery) ([]*types.AuditLog, error) {
			if q.AfterID != 100 {
				t.Fatalf("expected after_id=100, got %d", q.AfterID)
			}
			if q.Limit != 25 {
				t.Fatalf("expected limit=25, got %d", q.Limit)
			}
			if q.Action != types.AuditActionAccessDenied {
				t.Fatalf("expected action=access_denied, got %q", q.Action)
			}
			if q.Outcome != types.AuditOutcomeDenied {
				t.Fatalf("expected outcome=denied, got %q", q.Outcome)
			}
			if q.ActorUserID != "u-probing" {
				t.Fatalf("expected actor=u-probing, got %q", q.ActorUserID)
			}
			if !q.UnscopedOnly {
				t.Fatalf("tenant audit feed must exclude resource-scoped activity rows")
			}
			return nil, nil
		},
	}
	w := httptest.NewRecorder()
	q := "after_id=100&limit=25&action=rbac.access_denied&outcome=denied&actor=u-probing"
	req := httptest.NewRequest(http.MethodGet, "/tenants/7/audit-log?"+q, nil)
	newAuditHandlerTestRouter(svc).ServeHTTP(w, req)
	if w.Code != http.StatusOK {
		t.Fatalf("expected 200, got %d body=%s", w.Code, w.Body.String())
	}
}

func TestAuditLogHandler_EmptyResultProducesZeroCursor(t *testing.T) {
	// next_cursor=0 is the documented "no more rows" signal; the frontend
	// stops paginating when it sees this, so a regression that returns
	// the previous cursor on an empty page would loop forever.
	svc := &stubAuditService{
		list: func(_ context.Context, _ uint64, _ *interfaces.AuditLogQuery) ([]*types.AuditLog, error) {
			return nil, nil
		},
	}
	w := httptest.NewRecorder()
	req := httptest.NewRequest(http.MethodGet, "/tenants/7/audit-log", nil)
	newAuditHandlerTestRouter(svc).ServeHTTP(w, req)
	if w.Code != http.StatusOK {
		t.Fatalf("expected 200, got %d body=%s", w.Code, w.Body.String())
	}
	var got auditLogListResponse
	if err := json.Unmarshal(w.Body.Bytes(), &got); err != nil {
		t.Fatalf("unmarshal: %v", err)
	}
	if got.NextCursor != 0 {
		t.Fatalf("expected next_cursor=0 on empty page, got %d", got.NextCursor)
	}
}

func TestAuditLogHandler_InvalidTenantIDReturns400(t *testing.T) {
	// parseTenantIDFromPath rejects non-numeric tenant ids with 400 so
	// the handler never even calls the service. The harness still has
	// to not crash on an empty service if it's reached — guard with a
	// service that fails the test loudly.
	svc := &stubAuditService{
		list: func(_ context.Context, _ uint64, _ *interfaces.AuditLogQuery) ([]*types.AuditLog, error) {
			return nil, fmt.Errorf("must not be called")
		},
	}
	w := httptest.NewRecorder()
	req := httptest.NewRequest(http.MethodGet, "/tenants/not-a-number/audit-log", nil)
	newAuditHandlerTestRouter(svc).ServeHTTP(w, req)
	if w.Code != http.StatusBadRequest {
		t.Fatalf("expected 400 for non-numeric tenant id, got %d body=%s", w.Code, w.Body.String())
	}
}

func newKBActivityHandlerTestRouter(
	t *testing.T,
	svc interfaces.AuditLogService,
	callerTenantID uint64,
	kb *types.KnowledgeBase,
	userID string,
	role types.TenantRole,
) *gin.Engine {
	t.Helper()
	gin.SetMode(gin.TestMode)
	r := gin.New()
	r.Use(middleware.ErrorHandler())
	r.Use(func(c *gin.Context) {
		c.Set(types.TenantIDContextKey.String(), callerTenantID)
		c.Set(middleware.KBAccessContextKey, &middleware.KBAccess{KnowledgeBase: kb})
		ctx := context.WithValue(c.Request.Context(), types.UserIDContextKey, userID)
		ctx = context.WithValue(ctx, types.TenantRoleContextKey, role)
		c.Request = c.Request.WithContext(ctx)
		c.Next()
	})
	h := NewAuditLogHandler(svc)
	r.GET("/knowledge-bases/:id/activity", h.ListKnowledgeBaseActivity)
	return r
}

func TestKnowledgeBaseActivityHandler_UsesKBScope(t *testing.T) {
	svc := &stubAuditService{list: func(_ context.Context, tenantID uint64, q *interfaces.AuditLogQuery) ([]*types.AuditLog, error) {
		if tenantID != 7 || q.ScopeType != "knowledge_base" || q.ScopeID != "kb-1" {
			t.Fatalf("unexpected scope: tenant=%d type=%q id=%q", tenantID, q.ScopeType, q.ScopeID)
		}
		if q.AfterID != 30 || q.Limit != 10 || q.Outcome != types.AuditOutcomePartial {
			t.Fatalf("unexpected filters: %+v", q)
		}
		return []*types.AuditLog{{ID: 21, TenantID: 7, ScopeType: q.ScopeType, ScopeID: q.ScopeID}}, nil
	}}
	w := httptest.NewRecorder()
	req := httptest.NewRequest(http.MethodGet, "/knowledge-bases/kb-1/activity?after_id=30&limit=10&outcome=partial", nil)
	newKBActivityHandlerTestRouter(t, svc, 7,
		&types.KnowledgeBase{ID: "kb-1", TenantID: 7, CreatorID: "creator"},
		"creator", types.TenantRoleViewer).ServeHTTP(w, req)
	if w.Code != http.StatusOK {
		t.Fatalf("expected 200, got %d body=%s", w.Code, w.Body.String())
	}
}

func TestKnowledgeBaseActivityHandler_BlocksSharedWorkspace(t *testing.T) {
	svc := &stubAuditService{list: func(_ context.Context, _ uint64, _ *interfaces.AuditLogQuery) ([]*types.AuditLog, error) {
		t.Fatal("audit list must not be called for a shared workspace")
		return nil, nil
	}}
	w := httptest.NewRecorder()
	req := httptest.NewRequest(http.MethodGet, "/knowledge-bases/kb-1/activity", nil)
	newKBActivityHandlerTestRouter(t, svc, 8,
		&types.KnowledgeBase{ID: "kb-1", TenantID: 7, CreatorID: "creator"},
		"creator", types.TenantRoleOwner).ServeHTTP(w, req)
	if w.Code != http.StatusForbidden {
		t.Fatalf("expected 403, got %d body=%s", w.Code, w.Body.String())
	}
}

func TestKnowledgeBaseActivityHandler_RequiresCreatorOrAdmin(t *testing.T) {
	svc := &stubAuditService{list: func(_ context.Context, _ uint64, _ *interfaces.AuditLogQuery) ([]*types.AuditLog, error) {
		t.Fatal("audit list must not be called for ordinary members")
		return nil, nil
	}}
	w := httptest.NewRecorder()
	req := httptest.NewRequest(http.MethodGet, "/knowledge-bases/kb-1/activity", nil)
	newKBActivityHandlerTestRouter(t, svc, 7,
		&types.KnowledgeBase{ID: "kb-1", TenantID: 7, CreatorID: "creator"},
		"other", types.TenantRoleContributor).ServeHTTP(w, req)
	if w.Code != http.StatusForbidden {
		t.Fatalf("expected 403, got %d body=%s", w.Code, w.Body.String())
	}
}

// ---- ListSystemAuditLog (platform / system-scope feed) ----------------
//
// Mirrors the per-tenant suite above but covers the new
// GET /system/admin/audit-log endpoint. Key behavioural difference:
// the handler must always pass tenant_id=0 to the service (system-scope
// convention) regardless of any URL parameter. The route group is
// guarded by SystemAdmin() at the production wiring layer; the test
// mounts the handler directly so it focuses on the handler's own
// contract.

func newSystemAuditHandlerTestRouter(svc interfaces.AuditLogService) *gin.Engine {
	gin.SetMode(gin.TestMode)
	r := gin.New()
	r.Use(middleware.ErrorHandler())
	h := NewAuditLogHandler(svc)
	r.GET("/system/admin/audit-log", h.ListSystemAuditLog)
	return r
}

func TestSystemAuditLogHandler_AlwaysQueriesTenantZero(t *testing.T) {
	// The defining contract of ListSystemAuditLog: the underlying
	// service call is hard-pinned to tenant_id=0. A regression that
	// reads a tenant_id from the URL / context / header would leak
	// per-tenant rbac.* rows into the platform feed (and conversely,
	// hide the platform's system.* rows from the SystemAdmin).
	called := false
	svc := &stubAuditService{
		list: func(_ context.Context, tenantID uint64, _ *interfaces.AuditLogQuery) ([]*types.AuditLog, error) {
			called = true
			if tenantID != 0 {
				t.Fatalf("system audit handler must call List with tenant_id=0, got %d", tenantID)
			}
			return []*types.AuditLog{
				{ID: 50, TenantID: 0, Action: types.AuditActionSystemSettingChanged},
				{ID: 42, TenantID: 0, Action: types.AuditActionSystemAdminPromoted},
			}, nil
		},
	}
	w := httptest.NewRecorder()
	req := httptest.NewRequest(http.MethodGet, "/system/admin/audit-log", nil)
	newSystemAuditHandlerTestRouter(svc).ServeHTTP(w, req)

	if !called {
		t.Fatalf("expected AuditLogService.List to be invoked")
	}
	if w.Code != http.StatusOK {
		t.Fatalf("expected 200, got %d body=%s", w.Code, w.Body.String())
	}
	var got auditLogListResponse
	if err := json.Unmarshal(w.Body.Bytes(), &got); err != nil {
		t.Fatalf("unmarshal: %v", err)
	}
	if !got.Success {
		t.Fatalf("expected success=true")
	}
	if len(got.Data) != 2 {
		t.Fatalf("expected 2 entries, got %d", len(got.Data))
	}
	if got.NextCursor != 42 {
		t.Fatalf("expected next_cursor to be the smallest id (42), got %d", got.NextCursor)
	}
}

func TestSystemAuditLogHandler_PassesQueryFiltersThrough(t *testing.T) {
	// Same propagation guarantee as the per-tenant variant. We exercise
	// every filter the OpenAPI surface advertises so a typo in the
	// query-key list (e.g. dropping "outcome") is caught.
	svc := &stubAuditService{
		list: func(_ context.Context, tenantID uint64, q *interfaces.AuditLogQuery) ([]*types.AuditLog, error) {
			if tenantID != 0 {
				t.Fatalf("expected tenant_id=0, got %d", tenantID)
			}
			if q.AfterID != 200 {
				t.Fatalf("expected after_id=200, got %d", q.AfterID)
			}
			if q.Limit != 10 {
				t.Fatalf("expected limit=10, got %d", q.Limit)
			}
			if q.Action != types.AuditActionSystemSettingChanged {
				t.Fatalf("expected action=system.setting_changed, got %q", q.Action)
			}
			if q.Outcome != types.AuditOutcomeSuccess {
				t.Fatalf("expected outcome=success, got %q", q.Outcome)
			}
			if q.ActorUserID != "u-admin-1" {
				t.Fatalf("expected actor=u-admin-1, got %q", q.ActorUserID)
			}
			return nil, nil
		},
	}
	w := httptest.NewRecorder()
	q := "after_id=200&limit=10&action=system.setting_changed&outcome=success&actor=u-admin-1"
	req := httptest.NewRequest(http.MethodGet, "/system/admin/audit-log?"+q, nil)
	newSystemAuditHandlerTestRouter(svc).ServeHTTP(w, req)
	if w.Code != http.StatusOK {
		t.Fatalf("expected 200, got %d body=%s", w.Code, w.Body.String())
	}
}

func TestSystemAuditLogHandler_EmptyResultProducesZeroCursor(t *testing.T) {
	// next_cursor=0 is the documented "no more rows" signal — the
	// platform drawer's infinite-scroll watcher stops paginating on
	// it. A regression returning the previous cursor on an empty page
	// would loop forever and pin the CPU.
	svc := &stubAuditService{
		list: func(_ context.Context, _ uint64, _ *interfaces.AuditLogQuery) ([]*types.AuditLog, error) {
			return nil, nil
		},
	}
	w := httptest.NewRecorder()
	req := httptest.NewRequest(http.MethodGet, "/system/admin/audit-log?after_id=10", nil)
	newSystemAuditHandlerTestRouter(svc).ServeHTTP(w, req)
	if w.Code != http.StatusOK {
		t.Fatalf("expected 200, got %d body=%s", w.Code, w.Body.String())
	}
	var got auditLogListResponse
	if err := json.Unmarshal(w.Body.Bytes(), &got); err != nil {
		t.Fatalf("unmarshal: %v", err)
	}
	if got.NextCursor != 0 {
		t.Fatalf("expected next_cursor=0 on empty page, got %d", got.NextCursor)
	}
	if len(got.Data) != 0 {
		t.Fatalf("expected zero entries, got %d", len(got.Data))
	}
}

func TestSystemAuditLogHandler_GarbageCursorAndLimitTolerated(t *testing.T) {
	// Tolerant parsing matches ListTenantAuditLog so a misconfigured
	// client doesn't hard-fail the first request. Garbage `after_id`
	// or non-positive `limit` are treated as "use defaults" (0 / 0)
	// rather than a 400 — the frontend would otherwise show a blank
	// drawer the moment a stale param ends up in the URL.
	var seenAfter uint64
	var seenLimit int
	svc := &stubAuditService{
		list: func(_ context.Context, _ uint64, q *interfaces.AuditLogQuery) ([]*types.AuditLog, error) {
			seenAfter = q.AfterID
			seenLimit = q.Limit
			return nil, nil
		},
	}
	w := httptest.NewRecorder()
	req := httptest.NewRequest(http.MethodGet, "/system/admin/audit-log?after_id=abc&limit=-1", nil)
	newSystemAuditHandlerTestRouter(svc).ServeHTTP(w, req)
	if w.Code != http.StatusOK {
		t.Fatalf("expected 200 (tolerant parse), got %d body=%s", w.Code, w.Body.String())
	}
	if seenAfter != 0 {
		t.Fatalf("garbage after_id must collapse to 0, got %d", seenAfter)
	}
	if seenLimit != 0 {
		t.Fatalf("non-positive limit must collapse to 0 (repo default), got %d", seenLimit)
	}
}

func TestSystemAuditLogHandler_ServiceErrorReturns500(t *testing.T) {
	// AuditLogService.List failures bubble through as 500 via
	// errors.NewInternalServerError + middleware.ErrorHandler. The
	// frontend surfaces the message verbatim in the drawer's error
	// alert, so the body should still carry a non-empty string.
	svc := &stubAuditService{
		list: func(_ context.Context, _ uint64, _ *interfaces.AuditLogQuery) ([]*types.AuditLog, error) {
			return nil, fmt.Errorf("db: connection refused")
		},
	}
	w := httptest.NewRecorder()
	req := httptest.NewRequest(http.MethodGet, "/system/admin/audit-log", nil)
	newSystemAuditHandlerTestRouter(svc).ServeHTTP(w, req)
	if w.Code != http.StatusInternalServerError {
		t.Fatalf("expected 500, got %d body=%s", w.Code, w.Body.String())
	}
	if w.Body.Len() == 0 {
		t.Fatalf("expected non-empty error body for drawer alert")
	}
}