fix: preserve scroll position when projects refresh #642
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a bug where users lost their scroll position in SwaggerUI when switching tabs/windows. The issue occurred because encrypted remote spec URLs with random IVs were causing unnecessary React state updates on every refresh, even when the underlying data hadn't changed.
Key Changes:
- Implemented structural comparison logic to detect actual project changes instead of comparing full JSON
- Added
urlHashfield to track remote URL changes without relying on encrypted URLs - Replaced direct state updates with conditional updates that preserve reference equality when data hasn't changed
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| src/features/projects/view/ProjectsContextProvider.tsx | Introduced setProjectsIfChanged function that compares projects by structural identity (owner, name, version IDs, spec IDs, and urlHash) to prevent unnecessary state updates |
| src/features/projects/domain/OpenApiSpecification.ts | Added optional urlHash field to the schema for tracking remote URL changes |
| src/features/projects/data/GitHubProjectDataSource.ts | Imported crypto module and generates SHA-256 hash of remote config to populate the urlHash field for remote specifications |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ulrikandersen
force-pushed
the
hotfix/preserve-scroll-on-project-refresh
branch
2 times, most recently
from
21163f7 to
02ecd71
Compare
The encrypted URLs for remote specs contain random IVs, causing different ciphertext on each refresh. This triggered unnecessary state updates and re-renders, resetting the documentation viewer's scroll position. Add urlHash field computed from underlying remote config, and compare projects by fingerprint (urlHash for remote specs, URL for others).
ulrikandersen
force-pushed
the
hotfix/preserve-scroll-on-project-refresh
branch
from
02ecd71 to
dc61995
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Preserve scroll position in documentation viewer when projects refresh in the background.
Remote spec URLs are encrypted with random IVs, producing different ciphertext on each refresh even when the underlying config hasn't changed. This was triggering unnecessary React state updates.
Solution: Add a
urlHashfield (SHA-256 of the underlying remote config) and compare projects by fingerprint instead of encrypted URLs.Motivation and Context
Users were losing their scroll position in SwaggerUI when switching tabs/windows, because the visibility change event triggers a project refresh that was incorrectly detected as "changed" data.
Screenshots (if appropriate):
Skaermoptagelse.2025-12-19.kl.10.03.41.mov
Types of changes