Merge pull request #27 from aha-develop/DEVELOP-1137-1-automation-triggers

DEVELOP-1137-1 automation triggers

Author: jemmyw

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aha-develop/github",
   "description": "GitHub",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "author": "Aha! (support@aha.io)",
   "repository": {
     "type": "git",
@@ -91,9 +91,26 @@
       "endpoints": {
         "webhook": {
           "title": "Webhook from Github",
-          "entryPoint": "src/webhooks/webhook.js",
+          "entryPoint": "src/webhooks/webhook.ts",
           "public": true
         }
+      },
+      "automationTriggers": {
+        "draftPrOpened": {
+          "title": "Draft PR opened"
+        },
+        "prOpened": {
+          "title": "PR opened"
+        },
+        "prMerged": {
+          "title": "PR merged"
+        },
+        "prClosed": {
+          "title": "PR closed"
+        },
+        "prReopened": {
+          "title": "PR Re-opened"
+        }
       }
     }
   },

src/lib/fields.js

@@ -81,6 +81,7 @@ function githubPrToPrLink(pr) {
  */
 async function linkPullRequestToRecord(pr, record) {
   await appendField(record, PULL_REQUESTS_FIELD, githubPrToPrLink(pr));
+  await aha.account.setExtensionField(IDENTIFIER, pr.url, record.referenceNum);
 
   if (pr.headRef) {
     await linkBranchToRecord(pr.headRef.name, pr.repository.url, record);
@@ -90,11 +91,14 @@ async function linkPullRequestToRecord(pr, record) {
 /**
  * @param {Github.PrForLink} pr
  */
-async function linkPullRequest(pr) {
-  const record = await referenceToRecord(pr.title);
+async function getOrLinkPullRequestRecord(pr) {
+  let record = await referenceFromPr(pr);
 
-  if (record) {
-    await linkPullRequestToRecord(pr, record);
+  if (!record) {
+    record = await referenceToRecord(pr.title);
+    if (record) {
+      await linkPullRequestToRecord(pr, record);
+    }
   }
 
   return record;
@@ -105,19 +109,32 @@ async function linkPullRequest(pr) {
  * @param {*} number
  */
 async function unlinkPullRequest(record, number) {
-  await replaceField(record, PULL_REQUESTS_FIELD, (prs) => {
-    if (prs) {
-      return prs.filter((pr) => pr.id != number);
-    } else {
-      return [];
-    }
-  });
+  /** @type {null|Github.PrForLink[]} */
+  const prs = await record.getExtensionField(IDENTIFIER, PULL_REQUESTS_FIELD);
+  const pr = prs?.find((pr) => pr.id === number);
+  await record.setExtensionField(
+    IDENTIFIER,
+    PULL_REQUESTS_FIELD,
+    prs?.filter((pr) => pr.id != number) || []
+  );
+
+  if (pr) {
+    await aha.account.clearExtensionField(IDENTIFIER, pr.url);
+  }
 }
 
 /**
  * @param {Aha.ReferenceInterface & Aha.HasExtensionFields} record
  */
 async function unlinkPullRequests(record) {
+  /** @type {null|Github.PrForLink[]} */
+  const prs = await record.getExtensionField(IDENTIFIER, PULL_REQUESTS_FIELD);
+  if (prs) {
+    for (let pr of prs) {
+      await aha.account.clearExtensionField(IDENTIFIER, pr.url);
+    }
+  }
+
   await record.setExtensionField(IDENTIFIER, PULL_REQUESTS_FIELD, []);
 }
 
@@ -158,7 +175,7 @@ async function unlinkBranches(record) {
  * @returns {Promise<(Aha.HasExtensionFields & Aha.ReferenceInterface)|null>}
  */
 export async function referenceToRecord(str) {
-  const ahaReference = extractReference(str);
+  const ahaReference = extractReferenceFromName(str);
   if (!ahaReference) {
     return null;
   }
@@ -177,10 +194,21 @@ export async function referenceToRecord(str) {
   );
 }
 
+/**
+ * @param {Github.PrForLink | PrLink} pr
+ */
+export async function referenceFromPr(pr) {
+  const prLink = githubPrToPrLink(pr);
+  const ref = await aha.account.getExtensionField(IDENTIFIER, prLink.url);
+  if (!ref) return null;
+
+  return referenceToRecord(ref);
+}
+
 /**
  * @param {string} name
  */
-function extractReference(name) {
+function extractReferenceFromName(name) {
   let matches;
 
   // Requirement
@@ -210,7 +238,7 @@ function extractReference(name) {
 
 export {
   appendField,
-  linkPullRequest,
+  getOrLinkPullRequestRecord as linkPullRequest,
   linkPullRequestToRecord,
   unlinkPullRequest,
   unlinkPullRequests,

src/webhooks/webhook.js src/webhooks/webhook.tssrc/webhooks/webhook.js renamed to src/webhooks/webhook.ts

@@ -1,3 +1,4 @@
+import { IDENTIFIER } from "../extension.js";
 import {
   linkPullRequest,
   linkBranch,
@@ -22,6 +23,34 @@ aha.on("webhook", async ({ headers, payload }) => {
   }
 });
 
+async function triggerAutomation(payload, record) {
+  if (!payload?.pull_request) return;
+
+  // Check the record is a supported type
+  if (!["Epic", "Feature", "Requirement"].includes(record.typename)) {
+    return;
+  }
+
+  const triggers: Record<string, (pr: any) => string> = {
+    closed: (pr) => (pr.merged ? "prMerged" : "prClosed"),
+    opened: (pr) => (pr.draft ? "draftPrOpened" : "prOpened"),
+    reopened: () => "prReopened",
+  };
+
+  const trigger = (triggers[payload.action] || (() => null))(
+    payload.pull_request
+  );
+
+  if (trigger) {
+    console.log("Automation trigger");
+    await aha.triggerAutomationOn(
+      record,
+      [IDENTIFIER, trigger].join("."),
+      true
+    );
+  }
+}
+
 async function handlePullRequest(payload) {
   const pr = payload.pull_request;
 
@@ -35,6 +64,7 @@ async function handlePullRequest(payload) {
     }
 
     await triggerEvent("pr", payload, record);
+    await triggerAutomation(payload, record);
   } else {
     await triggerEvent("pr", payload, null);
   }

tsconfig.json

@@ -11,5 +11,5 @@
     "moduleResolution": "node",
     "target": "ES6"
   },
-  "include": [".aha-cache/aha.d.ts", "src"]
+  "include": [".aha-cache/types", "src"]
 }