[PM-24744] Remove past BIT status comments on originating issue (#379)

* shorten and clarify PR comments

* remove past BIT status comments on originating issue

Author: jprusik

.github/workflows/test-all-custom-flags.yml

@@ -187,8 +187,46 @@ jobs:
             ./tests-out/videos
             ./tests-out/screenshots
 
-      # Only post back to the PR if there was a failure since test-all has the
-      # typical config case covered for success feedback
+      - name: Remove past BIT status comments on originating issue
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        if: steps.set-send-pr-feedback.outputs.send_pr_feedback == 'true'
+        with:
+          github-token: ${{ steps.app-token.outputs.token }}
+          script: |
+            // Note: should match the first line of `message` in the communication steps
+            const workflowCommentTag = '<!-- comment_tag: test-all-custom-flags -->';
+
+            const owner = 'bitwarden';
+
+            const issueComments = await github.rest.issues.listComments({
+              issue_number: context.payload.client_payload.origin_issue,
+              owner: owner,
+              repo: 'clients',
+            });
+
+            for (const comment of issueComments.data || []) {
+              const shouldDeleteComment =
+                // Do not delete comments that were not automated
+                !!comment.performed_via_github_app &&
+
+                // Do not delete user comments
+                comment.user.type === 'Bot' &&
+
+                // Do not delete edited comments
+                comment.created_at === comment.updated_at &&
+
+                // Only delete comments from this workflow
+                comment.body.trim().startsWith(workflowCommentTag);
+
+              if (shouldDeleteComment) {
+                await github.rest.issues.deleteComment({
+                  comment_id: comment.id,
+                  owner: owner,
+                  repo: 'clients',
+                });
+              }
+            }
+
       - name: Communicate BIT failure on originating issue
         uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
         if: failure() && steps.set-send-pr-feedback.outputs.send_pr_feedback == 'true'
@@ -197,17 +235,51 @@ jobs:
           script: |
             const owner = 'bitwarden';
             const featureFlags = "${{ inputs.FEATURE_FLAGS || '{}' }}";
-            const featureFlagsMessage = featureFlags === '{}' ? 'all feature flags disabled.': `\n\n<details><summary><div>The following flags enabled:</div></summary>\`\`\`json\n${featureFlags}\`\`\``;
+            const featureFlagsMessage = featureFlags === '{}' ?
+              '<ins>all feature flags disabled</ins>.' :
+              `**the following flags enabled**:<br/><details><summary>Show/Hide Flags</summary><pre><code>${featureFlags}</code></pre></details>`;
             const runURL = `https://github.com/${owner}/browser-interactions-testing/actions/runs/${context.runId}`;
-            const message = `⚠️ **Files have been modified in this PR that impact the Autofill experience** ⚠️
+            const message = `
+            <!-- comment_tag: test-all-custom-flags -->
+            #### ⚠️ Changes in this PR impact the Autofill experience of the browser client ⚠️
+
+            [BIT](https://github.com/${owner}/browser-interactions-testing) has tested the core experience with these changes and ${featureFlagsMessage}
+
+            > [!CAUTION]
+            > Unfortunately, one or more of these tests failed. 😞
+            >
+            > Please resolve the failure before merging; reach out to \`@bitwarden/team-autofill-dev\` if you'd like help.
 
-            [BIT](https://github.com/${owner}/browser-interactions-testing) was run to verify no regressions have been introduced to the core Autofill experience. The tests ran with ${featureFlagsMessage}
+            You can view the detailed results of the tests [here](${runURL}).
+            `;
 
-            ❌ Unfortunately, one or more of these BIT tests failed. 😞
+            github.rest.issues.createComment({
+              issue_number: context.payload.client_payload.origin_issue,
+              owner: owner,
+              repo: 'clients',
+              body: message
+            });
+
+      - name: Communicate BIT success on originating issue
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        if: success() && steps.set-send-pr-feedback.outputs.send_pr_feedback == 'true'
+        with:
+          github-token: ${{ steps.app-token.outputs.token }}
+          script: |
+            const owner = 'bitwarden';
+            const featureFlags = "${{ inputs.FEATURE_FLAGS || '{}' }}";
+            const featureFlagsMessage = featureFlags === '{}' ?
+              '<ins>all feature flags disabled</ins>.' :
+              `**the following flags enabled**:<br/><details><summary>Show/Hide Flags</summary><pre><code>${featureFlags}</code></pre></details>`;
+            const runURL = `https://github.com/${owner}/browser-interactions-testing/actions/runs/${context.runId}`;
+            const message = `
+            <!-- comment_tag: test-all-custom-flags -->
+            #### Changes in this PR impact the Autofill experience of the browser client
 
-            Please resolve the failure before merging; reach out to \`@bitwarden/team-autofill-dev\` if you'd like help.
+            [BIT](https://github.com/${owner}/browser-interactions-testing) has tested the core experience with these changes and ${featureFlagsMessage}
 
-            You can view the detailed results of the tests [here](${runURL}).`;
+            ✅ Fortunately, [these BIT tests have passed](${runURL})! 🎉
+            `;
 
             github.rest.issues.createComment({
               issue_number: context.payload.client_payload.origin_issue,

.github/workflows/test-all.yml

@@ -189,6 +189,46 @@ jobs:
             ./tests-out/videos
             ./tests-out/screenshots
 
+      - name: Remove past BIT status comments on originating issue
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        if: steps.set-send-pr-feedback.outputs.send_pr_feedback == 'true'
+        with:
+          github-token: ${{ steps.app-token.outputs.token }}
+          script: |
+            // Note: should match the first line of `message` in the communication steps
+            const workflowCommentTag = '<!-- comment_tag: test-all -->';
+
+            const owner = 'bitwarden';
+
+            const issueComments = await github.rest.issues.listComments({
+              issue_number: context.payload.client_payload.origin_issue,
+              owner: owner,
+              repo: 'clients',
+            });
+
+            for (const comment of issueComments.data || []) {
+              const shouldDeleteComment =
+                // Do not delete comments that were not automated
+                !!comment.performed_via_github_app &&
+
+                // Do not delete user comments
+                comment.user.type === 'Bot' &&
+
+                // Do not delete edited comments
+                comment.created_at === comment.updated_at &&
+
+                // Only delete comments from this workflow
+                comment.body.trim().startsWith(workflowCommentTag);
+
+              if (shouldDeleteComment) {
+                await github.rest.issues.deleteComment({
+                  comment_id: comment.id,
+                  owner: owner,
+                  repo: 'clients',
+                });
+              }
+            }
+
       - name: Communicate BIT failure on originating issue
         uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
         if: failure() && steps.set-send-pr-feedback.outputs.send_pr_feedback == 'true'
@@ -198,15 +238,19 @@ jobs:
             const owner = 'bitwarden';
             const runURL = `https://github.com/${owner}/browser-interactions-testing/actions/runs/${context.runId}`;
             const configURL = new URL('${{ vars.BW_REMOTE_VAULT_CONFIG_MATCH }}');
-            const message = `⚠️ **Files have been modified in this PR that impact the Autofill experience** ⚠️
-
-            [BIT](https://github.com/${owner}/browser-interactions-testing) was run to verify no regressions have been introduced to the core Autofill experience. The tests ran with the same feature flag configuration used by \`${configURL.hostname}\`
+            const message = `
+            <!-- comment_tag: test-all -->
+            #### ⚠️ Changes in this PR impact the Autofill experience of the browser client ⚠️
 
-            ❌ Unfortunately, one or more of these BIT tests failed. 😞
+            [BIT](https://github.com/${owner}/browser-interactions-testing) has tested the core experience with these changes and **the feature flag configuration used by \`${configURL.hostname}\`**
 
-            Please resolve the failure before merging; reach out to \`@bitwarden/team-autofill-dev\` if you'd like help.
+            > [!CAUTION]
+            > Unfortunately, one or more of these tests failed. 😞
+            >
+            > Please resolve the failure before merging; reach out to \`@bitwarden/team-autofill-dev\` if you'd like help.
 
-            You can view the detailed results of the tests [here](${runURL}).`;
+            You can view the detailed results of the tests [here](${runURL}).
+            `;
 
             github.rest.issues.createComment({
               issue_number: context.payload.client_payload.origin_issue,
@@ -222,11 +266,16 @@ jobs:
           github-token: ${{ steps.app-token.outputs.token }}
           script: |
             const owner = 'bitwarden';
-            const message = `⚠️ **Files have been modified in this PR that impact the Autofill experience** ⚠️
+            const runURL = `https://github.com/${owner}/browser-interactions-testing/actions/runs/${context.runId}`;
+            const configURL = new URL('${{ vars.BW_REMOTE_VAULT_CONFIG_MATCH }}');
+            const message = `
+            <!-- comment_tag: test-all -->
+            #### Changes in this PR impact the Autofill experience of the browser client
 
-            [BIT](https://github.com/${owner}/browser-interactions-testing) was run to verify no regressions have been introduced to the core Autofill experience.
+            [BIT](https://github.com/${owner}/browser-interactions-testing) has tested the core experience with these changes and <ins>the feature flag configuration used by \`${configURL.hostname}\`</ins>.
 
-            ✅ Fortunately, [these BIT tests have passed](https://github.com/${owner}/browser-interactions-testing/actions/runs/${context.runId})! 🎉`;
+            ✅ Fortunately, [these BIT tests have passed](${runURL})! 🎉
+            `;
 
             github.rest.issues.createComment({
               issue_number: context.payload.client_payload.origin_issue,