File-by-file: URL Hash helper utility
What does this MR do and why?
Adds some utilities for testing the URL hash against some known formats that we can use.
Why
Context
For #337263 (closed).
We are making File-by-file view mode much more useful by only fetching the single file that you are trying to view at any time.
In extreme cases, if the file you are viewing is the last in a long list (say 100s or 1000s of files), batch-loading the diffs could introduce an extremely noticeable delay before your single file is loaded and displays while the app loads tons of files you have no interest in.
The above issue - and this chain of MRs - will resolve that problem by loading only the file needed to display.
Specifics
In the current paradigm, we only ever read the note hash from the URL once.
However, in the future, we'll be loading individual files dynamically, and will need to continually re-check whether we need to scroll to a comment.
Since this can happen a few different ways, duplicating the different parts of this logic became quite cumbersome.
Putting them all in one place is an obvious improvement as this area is getting more complicated.
Roadmap
This MR is one of a set of changes that will eventually implement this feature.
Phase 1 - Preparation
| Status | MR | Purpose |
|---|---|---|
|
|
!112515 (merged) | Adds the API access we need for the more surgical data |
|
|
!112516 (merged) | Switches to using our initial metadata representation of the MR for many operations |
|
|
!113941 (merged) | Marks metadata files as loaded so future uses don't try to load them again |
Phase 2 - New Abilities
| Status | MR | Purpose |
|---|---|---|
| We are here! |
!113940 (merged) | Adds helpers to re-retrieve the hash from the URL since it only needed to be fetched once before |
|
|
!113937 (merged) | Adds an action to fetch and store a single file versus the existing full diff batch loading |
|
|
!114009 (merged) | Add a getter to check the files marked in !113941 (merged) to simplify "already-loaded" guard clauses |
|
|
!114024 (merged) | Add an action to scroll to a file async (and load it if necessary) |
|
|
!114170 (merged) | Adds an action to re-check the note hash from the URL and potentially fetch the appropriate file |
Phase 3 - Implementation
| Status | MR | Purpose |
|---|---|---|
|
|
!111895 (merged) | Adds the feature that will only load the proper file when necessary to display it |
Screenshots or screen recordings
N/A, all backstage
How to set up and validate locally
Since this code isn't yet used, there's nothing to validate other than running the unit tests.
MR acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this MR.