Chore: Allow to develop locally without a GitHub API key (#365)

Fixes #57. A new environment variable NO_GH_API_KEY was introduced
and is used as flag to show that we don't want to provide GitHub API keys

Co-authored-by: bryan-aguilar <[email protected]>
Co-authored-by: Anthony Mirabella <[email protected]>

Author: 3 people

DEV_GUIDE.md

@@ -14,17 +14,35 @@
     ```
     npm install
     ```
-5. [Generate a GitHub Personal Access Token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token)
-6. Create a new file in the root called `.env.development` (See [Project Structure](#project-structure) for more information)
-7. In the `.env.development` file, add the following line:
+5. Disable GitHub API access (Used to fetch the list of contributors)
+   Create a new file in the root called `.env.development` (See [Project Structure](#project-structure) for more information)
+   Write the following line to it:
+   ```
+   NO_GH_API_KEY=true
+   ```
+4. Start up the Gatsby site
+    ```
+    npm start
+    ```
+5. Open http://localhost:8000 to check the site
+
+**Obs**: The `NO_GH_API_KEY` environment variable can also be passed through command line. E.g.: `NO_GH_API_KEY=true npm run start`.
+
+### Optional - Test the GitHub API integration
+
+This step is optional and allows you to test that the list of contributors is being fetched from GitHub.
+
+1. [Generate a GitHub Personal Access Token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token)
+2. Create a new file in the root called `.env.development` (See [Project Structure](#project-structure) for more information)
+3. In the `.env.development` file, add the following line:
    ```
    GH_API_KEY=<INSERT YOUR ACCESS TOKEN>
    ```
-8. Start up the Gatsby site
+4. Start up the Gatsby site
     ```
     npm start
     ```
-9. Open http://localhost:8000 to check the site
+5. Open http://localhost:8000 to check the site
 
 ## Making Changes to the Site
 

gatsby-config.js

@@ -30,6 +30,7 @@ module.exports = {
           "aws-observability/aws-otel-test-framework"
         ],
         token: process.env.GH_API_KEY,
+        useMockData: process.env.NO_GH_API_KEY,
       },
     },
     {

src/plugins/contributorsPlugin/gatsby-node.js

@@ -23,15 +23,57 @@
 const GitHub = require("github-base")
 const camelcaseKeys = require("camelcase-keys")
 
+function octocatContributor() {
+    // Using example provided by the docs https://docs.github.com/en/rest/repos/repos#list-repository-contributors
+    const githubContributor = {
+        login: "octocat",
+        id: 1,
+        node_id: "MDQ6VXNlcjE=",
+        avatar_url: "https://github.githubassets.com/images/modules/logos_page/Octocat.png",
+        gravatar_id: "",
+        url: "https://github.com/octocat",
+        html_url: "https://github.com/octocat",
+        followers_url: "https://api.github.com/users/octocat/followers",
+        following_url: "https://api.github.com/users/octocat/following{/other_user}",
+        gists_url: "https://api.github.com/users/octocat/gists{/gist_id}",
+        starred_url: "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+        subscriptions_url: "https://api.github.com/users/octocat/subscriptions",
+        organizations_url: "https://api.github.com/users/octocat/orgs",
+        repos_url: "https://api.github.com/users/octocat/repos",
+        events_url: "https://api.github.com/users/octocat/events{/privacy}",
+        received_events_url: "https://api.github.com/users/octocat/received_events",
+        type: "User",
+        site_admin: false,
+        contributions: 32
+      };
+
+      return camelcaseKeys({...githubContributor, name: "octocat"})
+}
+
 exports.sourceNodes = async (
     { actions, createNodeId, createContentDigest },
     options
 ) => {
-    const github = new GitHub(options);
+
+    // Used in Development mode so that we don't try to hit the GitHub API
+    if (options.useMockData) {
+       actions.createNode({
+        ...octocatContributor(),
+        id: createNodeId(1),
+        internal: {
+            type: "GitHubContributor",
+            contentDigest: createContentDigest('1')
+        }
+      });
+
+      return
+    }
+
+    const github = new GitHub({token: options.token});
 
     const loginsSet = new Set()
 
-    const responses = await Promise.all(options.repos.map((repo) => github.paged(`/repos/:${repo}/contributors`, options, null)));
+    const responses = await Promise.all(options.repos.map((repo) => github.paged(`/repos/:${repo}/contributors`)));
 
     const contributors = responses.map((res) => res.pages.flat().map((page) => page.body).flat()).flat();
 
@@ -40,7 +82,7 @@ exports.sourceNodes = async (
 
     const profiles = await Promise.all(
         [...loginsSet].map(login =>
-            github.get(`/users/${login}`, options).then((res) => res.body)
+            github.get(`/users/${login}`).then((res) => res.body)
         )
     );