This repository has been archived by the owner on Feb 12, 2023. It is now read-only.
Issue 459 avoid page load blocks #460
Merged
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
- The version note depends on the latest version as reported by GitHub, which requires an HTTP request to their servers. - This service takes care of the various scenarios that this request might create: HTTP interaction problems, temporal bans by GitHub (HTTP 403 response), parsing errors, etc. - This service implements a 24 hour cache to prevent throttling issues. - Each client will make 5 or 6 requests in a row when loading (one for each view that needs the version note - see the browser's network inspector) and we don't want to create the same amount of requests to GitHub's API.
- We now use a new service that will return the full version note depending on the current deployed version and the latest available version as reported by GitHub (which refreshes every 24 hours) - The main reason for this change is that Aggregate should be able to load without access to the internet. - This required changing the XMLHttpRequest to run asynchronously and subscribing to the error events, but this conflicted with the blocking nature of GWT Java UI building and the complexities of JSNI interaction. - By moving the interaction with GitHub to the server, we can simplify the client code (no JSNI, no asynchronous code issues).
- Now the google maps JS library loads asynchronously to prevent blocking the load page when the client doesn't have access to the internet.
lognaturel
approved these changes
Apr 23, 2019
|
Moving the version check to the server seems great all around. 👍 Would be good to get a QA sanity check and ideally it can go in 2.0.3. |
|
Tested with success! @opendatakit-bot unlabel "needs testing" |
This was referenced Apr 23, 2019
Merged
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Closes #459
What has been done to verify that this works as intended?
I've used Chrome's inspector for all these tests with the "Disable cache" from the network tab enabled.
Version note blocking issues
localhostand verify that I get the "you're up to date" note.Google maps JS blocking issues
Why is this the best possible solution? Were any other approaches considered?
First I tried to modify the client's JSNI implementation in
LayoutUtils.javato handle errors related to the requests to GitHub's API, but I got to very complicated half-solutions due to conflicts between the blocking nature of GWT Java UI building and the asynchronous XMLHttpRequest.Then I decided to switch to an all-Java server-side solution. At the expense of having a new GWT service, now we completely avoid client-side JSNI code and the asynchronous interaction is entirely made through GWT RPC calls, which is results in much simpler client code.
Thanks to moving this code to the server, we're also able to throttle-control calls to GitHub's API (and avoid nasty temporary bans due to spamming it with requests). Now, instead the clients (potentially many) doing calls to GH, it's the server who does 1 request per 24 hours max.
Are there any risks to merging this code? If so, what are they?
None.
Do we need any specific form for testing your changes? If so, please attach one
No.
Does this change require updates to documentation? If so, please file an issue at https://github.com/opendatakit/docs/issues/new and include the link below.
No.