Render alert fields when performing searches (#221)

This wires up a common renderer to the `actions exec` and `search` commands to
render any alert that comes back in a (hopefully) human readable form.

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

Author: LawnGnome

CHANGELOG.md

@@ -15,6 +15,8 @@ All notable changes to `src-cli` are documented in this file.
 
 - Pull missing docker images automatically. [#191](https://github.com/sourcegraph/src-cli/pull/191)
 
+- Searches that result in errors will now display any alerts returned by Sourcegraph, including suggestions for how the search could be corrected. [#221](https://github.com/sourcegraph/src-cli/pull/221)
+
 ### Changed
 
 - The terminal UI has been replaced by the logger-based UI that was previously only visible in verbose-mode (`-v`). [#228](https://github.com/sourcegraph/src-cli/pull/228)

cmd/src/actions_exec.go

@@ -483,6 +483,7 @@ query ActionRepos($query: String!) {
 					}
 				}
 			}
+			...SearchResultsAlertFields
 		}
 	}
 }
@@ -500,7 +501,8 @@ fragment repositoryFields on Repository {
 		}
 	}
 }
-`
+` + searchResultsAlertFragment
+
 	type Repository struct {
 		ID, Name           string
 		ExternalRepository struct {
@@ -527,6 +529,7 @@ fragment repositoryFields on Repository {
 						}
 						Repository Repository `json:"repository"`
 					}
+					Alert searchResultsAlert
 				}
 			}
 		} `json:"data,omitempty"`
@@ -634,6 +637,12 @@ fragment repositoryFields on Repository {
 		yellow.Fprintf(os.Stderr, "WARNING: No repositories matched by scopeQuery\n")
 	}
 
+	if content, err := result.Data.Search.Results.Alert.Render(); err != nil {
+		yellow.Fprint(os.Stderr, err)
+	} else {
+		os.Stderr.WriteString(content)
+	}
+
 	return repos, nil
 }
 

cmd/src/colors.go

@@ -37,6 +37,13 @@ var ansiColors = map[string]string{
 	"search-commit-author":  fg256Color(2),
 	"search-commit-subject": fg256Color(68),
 	"search-commit-date":    fg256Color(23),
+
+	// Search alert specific colors.
+	"search-alert-title":                fg256Color(124),
+	"search-alert-description":          fg256Color(124),
+	"search-alert-proposed-title":       "",
+	"search-alert-proposed-query":       fg256Color(69),
+	"search-alert-proposed-description": "",
 }
 
 // Borrowed from https://github.com/acarl005/stripansi/blob/master/stripansi.go

cmd/src/format.go

@@ -148,6 +148,16 @@ func parseTemplate(text string) (*template.Template, error) {
 
 			return buf.String()
 		},
+
+		// Alert rendering
+		"searchAlertRender": func(alert searchResultsAlert) string {
+			if content, err := alert.Render(); err != nil {
+				fmt.Fprintf(os.Stderr, "Error rendering search alert: %v\n", err)
+				return ""
+			} else {
+				return content
+			}
+		},
 	})
 	return tmpl.Parse(text)
 }

cmd/src/search.go

@@ -211,10 +211,11 @@ Other tips:
 				}
 				resultCount
 				elapsedMilliseconds
+				...SearchResultsAlertFields
 			  }
 			}
 		  }
-		`
+		` + searchResultsAlertFragment
 
 		var result struct {
 			Site struct {
@@ -281,6 +282,7 @@ type searchResults struct {
 	Cloning, Missing, Timedout []map[string]interface{}
 	ResultCount                int
 	ElapsedMilliseconds        int
+	Alert                      searchResultsAlert
 }
 
 // searchResultsImproved is a superset of what the GraphQL API returns. It
@@ -569,6 +571,9 @@ const searchResultsTemplate = `{{- /* ignore this line for template formatting s
 	{{- with .Timedout}}{{color "warning"}}{{"\n"}}({{len .}}) timed out:{{color "nc"}} {{join (repoNames .) ", "}}{{end -}}
 	{{"\n"}}
 
+{{- /* Any alert returned from the search */ -}}
+	{{- searchAlertRender .Alert -}}
+
 {{- /* Rendering of results */ -}}
 	{{- range .Results -}}
 		{{- if ne .__typename "Repository" -}}

cmd/src/search_alert.go

@@ -0,0 +1,78 @@
+package main
+
+import (
+	"strings"
+	"text/template"
+
+	"github.com/pkg/errors"
+)
+
+var searchResultsAlertTemplate *template.Template
+
+func init() {
+	var err error
+
+	if searchResultsAlertTemplate, err = parseTemplate(searchResultsAlertTemplateContent); err != nil {
+		// This shouldn't fail, since we control the template content via a
+		// constant below.
+		panic(err)
+	}
+}
+
+// searchResultsAlert is a type that can be used to unmarshal values returned by
+// the searchResultsAlertFragment GraphQL fragment below.
+type searchResultsAlert struct {
+	Title           string
+	Description     string
+	ProposedQueries []struct {
+		Description string
+		Query       string
+	}
+}
+
+// Render renders an alert to a string ready to be output to a console,
+// respecting the colour configuration in use by the current process. If the
+// alert is empty, then an empty string will be returned.
+func (alert *searchResultsAlert) Render() (string, error) {
+	b := &strings.Builder{}
+	if err := searchResultsAlertTemplate.Execute(b, alert); err != nil {
+		return "", errors.Wrap(err, "rendering alert template")
+	}
+	return b.String(), nil
+}
+
+// searchResultsAlertFragment provides a GraphQL fragment that can be used to
+// hydrate a searchResultsAlert instance.
+const searchResultsAlertFragment = `
+	fragment SearchResultsAlertFields on SearchResults {
+		alert {
+			title
+			description
+			proposedQueries {
+				description
+				query
+			}
+		}
+	}
+`
+
+const searchResultsAlertTemplateContent = `
+	{{- if gt (len .Title) 0 -}}
+		{{- color "search-alert-title"}}❗{{.Title}}{{color "nc"}}{{"\n"}}
+	{{- end -}}
+
+	{{- if gt (len .Description) 0 -}}
+		{{- color "search-alert-description"}}  {{.Description}}{{color "nc"}}{{"\n"}}
+	{{- end -}}
+
+	{{- if gt (len .ProposedQueries) 0 -}}
+		{{- color "search-alert-proposed-title"}}  Did you mean:{{color "nc" -}}
+		{{- "\n" -}}
+		{{- range .ProposedQueries -}}
+			{{- color "search-alert-proposed-query"}}  {{.Query}}{{color "nc" -}}
+			{{- " - " -}}
+			{{- color "search-alert-proposed-description"}}{{.Description}}{{color "nc" -}}
+			{{- "\n" -}}
+		{{- end -}}
+	{{- end -}}
+`

cmd/src/search_alert_test.go

@@ -0,0 +1,118 @@
+package main
+
+import (
+	"fmt"
+	"regexp"
+	"strings"
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+)
+
+func TestRender(t *testing.T) {
+	full := &searchResultsAlert{
+		Title:       "foo",
+		Description: "bar",
+		ProposedQueries: []struct {
+			Description string
+			Query       string
+		}{
+			{
+				Description: "quux",
+				Query:       "xyz:abc",
+			},
+			{
+				Description: "baz",
+				Query:       "def:ghi",
+			},
+		},
+	}
+
+	zero := &searchResultsAlert{}
+
+	t.Run("zero value", func(t *testing.T) {
+		content, err := zero.Render()
+		if err != nil {
+			t.Errorf("unexpected error rendering zero alert: %v", err)
+		}
+
+		if content != "" {
+			t.Errorf("unexpected content for zero alert: %s", content)
+		}
+	})
+
+	t.Run("no description", func(t *testing.T) {
+		alert := *full
+		alert.Description = zero.Description
+
+		content, err := alert.Render()
+		if err != nil {
+			t.Errorf("unexpected error rendering alert without description: %v", err)
+		}
+
+		expected := subColorCodes(strings.Join([]string{
+			"[[search-alert-title]]❗foo[[nc]]\n",
+			"[[search-alert-proposed-title]]  Did you mean:[[nc]]\n",
+			"[[search-alert-proposed-query]]  xyz:abc[[nc]] - [[search-alert-proposed-description]]quux[[nc]]\n",
+			"[[search-alert-proposed-query]]  def:ghi[[nc]] - [[search-alert-proposed-description]]baz[[nc]]\n",
+		}, ""))
+		if diff := cmp.Diff(expected, content); diff != "" {
+			t.Errorf("alert without description content incorrect: %s", diff)
+		}
+	})
+
+	t.Run("no proposed queries", func(t *testing.T) {
+		alert := *full
+		alert.ProposedQueries = zero.ProposedQueries
+
+		content, err := alert.Render()
+		if err != nil {
+			t.Errorf("unexpected error rendering alert without queries: %v", err)
+		}
+
+		expected := subColorCodes(strings.Join([]string{
+			"[[search-alert-title]]❗foo[[nc]]\n",
+			"[[search-alert-description]]  bar[[nc]]\n",
+		}, ""))
+		if diff := cmp.Diff(expected, content); diff != "" {
+			t.Errorf("alert without queries content incorrect: %s", diff)
+		}
+	})
+
+	t.Run("full", func(t *testing.T) {
+		content, err := full.Render()
+		if err != nil {
+			t.Errorf("unexpected error rendering full alert: %v", err)
+		}
+
+		expected := subColorCodes(strings.Join([]string{
+			"[[search-alert-title]]❗foo[[nc]]\n",
+			"[[search-alert-description]]  bar[[nc]]\n",
+			"[[search-alert-proposed-title]]  Did you mean:[[nc]]\n",
+			"[[search-alert-proposed-query]]  xyz:abc[[nc]] - [[search-alert-proposed-description]]quux[[nc]]\n",
+			"[[search-alert-proposed-query]]  def:ghi[[nc]] - [[search-alert-proposed-description]]baz[[nc]]\n",
+		}, ""))
+		if diff := cmp.Diff(expected, content); diff != "" {
+			t.Errorf("full alert content incorrect: %s", diff)
+		}
+	})
+}
+
+var subColorCodesRegex = regexp.MustCompile(`\[\[[a-zA-Z0-9-]+\]\]`)
+
+// subColorCodes provides ad-hoc templating of just ANSI colour codes from our
+// ansiColors map, using a [[colour-code]] syntax.
+func subColorCodes(in string) string {
+	// We could use text/template here, but at a certain point it feels like
+	// we're just reinventing the template string that's a const in
+	// search_alert.go. This allows us to express the colour codes in the
+	// expected string literals above while hopefully maintaining some meaning
+	// to the tests.
+	return subColorCodesRegex.ReplaceAllStringFunc(in, func(code string) string {
+		esc, ok := ansiColors[strings.Trim(code, "[]")]
+		if !ok {
+			panic(fmt.Sprintf("cannot find colour %s", code))
+		}
+		return esc
+	})
+}