refactor: Extract github-related calls

2023-10-31 17:51:00 +08:00
parent e2753d2444
commit 0bb95b5a6f
18 changed files with 614 additions and 487 deletions
@@ -0,0 +1,37 @@
+import {TagInfo} from "../pr-collector/tags";
+import {DiffInfo} from "../pr-collector/commits";
+import {Options} from "../pr-collector/prCollector";
+import moment from "moment/moment";
+import {PullRequestInfo} from "../pr-collector/pullRequests";
+
+export abstract class BaseRepository {
+    proxy?: string;
+    noProxyArray: string[]
+
+    // Define an abstract getter for the default URL
+    abstract get defaultUrl(): string;
+
+    protected constructor(protected token: string, protected url?: string) {
+        this.proxy = process.env.https_proxy || process.env.HTTPS_PROXY
+        const noProxy = process.env.no_proxy || process.env.NO_PROXY
+        this.noProxyArray = []
+        if (noProxy) {
+            this.noProxyArray = noProxy.split(',')
+        }
+    }
+
+    abstract getTags(owner: string, repo: string, maxTagsToFetch: number): Promise<TagInfo[]>
+
+    abstract fillTagInformation(repositoryPath: string, owner: string, repo: string, tagInfo: TagInfo): Promise<TagInfo>
+
+    abstract getDiffRemote(owner: string, repo: string, base: string, head: string): Promise<DiffInfo>
+
+
+    abstract getForCommitHash(owner: string, repo: string, commit_sha: string, maxPullRequests: number): Promise<PullRequestInfo[]>
+
+    abstract getBetweenDates(owner: string, repo: string, fromDate: moment.Moment, toDate: moment.Moment, maxPullRequests: number): Promise<PullRequestInfo[]>
+
+    abstract getOpen(owner: string, repo: string, maxPullRequests: number): Promise<PullRequestInfo[]>
+
+    abstract getReviews(owner: string, repo: string, pr: PullRequestInfo): Promise<void>
+}
@@ -0,0 +1,43 @@
+import {BaseRepository} from "./BaseRepository";
+import {TagInfo} from "../pr-collector/tags";
+import {PullRequestInfo} from "../pr-collector/pullRequests";
+import {DiffInfo} from "../pr-collector/commits";
+
+export class GiteaRepository extends BaseRepository{
+    get defaultUrl(): string {
+        return "https://gitea.com/api/v1";
+    }
+    constructor(token: string, url?: string) {
+        super(token, url);
+        this.url = url || this.defaultUrl
+    }
+
+    fillTagInformation(repositoryPath: string, owner: string, repo: string, tagInfo: TagInfo): Promise<TagInfo> {
+        return Promise.resolve(undefined);
+    }
+
+    getBetweenDates(owner: string, repo: string, fromDate: moment.Moment, toDate: moment.Moment, maxPullRequests: number): Promise<PullRequestInfo[]> {
+        return Promise.resolve([]);
+    }
+
+    getDiffRemote(owner: string, repo: string, base: string, head: string): Promise<DiffInfo> {
+        return Promise.resolve(undefined);
+    }
+
+    getForCommitHash(owner: string, repo: string, commit_sha: string, maxPullRequests: number): Promise<PullRequestInfo[]> {
+        return Promise.resolve([]);
+    }
+
+    getOpen(owner: string, repo: string, maxPullRequests: number): Promise<PullRequestInfo[]> {
+        return Promise.resolve([]);
+    }
+
+    getReviews(owner: string, repo: string, pr: PullRequestInfo): Promise<void> {
+        return Promise.resolve(undefined);
+    }
+
+    getTags(owner: string, repo: string, maxTagsToFetch: number): Promise<TagInfo[]> {
+        return Promise.resolve([]);
+    }
+
+}
@@ -0,0 +1,262 @@
+import {BaseRepository} from "./BaseRepository";
+import {Octokit, RestEndpointMethodTypes} from "@octokit/rest";
+import {HttpsProxyAgent} from "https-proxy-agent";
+import * as core from "@actions/core";
+import {TagInfo} from "../pr-collector/tags";
+import moment from "moment/moment";
+import {createCommandManager} from "../pr-collector/gitHelper";
+import {DiffInfo} from "../pr-collector/commits";
+import {
+    CommentInfo,
+    fetchedEnough,
+    mapComment,
+    mapPullRequest,
+    PullRequestInfo,
+    PullReviewsData, PullsListData
+} from "../pr-collector/pullRequests";
+
+export class GithubRepository extends BaseRepository {
+
+    async getDiffRemote(owner: string, repo: string, base: string, head: string): Promise<DiffInfo> {
+        let changedFilesCount = 0
+        let additionCount = 0
+        let deletionCount = 0
+        let changeCount = 0
+        let commitCount = 0
+
+        // Fetch comparisons recursively until we don't find any commits
+        // This is because the GitHub API limits the number of commits returned in a single response.
+        let commits: RestEndpointMethodTypes['repos']['compareCommits']['response']['data']['commits'] = []
+        let compareHead = head
+        // eslint-disable-next-line no-constant-condition
+        while (true) {
+            const compareResult = await this.octokit.repos.compareCommits({
+                owner,
+                repo,
+                base,
+                head: compareHead
+            })
+            if (compareResult.data.total_commits === 0) {
+                break
+            }
+            changedFilesCount += compareResult.data.files?.length ?? 0
+            const files = compareResult.data.files
+            if (files !== undefined) {
+                for (const file of files) {
+                    additionCount += file.additions
+                    deletionCount += file.deletions
+                    changeCount += file.changes
+                }
+            }
+            commitCount += compareResult.data.commits.length
+            commits = compareResult.data.commits.concat(commits)
+            compareHead = `${commits[0].sha}^`
+        }
+
+        core.info(`ℹ️ Found ${commits.length} commits from the GitHub API for ${owner}/${repo}`)
+
+        return {
+            changedFiles: changedFilesCount,
+            additions: additionCount,
+            deletions: deletionCount,
+            changes: changeCount,
+            commits: commitCount,
+            commitInfo: commits
+                .filter(commit => commit.sha)
+                .map(commit => ({
+                    sha: commit.sha || '',
+                    summary: commit.commit.message.split('\n')[0],
+                    message: commit.commit.message,
+                    author: commit.author?.login || '',
+                    authorDate: moment(commit.commit.author?.date),
+                    committer: commit.committer?.login || '',
+                    commitDate: moment(commit.commit.committer?.date),
+                    prNumber: undefined
+                }))
+        }
+    }
+
+    async getForCommitHash(owner: string, repo: string, commit_sha: string, maxPullRequests: number): Promise<PullRequestInfo[]> {
+        const mergedPRs: PullRequestInfo[] = []
+        const options = this.octokit.repos.listPullRequestsAssociatedWithCommit.endpoint.merge({
+            owner,
+            repo,
+            commit_sha,
+            per_page: `${Math.min(10, maxPullRequests)}`,
+            direction: 'desc'
+        })
+
+        for await (const response of this.octokit.paginate.iterator(options)) {
+            const prs: PullsListData = response.data as PullsListData
+
+            for (const pr of prs) {
+                mergedPRs.push(mapPullRequest(pr, pr.merged_at ? 'merged' : 'open'))
+            }
+        }
+        return mergedPRs
+    }
+    async getBetweenDates(owner: string, repo: string, fromDate: moment.Moment, toDate: moment.Moment, maxPullRequests: number): Promise<PullRequestInfo[]> {
+        const mergedPRs: PullRequestInfo[] = []
+        const options = this.octokit.pulls.list.endpoint.merge({
+            owner,
+            repo,
+            state: 'closed',
+            sort: 'merged',
+            per_page: `${Math.min(100, maxPullRequests)}`,
+            direction: 'desc'
+        })
+        for await (const response of this.octokit.paginate.iterator(options)) {
+            const prs: PullsListData = response.data as PullsListData
+
+            for (const pr of prs.filter(p => !!p.merged_at)) {
+                mergedPRs.push(mapPullRequest(pr, 'merged'))
+            }
+            if (mergedPRs.length >= maxPullRequests) {
+                core.warning(`⚠️ Reached 'maxPullRequests' count ${maxPullRequests} (1)`)
+                break // bail out early to not keep iterating forever
+            } else if (prs.length > 0) {
+                if (fetchedEnough(prs, fromDate)) {
+                    return mergedPRs // bail out early to not keep iterating on PRs super old
+                }
+            } else {
+                core.debug(`⚠️ No more PRs retrieved from API. Fetched so far: ${mergedPRs.length}`)
+                break
+            }
+        }
+        return mergedPRs
+    }
+    async getOpen(owner: string, repo: string, maxPullRequests: number): Promise<PullRequestInfo[]> {
+        const openPrs: PullRequestInfo[] = []
+        const options = this.octokit.pulls.list.endpoint.merge({
+            owner,
+            repo,
+            state: 'open',
+            sort: 'created',
+            per_page: '100',
+            direction: 'desc'
+        })
+
+        for await (const response of this.octokit.paginate.iterator(options)) {
+            const prs: PullsListData = response.data as PullsListData
+
+            for (const pr of prs) {
+                openPrs.push(mapPullRequest(pr, 'open'))
+            }
+
+            const firstPR = prs[0]
+            if (firstPR === undefined || openPrs.length >= maxPullRequests) {
+                if (openPrs.length >= maxPullRequests) {
+                    core.warning(`⚠️ Reached 'maxPullRequests' count ${maxPullRequests} (2)`)
+                }
+                break // bail out early to not keep iterating forever
+            }
+        }
+        return openPrs
+    }
+    async getReviews(owner: string, repo: string, pr: PullRequestInfo): Promise<void> {
+        const options = this.octokit.pulls.listReviews.endpoint.merge({
+            owner,
+            repo,
+            pull_number: pr.number,
+            sort: 'created',
+            direction: 'desc'
+        })
+        const prReviews: CommentInfo[] = []
+        for await (const response of this.octokit.paginate.iterator(options)) {
+            const comments: PullReviewsData = response.data as PullReviewsData
+
+            for (const comment of comments) {
+                prReviews.push(mapComment(comment))
+            }
+        }
+        pr.reviews = prReviews
+    }
+    get defaultUrl(): string {
+        return "https://api.example.com";
+    }
+    private octokit:Octokit
+    constructor(token: string, url?: string) {
+        super(token, url);
+        this.url = url || this.defaultUrl
+
+        // load octokit instance
+        this.octokit = new Octokit({
+            auth: `token ${this.token}`,
+            baseUrl: this.url
+        })
+        if (this.proxy) {
+            const agent = new HttpsProxyAgent(this.proxy)
+            this.octokit.hook.before('request', options => {
+                if (this.noProxyArray.includes(options.request.hostname)) {
+                    return
+                }
+                options.request.agent = agent
+            })
+        }
+    }
+
+    async getTags(owner: string, repo: string, maxTagsToFetch: number): Promise<TagInfo[]> {
+        const tagsInfo: TagInfo[] = []
+        const options = this.octokit.repos.listTags.endpoint.merge({
+            owner,
+            repo,
+            direction: 'desc',
+            per_page: 100
+        })
+
+        for await (const response of this.octokit.paginate.iterator(options)) {
+            type TagsListData = RestEndpointMethodTypes['repos']['listTags']['response']['data']
+            const tags: TagsListData = response.data as TagsListData
+
+            for (const tag of tags) {
+                tagsInfo.push({
+                    name: tag.name,
+                    commit: tag.commit.sha
+                })
+            }
+
+            // for performance only fetch newest maxTagsToFetch tags!!
+            if (tagsInfo.length >= maxTagsToFetch) {
+                break
+            }
+        }
+
+        core.info(`ℹ️ Found ${tagsInfo.length} (fetching max: ${maxTagsToFetch}) tags from the GitHub API for ${owner}/${repo}`)
+        return tagsInfo
+    }
+
+    async fillTagInformation(repositoryPath: string, owner: string, repo: string, tagInfo: TagInfo): Promise<TagInfo> {
+        const options = this.octokit.repos.getReleaseByTag.endpoint.merge({
+            owner,
+            repo,
+            tag: tagInfo.name
+        })
+
+        try {
+            const response = await this.octokit.request(options)
+            type ReleaseInformation = RestEndpointMethodTypes['repos']['getReleaseByTag']['response']['data']
+
+            const release: ReleaseInformation = response.data as ReleaseInformation
+            tagInfo.date = moment(release.created_at)
+            core.info(`ℹ️ Retrieved information about the release associated with ${tagInfo.name} from the GitHub API`)
+        } catch (error) {
+            core.info(`⚠️ No release information found for ${tagInfo.name}, trying to retrieve tag creation time as fallback.`)
+            const gitHelper = await createCommandManager(repositoryPath)
+            const creationTimeString = await gitHelper.tagCreation(tagInfo.name)
+            const creationTime = moment(creationTimeString)
+            if (creationTimeString !== null && creationTime.isValid()) {
+                tagInfo.date = creationTime
+                core.info(
+                    `ℹ️ Resolved tag creation time (${creationTimeString}) from 'git for-each-ref --format="%(creatordate:rfc)" "refs/tags/${tagInfo.name}`
+                )
+            } else {
+                core.info(
+                    `⚠️ Could not retrieve tag creation time via git cli 'git for-each-ref --format="%(creatordate:rfc)" "refs/tags/${tagInfo.name}'`
+                )
+            }
+        }
+        return tagInfo
+    }
+
+
+}