Merge pull request #4591 from opensafely-core/Jongmassey/Project-page…

…-doesnt-load-when-GitHub-API-is-unreachable

Project page doesnt load when GitHub api is unreachable

jobserver/views/projects.py

@@ -173,7 +173,7 @@ def get_repo(repo, ctx):
                     is_private = self.get_github_api().get_repo_is_private(
                         repo.owner, repo.name
                     )
-                except requests.HTTPError:
+                except (requests.HTTPError, requests.Timeout, requests.ConnectionError):
                     is_private = None
                 span = trace.get_current_span()
                 span.set_attribute("repo_owner", repo.owner)
@@ -187,9 +187,12 @@ def get_repo(repo, ctx):
                 }
 
         # use the threadpool to parallelise the repo requests
-        yield from repo_thread_pool.map(
-            get_repo, repos, itertools.repeat(ctx), timeout=30
-        )
+        try:
+            yield from repo_thread_pool.map(
+                get_repo, repos, itertools.repeat(ctx), timeout=30
+            )
+        except TimeoutError:
+            yield {"name": "GitHub API Unavailable", "is_private": None, "url": ""}
 
 
 class ProjectEdit(UpdateView):

tests/unit/jobserver/views/test_projects.py

@@ -200,6 +200,37 @@ def get_repo_is_private(self, *args):
     assert "Public" not in response.rendered_content
 
 
+def test_projectdetail_with_timed_out_github(rf):
+    project = ProjectFactory(org=OrgFactory())
+    WorkspaceFactory(
+        project=project, repo=RepoFactory(url="https://github.com/owner/repo")
+    )
+    WorkspaceFactory(project=project, repo=RepoFactory(url="/path/on/disk/to/repo"))
+
+    request = rf.get("/")
+    request.user = UserFactory()
+
+    class BrokenGitHubAPI:
+        def get_repo_is_private(self, *args):
+            raise TimeoutError
+
+    response = ProjectDetail.as_view(get_github_api=BrokenGitHubAPI)(
+        request, project_slug=project.slug
+    )
+
+    assert response.status_code == 200
+
+    # check there is no public/private badge when GitHub returns an
+    # unsuccessful response
+    assert not response.context_data["public_repos"]
+    assert response.context_data["private_repos"][0] == {
+        "name": "GitHub API Unavailable",
+        "is_private": None,
+        "url": "",
+    }
+    assert "Public" not in response.rendered_content
+
+
 def test_projectdetail_with_no_jobs(rf):
     project = ProjectFactory()