Update to Got 10 (#38)

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>

Author: szmarczak

index.js

@@ -1,54 +1,74 @@
 'use strict';
 const got = require('got');
 
-const getRateLimit = ({headers}) => ({
+const getRateLimit = headers => ({
 	limit: parseInt(headers['x-ratelimit-limit'], 10),
 	remaining: parseInt(headers['x-ratelimit-remaining'], 10),
 	reset: new Date(parseInt(headers['x-ratelimit-reset'], 10) * 1000)
 });
 
-const create = () => got.create({
-	options: got.mergeOptions(got.defaults.options, {
-		json: true,
-		token: process.env.GITHUB_TOKEN,
-		baseUrl: process.env.GITHUB_ENDPOINT || 'https://api.github.com',
-		headers: {
-			accept: 'application/vnd.github.v3+json',
-			'user-agent': 'https://github.com/sindresorhus/gh-got'
-		}
-	}),
+const create = () => got.extend({
+	prefixUrl: process.env.GITHUB_ENDPOINT || 'https://api.github.com',
+	headers: {
+		accept: 'application/vnd.github.v3+json',
+		'user-agent': 'https://github.com/sindresorhus/gh-got'
+	},
+	responseType: 'json',
+	token: process.env.GITHUB_TOKEN,
+	handlers: [
+		(options, next) => {
+			// Authorization
+			if (options.token && !options.headers.authorization) {
+				options.headers.authorization = `token ${options.token}`;
+			}
 
-	methods: got.defaults.methods,
+			// `options.body` -> `options.json`
+			options.json = options.body;
+			delete options.body;
 
-	handler: (options, next) => {
-		if (options.token) {
-			options.headers.authorization = options.headers.authorization || `token ${options.token}`;
-		}
+			// Don't touch streams
+			if (options.isStream) {
+				return next(options);
+			}
 
-		if (options.stream) {
-			return next(options);
-		}
+			// Magic begins
+			return (async () => {
+				try {
+					const response = await next(options);
 
-		// TODO: Use async/await here when Got supports the `handler` being an async function
-		return next(options)
-			.then(response => { // eslint-disable-line promise/prefer-await-to-then
-				response.rateLimit = getRateLimit(response);
-				return response;
-			})
-			.catch(error => {
-				const {response} = error;
-
-				if (response && response.body) {
-					error.name = 'GitHubError';
-					error.message = `${response.body.message} (${error.statusCode})`;
-				}
+					// Rate limit for the Response object
+					response.rateLimit = getRateLimit(response.headers);
 
-				if (response) {
-					error.rateLimit = getRateLimit(response);
-				}
+					return response;
+				} catch (error) {
+					const {response} = error;
 
-				throw error;
-			});
+					// Nicer errors
+					if (response && response.body) {
+						error.name = 'GitHubError';
+						error.message = `${response.body.message} (${error.response.statusCode})`;
+					}
+
+					// Rate limit for errors
+					if (response) {
+						error.rateLimit = getRateLimit(response.headers);
+					}
+
+					throw error;
+				}
+			})();
+		}
+	],
+	hooks: {
+		init: [
+			options => {
+				// TODO: This should be fixed in Got
+				// Remove leading slashes
+				if (typeof options.url === 'string' && options.url.startsWith('/')) {
+					options.url = options.url.slice(1);
+				}
+			}
+		]
 	}
 });
 

package.json

@@ -7,7 +7,7 @@
 	"author": {
 		"name": "Sindre Sorhus",
 		"email": "sindresorhus@gmail.com",
-		"url": "sindresorhus.com"
+		"url": "https://sindresorhus.com"
 	},
 	"engines": {
 		"node": ">=8"
@@ -33,12 +33,12 @@
 		"utility"
 	],
 	"dependencies": {
-		"got": "^9.5.0"
+		"got": "^10.5.7"
 	},
 	"devDependencies": {
-		"ava": "^1.0.1",
-		"get-stream": "^4.1.0",
-		"nock": "^10.0.5",
-		"xo": "^0.23.0"
+		"ava": "^3.0.2",
+		"get-stream": "^5.1.0",
+		"nock": "^11.7.2",
+		"xo": "^0.25.3"
 	}
 }

readme.md

@@ -75,7 +75,7 @@ GitHub [access token](https://github.com/settings/tokens/new).
 
 Can be set globally with the `GITHUB_TOKEN` environment variable.
 
-#### baseUrl
+#### prefixUrl
 
 Type: `string`<br>
 Default: `https://api.github.com/`

test.js

@@ -1,7 +1,7 @@
-import test from 'ava';
-import nock from 'nock';
-import getStream from 'get-stream';
-import ghGot from '.';
+const test = require('ava');
+const nock = require('nock');
+const getStream = require('get-stream');
+const ghGot = require('.');
 
 const token = process.env.GITHUB_TOKEN;
 
@@ -10,43 +10,54 @@ test('default', async t => {
 });
 
 test('full path', async t => {
-	t.is((await ghGot('https://api.github.com/users/sindresorhus')).body.login, 'sindresorhus');
+	t.is((await ghGot('https://api.github.com/users/sindresorhus', {prefixUrl: ''})).body.login, 'sindresorhus');
 });
 
 test('accepts options', async t => {
 	t.is((await ghGot('users/sindresorhus', {})).body.login, 'sindresorhus');
 });
 
-test('accepts options.endpoint without trailing slash', async t => {
-	t.is((await ghGot('users/sindresorhus', {endpoint: 'https://api.github.com'})).body.login, 'sindresorhus');
+test('accepts options.prefixUrl without trailing slash', async t => {
+	t.is((await ghGot('users/sindresorhus', {prefixUrl: 'https://api.github.com'})).body.login, 'sindresorhus');
 });
 
 test('dedupes slashes', async t => {
-	t.is((await ghGot('/users/sindresorhus', {endpoint: 'https://api.github.com/'})).body.login, 'sindresorhus');
+	t.is((await ghGot('/users/sindresorhus', {prefixUrl: 'https://api.github.com/'})).body.login, 'sindresorhus');
 });
 
 test.serial('global token option', async t => {
 	process.env.GITHUB_TOKEN = 'fail';
-	await t.throwsAsync(ghGot.recreate()('users/sindresorhus'), 'Bad credentials (401)');
+	await t.throwsAsync(
+		ghGot.recreate()('users/sindresorhus'),
+		{
+			message: 'Bad credentials (401)'
+		}
+	);
 	process.env.GITHUB_TOKEN = token;
 });
 
 test('token option', async t => {
-	await t.throwsAsync(ghGot('users/sindresorhus', {token: 'fail'}), 'Bad credentials (401)');
+	await t.throwsAsync(ghGot('users/sindresorhus', {token: 'fail'}), {
+		message: 'Bad credentials (401)'
+	});
 });
 
 test.serial('global endpoint option', async t => {
 	process.env.GITHUB_ENDPOINT = 'fail';
-	await t.throwsAsync(ghGot.recreate()('users/sindresorhus', {retries: 1}), 'Invalid URL: fail/');
+	await t.throwsAsync(ghGot.recreate()('users/sindresorhus', {retries: 1}), {
+		message: 'Invalid URL: fail/users/sindresorhus'
+	});
 	delete process.env.GITHUB_ENDPOINT;
 });
 
 test.serial('endpoint option', async t => {
 	process.env.GITHUB_ENDPOINT = 'https://api.github.com/';
 	await t.throwsAsync(ghGot.recreate()('users/sindresorhus', {
-		baseUrl: 'fail',
+		prefixUrl: 'fail',
 		retries: 1
-	}), 'Invalid URL: fail/');
+	}), {
+		message: 'Invalid URL: fail/users/sindresorhus'
+	});
 	delete process.env.GITHUB_ENDPOINT;
 });
 
@@ -56,13 +67,13 @@ test('stream interface', async t => {
 });
 
 test('json body', async t => {
-	const baseUrl = 'http://mock-endpoint';
+	const prefixUrl = 'http://mock-endpoint';
 	const body = {test: [1, 3, 3, 7]};
 	const reply = {ok: true};
 
-	const scope = nock(baseUrl).post('/test', body).reply(200, reply);
+	const scope = nock(prefixUrl).post('/test', body).reply(200, reply);
 
-	t.deepEqual((await ghGot('/test', {baseUrl, body})).body, reply);
+	t.deepEqual((await ghGot.post('test', {prefixUrl, body})).body, reply);
 	t.truthy(scope.isDone());
 });