Fix panic when search yields repo and file matches in same repo (#385)

This fixes #382 by fixing a regression that was introduced by #361.

When the search queries defined in a campaign spec yielded a repository
match result and file match results in the same repository, in that
order, the code would crash because of an uninitialized map.

The code here fixes it by always initializing the map.

I also added a test that reproduces the behaviour and documents how we
turn multiple search results into a list of repositories.

Author: mrnugget

CHANGELOG.md

@@ -17,6 +17,8 @@ All notable changes to `src-cli` are documented in this file.
 
 ### Fixed
 
+- Fix a regression that was introduced by [#361](https://github.com/sourcegraph/src-cli/pull/361) and caused the "Resolving repositories" step of `src campaign [apply|preview]` to crash when the search query in the campaign spec yielded file matches and repository matches from the same repository.
+
 ### Removed
 
 ## 3.22.0

internal/campaigns/service.go

@@ -535,7 +535,11 @@ func (sr *searchResult) UnmarshalJSON(data []byte) error {
 		return nil
 
 	case "Repository":
-		return json.Unmarshal(data, &sr.Repository)
+		if err := json.Unmarshal(data, &sr.Repository); err != nil {
+			return err
+		}
+		sr.Repository.FileMatches = map[string]bool{}
+		return nil
 
 	default:
 		return errors.Errorf("unknown GraphQL type %q", tn.Typename)

internal/campaigns/service_test.go

@@ -1,6 +1,14 @@
 package campaigns
 
-import "testing"
+import (
+	"bytes"
+	"context"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/sourcegraph/src-cli/internal/api"
+)
 
 func TestSetDefaultQueryCount(t *testing.T) {
 	for in, want := range map[string]string{
@@ -20,3 +28,94 @@ func TestSetDefaultQueryCount(t *testing.T) {
 		})
 	}
 }
+
+func TestResolveRepositorySearch(t *testing.T) {
+	mux := http.NewServeMux()
+	mux.HandleFunc("/.api/graphql", func(w http.ResponseWriter, r *http.Request) {
+		w.Header().Set("Content-Type", "application/json")
+		w.Write([]byte(testResolveRepositorySearchResult))
+	})
+
+	ts := httptest.NewServer(mux)
+	defer ts.Close()
+
+	var clientBuffer bytes.Buffer
+	client := api.NewClient(api.ClientOpts{Endpoint: ts.URL, Out: &clientBuffer})
+
+	svc := &Service{client: client}
+
+	repos, err := svc.resolveRepositorySearch(context.Background(), "sourcegraph reconciler or src-cli")
+	if err != nil {
+		t.Fatalf("unexpected error: %s", err)
+	}
+
+	// We want multiple FileMatches in the same repository to result in one repository
+	// and Repository and FileMatches should be folded into the same repository.
+	if have, want := len(repos), 3; have != want {
+		t.Fatalf("wrong number of repos. want=%d, have=%d", want, have)
+	}
+}
+
+const testResolveRepositorySearchResult = `{
+  "data": {
+    "search": {
+      "results": {
+        "results": [
+          {
+            "__typename": "FileMatch",
+            "file": { "path": "website/src/components/PricingTable.tsx" },
+            "repository": {
+              "id": "UmVwb3NpdG9yeTo0MDc=",
+              "name": "github.com/sd9/about",
+              "url": "/github.com/sd9/about",
+              "externalRepository": { "serviceType": "github" },
+              "defaultBranch": { "name": "refs/heads/master", "target": { "oid": "1576f235209fbbfc918129db35f3d108347b74cb" } }
+            }
+          },
+          {
+            "__typename": "Repository",
+            "id": "UmVwb3NpdG9yeToxOTM=",
+            "name": "github.com/sd9/src-cli",
+            "url": "/github.com/sd9/src-cli",
+            "externalRepository": { "serviceType": "github" },
+            "defaultBranch": { "name": "refs/heads/master", "target": { "oid": "21dd58b08d64620942401b5543f5b0d33498bacb" } }
+          },
+          {
+            "__typename": "FileMatch",
+            "file": { "path": "cmd/src/api.go" },
+            "repository": {
+              "id": "UmVwb3NpdG9yeToxOTM=",
+              "name": "github.com/sd9/src-cli",
+              "url": "/github.com/sd9/src-cli",
+              "externalRepository": { "serviceType": "github" },
+              "defaultBranch": { "name": "refs/heads/master", "target": { "oid": "21dd58b08d64620942401b5543f5b0d33498bacb" } }
+            }
+          },
+          {
+            "__typename": "FileMatch",
+            "file": { "path": "client/web/src/components/externalServices/externalServices.tsx" },
+            "repository": {
+              "id": "UmVwb3NpdG9yeTo2",
+              "name": "github.com/sourcegraph/sourcegraph",
+              "url": "/github.com/sourcegraph/sourcegraph",
+              "externalRepository": { "serviceType": "github" },
+              "defaultBranch": { "name": "refs/heads/main", "target": { "oid": "e612c34f2e27005928ff3dfdd8e5ead5a0cb1526" } }
+            }
+          },
+          {
+            "__typename": "FileMatch",
+            "file": { "path": "cmd/frontend/internal/httpapi/src_cli.go" },
+            "repository": {
+              "id": "UmVwb3NpdG9yeTo2",
+              "name": "github.com/sourcegraph/sourcegraph",
+              "url": "/github.com/sourcegraph/sourcegraph",
+              "externalRepository": { "serviceType": "github" },
+              "defaultBranch": { "name": "refs/heads/main", "target": { "oid": "e612c34f2e27005928ff3dfdd8e5ead5a0cb1526" } }
+            }
+          }
+        ]
+      }
+    }
+  }
+}
+`