[ui] Separate Diffs and Versions from the /versions endpoint as far as Ember is concerned #24145
Conversation
This file contains 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
philrenaud
commented
Oct 7, 2024
| @computed('versions.[]') | ||
| diffs = []; | ||
|
|
||
| @computed('versions.[]', 'diffs.[]') |
There was a problem hiding this comment.
the @computed prefix to this getter indicates something that should trigger an update.
philrenaud
commented
Oct 7, 2024
| @@ -38,7 +40,8 @@ export default class JobVersionsStream extends Component { | |||
| } | |||
| } | |||
|
|
|||
| return { version, meta }; | |||
| const diff = this.diffs.objectAt(index); | |||
| return { version, meta, diff }; | |||
There was a problem hiding this comment.
This is the component layer where we opt to join the Version and its Diff, which are otherwise same-indexed objects in separate arrays.
philrenaud
commented
Oct 7, 2024
| refreshModel: true, | ||
| }, | ||
| }; | ||
|
|
There was a problem hiding this comment.
Now that the route doesn't care about Diff data (the controller does), we don't need to make it concerned with queryParams / it doesn't need to re-fetch the versions when the user switches the comparison version via dropdown
philrenaud
commented
Oct 7, 2024
| related: buildURL(`${jobURL}/versions`, { namespace, diffs: true }), | ||
| related: buildURL(`${jobURL}/versions`, { | ||
| namespace, | ||
| }), |
There was a problem hiding this comment.
We no longer need to get .Diffs[] on initial model load
philrenaud
force-pushed
the
24144-ui-a-new-version-run-in-the-background-incorrectly-displays-diffs-on-the-versions-page
branch
from
bb02926
to
e003878
Compare
philrenaud
force-pushed
the
24144-ui-a-new-version-run-in-the-background-incorrectly-displays-diffs-on-the-versions-page
branch
from
e003878
to
4a25e53
Compare
Ember Test Audit comparison
|
tgross
approved these changes
Oct 7, 2024
philrenaud
force-pushed
the
24144-ui-a-new-version-run-in-the-background-incorrectly-displays-diffs-on-the-versions-page
branch
from
3f79962
to
f74bef3
Compare
philrenaud
deleted the
24144-ui-a-new-version-run-in-the-background-incorrectly-displays-diffs-on-the-versions-page
branch
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.
This separates
Diffobjects fromVersionobjects at the route/model layer, preferring to join them at component/view layer.For context: a diff living at
versions[].diffhas made sense prior to #24055, since a version diff was only ever against its previous version.Now that we can modify the "version to diff against" on the versions page, that model comes with side-effects (like the bug the Jira ticket uncovers, where a newly-pushed version would unblock the /versions query, but no update the diffs' position until refresh)
Now when you load the /versions page, 3 things happen:
/versionstakes place to get job versions and its data is returned on page/versions?index=numis opened, and resolved any time there is new version information / a new version/versions?diffs=true<&diffVersion=numtakes place and only the.Diffsinformation is processedThis is a little inefficient from a fetch perspective, but preserves a lot of conventions in our frontend (like "Watch the versions relationship on this job") and seems like the idiomatic way to do it.
Resolves #24144 (Jira)