w3c / presentation-api

Presentation API
https://www.w3.org/TR/presentation-api/
Other
71 stars 39 forks source link

GitHub API failing, which leads to ReSpec failures #228

Closed markafoltz closed 8 years ago

markafoltz commented 8 years ago

Periodically, the calls to the GitHub API made inline in the spec document fail with error 403 (Forbidden) when executing ReSpec locally. No other information is provided. This causes ReSpec to silently stop processing the document.

I have commented out the githubAPI line in PR #227 until this issue can be sorted.

tidoust commented 8 years ago

I believe that this is due to GitHub rate limiting unauthenticated requests (which is what ReSpec seems to be doing) to "60 requests per hour": https://developer.github.com/v3/#rate-limiting

I never run into problems when viewing specs online (my guess would be that GitHub does not apply the same limit when the request comes from code served from a github.io subdomain), but I confirm I've been running in similar issues from time to time when I work on a spec locally. I don't think there is a practical way to fix that in our case.

markafoltz commented 8 years ago

Does every issue linked in the document cause a request to be sent? I could see hitting this limit pretty quickly then.

tidoust commented 8 years ago

No, I think there's only one (or two) calls to the API. The code that handles that part should be at: https://github.com/w3c/respec/blob/develop/js/core/issues-notes.js#L130

Also, I note that conditional requests do not count towards the limit. However, I often force a refresh when I work locally to ensure I see the latest version of the spec.