Ensure efficient resolving of issue/pr create metadata to GraphQL IDs

mislav · mislav · commit bb0ab3a2d98e · 2020-12-03T18:55:46.000+01:00
For metadata types chosen in interactive flow, we fetch all records from
the API in order to be able to display a multi-select interface.

For metadata defined via command-line flags, we resolve records that can
be looked up directly, avoiding fetching the entirety of expensive
datasets (e.g. all members of an organization) if we can.

The new approach ensures efficient fetching when interactive flow is
combined with values from flags.
diff --git a/api/queries_repo.go b/api/queries_repo.go
@@ -464,6 +464,28 @@ func (m *RepoMetadataResult) MilestoneToID(title string) (string, error) {
 	return "", errors.New("not found")
 }
 
+func (m *RepoMetadataResult) Merge(m2 *RepoMetadataResult) {
+	if len(m2.AssignableUsers) > 0 || len(m.AssignableUsers) == 0 {
+		m.AssignableUsers = m2.AssignableUsers
+	}
+
+	if len(m2.Teams) > 0 || len(m.Teams) == 0 {
+		m.Teams = m2.Teams
+	}
+
+	if len(m2.Labels) > 0 || len(m.Labels) == 0 {
+		m.Labels = m2.Labels
+	}
+
+	if len(m2.Projects) > 0 || len(m.Projects) == 0 {
+		m.Projects = m2.Projects
+	}
+
+	if len(m2.Milestones) > 0 || len(m.Milestones) == 0 {
+		m.Milestones = m2.Milestones
+	}
+}
+
 type RepoMetadataInput struct {
 	Assignees  bool
 	Reviewers  bool
diff --git a/pkg/cmd/pr/shared/params.go b/pkg/cmd/pr/shared/params.go
@@ -37,25 +37,53 @@ func WithPrAndIssueQueryParams(baseURL string, state IssueMetadataState) (string
 	return u.String(), nil
 }
 
+// Ensure that tb.MetadataResult object exists and contains enough pre-fetched API data to be able
+// to resolve all object listed in tb to GraphQL IDs.
+func fillMetadata(client *api.Client, baseRepo ghrepo.Interface, tb *IssueMetadataState) error {
+	resolveInput := api.RepoResolveInput{}
+
+	if len(tb.Assignees) > 0 && (tb.MetadataResult == nil || len(tb.MetadataResult.AssignableUsers) == 0) {
+		resolveInput.Assignees = tb.Assignees
+	}
+
+	if len(tb.Reviewers) > 0 && (tb.MetadataResult == nil || len(tb.MetadataResult.AssignableUsers) == 0) {
+		resolveInput.Reviewers = tb.Reviewers
+	}
+
+	if len(tb.Labels) > 0 && (tb.MetadataResult == nil || len(tb.MetadataResult.Labels) == 0) {
+		resolveInput.Labels = tb.Labels
+	}
+
+	if len(tb.Projects) > 0 && (tb.MetadataResult == nil || len(tb.MetadataResult.Projects) == 0) {
+		resolveInput.Projects = tb.Projects
+	}
+
+	if len(tb.Milestones) > 0 && (tb.MetadataResult == nil || len(tb.MetadataResult.Milestones) == 0) {
+		resolveInput.Milestones = tb.Milestones
+	}
+
+	metadataResult, err := api.RepoResolveMetadataIDs(client, baseRepo, resolveInput)
+	if err != nil {
+		return err
+	}
+
+	if tb.MetadataResult == nil {
+		tb.MetadataResult = metadataResult
+	} else {
+		tb.MetadataResult.Merge(metadataResult)
+	}
+
+	return nil
+}
+
 func AddMetadataToIssueParams(client *api.Client, baseRepo ghrepo.Interface, params map[string]interface{}, tb *IssueMetadataState) error {
 	if !tb.HasMetadata() {
 		return nil
 	}
 
-	if tb.MetadataResult == nil {
-		resolveInput := api.RepoResolveInput{
-			Reviewers:  tb.Reviewers,
-			Assignees:  tb.Assignees,
-			Labels:     tb.Labels,
-			Projects:   tb.Projects,
-			Milestones: tb.Milestones,
-		}
-
-		var err error
-		tb.MetadataResult, err = api.RepoResolveMetadataIDs(client, baseRepo, resolveInput)
-		if err != nil {
-			return err
-		}
+	err := fillMetadata(client, baseRepo, tb)
+	if err != nil {
+		return err
 	}
 
 	assigneeIDs, err := tb.MetadataResult.MembersToIDs(tb.Assignees)
diff --git a/pkg/cmd/pr/shared/survey.go b/pkg/cmd/pr/shared/survey.go
@@ -263,13 +263,6 @@ func MetadataSurvey(io *iostreams.IOStreams, client *api.Client, baseRepo ghrepo
 		milestones = append(milestones, m.Title)
 	}
 
-	type metadataValues struct {
-		Reviewers []string
-		Assignees []string
-		Labels    []string
-		Projects  []string
-		Milestone string
-	}
 	var mqs []*survey.Question
 	if isChosen("Reviewers") {
 		if len(users) > 0 || len(teams) > 0 {
@@ -346,33 +339,39 @@ func MetadataSurvey(io *iostreams.IOStreams, client *api.Client, baseRepo ghrepo
 		}
 	}
 
-	if len(mqs) > 0 {
-		values := metadataValues{
-			Reviewers: state.Reviewers,
-			Assignees: state.Assignees,
-			Labels:    state.Labels,
-			Projects:  state.Projects,
-		}
-		if len(state.Milestones) > 0 {
-			values.Milestone = state.Milestones[0]
-		}
+	values := struct {
+		Reviewers []string
+		Assignees []string
+		Labels    []string
+		Projects  []string
+		Milestone string
+	}{}
 
-		err = prompt.SurveyAsk(mqs, &values, survey.WithKeepFilter(true))
-		if err != nil {
-			return fmt.Errorf("could not prompt: %w", err)
-		}
+	err = prompt.SurveyAsk(mqs, &values, survey.WithKeepFilter(true))
+	if err != nil {
+		return fmt.Errorf("could not prompt: %w", err)
+	}
 
+	if isChosen("Reviewers") {
 		state.Reviewers = values.Reviewers
+	}
+	if isChosen("Assignees") {
 		state.Assignees = values.Assignees
+	}
+	if isChosen("Labels") {
 		state.Labels = values.Labels
+	}
+	if isChosen("Projects") {
 		state.Projects = values.Projects
+	}
+	if isChosen("Milestone") {
 		if values.Milestone != "" && values.Milestone != noMilestone {
 			state.Milestones = []string{values.Milestone}
+		} else {
+			state.Milestones = []string{}
 		}
 	}
 
-	state.MetadataResult = nil
-
 	return nil
 }
 
