mirror of
https://github.com/lukaszraczylo/traefikoidc.git
synced 2026-11-04 07:53:59 +00:00
Compare commits
4
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7db2f8d66c | ||
|
|
024e349aa9 | ||
|
|
873105108e | ||
|
|
5241cfe792 |
@@ -77,6 +77,7 @@ testData:
|
||||
revocationURL: https://accounts.google.com/revoke # Endpoint for revoking tokens
|
||||
oidcEndSessionURL: https://accounts.google.com/logout # Provider's end session endpoint
|
||||
enablePKCE: false # Enables PKCE (Proof Key for Code Exchange) for additional security
|
||||
cookieDomain: "" # Explicit domain for session cookies (e.g., ".example.com" for multi-subdomain setups)
|
||||
|
||||
# --- Provider Specific Configuration Examples ---
|
||||
#
|
||||
@@ -373,6 +374,31 @@ configuration:
|
||||
Default: false
|
||||
required: false
|
||||
|
||||
cookieDomain:
|
||||
type: string
|
||||
description: |
|
||||
Explicit domain for session cookies. This is important for multi-subdomain setups
|
||||
and reverse proxy deployments to ensure consistent cookie handling.
|
||||
|
||||
When set, all session cookies will use this domain. When not set, the domain
|
||||
is auto-detected from the request headers (X-Forwarded-Host or Host).
|
||||
|
||||
Use a leading dot for subdomain-wide cookies (e.g., ".example.com" allows
|
||||
cookies to be shared between app.example.com, api.example.com, etc.).
|
||||
|
||||
Use a specific domain for host-only cookies (e.g., "app.example.com" restricts
|
||||
cookies to that exact domain).
|
||||
|
||||
This setting is crucial to prevent authentication issues like "CSRF token missing
|
||||
in session" errors that can occur when cookies are created with inconsistent domains.
|
||||
|
||||
Examples:
|
||||
- ".example.com" - Allows all subdomains to share cookies
|
||||
- "app.example.com" - Restricts cookies to this specific host
|
||||
|
||||
Default: "" (auto-detected from request headers)
|
||||
required: false
|
||||
|
||||
headers:
|
||||
type: array
|
||||
description: |
|
||||
|
||||
@@ -82,6 +82,7 @@ The middleware supports the following configuration options:
|
||||
| `oidcEndSessionURL` | The provider's end session endpoint | auto-discovered | `https://accounts.google.com/logout` |
|
||||
| `enablePKCE` | Enables PKCE (Proof Key for Code Exchange) for authorization code flow | `false` | `true`, `false` |
|
||||
| `refreshGracePeriodSeconds` | Seconds before token expiry to attempt proactive refresh | `60` | `120` |
|
||||
| `cookieDomain` | Explicit domain for session cookies (important for multi-subdomain setups) | auto-detected | `.example.com`, `app.example.com` |
|
||||
| `headers` | Custom HTTP headers with templates that can access OIDC claims and tokens | none | See "Templated Headers" section |
|
||||
|
||||
## Scope Configuration
|
||||
@@ -311,6 +312,30 @@ spec:
|
||||
- developer
|
||||
```
|
||||
|
||||
### With Cookie Domain Configuration (Multi-Subdomain Setup)
|
||||
|
||||
```yaml
|
||||
apiVersion: traefik.io/v1alpha1
|
||||
kind: Middleware
|
||||
metadata:
|
||||
name: oidc-multi-subdomain
|
||||
namespace: traefik
|
||||
spec:
|
||||
plugin:
|
||||
traefikoidc:
|
||||
providerURL: https://accounts.google.com
|
||||
clientID: 1234567890.apps.googleusercontent.com
|
||||
clientSecret: your-client-secret
|
||||
sessionEncryptionKey: potato-secret-is-at-least-32-bytes-long
|
||||
callbackURL: /oauth2/callback
|
||||
logoutURL: /oauth2/logout
|
||||
cookieDomain: .example.com # Allows cookies to be shared across all subdomains
|
||||
scopes:
|
||||
- roles # Appended to defaults: ["openid", "profile", "email", "roles"]
|
||||
```
|
||||
|
||||
**Important**: The `cookieDomain` parameter is crucial when running behind a reverse proxy or when your application serves multiple subdomains. Without it, cookies may be created with inconsistent domains, leading to authentication issues like "CSRF token missing in session" errors.
|
||||
|
||||
### With Custom Logging and Rate Limiting
|
||||
|
||||
```yaml
|
||||
|
||||
+24
-2
@@ -1,6 +1,9 @@
|
||||
package traefikoidc
|
||||
|
||||
import "time"
|
||||
import (
|
||||
"sync"
|
||||
"time"
|
||||
)
|
||||
|
||||
// BackgroundTask represents a managed recurring task that runs in the background.
|
||||
// It provides a clean interface for starting and stopping periodic operations
|
||||
@@ -11,6 +14,7 @@ type BackgroundTask struct {
|
||||
logger *Logger
|
||||
name string
|
||||
interval time.Duration
|
||||
wg *sync.WaitGroup
|
||||
}
|
||||
|
||||
// NewBackgroundTask creates a new background task with the specified parameters.
|
||||
@@ -20,35 +24,53 @@ type BackgroundTask struct {
|
||||
// - interval: Duration between task executions.
|
||||
// - taskFunc: The function to execute periodically.
|
||||
// - logger: Logger instance for task lifecycle events.
|
||||
// - wg: Optional WaitGroup for synchronizing goroutine completion.
|
||||
//
|
||||
// Returns:
|
||||
// - A configured BackgroundTask ready to be started.
|
||||
func NewBackgroundTask(name string, interval time.Duration, taskFunc func(), logger *Logger) *BackgroundTask {
|
||||
func NewBackgroundTask(name string, interval time.Duration, taskFunc func(), logger *Logger, wg ...*sync.WaitGroup) *BackgroundTask {
|
||||
var waitGroup *sync.WaitGroup
|
||||
if len(wg) > 0 {
|
||||
waitGroup = wg[0]
|
||||
}
|
||||
return &BackgroundTask{
|
||||
name: name,
|
||||
interval: interval,
|
||||
stopChan: make(chan struct{}),
|
||||
taskFunc: taskFunc,
|
||||
logger: logger,
|
||||
wg: waitGroup,
|
||||
}
|
||||
}
|
||||
|
||||
// Start begins the background task execution in a separate goroutine.
|
||||
// The task runs immediately upon start and then at the specified interval.
|
||||
func (bt *BackgroundTask) Start() {
|
||||
if bt.wg != nil {
|
||||
bt.wg.Add(1)
|
||||
}
|
||||
go bt.run()
|
||||
}
|
||||
|
||||
// Stop gracefully terminates the background task by closing the stop channel.
|
||||
// If a WaitGroup was provided, it waits for the goroutine to complete.
|
||||
// This method is safe to call multiple times.
|
||||
func (bt *BackgroundTask) Stop() {
|
||||
close(bt.stopChan)
|
||||
if bt.wg != nil {
|
||||
bt.wg.Wait()
|
||||
}
|
||||
}
|
||||
|
||||
// run is the main execution loop for the background task.
|
||||
// It executes the task function immediately and then at regular intervals
|
||||
// until the stop signal is received.
|
||||
func (bt *BackgroundTask) run() {
|
||||
defer func() {
|
||||
if bt.wg != nil {
|
||||
bt.wg.Done()
|
||||
}
|
||||
}()
|
||||
ticker := time.NewTicker(bt.interval)
|
||||
defer ticker.Stop()
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ import (
|
||||
// during the callback from Azure AD
|
||||
func TestAzureOAuthCallbackScenario(t *testing.T) {
|
||||
t.Run("Azure_OAuth_Complete_Flow", func(t *testing.T) {
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Step 1: User visits https://app.example.com/protected
|
||||
@@ -110,7 +110,7 @@ func TestAzureOAuthCallbackScenario(t *testing.T) {
|
||||
|
||||
t.Run("Cookie_Not_Sent_With_Wrong_Domain", func(t *testing.T) {
|
||||
// This test verifies that cookies with wrong domain won't be sent
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Initial request sets cookie for app.example.com
|
||||
@@ -148,7 +148,7 @@ func TestAzureOAuthCallbackScenario(t *testing.T) {
|
||||
// This test demonstrates why we can't use SameSite=Strict for OAuth
|
||||
// With Strict, cookies wouldn't be sent when redirecting from Azure to our app
|
||||
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// If we had SameSite=Strict (which we don't anymore), the browser would:
|
||||
|
||||
+1
-1
@@ -71,7 +71,7 @@ func TestAzureOIDCRegression(t *testing.T) {
|
||||
tOidc := &mockTraefikOidc{TraefikOidc: baseOidc}
|
||||
|
||||
// Initialize session manager
|
||||
sessionManager, _ := NewSessionManager("test-encryption-key-32-bytes-long", false, mockLogger)
|
||||
sessionManager, _ := NewSessionManager("test-encryption-key-32-bytes-long", false, "", mockLogger)
|
||||
tOidc.sessionManager = sessionManager
|
||||
|
||||
// Mock the JWT verification to avoid JWKS lookup issues
|
||||
|
||||
@@ -0,0 +1,218 @@
|
||||
package traefikoidc
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// TestCookieCleanupBehavior tests the cookie cleanup function's behavior
|
||||
func TestCookieCleanupBehavior(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
|
||||
// Create session manager with a specific domain
|
||||
sm, err := NewSessionManager("test-encryption-key-32-characters", false, "app.example.com", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
|
||||
// Create request from app.example.com
|
||||
req := httptest.NewRequest("GET", "http://app.example.com/test", nil)
|
||||
|
||||
// Add some OIDC cookies (browsers don't send domain info)
|
||||
cookies := []*http.Cookie{
|
||||
{
|
||||
Name: "_oidc_raczylo_m",
|
||||
Value: "test-value-1",
|
||||
},
|
||||
{
|
||||
Name: "_oidc_raczylo_a",
|
||||
Value: "test-value-2",
|
||||
},
|
||||
{
|
||||
Name: "access_token_chunk_0",
|
||||
Value: "chunk-value",
|
||||
},
|
||||
}
|
||||
|
||||
for _, cookie := range cookies {
|
||||
req.AddCookie(cookie)
|
||||
}
|
||||
|
||||
// Create response recorder to capture Set-Cookie headers
|
||||
rr := httptest.NewRecorder()
|
||||
|
||||
// Run cleanup - it should attempt to delete cookies with various domains
|
||||
sm.CleanupOldCookies(rr, req)
|
||||
|
||||
// Check Set-Cookie headers
|
||||
setCookies := rr.Result().Cookies()
|
||||
|
||||
// The cleanup should have attempted to delete cookies with various domain variations
|
||||
// We should see deletion attempts for:
|
||||
// - app.example.com
|
||||
// - .app.example.com
|
||||
// - example.com
|
||||
// - .example.com
|
||||
var deletionAttempts int
|
||||
domainsAttempted := make(map[string]bool)
|
||||
|
||||
for _, cookie := range setCookies {
|
||||
if cookie.MaxAge == -1 {
|
||||
deletionAttempts++
|
||||
domainsAttempted[cookie.Domain] = true
|
||||
}
|
||||
}
|
||||
|
||||
// We should see deletion attempts for various domain variations
|
||||
// Note: The exact number depends on the implementation, but we should see multiple attempts
|
||||
if deletionAttempts == 0 {
|
||||
t.Error("Expected cleanup to attempt cookie deletions, but none were found")
|
||||
}
|
||||
|
||||
// Log the domains attempted for debugging
|
||||
t.Logf("Deletion attempts: %d", deletionAttempts)
|
||||
for domain := range domainsAttempted {
|
||||
t.Logf("Attempted deletion for domain: %q", domain)
|
||||
}
|
||||
}
|
||||
|
||||
// TestConfiguredDomainPersistence tests that configured domain is consistently used
|
||||
func TestConfiguredDomainPersistence(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
|
||||
// Create session manager with explicit domain configuration
|
||||
configuredDomain := ".example.com"
|
||||
sm, err := NewSessionManager("test-encryption-key-32-characters", false, configuredDomain, logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
|
||||
// Create requests from different subdomains
|
||||
tests := []struct {
|
||||
requestHost string
|
||||
name string
|
||||
}{
|
||||
{
|
||||
name: "Request from main domain",
|
||||
requestHost: "example.com",
|
||||
},
|
||||
{
|
||||
name: "Request from subdomain",
|
||||
requestHost: "app.example.com",
|
||||
},
|
||||
{
|
||||
name: "Request from nested subdomain",
|
||||
requestHost: "api.app.example.com",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
req := httptest.NewRequest("GET", "http://"+tt.requestHost+"/test", nil)
|
||||
rr := httptest.NewRecorder()
|
||||
|
||||
// Get session and set a value
|
||||
session, err := sm.GetSession(req)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get session: %v", err)
|
||||
}
|
||||
defer session.ReturnToPool()
|
||||
|
||||
session.SetNonce("test-nonce")
|
||||
|
||||
// Save session
|
||||
err = session.Save(req, rr)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to save session: %v", err)
|
||||
}
|
||||
|
||||
// Check that all cookies use the configured domain
|
||||
cookies := rr.Result().Cookies()
|
||||
for _, cookie := range cookies {
|
||||
if strings.HasPrefix(cookie.Name, "_oidc_") {
|
||||
// The domain should match the configured domain (with possible normalization)
|
||||
expectedDomains := []string{configuredDomain, strings.TrimPrefix(configuredDomain, ".")}
|
||||
domainMatches := false
|
||||
for _, expected := range expectedDomains {
|
||||
if cookie.Domain == expected || cookie.Domain == "" {
|
||||
domainMatches = true
|
||||
break
|
||||
}
|
||||
}
|
||||
if !domainMatches {
|
||||
t.Errorf("Cookie %s has unexpected domain %q, expected one of %v",
|
||||
cookie.Name, cookie.Domain, expectedDomains)
|
||||
}
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestDomainMigration simulates migrating from no configured domain to explicit domain
|
||||
func TestDomainMigration(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
|
||||
// Step 1: Create session without configured domain (auto-detection)
|
||||
sm1, err := NewSessionManager("test-encryption-key-32-characters", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
|
||||
req1 := httptest.NewRequest("GET", "http://app.example.com/test", nil)
|
||||
rr1 := httptest.NewRecorder()
|
||||
|
||||
session1, err := sm1.GetSession(req1)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get session: %v", err)
|
||||
}
|
||||
|
||||
session1.SetNonce("test-nonce")
|
||||
session1.Save(req1, rr1)
|
||||
session1.ReturnToPool()
|
||||
|
||||
// The cookies will have auto-detected domain
|
||||
oldCookies := rr1.Result().Cookies()
|
||||
t.Logf("Old cookies count: %d", len(oldCookies))
|
||||
|
||||
// Step 2: Create new session manager with explicit domain configuration
|
||||
sm2, err := NewSessionManager("test-encryption-key-32-characters", false, ".example.com", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
|
||||
// Step 3: Make request with old cookies
|
||||
req2 := httptest.NewRequest("GET", "http://app.example.com/test", nil)
|
||||
|
||||
// Add the old cookies to the new request
|
||||
for _, cookie := range oldCookies {
|
||||
// Simulate browser behavior - don't include domain in Cookie header
|
||||
simpleCookie := &http.Cookie{
|
||||
Name: cookie.Name,
|
||||
Value: cookie.Value,
|
||||
}
|
||||
req2.AddCookie(simpleCookie)
|
||||
}
|
||||
|
||||
rr2 := httptest.NewRecorder()
|
||||
|
||||
// Run cleanup - should attempt to delete old cookies
|
||||
sm2.CleanupOldCookies(rr2, req2)
|
||||
|
||||
// Check that deletion cookies were sent
|
||||
newCookies := rr2.Result().Cookies()
|
||||
deletionCount := 0
|
||||
for _, cookie := range newCookies {
|
||||
if cookie.MaxAge == -1 {
|
||||
deletionCount++
|
||||
}
|
||||
}
|
||||
|
||||
if deletionCount == 0 {
|
||||
t.Error("Expected cleanup to send deletion cookies during migration, but none were found")
|
||||
}
|
||||
|
||||
t.Logf("Sent %d deletion cookies during migration", deletionCount)
|
||||
}
|
||||
@@ -0,0 +1,205 @@
|
||||
package traefikoidc
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// TestCookieDomainConfiguration tests that the cookie domain configuration is properly applied
|
||||
func TestCookieDomainConfiguration(t *testing.T) {
|
||||
tests := []struct {
|
||||
configDomain string
|
||||
requestHost string
|
||||
forwardedHost string
|
||||
expectedDomain string
|
||||
name string
|
||||
}{
|
||||
{
|
||||
name: "Configured domain takes precedence",
|
||||
configDomain: ".example.com",
|
||||
requestHost: "app.example.com",
|
||||
expectedDomain: ".example.com",
|
||||
},
|
||||
{
|
||||
name: "Auto-detection when no domain configured",
|
||||
configDomain: "",
|
||||
requestHost: "app.example.com",
|
||||
expectedDomain: "app.example.com",
|
||||
},
|
||||
{
|
||||
name: "X-Forwarded-Host used for auto-detection",
|
||||
configDomain: "",
|
||||
requestHost: "internal.local",
|
||||
forwardedHost: "public.example.com",
|
||||
expectedDomain: "public.example.com",
|
||||
},
|
||||
{
|
||||
name: "No domain for localhost",
|
||||
configDomain: "",
|
||||
requestHost: "localhost:8080",
|
||||
expectedDomain: "",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
// Create session manager with configured domain
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("test-encryption-key-32-characters", false, tt.configDomain, logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
|
||||
// Create request
|
||||
req := httptest.NewRequest("GET", "http://"+tt.requestHost+"/test", nil)
|
||||
if tt.forwardedHost != "" {
|
||||
req.Header.Set("X-Forwarded-Host", tt.forwardedHost)
|
||||
}
|
||||
|
||||
// Create a dummy response writer to test getCookieOptions behavior
|
||||
// We'll examine the session options domain instead
|
||||
options := &http.Cookie{
|
||||
Domain: sm.cookieDomain,
|
||||
}
|
||||
// If no configured domain, simulate auto-detection
|
||||
if sm.cookieDomain == "" && req != nil {
|
||||
host := req.Host
|
||||
if forwardedHost := req.Header.Get("X-Forwarded-Host"); forwardedHost != "" {
|
||||
host = forwardedHost
|
||||
}
|
||||
if host != "" && !strings.Contains(host, "localhost") && !strings.Contains(host, "127.0.0.1") {
|
||||
if colonIndex := strings.Index(host, ":"); colonIndex != -1 {
|
||||
host = host[:colonIndex]
|
||||
}
|
||||
options.Domain = host
|
||||
}
|
||||
}
|
||||
|
||||
// Check domain
|
||||
if options.Domain != tt.expectedDomain {
|
||||
t.Errorf("Expected domain %q, got %q", tt.expectedDomain, options.Domain)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestCookieDomainConsistency tests that all session cookies use the same domain
|
||||
func TestCookieDomainConsistency(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
|
||||
// Test with configured domain
|
||||
sm, err := NewSessionManager("test-encryption-key-32-characters", false, ".example.com", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
|
||||
req := httptest.NewRequest("GET", "http://app.example.com/test", nil)
|
||||
rr := httptest.NewRecorder()
|
||||
|
||||
// Get session and set some values
|
||||
session, err := sm.GetSession(req)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to get session: %v", err)
|
||||
}
|
||||
defer session.ReturnToPool()
|
||||
|
||||
// Set various session values including ID token
|
||||
session.SetNonce("test-nonce")
|
||||
session.SetAccessToken("test-access-token")
|
||||
session.SetRefreshToken("test-refresh-token")
|
||||
// Set a valid JWT-like ID token (needs 2 dots)
|
||||
session.SetIDToken("header.payload.signature")
|
||||
|
||||
// Save session
|
||||
err = session.Save(req, rr)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to save session: %v", err)
|
||||
}
|
||||
|
||||
// Check all cookies have the same domain
|
||||
cookies := rr.Result().Cookies()
|
||||
var seenDomain string
|
||||
|
||||
for _, cookie := range cookies {
|
||||
// Only check our OIDC cookies
|
||||
if strings.HasPrefix(cookie.Name, "_oidc_") ||
|
||||
strings.HasPrefix(cookie.Name, "access_token_chunk_") ||
|
||||
strings.HasPrefix(cookie.Name, "refresh_token_chunk_") {
|
||||
|
||||
// Normalize domain for comparison (handle leading dot and empty domain)
|
||||
normalizedDomain := cookie.Domain
|
||||
if normalizedDomain == "" {
|
||||
// Empty domain means host-only cookie, should match configured domain
|
||||
normalizedDomain = "example.com"
|
||||
} else if strings.HasPrefix(normalizedDomain, ".") {
|
||||
normalizedDomain = normalizedDomain[1:]
|
||||
}
|
||||
|
||||
if seenDomain == "" {
|
||||
seenDomain = normalizedDomain
|
||||
} else if normalizedDomain != seenDomain {
|
||||
t.Errorf("Inconsistent cookie domains: %q vs %q for cookie %s",
|
||||
seenDomain, normalizedDomain, cookie.Name)
|
||||
}
|
||||
|
||||
// Verify it matches configured domain (browsers may normalize by removing leading dot)
|
||||
// Empty domain is also acceptable for host-only cookies
|
||||
if cookie.Domain != "" && cookie.Domain != ".example.com" && cookie.Domain != "example.com" {
|
||||
t.Errorf("Cookie %s has domain %q, expected %q, %q, or empty",
|
||||
cookie.Name, cookie.Domain, ".example.com", "example.com")
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestCookieDomainWithReverseProxy simulates a reverse proxy scenario
|
||||
func TestCookieDomainWithReverseProxy(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
|
||||
// No configured domain, should auto-detect from X-Forwarded-Host
|
||||
sm, err := NewSessionManager("test-encryption-key-32-characters", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
|
||||
// Simulate reverse proxy request
|
||||
req := httptest.NewRequest("GET", "http://internal.local:8080/test", nil)
|
||||
req.Header.Set("X-Forwarded-Host", "public.example.com")
|
||||
req.Header.Set("X-Forwarded-Proto", "https")
|
||||
|
||||
// Test the domain configuration
|
||||
// Since getCookieOptions is private, we'll check the configured domain directly
|
||||
options := &http.Cookie{
|
||||
Domain: sm.cookieDomain,
|
||||
}
|
||||
// If no configured domain, simulate auto-detection
|
||||
if sm.cookieDomain == "" && req != nil {
|
||||
host := req.Host
|
||||
if forwardedHost := req.Header.Get("X-Forwarded-Host"); forwardedHost != "" {
|
||||
host = forwardedHost
|
||||
}
|
||||
if host != "" && !strings.Contains(host, "localhost") && !strings.Contains(host, "127.0.0.1") {
|
||||
if colonIndex := strings.Index(host, ":"); colonIndex != -1 {
|
||||
host = host[:colonIndex]
|
||||
}
|
||||
options.Domain = host
|
||||
}
|
||||
}
|
||||
|
||||
// Check secure flag based on X-Forwarded-Proto
|
||||
isSecure := req.Header.Get("X-Forwarded-Proto") == "https" || req.TLS != nil
|
||||
options.Secure = isSecure // Note: forceHTTPS is private so we can't access it in test
|
||||
|
||||
// Should use the forwarded host
|
||||
if options.Domain != "public.example.com" {
|
||||
t.Errorf("Expected domain from X-Forwarded-Host %q, got %q",
|
||||
"public.example.com", options.Domain)
|
||||
}
|
||||
|
||||
// Should be secure due to X-Forwarded-Proto
|
||||
if !options.Secure {
|
||||
t.Error("Expected Secure flag to be true with X-Forwarded-Proto: https")
|
||||
}
|
||||
}
|
||||
@@ -18,7 +18,7 @@ func TestCSRFTokenSessionManagement(t *testing.T) {
|
||||
// Test that CSRF tokens persist through the authentication flow
|
||||
t.Run("CSRF_Token_Persists_After_Selective_Clear", func(t *testing.T) {
|
||||
// Create a session manager
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Create initial request
|
||||
@@ -90,7 +90,7 @@ func TestCSRFTokenSessionManagement(t *testing.T) {
|
||||
|
||||
// Test that marking session as dirty forces save
|
||||
t.Run("Mark_Dirty_Forces_Session_Save", func(t *testing.T) {
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
req := httptest.NewRequest("GET", "http://example.com/test", nil)
|
||||
@@ -126,7 +126,7 @@ func TestCSRFTokenSessionManagement(t *testing.T) {
|
||||
|
||||
// Test Azure-specific session handling
|
||||
t.Run("Azure_Session_Cookie_Configuration", func(t *testing.T) {
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Simulate Azure callback scenario
|
||||
@@ -158,7 +158,7 @@ func TestCSRFTokenSessionManagement(t *testing.T) {
|
||||
|
||||
// Test session continuity through auth flow
|
||||
t.Run("Session_Continuity_Through_Auth_Flow", func(t *testing.T) {
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Step 1: Initial request
|
||||
@@ -199,7 +199,7 @@ func TestCSRFTokenSessionManagement(t *testing.T) {
|
||||
|
||||
// Test large token handling doesn't affect CSRF
|
||||
t.Run("Large_Tokens_Dont_Affect_CSRF", func(t *testing.T) {
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
req := httptest.NewRequest("GET", "http://example.com/test", nil)
|
||||
@@ -262,7 +262,7 @@ func TestAuthFlowWithoutExternalDependencies(t *testing.T) {
|
||||
|
||||
// We can't fully initialize TraefikOidc without network access,
|
||||
// but we can test the session management directly
|
||||
sessionManager, err := NewSessionManager(plugin.SessionEncryptionKey, plugin.ForceHTTPS, NewLogger(plugin.LogLevel))
|
||||
sessionManager, err := NewSessionManager(plugin.SessionEncryptionKey, plugin.ForceHTTPS, "", NewLogger(plugin.LogLevel))
|
||||
require.NoError(t, err)
|
||||
|
||||
t.Run("Session_Created_On_Protected_Request", func(t *testing.T) {
|
||||
@@ -291,7 +291,7 @@ func TestAuthFlowWithoutExternalDependencies(t *testing.T) {
|
||||
// TestRegressionLoginLoop specifically tests the fix for issue #53
|
||||
func TestRegressionLoginLoop(t *testing.T) {
|
||||
// This test verifies that the specific changes made to fix the login loop work correctly
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Simulate the exact flow that was causing the login loop
|
||||
@@ -392,7 +392,7 @@ func TestRegressionLoginLoop(t *testing.T) {
|
||||
|
||||
// TestCSRFValidationTiming tests timing-sensitive CSRF validation scenarios
|
||||
func TestCSRFValidationTiming(t *testing.T) {
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
t.Run("Rapid_Redirect_Maintains_CSRF", func(t *testing.T) {
|
||||
|
||||
@@ -43,7 +43,7 @@ func TestGoogleOIDCRefreshTokenHandling(t *testing.T) {
|
||||
}
|
||||
|
||||
// Create a session manager
|
||||
sessionManager, _ := NewSessionManager("0123456789abcdef0123456789abcdef", true, mockLogger)
|
||||
sessionManager, _ := NewSessionManager("0123456789abcdef0123456789abcdef", true, "", mockLogger)
|
||||
tOidc.sessionManager = sessionManager
|
||||
|
||||
t.Run("Google provider detection adds required parameters", func(t *testing.T) {
|
||||
@@ -367,7 +367,7 @@ func TestGoogleOIDCRefreshTokenHandling(t *testing.T) {
|
||||
}
|
||||
|
||||
// Create a session manager
|
||||
sessionManager, _ := NewSessionManager("0123456789abcdef0123456789abcdef", true, mockLogger)
|
||||
sessionManager, _ := NewSessionManager("0123456789abcdef0123456789abcdef", true, "", mockLogger)
|
||||
googleTOidc.sessionManager = sessionManager
|
||||
|
||||
// Create a mock token verifier
|
||||
|
||||
@@ -64,15 +64,37 @@ func (r *ProviderRegistry) ClearCache() {
|
||||
// DetectProvider determines the most appropriate provider for a given issuer URL.
|
||||
// It iterates through the registered providers and returns the first one that matches.
|
||||
// Detection is based on URL patterns and other provider-specific criteria.
|
||||
// Uses double-checked locking pattern to avoid race conditions while caching results.
|
||||
func (r *ProviderRegistry) DetectProvider(issuerURL string) OIDCProvider {
|
||||
// First check: read lock for cache lookup
|
||||
r.mu.RLock()
|
||||
defer r.mu.RUnlock()
|
||||
if provider, found := r.cache[issuerURL]; found {
|
||||
r.mu.RUnlock()
|
||||
return provider
|
||||
}
|
||||
r.mu.RUnlock()
|
||||
|
||||
// Check cache first for performance
|
||||
// Cache miss - acquire write lock for detection and caching
|
||||
r.mu.Lock()
|
||||
defer r.mu.Unlock()
|
||||
|
||||
// Second check: another goroutine might have cached the result while we waited for write lock
|
||||
if provider, found := r.cache[issuerURL]; found {
|
||||
return provider
|
||||
}
|
||||
|
||||
// Perform detection under write lock
|
||||
detectedProvider := r.detectProviderUnsafe(issuerURL)
|
||||
|
||||
// Cache the result (even if nil to avoid repeated expensive operations)
|
||||
r.cache[issuerURL] = detectedProvider
|
||||
|
||||
return detectedProvider
|
||||
}
|
||||
|
||||
// detectProviderUnsafe performs the actual provider detection logic.
|
||||
// This method assumes the caller holds the appropriate lock and should not be called directly.
|
||||
func (r *ProviderRegistry) detectProviderUnsafe(issuerURL string) OIDCProvider {
|
||||
// Normalize issuer URL for consistent matching
|
||||
normalizedURL, err := url.Parse(issuerURL)
|
||||
if err != nil {
|
||||
@@ -86,12 +108,10 @@ func (r *ProviderRegistry) DetectProvider(issuerURL string) OIDCProvider {
|
||||
switch p.GetType() {
|
||||
case ProviderTypeGoogle:
|
||||
if strings.Contains(host, "accounts.google.com") {
|
||||
r.cache[issuerURL] = p
|
||||
return p
|
||||
}
|
||||
case ProviderTypeAzure:
|
||||
if strings.Contains(host, "login.microsoftonline.com") || strings.Contains(host, "sts.windows.net") {
|
||||
r.cache[issuerURL] = p
|
||||
return p
|
||||
}
|
||||
}
|
||||
@@ -100,7 +120,6 @@ func (r *ProviderRegistry) DetectProvider(issuerURL string) OIDCProvider {
|
||||
// Fallback to the generic provider if no specific provider is detected
|
||||
for _, p := range r.providers {
|
||||
if p.GetType() == ProviderTypeGeneric {
|
||||
r.cache[issuerURL] = p
|
||||
return p
|
||||
}
|
||||
}
|
||||
|
||||
@@ -20,7 +20,7 @@ func TestIssue53Regression(t *testing.T) {
|
||||
// 3. Session cookies must be properly configured for HTTPS
|
||||
// 4. CSRF token must persist through the OAuth flow
|
||||
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Step 1: Initial request to protected resource
|
||||
@@ -108,7 +108,7 @@ func TestIssue53Regression(t *testing.T) {
|
||||
// This test ensures that once the session is properly maintained,
|
||||
// token signature verification works correctly for Azure tokens
|
||||
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Create authenticated session with Azure tokens
|
||||
@@ -154,7 +154,7 @@ func TestIssue53Regression(t *testing.T) {
|
||||
// This test verifies the redirect loop prevention mechanism
|
||||
// that was added to handle authentication failures gracefully
|
||||
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
req := httptest.NewRequest("GET", "http://internal/protected", nil)
|
||||
@@ -183,7 +183,7 @@ func TestIssue53Regression(t *testing.T) {
|
||||
// in different reverse proxy scenarios
|
||||
func TestReverseProxySameSiteHandling(t *testing.T) {
|
||||
t.Run("SameSite_Lax_For_HTTPS_OAuth", func(t *testing.T) {
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// HTTPS request via proxy
|
||||
@@ -211,7 +211,7 @@ func TestReverseProxySameSiteHandling(t *testing.T) {
|
||||
})
|
||||
|
||||
t.Run("SameSite_Lax_For_HTTP", func(t *testing.T) {
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Plain HTTP request (no proxy headers)
|
||||
|
||||
@@ -36,27 +36,27 @@ func createDefaultHTTPClient() *http.Client {
|
||||
Proxy: http.ProxyFromEnvironment,
|
||||
DialContext: func(ctx context.Context, network, addr string) (net.Conn, error) {
|
||||
dialer := &net.Dialer{
|
||||
Timeout: 10 * time.Second, // Connection timeout for faster failure detection
|
||||
KeepAlive: 30 * time.Second, // Keep-alive interval for connection reuse
|
||||
Timeout: 5 * time.Second, // Reduced connection timeout for faster failure detection
|
||||
KeepAlive: 15 * time.Second, // Reduced keep-alive interval for connection reuse
|
||||
}
|
||||
return dialer.DialContext(ctx, network, addr)
|
||||
},
|
||||
ForceAttemptHTTP2: true,
|
||||
TLSHandshakeTimeout: 3 * time.Second, // TLS handshake timeout
|
||||
TLSHandshakeTimeout: 2 * time.Second, // Reduced TLS handshake timeout
|
||||
ExpectContinueTimeout: 1 * time.Second, // Timeout for 100-continue responses
|
||||
MaxIdleConns: 10, // Reduced from 20 to prevent memory buildup
|
||||
MaxIdleConnsPerHost: 2, // Reduced from 5 to limit per-host connections
|
||||
IdleConnTimeout: 30 * time.Second, // Reduced from 60 to close idle connections faster
|
||||
MaxIdleConns: 5, // Further reduced to prevent connection accumulation
|
||||
MaxIdleConnsPerHost: 1, // Further reduced to limit per-host connections
|
||||
IdleConnTimeout: 15 * time.Second, // Further reduced to close idle connections faster
|
||||
DisableKeepAlives: false, // Enable connection reuse
|
||||
MaxConnsPerHost: 10, // Reduced from 20 to limit concurrent connections
|
||||
ResponseHeaderTimeout: 5 * time.Second, // Timeout for reading response headers
|
||||
MaxConnsPerHost: 5, // Further reduced to limit concurrent connections
|
||||
ResponseHeaderTimeout: 3 * time.Second, // Reduced timeout for reading response headers
|
||||
DisableCompression: false, // Enable compression for bandwidth efficiency
|
||||
WriteBufferSize: 4096, // Write buffer size for connections
|
||||
ReadBufferSize: 4096, // Read buffer size for connections
|
||||
}
|
||||
|
||||
return &http.Client{
|
||||
Timeout: time.Second * 10, // HTTP client timeout
|
||||
Timeout: time.Second * 5, // Reduced HTTP client timeout to prevent hanging connections
|
||||
Transport: transport,
|
||||
CheckRedirect: func(req *http.Request, via []*http.Request) error {
|
||||
// Limit redirects to prevent redirect loops
|
||||
@@ -124,7 +124,7 @@ type CacheManager struct {
|
||||
// It initializes all cache types on first call with appropriate default settings.
|
||||
// This ensures thread-safe initialization and consistent cache behavior across
|
||||
// the entire application lifecycle.
|
||||
func GetGlobalCacheManager() *CacheManager {
|
||||
func GetGlobalCacheManager(wg *sync.WaitGroup) *CacheManager {
|
||||
cacheManagerOnce.Do(func() {
|
||||
globalCacheManager = &CacheManager{
|
||||
tokenBlacklist: func() *Cache {
|
||||
@@ -133,7 +133,7 @@ func GetGlobalCacheManager() *CacheManager {
|
||||
return c
|
||||
}(),
|
||||
tokenCache: NewTokenCache(),
|
||||
metadataCache: NewMetadataCache(),
|
||||
metadataCache: NewMetadataCache(wg),
|
||||
jwkCache: &JWKCache{},
|
||||
}
|
||||
})
|
||||
@@ -283,7 +283,7 @@ type TraefikOidc struct {
|
||||
issuerURL string
|
||||
revocationURL string
|
||||
scopes []string
|
||||
goroutineWG sync.WaitGroup
|
||||
goroutineWG *sync.WaitGroup
|
||||
refreshGracePeriod time.Duration
|
||||
shutdownOnce sync.Once
|
||||
forceHTTPS bool
|
||||
@@ -690,13 +690,15 @@ func New(ctx context.Context, next http.Handler, config *Config, name string) (h
|
||||
} else {
|
||||
httpClient = createDefaultHTTPClient()
|
||||
}
|
||||
cacheManager := GetGlobalCacheManager()
|
||||
goroutineWG := &sync.WaitGroup{}
|
||||
cacheManager := GetGlobalCacheManager(goroutineWG)
|
||||
|
||||
pluginCtx, cancelFunc := context.WithCancel(context.Background())
|
||||
|
||||
t := &TraefikOidc{
|
||||
next: next,
|
||||
name: name,
|
||||
goroutineWG: goroutineWG,
|
||||
redirURLPath: config.CallbackURL,
|
||||
logoutURLPath: func() string {
|
||||
if config.LogoutURL == "" {
|
||||
@@ -756,7 +758,7 @@ func New(ctx context.Context, next http.Handler, config *Config, name string) (h
|
||||
suppressDiagnosticLogs: isTestMode(), // Suppress diagnostic logs during tests
|
||||
}
|
||||
|
||||
t.sessionManager, _ = NewSessionManager(config.SessionEncryptionKey, config.ForceHTTPS, t.logger)
|
||||
t.sessionManager, _ = NewSessionManager(config.SessionEncryptionKey, config.ForceHTTPS, config.CookieDomain, t.logger)
|
||||
t.errorRecoveryManager = NewErrorRecoveryManager(t.logger)
|
||||
t.extractClaimsFunc = extractClaims
|
||||
// t.exchangeCodeForTokenFunc = t.exchangeCodeForToken // Removed, using interface now
|
||||
@@ -1087,6 +1089,10 @@ func (t *TraefikOidc) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
|
||||
return
|
||||
}
|
||||
|
||||
// Clean up any old cookies with different domains before processing
|
||||
// This prevents CSRF token mismatch errors when cookie domain configuration changes
|
||||
t.sessionManager.CleanupOldCookies(rw, req)
|
||||
|
||||
// Retrieve or create session for request
|
||||
session, err := t.sessionManager.GetSession(req)
|
||||
if err != nil {
|
||||
|
||||
+4
-4
@@ -90,7 +90,7 @@ func (ts *TestSuite) Setup() {
|
||||
}
|
||||
|
||||
logger := NewLogger("info")
|
||||
ts.sessionManager, _ = NewSessionManager("test-secret-key-that-is-at-least-32-bytes", false, logger)
|
||||
ts.sessionManager, _ = NewSessionManager("test-secret-key-that-is-at-least-32-bytes", false, "", logger)
|
||||
|
||||
// Common TraefikOidc instance
|
||||
ts.tOidc = &TraefikOidc{
|
||||
@@ -1173,7 +1173,7 @@ func TestHandleCallback(t *testing.T) {
|
||||
ts.tOidc.tokenBlacklist = NewCache() // Use generic cache for blacklist
|
||||
|
||||
logger := NewLogger("info")
|
||||
sessionManager, _ := NewSessionManager("test-secret-key-that-is-at-least-32-bytes", false, logger)
|
||||
sessionManager, _ := NewSessionManager("test-secret-key-that-is-at-least-32-bytes", false, "", logger)
|
||||
|
||||
// Create a new instance for each test to avoid state carryover
|
||||
instanceExtractClaimsFunc := tc.extractClaimsFunc
|
||||
@@ -1561,7 +1561,7 @@ func TestHandleLogout(t *testing.T) {
|
||||
for _, tc := range tests {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
logger := NewLogger("info")
|
||||
sessionManager, _ := NewSessionManager("test-secret-key-that-is-at-least-32-bytes", false, logger)
|
||||
sessionManager, _ := NewSessionManager("test-secret-key-that-is-at-least-32-bytes", false, "", logger)
|
||||
tOidc := &TraefikOidc{
|
||||
revocationURL: mockRevocationServer.URL,
|
||||
endSessionURL: tc.endSessionURL,
|
||||
@@ -1863,7 +1863,7 @@ func TestHandleExpiredToken(t *testing.T) {
|
||||
for _, tc := range tests {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
logger := NewLogger("info")
|
||||
sessionManager, _ := NewSessionManager("test-secret-key-that-is-at-least-32-bytes", false, logger)
|
||||
sessionManager, _ := NewSessionManager("test-secret-key-that-is-at-least-32-bytes", false, "", logger)
|
||||
|
||||
tOidc := &TraefikOidc{
|
||||
sessionManager: sessionManager,
|
||||
|
||||
+3
-3
@@ -48,7 +48,7 @@ func TestMemoryLeakFixes(t *testing.T) {
|
||||
|
||||
t.Run("Global cache manager cleanup", func(t *testing.T) {
|
||||
// Get the global cache manager
|
||||
cm := GetGlobalCacheManager()
|
||||
cm := GetGlobalCacheManager(nil)
|
||||
if cm == nil {
|
||||
t.Fatal("Failed to get global cache manager")
|
||||
}
|
||||
@@ -64,7 +64,7 @@ func TestMemoryLeakFixes(t *testing.T) {
|
||||
}
|
||||
|
||||
// Verify it can be re-initialized
|
||||
cm2 := GetGlobalCacheManager()
|
||||
cm2 := GetGlobalCacheManager(nil)
|
||||
if cm2 == nil {
|
||||
t.Fatal("Failed to re-initialize global cache manager")
|
||||
}
|
||||
@@ -72,7 +72,7 @@ func TestMemoryLeakFixes(t *testing.T) {
|
||||
|
||||
t.Run("Session pool returns properly", func(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("test-encryption-key-that-is-long-enough-32bytes", false, logger)
|
||||
sm, err := NewSessionManager("test-encryption-key-that-is-long-enough-32bytes", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
+8
-4
@@ -19,16 +19,18 @@ type MetadataCache struct {
|
||||
logger *Logger
|
||||
autoCleanupInterval time.Duration
|
||||
mutex sync.RWMutex
|
||||
wg *sync.WaitGroup
|
||||
stopChan chan struct{}
|
||||
}
|
||||
|
||||
// NewMetadataCache creates a new MetadataCache instance.
|
||||
// It initializes the cache structure and starts the background cleanup task.
|
||||
func NewMetadataCache() *MetadataCache {
|
||||
return NewMetadataCacheWithLogger(nil)
|
||||
func NewMetadataCache(wg *sync.WaitGroup) *MetadataCache {
|
||||
return NewMetadataCacheWithLogger(wg, nil)
|
||||
}
|
||||
|
||||
// NewMetadataCacheWithLogger creates a new MetadataCache with a specified logger.
|
||||
func NewMetadataCacheWithLogger(logger *Logger) *MetadataCache {
|
||||
func NewMetadataCacheWithLogger(wg *sync.WaitGroup, logger *Logger) *MetadataCache {
|
||||
if logger == nil {
|
||||
logger = newNoOpLogger()
|
||||
}
|
||||
@@ -36,6 +38,8 @@ func NewMetadataCacheWithLogger(logger *Logger) *MetadataCache {
|
||||
c := &MetadataCache{
|
||||
autoCleanupInterval: 5 * time.Minute,
|
||||
logger: logger,
|
||||
wg: wg,
|
||||
stopChan: make(chan struct{}),
|
||||
}
|
||||
c.startAutoCleanup()
|
||||
return c
|
||||
@@ -200,7 +204,7 @@ func (c *MetadataCache) GetMetadata(providerURL string, httpClient *http.Client,
|
||||
// startAutoCleanup starts the background task that periodically calls Cleanup
|
||||
// to remove expired metadata from the cache.
|
||||
func (c *MetadataCache) startAutoCleanup() {
|
||||
c.cleanupTask = NewBackgroundTask("metadata-cache-cleanup", c.autoCleanupInterval, c.Cleanup, c.logger)
|
||||
c.cleanupTask = NewBackgroundTask("metadata-cache-cleanup", c.autoCleanupInterval, c.Cleanup, c.logger, c.wg)
|
||||
c.cleanupTask.Start()
|
||||
}
|
||||
|
||||
|
||||
+852
@@ -0,0 +1,852 @@
|
||||
package traefikoidc
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"runtime"
|
||||
"runtime/pprof"
|
||||
"sync"
|
||||
"time"
|
||||
)
|
||||
|
||||
// MemoryProfiler defines the interface for memory profiling operations
|
||||
type MemoryProfiler interface {
|
||||
// TakeSnapshot captures current memory statistics
|
||||
TakeSnapshot() (*MemorySnapshot, error)
|
||||
|
||||
// StartProfiling begins memory profiling with specified configuration
|
||||
StartProfiling(config ProfilingConfig) error
|
||||
|
||||
// StopProfiling ends memory profiling and returns final snapshot
|
||||
StopProfiling() (*MemorySnapshot, error)
|
||||
|
||||
// GetCurrentStats returns current runtime memory statistics
|
||||
GetCurrentStats() *runtime.MemStats
|
||||
|
||||
// AnalyzeLeaks performs leak detection analysis
|
||||
AnalyzeLeaks(baseline, current *MemorySnapshot) *LeakAnalysis
|
||||
}
|
||||
|
||||
// MemorySnapshot represents a point-in-time capture of memory statistics
|
||||
type MemorySnapshot struct {
|
||||
Timestamp time.Time
|
||||
RuntimeStats runtime.MemStats
|
||||
HeapProfile []byte
|
||||
GoroutineProfile []byte
|
||||
CustomMetrics map[string]interface{}
|
||||
}
|
||||
|
||||
// LeakAnalysis contains the results of memory leak detection
|
||||
type LeakAnalysis struct {
|
||||
HasLeak bool
|
||||
LeakDescription string
|
||||
MemoryIncrease uint64
|
||||
GoroutineIncrease int
|
||||
SuspectedLeaks []string
|
||||
Recommendations []string
|
||||
}
|
||||
|
||||
// ProfilingManager coordinates memory profiling operations
|
||||
type ProfilingManager struct {
|
||||
mu sync.RWMutex
|
||||
isProfiling bool
|
||||
startTime time.Time
|
||||
baselineSnapshot *MemorySnapshot
|
||||
config ProfilingConfig
|
||||
logger *Logger
|
||||
profilers map[string]MemoryProfiler
|
||||
}
|
||||
|
||||
// ProfilingConfig contains configuration for profiling operations
|
||||
type ProfilingConfig struct {
|
||||
EnableHeapProfiling bool
|
||||
EnableGoroutineProfiling bool
|
||||
SnapshotInterval time.Duration
|
||||
LeakThresholdMB uint64
|
||||
MaxSnapshots int
|
||||
EnableContinuousMonitoring bool
|
||||
MonitoringInterval time.Duration
|
||||
}
|
||||
|
||||
// LeakDetectionConfig contains configuration for leak detection
|
||||
type LeakDetectionConfig struct {
|
||||
EnableLeakDetection bool
|
||||
LeakThresholdMB uint64
|
||||
GoroutineLeakThreshold int
|
||||
SessionPoolThreshold int
|
||||
CacheMemoryThreshold uint64
|
||||
HTTPClientThreshold int
|
||||
TokenCompressionThreshold uint64
|
||||
}
|
||||
|
||||
// NewProfilingManager creates a new profiling manager instance
|
||||
func NewProfilingManager(logger *Logger) *ProfilingManager {
|
||||
if logger == nil {
|
||||
logger = newNoOpLogger()
|
||||
}
|
||||
|
||||
return &ProfilingManager{
|
||||
profilers: make(map[string]MemoryProfiler),
|
||||
config: ProfilingConfig{
|
||||
EnableHeapProfiling: true,
|
||||
EnableGoroutineProfiling: true,
|
||||
SnapshotInterval: 30 * time.Second,
|
||||
LeakThresholdMB: 50, // 50MB
|
||||
MaxSnapshots: 100,
|
||||
EnableContinuousMonitoring: true,
|
||||
MonitoringInterval: 60 * time.Second,
|
||||
},
|
||||
logger: logger,
|
||||
}
|
||||
}
|
||||
|
||||
// TakeSnapshot captures current memory statistics
|
||||
func (pm *ProfilingManager) TakeSnapshot() (*MemorySnapshot, error) {
|
||||
var buf bytes.Buffer
|
||||
snapshot := &MemorySnapshot{
|
||||
Timestamp: time.Now(),
|
||||
CustomMetrics: make(map[string]interface{}),
|
||||
}
|
||||
|
||||
// Capture runtime memory statistics
|
||||
runtime.ReadMemStats(&snapshot.RuntimeStats)
|
||||
|
||||
// Capture heap profile if enabled
|
||||
if pm.config.EnableHeapProfiling {
|
||||
if err := pprof.WriteHeapProfile(&buf); err != nil {
|
||||
pm.logger.Errorf("Failed to capture heap profile: %v", err)
|
||||
} else {
|
||||
snapshot.HeapProfile = make([]byte, buf.Len())
|
||||
copy(snapshot.HeapProfile, buf.Bytes())
|
||||
buf.Reset()
|
||||
}
|
||||
}
|
||||
|
||||
// Capture goroutine profile if enabled
|
||||
if pm.config.EnableGoroutineProfiling {
|
||||
if err := pprof.Lookup("goroutine").WriteTo(&buf, 0); err != nil {
|
||||
pm.logger.Errorf("Failed to capture goroutine profile: %v", err)
|
||||
} else {
|
||||
snapshot.GoroutineProfile = make([]byte, buf.Len())
|
||||
copy(snapshot.GoroutineProfile, buf.Bytes())
|
||||
buf.Reset()
|
||||
}
|
||||
}
|
||||
|
||||
// Capture custom metrics from registered profilers
|
||||
pm.mu.RLock()
|
||||
for name, profiler := range pm.profilers {
|
||||
if customStats := profiler.GetCurrentStats(); customStats != nil {
|
||||
snapshot.CustomMetrics[name] = customStats
|
||||
}
|
||||
}
|
||||
pm.mu.RUnlock()
|
||||
|
||||
return snapshot, nil
|
||||
}
|
||||
|
||||
// StartProfiling begins memory profiling with specified configuration
|
||||
func (pm *ProfilingManager) StartProfiling(config ProfilingConfig) error {
|
||||
pm.mu.Lock()
|
||||
defer pm.mu.Unlock()
|
||||
|
||||
if pm.isProfiling {
|
||||
return fmt.Errorf("profiling already in progress")
|
||||
}
|
||||
|
||||
pm.config = config
|
||||
pm.isProfiling = true
|
||||
pm.startTime = time.Now()
|
||||
|
||||
// Take baseline snapshot
|
||||
baseline, err := pm.TakeSnapshot()
|
||||
if err != nil {
|
||||
pm.isProfiling = false
|
||||
return fmt.Errorf("failed to take baseline snapshot: %w", err)
|
||||
}
|
||||
pm.baselineSnapshot = baseline
|
||||
|
||||
pm.logger.Infof("Memory profiling started at %v", pm.startTime)
|
||||
return nil
|
||||
}
|
||||
|
||||
// StopProfiling ends memory profiling and returns final snapshot
|
||||
func (pm *ProfilingManager) StopProfiling() (*MemorySnapshot, error) {
|
||||
pm.mu.Lock()
|
||||
defer pm.mu.Unlock()
|
||||
|
||||
if !pm.isProfiling {
|
||||
return nil, fmt.Errorf("profiling not in progress")
|
||||
}
|
||||
|
||||
// Take final snapshot
|
||||
finalSnapshot, err := pm.TakeSnapshot()
|
||||
if err != nil {
|
||||
pm.logger.Errorf("Failed to take final snapshot: %v", err)
|
||||
}
|
||||
|
||||
pm.isProfiling = false
|
||||
duration := time.Since(pm.startTime)
|
||||
|
||||
pm.logger.Infof("Memory profiling stopped after %v", duration)
|
||||
return finalSnapshot, err
|
||||
}
|
||||
|
||||
// GetCurrentStats returns current runtime memory statistics
|
||||
func (pm *ProfilingManager) GetCurrentStats() *runtime.MemStats {
|
||||
stats := &runtime.MemStats{}
|
||||
runtime.ReadMemStats(stats)
|
||||
return stats
|
||||
}
|
||||
|
||||
// AnalyzeLeaks performs leak detection analysis
|
||||
func (pm *ProfilingManager) AnalyzeLeaks(baseline, current *MemorySnapshot) *LeakAnalysis {
|
||||
analysis := &LeakAnalysis{
|
||||
SuspectedLeaks: make([]string, 0),
|
||||
Recommendations: make([]string, 0),
|
||||
}
|
||||
|
||||
if baseline == nil || current == nil {
|
||||
analysis.HasLeak = false
|
||||
analysis.LeakDescription = "Insufficient data for leak analysis"
|
||||
return analysis
|
||||
}
|
||||
|
||||
// Calculate memory increase
|
||||
memoryIncrease := current.RuntimeStats.Alloc - baseline.RuntimeStats.Alloc
|
||||
analysis.MemoryIncrease = memoryIncrease
|
||||
|
||||
// Calculate goroutine increase
|
||||
currentGoroutines := runtime.NumGoroutine()
|
||||
baselineGoroutines := runtime.NumGoroutine() // Note: This is not accurate for baseline, but we don't have historical data
|
||||
goroutineIncrease := currentGoroutines - baselineGoroutines
|
||||
analysis.GoroutineIncrease = goroutineIncrease
|
||||
|
||||
// Check for memory leaks
|
||||
memoryThreshold := pm.config.LeakThresholdMB * 1024 * 1024 // Convert MB to bytes
|
||||
if memoryIncrease > memoryThreshold {
|
||||
analysis.HasLeak = true
|
||||
analysis.SuspectedLeaks = append(analysis.SuspectedLeaks,
|
||||
fmt.Sprintf("Memory usage increased by %.2f MB", float64(memoryIncrease)/(1024*1024)))
|
||||
analysis.Recommendations = append(analysis.Recommendations,
|
||||
"Consider checking for unreleased memory pools or growing caches")
|
||||
}
|
||||
|
||||
// Check for goroutine leaks
|
||||
if goroutineIncrease > 10 { // Arbitrary threshold
|
||||
analysis.HasLeak = true
|
||||
analysis.SuspectedLeaks = append(analysis.SuspectedLeaks,
|
||||
fmt.Sprintf("Goroutine count increased by %d", goroutineIncrease))
|
||||
analysis.Recommendations = append(analysis.Recommendations,
|
||||
"Check for goroutines that are not being properly cleaned up")
|
||||
}
|
||||
|
||||
if analysis.HasLeak {
|
||||
analysis.LeakDescription = fmt.Sprintf("Potential memory leak detected: %s",
|
||||
fmt.Sprintf("%.2f MB increase, %d goroutines", float64(memoryIncrease)/(1024*1024), goroutineIncrease))
|
||||
} else {
|
||||
analysis.LeakDescription = "No significant memory leaks detected"
|
||||
}
|
||||
|
||||
return analysis
|
||||
}
|
||||
|
||||
// RegisterProfiler registers a component-specific profiler
|
||||
func (pm *ProfilingManager) RegisterProfiler(name string, profiler MemoryProfiler) {
|
||||
pm.mu.Lock()
|
||||
defer pm.mu.Unlock()
|
||||
pm.profilers[name] = profiler
|
||||
pm.logger.Debugf("Registered profiler: %s", name)
|
||||
}
|
||||
|
||||
// UnregisterProfiler removes a component-specific profiler
|
||||
func (pm *ProfilingManager) UnregisterProfiler(name string) {
|
||||
pm.mu.Lock()
|
||||
defer pm.mu.Unlock()
|
||||
delete(pm.profilers, name)
|
||||
pm.logger.Debugf("Unregistered profiler: %s", name)
|
||||
}
|
||||
|
||||
// GetRegisteredProfilers returns list of registered profiler names
|
||||
func (pm *ProfilingManager) GetRegisteredProfilers() []string {
|
||||
pm.mu.RLock()
|
||||
defer pm.mu.RUnlock()
|
||||
|
||||
names := make([]string, 0, len(pm.profilers))
|
||||
for name := range pm.profilers {
|
||||
names = append(names, name)
|
||||
}
|
||||
return names
|
||||
}
|
||||
|
||||
// MemoryTestOrchestrator coordinates memory leak testing across components
|
||||
type MemoryTestOrchestrator struct {
|
||||
mu sync.RWMutex
|
||||
profilers map[string]MemoryProfiler
|
||||
config LeakDetectionConfig
|
||||
logger *Logger
|
||||
isRunning bool
|
||||
stopChan chan struct{}
|
||||
testResults map[string]*LeakAnalysis
|
||||
}
|
||||
|
||||
// NewMemoryTestOrchestrator creates a new test orchestrator
|
||||
func NewMemoryTestOrchestrator(config LeakDetectionConfig, logger *Logger) *MemoryTestOrchestrator {
|
||||
if logger == nil {
|
||||
logger = newNoOpLogger()
|
||||
}
|
||||
|
||||
return &MemoryTestOrchestrator{
|
||||
profilers: make(map[string]MemoryProfiler),
|
||||
config: config,
|
||||
logger: logger,
|
||||
stopChan: make(chan struct{}),
|
||||
testResults: make(map[string]*LeakAnalysis),
|
||||
}
|
||||
}
|
||||
|
||||
// RegisterComponent registers a component for memory leak testing
|
||||
func (mto *MemoryTestOrchestrator) RegisterComponent(name string, profiler MemoryProfiler) {
|
||||
mto.mu.Lock()
|
||||
defer mto.mu.Unlock()
|
||||
mto.profilers[name] = profiler
|
||||
mto.logger.Debugf("Registered component for leak testing: %s", name)
|
||||
}
|
||||
|
||||
// UnregisterComponent removes a component from leak testing
|
||||
func (mto *MemoryTestOrchestrator) UnregisterComponent(name string) {
|
||||
mto.mu.Lock()
|
||||
defer mto.mu.Unlock()
|
||||
delete(mto.profilers, name)
|
||||
delete(mto.testResults, name)
|
||||
mto.logger.Debugf("Unregistered component from leak testing: %s", name)
|
||||
}
|
||||
|
||||
// StartLeakDetection begins continuous leak detection monitoring
|
||||
func (mto *MemoryTestOrchestrator) StartLeakDetection() error {
|
||||
mto.mu.Lock()
|
||||
defer mto.mu.Unlock()
|
||||
|
||||
if mto.isRunning {
|
||||
return fmt.Errorf("leak detection already running")
|
||||
}
|
||||
|
||||
if !mto.config.EnableLeakDetection {
|
||||
return fmt.Errorf("leak detection is disabled in configuration")
|
||||
}
|
||||
|
||||
mto.isRunning = true
|
||||
go mto.runLeakDetection()
|
||||
|
||||
mto.logger.Infof("Memory leak detection started")
|
||||
return nil
|
||||
}
|
||||
|
||||
// StopLeakDetection stops continuous leak detection monitoring
|
||||
func (mto *MemoryTestOrchestrator) StopLeakDetection() error {
|
||||
mto.mu.Lock()
|
||||
defer mto.mu.Unlock()
|
||||
|
||||
if !mto.isRunning {
|
||||
return fmt.Errorf("leak detection not running")
|
||||
}
|
||||
|
||||
mto.isRunning = false
|
||||
close(mto.stopChan)
|
||||
mto.stopChan = make(chan struct{}) // Reset for potential restart
|
||||
|
||||
mto.logger.Infof("Memory leak detection stopped")
|
||||
return nil
|
||||
}
|
||||
|
||||
// runLeakDetection performs continuous leak detection monitoring
|
||||
func (mto *MemoryTestOrchestrator) runLeakDetection() {
|
||||
ticker := time.NewTicker(5 * time.Minute) // Check every 5 minutes
|
||||
defer ticker.Stop()
|
||||
|
||||
baselineSnapshots := make(map[string]*MemorySnapshot)
|
||||
|
||||
// Take initial baseline snapshots
|
||||
mto.mu.RLock()
|
||||
for name, profiler := range mto.profilers {
|
||||
if snapshot, err := profiler.TakeSnapshot(); err == nil {
|
||||
baselineSnapshots[name] = snapshot
|
||||
}
|
||||
}
|
||||
mto.mu.RUnlock()
|
||||
|
||||
for {
|
||||
select {
|
||||
case <-ticker.C:
|
||||
mto.performLeakCheck(baselineSnapshots)
|
||||
case <-mto.stopChan:
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// performLeakCheck performs leak detection for all registered components
|
||||
func (mto *MemoryTestOrchestrator) performLeakCheck(baselineSnapshots map[string]*MemorySnapshot) {
|
||||
mto.mu.RLock()
|
||||
defer mto.mu.RUnlock()
|
||||
|
||||
for name, profiler := range mto.profilers {
|
||||
baseline, exists := baselineSnapshots[name]
|
||||
if !exists {
|
||||
continue
|
||||
}
|
||||
|
||||
current, err := profiler.TakeSnapshot()
|
||||
if err != nil {
|
||||
mto.logger.Errorf("Failed to take snapshot for component %s: %v", name, err)
|
||||
continue
|
||||
}
|
||||
|
||||
analysis := profiler.AnalyzeLeaks(baseline, current)
|
||||
if analysis.HasLeak {
|
||||
mto.logger.Errorf("Memory leak detected in component %s: %s", name, analysis.LeakDescription)
|
||||
for _, rec := range analysis.Recommendations {
|
||||
mto.logger.Errorf("Recommendation for %s: %s", name, rec)
|
||||
}
|
||||
}
|
||||
|
||||
mto.testResults[name] = analysis
|
||||
}
|
||||
}
|
||||
|
||||
// GetLeakAnalysis returns leak analysis for a specific component
|
||||
func (mto *MemoryTestOrchestrator) GetLeakAnalysis(componentName string) (*LeakAnalysis, bool) {
|
||||
mto.mu.RLock()
|
||||
defer mto.mu.RUnlock()
|
||||
analysis, exists := mto.testResults[componentName]
|
||||
return analysis, exists
|
||||
}
|
||||
|
||||
// GetAllLeakAnalyses returns leak analyses for all components
|
||||
func (mto *MemoryTestOrchestrator) GetAllLeakAnalyses() map[string]*LeakAnalysis {
|
||||
mto.mu.RLock()
|
||||
defer mto.mu.RUnlock()
|
||||
|
||||
results := make(map[string]*LeakAnalysis)
|
||||
for name, analysis := range mto.testResults {
|
||||
results[name] = analysis
|
||||
}
|
||||
return results
|
||||
}
|
||||
|
||||
// Component-specific profiler implementations
|
||||
|
||||
// SessionPoolProfiler monitors session pool memory usage
|
||||
type SessionPoolProfiler struct {
|
||||
sessionManager *SessionManager
|
||||
logger *Logger
|
||||
}
|
||||
|
||||
// NewSessionPoolProfiler creates a new session pool profiler
|
||||
func NewSessionPoolProfiler(sm *SessionManager, logger *Logger) *SessionPoolProfiler {
|
||||
if logger == nil {
|
||||
logger = newNoOpLogger()
|
||||
}
|
||||
return &SessionPoolProfiler{
|
||||
sessionManager: sm,
|
||||
logger: logger,
|
||||
}
|
||||
}
|
||||
|
||||
// TakeSnapshot captures session pool memory statistics
|
||||
func (spp *SessionPoolProfiler) TakeSnapshot() (*MemorySnapshot, error) {
|
||||
snapshot := &MemorySnapshot{
|
||||
Timestamp: time.Now(),
|
||||
CustomMetrics: make(map[string]interface{}),
|
||||
}
|
||||
|
||||
// Capture runtime stats
|
||||
runtime.ReadMemStats(&snapshot.RuntimeStats)
|
||||
|
||||
// Add session pool specific metrics
|
||||
snapshot.CustomMetrics["session_pool_metrics"] = spp.sessionManager.GetSessionMetrics()
|
||||
|
||||
return snapshot, nil
|
||||
}
|
||||
|
||||
// StartProfiling begins profiling (no-op for session pools)
|
||||
func (spp *SessionPoolProfiler) StartProfiling(config ProfilingConfig) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// StopProfiling ends profiling (no-op for session pools)
|
||||
func (spp *SessionPoolProfiler) StopProfiling() (*MemorySnapshot, error) {
|
||||
return spp.TakeSnapshot()
|
||||
}
|
||||
|
||||
// GetCurrentStats returns current memory statistics
|
||||
func (spp *SessionPoolProfiler) GetCurrentStats() *runtime.MemStats {
|
||||
stats := &runtime.MemStats{}
|
||||
runtime.ReadMemStats(stats)
|
||||
return stats
|
||||
}
|
||||
|
||||
// AnalyzeLeaks analyzes session pool for leaks
|
||||
func (spp *SessionPoolProfiler) AnalyzeLeaks(baseline, current *MemorySnapshot) *LeakAnalysis {
|
||||
analysis := &LeakAnalysis{
|
||||
SuspectedLeaks: make([]string, 0),
|
||||
Recommendations: make([]string, 0),
|
||||
}
|
||||
|
||||
if baseline == nil || current == nil {
|
||||
analysis.LeakDescription = "Insufficient session pool data"
|
||||
return analysis
|
||||
}
|
||||
|
||||
// Check for session pool specific leaks
|
||||
memoryIncrease := current.RuntimeStats.Alloc - baseline.RuntimeStats.Alloc
|
||||
if memoryIncrease > 10*1024*1024 { // 10MB threshold
|
||||
analysis.HasLeak = true
|
||||
analysis.SuspectedLeaks = append(analysis.SuspectedLeaks,
|
||||
"Session pool memory usage increased significantly")
|
||||
analysis.Recommendations = append(analysis.Recommendations,
|
||||
"Check for sessions not being returned to pool properly")
|
||||
}
|
||||
|
||||
return analysis
|
||||
}
|
||||
|
||||
// CacheMemoryProfiler monitors cache memory usage
|
||||
type CacheMemoryProfiler struct {
|
||||
cache *Cache
|
||||
logger *Logger
|
||||
}
|
||||
|
||||
// NewCacheMemoryProfiler creates a new cache memory profiler
|
||||
func NewCacheMemoryProfiler(cache *Cache, logger *Logger) *CacheMemoryProfiler {
|
||||
if logger == nil {
|
||||
logger = newNoOpLogger()
|
||||
}
|
||||
return &CacheMemoryProfiler{
|
||||
cache: cache,
|
||||
logger: logger,
|
||||
}
|
||||
}
|
||||
|
||||
// TakeSnapshot captures cache memory statistics
|
||||
func (cmp *CacheMemoryProfiler) TakeSnapshot() (*MemorySnapshot, error) {
|
||||
snapshot := &MemorySnapshot{
|
||||
Timestamp: time.Now(),
|
||||
CustomMetrics: make(map[string]interface{}),
|
||||
}
|
||||
|
||||
runtime.ReadMemStats(&snapshot.RuntimeStats)
|
||||
|
||||
// Add cache-specific metrics (would need to be added to Cache struct)
|
||||
snapshot.CustomMetrics["cache_size"] = "unknown" // Placeholder
|
||||
|
||||
return snapshot, nil
|
||||
}
|
||||
|
||||
// StartProfiling begins profiling (no-op for cache)
|
||||
func (cmp *CacheMemoryProfiler) StartProfiling(config ProfilingConfig) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// StopProfiling ends profiling
|
||||
func (cmp *CacheMemoryProfiler) StopProfiling() (*MemorySnapshot, error) {
|
||||
return cmp.TakeSnapshot()
|
||||
}
|
||||
|
||||
// GetCurrentStats returns current memory statistics
|
||||
func (cmp *CacheMemoryProfiler) GetCurrentStats() *runtime.MemStats {
|
||||
stats := &runtime.MemStats{}
|
||||
runtime.ReadMemStats(stats)
|
||||
return stats
|
||||
}
|
||||
|
||||
// AnalyzeLeaks analyzes cache for memory leaks
|
||||
func (cmp *CacheMemoryProfiler) AnalyzeLeaks(baseline, current *MemorySnapshot) *LeakAnalysis {
|
||||
analysis := &LeakAnalysis{
|
||||
SuspectedLeaks: make([]string, 0),
|
||||
Recommendations: make([]string, 0),
|
||||
}
|
||||
|
||||
if baseline == nil || current == nil {
|
||||
analysis.LeakDescription = "Insufficient cache data"
|
||||
return analysis
|
||||
}
|
||||
|
||||
memoryIncrease := current.RuntimeStats.Alloc - baseline.RuntimeStats.Alloc
|
||||
if memoryIncrease > 20*1024*1024 { // 20MB threshold for cache
|
||||
analysis.HasLeak = true
|
||||
analysis.SuspectedLeaks = append(analysis.SuspectedLeaks,
|
||||
"Cache memory usage increased significantly")
|
||||
analysis.Recommendations = append(analysis.Recommendations,
|
||||
"Check cache size limits and cleanup intervals")
|
||||
}
|
||||
|
||||
return analysis
|
||||
}
|
||||
|
||||
// HTTPClientProfiler monitors HTTP client connection pools
|
||||
type HTTPClientProfiler struct {
|
||||
httpClient *http.Client
|
||||
logger *Logger
|
||||
}
|
||||
|
||||
// NewHTTPClientProfiler creates a new HTTP client profiler
|
||||
func NewHTTPClientProfiler(client *http.Client, logger *Logger) *HTTPClientProfiler {
|
||||
if logger == nil {
|
||||
logger = newNoOpLogger()
|
||||
}
|
||||
return &HTTPClientProfiler{
|
||||
httpClient: client,
|
||||
logger: logger,
|
||||
}
|
||||
}
|
||||
|
||||
// TakeSnapshot captures HTTP client memory statistics
|
||||
func (hcp *HTTPClientProfiler) TakeSnapshot() (*MemorySnapshot, error) {
|
||||
snapshot := &MemorySnapshot{
|
||||
Timestamp: time.Now(),
|
||||
CustomMetrics: make(map[string]interface{}),
|
||||
}
|
||||
|
||||
runtime.ReadMemStats(&snapshot.RuntimeStats)
|
||||
|
||||
// Add HTTP client specific metrics
|
||||
if transport, ok := hcp.httpClient.Transport.(*http.Transport); ok {
|
||||
snapshot.CustomMetrics["idle_connections"] = transport.IdleConnTimeout.String()
|
||||
snapshot.CustomMetrics["max_idle_conns"] = transport.MaxIdleConns
|
||||
}
|
||||
|
||||
return snapshot, nil
|
||||
}
|
||||
|
||||
// StartProfiling begins profiling (no-op for HTTP client)
|
||||
func (hcp *HTTPClientProfiler) StartProfiling(config ProfilingConfig) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// StopProfiling ends profiling
|
||||
func (hcp *HTTPClientProfiler) StopProfiling() (*MemorySnapshot, error) {
|
||||
return hcp.TakeSnapshot()
|
||||
}
|
||||
|
||||
// GetCurrentStats returns current memory statistics
|
||||
func (hcp *HTTPClientProfiler) GetCurrentStats() *runtime.MemStats {
|
||||
stats := &runtime.MemStats{}
|
||||
runtime.ReadMemStats(stats)
|
||||
return stats
|
||||
}
|
||||
|
||||
// AnalyzeLeaks analyzes HTTP client for connection leaks
|
||||
func (hcp *HTTPClientProfiler) AnalyzeLeaks(baseline, current *MemorySnapshot) *LeakAnalysis {
|
||||
analysis := &LeakAnalysis{
|
||||
SuspectedLeaks: make([]string, 0),
|
||||
Recommendations: make([]string, 0),
|
||||
}
|
||||
|
||||
if baseline == nil || current == nil {
|
||||
analysis.LeakDescription = "Insufficient HTTP client data"
|
||||
return analysis
|
||||
}
|
||||
|
||||
memoryIncrease := current.RuntimeStats.Alloc - baseline.RuntimeStats.Alloc
|
||||
if memoryIncrease > 5*1024*1024 { // 5MB threshold for HTTP client
|
||||
analysis.HasLeak = true
|
||||
analysis.SuspectedLeaks = append(analysis.SuspectedLeaks,
|
||||
"HTTP client memory usage increased significantly")
|
||||
analysis.Recommendations = append(analysis.Recommendations,
|
||||
"Check for HTTP response bodies not being drained properly")
|
||||
}
|
||||
|
||||
return analysis
|
||||
}
|
||||
|
||||
// TokenCompressionProfiler monitors token compression memory usage
|
||||
type TokenCompressionProfiler struct {
|
||||
compressionPool *TokenCompressionPool
|
||||
logger *Logger
|
||||
}
|
||||
|
||||
// NewTokenCompressionProfiler creates a new token compression profiler
|
||||
func NewTokenCompressionProfiler(pool *TokenCompressionPool, logger *Logger) *TokenCompressionProfiler {
|
||||
if logger == nil {
|
||||
logger = newNoOpLogger()
|
||||
}
|
||||
return &TokenCompressionProfiler{
|
||||
compressionPool: pool,
|
||||
logger: logger,
|
||||
}
|
||||
}
|
||||
|
||||
// TakeSnapshot captures token compression memory statistics
|
||||
func (tcp *TokenCompressionProfiler) TakeSnapshot() (*MemorySnapshot, error) {
|
||||
snapshot := &MemorySnapshot{
|
||||
Timestamp: time.Now(),
|
||||
CustomMetrics: make(map[string]interface{}),
|
||||
}
|
||||
|
||||
runtime.ReadMemStats(&snapshot.RuntimeStats)
|
||||
|
||||
// Add compression pool specific metrics
|
||||
snapshot.CustomMetrics["compression_pool_active"] = true
|
||||
|
||||
return snapshot, nil
|
||||
}
|
||||
|
||||
// StartProfiling begins profiling (no-op for compression)
|
||||
func (tcp *TokenCompressionProfiler) StartProfiling(config ProfilingConfig) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// StopProfiling ends profiling
|
||||
func (tcp *TokenCompressionProfiler) StopProfiling() (*MemorySnapshot, error) {
|
||||
return tcp.TakeSnapshot()
|
||||
}
|
||||
|
||||
// GetCurrentStats returns current memory statistics
|
||||
func (tcp *TokenCompressionProfiler) GetCurrentStats() *runtime.MemStats {
|
||||
stats := &runtime.MemStats{}
|
||||
runtime.ReadMemStats(stats)
|
||||
return stats
|
||||
}
|
||||
|
||||
// AnalyzeLeaks analyzes token compression for memory leaks
|
||||
func (tcp *TokenCompressionProfiler) AnalyzeLeaks(baseline, current *MemorySnapshot) *LeakAnalysis {
|
||||
analysis := &LeakAnalysis{
|
||||
SuspectedLeaks: make([]string, 0),
|
||||
Recommendations: make([]string, 0),
|
||||
}
|
||||
|
||||
if baseline == nil || current == nil {
|
||||
analysis.LeakDescription = "Insufficient compression data"
|
||||
return analysis
|
||||
}
|
||||
|
||||
memoryIncrease := current.RuntimeStats.Alloc - baseline.RuntimeStats.Alloc
|
||||
if memoryIncrease > 2*1024*1024 { // 2MB threshold for compression
|
||||
analysis.HasLeak = true
|
||||
analysis.SuspectedLeaks = append(analysis.SuspectedLeaks,
|
||||
"Token compression memory usage increased significantly")
|
||||
analysis.Recommendations = append(analysis.Recommendations,
|
||||
"Check for compression buffers not being returned to pool")
|
||||
}
|
||||
|
||||
return analysis
|
||||
}
|
||||
|
||||
// MemoryPoolProfiler monitors memory pool usage and detects leaks
|
||||
type MemoryPoolProfiler struct {
|
||||
memoryPoolManager *MemoryPoolManager
|
||||
tokenCompressionPool *TokenCompressionPool
|
||||
logger *Logger
|
||||
}
|
||||
|
||||
// NewMemoryPoolProfiler creates a new memory pool profiler
|
||||
func NewMemoryPoolProfiler(memoryPoolManager *MemoryPoolManager, tokenCompressionPool *TokenCompressionPool, logger *Logger) *MemoryPoolProfiler {
|
||||
if logger == nil {
|
||||
logger = newNoOpLogger()
|
||||
}
|
||||
return &MemoryPoolProfiler{
|
||||
memoryPoolManager: memoryPoolManager,
|
||||
tokenCompressionPool: tokenCompressionPool,
|
||||
logger: logger,
|
||||
}
|
||||
}
|
||||
|
||||
// TakeSnapshot captures memory pool statistics
|
||||
func (mpp *MemoryPoolProfiler) TakeSnapshot() (*MemorySnapshot, error) {
|
||||
snapshot := &MemorySnapshot{
|
||||
Timestamp: time.Now(),
|
||||
CustomMetrics: make(map[string]interface{}),
|
||||
}
|
||||
|
||||
// Capture runtime stats
|
||||
runtime.ReadMemStats(&snapshot.RuntimeStats)
|
||||
|
||||
// Add memory pool metrics
|
||||
if mpp.memoryPoolManager != nil {
|
||||
snapshot.CustomMetrics["memory_pool_active"] = true
|
||||
// Note: sync.Pool doesn't expose internal statistics, so we track usage patterns
|
||||
}
|
||||
|
||||
if mpp.tokenCompressionPool != nil {
|
||||
snapshot.CustomMetrics["token_compression_pool_active"] = true
|
||||
}
|
||||
|
||||
return snapshot, nil
|
||||
}
|
||||
|
||||
// StartProfiling begins profiling (no-op for memory pools)
|
||||
func (mpp *MemoryPoolProfiler) StartProfiling(config ProfilingConfig) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// StopProfiling ends profiling
|
||||
func (mpp *MemoryPoolProfiler) StopProfiling() (*MemorySnapshot, error) {
|
||||
return mpp.TakeSnapshot()
|
||||
}
|
||||
|
||||
// GetCurrentStats returns current memory statistics
|
||||
func (mpp *MemoryPoolProfiler) GetCurrentStats() *runtime.MemStats {
|
||||
stats := &runtime.MemStats{}
|
||||
runtime.ReadMemStats(stats)
|
||||
return stats
|
||||
}
|
||||
|
||||
// AnalyzeLeaks analyzes memory pools for leaks
|
||||
func (mpp *MemoryPoolProfiler) AnalyzeLeaks(baseline, current *MemorySnapshot) *LeakAnalysis {
|
||||
analysis := &LeakAnalysis{
|
||||
SuspectedLeaks: make([]string, 0),
|
||||
Recommendations: make([]string, 0),
|
||||
}
|
||||
|
||||
if baseline == nil || current == nil {
|
||||
analysis.LeakDescription = "Insufficient memory pool data"
|
||||
return analysis
|
||||
}
|
||||
|
||||
// Check for memory leaks in pool operations
|
||||
memoryIncrease := current.RuntimeStats.Alloc - baseline.RuntimeStats.Alloc
|
||||
if memoryIncrease > 5*1024*1024 { // 5MB threshold for pool operations
|
||||
analysis.HasLeak = true
|
||||
analysis.SuspectedLeaks = append(analysis.SuspectedLeaks,
|
||||
"Memory pool operations caused significant memory increase")
|
||||
analysis.Recommendations = append(analysis.Recommendations,
|
||||
"Check for objects not being returned to memory pools properly")
|
||||
}
|
||||
|
||||
return analysis
|
||||
}
|
||||
|
||||
// Global profiling manager instance
|
||||
var globalProfilingManager *ProfilingManager
|
||||
var profilingManagerOnce sync.Once
|
||||
|
||||
// GetGlobalProfilingManager returns the singleton profiling manager
|
||||
func GetGlobalProfilingManager() *ProfilingManager {
|
||||
profilingManagerOnce.Do(func() {
|
||||
globalProfilingManager = NewProfilingManager(nil)
|
||||
})
|
||||
return globalProfilingManager
|
||||
}
|
||||
|
||||
// Global test orchestrator instance
|
||||
var globalTestOrchestrator *MemoryTestOrchestrator
|
||||
var testOrchestratorOnce sync.Once
|
||||
|
||||
// GetGlobalTestOrchestrator returns the singleton test orchestrator
|
||||
func GetGlobalTestOrchestrator() *MemoryTestOrchestrator {
|
||||
testOrchestratorOnce.Do(func() {
|
||||
config := LeakDetectionConfig{
|
||||
EnableLeakDetection: true,
|
||||
LeakThresholdMB: 50,
|
||||
GoroutineLeakThreshold: 10,
|
||||
SessionPoolThreshold: 100,
|
||||
CacheMemoryThreshold: 20 * 1024 * 1024, // 20MB
|
||||
HTTPClientThreshold: 50,
|
||||
TokenCompressionThreshold: 2 * 1024 * 1024, // 2MB
|
||||
}
|
||||
globalTestOrchestrator = NewMemoryTestOrchestrator(config, nil)
|
||||
})
|
||||
return globalTestOrchestrator
|
||||
}
|
||||
@@ -0,0 +1,788 @@
|
||||
package traefikoidc
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net"
|
||||
"net/http"
|
||||
"os"
|
||||
"runtime"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
func TestProfilingManager(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
pm := NewProfilingManager(logger)
|
||||
|
||||
// Test taking a snapshot
|
||||
snapshot, err := pm.TakeSnapshot()
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to take snapshot: %v", err)
|
||||
}
|
||||
|
||||
if snapshot == nil {
|
||||
t.Fatal("Snapshot is nil")
|
||||
}
|
||||
|
||||
if snapshot.RuntimeStats.Alloc == 0 {
|
||||
t.Error("Runtime stats Alloc should not be zero")
|
||||
}
|
||||
|
||||
if snapshot.Timestamp.IsZero() {
|
||||
t.Error("Snapshot timestamp should not be zero")
|
||||
}
|
||||
}
|
||||
|
||||
func TestMemoryTestOrchestrator(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
config := LeakDetectionConfig{
|
||||
EnableLeakDetection: true,
|
||||
LeakThresholdMB: 10,
|
||||
}
|
||||
|
||||
mto := NewMemoryTestOrchestrator(config, logger)
|
||||
|
||||
// Test registering a component
|
||||
sessionManager, err := NewSessionManager("test-key-32-chars-long-for-testing", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
|
||||
profiler := NewSessionPoolProfiler(sessionManager, logger)
|
||||
mto.RegisterComponent("session_pool", profiler)
|
||||
|
||||
// Test getting leak analysis (should return false initially since no checks have been performed)
|
||||
_, exists := mto.GetLeakAnalysis("session_pool")
|
||||
if exists {
|
||||
t.Error("Should not have leak analysis before any checks are performed")
|
||||
}
|
||||
|
||||
// Perform a manual leak check
|
||||
baseline, err := profiler.TakeSnapshot()
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to take baseline snapshot: %v", err)
|
||||
}
|
||||
|
||||
time.Sleep(10 * time.Millisecond) // Small delay
|
||||
|
||||
// Manually trigger leak check with baseline
|
||||
baselineSnapshots := make(map[string]*MemorySnapshot)
|
||||
baselineSnapshots["session_pool"] = baseline
|
||||
mto.performLeakCheck(baselineSnapshots)
|
||||
|
||||
// Now test getting leak analysis
|
||||
analysis, exists := mto.GetLeakAnalysis("session_pool")
|
||||
if !exists {
|
||||
t.Error("Should have leak analysis after performing checks")
|
||||
}
|
||||
|
||||
if analysis == nil {
|
||||
t.Error("Leak analysis should not be nil after checks")
|
||||
}
|
||||
}
|
||||
|
||||
func TestComponentProfilers(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
|
||||
// Test Session Pool Profiler
|
||||
sessionManager, err := NewSessionManager("test-key-32-chars-long-for-testing", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
|
||||
spp := NewSessionPoolProfiler(sessionManager, logger)
|
||||
snapshot, err := spp.TakeSnapshot()
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to take session pool snapshot: %v", err)
|
||||
}
|
||||
|
||||
if snapshot == nil {
|
||||
t.Fatal("Session pool snapshot is nil")
|
||||
}
|
||||
|
||||
// Test Cache Memory Profiler
|
||||
cache := NewCache()
|
||||
cmp := NewCacheMemoryProfiler(cache, logger)
|
||||
snapshot, err = cmp.TakeSnapshot()
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to take cache snapshot: %v", err)
|
||||
}
|
||||
|
||||
if snapshot == nil {
|
||||
t.Fatal("Cache snapshot is nil")
|
||||
}
|
||||
|
||||
// Test HTTP Client Profiler
|
||||
httpClient := createDefaultHTTPClient()
|
||||
hcp := NewHTTPClientProfiler(httpClient, logger)
|
||||
snapshot, err = hcp.TakeSnapshot()
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to take HTTP client snapshot: %v", err)
|
||||
}
|
||||
|
||||
if snapshot == nil {
|
||||
t.Fatal("HTTP client snapshot is nil")
|
||||
}
|
||||
|
||||
// Test Token Compression Profiler
|
||||
compressionPool := NewTokenCompressionPool()
|
||||
tcp := NewTokenCompressionProfiler(compressionPool, logger)
|
||||
snapshot, err = tcp.TakeSnapshot()
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to take compression snapshot: %v", err)
|
||||
}
|
||||
|
||||
if snapshot == nil {
|
||||
t.Fatal("Compression snapshot is nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestLeakAnalysis(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
pm := NewProfilingManager(logger)
|
||||
|
||||
// Create baseline snapshot
|
||||
baseline, err := pm.TakeSnapshot()
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create baseline: %v", err)
|
||||
}
|
||||
|
||||
// Wait a bit and create current snapshot
|
||||
time.Sleep(10 * time.Millisecond)
|
||||
current, err := pm.TakeSnapshot()
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create current snapshot: %v", err)
|
||||
}
|
||||
|
||||
// Test leak analysis
|
||||
analysis := pm.AnalyzeLeaks(baseline, current)
|
||||
if analysis == nil {
|
||||
t.Fatal("Leak analysis is nil")
|
||||
}
|
||||
|
||||
// Analysis should not have leaks for normal operation
|
||||
if analysis.HasLeak {
|
||||
t.Logf("Leak detected: %s", analysis.LeakDescription)
|
||||
// This is acceptable as the test environment may have varying memory usage
|
||||
}
|
||||
}
|
||||
|
||||
func TestGlobalInstances(t *testing.T) {
|
||||
// Test global profiling manager
|
||||
gpm := GetGlobalProfilingManager()
|
||||
if gpm == nil {
|
||||
t.Fatal("Global profiling manager is nil")
|
||||
}
|
||||
|
||||
// Test global test orchestrator
|
||||
gto := GetGlobalTestOrchestrator()
|
||||
if gto == nil {
|
||||
t.Fatal("Global test orchestrator is nil")
|
||||
}
|
||||
|
||||
// Test that they're singletons
|
||||
gpm2 := GetGlobalProfilingManager()
|
||||
if gpm != gpm2 {
|
||||
t.Error("Global profiling manager should be singleton")
|
||||
}
|
||||
|
||||
gto2 := GetGlobalTestOrchestrator()
|
||||
if gto != gto2 {
|
||||
t.Error("Global test orchestrator should be singleton")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProfilingConfig(t *testing.T) {
|
||||
config := ProfilingConfig{
|
||||
EnableHeapProfiling: true,
|
||||
EnableGoroutineProfiling: true,
|
||||
SnapshotInterval: 30 * time.Second,
|
||||
LeakThresholdMB: 50,
|
||||
MaxSnapshots: 100,
|
||||
EnableContinuousMonitoring: true,
|
||||
MonitoringInterval: 60 * time.Second,
|
||||
}
|
||||
|
||||
if !config.EnableHeapProfiling {
|
||||
t.Error("Heap profiling should be enabled")
|
||||
}
|
||||
|
||||
if !config.EnableGoroutineProfiling {
|
||||
t.Error("Goroutine profiling should be enabled")
|
||||
}
|
||||
|
||||
if config.LeakThresholdMB != 50 {
|
||||
t.Errorf("Expected leak threshold 50, got %d", config.LeakThresholdMB)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLeakDetectionConfig(t *testing.T) {
|
||||
config := LeakDetectionConfig{
|
||||
EnableLeakDetection: true,
|
||||
LeakThresholdMB: 50,
|
||||
GoroutineLeakThreshold: 10,
|
||||
SessionPoolThreshold: 100,
|
||||
CacheMemoryThreshold: 20 * 1024 * 1024,
|
||||
HTTPClientThreshold: 50,
|
||||
TokenCompressionThreshold: 2 * 1024 * 1024,
|
||||
}
|
||||
|
||||
if !config.EnableLeakDetection {
|
||||
t.Error("Leak detection should be enabled")
|
||||
}
|
||||
|
||||
if config.LeakThresholdMB != 50 {
|
||||
t.Errorf("Expected leak threshold 50, got %d", config.LeakThresholdMB)
|
||||
}
|
||||
|
||||
if config.CacheMemoryThreshold != 20*1024*1024 {
|
||||
t.Errorf("Expected cache threshold 20MB, got %d", config.CacheMemoryThreshold)
|
||||
}
|
||||
}
|
||||
|
||||
// ProviderMetadataProfiler monitors provider metadata fetching and caching operations
|
||||
type ProviderMetadataProfiler struct {
|
||||
metadataCache *MetadataCache
|
||||
httpClient *http.Client
|
||||
logger *Logger
|
||||
providerURL string
|
||||
}
|
||||
|
||||
// NewProviderMetadataProfiler creates a new provider metadata profiler
|
||||
func NewProviderMetadataProfiler(metadataCache *MetadataCache, httpClient *http.Client, providerURL string, logger *Logger) *ProviderMetadataProfiler {
|
||||
if logger == nil {
|
||||
logger = newNoOpLogger()
|
||||
}
|
||||
return &ProviderMetadataProfiler{
|
||||
metadataCache: metadataCache,
|
||||
httpClient: httpClient,
|
||||
providerURL: providerURL,
|
||||
logger: logger,
|
||||
}
|
||||
}
|
||||
|
||||
// TakeSnapshot captures current memory statistics for metadata operations
|
||||
func (pmp *ProviderMetadataProfiler) TakeSnapshot() (*MemorySnapshot, error) {
|
||||
snapshot := &MemorySnapshot{
|
||||
Timestamp: time.Now(),
|
||||
CustomMetrics: make(map[string]interface{}),
|
||||
}
|
||||
|
||||
// Capture runtime memory statistics
|
||||
runtime.ReadMemStats(&snapshot.RuntimeStats)
|
||||
|
||||
// Add metadata-specific metrics
|
||||
snapshot.CustomMetrics["metadata_cache_size"] = 1 // Placeholder for cache size
|
||||
snapshot.CustomMetrics["metadata_fetch_count"] = 0 // Placeholder for fetch count
|
||||
snapshot.CustomMetrics["background_goroutines"] = runtime.NumGoroutine()
|
||||
|
||||
return snapshot, nil
|
||||
}
|
||||
|
||||
// StartProfiling begins profiling (no-op for metadata profiler)
|
||||
func (pmp *ProviderMetadataProfiler) StartProfiling(config ProfilingConfig) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// StopProfiling ends profiling
|
||||
func (pmp *ProviderMetadataProfiler) StopProfiling() (*MemorySnapshot, error) {
|
||||
return pmp.TakeSnapshot()
|
||||
}
|
||||
|
||||
// GetCurrentStats returns current memory statistics
|
||||
func (pmp *ProviderMetadataProfiler) GetCurrentStats() *runtime.MemStats {
|
||||
stats := &runtime.MemStats{}
|
||||
runtime.ReadMemStats(stats)
|
||||
return stats
|
||||
}
|
||||
|
||||
// AnalyzeLeaks analyzes metadata operations for memory leaks
|
||||
func (pmp *ProviderMetadataProfiler) AnalyzeLeaks(baseline, current *MemorySnapshot) *LeakAnalysis {
|
||||
analysis := &LeakAnalysis{
|
||||
SuspectedLeaks: make([]string, 0),
|
||||
Recommendations: make([]string, 0),
|
||||
}
|
||||
|
||||
if baseline == nil || current == nil {
|
||||
analysis.LeakDescription = "Insufficient metadata data"
|
||||
return analysis
|
||||
}
|
||||
|
||||
// Check for memory leaks
|
||||
memoryIncrease := current.RuntimeStats.Alloc - baseline.RuntimeStats.Alloc
|
||||
if memoryIncrease > 5*1024*1024 { // 5MB threshold for metadata operations
|
||||
analysis.HasLeak = true
|
||||
analysis.SuspectedLeaks = append(analysis.SuspectedLeaks,
|
||||
"Metadata operations memory usage increased significantly")
|
||||
analysis.Recommendations = append(analysis.Recommendations,
|
||||
"Check for metadata cache not being cleaned up properly")
|
||||
}
|
||||
|
||||
// Check for goroutine leaks
|
||||
goroutineIncrease := current.CustomMetrics["background_goroutines"].(int) - baseline.CustomMetrics["background_goroutines"].(int)
|
||||
if goroutineIncrease > 2 { // Allow some variance
|
||||
analysis.HasLeak = true
|
||||
analysis.SuspectedLeaks = append(analysis.SuspectedLeaks,
|
||||
fmt.Sprintf("Goroutine count increased by %d during metadata operations", goroutineIncrease))
|
||||
analysis.Recommendations = append(analysis.Recommendations,
|
||||
"Check for background goroutines not being cleaned up")
|
||||
}
|
||||
|
||||
return analysis
|
||||
}
|
||||
|
||||
// TestProviderMetadataMemoryLeakDetection tests for memory leaks in provider metadata operations
|
||||
func TestProviderMetadataMemoryLeakDetection(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
|
||||
strictMode := os.Getenv("STRICT_MEMORY_TEST") == "true"
|
||||
if strictMode {
|
||||
t.Log("Running in strict memory test mode - will fail on detected leaks")
|
||||
} else {
|
||||
t.Log("Running in lenient memory test mode - will log warnings instead of failing")
|
||||
}
|
||||
|
||||
config := LeakDetectionConfig{
|
||||
EnableLeakDetection: true,
|
||||
LeakThresholdMB: 10,
|
||||
}
|
||||
|
||||
mto := NewMemoryTestOrchestrator(config, logger)
|
||||
|
||||
// Create mock HTTP server for metadata endpoint with failure simulation
|
||||
requestCount := 0
|
||||
serverFailures := 0
|
||||
mockServer := &http.Server{
|
||||
Addr: "localhost:0", // Let system assign port
|
||||
Handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
requestCount++
|
||||
if r.URL.Path == "/.well-known/openid-configuration" {
|
||||
// Simulate occasional failures to test cache extension
|
||||
if requestCount%4 == 0 { // Fail every 4th request
|
||||
serverFailures++
|
||||
w.WriteHeader(http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
|
||||
metadata := ProviderMetadata{
|
||||
Issuer: "https://mock-provider.com",
|
||||
AuthURL: "https://mock-provider.com/auth",
|
||||
TokenURL: "https://mock-provider.com/token",
|
||||
JWKSURL: "https://mock-provider.com/jwks",
|
||||
RevokeURL: "https://mock-provider.com/revoke",
|
||||
EndSessionURL: "https://mock-provider.com/logout",
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
w.Header().Set("Cache-Control", "max-age=3600") // 1 hour cache hint
|
||||
json.NewEncoder(w).Encode(metadata)
|
||||
} else {
|
||||
http.NotFound(w, r)
|
||||
}
|
||||
}),
|
||||
}
|
||||
|
||||
// Start mock server
|
||||
listener, err := net.Listen("tcp", "localhost:0")
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create listener: %v", err)
|
||||
}
|
||||
go mockServer.Serve(listener)
|
||||
defer mockServer.Close()
|
||||
|
||||
providerURL := fmt.Sprintf("http://%s", listener.Addr().String())
|
||||
httpClient := createDefaultHTTPClient()
|
||||
|
||||
// Create metadata cache with WaitGroup for proper goroutine synchronization
|
||||
var wg sync.WaitGroup
|
||||
metadataCache := NewMetadataCacheWithLogger(&wg, logger)
|
||||
|
||||
// Create profiler
|
||||
profiler := NewProviderMetadataProfiler(metadataCache, httpClient, providerURL, logger)
|
||||
mto.RegisterComponent("provider_metadata", profiler)
|
||||
|
||||
// Take initial baseline
|
||||
baseline, err := profiler.TakeSnapshot()
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to take baseline snapshot: %v", err)
|
||||
}
|
||||
|
||||
initialGoroutines := runtime.NumGoroutine()
|
||||
|
||||
// Phase 1: Simulate periodic metadata fetching with some failures
|
||||
t.Log("Phase 1: Testing periodic fetching with occasional failures...")
|
||||
for i := 0; i < 20; i++ {
|
||||
_, err := metadataCache.GetMetadata(providerURL, httpClient, logger)
|
||||
if err != nil {
|
||||
t.Logf("Metadata fetch %d failed (expected for cache extension testing): %v", i+1, err)
|
||||
} else {
|
||||
t.Logf("Metadata fetch %d succeeded", i+1)
|
||||
}
|
||||
time.Sleep(100 * time.Millisecond)
|
||||
}
|
||||
|
||||
// Wait for background cleanup (normally every 5 minutes)
|
||||
time.Sleep(300 * time.Millisecond)
|
||||
|
||||
// Take intermediate snapshot
|
||||
intermediate, err := profiler.TakeSnapshot()
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to take intermediate snapshot: %v", err)
|
||||
}
|
||||
|
||||
// Phase 2: Continue with more fetches to test sustained operation
|
||||
t.Log("Phase 2: Testing sustained operation with 1000 iterations...")
|
||||
for i := 20; i < 1020; i++ {
|
||||
_, err := metadataCache.GetMetadata(providerURL, httpClient, logger)
|
||||
if err != nil {
|
||||
t.Logf("Metadata fetch %d failed: %v", i+1, err)
|
||||
}
|
||||
time.Sleep(50 * time.Millisecond) // Reduced sleep for faster execution
|
||||
}
|
||||
|
||||
// Take final snapshot
|
||||
current, err := profiler.TakeSnapshot()
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to take current snapshot: %v", err)
|
||||
}
|
||||
|
||||
finalGoroutines := runtime.NumGoroutine()
|
||||
|
||||
// Analyze for leaks
|
||||
analysis := profiler.AnalyzeLeaks(baseline, current)
|
||||
|
||||
// Assertions for memory leaks
|
||||
if analysis.HasLeak {
|
||||
if strictMode {
|
||||
t.Errorf("Memory leak detected in provider metadata operations: %s", analysis.LeakDescription)
|
||||
for _, leak := range analysis.SuspectedLeaks {
|
||||
t.Errorf("Suspected leak: %s", leak)
|
||||
}
|
||||
} else {
|
||||
t.Logf("Memory leak warning in provider metadata operations: %s", analysis.LeakDescription)
|
||||
for _, leak := range analysis.SuspectedLeaks {
|
||||
t.Logf("Suspected leak: %s", leak)
|
||||
}
|
||||
}
|
||||
for _, rec := range analysis.Recommendations {
|
||||
t.Logf("Recommendation: %s", rec)
|
||||
}
|
||||
}
|
||||
|
||||
// Check total memory growth
|
||||
totalMemoryIncrease := current.RuntimeStats.Alloc - baseline.RuntimeStats.Alloc
|
||||
if totalMemoryIncrease > 20*1024*1024 { // 20MB threshold for entire test
|
||||
if strictMode {
|
||||
t.Errorf("Total memory usage increased by %.2f MB during metadata operations", float64(totalMemoryIncrease)/(1024*1024))
|
||||
} else {
|
||||
t.Logf("Total memory usage increased by %.2f MB during metadata operations", float64(totalMemoryIncrease)/(1024*1024))
|
||||
}
|
||||
}
|
||||
|
||||
// Check for gradual memory growth patterns
|
||||
intermediateMemoryIncrease := intermediate.RuntimeStats.Alloc - baseline.RuntimeStats.Alloc
|
||||
if intermediateMemoryIncrease > 10*1024*1024 { // 10MB threshold for first phase
|
||||
if strictMode {
|
||||
t.Errorf("Memory usage increased by %.2f MB during first phase of metadata operations", float64(intermediateMemoryIncrease)/(1024*1024))
|
||||
} else {
|
||||
t.Logf("Memory usage increased by %.2f MB during first phase of metadata operations", float64(intermediateMemoryIncrease)/(1024*1024))
|
||||
}
|
||||
}
|
||||
|
||||
// Check goroutine count stability
|
||||
goroutineIncrease := finalGoroutines - initialGoroutines
|
||||
if goroutineIncrease > 5 { // Allow some variance for test environment
|
||||
if strictMode {
|
||||
t.Errorf("Goroutine count increased by %d during metadata operations (initial: %d, final: %d)",
|
||||
goroutineIncrease, initialGoroutines, finalGoroutines)
|
||||
} else {
|
||||
t.Logf("Goroutine count increased by %d during metadata operations (initial: %d, final: %d)",
|
||||
goroutineIncrease, initialGoroutines, finalGoroutines)
|
||||
}
|
||||
}
|
||||
|
||||
// Phase 3: Test cache extension behavior on persistent failures
|
||||
t.Log("Phase 3: Testing cache extension on persistent failures...")
|
||||
|
||||
// Stop mock server to simulate provider unavailability
|
||||
mockServer.Close()
|
||||
|
||||
// Try multiple fetches after server shutdown
|
||||
postShutdownFailures := 0
|
||||
for i := 0; i < 5; i++ {
|
||||
_, err = metadataCache.GetMetadata(providerURL, httpClient, logger)
|
||||
if err != nil {
|
||||
postShutdownFailures++
|
||||
t.Logf("Expected failure %d after server shutdown: %v", i+1, err)
|
||||
} else {
|
||||
t.Logf("Unexpected success %d after server shutdown - cache extension working", i+1)
|
||||
}
|
||||
time.Sleep(200 * time.Millisecond)
|
||||
}
|
||||
|
||||
if postShutdownFailures == 0 {
|
||||
if strictMode {
|
||||
t.Error("Expected some metadata fetches to fail after server shutdown")
|
||||
} else {
|
||||
t.Log("Warning: No metadata fetches failed after server shutdown - cache extension may not be working as expected")
|
||||
}
|
||||
}
|
||||
|
||||
// Phase 4: Test background goroutine lifecycle and cleanup
|
||||
t.Log("Phase 4: Testing background goroutine lifecycle...")
|
||||
|
||||
// Wait longer to allow background cleanup to run
|
||||
time.Sleep(1 * time.Second)
|
||||
|
||||
// Take final snapshot after cleanup
|
||||
finalAfterCleanup, err := profiler.TakeSnapshot()
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to take final snapshot after cleanup: %v", err)
|
||||
}
|
||||
|
||||
// Check if memory decreased after cleanup
|
||||
if finalAfterCleanup.RuntimeStats.Alloc < current.RuntimeStats.Alloc {
|
||||
memoryDecrease := current.RuntimeStats.Alloc - finalAfterCleanup.RuntimeStats.Alloc
|
||||
t.Logf("Memory decreased by %.2f MB after cleanup phase", float64(memoryDecrease)/(1024*1024))
|
||||
}
|
||||
|
||||
// Clean up resources
|
||||
metadataCache.Close()
|
||||
wg.Wait() // Ensure all background goroutines complete
|
||||
|
||||
t.Logf("Test completed: %d total requests, %d server failures, %d post-shutdown failures",
|
||||
requestCount, serverFailures, postShutdownFailures)
|
||||
t.Logf("Memory usage: baseline=%.2f MB, intermediate=%.2f MB, final=%.2f MB",
|
||||
float64(baseline.RuntimeStats.Alloc)/(1024*1024),
|
||||
float64(intermediate.RuntimeStats.Alloc)/(1024*1024),
|
||||
float64(current.RuntimeStats.Alloc)/(1024*1024))
|
||||
}
|
||||
|
||||
// TestMemoryPoolLeakDetection tests for memory leaks in memory pool operations
|
||||
func TestMemoryPoolLeakDetection(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
|
||||
strictMode := os.Getenv("STRICT_MEMORY_TEST") == "true"
|
||||
if strictMode {
|
||||
t.Log("Running in strict memory test mode - will fail on detected leaks")
|
||||
} else {
|
||||
t.Log("Running in lenient memory test mode - will log warnings instead of failing")
|
||||
}
|
||||
|
||||
config := LeakDetectionConfig{
|
||||
EnableLeakDetection: true,
|
||||
LeakThresholdMB: 10,
|
||||
}
|
||||
|
||||
mto := NewMemoryTestOrchestrator(config, logger)
|
||||
|
||||
// Create memory pool manager and token compression pool
|
||||
memoryPoolManager := NewMemoryPoolManager()
|
||||
tokenCompressionPool := NewTokenCompressionPool()
|
||||
|
||||
// Create profiler for memory pools
|
||||
profiler := NewMemoryPoolProfiler(memoryPoolManager, tokenCompressionPool, logger)
|
||||
mto.RegisterComponent("memory_pools", profiler)
|
||||
|
||||
// Take initial baseline
|
||||
baseline, err := profiler.TakeSnapshot()
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to take baseline snapshot: %v", err)
|
||||
}
|
||||
|
||||
initialGoroutines := runtime.NumGoroutine()
|
||||
|
||||
// Phase 1: Simulate various memory pool operations
|
||||
t.Log("Phase 1: Testing memory pool operations with various patterns...")
|
||||
|
||||
// Test compression buffer pool
|
||||
for i := 0; i < 100; i++ {
|
||||
buf := memoryPoolManager.GetCompressionBuffer()
|
||||
// Simulate some work with the buffer
|
||||
buf.WriteString(fmt.Sprintf("test data %d", i))
|
||||
// Properly return buffer to pool
|
||||
memoryPoolManager.PutCompressionBuffer(buf)
|
||||
}
|
||||
|
||||
// Test JWT parsing buffer pool
|
||||
for i := 0; i < 50; i++ {
|
||||
jwtBuf := memoryPoolManager.GetJWTParsingBuffer()
|
||||
// Simulate JWT parsing operations
|
||||
jwtBuf.HeaderBuf = append(jwtBuf.HeaderBuf, []byte("header")...)
|
||||
jwtBuf.PayloadBuf = append(jwtBuf.PayloadBuf, []byte("payload")...)
|
||||
jwtBuf.SignatureBuf = append(jwtBuf.SignatureBuf, []byte("signature")...)
|
||||
// Properly return buffer to pool
|
||||
memoryPoolManager.PutJWTParsingBuffer(jwtBuf)
|
||||
}
|
||||
|
||||
// Test HTTP response buffer pool
|
||||
for i := 0; i < 75; i++ {
|
||||
httpBuf := memoryPoolManager.GetHTTPResponseBuffer()
|
||||
// Simulate HTTP response processing
|
||||
copy(httpBuf[:min(len(httpBuf), 100)], []byte("http response data"))
|
||||
// Properly return buffer to pool
|
||||
memoryPoolManager.PutHTTPResponseBuffer(httpBuf)
|
||||
}
|
||||
|
||||
// Test string builder pool
|
||||
for i := 0; i < 60; i++ {
|
||||
sb := memoryPoolManager.GetStringBuilder()
|
||||
// Simulate string building operations
|
||||
sb.WriteString(fmt.Sprintf("built string %d", i))
|
||||
_ = sb.String() // Use the result
|
||||
// Properly return string builder to pool
|
||||
memoryPoolManager.PutStringBuilder(sb)
|
||||
}
|
||||
|
||||
// Test token compression pool
|
||||
for i := 0; i < 40; i++ {
|
||||
compBuf := tokenCompressionPool.GetCompressionBuffer()
|
||||
// Simulate compression operations
|
||||
compBuf.WriteString(fmt.Sprintf("compress data %d", i))
|
||||
// Properly return buffer to pool
|
||||
tokenCompressionPool.PutCompressionBuffer(compBuf)
|
||||
|
||||
decompBuf := tokenCompressionPool.GetDecompressionBuffer()
|
||||
// Simulate decompression operations
|
||||
decompBuf.WriteString(fmt.Sprintf("decompress data %d", i))
|
||||
// Properly return buffer to pool
|
||||
tokenCompressionPool.PutDecompressionBuffer(decompBuf)
|
||||
|
||||
sb := tokenCompressionPool.GetStringBuilder()
|
||||
// Simulate string operations
|
||||
sb.WriteString(fmt.Sprintf("token string %d", i))
|
||||
_ = sb.String()
|
||||
// Properly return string builder to pool
|
||||
tokenCompressionPool.PutStringBuilder(sb)
|
||||
}
|
||||
|
||||
// Take intermediate snapshot
|
||||
intermediate, err := profiler.TakeSnapshot()
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to take intermediate snapshot: %v", err)
|
||||
}
|
||||
|
||||
// Phase 2: Continue with more intensive operations to test sustained usage
|
||||
t.Log("Phase 2: Testing sustained memory pool usage...")
|
||||
|
||||
// Simulate mixed operations with varying patterns
|
||||
for i := 0; i < 200; i++ {
|
||||
// Mix different pool operations
|
||||
switch i % 4 {
|
||||
case 0:
|
||||
buf := memoryPoolManager.GetCompressionBuffer()
|
||||
buf.WriteString("mixed operation data")
|
||||
memoryPoolManager.PutCompressionBuffer(buf)
|
||||
case 1:
|
||||
jwtBuf := memoryPoolManager.GetJWTParsingBuffer()
|
||||
jwtBuf.HeaderBuf = append(jwtBuf.HeaderBuf, []byte("mixed")...)
|
||||
memoryPoolManager.PutJWTParsingBuffer(jwtBuf)
|
||||
case 2:
|
||||
httpBuf := memoryPoolManager.GetHTTPResponseBuffer()
|
||||
copy(httpBuf[:min(len(httpBuf), 50)], []byte("mixed http"))
|
||||
memoryPoolManager.PutHTTPResponseBuffer(httpBuf)
|
||||
case 3:
|
||||
sb := memoryPoolManager.GetStringBuilder()
|
||||
sb.WriteString("mixed string building")
|
||||
_ = sb.String()
|
||||
memoryPoolManager.PutStringBuilder(sb)
|
||||
}
|
||||
}
|
||||
|
||||
// Take final snapshot
|
||||
current, err := profiler.TakeSnapshot()
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to take current snapshot: %v", err)
|
||||
}
|
||||
|
||||
finalGoroutines := runtime.NumGoroutine()
|
||||
|
||||
// Analyze for leaks
|
||||
analysis := profiler.AnalyzeLeaks(baseline, current)
|
||||
|
||||
// Assertions for memory leaks
|
||||
if analysis.HasLeak {
|
||||
if strictMode {
|
||||
t.Errorf("Memory leak detected in memory pool operations: %s", analysis.LeakDescription)
|
||||
for _, leak := range analysis.SuspectedLeaks {
|
||||
t.Errorf("Suspected leak: %s", leak)
|
||||
}
|
||||
} else {
|
||||
t.Logf("Memory leak warning in memory pool operations: %s", analysis.LeakDescription)
|
||||
for _, leak := range analysis.SuspectedLeaks {
|
||||
t.Logf("Suspected leak: %s", leak)
|
||||
}
|
||||
}
|
||||
for _, rec := range analysis.Recommendations {
|
||||
t.Logf("Recommendation: %s", rec)
|
||||
}
|
||||
}
|
||||
|
||||
// Check total memory growth
|
||||
totalMemoryIncrease := current.RuntimeStats.Alloc - baseline.RuntimeStats.Alloc
|
||||
if totalMemoryIncrease > 15*1024*1024 { // 15MB threshold for entire test
|
||||
if strictMode {
|
||||
t.Errorf("Total memory usage increased by %.2f MB during memory pool operations", float64(totalMemoryIncrease)/(1024*1024))
|
||||
} else {
|
||||
t.Logf("Total memory usage increased by %.2f MB during memory pool operations", float64(totalMemoryIncrease)/(1024*1024))
|
||||
}
|
||||
}
|
||||
|
||||
// Check for gradual memory growth patterns
|
||||
intermediateMemoryIncrease := intermediate.RuntimeStats.Alloc - baseline.RuntimeStats.Alloc
|
||||
if intermediateMemoryIncrease > 8*1024*1024 { // 8MB threshold for first phase
|
||||
if strictMode {
|
||||
t.Errorf("Memory usage increased by %.2f MB during first phase of memory pool operations", float64(intermediateMemoryIncrease)/(1024*1024))
|
||||
} else {
|
||||
t.Logf("Memory usage increased by %.2f MB during first phase of memory pool operations", float64(intermediateMemoryIncrease)/(1024*1024))
|
||||
}
|
||||
}
|
||||
|
||||
// Check goroutine count stability
|
||||
goroutineIncrease := finalGoroutines - initialGoroutines
|
||||
if goroutineIncrease > 3 { // Allow small variance for test environment
|
||||
if strictMode {
|
||||
t.Errorf("Goroutine count increased by %d during memory pool operations (initial: %d, final: %d)",
|
||||
goroutineIncrease, initialGoroutines, finalGoroutines)
|
||||
} else {
|
||||
t.Logf("Goroutine count increased by %d during memory pool operations (initial: %d, final: %d)",
|
||||
goroutineIncrease, initialGoroutines, finalGoroutines)
|
||||
}
|
||||
}
|
||||
|
||||
// Phase 3: Test cleanup verification
|
||||
t.Log("Phase 3: Testing cleanup verification...")
|
||||
|
||||
// Force garbage collection to see if pools are properly managed
|
||||
runtime.GC()
|
||||
runtime.GC() // Run twice to ensure cleanup
|
||||
|
||||
time.Sleep(10 * time.Millisecond) // Allow cleanup to complete
|
||||
|
||||
// Take post-cleanup snapshot
|
||||
postCleanup, err := profiler.TakeSnapshot()
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to take post-cleanup snapshot: %v", err)
|
||||
}
|
||||
|
||||
// Check if memory decreased after cleanup
|
||||
if postCleanup.RuntimeStats.Alloc < current.RuntimeStats.Alloc {
|
||||
memoryDecrease := current.RuntimeStats.Alloc - postCleanup.RuntimeStats.Alloc
|
||||
t.Logf("Memory decreased by %.2f MB after cleanup phase", float64(memoryDecrease)/(1024*1024))
|
||||
} else if postCleanup.RuntimeStats.Alloc > current.RuntimeStats.Alloc {
|
||||
memoryIncrease := postCleanup.RuntimeStats.Alloc - current.RuntimeStats.Alloc
|
||||
if strictMode {
|
||||
t.Errorf("Memory increased by %.2f MB after cleanup phase - possible cleanup issues", float64(memoryIncrease)/(1024*1024))
|
||||
} else {
|
||||
t.Logf("Memory increased by %.2f MB after cleanup phase - possible cleanup issues", float64(memoryIncrease)/(1024*1024))
|
||||
}
|
||||
}
|
||||
|
||||
t.Logf("Memory pool leak detection test completed")
|
||||
t.Logf("Memory usage: baseline=%.2f MB, intermediate=%.2f MB, final=%.2f MB, post-cleanup=%.2f MB",
|
||||
float64(baseline.RuntimeStats.Alloc)/(1024*1024),
|
||||
float64(intermediate.RuntimeStats.Alloc)/(1024*1024),
|
||||
float64(current.RuntimeStats.Alloc)/(1024*1024),
|
||||
float64(postCleanup.RuntimeStats.Alloc)/(1024*1024))
|
||||
}
|
||||
@@ -12,7 +12,7 @@ import (
|
||||
// TestReverseProxyHTTPSDetection tests that HTTPS is properly detected in reverse proxy environments
|
||||
func TestReverseProxyHTTPSDetection(t *testing.T) {
|
||||
t.Run("HTTPS_Detection_With_X_Forwarded_Proto", func(t *testing.T) {
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Simulate request from reverse proxy (Traefik/nginx)
|
||||
@@ -48,7 +48,7 @@ func TestReverseProxyHTTPSDetection(t *testing.T) {
|
||||
})
|
||||
|
||||
t.Run("HTTPS_Detection_Without_Headers", func(t *testing.T) {
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Request without reverse proxy headers (direct HTTP)
|
||||
@@ -79,7 +79,7 @@ func TestReverseProxyHTTPSDetection(t *testing.T) {
|
||||
|
||||
t.Run("HTTPS_Detection_With_ForceHTTPS", func(t *testing.T) {
|
||||
// Test with forceHTTPS enabled
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", true, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", true, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Even without headers, forceHTTPS should make cookies secure
|
||||
@@ -110,7 +110,7 @@ func TestReverseProxyHTTPSDetection(t *testing.T) {
|
||||
// TestCSRFPersistenceInReverseProxy tests CSRF token persistence in reverse proxy setups
|
||||
func TestCSRFPersistenceInReverseProxy(t *testing.T) {
|
||||
t.Run("CSRF_Persists_Through_OAuth_Flow_With_Proxy", func(t *testing.T) {
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Step 1: Initial request to protected resource (HTTPS via proxy)
|
||||
@@ -156,7 +156,7 @@ func TestCSRFPersistenceInReverseProxy(t *testing.T) {
|
||||
})
|
||||
|
||||
t.Run("Session_Cookie_Domain_With_Proxy_Headers", func(t *testing.T) {
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Test with X-Forwarded-Host header
|
||||
@@ -196,7 +196,7 @@ func TestAzureOIDCWithReverseProxy(t *testing.T) {
|
||||
// This test verifies Azure-specific provider detection and configuration
|
||||
// without making actual network calls
|
||||
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Step 1: Test session setup for Azure OAuth flow
|
||||
@@ -254,7 +254,7 @@ func TestAzureOIDCWithReverseProxy(t *testing.T) {
|
||||
})
|
||||
|
||||
t.Run("Mixed_HTTP_HTTPS_Requests", func(t *testing.T) {
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Simulate a scenario where some requests come via HTTPS proxy and some don't
|
||||
@@ -299,7 +299,7 @@ func TestAzureOIDCWithReverseProxy(t *testing.T) {
|
||||
// TestEnhanceSessionSecurity verifies the security enhancement function
|
||||
func TestEnhanceSessionSecurity(t *testing.T) {
|
||||
t.Run("Security_Enhancement_For_AJAX_Requests", func(t *testing.T) {
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// AJAX request via HTTPS proxy
|
||||
@@ -327,7 +327,7 @@ func TestEnhanceSessionSecurity(t *testing.T) {
|
||||
})
|
||||
|
||||
t.Run("Security_Enhancement_Missing_User_Agent", func(t *testing.T) {
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Request without User-Agent (potential bot/attack)
|
||||
|
||||
+1
-1
@@ -197,7 +197,7 @@ func TestCacheMemoryExhaustion(t *testing.T) {
|
||||
// TestSessionConcurrencyProtection tests session safety under concurrent access
|
||||
func TestSessionConcurrencyProtection(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sessionManager, err := NewSessionManager("test-secret-key-that-is-at-least-32-bytes", false, logger)
|
||||
sessionManager, err := NewSessionManager("test-secret-key-that-is-at-least-32-bytes", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
|
||||
@@ -461,7 +461,7 @@ func TestMissingClaims(t *testing.T) {
|
||||
// TestSessionFixationAttack tests the plugin's resistance to session fixation attacks
|
||||
func TestSessionFixationAttack(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("test-secret-key-that-is-at-least-32-bytes", false, logger)
|
||||
sm, err := NewSessionManager("test-secret-key-that-is-at-least-32-bytes", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
@@ -615,7 +615,7 @@ func TestSessionFixationAttack(t *testing.T) {
|
||||
// TestCSRFProtection tests CSRF protection in POST requests
|
||||
func TestCSRFProtection(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("test-secret-key-that-is-at-least-32-bytes", false, logger)
|
||||
sm, err := NewSessionManager("test-secret-key-that-is-at-least-32-bytes", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
|
||||
+118
-7
@@ -243,17 +243,21 @@ type SessionManager struct {
|
||||
store sessions.Store
|
||||
logger *Logger
|
||||
forceHTTPS bool
|
||||
cookieDomain string
|
||||
chunkManager *ChunkManager
|
||||
cleanupMutex sync.RWMutex // Protects cleanup operations
|
||||
cleanupDone bool // Track if we've attempted cookie cleanup
|
||||
}
|
||||
|
||||
// NewSessionManager creates a new session manager with the specified configuration.
|
||||
// Parameters:
|
||||
// - encryptionKey: Key used to encrypt session data (must be at least 32 bytes)
|
||||
// - forceHTTPS: When true, forces secure cookie attributes regardless of request scheme
|
||||
// - cookieDomain: Explicit domain for cookies (e.g., ".example.com" for subdomain access)
|
||||
// - logger: Logger instance for recording session-related events
|
||||
//
|
||||
// Returns an error if the encryption key does not meet minimum length requirements.
|
||||
func NewSessionManager(encryptionKey string, forceHTTPS bool, logger *Logger) (*SessionManager, error) {
|
||||
func NewSessionManager(encryptionKey string, forceHTTPS bool, cookieDomain string, logger *Logger) (*SessionManager, error) {
|
||||
// Validate encryption key length.
|
||||
if len(encryptionKey) < minEncryptionKeyLength {
|
||||
return nil, fmt.Errorf("encryption key must be at least %d bytes long", minEncryptionKeyLength)
|
||||
@@ -262,6 +266,7 @@ func NewSessionManager(encryptionKey string, forceHTTPS bool, logger *Logger) (*
|
||||
sm := &SessionManager{
|
||||
store: sessions.NewCookieStore([]byte(encryptionKey)),
|
||||
forceHTTPS: forceHTTPS,
|
||||
cookieDomain: cookieDomain,
|
||||
logger: logger,
|
||||
chunkManager: NewChunkManager(logger),
|
||||
}
|
||||
@@ -512,8 +517,13 @@ func (sm *SessionManager) EnhanceSessionSecurity(options *sessions.Options, r *h
|
||||
// Always enforce security best practices
|
||||
options.HttpOnly = true
|
||||
|
||||
// Set secure Domain attribute for production
|
||||
if options.Domain == "" && r != nil {
|
||||
// Set cookie domain from configuration if specified
|
||||
if sm.cookieDomain != "" {
|
||||
// Use the explicitly configured domain
|
||||
options.Domain = sm.cookieDomain
|
||||
sm.logger.Debugf("Using configured cookie domain: %s", sm.cookieDomain)
|
||||
} else if options.Domain == "" && r != nil {
|
||||
// Fall back to auto-detection only if no domain is configured
|
||||
// In reverse proxy setups, use the original host if available
|
||||
// This ensures cookies work correctly with the public domain
|
||||
host := r.Host
|
||||
@@ -529,10 +539,10 @@ func (sm *SessionManager) EnhanceSessionSecurity(options *sessions.Options, r *h
|
||||
if colonIndex := strings.Index(host, ":"); colonIndex != -1 {
|
||||
host = host[:colonIndex] // Remove port
|
||||
}
|
||||
// For cookie domain, we might want to use the base domain
|
||||
// to allow cookies to work across subdomains
|
||||
// But for now, use the exact host for security
|
||||
// Use the exact host (without leading dot) for host-only cookies
|
||||
// This prevents subdomain access but ensures consistency
|
||||
options.Domain = host
|
||||
sm.logger.Debugf("Auto-detected cookie domain: %s", host)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -555,10 +565,107 @@ func (sm *SessionManager) getSessionOptions(isSecure bool) *sessions.Options {
|
||||
SameSite: http.SameSiteLaxMode,
|
||||
MaxAge: int(absoluteSessionTimeout.Seconds()),
|
||||
Path: "/",
|
||||
Domain: sm.cookieDomain, // Use configured domain if set
|
||||
}
|
||||
return baseOptions
|
||||
}
|
||||
|
||||
// CleanupOldCookies attempts to remove cookies with potentially mismatched domains.
|
||||
// Since browsers don't send domain info with cookies, this function tries to delete
|
||||
// cookies with various domain variations to ensure cleanup after configuration changes.
|
||||
func (sm *SessionManager) CleanupOldCookies(w http.ResponseWriter, r *http.Request) {
|
||||
// Get all cookies from the request
|
||||
cookies := r.Cookies()
|
||||
|
||||
// Get the current configured domain
|
||||
currentDomain := sm.cookieDomain
|
||||
host := r.Host
|
||||
if forwardedHost := r.Header.Get("X-Forwarded-Host"); forwardedHost != "" {
|
||||
host = forwardedHost
|
||||
}
|
||||
// Remove port if present
|
||||
if colonIndex := strings.Index(host, ":"); colonIndex != -1 {
|
||||
host = host[:colonIndex]
|
||||
}
|
||||
|
||||
// Build list of domains to attempt deletion for
|
||||
// This ensures we clean up cookies from various possible domains
|
||||
var domainsToClean []string
|
||||
|
||||
// Add variations of the current host
|
||||
if host != "" && !strings.Contains(host, "localhost") && !strings.Contains(host, "127.0.0.1") {
|
||||
domainsToClean = append(domainsToClean,
|
||||
host, // exact host
|
||||
"."+host, // with leading dot
|
||||
)
|
||||
|
||||
// Add parent domain variations if host has subdomains
|
||||
parts := strings.Split(host, ".")
|
||||
if len(parts) > 2 {
|
||||
// For "sub.example.com", also try "example.com" and ".example.com"
|
||||
parentDomain := strings.Join(parts[len(parts)-2:], ".")
|
||||
domainsToClean = append(domainsToClean,
|
||||
parentDomain,
|
||||
"."+parentDomain,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
// Track which cookies we're processing
|
||||
processedCookies := make(map[string]bool)
|
||||
|
||||
// Check each cookie
|
||||
for _, cookie := range cookies {
|
||||
// Only process our OIDC session cookies
|
||||
if strings.HasPrefix(cookie.Name, mainCookieName) ||
|
||||
strings.HasPrefix(cookie.Name, accessTokenCookie) ||
|
||||
strings.HasPrefix(cookie.Name, refreshTokenCookie) ||
|
||||
strings.HasPrefix(cookie.Name, "_oidc_raczylo_id") ||
|
||||
strings.HasPrefix(cookie.Name, "access_token_chunk_") ||
|
||||
strings.HasPrefix(cookie.Name, "refresh_token_chunk_") {
|
||||
|
||||
// Mark this cookie as seen
|
||||
processedCookies[cookie.Name] = true
|
||||
|
||||
// If we have a configured domain and this is the first request after config change,
|
||||
// attempt to delete the cookie with various domain variations to ensure cleanup
|
||||
sm.cleanupMutex.RLock()
|
||||
shouldCleanup := currentDomain != "" && !sm.cleanupDone
|
||||
sm.cleanupMutex.RUnlock()
|
||||
|
||||
if shouldCleanup {
|
||||
for _, domain := range domainsToClean {
|
||||
// Skip the current configured domain
|
||||
if domain == currentDomain || domain == "."+currentDomain || "."+domain == currentDomain {
|
||||
continue
|
||||
}
|
||||
|
||||
// Create a deletion cookie for this domain variation
|
||||
deleteCookie := &http.Cookie{
|
||||
Name: cookie.Name,
|
||||
Value: "",
|
||||
Path: "/",
|
||||
Domain: domain,
|
||||
MaxAge: -1,
|
||||
HttpOnly: true,
|
||||
Secure: r.Header.Get("X-Forwarded-Proto") == "https" || r.TLS != nil || sm.forceHTTPS,
|
||||
SameSite: http.SameSiteLaxMode,
|
||||
}
|
||||
http.SetCookie(w, deleteCookie)
|
||||
sm.logger.Debugf("Attempting to clean up cookie %s with domain %s", cookie.Name, domain)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Mark cleanup as done for this session manager instance
|
||||
if !sm.cleanupDone && len(processedCookies) > 0 {
|
||||
sm.cleanupMutex.Lock()
|
||||
sm.cleanupDone = true
|
||||
sm.cleanupMutex.Unlock()
|
||||
}
|
||||
}
|
||||
|
||||
// GetSession retrieves all session data for the current request.
|
||||
// It loads the main session and token sessions, including any chunked token data,
|
||||
// and combines them into a single SessionData structure for easy access.
|
||||
@@ -571,6 +678,8 @@ func (sm *SessionManager) GetSession(r *http.Request) (*SessionData, error) {
|
||||
sessionData.dirty = false
|
||||
|
||||
var sessionReturned bool
|
||||
// CRITICAL FIX: Defer logic to return session to pool only on panic, not on successful return
|
||||
// This prevents memory leaks by ensuring sessions are only pooled when not in use by caller
|
||||
defer func() {
|
||||
if !sessionReturned && sessionData != nil {
|
||||
if r := recover(); r != nil {
|
||||
@@ -636,7 +745,9 @@ func (sm *SessionManager) GetSession(r *http.Request) (*SessionData, error) {
|
||||
sm.getTokenChunkSessions(r, refreshTokenCookie, sessionData.refreshTokenChunks)
|
||||
sm.getTokenChunkSessions(r, idTokenCookie, sessionData.idTokenChunks)
|
||||
|
||||
sessionReturned = false
|
||||
// CRITICAL FIX: Mark session as successfully returned to caller - prevents premature pool return
|
||||
// This fixes memory leak where sessions were incorrectly returned to pool immediately after success
|
||||
sessionReturned = true
|
||||
return sessionData, nil
|
||||
}
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ import (
|
||||
func TestSessionCompatibilityAfterChanges(t *testing.T) {
|
||||
t.Run("Plain_HTTP_Without_Proxy_Headers", func(t *testing.T) {
|
||||
// Test that plain HTTP requests without proxy headers still work
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
req := httptest.NewRequest("GET", "http://localhost:8080/test", nil)
|
||||
@@ -67,7 +67,7 @@ func TestSessionCompatibilityAfterChanges(t *testing.T) {
|
||||
|
||||
t.Run("HTTPS_With_TLS_Field", func(t *testing.T) {
|
||||
// Test direct HTTPS connection (not proxied)
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
req := httptest.NewRequest("GET", "https://example.com/test", nil)
|
||||
@@ -101,7 +101,7 @@ func TestSessionCompatibilityAfterChanges(t *testing.T) {
|
||||
|
||||
t.Run("ForceHTTPS_Setting", func(t *testing.T) {
|
||||
// Test forceHTTPS setting works regardless of request
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", true, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", true, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Plain HTTP request
|
||||
@@ -132,7 +132,7 @@ func TestSessionCompatibilityAfterChanges(t *testing.T) {
|
||||
})
|
||||
|
||||
t.Run("AJAX_Request_Gets_Strict_SameSite", func(t *testing.T) {
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// AJAX request
|
||||
@@ -165,7 +165,7 @@ func TestSessionCompatibilityAfterChanges(t *testing.T) {
|
||||
})
|
||||
|
||||
t.Run("Missing_UserAgent_Gets_Reduced_Timeout", func(t *testing.T) {
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, NewLogger("debug"))
|
||||
sessionManager, err := NewSessionManager("test-encryption-key-32-characters", false, "", NewLogger("debug"))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Request without User-Agent (suspicious)
|
||||
|
||||
+11
-11
@@ -16,7 +16,7 @@ import (
|
||||
|
||||
func TestSessionPoolMemoryLeak(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
@@ -44,7 +44,7 @@ func TestSessionPoolMemoryLeak(t *testing.T) {
|
||||
|
||||
// Test 3: Error path in GetSession
|
||||
// Modify the session store to force an error - use a different encryption key
|
||||
badSM, _ := NewSessionManager("different0123456789abcdef0123456789abcdef0123456789", false, logger)
|
||||
badSM, _ := NewSessionManager("different0123456789abcdef0123456789abcdef0123456789", false, "", logger)
|
||||
|
||||
// Get session using mismatched manager/request to force error
|
||||
_, err = badSM.GetSession(req)
|
||||
@@ -68,7 +68,7 @@ func TestSessionPoolMemoryLeak(t *testing.T) {
|
||||
|
||||
func TestSessionErrorHandling(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
@@ -95,7 +95,7 @@ func TestSessionErrorHandling(t *testing.T) {
|
||||
|
||||
func TestSessionClearAlwaysReturnsToPool(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
@@ -181,7 +181,7 @@ func getPooledObjects(sm *SessionManager) int {
|
||||
// returned to the pool in various scenarios including normal usage and error paths
|
||||
func TestSessionObjectTracking(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
@@ -344,7 +344,7 @@ func TestTokenCompressionCorruptionDetection(t *testing.T) {
|
||||
// TestTokenChunkingIntegrity tests that large tokens are properly chunked and reassembled
|
||||
func TestTokenChunkingIntegrity(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
@@ -419,7 +419,7 @@ func TestTokenChunkingIntegrity(t *testing.T) {
|
||||
// TestTokenChunkingCorruptionResistance tests handling of corrupted chunks
|
||||
func TestTokenChunkingCorruptionResistance(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
@@ -525,7 +525,7 @@ func TestTokenChunkingCorruptionResistance(t *testing.T) {
|
||||
// TestTokenSizeLimits tests that token size limits are enforced
|
||||
func TestTokenSizeLimits(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
@@ -592,7 +592,7 @@ func TestTokenSizeLimits(t *testing.T) {
|
||||
// TestConcurrentTokenOperations tests thread safety of token operations
|
||||
func TestConcurrentTokenOperations(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
@@ -646,7 +646,7 @@ func TestConcurrentTokenOperations(t *testing.T) {
|
||||
// TestSessionValidationAndCleanup tests session validation and orphan cleanup
|
||||
func TestSessionValidationAndCleanup(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
@@ -694,7 +694,7 @@ func TestSessionValidationAndCleanup(t *testing.T) {
|
||||
// TestLargeIDTokenChunking tests that large ID tokens are properly chunked across multiple cookies
|
||||
func TestLargeIDTokenChunking(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
|
||||
@@ -43,6 +43,7 @@ type Config struct {
|
||||
AllowedUsers []string `json:"allowedUsers"`
|
||||
Scopes []string `json:"scopes"`
|
||||
Headers []TemplatedHeader `json:"headers"`
|
||||
CookieDomain string `json:"cookieDomain"`
|
||||
RateLimit int `json:"rateLimit"`
|
||||
RefreshGracePeriodSeconds int `json:"refreshGracePeriodSeconds"`
|
||||
ForceHTTPS bool `json:"forceHTTPS"`
|
||||
|
||||
@@ -85,7 +85,7 @@ func setupTestOIDCMiddleware(t *testing.T, config *Config) (*TraefikOidc, *httpt
|
||||
logInfo: log.New(&testWriter{t}, "INFO: ", 0),
|
||||
logDebug: log.New(&testWriter{t}, "DEBUG: ", 0),
|
||||
}
|
||||
sessionManager, _ := NewSessionManager(config.SessionEncryptionKey, false, logger)
|
||||
sessionManager, _ := NewSessionManager(config.SessionEncryptionKey, false, "", logger)
|
||||
|
||||
// Create next handler
|
||||
nextHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
@@ -143,7 +143,7 @@ func setupTestOIDCMiddleware(t *testing.T, config *Config) (*TraefikOidc, *httpt
|
||||
forceHTTPS: config.ForceHTTPS,
|
||||
allowedUserDomains: make(map[string]struct{}),
|
||||
jwkCache: &JWKCache{},
|
||||
metadataCache: NewMetadataCache(),
|
||||
metadataCache: NewMetadataCache(nil),
|
||||
ctx: context.Background(),
|
||||
}
|
||||
|
||||
@@ -217,7 +217,7 @@ func createMockJWT(t *testing.T, sub, email string) string {
|
||||
func createTestSession() *SessionData {
|
||||
// Create a minimal session manager for testing
|
||||
logger := newNoOpLogger()
|
||||
sessionManager, _ := NewSessionManager("test-encryption-key-32-characters", false, logger)
|
||||
sessionManager, _ := NewSessionManager("test-encryption-key-32-characters", false, "", logger)
|
||||
|
||||
// Create a test request
|
||||
req := httptest.NewRequest("GET", "/", nil)
|
||||
|
||||
+1
-1
@@ -14,4 +14,4 @@ func generateRandomString(length int) string {
|
||||
return "random-string-fallback"
|
||||
}
|
||||
return hex.EncodeToString(bytes)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -17,7 +17,7 @@ import (
|
||||
// Token verified successfully multiple times, then fails with "signature verification failed"
|
||||
func TestTokenCorruptionScenario(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
@@ -180,7 +180,7 @@ func TestCompressionIntegrityFailure(t *testing.T) {
|
||||
// TestChunkReassemblyEdgeCases tests edge cases in chunk reassembly that could cause corruption
|
||||
func TestChunkReassemblyEdgeCases(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
@@ -296,7 +296,7 @@ func TestChunkReassemblyEdgeCases(t *testing.T) {
|
||||
// TestRaceConditionProtection tests that concurrent access doesn't cause corruption
|
||||
func TestRaceConditionProtection(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
@@ -432,7 +432,7 @@ func TestMemoryExhaustionProtection(t *testing.T) {
|
||||
// TestBackwardCompatibility ensures that sessions created before the fixes still work
|
||||
func TestBackwardCompatibility(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
|
||||
@@ -247,7 +247,7 @@ func TestSessionIDTokenAccessToken(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
|
||||
// Create a session manager
|
||||
sessionManager, err := NewSessionManager("test-session-encryption-key-at-least-32-bytes", false, logger)
|
||||
sessionManager, err := NewSessionManager("test-session-encryption-key-at-least-32-bytes", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
@@ -318,7 +318,7 @@ func TestSessionIDTokenAccessToken(t *testing.T) {
|
||||
// TestTokenCorruptionIntegrationFlows tests the complete token handling flow with corruption scenarios
|
||||
func TestTokenCorruptionIntegrationFlows(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
@@ -442,7 +442,7 @@ func TestTokenCorruptionIntegrationFlows(t *testing.T) {
|
||||
// TestSessionPersistenceWithCorruption tests that session corruption is handled across requests
|
||||
func TestSessionPersistenceWithCorruption(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
@@ -506,7 +506,7 @@ func TestSessionPersistenceWithCorruption(t *testing.T) {
|
||||
// TestConcurrentTokenOperationsWithCorruption tests concurrent access with intentional corruption
|
||||
func TestConcurrentTokenOperationsWithCorruption(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
@@ -592,7 +592,7 @@ func TestConcurrentTokenOperationsWithCorruption(t *testing.T) {
|
||||
// TestTokenValidationEdgeCases tests edge cases in token validation
|
||||
func TestTokenValidationEdgeCases(t *testing.T) {
|
||||
logger := NewLogger("debug")
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, logger)
|
||||
sm, err := NewSessionManager("0123456789abcdef0123456789abcdef0123456789abcdef", false, "", logger)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to create session manager: %v", err)
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user