feat(hub-common): allow force updates of cache files as well as cache status reporting #1657
+273
−29
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
…es and returning the status affects: @esri/hub-common
… polling affects: @esri/hub-common
sonofflynn89
changed the title
affects: @esri/hub-common
sonofflynn89
commented
Sep 19, 2024
| @@ -53,7 +53,6 @@ export async function fetchExportImageDownloadFile( | |||
| // } | |||
|
|
|||
| const blob: Blob = await request(`${entity.url}/exportImage`, requestOptions); | |||
| progressCallback && progressCallback(DownloadOperationStatus.COMPLETED); | |||
There was a problem hiding this comment.
As part of this PR, we made the decision that fetchDownloadFile() delegates are no longer responsible for emitting the "complete" event. It is up to the caller of fetchDownloadFile() to notify that the download is complete.
sonofflynn89
commented
Sep 19, 2024
| }; | ||
| } | ||
|
|
||
| // Operation still in progress, poll again | ||
| // Operation still in progress. Report progress if a callback was provided and poll again. | ||
| progressCallback && progressCallback(operationStatus, progressInPercent); |
There was a problem hiding this comment.
Moving this for the same reason as above. We don't want to emit the "complete" event from within this function.
affects: @esri/hub-common
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.
Part of https://devtopia.esri.com/dc/hub/issues/11445
This PR is meant to reflect new realities in our Download API, namely:
fetchDownloadFile()to update the cache by providing the "updateCache" optionAs an aside, we decided to remove the implicit requirement that
fetchDownloadFile()would callprogressCallbackwith a completed status. It's now up to the callers offetchDownloadFile()to inform interested parties that the download is complete.Updated meaningful TSDoc to methods including Parameters and Returns, see Documentation Guide
used semantic commit messages
PR title follows semantic commit format (CRITICAL if the title is not in a semantic format, the release automation will not run!)