Migrate to octokit

Author: axelrindle

lib/query/graphql.js

@@ -1,6 +1,7 @@
 // Require modules
-const github_graphql = require('github-graphql-client')
+const { Octokit } = require('@octokit/core')
 const semver = require('semver')
+const pkg = require('../../package.json')
 const query = require('../util/query')
 
 /**
@@ -12,18 +13,17 @@ const query = require('../util/query')
  * @param {CheckOptions} options The options for the version check.
  * @param {CallbackFunction} callback The callback function.
  */
-module.exports = (options, callback) => {
-    // build the query
+module.exports = async (options, callback) => {
     const theQuery = options.fetchTags ? query.tags(options.repo, options.owner) : query.releases(options.repo, options.owner)
+    const octokit = new Octokit({
+        auth: options.token,
+        headers: {
+            'user-agent': `${pkg.name} v${pkg.version}`
+        }
+    })
 
-    // do the api call
-    github_graphql({
-        token: options.token,
-        query: theQuery
-    }, (err, res) => {
-        if (err) {
-            callback(err, null)
-        } else {
+    octokit.graphql(theQuery)
+        .then(res => {
             // Retrieve newer version name
             const newer = options.fetchTags ? res.data.repository.refs.nodes[0] : res.data.repository.releases.nodes[0]
 
@@ -33,6 +33,6 @@ module.exports = (options, callback) => {
             } else {
                 callback(null, null)
             }
-        }
-    })
+        })
+        .catch(err => callback(err, null))
 }

lib/query/rest.js

@@ -1,8 +1,8 @@
 // Require modules
-const https = require('https')
 const semver = require('semver')
 const schemeMapper = require('../util/scheme-mapper')
 const pkg = require('../../package.json')
+const { Octokit } = require('@octokit/core')
 
 /**
  * @param {CheckOptions} options The options for the version check.
@@ -30,50 +30,6 @@ function compare(options, json) {
     return found ? version : null
 }
 
-/**
- * @param {CheckOptions} options The options for the version check.
- * @param {CallbackFunction} callback The callback function.
- * @returns {RestHandlerFunction}
- */
-function makeHandler(options, callback) {
-    return res => {
-        const chunks = []
-        res.on('data', chunk => {
-            return chunks.push(chunk.toString())
-        })
-        res.on('end', () => {
-            // parse response string into an object
-            const response = chunks.join('')
-            let json = null
-            try {
-                json = JSON.parse(response)
-            } catch (error) {
-                return callback(error, null)
-            }
-
-            // 404 error occurs, when no releases are found
-            if (res.statusCode === 404) {
-                return callback(null, null)
-            }
-
-            // status codes other than 200 are treated as an error
-            else if (res.statusCode !== 200) {
-                return callback(new Error(json.message), null)
-            }
-
-            // Compare versions
-            const version = compare(options, json)
-
-            if (version) {
-                const mapped = schemeMapper[options.fetchTags ? 'tag' : 'release'](version)
-                callback(null, mapped)
-            } else {
-                callback(null, null)
-            }
-        })
-    }
-}
-
 /**
  * Executes an API call on the Github Rest API (v3) that should return the latest version.
  * The returned version is compared to the given version.
@@ -85,7 +41,7 @@ function makeHandler(options, callback) {
 */
 module.exports = (options, callback) => {
     // build url
-    let apiUrl = `/repos/${options.owner}/${options.repo}`
+    let apiUrl = '/repos/{owner}/{repo}'
     if (options.fetchTags) {
         apiUrl += '/tags'
     } else {
@@ -96,21 +52,35 @@ module.exports = (options, callback) => {
         }
     }
 
-    // define request options
-    /** @type {https.RequestOptions} */
-    const opts = {
-        hostname: 'api.github.com',
-        path: apiUrl,
+    const octokit = new Octokit({
+        auth: options.token
+    })
+
+    octokit.request(apiUrl, {
+        owner: options.owner,
+        repo: options.repo,
         headers: {
-            'Accept': 'application/vnd.github.v3+json',
-            'User-Agent': `${pkg.name} v${pkg.version}`
+            'user-agent': `${pkg.name} v${pkg.version}`
         }
-    }
-
-    // execute request
-    let req = https.get(opts, makeHandler(options, callback))
-    req.on('error', err => {
-        callback(err, null)
     })
-    req.end()
+        .then(response => {
+            // 404 error occurs, when no releases are found
+            if (response.status === 404) {
+                return callback(null, null)
+            }
+
+            // status codes other than 200 are treated as an error
+            else if (response.status !== 200) {
+                return callback(new Error(response.data.message), null)
+            }
+
+            // Compare versions
+            const version = compare(options, response.data)
+            if (version) {
+                const mapped = schemeMapper[options.fetchTags ? 'tag' : 'release'](version)
+                callback(null, mapped)
+            } else {
+                callback(null, null)
+            }
+        })
 }