Add BaseRef field to CampaignPlanPatch and use commitID in BaseRevision (#158)

* Add BaseRef field to CampaignPlanPlatch and use commitID in BaseRevision

This implements the src CLI tasks of https://github.com/sourcegraph/sourcegraph/issues/8846

With this change src CLI uses the commit ID (instead of refspec) as the
`CampaignPlanPatch.BaseRevision` when creating a `CampaignPlan`.

It also adds the additional `baseRef` field to `CampaignPlanPatch` and
sends that to the GraphQL.

Since Sourcegraph <3.14 expects the `baseRevision` of a
`CampaignPlanPatch` to contain a ref (e.g. "refs/heads/master") we check
the Sourcegraph version and fall back to that behaviour so that
customers can use a newer src CLI version with their <3.14
instance.

With the addition of these fields to ActionRepo and CampaignPlanPatch
the cache of src CLI is now also busted when the revision of the default
branch of a repo changes.

* Update cmd/src/campaign_plans_create_from_patches.go

Co-Authored-By: Erik Seliger <[email protected]>

Co-authored-by: Erik Seliger <[email protected]>

Author: mrnugget

cmd/src/actions_exec.go

@@ -40,6 +40,7 @@ type ActionStep struct {
 type CampaignPlanPatch struct {
 	Repository   string `json:"repository"`
 	BaseRevision string `json:"baseRevision"`
+	BaseRef      string `json:"baseRef"`
 	Patch        string `json:"patch"`
 }
 
@@ -349,9 +350,10 @@ func getDockerImageContentDigest(ctx context.Context, image string) (string, err
 }
 
 type ActionRepo struct {
-	ID   string
-	Name string
-	Rev  string
+	ID      string
+	Name    string
+	Rev     string
+	BaseRef string
 }
 
 func actionRepos(ctx context.Context, scopeQuery string) ([]ActionRepo, []string, error) {
@@ -373,13 +375,19 @@ query ActionRepos($query: String!) {
 				... on Repository {
 					id
 					name
-					defaultBranch { name }
+					defaultBranch {
+						name
+						target { oid }
+					}
 				}
 				... on FileMatch {
 					repository {
 						id
 						name
-						defaultBranch { name }
+						defaultBranch {
+							name
+							target { oid }
+						}
 					}
 				}
 			}
@@ -389,16 +397,22 @@ query ActionRepos($query: String!) {
 `
 	type Repository struct {
 		ID, Name      string
-		DefaultBranch struct{ Name string }
+		DefaultBranch struct {
+			Name   string
+			Target struct{ OID string }
+		}
 	}
 	var result struct {
 		Search struct {
 			Results struct {
 				Results []struct {
 					Typename      string `json:"__typename"`
 					ID, Name      string
-					DefaultBranch struct{ Name string }
-					Repository    Repository `json:"repository"`
+					DefaultBranch struct {
+						Name   string
+						Target struct{ OID string }
+					}
+					Repository Repository `json:"repository"`
 				}
 			}
 		}
@@ -433,11 +447,17 @@ query ActionRepos($query: String!) {
 			continue
 		}
 
+		if repo.DefaultBranch.Target.OID == "" {
+			skipped = append(skipped, repo.Name)
+			continue
+		}
+
 		if _, ok := reposByID[repo.ID]; !ok {
 			reposByID[repo.ID] = ActionRepo{
-				ID:   repo.ID,
-				Name: repo.Name,
-				Rev:  repo.DefaultBranch.Name,
+				ID:      repo.ID,
+				Name:    repo.Name,
+				Rev:     repo.DefaultBranch.Target.OID,
+				BaseRef: repo.DefaultBranch.Name,
 			}
 		}
 	}

cmd/src/actions_exec_backend_runner.go

@@ -68,6 +68,7 @@ func (x *actionExecutor) do(ctx context.Context, repo ActionRepo) (err error) {
 		status.Patch = CampaignPlanPatch{
 			Repository:   repo.ID,
 			BaseRevision: repo.Rev,
+			BaseRef:      repo.BaseRef,
 			Patch:        string(patch),
 		}
 	}

cmd/src/campaign_plans_create_from_patches.go

@@ -97,6 +97,33 @@ func createCampaignPlanFromPatches(
 	var result struct {
 		CreateCampaignPlanFromPatches CampaignPlan
 	}
+
+	version, err := getSourcegraphVersion()
+	if err != nil {
+		return err
+	}
+	supportsBaseRef, err := sourcegraphVersionCheck(version, ">= 3.14.0", "2020-03-11")
+	if err != nil {
+		return err
+	}
+
+	// If we're on Sourcegraph >=3.14 the GraphQL API is "fixed" and accepts
+	// patches with `BaseRevision` and `BaseRef` fields. <3.14 expects a ref
+	// (e.g. "refs/heads/master") in `BaseRevision`, so we need to copy the
+	// value over.
+	if !supportsBaseRef {
+		patchesWithoutBaseRef := make([]CampaignPlanPatch, len(patches))
+		for i, p := range patches {
+			patchesWithoutBaseRef[i] = CampaignPlanPatch{
+				Repository:   p.Repository,
+				BaseRevision: p.BaseRef,
+				BaseRef:      "IGNORE-THIS",
+				Patch:        p.Patch,
+			}
+		}
+		patches = patchesWithoutBaseRef
+	}
+
 	return (&apiRequest{
 		query:  query,
 		vars:   map[string]interface{}{"patches": patches},