ProposalPolice™ GH Actions Workflow

.github/scripts/proposal-police/issue-comment-edit.js

@@ -0,0 +1,116 @@
+// Import GitHub toolkit and Octokit REST client
+const { context, getOctokit } = require('@actions/github');
+const InitOpenAI = require('openai');
+const _ = require('underscore');
+
+const OpenAI = new InitOpenAI({apiKey: process.env.OPENAI_API_KEY});
+
+/**
+ * Handles the case when somebody edits a comment on an issue to check whether it's a proposal and what kind of changes were made.
+ * @param {*} octokit - GitHub REST client
+ * @param {*} labelNames - String array of label names to check for, ex. ['Help Wanted', "External"]
+ * @returns {Promise<false | undefined>}
+ */
+async function handleIssueCommentEdited(octokit, labelNames) {
+    const payload = context.payload;
+    const OPENAI_ASSISTANT_ID = process.env.OPENAI_ASSISTANT_ID;
+
+    // check if the issue is opened and the has all passed labels
+    if (
+        payload.issue.state === 'open' &&
+        _.every(labelNames, labelName => _.some(payload.issue.labels, issueLabel => issueLabel.name === labelName))
+    ) {
+        if (!OPENAI_ASSISTANT_ID) {
+            console.log('OPENAI_ASSISTANT_ID missing from the environment variables');
+            return;
+        }
+
+        // You need to adapt this part to fit the Edit Use Case as in the original function
+        const content = `I NEED HELP WITH CASE (2.) WHEN A USER THAT POSTED AN INITIAL PROPOSAL OR COMMENT (UNEDITED) THEN EDITS THE COMMENT - WE NEED TO CLASSIFY THE COMMENT BASED IN THE GIVEN INSTRUCTIONS AND IF TEMPLATE IS FOLLOWED AS PER INSTRUCTIONS. IT IS MANDATORY THAT YOU RESPOND ONLY WITH "NO_ACTION" IN CASE THE COMMENT IS NOT A PROPOSAL. \n\nPrevious comment content: ${payload.changes.body.from}.\n\nEdited comment content: ${payload.comment.body}`;
+
+        // create thread with first user message and run it
+        const createAndRunResponse = await OpenAI.beta.threads.createAndRun({
+            assistant_id: OPENAI_ASSISTANT_ID || '',
+            thread: {messages: [{ role: "user", content }],},
+        });
+
+        // count calls for debug purposes
+        let count = 0;
+        // poll for run completion
+        const intervalID = setInterval(() => {
+            OpenAI.beta.threads.runs.retrieve(createAndRunResponse.thread_id, createAndRunResponse.id).then(threadRun => {
+                // return if run is not completed yet
+                if (threadRun.status !== "completed") {
+                    console.log('issue_comment.edited - run pending completion');
+                    return;
+                }
+
+                // get assistant response
+                OpenAI.beta.threads.messages.list(createAndRunResponse.thread_id).then(threadMessages => {
+                    // list thread messages content
+                    threadMessages.data.forEach((message, index) => {
+                        // @ts-ignore - we do have text value in content[0] but typescript doesn't know that
+                        // this is a 'openai' package type issue
+                        const assistantResponse = message.content[index].text.value;
+                        console.log('issue_comment.edited - assistantResponse', assistantResponse);
+
+                        if (!assistantResponse) {
+                            return console.log('issue_comment.edited - assistantResponse is empty');
+                        }
+
+                        // check if assistant response is either NO_ACTION or "NO_ACTION" strings
+                        // as sometimes the assistant response varies
+                        const isNoAction = assistantResponse === 'NO_ACTION' || assistantResponse === '"NO_ACTION"';
+                        // if assistant response is NO_ACTION or message role is 'user', do nothing
+                        if (isNoAction || threadMessages.data[index].role === 'user') {
+                            if (threadMessages.data[index].role === 'user')  {
+                                return;
+                            }
+                            return console.log('issue_comment.edited - NO_ACTION');
+                        }
+
+                        // edit comment if assistant detected substantial changes and if the comment was not edited already by the bot
+                        if (assistantResponse.includes('[EDIT_COMMENT]') && !payload.comment.body.includes('Edited by **proposal-police**')) {
+                            // extract the text after [EDIT_COMMENT] from assistantResponse since this is a
+                            // bot related action keyword
+                            let extractedNotice = assistantResponse.split('[EDIT_COMMENT] ')[1].replace('"', '');
+                            // format the github's updated_at like: 2024-01-24 13:15:24 UTC not 2024-01-28 18:18:28.000 UTC
+                            const date = new Date(payload.comment.updated_at);
+                            const formattedDate = `${date.toISOString().split('.')[0].replace('T', ' ')  } UTC`;
+                            extractedNotice = extractedNotice.replace('{updated_timestamp}', formattedDate);
+
+                            console.log(`issue_comment.edited - proposal-police edits comment: ${payload.comment.id}`);
+                            return octokit.issues.updateComment({
+                                ...context.repo,
+                                comment_id: payload.comment.id,
+                                body: `${extractedNotice}\n\n${  payload.comment.body}`,
+                            });
+                        }
+
+                        return false;
+                    });
+                }).catch(err => console.log('threads.messages.list - err', err));
+
+                // stop polling
+                clearInterval(intervalID);
+            }).catch(err => console.log('threads.runs.retrieve - err', err));
+
+            // increment count for every threads.runs.retrieve call
+            count++;
+            console.log('threads.runs.retrieve - called:', count);
+        }, 1500);
+    }
+
+    // return so that the script doesn't hang
+    return false;
+}
+
+async function run() {
+    const octokit = getOctokit(process.env.GITHUB_TOKEN);
+    await handleIssueCommentEdited(octokit, ['Help Wanted']);
+}
+
+run().catch(error => {
+    console.error(error);
+    process.exit(1);
+});

.github/scripts/proposal-police/issue-comment.js

@@ -0,0 +1,120 @@
+// Import GitHub toolkit and Octokit REST client
+const { context, getOctokit } = require('@actions/github');
+const InitOpenAI = require('openai');
+const _ = require('underscore');
+
+const OpenAI = new InitOpenAI({apiKey: process.env.OPENAI_API_KEY});
+
+/**
+ * Handles the case when somebody edits a comment on an issue to check whether it's a proposal and what kind of changes were made.
+ * @param {*} octokit - GitHub REST client
+ * @param {*} labelNames - String array of label names to check for, ex. ['Help Wanted', "External"]
+ * @returns {Promise<false | undefined>}
+ */
+async function handleIssueCommentCreated(octokit, labelNames) {
+    const payload = context.payload;
+    const OPENAI_ASSISTANT_ID = process.env.OPENAI_ASSISTANT_ID;
+
+    // check if the issue is opened and the has all passed labels
+    if (
+        payload.issue.state === 'open' &&
+        _.every(labelNames, labelName => _.some(payload.issue.labels, issueLabel => issueLabel.name === labelName))
+    ) {
+        if (!OPENAI_ASSISTANT_ID) {
+            console.log('OPENAI_ASSISTANT_ID missing from the environment variables');
+            return;
+        }
+
+        // 1, check if comment is proposal and if proposal template is followed
+        const content = `I NEED HELP WITH CASE (1.), CHECK IF COMMENT IS PROPOSAL AND IF TEMPLATE IS FOLLOWED AS PER INSTRUCTIONS. IT IS MANDATORY THAT YOU RESPOND ONLY WITH "NO_ACTION" IN CASE THE COMMENT IS NOT A PROPOSAL. Comment content: ${payload.comment.body}`;
+
+        // create thread with first user message and run it
+        const createAndRunResponse = await OpenAI.beta.threads.createAndRun({
+            assistant_id: OPENAI_ASSISTANT_ID || '',
+            thread: {messages: [{ role: "user", content }],},
+        });
+
+        // count calls for debug purposes
+        let count = 0;
+        // poll for run completion
+        const intervalID = setInterval(() => {
+            OpenAI.beta.threads.runs.retrieve(createAndRunResponse.thread_id, createAndRunResponse.id).then(threadRun => {
+                // return if run is not completed
+                if (threadRun.status !== "completed") {
+                    return;
+                }
+
+                // get assistant response
+                OpenAI.beta.threads.messages.list(createAndRunResponse.thread_id).then(threadMessages => {
+                    // list thread messages content
+                    threadMessages.data.forEach((message, index) => {
+                        // @ts-ignore - we do have text value in content[0] but typescript doesn't know that
+                        // this is a 'openai' package type issue
+                        let assistantResponse = message.content[index].text.value;
+                        console.log('issue_comment.created - assistantResponse', assistantResponse);
+
+                        if (!assistantResponse) {
+                            return console.log('issue_comment.created - assistantResponse is empty');
+                        }
+
+                        // check if assistant response is either NO_ACTION or "NO_ACTION" strings
+                        // as sometimes the assistant response varies
+                        const isNoAction = assistantResponse === 'NO_ACTION' || assistantResponse === '"NO_ACTION"';
+                        // if assistant response is NO_ACTION or message role is 'user', do nothing
+                        if (isNoAction || threadMessages.data[index].role === 'user') {
+                            if (threadMessages.data[index].role === 'user')  {
+                                return;
+                            }
+                            return console.log('issue_comment.created - NO_ACTION');
+                        }
+
+                        // if the assistant responded with no action but there's some context in the response
+                        if (assistantResponse.includes('[NO_ACTION]')) {
+                            // extract the text after [NO_ACTION] from assistantResponse since this is a
+                            // bot related action keyword
+                            const noActionContext = assistantResponse.split('[NO_ACTION] ')[1].replace('"', '');
+                            console.log('issue_comment.created - [NO_ACTION] w/ context: ', noActionContext);
+                            return;
+                        }
+                        // replace {user} from response template with @username
+                        assistantResponse = assistantResponse.replace('{user}', `@${payload.comment.user.login}`);
+                        // replace {proposalLink} from response template with the link to the comment
+                        assistantResponse = assistantResponse.replace('{proposalLink}', payload.comment.html_url);
+
+                        // remove any double quotes from the final comment because sometimes the assistant's
+                        // response contains double quotes / sometimes it doesn't
+                        assistantResponse = assistantResponse.replace('"', '');
+                        // create a comment with the assistant's response
+                        console.log('issue_comment.created - proposal-police posts comment');
+                        return octokit.issues.createComment({
+                            ...context.repo,
+                            issue_number: payload.issue.number,
+                            body: assistantResponse
+                        });
+                    });
+                }).catch(err => console.log('threads.messages.list - err', err));
+
+                // stop polling
+                clearInterval(intervalID);
+            }).catch(err => console.log('threads.runs.retrieve - err', err));
+
+            // increment count for every threads.runs.retrieve call
+            count++;
+            console.log('threads.runs.retrieve - called:', count);
+        }, 1500);
+    }
+
+    // return so that the script doesn't hang
+    return false;
+}
+
+// Main function to process the workflow event
+async function run() {
+    const octokit = getOctokit(process.env.GITHUB_TOKEN);
+    await handleIssueCommentCreated(octokit, ['Help Wanted']);
+}
+
+run().catch(error => {
+    console.error(error);
+    process.exit(1);
+});

.github/scripts/proposal-police/package.json

@@ -0,0 +1,10 @@
+{
+    "name": "github-action",
+    "version": "1.0.0",
+    "dependencies": {
+        "@actions/core": "^1.2.6",
+        "@actions/github": "^4.0.0",
+        "@octokit/rest": "^18.0.0",
+        "openai": "^4.24.7"
+    }
+}

.github/workflows/proposalPolice.yml

@@ -0,0 +1,41 @@
+name: ProposalPolice™ - Issue Comment Workflow
+on:
+  issue_comment:
+    types: [created, edited]
+
+jobs:
+  process-issue-comment:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: "16"
+
+      - name: Install dependencies
+        run: npm install
+        working-directory: .github/scripts/proposal-police
+
+      # Checks if the comment is created and follows the template
+      - name: Run issue new comment script
+        if: github.event.action == 'created'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+          OPENAI_ASSISTANT_ID: ${{ secrets.OPENAI_ASSISTANT_ID }}
+          ISSUE: ${{ toJson(github.event.issue) }}
+          COMMENT: ${{ toJson(github.event.comment) }}
+        run: node .github/scripts/proposal-police/issue-comment.js
+
+      # Checks if the comment is edited and if proposal template is followed
+      - name: Run issue comment edited script
+        if: github.event.action == 'edited'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+          OPENAI_ASSISTANT_ID: ${{ secrets.OPENAI_ASSISTANT_ID }}
+          ISSUE: ${{ toJson(github.event.issue) }}
+          COMMENT: ${{ toJson(github.event.comment) }}
+        run: node .github/scripts/proposal-police/issue-comment-edit.js