extern/hishtory
1
0
Fork 0
mirror of https://github.com/ddworken/hishtory.git synced 2025-01-29 17:51:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add a basic deep cleaning function for the self-hosted server to warn users about cases like #234

Browse Source
This commit is contained in:
David Dworken 2024-08-18 21:48:53 -07:00
parent f9aa3df8bf
commit 28da99d512
No known key found for this signature in database
2 changed files with 61 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
backend/server/internal/database/db.go
View File

@ -4,6 +4,7 @@ import (
"context"
"database/sql"
"fmt"
"os"
"strings"
"time"
@ -427,6 +428,56 @@ func (db *DB) GenerateAndStoreActiveUserStats(ctx context.Context) error {
}).Error
}
func (db *DB) SelfHostedDeepClean(ctx context.Context) error {
return db.WithContext(ctx).Transaction(func(tx *gorm.DB) error {
runDeletes := os.Getenv("HISHTORY_SELF_HOSTED_DEEP_CLEAN") != ""
r := tx.Exec(`
CREATE TEMP TABLE temp_inactive_devices AS (
SELECT device_id
FROM usage_data
WHERE last_used <= (now() - INTERVAL '90 days')
)
`)
if r.Error != nil {
return fmt.Errorf("failed to create list of inactive users: %w", r.Error)
}
if runDeletes {
r = tx.Raw(`
DELETE FROM enc_history_entries WHERE
device_id IN (SELECT * FROM temp_inactive_devices)
`)
if r.Error != nil {
return fmt.Errorf("failed to delete entries for inactive devices: %w", r.Error)
}
r = tx.Raw(`
DELETE FROM devices WHERE
device_id IN (SELECT * FROM temp_inactive_devices)
`)
if r.Error != nil {
return fmt.Errorf("failed to delete inactive devices: %w", r.Error)
}
} else {
r = tx.Raw(`
SELECT COUNT(*)
FROM enc_history_entries
WHERE device_id IN (SELECT * FROM temp_inactive_devices)
`)
if r.Error != nil {
return fmt.Errorf("failed to count entries for inactive devices: %w", r.Error)
}
count, err := extractInt64FromRow(r.Row())
if err != nil {
return fmt.Errorf("failed to extract count of entries for inactive devices: %w", err)
}
if count > 10_000 {
fmt.Printf("WARNING: This server is persisting %d entries for devices that have been offline for more than 90 days. If this is unexpected, set the server environment variable HISHTORY_SELF_HOSTED_DEEP_CLEAN=1 to permanently delete these devices.\n", count)
}
}
fmt.Println("Successfully checked for inactive devices")
return nil
})
}
func (db *DB) DeepClean(ctx context.Context) error {
err := db.WithContext(ctx).Transaction(func(tx *gorm.DB) error {
// Delete entries for users that have one device and are inactive

13
backend/server/server.go
View File

@ -128,10 +128,17 @@ func cron(ctx context.Context, db *database.DB, stats *statsd.Client) error {
}
// Run a deep clean less often to cover some more edge cases that hurt DB performance
if isProductionEnvironment() && time.Since(LAST_DEEP_CLEAN) > 24*3*time.Hour {
if time.Since(LAST_DEEP_CLEAN) > 24*3*time.Hour {
LAST_DEEP_CLEAN = time.Now()
if err := db.DeepClean(ctx); err != nil {
return fmt.Errorf("db.DeepClean: %w", err)
if isProductionEnvironment() {
if err := db.DeepClean(ctx); err != nil {
return fmt.Errorf("db.DeepClean: %w", err)
}
}
if !isProductionEnvironment() && !isTestEnvironment() {
if err := db.SelfHostedDeepClean(ctx); err != nil {
return fmt.Errorf("db.SelfHostedDeepClean: %w", err)
}
}
}