Merge pull request #637 from keymanapp/maint/upgrade-probot

maint: upgrade probot to 14.x

Author: mcdurdin

server/code.ts

@@ -29,6 +29,7 @@ import { consoleLog } from './util/console-log.js';
 import { buildVersion } from '../shared/version.js';
 import { processGithubWebhookEvent } from './webhooks/github-webhook.js';
 import { triggerGitHookRedeliveryWorkflow } from './webhooks/github-webhook-redelivery.js';
+import { inspect } from 'node:util';
 
 sms.install();
 
@@ -225,7 +226,7 @@ wsServer.on('connection', socket => {
 });
 
 export function reportError(error) {
-  console.error(error);
+  console.error(inspect(error));
   Sentry.captureMessage(error);
 }
 
@@ -364,7 +365,7 @@ app.post('/webhook/discourse', (request, response) => {
   response.send('ok');
 });
 
-app.use('/webhook/keymanapp-test-bot', keymanAppTestBotMiddleware);
+app.use('/webhook/keymanapp-test-bot', (request, response) => { keymanAppTestBotMiddleware(request, response); } );
 
 export function sendWsAlert(hasChanged: boolean, message: string): boolean {
   if(hasChanged) {
@@ -459,7 +460,7 @@ app.get('/status/github-contributions', async (request, response) => {
       try {
         contributions = await githubContributionsService.get(sprintStartDateTime.toISOString());
       } catch(e) {
-        console.debug(e);
+        console.error(inspect(e));
         Sentry.addBreadcrumb({
           category: "Request",
           message: JSON.stringify(request.query)

server/keymanapp-test-bot/artifact-links-comment.ts

@@ -4,6 +4,7 @@ import teamcityService from "../services/teamcity/teamcity.js";
 import { statusData } from '../data/status-data.js';
 import { artifactLinks } from '../../shared/artifact-links.js';
 import { getTeamcityUrlParams } from "../../shared/getTeamcityUrlParams.js";
+import { inspect } from "node:util";
 
 type BuildDataCacheItem = {context:string, target_url:string, state:string};
 type BuildDataCache = {[index:string]: BuildDataCacheItem};
@@ -22,7 +23,8 @@ export async function getArtifactLinksComment(
   try {
     statuses = await octokit.rest.repos.getCombinedStatusForRef({...data, ref: pull.data.head.ref});
   } catch(e) {
-    console.error(`[@keymanapp-test-bot] ${e}`);
+    console.error(`[@keymanapp-test-bot] getArtifactLinksComment: ${e}`);
+    console.error(inspect(e));
     return '';
   }
   //const statuses = await octokit.rest.repos.getCombinedStatusForRef({owner:'keymanapp',repo:'keyman',ref:'fix/web/5950-clear-timeout-on-longpress-flick'/*pull.data.head.ref*/});
@@ -63,20 +65,21 @@ export async function getArtifactLinksComment(
     // artifactLinks
     let u;
     if(!s[context].target_url) {
-      console.warn(`[@keymanapp-test-bot] skipping ${s[context].context}`);
+      console.warn(`[@keymanapp-test-bot] getArtifactLinksComment: skipping ${s[context].context}`);
       continue;
     }
     try {
       u = new URL(s[context].target_url);
     } catch(e) {
-      console.error(`[@keymanapp-test-bot] ${e}`);
+      console.error(`[@keymanapp-test-bot] getArtifactLinksComment(2): ${e}`);
+      console.error(inspect(e));
       continue;
     }
     if (context == 'Debian Packaging') {
       // https://github.com/keymanapp/keyman/actions/runs/4294449810
       const matches = s[context].target_url.match(/.+\/runs\/(\d+)/);
       if (!matches) {
-        console.error(`[@keymanapp-test-bot] Can't find workflow run in url ${s[context].target_url}`);
+        console.error(`[@keymanapp-test-bot] getArtifactLinksComment: Can't find workflow run in url ${s[context].target_url}`);
         return '';
       }
       const run_id = matches[1];
@@ -90,7 +93,7 @@ export async function getArtifactLinksComment(
           // "keyman-binarypkgs-focal_amd64"
           const distroMatches = artifact.name.match(/keyman-binarypkgs-(.+)_amd64/);
           if (!distroMatches) {
-            console.error(`[@keymanapp-test-bot] Can't find distribution in artifact name ${artifact.name}`);
+            console.error(`[@keymanapp-test-bot] getArtifactLinksComment: Can't find distribution in artifact name ${artifact.name}`);
             return '';
           }
           if (!links['Linux']) links['Linux'] = [];
@@ -102,12 +105,13 @@ export async function getArtifactLinksComment(
           });
         }
       } catch (e) {
-        console.error(`[@keymanapp-test-bot] ${e}`);
+        console.error(`[@keymanapp-test-bot] getArtifactLinksComment(3): ${e}`);
+        console.error(inspect(e));
         return '';
       }
     } else if(u.searchParams.has('buildTypeId') || u.pathname.match(/\/buildConfiguration\//)) {
       const { buildTypeId, buildId } = getTeamcityUrlParams(u);
-      console.log(`[@keymanapp-test-bot] Finding TeamCity build data for build ${buildTypeId}:${buildId}`)
+      console.log(`[@keymanapp-test-bot] getArtifactLinksComment: Finding TeamCity build data for build ${buildTypeId}:${buildId}`)
 
       version_with_tag = null;
       version = null;
@@ -116,7 +120,7 @@ export async function getArtifactLinksComment(
       if(buildData) version_with_tag = findBuildVersion(buildData);
       if(version_with_tag) version = /^(\d+\.\d+\.\d+)/.exec(version_with_tag)?.[1];
       if(!version) {
-        console.error(`[@keymanapp-test-bot] Failed to find version information for artifact links for ${buildTypeId}:${buildId}; buildData: ${JSON.stringify(buildData)}`);
+        console.error(`[@keymanapp-test-bot] getArtifactLinksComment: Failed to find version information for artifact links for ${buildTypeId}:${buildId}; buildData: ${JSON.stringify(buildData)}`);
         if(!teamCityDataFromCache) {
           continue;
         }
@@ -130,12 +134,12 @@ export async function getArtifactLinksComment(
         if(buildData) version_with_tag = findBuildVersion(buildData);
         if(version_with_tag) version = /^(\d+\.\d+\.\d+)/.exec(version_with_tag)?.[1];
         if(!version) {
-          console.error(`[@keymanapp-test-bot] After reload, failed to find version information for artifact links for ${buildTypeId}:${buildId}; buildData: ${JSON.stringify(buildData)}`);
+          console.error(`[@keymanapp-test-bot] getArtifactLinksComment: After reload, failed to find version information for artifact links for ${buildTypeId}:${buildId}; buildData: ${JSON.stringify(buildData)}`);
           continue;
         }
       }
 
-      console.log(`[@keymanapp-test-bot] Found version data for ${buildTypeId}:${buildId}:${version_with_tag}`)
+      console.log(`[@keymanapp-test-bot] getArtifactLinksComment: Found version data for ${buildTypeId}:${buildId}:${version_with_tag}`)
 
       const buildLevel = buildData?.properties?.property?.find(prop => prop.name == 'env.KEYMAN_BUILD_LEVEL')?.value;
       let t = artifactLinks.teamCityTargets[buildTypeId];

server/keymanapp-test-bot/issue-milestone.ts

@@ -1,5 +1,5 @@
 import { ProbotOctokit } from "probot";
-import { Issue } from "@octokit/webhooks-types";
+import { components } from "@octokit/openapi-webhooks-types";
 
 import { ProcessEventData } from "./keymanapp-test-bot.js";
 import { getCurrentSprint } from "../current-sprint.js";
@@ -13,7 +13,7 @@ import { consoleError, consoleLog } from "../util/console-log.js";
 export async function updateIssueMilestoneWhenIssueClosed(
   octokit: InstanceType<typeof ProbotOctokit>,
   data: ProcessEventData,
-  issue: Issue
+  issue: components["schemas"]["webhook-issues-closed"]["issue"]
 ): Promise<void> {
   consoleLog('pr-bot', null, `Updating issue #${issue.number} milestone`);
   const currentSprint = getCurrentSprint(statusData.cache.sprints?.current?.github?.data);

server/keymanapp-test-bot/keymanapp-test-bot-middleware.ts

@@ -7,7 +7,7 @@
 import { env } from "node:process";
 import * as fs from 'node:fs';
 
-import { createNodeMiddleware, Probot } from 'probot';
+import { createNodeMiddleware, createProbot, Probot } from 'probot';
 import * as keymanappTestBot from './keymanapp-test-bot.js';
 
 import { dirname } from 'node:path';
@@ -35,7 +35,7 @@ let privateKey, secret;
 if(fs.existsSync(privateKeyFilename))
   privateKey = fs.readFileSync(privateKeyFilename, 'utf8');
 else if(env.PROBOT_PRIVATE_KEY)
-  privateKey = Buffer.from(env.PROBOT_PRIVATE_KEY, 'base64');
+  privateKey = Buffer.from(env.PROBOT_PRIVATE_KEY, 'base64').toString('utf-8');
 
 if(fs.existsSync(secretFilename))
   secret = fs.readFileSync(secretFilename, 'utf8').trim();
@@ -48,10 +48,14 @@ const probot = new Probot({
   secret: secret,
 });
 
-const middleware = createNodeMiddleware(keymanappTestBot.default, { probot,
+const middleware = await createNodeMiddleware(keymanappTestBot.default, { probot,
   webhooksPath: "/",
 });
 
 export default (req, res) => {
-  return middleware(req, res);
+  middleware(req, res, () => {
+    res.writeHead(404);
+    res.end();
+  });
 };
+

server/keymanapp-test-bot/keymanapp-test-bot.ts

@@ -4,7 +4,7 @@
  * @keymanapp-test-bot implementation
  */
 
-import { User } from "@octokit/webhooks-types";
+import { components } from "@octokit/openapi-webhooks-types";
 import { Probot, ProbotOctokit } from "probot";
 import { GetResponseTypeFromEndpointMethod, GetResponseDataTypeFromEndpointMethod } from "@octokit/types";
 
@@ -33,7 +33,7 @@ export interface ProcessEventData {
 };
 
 async function processEvent(
-  octokit: InstanceType<typeof ProbotOctokit>,
+  octokit:  ProbotOctokit,
   data: ProcessEventData,
   is_pull_request: boolean
 ) {
@@ -56,12 +56,12 @@ async function processEvent(
 }
 
 async function processUserTest(
-  octokit: InstanceType<typeof ProbotOctokit>,
+  octokit: ProbotOctokit,
   data: ProcessEventData,
   is_pull_request: boolean,
   issue: GetResponseTypeFromEndpointMethod<typeof octokit.rest.issues.get>,
   pull: GetResponseTypeFromEndpointMethod<typeof octokit.rest.pulls.get>,
-  issue_comments: GetResponseDataTypeFromEndpointMethod<typeof octokit.rest.issues.listComments>) {
+  issue_comments: GetResponseDataTypeFromEndpointMethod<typeof octokit.rest.issues.listComments>): Promise<any> {
 
   const mtp = new ManualTestParser();
   let protocol = new ManualTestProtocol(data.owner, data.repo, data.issue_number, is_pull_request, issue.data.id, pull?.data?.id);
@@ -147,9 +147,9 @@ async function processUserTest(
 
   // If this is a pull request, add a status check
   if(is_pull_request) {
-    let pr = await octokit.pulls.get({...data, pull_number: data.issue_number});
+    let pr = await octokit.rest.pulls.get({...data, pull_number: data.issue_number});
 
-    let statusCounts = {}, totalTests = 0;
+    let statusCounts: any = {}, totalTests = 0;
     statusCounts[ManualTestStatus.Open] = 0;
     statusCounts[ManualTestStatus.Passed] = 0;
     statusCounts[ManualTestStatus.Failed] = 0;
@@ -177,7 +177,7 @@ async function processUserTest(
       statusCounts[ManualTestStatus.Failed] + statusCounts[ManualTestStatus.Blocked] == 0 ? 'pending' :  // no errors, but testing unfinished
       'failure'; // at least one error
 
-    await octokit.repos.createCommitStatus({...data,
+    await octokit.rest.repos.createCommitStatus({...data,
       name: '@keymanapp-test-bot User Test Coverage',
       sha: pr.data.head.sha,
       state: state,
@@ -190,7 +190,7 @@ async function processUserTest(
   log('processEvent: EXIT');
 }
 
-function shouldProcessEvent(sender: User, state: "closed"|"open"): boolean {
+function shouldProcessEvent(sender: components["schemas"]["simple-user"], state: "closed"|"open"): boolean {
   if(sender.type != "User")
     return false;
 
@@ -206,7 +206,7 @@ function shouldProcessEvent(sender: User, state: "closed"|"open"): boolean {
 const exports = (app: Probot) => {
   app.on(['pull_request.edited', 'pull_request.opened', 'pull_request.synchronize'], (context) => {
     log('pull_request ENTER: '+context.id+', '+context.payload.pull_request.number);
-    if(!shouldProcessEvent(context.payload.sender, context.payload.pull_request.state)) {
+    if(!shouldProcessEvent(context.payload.sender!, context.payload.pull_request.state)) {
       log('pull_request EXIT: '+context.id+' -- skipping');
       return null;
     }
@@ -225,7 +225,7 @@ const exports = (app: Probot) => {
 
   app.on(['issues.labeled'], (context) => {
     log('issues.labeled ENTER: '+context.id+', '+context.payload.issue.number);
-    if(!shouldProcessEvent(context.payload.sender, context.payload.issue.state)) {
+    if(!shouldProcessEvent(context.payload.sender, context.payload.issue.state!)) {
       log('issues.labeled EXIT: '+context.id+' -- skipping');
       return null;
     }
@@ -244,7 +244,7 @@ const exports = (app: Probot) => {
 
   app.on(['issues.opened', 'issues.edited'], (context) => {
     log('issue ENTER: '+context.id+', '+context.payload.issue.number);
-    if(!shouldProcessEvent(context.payload.sender, context.payload.issue.state)) {
+    if(!shouldProcessEvent(context.payload.sender, context.payload.issue.state!)) {
       log('issue EXIT: '+context.id+' -- skipping');
       return null;
     }

server/keymanapp-test-bot/test-user-test-results-comment.ts

@@ -16,7 +16,7 @@ import ManualTestParser from "../../shared/manual-test/manual-test-parser.js";
 import { ManualTestProtocol } from "../../shared/manual-test/manual-test-protocols.js";
 import { getArtifactLinksComment } from "./artifact-links-comment.js";
 
-const pr = 6849;
+const pr = 16099;
 const is_pull_request = true;
 const data = {owner:'keymanapp', repo:'keyman', issue_number: pr};