Merge pull request #5 from magnificode-ltd/release

add action.yml ncc
magnificode-ltd · May 10, 2023 · 1da5928 · 1da5928
2 parents 9072d74 + 4d69fdb
commit 1da5928
Show file tree

Hide file tree

Showing 10 changed files with 732 additions and 9 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,11 +1,6 @@
 # Node.js dependencies
 node_modules/
 
-# Compiled output
-dist/
-*.js
-*.js.map
-
 # TypeScript cache
 *.tsbuildinfo
 

diff --git a/action.yml b/action.yml
@@ -0,0 +1,11 @@
+name: chatgpt-reviewer-github-action
+description: GitHub action that provides a service for adding review comments to a pull request on GitHub
+author: MagnifiCode
+inputs:
+  model:
+    description: 'OpenAI model'
+    default: 'gpt-3.5-turbo'
+    required: false
+runs:
+  using: node16
+  main: dist/index.js
diff --git a/dist/config/errorsConfig.js b/dist/config/errorsConfig.js
@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorMessage = void 0;
+var ErrorMessage;
+(function (ErrorMessage) {
+    ErrorMessage[ErrorMessage["No_GitHub_Token"] = 0] = "No_GitHub_Token";
+    ErrorMessage[ErrorMessage["No_OpenAi_Token"] = 1] = "No_OpenAi_Token";
+    ErrorMessage[ErrorMessage["No_PullRequest_In_Context"] = 2] = "No_PullRequest_In_Context";
+    ErrorMessage[ErrorMessage["No_Patch_For_OpenAi_Suggestion"] = 3] = "No_Patch_For_OpenAi_Suggestion";
+    ErrorMessage[ErrorMessage["No_Changed_Files_In_PullRequest"] = 4] = "No_Changed_Files_In_PullRequest";
+    ErrorMessage[ErrorMessage["Not_Match_Status_Of_Changed_File"] = 5] = "Not_Match_Status_Of_Changed_File";
+    ErrorMessage[ErrorMessage["No_Patch_File"] = 6] = "No_Patch_File";
+})(ErrorMessage || (ErrorMessage = {}));
+exports.ErrorMessage = ErrorMessage;
+const errorsConfig = {
+    [ErrorMessage.No_GitHub_Token]: 'A GitHub token must be provided to use the Octokit API.',
+    [ErrorMessage.No_OpenAi_Token]: 'An OpenAI API token must be provided to use the OpenAI API. Make sure you have add a token with a name OPENAI_API_KEY in https://github.com/{user}/{repository}/settings/secrets/actions',
+    [ErrorMessage.No_PullRequest_In_Context]: 'Pull request data must be provided, check payload and try again.',
+    [ErrorMessage.No_Patch_For_OpenAi_Suggestion]: 'The patch must be exist to provide a suggestions with Open AI',
+    [ErrorMessage.No_Changed_Files_In_PullRequest]: 'There are not any changed files in provided pull request',
+    [ErrorMessage.Not_Match_Status_Of_Changed_File]: 'The status of the file should be one of ["added", "modified", "renamed", "changed"], provided status is:',
+    [ErrorMessage.No_Patch_File]: 'Patch file must be provided',
+};
+exports.default = errorsConfig;
diff --git a/dist/config/promptsConfig.js b/dist/config/promptsConfig.js
@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Prompt = void 0;
+var Prompt;
+(function (Prompt) {
+    Prompt[Prompt["Check_Patch"] = 0] = "Check_Patch";
+})(Prompt || (Prompt = {}));
+exports.Prompt = Prompt;
+const promptsConfig = {
+    [Prompt.Check_Patch]: 'Based on the patch provide a list of suggestions how to improve the code with examples.',
+};
+exports.default = promptsConfig;
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/services/commentOnPullRequestService.js b/dist/services/commentOnPullRequestService.js
@@ -0,0 +1,146 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const github_1 = require("@actions/github");
+const openai_1 = require("openai");
+const errorsConfig_1 = __importStar(require("../config/errorsConfig"));
+const promptsConfig_1 = __importStar(require("../config/promptsConfig"));
+class CommentOnPullRequestService {
+    constructor() {
+        var _a, _b, _c, _d, _e, _f;
+        if (!process.env.GITHUB_TOKEN) {
+            throw new Error(errorsConfig_1.default[errorsConfig_1.ErrorMessage.No_GitHub_Token]);
+        }
+        if (!process.env.OPENAI_API_KEY) {
+            throw new Error(errorsConfig_1.default[errorsConfig_1.ErrorMessage.No_OpenAi_Token]);
+        }
+        if (!github_1.context.payload.pull_request) {
+            throw new Error(errorsConfig_1.default[errorsConfig_1.ErrorMessage.No_PullRequest_In_Context]);
+        }
+        this._octokitApi = (0, github_1.getOctokit)(process.env.GITHUB_TOKEN);
+        this._openAiApi = new openai_1.OpenAIApi(new openai_1.Configuration({ apiKey: process.env.OPENAI_API_KEY }));
+        this._pullRequest = {
+            owner: github_1.context.repo.owner,
+            repo: github_1.context.repo.repo,
+            pullHead: (_b = (_a = github_1.context.payload) === null || _a === void 0 ? void 0 : _a.pull_request) === null || _b === void 0 ? void 0 : _b.head.ref,
+            pullBase: (_d = (_c = github_1.context.payload) === null || _c === void 0 ? void 0 : _c.pull_request) === null || _d === void 0 ? void 0 : _d.base.ref,
+            pullNumber: (_f = (_e = github_1.context.payload) === null || _e === void 0 ? void 0 : _e.pull_request) === null || _f === void 0 ? void 0 : _f.number,
+        };
+    }
+    getBranchDiff() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { owner, repo, pullBase, pullHead } = this._pullRequest;
+            const { data: branchDiff } = yield this._octokitApi.rest.repos.compareCommits({
+                owner,
+                repo,
+                base: pullBase,
+                head: pullHead,
+            });
+            return branchDiff;
+        });
+    }
+    getCommitsList() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { owner, repo, pullNumber } = this._pullRequest;
+            const { data: commitsList } = yield this._octokitApi.rest.pulls.listCommits({
+                owner,
+                repo,
+                per_page: 50,
+                pull_number: pullNumber,
+            });
+            return commitsList;
+        });
+    }
+    getOpenAiSuggestions(patch) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!patch) {
+                throw new Error(errorsConfig_1.default[errorsConfig_1.ErrorMessage.No_Patch_For_OpenAi_Suggestion]);
+            }
+            const prompt = `
+      ${promptsConfig_1.default[promptsConfig_1.Prompt.Check_Patch]}\n
+      Patch:\n\n"${patch}"
+    `;
+            const openAIResult = yield this._openAiApi.createChatCompletion({
+                model: 'gpt-3.5-turbo',
+                messages: [{ role: 'user', content: prompt }],
+            });
+            const responseText = ((_b = (_a = openAIResult.data.choices.shift()) === null || _a === void 0 ? void 0 : _a.message) === null || _b === void 0 ? void 0 : _b.content) || '';
+            return responseText;
+        });
+    }
+    getFirstChangedLineFromThePatch(patch) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!patch) {
+                throw new Error(errorsConfig_1.default[errorsConfig_1.ErrorMessage.No_Patch_File]);
+            }
+            const lineHeaderRegExp = /^@@ -\d+,\d+ \+(\d+),(\d+) @@/;
+            const lines = patch.split('\n');
+            const lineHeaderMatch = lines[0].match(lineHeaderRegExp);
+            let lineNumber = 1;
+            if (lineHeaderMatch) {
+                lineNumber = parseInt(lineHeaderMatch[1], 10);
+            }
+            return lineNumber;
+        });
+    }
+    addCommentToPr() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { files } = yield this.getBranchDiff();
+            if (!files) {
+                throw new Error(errorsConfig_1.default[errorsConfig_1.ErrorMessage.No_Changed_Files_In_PullRequest]);
+            }
+            for (const file of files) {
+                const isFileStatusMatch = ['added', 'modified', 'renamed', 'changed'].includes(file.status);
+                if (!isFileStatusMatch) {
+                    throw new Error(`${errorsConfig_1.default[errorsConfig_1.ErrorMessage.Not_Match_Status_Of_Changed_File]} ${file.status}`);
+                }
+                const openAiSuggestions = yield this.getOpenAiSuggestions(file.patch);
+                const commitsList = yield this.getCommitsList();
+                const { owner, repo, pullNumber } = this._pullRequest;
+                const firstChangedLineFromThePatch = yield this.getFirstChangedLineFromThePatch(file.patch);
+                yield this._octokitApi.rest.pulls.createReviewComment({
+                    owner,
+                    repo,
+                    pull_number: pullNumber,
+                    line: firstChangedLineFromThePatch,
+                    path: file.filename,
+                    body: `[ChatGPTReviewer]\n${openAiSuggestions}`,
+                    commit_id: commitsList[commitsList.length - 1].sha,
+                });
+            }
+        });
+    }
+}
+exports.default = CommentOnPullRequestService;
diff --git a/dist/sourcemap-register.js b/dist/sourcemap-register.js