index.ts

import type { RequestOptions, OctokitResponse } from "@octokit/types";
import type { RequestErrorOptions } from "./types.js";

/**
 * Error with extra properties to help with debugging
 */
export class RequestError extends Error {
  name: "HttpError";

  /**
   * http status code
   */
  status: number;

  /**
   * Request options that lead to the error.
   */
  request: RequestOptions;

  /**
   * Response object if a response was received
   */
  response?: OctokitResponse<unknown> | undefined;

  constructor(
    message: string,
    statusCode: number,
    options: RequestErrorOptions,
  ) {
    super(message);

    this.name = "HttpError";

    // Coerce the statusCode to an integer especially if it is a string
    this.status = Number.parseInt(statusCode as unknown as string);

    // If status code is NaN, then set status to 0 to signal e.g. a network
    // error or a AbortError
    if (Number.isNaN(this.status)) {
      this.status = 0;
    }

    if ("response" in options) {
      this.response = options.response;
    }

    // redact request credentials without mutating original request options
    const requestCopy = Object.assign({}, options.request);
    if (options.request.headers.authorization) {
      requestCopy.headers = Object.assign({}, options.request.headers, {
        authorization: options.request.headers.authorization.replace(
          /(?<! ) .*$/,
          " [REDACTED]",
        ),
      });
    }

    requestCopy.url = requestCopy.url
      // client_id & client_secret can be passed as URL query parameters to increase rate limit
      // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications
      .replace(/\bclient_secret=\w+/g, "client_secret=[REDACTED]")
      // OAuth tokens can be passed as URL query parameters, although it is not recommended
      // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header
      .replace(/\baccess_token=\w+/g, "access_token=[REDACTED]");

    this.request = requestCopy;
  }
}