Merge pull request #983 from gr2m/upgrade-octokit-rest

Upgrade to latest @octokit/rest
danger · Feb 3, 2020 · 0c5b23f · 0c5b23f
2 parents b4233d1 + df20c01
commit 0c5b23f
Show file tree

Hide file tree

Showing 10 changed files with 179 additions and 79 deletions.
diff --git a/source/danger.d.ts b/source/danger.d.ts
@@ -2,7 +2,7 @@
 // Autogenerated from scripts/danger-dts.ts
 //
 
-import * as GitHub from "@octokit/rest"
+import { Octokit as GitHub } from "@octokit/rest"
 
 type MarkdownString = string
 // TODO: extract out from BitBucket specifically, or create our own type

diff --git a/source/dsl/GitHubDSL.ts b/source/dsl/GitHubDSL.ts
@@ -1,7 +1,7 @@
 // Please don't have includes in here that aren't inside the DSL folder, or the d.ts/flow defs break
 
 import { GitCommit } from "./Commit"
-import * as GitHub from "@octokit/rest"
+import { Octokit as GitHub } from "@octokit/rest"
 
 // This is `danger.github` inside the JSON
 

diff --git a/source/platforms/GitHub.ts b/source/platforms/GitHub.ts
@@ -3,7 +3,7 @@ import { GitHubAPI } from "./github/GitHubAPI"
 import GitHubUtils from "./github/GitHubUtils"
 import gitDSLForGitHub from "./github/GitHubGit"
 
-import NodeGitHub from "@octokit/rest"
+import { Octokit as NodeGitHub } from "@octokit/rest"
 import { Platform } from "./platform"
 
 import { GitHubIssueCommenter } from "./github/comms/issueCommenter"

diff --git a/source/platforms/github/GitHubAPI.ts b/source/platforms/github/GitHubAPI.ts
@@ -1,4 +1,4 @@
-import GitHubNodeAPI from "@octokit/rest"
+import { Octokit as GitHubNodeAPI } from "@octokit/rest"
 import { debug } from "../../debug"
 import * as node_fetch from "node-fetch"
 import parse from "parse-link-header"

diff --git a/source/platforms/github/GitHubUtils.ts b/source/platforms/github/GitHubUtils.ts
@@ -6,7 +6,7 @@ import { filepathContentsMapToUpdateGitHubBranch, BranchCreationConfig } from "m
 
 const d = debug("GitHub::Utils")
 
-import * as GitHub from "@octokit/rest"
+import { Octokit as GitHub } from "@octokit/rest"
 
 // We need to curry in access to the GitHub PR metadata
 
@@ -66,8 +66,13 @@ export const fileContentsGenerator = (
     owner: repoSlug.split("/")[0],
   }
   try {
+    // response of getContents() can be one of 4 things. We are interested in file responses only
+    // https://developer.github.com/v3/repos/contents/#get-contents
     const response = await api.repos.getContents(opts)
-    if (response && response.data && response.data.type === "file") {
+    if (Array.isArray(response.data)) {
+      return ""
+    }
+    if (response && response.data && response.data.content) {
       const buffer = new Buffer(response.data.content, response.data.encoding)
       return buffer.toString()
     } else {

diff --git a/source/platforms/github/_tests/_github_git.test.ts b/source/platforms/github/_tests/_github_git.test.ts
@@ -7,7 +7,7 @@ import { readFileSync } from "fs"
 import { resolve, join as pathJoin } from "path"
 import { gitHubGitDSL as gitJSONToGitDSL } from "../GitHubGit"
 
-import NodeGitHub from "@octokit/rest"
+import { Octokit as NodeGitHub } from "@octokit/rest"
 import { GitHubDSL } from "../../../dsl/GitHubDSL"
 import { GitDSL, GitJSONDSL } from "../../../dsl/GitDSL"
 

diff --git a/source/platforms/github/_tests/fixturedGitHubDSL.ts b/source/platforms/github/_tests/fixturedGitHubDSL.ts
@@ -6,7 +6,7 @@ import { readFileSync } from "fs"
 import { resolve, join as pathJoin } from "path"
 import { gitHubGitDSL as gitJSONToGitDSL } from "../GitHubGit"
 
-import NodeGitHub from "@octokit/rest"
+import { Octokit as NodeGitHub } from "@octokit/rest"
 import { GitHubDSL } from "../../../dsl/GitHubDSL"
 import { GitDSL, GitJSONDSL } from "../../../dsl/GitDSL"
 import { DangerDSLType } from "../../../dsl/DangerDSL"

diff --git a/source/platforms/github/comms/checks/resultsToCheck.ts b/source/platforms/github/comms/checks/resultsToCheck.ts
@@ -2,7 +2,7 @@ import { DangerResults, regularResults, inlineResults, resultsIntoInlineResults
 import { GitHubPRDSL } from "../../../../dsl/GitHubDSL"
 import { ExecutorOptions } from "../../../../runner/Executor"
 import { template as githubResultsTemplate } from "../../../../runner/templates/githubIssueTemplate"
-import GitHubNodeAPI from "@octokit/rest"
+import { Octokit as GitHubNodeAPI } from "@octokit/rest"
 import { debug } from "../../../../debug"
 
 const d = debug("GitHub::ResultsToCheck")
@@ -68,7 +68,13 @@ export const resultsToCheck = async (
 
   const getBlobUrlForPath = async (path: string) => {
     try {
+      // response of getContents() can be one of 4 things. We are interested in file responses only
+      // https://developer.github.com/v3/repos/contents/#get-contents
       const { data } = await api.repos.getContents({ repo: pr.head.repo.name, owner: pr.head.repo.owner.login, path })
+      if (Array.isArray(data)) {
+        console.error(`Path "${path}" is a folder - ignoring`)
+        return ""
+      }
       d("Got content data for: ", path)
       // https://developer.github.com/v3/checks/runs/#example-of-completed-conclusion
       // e.g.  "blob_href": "http://github.com/octocat/Hello-World/blob/837db83be4137ca555d9a5598d0a1ea2987ecfee/README.md",

diff --git a/source/runner/jsonToDSL.ts b/source/runner/jsonToDSL.ts
@@ -1,4 +1,4 @@
-import OctoKit from "@octokit/rest"
+import { Octokit } from "@octokit/rest"
 
 import { DangerDSLJSONType, DangerDSLType } from "../dsl/DangerDSL"
 import { gitHubGitDSL as githubJSONToGitDSL } from "../platforms/github/GitHubGit"
@@ -31,7 +31,7 @@ export const jsonToDSL = async (dsl: DangerDSLJSONType, source: CISource): Promi
 
   const api = apiForDSL(dsl)
   const platformExists = [dsl.github, dsl.bitbucket_server, dsl.gitlab, dsl.bitbucket_cloud].some(p => !!p)
-  const github = dsl.github && githubJSONToGitHubDSL(dsl.github, api as OctoKit)
+  const github = dsl.github && githubJSONToGitHubDSL(dsl.github, api as Octokit)
   const bitbucket_server =
     dsl.bitbucket_server && bitbucketServerJSONToBitBucketServerDSL(dsl.bitbucket_server, api as BitBucketServerAPI)
   const bitbucket_cloud = dsl.bitbucket_cloud
@@ -67,7 +67,7 @@ export const jsonToDSL = async (dsl: DangerDSLJSONType, source: CISource): Promi
   }
 }
 
-const apiForDSL = (dsl: DangerDSLJSONType): OctoKit | BitBucketServerAPI | GitLabAPI | BitBucketCloudAPI => {
+const apiForDSL = (dsl: DangerDSLJSONType): Octokit | BitBucketServerAPI | GitLabAPI | BitBucketCloudAPI => {
   if (process.env["DANGER_BITBUCKETSERVER_HOST"]) {
     return new BitBucketServerAPI(dsl.bitbucket_server!.metadata, bitbucketServerRepoCredentialsFromEnv(process.env))
   }
@@ -82,7 +82,7 @@ const apiForDSL = (dsl: DangerDSLJSONType): OctoKit | BitBucketServerAPI | GitLa
     return new GitLabAPI(gitlab.metadata, getGitLabAPICredentialsFromEnv(process.env))
   }
 
-  const options: OctoKit.Options & { debug: boolean } = {
+  const options: Octokit.Options & { debug: boolean } = {
     debug: !!process.env.LOG_FETCH_REQUESTS,
     baseUrl: dsl.settings.github.baseURL,
   }
@@ -102,6 +102,6 @@ const apiForDSL = (dsl: DangerDSLJSONType): OctoKit | BitBucketServerAPI | GitLa
     options.auth = `token ${dsl.settings.github.accessToken}`
   }
 
-  const api = new OctoKit(options)
+  const api = new Octokit(options)
   return api
 }