forked from trent_larson/crowd-funder-for-time-pwa
Update migration template with comprehensive time tracking system (15 minutes)
Time Tracking Integration: Add mandatory timing steps and performance analysis Performance Targets: Include realistic complexity-based duration estimates Quality Gates: Require time data in commits and performance comparison Project Estimates: Update to 2-3 weeks based on actual performance data Time: 15 minutes | Complexity: Simple | Issues: None Testing: Manual | Validation: Template review complete
This commit is contained in:
@@ -3,6 +3,8 @@
|
||||
## Overview
|
||||
This checklist ensures NO migration steps are forgotten. **Every component migration MUST complete ALL sections.**
|
||||
|
||||
## ⏱️ **TIME TRACKING REQUIREMENT**: All migrations must be timed and performance recorded
|
||||
|
||||
## ⚠️ CRITICAL: Enhanced Triple Migration Pattern
|
||||
|
||||
### 🔑 The Complete Pattern (ALL 4 REQUIRED)
|
||||
@@ -16,12 +18,23 @@ This checklist ensures NO migration steps are forgotten. **Every component migra
|
||||
|
||||
## Pre-Migration Assessment
|
||||
|
||||
### [ ] 0. Start Time Tracking
|
||||
- [ ] **MANDATORY**: Run `./scripts/time-migration.sh [ComponentName.vue] start`
|
||||
- [ ] Record start time in terminal output
|
||||
- [ ] Keep terminal open for entire migration process
|
||||
|
||||
### [ ] 1. Component Complexity Assessment
|
||||
- [ ] **Simple** (15-20 min): Dialog components, minimal DB operations, few notifications
|
||||
- [ ] **Medium** (30-45 min): Standard views, moderate DB usage, multiple notifications
|
||||
- [ ] **Complex** (45-60 min): Large views, extensive DB operations, many notifications
|
||||
- [ ] Document complexity level for performance tracking
|
||||
|
||||
### Date Time Context
|
||||
- [ ] Always use system date command to establish accurate time context
|
||||
- [ ] Use time log to track project progress
|
||||
- [ ] Use historical time durations to improve estimates
|
||||
|
||||
### [ ] 1. Identify Legacy Patterns
|
||||
### [ ] 2. Identify Legacy Patterns
|
||||
- [ ] Count `databaseUtil` imports and calls
|
||||
- [ ] Count raw SQL queries (`SELECT`, `INSERT`, `UPDATE`, `DELETE`)
|
||||
- [ ] Count `$notify()` calls
|
||||
@@ -29,32 +42,32 @@ This checklist ensures NO migration steps are forgotten. **Every component migra
|
||||
- [ ] Identify template complexity patterns (repeated expressions, long class strings)
|
||||
- [ ] Document total issues found
|
||||
|
||||
### [ ] 2. Verify PlatformServiceMixin Setup
|
||||
### [ ] 3. Verify PlatformServiceMixin Setup
|
||||
- [ ] Component already imports `PlatformServiceMixin`
|
||||
- [ ] Component already has `mixins: [PlatformServiceMixin]`
|
||||
- [ ] If missing, add mixin first
|
||||
|
||||
## Phase 1: Database Migration
|
||||
|
||||
### [ ] 3. Replace Database Utility Calls
|
||||
### [ ] 4. Replace Database Utility Calls
|
||||
- [ ] Remove `import * as databaseUtil from "../db/databaseUtil"`
|
||||
- [ ] Replace `databaseUtil.retrieveSettingsForActiveAccount()` → `this.$accountSettings()`
|
||||
- [ ] Replace `databaseUtil.mapQueryResultToValues()` → `this.$mapQueryResultToValues()`
|
||||
- [ ] Replace other `databaseUtil.*` calls with mixin equivalents
|
||||
|
||||
### [ ] 4. Replace Logging Calls
|
||||
### [ ] 5. Replace Logging Calls
|
||||
- [ ] Remove `import { logConsoleAndDb } from "../db/index"`
|
||||
- [ ] Replace `logConsoleAndDb()` → `this.$logAndConsole()`
|
||||
|
||||
## Phase 2: SQL Abstraction Migration
|
||||
|
||||
### [ ] 5. Replace Raw Contact Operations
|
||||
### [ ] 6. Replace Raw Contact Operations
|
||||
- [ ] `SELECT * FROM contacts WHERE did = ?` → `this.$getContact(did)`
|
||||
- [ ] `DELETE FROM contacts WHERE did = ?` → `this.$deleteContact(did)`
|
||||
- [ ] `UPDATE contacts SET x = ? WHERE did = ?` → `this.$updateContact(did, changes)`
|
||||
- [ ] `INSERT INTO contacts` → `this.$insertContact(contact)`
|
||||
|
||||
### [ ] 6. Replace Other Raw SQL
|
||||
### [ ] 7. Replace Other Raw SQL
|
||||
- [ ] `SELECT * FROM settings` → `this.$accountSettings()`
|
||||
- [ ] `UPDATE settings` → `this.$saveSettings(changes)`
|
||||
- [ ] Generic queries → appropriate service methods
|
||||
@@ -62,18 +75,18 @@ This checklist ensures NO migration steps are forgotten. **Every component migra
|
||||
|
||||
## Phase 3: Notification Migration
|
||||
|
||||
### [ ] 7. Add Notification Infrastructure
|
||||
### [ ] 8. Add Notification Infrastructure
|
||||
- [ ] Add import: `import { createNotifyHelpers, TIMEOUTS } from "@/utils/notify"`
|
||||
- [ ] Add property: `notify!: ReturnType<typeof createNotifyHelpers>;`
|
||||
- [ ] Add initialization: `created() { this.notify = createNotifyHelpers(this.$notify); }`
|
||||
|
||||
### [ ] 8. Add Notification Constants to Central File
|
||||
### [ ] 9. Add Notification Constants to Central File
|
||||
- [ ] **CRITICAL**: Add constants to `src/constants/notifications.ts` (NOT local constants)
|
||||
- [ ] Use naming pattern: `NOTIFY_[COMPONENT]_[ACTION]` (e.g., `NOTIFY_OFFER_SETTINGS_ERROR`)
|
||||
- [ ] Import constants: `import { NOTIFY_X, NOTIFY_Y } from "@/constants/notifications"`
|
||||
- [ ] **NO LOCAL CONSTANTS**: All notification text must be centralized
|
||||
|
||||
### [ ] 9. Replace Notification Calls
|
||||
### [ ] 10. Replace Notification Calls
|
||||
- [ ] **Warning**: `this.$notify({type: "warning"})` → `this.notify.warning(CONSTANT.message, TIMEOUTS.LONG)`
|
||||
- [ ] **Error**: `this.$notify({type: "danger"})` → `this.notify.error(CONSTANT.message, TIMEOUTS.LONG)`
|
||||
- [ ] **Success**: `this.$notify({type: "success"})` → `this.notify.success(CONSTANT.message, TIMEOUTS.STANDARD)`
|
||||
@@ -81,7 +94,7 @@ This checklist ensures NO migration steps are forgotten. **Every component migra
|
||||
- [ ] **Confirm**: `this.$notify({type: "confirm"})` → `this.notify.confirm(message, onYes)`
|
||||
- [ ] **Standard patterns**: Use `this.notify.confirmationSubmitted()`, `this.notify.sent()`, etc.
|
||||
|
||||
### [ ] 10. Constants vs Literal Strings
|
||||
### [ ] 11. Constants vs Literal Strings
|
||||
- [ ] **Use constants** for static, reusable messages
|
||||
- [ ] **Use literal strings** for dynamic messages with variables
|
||||
- [ ] **Extract literals from complex modals** - Even raw `$notify` calls should use constants for text
|
||||
@@ -89,19 +102,19 @@ This checklist ensures NO migration steps are forgotten. **Every component migra
|
||||
|
||||
## Phase 4: Template Streamlining
|
||||
|
||||
### [ ] 11. Identify Template Complexity Patterns
|
||||
### [ ] 12. Identify Template Complexity Patterns
|
||||
- [ ] **Repeated CSS Classes**: Long Tailwind strings used multiple times
|
||||
- [ ] **Complex Configuration Objects**: Multi-line objects in template
|
||||
- [ ] **Repeated Function Calls**: Same logic executed multiple times
|
||||
- [ ] **Complex Conditional Logic**: Nested ternary or complex boolean expressions
|
||||
|
||||
### [ ] 12. Extract to Computed Properties
|
||||
### [ ] 13. Extract to Computed Properties
|
||||
- [ ] **CSS Class Groups**: Extract repeated styling to computed properties
|
||||
- [ ] **Configuration Objects**: Move router configs, form configs to computed
|
||||
- [ ] **Conditional Logic**: Extract complex `v-if` conditions to computed properties
|
||||
- [ ] **Dynamic Values**: Convert repeated calculations to cached computed properties
|
||||
|
||||
### [ ] 13. Document Computed Properties
|
||||
### [ ] 14. Document Computed Properties
|
||||
- [ ] **JSDoc Comments**: Add comprehensive comments for all computed properties
|
||||
- [ ] **Purpose Documentation**: Explain what template complexity each property solves
|
||||
- [ ] **Organized Sections**: Group related computed properties with section headers
|
||||
@@ -109,19 +122,19 @@ This checklist ensures NO migration steps are forgotten. **Every component migra
|
||||
|
||||
## Phase 5: Code Quality Review
|
||||
|
||||
### [ ] 14. Template Quality Assessment
|
||||
### [ ] 15. Template Quality Assessment
|
||||
- [ ] **Readability**: Template is easy to scan and understand
|
||||
- [ ] **Maintainability**: Styling changes can be made in one place
|
||||
- [ ] **Performance**: Computed properties cache expensive operations
|
||||
- [ ] **Consistency**: Similar patterns use similar solutions
|
||||
|
||||
### [ ] 15. Component Architecture Review
|
||||
### [ ] 16. Component Architecture Review
|
||||
- [ ] **Single Responsibility**: Component has clear, focused purpose
|
||||
- [ ] **Props Interface**: Clear, well-documented component props
|
||||
- [ ] **Event Emissions**: Appropriate event handling and emission
|
||||
- [ ] **State Management**: Component state is minimal and well-organized
|
||||
|
||||
### [ ] 16. Code Organization Review
|
||||
### [ ] 17. Code Organization Review
|
||||
- [ ] **Import Organization**: Imports are grouped logically (Vue, constants, services)
|
||||
- [ ] **Method Organization**: Methods are grouped by purpose with section headers
|
||||
- [ ] **Property Organization**: Data properties are documented and organized
|
||||
@@ -129,17 +142,17 @@ This checklist ensures NO migration steps are forgotten. **Every component migra
|
||||
|
||||
## Validation Phase
|
||||
|
||||
### [ ] 17. Run Validation Script
|
||||
### [ ] 18. Run Validation Script
|
||||
- [ ] Execute: `scripts/validate-migration.sh`
|
||||
- [ ] **MUST show**: "Technically Compliant" (not "Mixed Pattern")
|
||||
- [ ] **Zero** legacy patterns detected
|
||||
|
||||
### [ ] 18. Run Linting
|
||||
### [ ] 19. Run Linting
|
||||
- [ ] Execute: `npm run lint-fix`
|
||||
- [ ] **Zero errors** introduced
|
||||
- [ ] **TypeScript compiles** without errors
|
||||
|
||||
### [ ] 19. Manual Code Review
|
||||
### [ ] 20. Manual Code Review
|
||||
- [ ] **NO** `databaseUtil` imports or calls
|
||||
- [ ] **NO** raw SQL queries (`SELECT`, `INSERT`, `UPDATE`, `DELETE`)
|
||||
- [ ] **NO** `$notify()` calls with object syntax
|
||||
@@ -149,24 +162,43 @@ This checklist ensures NO migration steps are forgotten. **Every component migra
|
||||
- [ ] **ALL** notifications through helper methods with centralized constants
|
||||
- [ ] **ALL** complex template logic extracted to computed properties
|
||||
|
||||
## ⏱️ Time Tracking & Commit Phase
|
||||
|
||||
### [ ] 21. End Time Tracking
|
||||
- [ ] **MANDATORY**: Run `./scripts/time-migration.sh [ComponentName.vue] end`
|
||||
- [ ] Record total duration from terminal output
|
||||
- [ ] Note any blockers or issues that impacted timing
|
||||
|
||||
### [ ] 22. Commit with Time Data
|
||||
- [ ] **MANDATORY**: Include time data in commit message
|
||||
- [ ] Use template: `Complete [ComponentName] Enhanced Triple Migration Pattern (X minutes)`
|
||||
- [ ] Include complexity level and any issues encountered
|
||||
- [ ] Document specific changes made in each phase
|
||||
|
||||
### [ ] 23. Performance Analysis
|
||||
- [ ] Compare actual time vs. estimated time for complexity level
|
||||
- [ ] Note if component was faster/slower than expected
|
||||
- [ ] Document any efficiency improvements discovered
|
||||
|
||||
## Documentation Phase
|
||||
|
||||
### [ ] 20. Update Migration Documentation
|
||||
### [ ] 24. Update Migration Documentation
|
||||
- [ ] Create `docs/migration-testing/[COMPONENT]_MIGRATION.md`
|
||||
- [ ] Document all changes made (database, SQL, notifications, template)
|
||||
- [ ] Include before/after examples for template streamlining
|
||||
- [ ] Note validation results
|
||||
- [ ] Note validation results and timing data
|
||||
- [ ] Provide a guide to finding the components in the user interface
|
||||
- [ ] Include code quality review notes
|
||||
|
||||
### [ ] 21. Update Testing Tracker
|
||||
### [ ] 25. Update Testing Tracker
|
||||
- [ ] Update `docs/migration-testing/HUMAN_TESTING_TRACKER.md`
|
||||
- [ ] Mark component as "Ready for Testing"
|
||||
- [ ] Include notes about migration completed with template streamlining
|
||||
- [ ] Record actual migration time for future estimates
|
||||
|
||||
## Human Testing Phase
|
||||
|
||||
### [ ] 22. Test All Functionality
|
||||
### [ ] 26. Test All Functionality
|
||||
- [ ] **Core functionality** works correctly
|
||||
- [ ] **Database operations** function properly
|
||||
- [ ] **Notifications** display correctly with proper timing
|
||||
@@ -174,22 +206,43 @@ This checklist ensures NO migration steps are forgotten. **Every component migra
|
||||
- [ ] **Template rendering** performs smoothly with computed properties
|
||||
- [ ] **Cross-platform** compatibility (web/mobile)
|
||||
|
||||
### [ ] 23. Confirm Testing Complete
|
||||
### [ ] 27. Confirm Testing Complete
|
||||
- [ ] User confirms component works correctly
|
||||
- [ ] Update testing tracker with results
|
||||
- [ ] Mark as "Human Tested" in validation script
|
||||
|
||||
## Final Validation
|
||||
|
||||
### [ ] 24. Comprehensive Check
|
||||
### [ ] 28. Comprehensive Check
|
||||
- [ ] Component shows as "Technically Compliant" in validation
|
||||
- [ ] All manual testing passed
|
||||
- [ ] Zero legacy patterns remain
|
||||
- [ ] Template streamlining complete
|
||||
- [ ] Code quality review passed
|
||||
- [ ] Documentation complete
|
||||
- [ ] Time tracking data recorded
|
||||
- [ ] Ready for production
|
||||
|
||||
## ⏱️ **Time Tracking Performance Targets**
|
||||
|
||||
### **Expected Durations by Complexity**
|
||||
- **Simple Components**: 15-20 minutes
|
||||
- **Medium Components**: 30-45 minutes
|
||||
- **Complex Components**: 45-60 minutes
|
||||
|
||||
### **Quality Gates**
|
||||
- [ ] Start time logged with script
|
||||
- [ ] End time logged with script
|
||||
- [ ] Duration recorded in commit message
|
||||
- [ ] Performance compared to expected range
|
||||
- [ ] Issues affecting timing documented
|
||||
|
||||
### **Efficiency Tracking**
|
||||
- [ ] Batch similar components for efficiency
|
||||
- [ ] Use proven patterns to reduce time
|
||||
- [ ] Note any new patterns or shortcuts discovered
|
||||
- [ ] Update time estimates based on actual performance
|
||||
|
||||
## Wait for human confirmation before proceeding to next file unless directly overridden.
|
||||
|
||||
## 🚨 FAILURE CONDITIONS
|
||||
@@ -199,22 +252,29 @@ This checklist ensures NO migration steps are forgotten. **Every component migra
|
||||
- Raw SQL queries (`SELECT`, `INSERT`, `UPDATE`, `DELETE`)
|
||||
- `$notify()` calls with object syntax
|
||||
- `logConsoleAndDb()` calls
|
||||
- Local notification constants (should be centralized)
|
||||
- Complex template expressions without computed properties
|
||||
- Missing notification helpers setup
|
||||
- Validation script shows "Mixed Pattern"
|
||||
- Local notification constants
|
||||
- Complex template logic not extracted to computed properties
|
||||
- **Missing time tracking data in commit**
|
||||
|
||||
## 🎯 SUCCESS CRITERIA
|
||||
**❌ INCOMPLETE TIME TRACKING** if ANY of these are missing:
|
||||
- Start time not logged
|
||||
- End time not logged
|
||||
- Duration not recorded in commit message
|
||||
- Complexity level not assessed
|
||||
- Performance not compared to targets
|
||||
|
||||
**✅ COMPLETE MIGRATION** requires ALL:
|
||||
## 🎯 **SUCCESS CRITERIA**
|
||||
|
||||
**✅ COMPLETE MIGRATION** requires ALL of these:
|
||||
- All four migration phases completed
|
||||
- Zero legacy patterns detected
|
||||
- All database operations through service layer
|
||||
- All notifications through helper methods with centralized constants
|
||||
- Template complexity extracted to computed properties
|
||||
- Code quality review passed
|
||||
- Validation script shows "Technically Compliant"
|
||||
- Manual testing passed
|
||||
- Documentation complete
|
||||
- All validation scripts pass
|
||||
- Time tracking data recorded
|
||||
- Commit includes performance metrics
|
||||
- Documentation updated
|
||||
- Ready for human testing
|
||||
|
||||
**Expected Project Completion**: 2-3 weeks (69 remaining components × 20 minutes average = 23 hours = 3 days focused work)
|
||||
|
||||
## Templates and References
|
||||
|
||||
|
||||
Reference in New Issue
Block a user