feat: Implement setting to skip push events for PR commits

*   Add `skip-push-event-for-pr-commits` configuration setting.
*   Skip processing push events when the commit SHA is present in an open pull
request.
*   Prevent duplicate pipeline runs triggered by both push and pull request
events for the same commit.
*   Document the new configuration setting.

Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>

Author: chmouel

config/302-pac-configmap.yaml

@@ -143,6 +143,13 @@ data:
   # you may want to disable this if ok-to-test should be done on each iteration
   remember-ok-to-test: "false"
 
+  # When enabled, this option prevents duplicate pipeline runs when a commit appears in
+  # both a push event and a pull request. If a push event comes from a commit that is
+  # part of an open pull request, the push event will be skipped as it would create
+  # a duplicate pipeline run.
+  # Default: true
+  skip-push-event-for-pr-commits: "true"
+
   # Configure a custom console here, the driver support custom parameters from
   # Repo CR along a few other template variable, see documentation for more
   # details

docs/content/docs/install/settings.md

@@ -139,6 +139,20 @@ There is a few things you can configure through the config map
   risk and should be aware of the potential security vulnerabilities.
   (only GitHub and Gitea is supported at the moment).
 
+* `skip-push-event-for-pr-commits`
+
+  When enabled, this option prevents duplicate pipeline runs when a commit appears in
+  both a push event and a pull request. If a push event comes from a commit that is
+  part of an open pull request, the push event will be skipped as it would create
+  a duplicate pipeline run.
+  
+  This feature works by checking if a pushed commit SHA exists in any open pull request,
+  and if so, skipping the push event processing.
+  
+  Default: `true`
+  
+{{< support_matrix github_app="true" github_webhook="true" gitea="false" gitlab="false" bitbucket_cloud="false" bitbucket_datacenter="false" >}}
+
 ### Global Cancel In Progress Settings
 
 * `enable-cancel-in-progress-on-pull-requests`
@@ -429,28 +443,28 @@ A few settings are available to configure this feature:
       }
   ```
 
-  The `loglevel.*` fields define the log level for the controllers:
+The `loglevel.*` fields define the log level for the controllers:
 
 * loglevel.pipelinesascode - the log level for the pipelines-as-code-controller component
 * loglevel.pipelines-as-code-webhook - the log level for the pipelines-as-code-webhook component
 * loglevel.pac-watcher - the log level for the pipelines-as-code-watcher component
 
-  You can change the log level from `info` to `debug` or any other supported values. For example, select the `debug` log level for the pipelines-as-code-watcher component:
+You can change the log level from `info` to `debug` or any other supported values. For example, select the `debug` log level for the pipelines-as-code-watcher component:
 
-  ```bash
-  kubectl patch configmap pac-config-logging -n pipelines-as-code --type json -p '[{"op": "replace", "path": "/data/loglevel.pac-watcher", "value":"debug"}]'
-  ```
+```bash
+kubectl patch configmap pac-config-logging -n pipelines-as-code --type json -p '[{"op": "replace", "path": "/data/loglevel.pac-watcher", "value":"debug"}]'
+```
 
-  After this command, the controller gets a new log level value.
-  If you want to use the same log level for all Pipelines-as-Code components, delete `level.*` values from configmap:
+After this command, the controller gets a new log level value.
+If you want to use the same log level for all Pipelines-as-Code components, delete `level.*` values from configmap:
 
-  ```bash
-  kubectl patch configmap pac-config-logging -n pipelines-as-code --type json -p '[  {"op": "remove", "path": "/data/loglevel.pac-watcher"},  {"op": "remove", "path": "/data/loglevel.pipelines-as-code-webhook"},  {"op": "remove", "path": "/data/loglevel.pipelinesascode"}]'
-  ```
+```bash
+kubectl patch configmap pac-config-logging -n pipelines-as-code --type json -p '[  {"op": "remove", "path": "/data/loglevel.pac-watcher"},  {"op": "remove", "path": "/data/loglevel.pipelines-as-code-webhook"},  {"op": "remove", "path": "/data/loglevel.pipelinesascode"}]'
+```
 
-  In this case, all Pipelines-as-Code components get a common log level from `zap-logger-config` - `level` field from the json.
+In this case, all Pipelines-as-Code components get a common log level from `zap-logger-config` - `level` field from the json.
 
-  `zap-logger-config` supports the following log levels:
+`zap-logger-config` supports the following log levels:
 
 * debug - fine-grained debugging
 * info - normal logging
@@ -460,4 +474,4 @@ A few settings are available to configure this feature:
 * panic - trigger a panic (crash)
 * fatal - immediately exit with exit status 1 (failure)
 
-  See more: <https://knative.dev/docs/serving/observability/logging/config-logging>
+See more: <https://knative.dev/docs/serving/observability/logging/config-logging>

pkg/params/settings/config.go

@@ -66,6 +66,8 @@ type Settings struct {
 	EnableCancelInProgressOnPullRequests bool `json:"enable-cancel-in-progress-on-pull-requests"`
 	EnableCancelInProgressOnPush         bool `json:"enable-cancel-in-progress-on-push"`
 
+	SkipPushEventForPRCommits bool `json:"skip-push-event-for-pr-commits" default:"true"` // nolint:tagalign
+
 	CustomConsoleName         string `json:"custom-console-name"`
 	CustomConsoleURL          string `json:"custom-console-url"`
 	CustomConsolePRdetail     string `json:"custom-console-url-pr-details"`

pkg/params/settings/config_test.go

@@ -40,6 +40,7 @@ func TestSyncConfig(t *testing.T) {
 				ErrorDetectionSimpleRegexp:           "^(?P<filename>[^:]*):(?P<line>[0-9]+):(?P<column>[0-9]+)?([ ]*)?(?P<error>.*)",
 				EnableCancelInProgressOnPullRequests: false,
 				EnableCancelInProgressOnPush:         false,
+				SkipPushEventForPRCommits:            true,
 				CustomConsoleName:                    "",
 				CustomConsoleURL:                     "",
 				CustomConsolePRdetail:                "",
@@ -73,6 +74,7 @@ func TestSyncConfig(t *testing.T) {
 				"custom-console-url-pr-tasklog":          "https://custom-console-pr-tasklog",
 				"custom-console-url-namespace":           "https://custom-console-namespace",
 				"remember-ok-to-test":                    "false",
+				"skip-push-event-for-pr-commits":         "true",
 			},
 			expectedStruct: Settings{
 				ApplicationName:                    "pac-pac",
@@ -98,6 +100,7 @@ func TestSyncConfig(t *testing.T) {
 				CustomConsolePRTaskLog:             "https://custom-console-pr-tasklog",
 				CustomConsoleNamespaceURL:          "https://custom-console-namespace",
 				RememberOKToTest:                   false,
+				SkipPushEventForPRCommits:          true,
 			},
 		},
 		{

pkg/params/settings/convert_test.go

@@ -35,6 +35,7 @@ func TestConvert(t *testing.T) {
 				"error-log-snippet":                          "true",
 				"enable-cancel-in-progress-on-pull-requests": "false",
 				"enable-cancel-in-progress-on-push":          "false",
+				"skip-push-event-for-pr-commits":             "true",
 				"hub-catalog-name":                           "tekton",
 				"hub-url":                                    "https://api.hub.tekton.dev/v1",
 				"max-keep-run-upper-limit":                   "0",
@@ -75,6 +76,7 @@ func TestConvert(t *testing.T) {
 				"error-log-snippet":                          "true",
 				"enable-cancel-in-progress-on-pull-requests": "false",
 				"enable-cancel-in-progress-on-push":          "false",
+				"skip-push-event-for-pr-commits":             "true",
 				"hub-catalog-name":                           "tekton",
 				"hub-url":                                    "https://api.hub.tekton.dev/v1",
 				"max-keep-run-upper-limit":                   "0",
@@ -116,6 +118,7 @@ func TestConvert(t *testing.T) {
 				"error-log-snippet":                          "true",
 				"enable-cancel-in-progress-on-pull-requests": "false",
 				"enable-cancel-in-progress-on-push":          "false",
+				"skip-push-event-for-pr-commits":             "true",
 				"hub-catalog-name":                           "test tekton",
 				"hub-url":                                    "https://api.hub.tekton.dev/v2",
 				"max-keep-run-upper-limit":                   "0",
@@ -169,6 +172,7 @@ func TestConvert(t *testing.T) {
 				"error-log-snippet":                          "true",
 				"enable-cancel-in-progress-on-pull-requests": "false",
 				"enable-cancel-in-progress-on-push":          "false",
+				"skip-push-event-for-pr-commits":             "true",
 				"hub-catalog-name":                           "test tekton",
 				"hub-url":                                    "https://api.hub.tekton.dev/v2",
 				"max-keep-run-upper-limit":                   "0",

pkg/provider/github/parse_payload.go

@@ -208,6 +208,40 @@ func (v *Provider) ParsePayload(ctx context.Context, run *params.Run, request *h
 	return processedEvent, nil
 }
 
+// isCommitPartOfPullRequest checks if the commit from a push event is part of an open pull request
+// If it is, it returns true and the PR number.
+func (v *Provider) isCommitPartOfPullRequest(ctx context.Context, sha, org, repo string) (bool, int, error) {
+	if v.ghClient == nil {
+		return false, 0, nil
+	}
+
+	// List all open pull requests in the repository
+	prs, _, err := v.ghClient.PullRequests.List(ctx, org, repo, &github.PullRequestListOptions{
+		State: "open",
+	})
+	if err != nil {
+		return false, 0, err
+	}
+
+	// Check each PR to see if it contains the commit
+	for _, pr := range prs {
+		// Get the commits in this PR
+		commits, _, err := v.ghClient.PullRequests.ListCommits(ctx, org, repo, pr.GetNumber(), &github.ListOptions{})
+		if err != nil {
+			continue
+		}
+
+		// Check if our SHA is in the PR's commits
+		for _, commit := range commits {
+			if commit.GetSHA() == sha {
+				return true, pr.GetNumber(), nil
+			}
+		}
+	}
+
+	return false, 0, nil
+}
+
 func (v *Provider) processEvent(ctx context.Context, event *info.Event, eventInt any) (*info.Event, error) {
 	var processedEvent *info.Event
 	var err error
@@ -268,16 +302,34 @@ func (v *Provider) processEvent(ctx context.Context, event *info.Event, eventInt
 			}
 		}
 
+		// Check if this push commit is part of an open pull request
+		sha := gitEvent.GetHeadCommit().GetID()
+		if sha == "" {
+			sha = gitEvent.GetBefore()
+		}
+		org := gitEvent.GetRepo().GetOwner().GetLogin()
+		repoName := gitEvent.GetRepo().GetName()
+
+		// Only check if the flag is enabled
+		if v.pacInfo.SkipPushEventForPRCommits {
+			isPartOfPR, prNumber, err := v.isCommitPartOfPullRequest(ctx, sha, org, repoName)
+			if err != nil {
+				v.Logger.Warnf("Error checking if push commit is part of PR: %v", err)
+			}
+
+			// If the commit is part of a PR, skip processing the push event
+			if isPartOfPR {
+				v.Logger.Infof("Skipping push event for commit %s as it belongs to pull request #%d", sha, prNumber)
+				return nil, fmt.Errorf("commit %s is part of pull request #%d, skipping push event", sha, prNumber)
+			}
+		}
+
 		processedEvent.Organization = gitEvent.GetRepo().GetOwner().GetLogin()
 		processedEvent.Repository = gitEvent.GetRepo().GetName()
 		processedEvent.DefaultBranch = gitEvent.GetRepo().GetDefaultBranch()
 		processedEvent.URL = gitEvent.GetRepo().GetHTMLURL()
 		v.RepositoryIDs = []int64{gitEvent.GetRepo().GetID()}
-		processedEvent.SHA = gitEvent.GetHeadCommit().GetID()
-		// on push event we may not get a head commit but only
-		if processedEvent.SHA == "" {
-			processedEvent.SHA = gitEvent.GetBefore()
-		}
+		processedEvent.SHA = sha
 		processedEvent.SHAURL = gitEvent.GetHeadCommit().GetURL()
 		processedEvent.SHATitle = gitEvent.GetHeadCommit().GetMessage()
 		processedEvent.Sender = gitEvent.GetSender().GetLogin()