lib/common/utils/reportUtilities.util.ts

import type { AxiosResponse } from "axios";
import type { ReportService } from "../../client";
import { ReportJobStatus } from "../../client/services/report/report.enum";
import type { ReportDownloadOptions } from "../../client/services/report/report.type";
import { AdsReportsException } from "../handlers";
import { HttpUtilities } from "./httpUtilities.util";
import { AdsReportUtilities, ReportResponse } from "./reports";

/**
 * Utility class for DFP API report downloads.
 */
export class ReportUtilities extends AdsReportUtilities {
  /**
   * The report service object to make calls with
   */
  private reportService: ReportService;

  /**
   * The ID of the report job to check
   */
  private reportJobId: number;

  /**
   * The options to use when downloading the completed report.
   */
  public reportDownloadOptions?: ReportDownloadOptions;

  /**
   * @param reportService ReportService to be used
   * @param reportJobId The ID of the report job
   */
  constructor(reportService: ReportService, reportJobId: number) {
    super();
    this.reportService = reportService;
    this.reportJobId = reportJobId;
  }

  /**
   * Returns a flag indicating whether the caller should wait more time for
   * the report download to complete.
   * @returns True, if the caller should wait more, false otherwise.
   */
  async shouldWaitMore(): Promise<boolean> {
    const status: ReportJobStatus = await this.reportService.getReportJobStatus(
      this.reportJobId,
    );

    if (status === ReportJobStatus.FAILED) {
      throw new AdsReportsException(`Report job ${this.reportJobId} failed.`);
    }

    return status != ReportJobStatus.COMPLETED;
  }

  /**
   * Gets the report response.
   * @returns The report response.
   */
  protected async getReport(): Promise<ReportResponse> {
    const response = await this.buildRequest(
      await this.reportService.getReportDownloadUrlWithOptions(
        this.reportJobId,
        this.reportDownloadOptions,
      ),
    );

    return new ReportResponse(response);
  }

  /**
   * Builds an HTTP request for downloading reports.
   * @param downloadUrl The download url.
   */
  private buildRequest(downloadUrl: string): Promise<AxiosResponse> {
    return HttpUtilities.buildRequest(downloadUrl, "GET", {
      timeout: 0,
    });
  }
}