File

src/timescale/push_github_events.service.ts

Index

Methods

Constructor

constructor(pushGitHubEventsRepository: Repository<DbPushGitHubEvents>, pushGitHubEventsHistogramRepository: Repository)
Parameters :
Name Type Optional
pushGitHubEventsRepository Repository<DbPushGitHubEvents> No
pushGitHubEventsHistogramRepository Repository<DbPushGitHubEventsHistogram> No

Methods

baseQueryBuilder
baseQueryBuilder()
Returns : any
Async genPushHistogram
genPushHistogram(options: PushesHistogramDto)
Parameters :
Name Type Optional
options PushesHistogramDto No
Returns : Promise<DbPushGitHubEventsHistogram[]>
Async getPushCountForLogin
getPushCountForLogin(username: string, contribType: ContributorStatsTypeEnum, range: number, repos?: string[])
Parameters :
Name Type Optional
username string No
contribType ContributorStatsTypeEnum No
range number No
repos string[] Yes
Returns : Promise<number>
Async getPushEventsAllForLogin
getPushEventsAllForLogin(username: string, range: number, repos?: string[])
Parameters :
Name Type Optional
username string No
range number No
repos string[] Yes
Async getPushEventsAllForRepos
getPushEventsAllForRepos(undefined: literal type)
Parameters :
Name Type Optional
literal type No
Async lastPushDatesForRepo
lastPushDatesForRepo(repo: string)
Parameters :
Name Type Optional
repo string No
Returns : Promise<literal type>
import { BadRequestException, Injectable } from "@nestjs/common";
import { InjectRepository } from "@nestjs/typeorm";
import { Repository } from "typeorm";
import { GetPrevDateISOString } from "../common/util/datetimes";
import { PushesHistogramDto } from "../histogram/dtos/pushes.dto";
import { OrderDirectionEnum } from "../common/constants/order-direction.constant";
import { DbPushGitHubEventsHistogram } from "./entities/push_github_events_histogram.entity";
import { DbPushGitHubEvents } from "./entities/push_github_events.entity";
import { applyContribTypeEnumFilters } from "./common/counts";
import { ContributorStatsTypeEnum } from "./dtos/most-active-contrib.dto";

/*
 * push events, named "PushEvent" in the GitHub API, are when
 * a GitHub actor makes a "git push" to a repo's ref. This may be the main ref
 * (like ref/head/main) or some branch on the repo.
 *
 * for further details, refer to: https://docs.github.com/en/rest/using-the-rest-api/github-event-types?apiVersion=2022-11-28
 */

@Injectable()
export class PushGithubEventsService {
  constructor(
    @InjectRepository(DbPushGitHubEvents, "TimescaleConnection")
    private pushGitHubEventsRepository: Repository<DbPushGitHubEvents>,
    @InjectRepository(DbPushGitHubEventsHistogram, "TimescaleConnection")
    private pushGitHubEventsHistogramRepository: Repository<DbPushGitHubEventsHistogram>
  ) {}

  baseQueryBuilder() {
    const builder = this.pushGitHubEventsRepository.createQueryBuilder("push_github_events");

    return builder;
  }

  async getPushEventsAllForLogin(username: string, range: number, repos?: string[]): Promise<DbPushGitHubEvents[]> {
    const queryBuilder = this.baseQueryBuilder()
      .where("LOWER(actor_login) = :username", { username })
      .andWhere("push_ref IN ('refs/heads/main', 'refs/heads/master')")
      .andWhere("event_time > NOW() - :range_interval::INTERVAL", { range_interval: `${range} days` });

    if (repos && repos.length > 0) {
      queryBuilder.andWhere(`LOWER(repo_name) IN (:...repos)`, { repos });
    }

    return queryBuilder.getMany();
  }

  async getPushEventsAllForRepos({
    range,
    repos,
    ref,
  }: {
    range: number;
    repos: string[];
    ref?: string;
  }): Promise<DbPushGitHubEvents[]> {
    const queryBuilder = this.baseQueryBuilder()
      .where("event_time > NOW() - :range_interval::INTERVAL", {
        range_interval: `${range} days`,
      })
      .andWhere(`LOWER(repo_name) IN (:...repos)`, { repos: repos.map((repo) => repo.toLowerCase()) });

    if (ref) {
      queryBuilder.andWhere("push_ref = :ref", { ref });
    }

    return queryBuilder.getMany();
  }

  async getPushCountForLogin(
    username: string,
    contribType: ContributorStatsTypeEnum,
    range: number,
    repos?: string[]
  ): Promise<number> {
    const queryBuilder = this.pushGitHubEventsRepository.manager
      .createQueryBuilder()
      .select("COALESCE(sum(push_num_commits), 0) AS commits")
      .from("push_github_events", "push_github_events")
      .where("LOWER(actor_login) = :username", { username })
      .andWhere("push_ref IN ('refs/heads/main', 'refs/heads/master')")
      .groupBy("LOWER(actor_login)");

    if (repos && repos.length > 0) {
      queryBuilder.andWhere(`LOWER(repo_name) IN (:...repos)`, { repos });
    }

    applyContribTypeEnumFilters(contribType, queryBuilder, range);

    const result = await queryBuilder.getRawOne<{ commits: number }>();
    const parsedResult = parseFloat(`${result?.commits ?? "0"}`);

    return parsedResult;
  }

  async genPushHistogram(options: PushesHistogramDto): Promise<DbPushGitHubEventsHistogram[]> {
    if (!options.contributor && !options.repo && !options.repoIds) {
      throw new BadRequestException("must provide contributor, repo, or repoIds");
    }

    const { range } = options;
    const order = options.orderDirection ?? OrderDirectionEnum.DESC;
    const startDate = GetPrevDateISOString(options.prev_days_start_date ?? 0);
    const width = options.width ?? 1;

    const queryBuilder = this.pushGitHubEventsHistogramRepository.manager
      .createQueryBuilder()
      .select("time_bucket(:width_interval::INTERVAL, event_time)", "bucket")
      .addSelect("count(*)", "pushes_count")
      .addSelect("count(CASE WHEN LOWER(push_ref) SIMILAR TO '%(main|master)%' THEN 1 END)", "main_pushes")
      .from("push_github_events", "push_github_events")
      .where(`:start_date::TIMESTAMP >= "push_github_events"."event_time"`, { start_date: startDate })
      .andWhere(`:start_date::TIMESTAMP - :range_interval::INTERVAL <= "push_github_events"."event_time"`, {
        start_date: startDate,
        range_interval: `${range} days`,
      })
      .groupBy("bucket")
      .orderBy("bucket", order)
      .setParameter("width_interval", `${width} days`);

    /* filter on the provided pusher username */
    if (options.contributor) {
      queryBuilder.andWhere(`LOWER("push_github_events"."actor_login") = LOWER(:actor)`, {
        actor: options.contributor,
      });
    }

    /* filter on the provided repo names */
    if (options.repo) {
      queryBuilder.andWhere(`LOWER("push_github_events"."repo_name") IN (:...repoNames)`, {
        repoNames: options.repo.toLowerCase().split(","),
      });
    }

    /* filter on the provided repo ids */
    if (options.repoIds) {
      queryBuilder.andWhere(`"push_github_events"."repo_id" IN (:...repoIds)`, {
        repoIds: options.repoIds.split(","),
      });
    }

    const rawResults = await queryBuilder.getRawMany();

    return rawResults as DbPushGitHubEventsHistogram[];
  }

  async lastPushDatesForRepo(repo: string): Promise<{ push_date: Date; main_push_date: Date }> {
    const startDate = GetPrevDateISOString(0);
    const range = 30;

    const queryBuilder = this.baseQueryBuilder()
      .where(`:start_date::TIMESTAMP >= "push_github_events"."event_time"`, {
        start_date: startDate,
      })
      .andWhere(`:start_date::TIMESTAMP - :range_interval::INTERVAL <= "push_github_events"."event_time"`, {
        start_date: startDate,
        range_interval: `${range} days`,
      })
      .andWhere(`LOWER("push_github_events"."repo_name") = '${repo}'`)
      .orderBy("event_time", OrderDirectionEnum.DESC);

    const results = await queryBuilder.getMany();

    if (results.length === 0) {
      return { push_date: new Date(0), main_push_date: new Date(0) };
    }

    const firstPushDate = results[0].event_time;
    const mainMasterRegex = new RegExp("main|master");
    const firstMainPushDate =
      results.find((item) => item.push_ref && mainMasterRegex.test(item.push_ref))?.event_time ?? new Date(0);

    return {
      push_date: firstPushDate,
      main_push_date: firstMainPushDate,
    };
  }
}

results matching ""

    No results matching ""