Chore/testing

package.json

@@ -36,7 +36,7 @@
     "@octokit/rest": "20.1.1",
     "@octokit/webhooks": "13.2.7",
     "@sinclair/typebox": "0.32.31",
-    "@ubiquity-dao/ubiquibot-logger": "^1.3.0",
+    "@ubiquity-dao/ubiquibot-logger": "^1.3.1",
     "dotenv": "16.4.5",
     "luxon": "3.4.4",
     "ms": "2.1.3",
@@ -89,4 +89,4 @@
     ]
   },
   "packageManager": "[email protected]"
-}
+}

src/helpers/get-assignee-activity.ts

@@ -27,12 +27,6 @@ export async function getAssigneesActivityForIssue(context: Context, issue: List
         issueEvents.push(...events);
     }
 
-    return issueEvents
-        .reduce((acc, event) => {
-            if (event.actor && event.actor.id) {
-                if (assigneeIds.includes(event.actor.id)) acc.push(event);
-            }
-            return acc;
-        }, [] as GitHubListEvents[])
+    return issueEvents.filter((o) => o.actor && o.actor.id && assigneeIds.includes(o.actor.id))
         .sort((a, b) => DateTime.fromISO(b.created_at).toMillis() - DateTime.fromISO(a.created_at).toMillis());
 }

src/helpers/remind-and-remove.ts

@@ -1,6 +1,7 @@
 import { Context } from "../types/context";
 import { parseIssueUrl } from "./github-url";
 import { ListIssueForRepo } from "../types/github-types";
+import { createStructuredMetadata } from "./structured-metadata";
 
 export async function unassignUserFromIssue(context: Context, issue: ListIssueForRepo) {
     const { logger, config } = context;
@@ -36,11 +37,17 @@ async function remindAssignees(context: Context, issue: ListIssueForRepo) {
         .filter((o) => !!o)
         .join(", @");
 
+    const logMessage = logger.info(`@${logins}, this task has been idle for a while. Please provide an update.\n\n`, {
+        taskAssignees: issue.assignees.map((o) => o?.id),
+    });
+
+    const metadata = createStructuredMetadata("Followup", logMessage);
+
     await octokit.rest.issues.createComment({
         owner,
         repo,
         issue_number,
-        body: `@${logins}, this task has been idle for a while. Please provide an update.`,
+        body: [logMessage.logMessage.raw, metadata].join("\n"),
     });
     return true;
 }

src/helpers/structured-metadata.ts

@@ -0,0 +1,28 @@
+import { LogReturn } from "@ubiquity-dao/ubiquibot-logger";
+
+export function createStructuredMetadata(className: string, logReturn: LogReturn | null) {
+    let logMessage, metadata;
+    if (logReturn) {
+        logMessage = logReturn.logMessage;
+        metadata = logReturn.metadata;
+    }
+
+    const jsonPretty = JSON.stringify(metadata, null, 2);
+    const stackLine = new Error().stack?.split("\n")[2] ?? "";
+    const caller = stackLine.match(/at (\S+)/)?.[1] ?? "";
+    const ubiquityMetadataHeader = `<!-- Ubiquity - ${className} - ${caller} - ${metadata?.revision}`;
+
+    let metadataSerialized: string;
+    const metadataSerializedVisible = ["```json", jsonPretty, "```"].join("\n");
+    const metadataSerializedHidden = [ubiquityMetadataHeader, jsonPretty, "-->"].join("\n");
+
+    if (logMessage?.type === "fatal") {
+        // if the log message is fatal, then we want to show the metadata
+        metadataSerialized = [metadataSerializedVisible, metadataSerializedHidden].join("\n");
+    } else {
+        // otherwise we want to hide it
+        metadataSerialized = metadataSerializedHidden;
+    }
+
+    return metadataSerialized;
+}

src/helpers/task-deadline.ts

@@ -3,7 +3,7 @@ import { Context } from "../types/context";
 import { ListIssueForRepo } from "../types/github-types";
 import { getAssigneesActivityForIssue } from "./get-assignee-activity";
 
-export async function handleDeadline(
+export async function getDeadlineWithThreshold(
     context: Context,
     metadata: {
         taskDeadline: string;

src/helpers/task-metadata.ts

@@ -3,7 +3,7 @@ import { Context } from "../types/context";
 import { ListCommentsForIssue, ListForOrg, ListIssueForRepo } from "../types/github-types";
 import ms from "ms";
 
-export async function handleCommentsAndMetadata(
+export async function getTaskMetadata(
     context: Context,
     repo: ListForOrg["data"][0],
     issue: ListIssueForRepo
@@ -27,7 +27,7 @@ export async function handleCommentsAndMetadata(
         DateTime.fromISO(a.created_at).toMillis() - DateTime.fromISO(b.created_at).toMillis()
     )
 
-    const botFollowup = /this task has been idle for a while. Please provide an update./gi;
+    const botFollowup = /<!-- Ubiquity - Followup - remindAssignees/gi;
     const botFollowupComments = botComments.filter((o) => botFollowup.test(o?.body || ""));
 
     if (!botAssignmentComments.length && !botFollowupComments.length) {

src/helpers/task-update.ts

@@ -2,21 +2,21 @@ import { DateTime } from "luxon";
 import { Context } from "../types/context";
 import { ListForOrg, ListIssueForRepo } from "../types/github-types";
 import { remindAssigneesForIssue, unassignUserFromIssue } from "./remind-and-remove";
-import { handleDeadline } from "./task-deadline";
-import { handleCommentsAndMetadata } from "./task-metadata";
+import { getDeadlineWithThreshold } from "./task-deadline";
+import { getTaskMetadata } from "./task-metadata";
 
 export async function updateTaskReminder(context: Context, repo: ListForOrg["data"][0], issue: ListIssueForRepo) {
   const { logger } = context;
 
   let metadata, lastCheck, deadlineWithThreshold, reminderWithThreshold, now;
 
-  const handledMetadata = await handleCommentsAndMetadata(context, repo, issue);
+  const handledMetadata = await getTaskMetadata(context, repo, issue);
 
   if (handledMetadata) {
     metadata = handledMetadata.metadata;
     lastCheck = handledMetadata.lastCheck;
 
-    const handledDeadline = await handleDeadline(context, metadata, issue, lastCheck);
+    const handledDeadline = await getDeadlineWithThreshold(context, metadata, issue, lastCheck);
     if (handledDeadline) {
       deadlineWithThreshold = handledDeadline.deadlineWithThreshold;
       reminderWithThreshold = handledDeadline.reminderWithThreshold;

tests/main.test.ts

@@ -13,6 +13,7 @@ import mockUsers from "./__mocks__/mock-users";
 import { botAssignmentComment, getIssueHtmlUrl, getIssueUrl, noAssignmentCommentFor, STRINGS, updatingRemindersFor } from "./__mocks__/strings";
 import { createComment, createIssue, createRepo, ONE_DAY } from "./__mocks__/helpers";
 import { collectLinkedPullRequests } from "../src/handlers/collect-linked-pulls";
+import { createStructuredMetadata } from "../src/helpers/structured-metadata";
 
 dotenv.config();
 const octokit = jest.requireActual("@octokit/rest");
@@ -119,7 +120,9 @@ describe("User start/stop", () => {
     expect(updatedIssue?.assignees).toEqual([{ login: STRINGS.USER, id: 2 }]);
 
     const comments = db.issueComments.getAll();
-    expect(comments[comments.length - 1].body).toEqual(JSON.stringify({ body: `@${STRINGS.USER}, this task has been idle for a while. Please provide an update.` }));
+    const latestComment = comments[comments.length - 1];
+    const partialComment = "@user2, this task has been idle for a while. Please provide an update.\\n\\n\\n<!-- Ubiquity - Followup -"
+    expect(latestComment.body).toContain(partialComment);
   });
 
   it("Should have nothing do within the warning period", async () => {

yarn.lock

@@ -1810,10 +1810,10 @@
   dependencies:
     "@types/yargs-parser" "*"
 
-"@ubiquity-dao/ubiquibot-logger@^1.3.0":
-  version "1.3.0"
-  resolved "https://registry.yarnpkg.com/@ubiquity-dao/ubiquibot-logger/-/ubiquibot-logger-1.3.0.tgz#b07364658be95b3be3876305c66b2adc906e9590"
-  integrity sha512-ifkd7fB2OMTSt3OL9L14bCIvCMXV+IHFdJYU5S8FUzE2U88b4xKxuEAYDFX+DX3wwDEswFAVUwx5aP3QcMIRWA==
+"@ubiquity-dao/ubiquibot-logger@^1.3.1":
+  version "1.3.1"
+  resolved "https://registry.yarnpkg.com/@ubiquity-dao/ubiquibot-logger/-/ubiquibot-logger-1.3.1.tgz#c3f45d70014dcc2551442c28101046e1c8ea6886"
+  integrity sha512-kDLnVP87Y3yZV6NnqIEDAOz+92IW0nIcccML2lUn93uZ5ada78vfdTPtwPJo8tkXl1Z9qMKAqqHkwBMp1Ksnag==
 
 JSONStream@^1.3.5:
   version "1.3.5"