Merge pull request #870 from amazeeio/601-skip-deploy-pr-body-changes

Skip PR deployments if only the body has changed

services/webhooks2tasks/src/handlers/bitbucketPullRequestUpdated.js

@@ -16,7 +16,14 @@ async function bitbucketPullRequestUpdated(webhook: WebhookRequestData, project:
       body,
     } = webhook;
 
-    console.log(body);
+    const meta = {
+      projectName: project.name,
+      pullrequestTitle: body.pullrequest.title,
+      pullrequestNumber: body.pullrequest.id,
+      pullrequestUrl: body.pullrequest.destination.repository.links.html.href,
+      repoName: body.repository.full_name,
+      repoUrl: body.repository.links.html.href,
+    }
 
     const headBranchName = body.pullrequest.source.branch.name
     const headSha = body.pullrequest.source.commit.hash
@@ -51,7 +58,7 @@ async function bitbucketPullRequestUpdated(webhook: WebhookRequestData, project:
         case "UnknownActiveSystem":
           // These are not real errors and also they will happen many times. We just log them locally but not throw an error
           sendToLagoonLogs('info', project.name, uuid, `${webhooktype}:${event}:handledButNoTask`, meta,
-            `*[${project.name}]* PR ${body.object_attributes.id} opened. No remove task created, reason: ${error}`
+            `*[${project.name}]* PR ${body.object_attributes.id} updated. No deploy task created, reason: ${error}`
           )
           return;
 

services/webhooks2tasks/src/handlers/githubPullRequestOpened.js

@@ -21,6 +21,14 @@ async function githubPullRequestOpened(webhook: WebhookRequestData, project: Pro
     const baseBranchName = body.pull_request.base.ref
     const baseSha = body.pull_request.base.sha
 
+    const meta = {
+      projectName: project.name,
+      pullrequestTitle: body.pull_request.title,
+      pullrequestNumber: body.number,
+      pullrequestUrl: body.pull_request.html_url,
+      repoName: body.repository.full_name,
+      repoUrl: body.repository.html_url,
+    }
 
     const data: deployData = {
       repoUrl: body.repository.html_url,
@@ -50,7 +58,7 @@ async function githubPullRequestOpened(webhook: WebhookRequestData, project: Pro
         case "UnknownActiveSystem":
           // These are not real errors and also they will happen many times. We just log them locally but not throw an error
           sendToLagoonLogs('info', project.name, uuid, `${webhooktype}:${event}:handledButNoTask`, meta,
-            `*[${project.name}]* PR ${body.number} opened. No remove task created, reason: ${error}`
+            `*[${project.name}]* PR ${body.number} opened. No deploy task created, reason: ${error}`
           )
           return;
 

services/webhooks2tasks/src/handlers/githubPullRequestSynchronize.js

@@ -1,11 +1,22 @@
 // @flow
 
+const R = require('ramda');
 const { logger } = require('@lagoon/commons/src/local-logging');
 const { sendToLagoonLogs } = require('@lagoon/commons/src/logs');
 const { createDeployTask } = require('@lagoon/commons/src/tasks');
 
 import type { WebhookRequestData, removeData, ChannelWrapper, Project } from '../types';
 
+const isEditAction = R.propEq('action', 'edited');
+
+const onlyBodyChanges = R.pipe(
+  R.propOr({}, 'changes'),
+  R.keys,
+  R.equals(['body']),
+);
+
+const skipRedeploy = R.and(isEditAction, onlyBodyChanges);
+
 async function githubPullRequestSynchronize(webhook: WebhookRequestData, project: Project) {
 
     const {
@@ -16,9 +27,21 @@ async function githubPullRequestSynchronize(webhook: WebhookRequestData, project
       body,
     } = webhook;
 
-    if (body.action == 'updated' && !('base' in body.changes)) {
-      // we are only interested in this webhook if the base had been updated, ofter updates like title or description don't need a redeploy
-      return
+    const meta = {
+      projectName: project.name,
+      pullrequestTitle: body.pull_request.title,
+      pullrequestNumber: body.number,
+      pullrequestUrl: body.pull_request.html_url,
+      repoName: body.repository.full_name,
+      repoUrl: body.repository.html_url,
+    }
+
+    // Don't trigger deploy if only the PR body was edited.
+    if (skipRedeploy(body)) {
+      sendToLagoonLogs('info', project.name, uuid, `${webhooktype}:${event}:handledButNoTask`, meta,
+        `*[${project.name}]* PR ${body.number} updated. No deploy task created, reason: Only body changed`
+      )
+      return;
     }
 
     const headBranchName = body.pull_request.head.ref
@@ -54,7 +77,7 @@ async function githubPullRequestSynchronize(webhook: WebhookRequestData, project
         case "UnknownActiveSystem":
           // These are not real errors and also they will happen many times. We just log them locally but not throw an error
           sendToLagoonLogs('info', project.name, uuid, `${webhooktype}:${event}:handledButNoTask`, meta,
-            `*[${project.name}]* PR ${body.number} opened. No remove task created, reason: ${error}`
+            `*[${project.name}]* PR ${body.number} opened. No deploy task created, reason: ${error}`
           )
           return;
 

services/webhooks2tasks/src/handlers/gitlabPullRequestOpened.js

@@ -16,6 +16,15 @@ async function gitlabPullRequestOpened(webhook: WebhookRequestData, project: Pro
       body,
     } = webhook;
 
+    const meta = {
+      projectName: project.name,
+      pullrequestNumber: body.object_attributes.id,
+      pullrequestTitle: body.object_attributes.title,
+      pullrequestUrl: body.object_attributes.url,
+      repoName: body.object_attributes.target.name,
+      repoUrl: body.object_attributes.target.web_url,
+    }
+
     const headBranchName = body.object_attributes.source_branch
     const headSha = body.object_attributes.last_commit.id
     const baseBranchName = body.object_attributes.target_branch
@@ -50,7 +59,7 @@ async function gitlabPullRequestOpened(webhook: WebhookRequestData, project: Pro
         case "UnknownActiveSystem":
           // These are not real errors and also they will happen many times. We just log them locally but not throw an error
           sendToLagoonLogs('info', project.name, uuid, `${webhooktype}:${event}:handledButNoTask`, meta,
-            `*[${project.name}]* PR ${body.object_attributes.id} opened. No remove task created, reason: ${error}`
+            `*[${project.name}]* PR ${body.object_attributes.id} opened. No deploy task created, reason: ${error}`
           )
           return;
 

services/webhooks2tasks/src/handlers/gitlabPullRequestUpdated.js

@@ -16,6 +16,15 @@ async function gitlabPullRequestUpdated(webhook: WebhookRequestData, project: Pr
       body,
     } = webhook;
 
+    const meta = {
+      projectName: project.name,
+      pullrequestNumber: body.object_attributes.id,
+      pullrequestTitle: body.object_attributes.title,
+      pullrequestUrl: body.object_attributes.url,
+      repoName: body.object_attributes.target.name,
+      repoUrl: body.object_attributes.target.web_url,
+    }
+
     const headBranchName = body.object_attributes.source_branch
     const headSha = body.object_attributes.last_commit.id
     const baseBranchName = body.object_attributes.target_branch
@@ -51,7 +60,7 @@ async function gitlabPullRequestUpdated(webhook: WebhookRequestData, project: Pr
         case "UnknownActiveSystem":
           // These are not real errors and also they will happen many times. We just log them locally but not throw an error
           sendToLagoonLogs('info', project.name, uuid, `${webhooktype}:${event}:handledButNoTask`, meta,
-            `*[${project.name}]* PR ${body.object_attributes.id} opened. No remove task created, reason: ${error}`
+            `*[${project.name}]* PR ${body.object_attributes.id} updated. No deploy task created, reason: ${error}`
           )
           return;