Skip to content

Job Progress Integration and Merge Preparation

Status: 🔄 In Progress (50% - 3/6 tasks complete) Priority: Medium Story Points: 8 Assignee: @chrissena Created: 2025-08-11 Latest Update: 2025-09-12

Problem Statement

The job progress feature work has been developed but requires integration work and additional changes before it can be merged into the master branch. The feature includes updates to the Study Management interface, RoB (Risk of Bias) flags, and table layouts.

Current State:

  • Job progress work exists in a feature branch
  • Some integration tasks completed (Study Management flag, RoB flags, table layout fixes)
  • Remaining work needed: data mismatch resolution, component structure refactoring
  • Not yet deployed - waiting for feature flag integration

Pain Points:

  • Feature work isolated in branch - not available to users
  • Data mismatch in "last modified" column needs resolution
  • Component structure needs cleanup before merge
  • Feature flag strategy needed for safe deployment

Proposed Solution

Complete the remaining integration tasks and merge the job progress feature into master behind a feature flag for controlled rollout.

Technical Approach:

  1. Fix Data Mismatch Issue (Priority 1):
  2. Resolve discrepancy in "last modified" column data
  3. Ensure data consistency across Study Management views
  4. Add validation/tests to prevent future mismatches

  5. Refactor Component Structure (Priority 2):

  6. Restructure components following Angular best practices
  7. Improve separation of concerns
  8. Extract reusable components where appropriate
  9. Update imports and dependencies

  10. Feature Flag Integration (Priority 3):

  11. Implement feature flag for job progress UI
  12. Ensure backward compatibility when flag disabled
  13. Allow toggling without code changes
  14. Document flag usage for operations team

  15. Merge to Master (Final Step):

  16. Create PR with comprehensive testing
  17. Code review with team
  18. Deploy to staging with flag disabled
  19. Gradually enable for testing
  20. Production deployment behind feature flag

Acceptance Criteria

Completed ✅:

  • Use new Study Management interface flag
  • Use RoB (Risk of Bias) Flags
  • Fix table layout issues

Remaining ⏳:

  • Fix data mismatch issue for "last modified" column
  • Refactor component structure
  • Push to master with feature flag
  • Deploy behind feature flag for controlled rollout

Technical Notes

Architecture

Frontend Components (Web Service):

  • Study Management interface components
  • Job progress display components
  • RoB flag components
  • Table layout components

State Management:

  • ngrx store for job progress state
  • Study Management state integration
  • RoB flag state management

Feature Flag System:

  • Configuration-based feature toggles
  • Environment-specific flag management
  • Runtime flag evaluation

Dependencies

Related Work:

  • Study Management interface updates
  • RoB (Risk of Bias) flag implementation
  • Job progress tracking backend (assumed complete)

External Dependencies:

  • Feature flag configuration system
  • Angular 18 Material components
  • ngrx 18 state management

Testing Strategy

Unit Tests:

describe('JobProgressComponent', () => {
  it('should display job progress when feature flag enabled', () => {
    // Test component behavior with flag ON
  });

  it('should hide job progress when feature flag disabled', () => {
    // Test component behavior with flag OFF
  });

  it('should display correct "last modified" data', () => {
    // Test data mismatch fix
  });
});

Integration Tests:

  • Full Study Management workflow with job progress
  • RoB flag integration with job tracking
  • Feature flag toggling scenarios

Manual Testing:

  • Test with feature flag enabled/disabled
  • Verify "last modified" column accuracy
  • Check component structure and performance
  • Validate backward compatibility

Blockers and Risks

Current Blockers

  • ⚠️ Data Mismatch: "Last modified" column showing incorrect data - needs investigation
  • ⚠️ Component Structure: Current structure needs refactoring before merge

Risks

  • 🔶 Merge Conflicts: Long-running branch may have conflicts with master
  • 🔶 Regression: Changes could affect existing Study Management functionality
  • 🔶 Feature Flag Complexity: Need to ensure proper flag implementation to avoid issues

Next Actions

Immediate (This Sprint)

  1. Investigate Data Mismatch:
  2. Review "last modified" column data source
  3. Identify root cause of discrepancy
  4. Implement fix with tests
  5. Verify across different study types

  6. Component Structure Refactoring:

  7. Review current component organization
  8. Plan refactoring approach
  9. Implement changes incrementally
  10. Update tests to match new structure

  11. Feature Flag Setup:

  12. Define feature flag configuration
  13. Implement flag checks in components
  14. Test flag toggling scenarios
  15. Document flag usage

Before Merge

  1. Code Review Preparation:
  2. Clean up branch history
  3. Update component documentation
  4. Write comprehensive PR description
  5. Prepare demo for team review

  6. Testing and Validation:

  7. Run full test suite
  8. Manual testing on staging
  9. Performance testing
  10. Accessibility testing

Success Metrics

  • ✅ All 6 acceptance criteria completed
  • ✅ No regressions in Study Management functionality
  • ✅ "Last modified" column displays accurate data
  • ✅ Component structure follows team standards
  • ✅ Feature flag allows safe rollout
  • ✅ Code review approved by team
  • ✅ Successfully deployed to staging and production
  • Issue #1917: Primary tracking issue
  • Study Management: Related interface updates
  • RoB Flags: Risk of Bias flag integration

Timeline

Created: 2025-08-11 Latest Update: 2025-09-12 Estimated Completion: TBD (pending data mismatch resolution)


Source: GitHub Issue #1917 Last Synced: 2025-11-24

This feature brief was auto-generated from the GitHub issue. The work is 50% complete with 3 of 6 checklist items done. Key remaining work includes fixing the data mismatch issue and refactoring component structure before merge to master.

Next Steps:

  1. Prioritize data mismatch investigation
  2. Plan component structure refactoring
  3. Implement feature flag integration
  4. Prepare for code review and merge