fix(deps): update dependency got to v10 (#89)

* fix(deps): update dependency got to v10

* chore: migrate

Co-authored-by: Renovate Bot <[email protected]>
Co-authored-by: Felix Becker <[email protected]>

Author: 3 people

package.json

@@ -48,8 +48,8 @@
     "chalk": "^2.4.1",
     "delay": "^4.3.0",
     "execa": "^4.0.0",
-    "got": "^9.6.0",
     "inquirer": "^7.1.0",
+    "got": "^10.7.0",
     "js-yaml": "^3.13.1",
     "mkdirp-promise": "^5.0.1",
     "mz": "^2.7.0",
@@ -63,7 +63,6 @@
     "@sourcegraph/prettierrc": "^3.0.3",
     "@sourcegraph/tsconfig": "^4.0.1",
     "@types/execa": "0.9.0",
-    "@types/got": "9.6.9",
     "@types/inquirer": "6.5.0",
     "@types/js-yaml": "3.12.2",
     "@types/mkdirp-promise": "5.0.0",

src/buildkite.ts

@@ -1,19 +1,24 @@
-import got, { GotInstance, GotJSONFn } from 'got'
+import got, { Got, HTTPError } from 'got'
 import * as yaml from 'js-yaml'
 import { exists, writeFile } from 'mz/fs'
 import { GitHubClient } from './github'
 
-export type BuildkiteClient = GotInstance<GotJSONFn>
+export type BuildkiteClient = Got
 
 export const createBuildkiteClient = ({ token }: { token: string }): BuildkiteClient =>
     got.extend({
-        baseUrl: 'https://api.buildkite.com/v2/',
-        json: true,
+        prefixUrl: 'https://api.buildkite.com/v2/',
         headers: {
             Authorization: 'Bearer ' + token,
         },
     })
 
+interface BuildkitePipeline {
+    provider: { webhook_url: string }
+    badge_url: string
+    web_url: string
+}
+
 export async function initBuildkite({
     hasTests,
     repoName,
@@ -73,24 +78,25 @@ export async function initBuildkite({
         },
     }
 
-    let pipeline: { provider: { webhook_url: string }; badge_url: string; web_url: string }
+    let pipeline: BuildkitePipeline
     try {
-        pipeline = (
-            await buildkiteClient.post('organizations/sourcegraph/pipelines', {
-                body: buildkitePipeline,
-                json: true,
-            })
-        ).body
+        pipeline = await buildkiteClient.post<BuildkitePipeline>('organizations/sourcegraph/pipelines', {
+            json: buildkitePipeline,
+            responseType: 'json',
+            resolveBodyOnly: true,
+        })
     } catch (err) {
         if (
-            err.error &&
-            err.error.errors &&
-            err.error.errors[0] &&
-            err.error.errors[0].field === 'name' &&
-            err.error.errors[0].code === 'already_exists'
+            err instanceof HTTPError &&
+            (err.response.body as any)?.errors?.some?.(
+                (err: any) => err?.field === 'name' && err?.code === 'already_exists'
+            )
         ) {
             console.log(`Buildkite pipeline "${repoName}" already exists, skipping creation`)
-            pipeline = (await buildkiteClient.get(`organizations/sourcegraph/pipelines/${repoName}`)).body
+            pipeline = await buildkiteClient.get<BuildkitePipeline>(`organizations/sourcegraph/pipelines/${repoName}`, {
+                responseType: 'json',
+                resolveBodyOnly: true,
+            })
         } else {
             throw err
         }
@@ -99,7 +105,7 @@ export async function initBuildkite({
     console.log('🔗 Creating GitHub webhook for pipeline')
     try {
         await githubClient.post(`/repos/sourcegraph/${repoName}/hooks`, {
-            body: {
+            json: {
                 name: 'web',
                 events: ['push', 'pull_request', 'deployment'],
                 config: {
@@ -110,9 +116,10 @@ export async function initBuildkite({
         })
     } catch (err) {
         if (
-            err.error &&
-            Array.isArray(err.error.errors) &&
-            err.error.errors.some((err: any) => /hook already exists/i.test(err.message))
+            err instanceof HTTPError &&
+            (err.response.body as any)?.errors?.some?.(
+                (err: any) => typeof err?.message === 'string' && /hook already exists/i.test(err.message)
+            )
         ) {
             console.log('Webhook already exists')
         } else {
@@ -123,7 +130,7 @@ export async function initBuildkite({
     console.log('🔐 Granting Buildkite team pull access to repo')
     // buildkite team, see https://api.github.com/orgs/sourcegraph/teams
     await githubClient.put(`/teams/2444623/repos/sourcegraph/${repoName}`, {
-        body: {
+        json: {
             permission: 'pull',
         },
     })

src/cli.ts

@@ -15,6 +15,7 @@ import { createTravisClient, initTravis } from './travis'
 import { JsonSchemaForTheTypeScriptCompilersConfigurationFile } from './tsconfig-schema'
 import { JSONSchemaForESLintConfigurationFiles } from './eslintrc-schema'
 import mkdirp from 'mkdirp-promise'
+import { HTTPError } from 'got'
 
 const createCLIError = (message: string): Error => Object.assign(new Error(message), { showStack: false })
 
@@ -99,7 +100,7 @@ async function main(): Promise<void> {
         repoName = await prompt.input({ message: 'Repository name', default: repoName })
         try {
             await githubClient.post('orgs/sourcegraph/repos', {
-                body: {
+                json: {
                     name: repoName,
                     private: visibility === Visibility.Private,
                     description,
@@ -111,11 +112,13 @@ async function main(): Promise<void> {
             console.log(`📘 Created https://github.com/sourcegraph/${repoName}`)
         } catch (err) {
             if (
-                err.error &&
-                Array.isArray(err.error.errors) &&
-                err.error.errors.some(
+                err instanceof HTTPError &&
+                (err.response.body as any)?.errors?.some?.(
                     (err: any) =>
-                        err.resource === 'Repository' && err.field === 'name' && /already exists/i.test(err.message)
+                        err?.resource === 'Repository' &&
+                        err?.field === 'name' &&
+                        typeof err?.message === 'string' &&
+                        /already exists/i.test(err.message)
                 )
             ) {
                 console.log(
@@ -132,7 +135,7 @@ async function main(): Promise<void> {
     console.log('🔑 Giving all FTTs admin access')
     // FTTs, see https://api.github.com/orgs/sourcegraph/teams
     await githubClient.put(`/teams/626894/repos/sourcegraph/${repoName}`, {
-        body: {
+        json: {
             permission: 'admin',
         },
     })
@@ -148,9 +151,12 @@ async function main(): Promise<void> {
     })
     if (licenseName !== 'UNLICENSED') {
         console.log('📄 Adding LICENSE')
-        const license = (await githubClient.get(`licenses/${licenseName}`)).body
+        const license = await githubClient.get<{ body: string }>(`licenses/${licenseName}`, {
+            responseType: 'json',
+            resolveBodyOnly: true,
+        })
         const licenseText = license.body
-            .replace(/\[year\]/g, new Date().getFullYear())
+            .replace(/\[year\]/g, new Date().getFullYear().toString())
             .replace(/\[fullname\]/g, 'Sourcegraph')
         await writeFile('LICENSE', licenseText)
     }
@@ -352,7 +358,10 @@ async function main(): Promise<void> {
     }
 
     console.log('🔑 Fetching Codecov repository tokens')
-    const codecovRepo: { repo: CodecovRepo } = (await codecovClient.get(`gh/sourcegraph/${repoName}`)).body
+    const codecovRepo = await codecovClient.get<{ repo: CodecovRepo }>(`gh/sourcegraph/${repoName}`, {
+        responseType: 'json',
+        resolveBodyOnly: true,
+    })
     if (!codecovRepo.repo || !codecovRepo.repo.upload_token) {
         throw Object.assign(
             new Error(`No Codecov upload token returned by Codecov for https://codecov.io/gh/sourcegraph/${repoName}`),

src/codecov.ts

@@ -1,6 +1,6 @@
-import got, { GotInstance, GotJSONFn } from 'got'
+import got, { Got } from 'got'
 
-export type CodecovClient = GotInstance<GotJSONFn>
+export type CodecovClient = Got
 
 export interface CodecovRepo {
     upload_token: string
@@ -9,11 +9,12 @@ export interface CodecovRepo {
 
 export const createCodecovClient = ({ token }: { token: string }): CodecovClient =>
     got.extend({
-        baseUrl: 'https://codecov.io/api/',
-        json: true,
+        prefixUrl: 'https://codecov.io/api/',
         headers: {
             Authorization: 'token ' + token,
         },
+        responseType: 'json',
+        resolveBodyOnly: true,
     })
 
 export const getCodecovBadge = ({

src/github.ts

@@ -1,16 +1,17 @@
-import got, { GotInstance, GotJSONFn } from 'got'
+import got, { Got } from 'got'
 import * as prompt from './prompt'
 
-export type GitHubClient = GotInstance<GotJSONFn>
+export type GitHubClient = Got
 
 export const createGitHubClient = ({ token }: { token: string }): GitHubClient =>
     got.extend({
-        baseUrl: 'https://api.github.com/',
-        json: true,
+        prefixUrl: 'https://api.github.com/',
         headers: {
             Authorization: 'Bearer ' + token,
             'User-Agent': 'NodeJS',
         },
+        responseType: 'json',
+        resolveBodyOnly: true,
     })
 
 export async function createSourcegraphBotGitHubToken({
@@ -26,17 +27,18 @@ export async function createSourcegraphBotGitHubToken({
     const password = await prompt.password('@sourcegraph-bot GitHub password')
     const otp = await prompt.input('@sourcegraph-bot GitHub 2FA code')
 
-    const response = await githubClient.post('authorizations', {
+    const response = await githubClient.post<{ token: string }>('authorizations', {
         headers: {
             Authorization: 'Basic ' + Buffer.from('sourcegraph-bot:' + password).toString('base64'),
             'X-GitHub-OTP': otp,
         },
-        json: true,
-        body: {
+        json: {
             note: `semantic-release Travis CI for repo ${repoName}`,
             scopes: ['repo', 'read:org', 'user:email', 'repo_deployment', 'repo:status', 'write:repo_hook'],
         },
+        responseType: 'json',
+        resolveBodyOnly: true,
     })
     console.log('🔑 Created GitHub token for @sourcegraph-bot')
-    return response.body.token
+    return response.token
 }

src/travis.ts

@@ -1,17 +1,16 @@
 import delay from 'delay'
-import got, { GotInstance, GotJSONFn } from 'got'
+import got, { Got, HTTPError } from 'got'
 import * as yaml from 'js-yaml'
 import { exists, writeFile } from 'mz/fs'
 import { createSourcegraphBotGitHubToken, GitHubClient } from './github'
 import { createSourcegraphBotNpmToken } from './npm'
 import { JsonSchemaForTravisCiConfigurationFiles } from './travis-schema'
 
-export type TravisClient = GotInstance<GotJSONFn>
+export type TravisClient = Got
 
 export const createTravisClient = ({ token }: { token: string }): TravisClient =>
     got.extend({
-        baseUrl: 'https://api.travis-ci.org/',
-        json: true,
+        prefixUrl: 'https://api.travis-ci.org/',
         headers: {
             Authorization: 'token ' + token,
             'Travis-API-Version': '3',
@@ -32,8 +31,7 @@ const createTravisEnvVar = async ({
     travisClient: TravisClient
 }): Promise<void> => {
     await travisClient.post(`/repo/sourcegraph%2F${repoName}/env_vars`, {
-        json: true,
-        body: {
+        json: {
             'env_var.name': name,
             'env_var.value': value,
             'env_var.public': false,
@@ -53,8 +51,14 @@ interface TravisUser {
     synced_at: string
 }
 
+interface TravisEnvVarsResult {
+    env_vars: {
+        name: string
+    }[]
+}
+
 const getCurrentTravisUser = async ({ travisClient }: { travisClient: TravisClient }): Promise<TravisUser> =>
-    (await travisClient.get('user')).body
+    travisClient.get<TravisUser>('user', { responseType: 'json', resolveBodyOnly: true })
 
 export async function initTravis({
     hasTests,
@@ -128,22 +132,25 @@ export async function initTravis({
             await travisClient.post(`/repo/sourcegraph%2F${repoName}/activate`)
             break
         } catch (err) {
-            if (err.status !== 404) {
+            if (!(err instanceof HTTPError) || err.response.statusCode !== 404) {
                 throw err
             }
         }
     }
 
-    const envVars = (await travisClient.get(`/repo/sourcegraph%2F${repoName}/env_vars`)).body
-    if (envVars.env_vars.some((envVar: any) => envVar.name === 'NPM_TOKEN')) {
+    const envVars = await travisClient.get<TravisEnvVarsResult>(`/repo/sourcegraph%2F${repoName}/env_vars`, {
+        responseType: 'json',
+        resolveBodyOnly: true,
+    })
+    if (envVars.env_vars.some(envVar => envVar.name === 'NPM_TOKEN')) {
         console.log('🔑 NPM_TOKEN already set in Travis, skipping creation')
     } else {
         const npmToken = await createSourcegraphBotNpmToken()
         console.log('🔑 Setting NPM_TOKEN env var in Travis')
         await createTravisEnvVar({ repoName, name: 'NPM_TOKEN', value: npmToken, branch: 'master', travisClient })
     }
 
-    if (envVars.env_vars.some((envVar: any) => envVar.name === 'GITHUB_TOKEN')) {
+    if (envVars.env_vars.some(envVar => envVar.name === 'GITHUB_TOKEN')) {
         console.log('🔑 GITHUB_TOKEN already set in Travis, skipping creation')
     } else {
         const githubToken = await createSourcegraphBotGitHubToken({ repoName, githubClient })