Exporting gh secret list should always provide number of selected repositories #8679

Activity

1. nvincent-vossloh

   added

   bugSomething isn't workingSomething isn't working

   on Feb 9, 2024
2. cliAutomation

   added

   needs-triageneeds to be reviewedneeds to be reviewed

   on Feb 9, 2024
3. andyfeller commented on Feb 12, 2024

   

   andyfeller

   on Feb 12, 2024

   Last edited by andyfeller

   Contributor

   More actions

   @nvincent-vossloh : thank you for opening up this issue! 🙇

   After digging into the code a bit, I think I know where this is happening, which dates back to the origin of the command in #4714:

   cli/pkg/cmd/secret/list/list.go

   Lines 117 to 141 in 8948ee8

   	var secrets []Secret
   	showSelectedRepoInfo := opts.IO.IsStdoutTTY()
   	switch secretEntity {
   	case shared.Repository:
   	secrets, err = getRepoSecrets(client, baseRepo, secretApp)
   	case shared.Environment:
   	secrets, err = getEnvSecrets(client, baseRepo, envName)
   	case shared.Organization, shared.User:
   	var cfg config.Config
   	var host string
   	cfg, err = opts.Config()
   	if err != nil {
   	return err
   	}
   	host, _ = cfg.Authentication().DefaultHost()
   	if secretEntity == shared.User {
   	secrets, err = getUserSecrets(client, host, showSelectedRepoInfo)
   	} else {
   	secrets, err = getOrgSecrets(client, host, orgName, showSelectedRepoInfo, secretApp)
   	}
   	}

   The code currently uses whether a TTY to show selected repository information or not. I'm going to follow up regarding the concern and if there are any issues with relaxing that requirement. 👍

   Update

   TLDR: We could relax this requirement, but it will increase API requests used. Additionally, it appears gh secret list will only pull up to 100 secrets.

   Once secrets are retrieved, secondary enrichment of secrets will attempt to add number of repositories selected if relevant and depending on TTY. Depending on whether you are using a PAT versus a GitHub App installation access token, that will just quicken the request per hour used.

   cli/pkg/cmd/secret/list/list.go

   Lines 276 to 291 in 8948ee8

   	func populateSelectedRepositoryInformation(client *http.Client, host string, secrets []Secret) error {
   	apiClient := api.NewClientFromHTTP(client)
   	for i, secret := range secrets {
   	if secret.SelectedReposURL == "" {
   	continue
   	}
   	response := struct {
   	TotalCount int `json:"total_count"`
   	}{}
   	if err := apiClient.REST(host, "GET", secret.SelectedReposURL, nil, &response); err != nil {
   	return fmt.Errorf("failed determining selected repositories for %s: %w", secret.Name, err)
   	}
   	secrets[i].NumSelectedRepos = response.TotalCount
   	}
   	return nil
   	}

   Lastly, it appears gh secret list is hard coded to pull a single 100 page of secrets from the API. In the case of limits of GitHub Actions secrets, an organization can have up to 1,000.

   cli/pkg/cmd/secret/list/list.go

   Lines 258 to 274 in 8948ee8

   	func getSecrets(client *http.Client, host, path string) ([]Secret, error) {
   	var results []Secret
   	apiClient := api.NewClientFromHTTP(client)
   	path = fmt.Sprintf("%s?per_page=100", path)
   	for path != "" {
   	response := struct {
   	Secrets []Secret
   	}{}
   	var err error
   	path, err = apiClient.RESTWithNext(host, "GET", path, nil, &response)
   	if err != nil {
   	return nil, err
   	}
   	results = append(results, response.Secrets...)
   	}
   	return results, nil
   	}

   🎉React with 🎉1Reacted by Nicolas VINCENT
4. andyfeller

   added

   priority-3Affects a small number of users or is largely cosmeticAffects a small number of users or is largely cosmetic

   help wantedContributions welcomeContributions welcome

   gh-secretrelating to the gh secret commandrelating to the gh secret command

   and removed

   needs-triageneeds to be reviewedneeds to be reviewed

   on Feb 12, 2024
5. andyfeller

   changed the title [-]inconsistent json output for integer values when stdout sent to a pipe[/-] [+]Exporting `gh secret list` should always provide number of selected repositories[/+] on Feb 12, 2024
6. babakks commented on Apr 1, 2024

   

   babakks

   on Apr 1, 2024

   Member

   More actions

   @andyfeller I just submitted a PR to fix this. Thanks for the hint.
7. babakks commented on Apr 1, 2024

   

   babakks

   on Apr 1, 2024

   Last edited by babakks

   Member

   More actions

   Lastly, it appears gh secret list is hard coded to pull a single 100 page of secrets from the API. In the case of limits of GitHub Actions secrets, an organization can have up to 1,000.

   @andyfeller But that happens in a loop, so it'll fetch all secrets, right? Or I'm missing something?
8. andyfeller

   closed this as completedin #8899on Apr 9, 2024