feat(gcf-utils): change the method signature of addOrUpdateIssueComme…

…nt (#1131)

fixes #1130 

Now it only requires Octokit, instead of Context.
The intention is to allow us to use this function from the cron hander.

packages/gcf-utils/src/gcf-utils.ts

@@ -15,10 +15,10 @@
 import {
   createProbot,
   Probot,
+  ProbotOctokit,
   ApplicationFunction,
   Options,
   Application,
-  Context,
 } from 'probot';
 
 import getStream from 'get-stream';
@@ -38,6 +38,8 @@ import {v4} from 'uuid';
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const LoggingOctokitPlugin = require('../src/logging/logging-octokit-plugin.js');
 
+type ProbotOctokitType = InstanceType<typeof ProbotOctokit>;
+
 interface Repos {
   repos: [
     {
@@ -96,15 +98,15 @@ export enum TriggerType {
 }
 
 export const addOrUpdateIssueComment = async (
-  context: Context,
+  github: ProbotOctokitType,
   owner: string,
   repo: string,
   issueNumber: number,
+  installationId: number,
   commentBody: string
 ) => {
-  const installationId = context.payload.installation.id;
   const commentMark = `<!-- probot comment [${installationId}]-->`;
-  const listCommentsResponse = await context.github.issues.listComments({
+  const listCommentsResponse = await github.issues.listComments({
     owner: owner,
     repo: repo,
     per_page: 50, // I think 50 is enough, but I may be wrong.
@@ -114,7 +116,7 @@ export const addOrUpdateIssueComment = async (
   for (const comment of listCommentsResponse.data) {
     if (comment.body.includes(commentMark)) {
       // We found the existing comment, so updating it
-      await context.github.issues.updateComment({
+      await github.issues.updateComment({
         owner: owner,
         repo: repo,
         comment_id: comment.id,
@@ -124,7 +126,7 @@ export const addOrUpdateIssueComment = async (
     }
   }
   if (!found) {
-    await context.github.issues.createComment({
+    await github.issues.createComment({
       owner: owner,
       repo: repo,
       issue_number: issueNumber,

packages/gcf-utils/test/gcf-utils.ts

@@ -30,10 +30,11 @@ const fixturesPath = resolve(__dirname, '../../test/fixtures');
 const app = (app: Application) => {
   app.on('issues.opened', async context => {
     await addOrUpdateIssueComment(
-      context,
+      context.github,
       context.payload.repository.owner.login,
       context.payload.repository.name,
       context.payload.issue.number,
+      context.payload.installation.id,
       'test comment'
     );
   });