gitea-mirror/Pulse
1
0
Fork 0
mirror of https://github.com/rcourtman/Pulse.git synced 2026-02-18 00:17:39 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a1dc451ed460a418d5604f4bab74d9ba1376ab9e
Pulse/MIGRATION_SCAFFOLDING.md
rcourtman 6eb1a10d9b Refactor: Code cleanup and localStorage consolidation 
This commit includes comprehensive codebase cleanup and refactoring:

## Code Cleanup
- Remove dead TypeScript code (types/monitoring.ts - 194 lines duplicate)
- Remove unused Go functions (GetClusterNodes, MigratePassword, GetClusterHealthInfo)
- Clean up commented-out code blocks across multiple files
- Remove unused TypeScript exports (helpTextClass, private tag color helpers)
- Delete obsolete test files and components

## localStorage Consolidation
- Centralize all storage keys into STORAGE_KEYS constant
- Update 5 files to use centralized keys:
  * utils/apiClient.ts (AUTH, LEGACY_TOKEN)
  * components/Dashboard/Dashboard.tsx (GUEST_METADATA)
  * components/Docker/DockerHosts.tsx (DOCKER_METADATA)
  * App.tsx (PLATFORMS_SEEN)
  * stores/updates.ts (UPDATES)
- Benefits: Single source of truth, prevents typos, better maintainability

## Previous Work Committed
- Docker monitoring improvements and disk metrics
- Security enhancements and setup fixes
- API refactoring and cleanup
- Documentation updates
- Build system improvements

## Testing
- All frontend tests pass (29 tests)
- All Go tests pass (15 packages)
- Production build successful
- Zero breaking changes

Total: 186 files changed, 5825 insertions(+), 11602 deletions(-)
2025-11-04 21:50:46 +00:00

1.4 KiB
Raw Blame History

Migration Scaffolding Tracker

This document tracks temporary code added to handle migration paths between versions. All code listed here should be removed according to the specified criteria.

Purpose: These features exist solely to assist users in migrating from old patterns to new ones. They serve no functional purpose beyond migration assistance and represent technical debt that should be cleaned up once the migration period is complete.

Active Migration Code

Removed Migration Code

  • Legacy SSH detection banner (removed in cleanup)

Guidelines for Adding New Migration Code

When adding new migration scaffolding:

  1. Mark it clearly with ⚠️ MIGRATION SCAFFOLDING - TEMPORARY CODE comments
  2. Add it to this document with:
    • Why it exists
    • Files involved
    • Removal criteria
    • Removal instructions
  3. Set explicit removal criteria:
    • Version number target
    • Time-based target (e.g., "6 months after release")
    • Data-driven target (e.g., "when <1% users affected")
  4. Add a kill switch: Environment variable or feature flag to disable without redeployment
  5. Consider telemetry: If removal depends on data, instrument the code to collect that data
  6. Create a removal task: Add to issue tracker with assigned owner and date

Remember: Migration code is technical debt. Make it easy to find and remove later.