Update: Pull GitHub Sponsors donation data (#658)

Author: ilyavolodin

_tools/fetch-sponsors.js

@@ -1,5 +1,6 @@
 /**
- * @fileoverview Script to fetch sponsor data from Open Collective. Call using:
+ * @fileoverview Script to fetch sponsor data from Open Collective and GitHub.
+ * Call using:
  *     node _tools/fetch-sponsors.js
  * @author Nicholas C. Zakas
  */
@@ -14,99 +15,187 @@
 
 const fs = require("fs");
 const fetch = require("node-fetch");
+const { graphql: githubGraphQL } = require("@octokit/graphql");
 
 //-----------------------------------------------------------------------------
 // Data
 //-----------------------------------------------------------------------------
 
-// filename to output to
-const filename = "./_data/sponsors.json";
+// filename to output sponsors to
+const sponsorsFilename = "./_data/sponsors.json";
 
 // simplified data structure
-const sponsors = {
+const tierSponsors = {
     gold: [],
     silver: [],
     bronze: [],
     backers: []
 };
 
-const graphqlEndpoint = "https://api.opencollective.com/graphql/v2";
-
-const graphqlQuery = `{
-  account(slug: "eslint") {
-    orders(status: ACTIVE) {
-      totalCount
-      nodes {
-        fromAccount {
-          name
-          website
-          imageUrl
-        }
-        amount {
-          value
+const { ESLINT_GITHUB_TOKEN } = process.env;
+
+if (!ESLINT_GITHUB_TOKEN) {
+    throw new Error("Missing ESLINT_GITHUB_TOKEN.");
+}
+
+//-----------------------------------------------------------------------------
+// Helpers
+//-----------------------------------------------------------------------------
+
+/**
+ * Returns the tier ID for a given donation amount.
+ * @param {int} monthlyDonation The monthly donation in dollars.
+ * @returns {string} The ID of the tier the donation belongs to.
+ */
+function getTierSlug(monthlyDonation) {
+    if (monthlyDonation >= 1000) {
+        return "gold-sponsor";
+    }
+
+    if (monthlyDonation >= 500) {
+        return "silver-sponsor";
+    }
+
+    if (monthlyDonation >= 200) {
+        return "bronze-sponsor";
+    }
+
+    return "backer";
+}
+
+/**
+ * Fetch order data from Open Collective using the GraphQL API.
+ * @returns {Array} An array of sponsors.
+ */
+async function fetchOpenCollectiveSponsors() {
+
+    const endpoint = "https://api.opencollective.com/graphql/v2";
+
+    const query = `{
+        account(slug: "eslint") {
+          orders(status: ACTIVE) {
+            totalCount
+            nodes {
+              fromAccount {
+                name
+                website
+                imageUrl
+              }
+              amount {
+                value
+              }
+              tier {
+                slug
+              }
+              frequency
+              totalDonations {
+                value
+              }
+            }
+          }
         }
-        tier {
-          slug
+      }`;
+
+    const result = await fetch(endpoint, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify({ query })
+    });
+
+    const payload = await result.json();
+
+    return payload.data.account.orders.nodes.map(order => ({
+        name: order.fromAccount.name,
+        url: order.fromAccount.website,
+        image: order.fromAccount.imageUrl,
+        monthlyDonation: order.frequency === "year" ? Math.round(order.amount.value * 100 / 12) : order.amount.value * 100,
+        totalDonations: order.totalDonations.value * 100,
+        source: "opencollective",
+        tier: order.tier ? order.tier.slug : null
+    }));
+
+}
+
+/**
+ * Fetches GitHub Sponsors data using the GraphQL API.
+ * @returns {Array} An array of sponsors.
+ */
+async function fetchGitHubSponsors() {
+
+    const { organization } = await githubGraphQL(`query {
+        organization(login: "eslint") {
+          sponsorshipsAsMaintainer (first: 100) {
+            nodes {
+              sponsor {
+                name,
+                login,
+                avatarUrl,
+                url,
+                websiteUrl
+              },
+              tier {
+                monthlyPriceInDollars
+              }
+            }
+          }
         }
-        frequency
-        totalDonations {
-          value
+      }`, {
+        headers: {
+            authorization: `token ${ESLINT_GITHUB_TOKEN}`
         }
-      }
-    }
-  }
-}`;
+    });
+
+    // return an array in the same format as Open Collective
+    return organization.sponsorshipsAsMaintainer.nodes.map(({ sponsor, tier }) => ({
+        name: sponsor.name,
+        image: sponsor.avatarUrl,
+        url: sponsor.websiteUrl || sponsor.url,
+        monthlyDonation: tier.monthlyPriceInDollars * 100,
+        source: "github",
+        tier: getTierSlug(tier.monthlyPriceInDollars)
+    }));
+
+}
 
 //-----------------------------------------------------------------------------
 // Main
 //-----------------------------------------------------------------------------
 
 (async() => {
 
-    // fetch the data
-    const result = await fetch(graphqlEndpoint, {
-        method: "POST",
-        headers: { "Content-Type": "application/json" },
-        body: JSON.stringify({ query: graphqlQuery })
-    });
-    const orders = await result.json().then(res => res.data.account.orders.nodes);
-
-    // process into a useful format
-    for (const order of orders) {
+    const [openCollectiveSponsors, githubSponsors] = await Promise.all([
+        fetchOpenCollectiveSponsors(),
+        fetchGitHubSponsors()
+    ]);
 
-        const sponsor = {
-            name: order.fromAccount.name,
-            url: order.fromAccount.website,
-            image: order.fromAccount.imageUrl,
-            monthlyDonation: order.frequency === "year" ? Math.round(order.amount.value * 100 / 12) : order.amount.value * 100,
-            totalDonations: order.totalDonations.value * 100
-        };
+    const sponsors = openCollectiveSponsors.concat(githubSponsors);
 
-        const tierSlug = order.tier ? order.tier.slug : null;
+    // process into a useful format
+    for (const sponsor of sponsors) {
 
-        switch (tierSlug) {
+        switch (sponsor.tier) {
             case "gold-sponsor":
-                sponsors.gold.push(sponsor);
+                tierSponsors.gold.push(sponsor);
                 break;
 
             case "silver-sponsor":
-                sponsors.silver.push(sponsor);
+                tierSponsors.silver.push(sponsor);
                 break;
 
             case "bronze-sponsor":
-                sponsors.bronze.push(sponsor);
+                tierSponsors.bronze.push(sponsor);
                 break;
 
             default:
-                sponsors.backers.push(sponsor);
+                tierSponsors.backers.push(sponsor);
 
         }
     }
 
     // sort order based on total donations
-    for (const key of Object.keys(sponsors)) {
-        sponsors[key].sort((a, b) => b.monthlyDonation - a.monthlyDonation);
+    for (const key of Object.keys(tierSponsors)) {
+        tierSponsors[key].sort((a, b) => b.monthlyDonation - a.monthlyDonation);
     }
 
-    fs.writeFileSync(filename, JSON.stringify(sponsors, null, "    "), { encoding: "utf8" });
+    fs.writeFileSync(sponsorsFilename, JSON.stringify(tierSponsors, null, "    "), { encoding: "utf8" });
 })();