Skip fetching selected repo info when not a tty

joshmgross · web-flow · commit 5b6827ac4091 · 2021-11-11T19:14:02.000Z
When list secret is run outside the context of a tty, the selected
repository count is not shown.
Since fetching this information is an extra API call per secret,
we should skip fetching it when it's not needed.
diff --git a/pkg/cmd/secret/list/list.go b/pkg/cmd/secret/list/list.go
@@ -90,6 +90,7 @@ func listRun(opts *ListOptions) error {
 	}
 
 	var secrets []*Secret
+	showSelectedRepoInfo := opts.IO.IsStdoutTTY()
 	if orgName == "" && !opts.UserSecrets {
 		if envName == "" {
 			secrets, err = getRepoSecrets(client, baseRepo)
@@ -111,9 +112,9 @@ func listRun(opts *ListOptions) error {
 		}
 
 		if opts.UserSecrets {
-			secrets, err = getUserSecrets(client, host)
+			secrets, err = getUserSecrets(client, host, showSelectedRepoInfo)
 		} else {
-			secrets, err = getOrgSecrets(client, host, orgName)
+			secrets, err = getOrgSecrets(client, host, orgName, showSelectedRepoInfo)
 		}
 	}
 
@@ -130,7 +131,7 @@ func listRun(opts *ListOptions) error {
 		}
 		tp.AddField(updatedAt, nil, nil)
 		if secret.Visibility != "" {
-			if opts.IO.IsStdoutTTY() {
+			if showSelectedRepoInfo {
 				tp.AddField(fmtVisibility(*secret), nil, nil)
 			} else {
 				tp.AddField(strings.ToUpper(string(secret.Visibility)), nil, nil)
@@ -171,29 +172,32 @@ func fmtVisibility(s Secret) string {
 	return ""
 }
 
-func getOrgSecrets(client httpClient, host, orgName string) ([]*Secret, error) {
+func getOrgSecrets(client httpClient, host, orgName string, showSelectedRepoInfo bool) ([]*Secret, error) {
 	secrets, err := getSecrets(client, host, fmt.Sprintf("orgs/%s/actions/secrets", orgName))
 	if err != nil {
 		return nil, err
 	}
 
-	err = getSelectedRepositoryInformation(client, secrets)
-	if err != nil {
-		return nil, err
+	if showSelectedRepoInfo {
+		err = getSelectedRepositoryInformation(client, secrets)
+		if err != nil {
+			return nil, err
+		}
 	}
-
 	return secrets, nil
 }
 
-func getUserSecrets(client httpClient, host string) ([]*Secret, error) {
+func getUserSecrets(client httpClient, host string, showSelectedRepoInfo bool) ([]*Secret, error) {
 	secrets, err := getSecrets(client, host, "user/codespaces/secrets")
 	if err != nil {
 		return nil, err
 	}
 
-	err = getSelectedRepositoryInformation(client, secrets)
-	if err != nil {
-		return nil, err
+	if showSelectedRepoInfo {
+		err = getSelectedRepositoryInformation(client, secrets)
+		if err != nil {
+			return nil, err
+		}
 	}
 
 	return secrets, nil
diff --git a/pkg/cmd/secret/list/list_test.go b/pkg/cmd/secret/list/list_test.go
@@ -234,11 +234,13 @@ func Test_listRun(t *testing.T) {
 				}
 				path = fmt.Sprintf("orgs/%s/actions/secrets", tt.opts.OrgName)
 
-				reg.Register(
-					httpmock.REST("GET", fmt.Sprintf("orgs/%s/actions/secrets/SECRET_THREE/repositories", tt.opts.OrgName)),
-					httpmock.JSONResponse(struct {
-						TotalCount int `json:"total_count"`
-					}{2}))
+				if tt.tty {
+					reg.Register(
+						httpmock.REST("GET", fmt.Sprintf("orgs/%s/actions/secrets/SECRET_THREE/repositories", tt.opts.OrgName)),
+						httpmock.JSONResponse(struct {
+							TotalCount int `json:"total_count"`
+						}{2}))
+				}
 			}
 
 			if tt.opts.UserSecrets {
@@ -264,15 +266,17 @@ func Test_listRun(t *testing.T) {
 				}
 
 				path = "user/codespaces/secrets"
-				for i, secret := range payload.Secrets {
-					hostLen := len("https://api.github.com/")
-					path := secret.SelectedReposURL[hostLen:len(secret.SelectedReposURL)]
-					repositoryCount := i + 1
-					reg.Register(
-						httpmock.REST("GET", path),
-						httpmock.JSONResponse(struct {
-							TotalCount int `json:"total_count"`
-						}{repositoryCount}))
+				if tt.tty {
+					for i, secret := range payload.Secrets {
+						hostLen := len("https://api.github.com/")
+						path := secret.SelectedReposURL[hostLen:len(secret.SelectedReposURL)]
+						repositoryCount := i + 1
+						reg.Register(
+							httpmock.REST("GET", path),
+							httpmock.JSONResponse(struct {
+								TotalCount int `json:"total_count"`
+							}{repositoryCount}))
+					}
 				}
 			}
 
