Authenticated Github API requests

[simondate]

If a user tries to install multiple AAT instances on a single device (server or local PC) too many times in a short period of times, they are likely to run into an error with Github's API request limit, these usually reset after an hour, so up until now this hasn't been too much of an issue as the user would just wait until then.

However, one of my client's seems to have hit this error too often and now every time they try to install the Authoring Tool they are met with a new error, which always sets a time one hour in the future. They have been trying for several days and not been able to have any success, screenshot below. They get an error before the script even begins, so there must be an API call which happens early in the process.

The install process for the AAT should allow the option for the installer to include a personal access token, which will grant them higher rate limits for API requests.

[simondate]

Just created a branch which implements this. Since this is such a niche feature, I don't see much point in merging this, but I suggest that we should keep this issue open, should anyone else with this problem.

How to implement authentication

1. You need to generate a personal access token on github, go to this link and complete the form.
   1.1) Choose a classic token
   1.2) Set no expiration date (which prevents you having to update this in the future
   1.3) Leave everything blank - You are just reading a public repo, so don't require any special access
   1.4) Scroll to the bottom and press 'generate token'
   1.5) When complete, copy the token which is generated for you
2. Now you can setup your project. Clone or checkout the branch above
3. In the repo, navigate to the lib/installHelpers.js file.
   4.1) On line 20 change the DEFAULT_USER_AGENT value to your github account name
   4.2) On line 21 change the DEFAULT_USER_TOKEN value to the generated token. Ensure that Bearer remains in front it.

If you now try to install the Authoring Tool you should no longer have an API request error. You will be able to use the same access token for all of your AAT installs.

EDIT: If you taken my suggestion of using a classic token with no expiration you shouldn't run into this error
If the token goes past its expiration date, you will need to regenerate a new one. You will run into errors next time you start an AAT or try to upgrade, as an API call is made every time you do either, so ensure you remember you've made this change.

Hope that helps 😄