Merge pull request #28 from atlanhq/fix/show-all-impact-in-one-comment

Fix/show all impact in one comment

Author: Jaagrav

src/api/get-downstream-assets.js

@@ -2,7 +2,7 @@ import fetch from "node-fetch";
 import core from "@actions/core";
 import dotenv from "dotenv";
 import {sendSegmentEvent} from "./index.js";
-import {createCustomComment, getConnectorImage, getCertificationImage} from "../utils/index.js";
+import {createIssueComment, getConnectorImage, getCertificationImage} from "../utils/index.js";
 
 dotenv.config();
 
@@ -64,7 +64,7 @@ export default async function getDownstreamAssets(asset, guid, octokit, context)
             
 [See lineage on Atlan.](${ATLAN_INSTANCE_URL}/assets/${asset.guid}/lineage?utm_source=dbt_github_action)`;
 
-        createCustomComment(octokit, context, comment)
+        createIssueComment(octokit, context, comment)
 
         sendSegmentEvent("dbt_ci_action_failure", {
             reason: 'failed_to_fetch_lineage',

src/main/print-downstream-assets.js

@@ -4,13 +4,14 @@ import {
     sendSegmentEvent,
 } from "../api/index.js";
 import {
-    createComment,
+    renderDownstreamAssetsComment,
     getChangedFiles,
-    getAssetName,
+    getAssetName, createIssueComment, checkCommentExists, deleteComment
 } from "../utils/index.js";
 
 export default async function printDownstreamAssets({octokit, context}) {
     const changedFiles = await getChangedFiles(octokit, context);
+    let comments = ``;
     var totalChangedFiles = 0
 
     if (changedFiles.length === 0) return;
@@ -25,6 +26,9 @@ export default async function printDownstreamAssets({octokit, context}) {
         const timeStart = Date.now();
         const downstreamAssets = await getDownstreamAssets(asset, guid, octokit, context);
 
+        if (totalChangedFiles !== 0)
+            comments += '\n\n---\n\n';
+
         if (downstreamAssets.length === 0) continue;
 
         sendSegmentEvent("dbt_ci_action_downstream_unfurl", {
@@ -34,15 +38,23 @@ export default async function printDownstreamAssets({octokit, context}) {
             total_fetch_time: Date.now() - timeStart,
         });
 
-        await createComment(
+        const comment = await renderDownstreamAssetsComment(
             octokit,
             context,
             asset,
             downstreamAssets
-        );
+        )
+
+        comments += comment;
 
         totalChangedFiles++
     }
 
+    const existingComment = await checkCommentExists(octokit, context);
+    await createIssueComment(octokit, context, comments, existingComment?.id)
+
+    if (totalChangedFiles === 0 && existingComment)
+        await deleteComment(octokit, context, existingComment.id)
+
     return totalChangedFiles;
 }

src/main/set-resource-on-asset.js

@@ -1,6 +1,6 @@
 import {getAsset, createResource} from "../api/index.js";
 import {
-    createCustomComment,
+    createIssueComment,
     getChangedFiles,
     getAssetName,
 } from "../utils/index.js";
@@ -35,7 +35,7 @@ export default async function setResourceOnAsset({octokit, context}) {
         totalChangedFiles++
     });
 
-    const comment = await createCustomComment(
+    const comment = await createIssueComment(
         octokit,
         context,
         `🎊 Congrats on the merge!

src/utils/auth.js

@@ -1,7 +1,7 @@
 import fetch from "node-fetch";
 import dotenv from "dotenv";
 import core from "@actions/core";
-import {createCustomComment} from "./create-comment.js";
+import {createIssueComment} from "./create-comment.js";
 
 dotenv.config();
 
@@ -29,7 +29,7 @@ export default async function auth(octokit, context) {
 
     if (response?.status === 401) {
         await
-            createCustomComment(octokit, context, `We couldn't connect to your Atlan Instance, please make sure to set the valid Atlan Bearer Token as \`ATLAN_API_TOKEN\` as this repository's action secret. 
+            createIssueComment(octokit, context, `We couldn't connect to your Atlan Instance, please make sure to set the valid Atlan Bearer Token as \`ATLAN_API_TOKEN\` as this repository's action secret. 
 
 Atlan Instance URL: ${ATLAN_INSTANCE_URL}
 
@@ -39,7 +39,7 @@ Set your repository action secrets [here](https://github.com/${context.payload.r
 
     if (response === undefined) {
         await
-            createCustomComment(octokit, context, `We couldn't connect to your Atlan Instance, please make sure to set the valid Atlan Instance URL as \`ATLAN_INSTANCE_URL\` as this repository's action secret. 
+            createIssueComment(octokit, context, `We couldn't connect to your Atlan Instance, please make sure to set the valid Atlan Instance URL as \`ATLAN_INSTANCE_URL\` as this repository's action secret. 
 
 Atlan Instance URL: ${ATLAN_INSTANCE_URL}
 

src/utils/create-comment.js

@@ -1,26 +1,20 @@
 import dotenv from "dotenv";
 import core from "@actions/core";
 
-import {
-    getConnectorImage,
-    getCertificationImage,
-    getImageURL,
-} from "./index.js";
+import {getCertificationImage, getConnectorImage, getImageURL,} from "./index.js";
 
 dotenv.config();
 
 const {IS_DEV} = process.env;
 const ATLAN_INSTANCE_URL =
     core.getInput("ATLAN_INSTANCE_URL") || process.env.ATLAN_INSTANCE_URL;
 
-export default async function createComment(
+export default async function renderDownstreamAssetsComment(
     octokit,
     context,
     asset,
     downstreamAssets
 ) {
-    const {pull_request} = context.payload;
-
     const rows = downstreamAssets.map(
         ({displayText, guid, typeName, attributes, meanings}) => {
             const connectorImage = getConnectorImage(attributes.connectorName),
@@ -48,8 +42,7 @@ export default async function createComment(
         }
     );
 
-    const comment = `
-  ## ${getConnectorImage(asset.attributes.connectorName)} [${
+    const comment = `## ${getConnectorImage(asset.attributes.connectorName)} [${
         asset.displayText
     }](${ATLAN_INSTANCE_URL}/assets/${asset.guid}?utm_source=dbt_github_action) ${
         asset.attributes?.certificateStatus
@@ -60,25 +53,29 @@ export default async function createComment(
   There are ${downstreamAssets.length} downstream assets.
   Name | Type | Description | Owners | Terms | Source URL
   --- | --- | --- | --- | --- | ---
-  ${rows.map((row) => row.join(" | ")).join("\n")}
+  ${rows.map((row) => row.map(i => i.replace(/\|/g, "•")).join(" | ")).join("\n")}
   
   ${getImageURL(
         "atlan-logo"
     )} [View asset on Atlan.](${ATLAN_INSTANCE_URL}/assets/${asset.guid}?utm_source=dbt_github_action)`;
 
-    const commentObj = {
+    return comment
+}
+
+export async function checkCommentExists(octokit, context) {
+    const {pull_request} = context.payload;
+
+    const comments = await octokit.rest.issues.listComments({
         ...context.repo,
         issue_number: pull_request.number,
-        body: comment,
-    };
-
-    console.log(comment)
+    });
 
-    if (IS_DEV) return comment;
-    return octokit.rest.issues.createComment(commentObj);
+    return comments.data.find(
+        (comment) => comment.user.login === "github-actions[bot]"
+    );
 }
 
-export async function createCustomComment(octokit, context, content) {
+export async function createIssueComment(octokit, context, content, comment_id = null) {
     const {pull_request} = context.payload;
     const commentObj = {
         ...context.repo,
@@ -89,5 +86,17 @@ export async function createCustomComment(octokit, context, content) {
     console.log(content)
 
     if (IS_DEV) return content;
-    return octokit.rest.issues.createComment(commentObj);
+
+    if (comment_id) return octokit.rest.issues.updateComment({...commentObj, comment_id});
+    return octokit.rest.issues.renderDownstreamAssetsComment(commentObj);
+}
+
+export async function deleteComment(octokit, context, comment_id) {
+    const {pull_request} = context.payload;
+
+    return octokit.rest.issues.deleteComment({
+        ...context.repo,
+        issue_number: pull_request.number,
+        comment_id,
+    });
 }

src/utils/index.js

@@ -5,8 +5,8 @@ export {
 } from "./get-image-url.js";
 export {default as hostedImages} from "./hosted-images.js";
 export {
-    default as createComment,
-    createCustomComment,
+    default as renderDownstreamAssetsComment,
+    createIssueComment, checkCommentExists, deleteComment
 } from "./create-comment.js";
 export {
     getFileContents,