Verification Checklist
Verify the Revision workflow across framework setup, document preparation, alignment, comparison, errors, cancellation, and cleanup.
Preconditions: The host application is configured in a development or test environment with known-good files, known-bad files, and at least one pair of files that requires alignment.
- 1Run setup verification for the active framework first.
- 2Run preparation checks with valid, inaccessible, expired, unsupported, and mismatched files.
- 3Run direct comparison with files that should not require alignment.
- 4Run interactive alignment before comparison with files that are visibly offset.
- 5Verify direct compare, interactive alignment, failure recovery, and cleanup through the supported npm API.
- 6Run route navigation and cleanup checks after success, failure, and cancellation.
- 7Record failures against the workflow page that owns the broken behavior.
Use these checkpoints as the acceptance list for a Revision implementation:
- React setup: The viewer initializes only after the container ref exists and cleans up global listeners when the component unmounts.
- Angular setup: The viewer initializes in ngAfterViewInit, updates UI state through Angular change detection when needed, and cleans up in ngOnDestroy.
- Preparation: Invalid URLs, expired access, unsupported files, and mismatched source choices are caught before compare or align starts.
- Direct comparison: A valid aligned pair emits comparisonComplete, clears loading state, and renders the difference result.
- Alignment path: Interactive alignment starts, accepts user-selected reference points, and returns a comparison result or recoverable failure.
- Error handling: comparisonError always unlocks the UI, preserves inputs, and shows a recovery action.
- Cancellation: Cancelling interactive alignment closes transient UI, unlocks inputs, and does not submit a stale comparison.
- Retry: The user can retry after changing a failed condition without refreshing the browser.
- Cleanup: Repeated route changes do not accumulate viewer instances, timers, or stale loading state.
A release-ready Revision workflow passes setup, success, failure, cancellation, retry, and cleanup checks in the supported framework integrations.
When a checkpoint fails, fix the workflow layer that owns the behavior before adding new features. Most recurring issues come from early submit before viewer readiness, unvalidated file access, unsupported direct comparison without alignment, or missing cleanup after terminal events.