Class GitHubAPI

source/platforms/github/GitHubAPI.ts:70–600

/** This represent the GitHub API */

export class GitHubAPI {
  fetch: typeof fetch
  additionalHeaders: any
  private readonly d = debug("GitHubAPI")

  private pr: GitHubPRDSL | undefined

  constructor(public readonly repoMetadata: RepoMetaData, public readonly token?: APIToken) {
    // This allows Peril to DI in a new Fetch function
    // which can handle unique API edge-cases around integrations
    this.fetch = fetch
    this.additionalHeaders = {}
  }

  /**
   * Bit weird, yes, but we want something that can be exposed to an end-user.
   * I wouldn't have a problem with moving this to use this API under the hood
   * but for now that's just a refactor someone can try.
   */
  getExternalAPI = (accessTokenForApp?: string): GitHubNodeAPI => {
    // A token should have been set by this point
    const token = accessTokenForApp || this.token!

    const host = process.env["DANGER_GITHUB_API_BASE_URL"] || "https://api.github.com"
    const options: ConstructorParameters<typeof GitHubNodeAPI>[0] & { debug: boolean } = {
      debug: !!process.env.LOG_FETCH_REQUESTS,
      baseUrl: host,
      auth: `token ${token}`,
    }

    if (this.additionalHeaders) {
      options.headers = this.additionalHeaders
    }

    return new GitHubNodeAPI(options)
  }

  /**
   * Grabs the contents of an individual file on GitHub
   *
   * @param {string} path path to the file
   * @param {string} [ref] an optional sha
   * @returns {Promise<string>} text contents
   *
   */
  fileContents = async (path: string, repoSlug?: string, ref?: string): Promise<string> => {
    // Use the current state of PR if no repo/ref is passed
    if (!repoSlug || !ref) {
      const prJSON = await this.getPullRequestInfo()
      repoSlug = prJSON.head.repo.full_name
      ref = prJSON.head.ref
    }

    const data = await this.getFileContents(path, repoSlug, ref)
    const buffer = Buffer.from(data.content, "base64")
    return buffer.toString()
  }