Merge pull request #80 from w3c/no-octokat

Use @octokit/core instead of octokat

Author: foolip

lib/github.js

@@ -2,12 +2,53 @@
 
 "use strict";
 
-const config = require("../config.json");
+const octokit = require("./octokit.js");
 
-const graphql = require("./graphql.js");
-// github API v3 needed to check webhooks
-const Octokat = require("octokat");
-const octo = new Octokat({token: config.ghToken});
+const licenseQuery = `
+  query {
+    repository(owner: "w3c", name: "licenses") {
+      contributing: object(expression: "HEAD:WG-CONTRIBUTING.md") {
+        ... on Blob {
+          text
+        }
+      }
+      contributingSw: object(expression: "HEAD:WG-CONTRIBUTING-SW.md") {
+        ... on Blob {
+          text
+        }
+      }
+      license: object(expression: "HEAD:WG-LICENSE.md") {
+        ... on Blob {
+          text
+        }
+      }
+      licenseSw: object(expression: "HEAD:WG-LICENSE-SW.md") {
+        ... on Blob {
+          text
+        }
+      }
+    }
+  }
+`;
+
+async function w3cLicenses() {
+  let res = await octokit.graphql(licenseQuery);
+  res = res.repository;
+
+  if (res.contributing) {
+    res.contributing = res.contributing.text;
+  }
+  if (res.contributingSw) {
+    res.contributingSw = res.contributingSw.text;
+  }
+  if (res.license) {
+    res.license = res.license.text;
+  }
+  if (res.licenseSw) {
+    res.licenseSw = res.licenseSw.text;
+  }
+  return res;
+}
 
 const repoQuery = `
   query ($org: String!, $cursor: String) {
@@ -102,12 +143,12 @@ const labelQuery = `
 
 async function *listRepos(org) {
   for (let cursor = null; ;) {
-    const res = await graphql(repoQuery, {org, cursor});
+    const res = await octokit.graphql(repoQuery, {org, cursor});
     for (const repo of res.organization.repositories.nodes) {
       const labels = repo.labels.nodes;
       // Fetch more labels if they are paginated
       for (let pageInfo = repo.labels.pageInfo; pageInfo.hasNextPage;) {
-        const res = await graphql(labelQuery, {
+        const res = await octokit.graphql(labelQuery, {
           org,
           repo: repo.name,
           cursor: pageInfo.endCursor
@@ -126,9 +167,23 @@ async function *listRepos(org) {
   }
 }
 
-async function listRepoHooks(org, repo) {
-  const hooks = await octo.repos(`${org}/${repo}`).hooks.fetch();
-  return hooks.items;
+async function listRepoContributors(owner, repo) {
+  const res = await octokit.request('GET /repos/:owner/:repo/contributors', {
+    owner, repo,
+  });
+  return res.data;
+}
+
+async function listRepoHooks(owner, repo) {
+  const res = await octokit.request('GET /repos/:owner/:repo/hooks', {
+    owner, repo,
+  });
+  return res.data;
 }
 
-module.exports = {listRepos, listRepoHooks};
+module.exports = {
+  w3cLicenses,
+  listRepos,
+  listRepoContributors,
+  listRepoHooks,
+};

lib/graphql.js renamed to lib/octokit.js

@@ -23,14 +23,14 @@ const octokit = new Octokit({
     },
     onAbuseLimit: (retryAfter, options) => {
       if (options.request.retryCount < MAX_RETRIES) {
-        console.warn(`Abuse detected triggered, retrying after ${retryAfter} seconds`)
+        console.warn(`Abuse detection triggered, retrying after ${retryAfter} seconds`)
         return true;
       } else {
-        console.error(`Abuse detected triggered, giving up after ${MAX_RETRIES} retries`);
+        console.error(`Abuse detection triggered, giving up after ${MAX_RETRIES} retries`);
         return false;
       }
     }
   }
 });
 
-module.exports = octokit.graphql;
+module.exports = octokit;

lib/validator.js

@@ -190,7 +190,7 @@ function validateAshHooks(hooks) {
   // pushed instead of nulls. This is simply to match the original structure
   // of report.json. TODO: change this to null, or add error details.
   const errors = [];
-  const ashHooks = hooks.filter(h => ashnazgHookUrls.includes(h.config.url) && h.config.contentType === "json" && h.config.insecureSsl === "0" && h.config.secret !== "");
+  const ashHooks = hooks.filter(h => ashnazgHookUrls.includes(h.config.url) && h.config.content_type === "json" && h.config.insecure_ssl === "0" && h.config.secret !== "");
   if (ashHooks.length === 0) {
     errors.push(['missingashnazghook', {}]);
   }

lib/w3cLicenses.js

@@ -1,24 +1,23 @@
 /* eslint-env node */
 
-const Octokat = require("octokat");
 const config = require("./config.json");
+const github = require("./lib/github.js");
 const w3c = require('node-w3capi');
 
 // based on a downloaded a local copy from https://labs.w3.org/hatchery/repo-manager/api/users when logged in there, filtered to leave only list of ghID
 const ashnazgusers = require('./ashnazg-users.json');
 
 w3c.apiKey = config.w3capikey;
-const octo = new Octokat({token: config.ghToken});
 
 if (!process.argv[2] || process.argv[2].indexOf('/') === -1) {
   console.error("Required: name of repo to check, e.g. w3c/webrtc-pc");
   process.exit(2);
 }
 
-const selectedrepo = process.argv[2];
+const [owner, repo] = process.argv[2].split('/');
 
-octo.repos(selectedrepo).contributors.fetch().then(contributors => {
-  Promise.all(contributors.items.map(contributor => {
+github.listRepoContributors(owner, repo).then(contributors => {
+  Promise.all(contributors.map(contributor => {
     return new Promise(function(res, rej) {
       w3c.user({type: 'github', id: contributor.id}).fetch(function(err, /* w3cuser */) {
         if (err) {

list-unconnected-contributors.js

@@ -13,8 +13,7 @@
     "@octokit/core": "2.1.2",
     "@octokit/plugin-throttling": "2.7.0",
     "node-fetch": "^1.6.3",
-    "node-w3capi": "^1.4.0",
-    "octokat": "^0.7.0"
+    "node-w3capi": "^1.4.0"
   },
   "devDependencies": {
     "eslint": "^6.6.0",

package-lock.json

@@ -7,6 +7,59 @@ const proxyquire = require('proxyquire');
 const sinon = require('sinon');
 
 describe('github', () => {
+  describe('w3cLicenses', () => {
+    it('happy path', async () => {
+      const graphql = sinon.fake.resolves({
+        repository: {
+          contributing: {
+            text: 'mock WG-CONTRIBUTING.md content'
+          },
+          contributingSw: {
+            text: 'mock WG-CONTRIBUTING-SW.md content'
+          },
+          license: {
+            text: 'mock WG-LICENSE.md content'
+          },
+          licenseSw: {
+            text: 'mock WG-LICENSE-SW.md content'
+          },
+        }
+      });
+      const github = proxyquire('../lib/github.js', {
+        './octokit.js': {graphql}
+      });
+      const lic = await github.w3cLicenses();
+      assert.deepStrictEqual(lic, {
+        contributing: 'mock WG-CONTRIBUTING.md content',
+        contributingSw: 'mock WG-CONTRIBUTING-SW.md content',
+        license: 'mock WG-LICENSE.md content',
+        licenseSw: 'mock WG-LICENSE-SW.md content',
+      });
+      assert(graphql.calledOnce);
+    });
+
+    it('no files found', async () => {
+      const graphql = sinon.fake.resolves({repository: {}});
+      const github = proxyquire('../lib/github.js', {
+        './octokit.js': {graphql}
+      });
+      const lic = await github.w3cLicenses();
+      assert.deepStrictEqual(lic, {});
+      assert(graphql.calledOnce);
+    });
+
+    it('graphql error', async () => {
+      const graphql = sinon.fake.rejects(new Error('mock error'));
+      const github = proxyquire('../lib/github.js', {
+        './octokit.js': {graphql}
+      });
+      await assert.rejects(github.w3cLicenses(), {
+        message: 'mock error'
+      });
+      assert(graphql.calledOnce);
+    });
+  });
+
   describe('listRepos', () => {
     async function toArray(iterator) {
       const array = [];
@@ -41,7 +94,7 @@ describe('github', () => {
         }
       });
       const github = proxyquire('../lib/github.js', {
-        './graphql.js': graphql
+        './octokit.js': {graphql}
       });
       const res = await toArray(github.listRepos('WICG'));
       assert(graphql.calledOnce);
@@ -99,7 +152,7 @@ describe('github', () => {
         }
       });
       const github = proxyquire('../lib/github.js', {
-        './graphql.js': graphql
+        './octokit.js': {graphql}
       });
       const res = await toArray(github.listRepos('WICG'));
       assert(graphql.calledTwice);
@@ -165,7 +218,7 @@ describe('github', () => {
         }
       });
       const github = proxyquire('../lib/github.js', {
-        './graphql.js': graphql
+        './octokit.js': {graphql}
       });
       const res = await toArray(github.listRepos('WICG'));
       assert(graphql.calledThrice);
@@ -181,22 +234,27 @@ describe('github', () => {
     });
   });
 
-  it('fetchRepoHooks', async () => {
-    class Stubkat {
-      repos() {
-        return {
-          hooks: {
-            async fetch() {
-              return {
-                items: ['mock-hook'],
-              }
-            }
-          }
-        }
-      }
-    }
-    const github = proxyquire('../lib/github.js', {'octokat': Stubkat});
+  it('listRepoContributors', async () => {
+    const request = sinon.stub();
+    request.resolves({data: ['mock-contributor']});
+    const github = proxyquire('../lib/github.js', {'./octokit.js': {request}});
+    const contributors = await github.listRepoContributors('foo', 'bar');
+    assert(request.calledOnceWith('GET /repos/:owner/:repo/contributors', {
+      owner: 'foo',
+      repo: 'bar',
+    }));
+    assert.deepEqual(contributors, ['mock-contributor']);
+  });
+
+  it('listRepoHooks', async () => {
+    const request = sinon.stub();
+    request.resolves({data: ['mock-hook']});
+    const github = proxyquire('../lib/github.js', {'./octokit.js': {request}});
     const hooks = await github.listRepoHooks('foo', 'bar');
+    assert(request.calledOnceWith('GET /repos/:owner/:repo/hooks', {
+      owner: 'foo',
+      repo: 'bar',
+    }));
     assert.deepEqual(hooks, ['mock-hook']);
   });