-
Notifications
You must be signed in to change notification settings - Fork 77
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: extract github request logic in new file - githubClient.ts
Signed-off-by: Victor Yanev <victor.yanev@limechain.tech>
- Loading branch information
1 parent
97badf6
commit 45075f8
Showing
3 changed files
with
118 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| /*- | ||
| * | ||
| * Hedera JSON RPC Relay | ||
| * | ||
| * Copyright (C) 2022-2024 Hedera Hashgraph, LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| */ | ||
|
|
||
| import { Octokit } from '@octokit/core'; | ||
| import { GitHubContext } from '../types/GitHubContext'; | ||
|
|
||
| /** | ||
| * Client for interacting with GitHub, providing methods to perform operations such as adding comments to pull requests. | ||
| */ | ||
| export class GitHubClient { | ||
| private static readonly CREATE_COMMENT_ENDPOINT = 'POST /repos/{owner}/{repo}/pulls/{pull_number}/comments'; | ||
|
|
||
| /** | ||
| * The Octokit instance used to interact with GitHub. | ||
| * @private | ||
| */ | ||
| private readonly octokit: Octokit; | ||
|
|
||
| constructor(octokit?: Octokit) { | ||
| this.octokit = octokit || new Octokit({ auth: process.env.GITHUB_TOKEN }); | ||
| } | ||
|
|
||
| /** | ||
| * Adds a comment to a pull request. | ||
| * @param {string} commentBody - The body of the comment. | ||
| * @param {string} path - The file path related to the comment. | ||
| * @returns {Promise<void>} A promise that resolves when the comment is successfully posted. | ||
| */ | ||
| async addCommentToPullRequest(commentBody: string, path: string): Promise<void> { | ||
| try { | ||
| const context = GitHubClient.getContext(); | ||
| const response = await this.octokit.request(GitHubClient.CREATE_COMMENT_ENDPOINT, { | ||
| owner: context.owner, | ||
| repo: context.repo, | ||
| pull_number: context.pullNumber, | ||
| body: commentBody, | ||
| commit_id: context.commitId, | ||
| // @ts-ignore | ||
| subject_type: 'file', | ||
| path, | ||
| }); | ||
| console.info('Comment posted successfully:', response); | ||
| } catch (error) { | ||
| console.error('Failed to post comment to PR:', error); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves the GitHub context from environment variables. | ||
| * @returns {GitHubContext} The GitHub context. | ||
| */ | ||
| private static getContext(): GitHubContext { | ||
| const { GITHUB_REPOSITORY, GITHUB_PR_NUMBER, GITHUB_COMMIT_SHA, GITHUB_TOKEN } = process.env; | ||
| if (!GITHUB_REPOSITORY || !GITHUB_PR_NUMBER || !GITHUB_COMMIT_SHA || !GITHUB_TOKEN) { | ||
| throw new Error( | ||
| `Missing required environment variables: | ||
| $GITHUB_REPOSITORY, $GITHUB_PR_NUMBER, $GITHUB_COMMIT_SHA, $GITHUB_TOKEN`, | ||
| ); | ||
| } | ||
| const [owner, repo] = GITHUB_REPOSITORY.split('/'); | ||
| const pullNumber = parseInt(GITHUB_PR_NUMBER); | ||
| if (isNaN(pullNumber)) { | ||
| throw new Error('Invalid PR number: $GITHUB_PR_NUMBER must be a valid number.'); | ||
| } | ||
| return { owner, repo, pullNumber, token: GITHUB_TOKEN, commitId: GITHUB_COMMIT_SHA }; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /*- | ||
| * | ||
| * Hedera JSON RPC Relay | ||
| * | ||
| * Copyright (C) 2022-2024 Hedera Hashgraph, LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| */ | ||
|
|
||
| export interface GitHubContext { | ||
| readonly owner: string; | ||
| readonly repo: string; | ||
| readonly token: string; | ||
| readonly pullNumber: number; | ||
| readonly commitId: string; | ||
| } |