Limit commits_level requests to three branches

Author: penyuan

README.md

@@ -225,7 +225,7 @@ There are two components to each request:
    2. `files_editability`: Basic information about how "editable" the CAD files are in this repository.
    3. `license`: The license for the repository.
    4. `tags`: Aggregated tags for the repository and any associated with the maintainers of that repsitory.
-   5. `commits_level`: The hash identifier (contribution `id` for Wikifactory projects) and timestamp of each commit to the repository. This can be used to graph the commit activity level in a frontend visualisation.
+   5. `commits_level`: The hash identifier (contribution `id` for Wikifactory projects) and timestamp of each commit to the repository. This can be used to graph the commit activity level in a frontend visualisation. **Note:** This will be based on commits from the first three detected branches in the repository, including the default branch. This is because the time it takes to requests commits across various branches take a long time, and APIs might time out.
    6. `issues_level`: Similar to `commits_level`, but for all issues in the repository.
 
 The following is an example request that could be sent to the API for three Wikifactory projects: 

oshminer/GitHub.py

@@ -334,8 +334,9 @@ async def get_commits_level(project: dict, session) -> dict:
     Each commit is a `dict` containing as `str`s: `oid`, `messageHeadline`, 
     `committedDate`, and `url`.
     
-    The commits are aggregated and de-duplicated across all branches up to 100
-    branches.
+    The commits are aggregated and de-duplicated across branches up to 3
+    branches including the default branch. The 3 branch limit is because 
+    otherwise the requests would take too long.
     """
 
     # 
@@ -387,6 +388,60 @@ async def get_commits_level(project: dict, session) -> dict:
     # Add branches from query results to list of branches
     for node in branches_results: 
         branches_list.append(node["name"])
+        
+    #
+    # Identify default branch name
+    #
+    
+    #
+    # Determine name of default branch
+    #
+    
+    # This can be done with GitHub v4 GraphQL API
+    query_default_branch = gql(
+        """
+        query ($owner: String!, $name: String!) {
+            repository(owner: $owner, name: $name) {
+                defaultBranchRef {
+                    name
+                }
+            }
+        }
+        """
+    )
+    # Query variables
+    params: dict = {
+        "owner": project["owner"], 
+        "name": project["name"]
+    }
+    # Execute query on the transport
+    # `execute_async()` is the asynchronous version of `execute()`
+    try: 
+        query_default_branch_response: dict = await session.execute(query_default_branch, variable_values = params)
+    except Exception as exc: 
+        # Very hacky workaround for now: 
+        # When there's an authorisation error such as a bad personal access token, 
+        # GitHub would return a 401 error response. The `gql` library woudl throw the 
+        # `gql.transport.exceptions.TransportServerError` exception.
+        # But for some reason `except gql.transport.exceptions.TransportServerError`
+        # would fail, so for now I'm manually catching the 401 code here.
+        if exc.code == 401: 
+            raise exceptions.BadGitHubTokenError()
+        else: 
+            # For all other errors, continue throwing an exception to stop execution.
+            raise Exception
+    default_branch_name: str = query_default_branch_response["repository"]["defaultBranchRef"]["name"]
+    
+    #
+    # Keep 3 branches including default branch
+    #
+    
+    if len(branches_list) > 3: 
+        print("Keeping 3 branches to query", file=sys.stderr)
+        # Keep two branches plus default branch
+        branches_list.remove(default_branch_name)
+        branches_list = branches_list[:2]
+        branches_list.append(default_branch_name)
 
     #
     # Get list of commits in each branch