Slight refactor to GraphQL helper, review feedback on current_user

Author: RicePatrick

internal/provider/data_source_gitlab_current_user.go

@@ -11,9 +11,9 @@ import (
 
 var _ = registerDataSource("gitlab_current_user", func() *schema.Resource {
 	return &schema.Resource{
-		Description: `The ` + "`gitlab_current_user`" + ` data source allows details of the current user (determined by the input provider token) to be retrieved.
+		Description: `The ` + "`gitlab_current_user`" + ` data source allows details of the current user (determined by ` + "`token`" + ` provider attribute) to be retrieved.
 
-**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/graphql/reference/index.html#querycurrentuser)`,
+**Upstream API**: [GitLab GraphQL API docs](https://docs.gitlab.com/ee/api/graphql/reference/index.html#querycurrentuser)`,
 
 		ReadContext: dataSourceGitlabCurrentUserRead,
 		Schema: map[string]*schema.Schema{
@@ -28,7 +28,7 @@ var _ = registerDataSource("gitlab_current_user", func() *schema.Resource {
 				Computed:    true,
 			},
 			"name": {
-				Description: "Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project. ",
+				Description: "Human-readable name of the user. Returns **** if the user is a project bot and the requester does not have permission to view the project.",
 				Type:        schema.TypeString,
 				Computed:    true,
 			},
@@ -60,13 +60,12 @@ func dataSourceGitlabCurrentUserRead(ctx context.Context, d *schema.ResourceData
 	client := meta.(*gitlab.Client)
 
 	query := GraphQLQuery{
-		`query {currentUser {name, bot, groupCount, id, namespace{id} publicEmail, username}}`,
+		`query {currentUser {name, bot, groupCount, id, namespace{id}, publicEmail, username}}`,
 	}
 	log.Printf("[DEBUG] executing GraphQL Query %s to retrieve current user", query.Query)
 
 	var response CurrentUserResponse
-	_, err := SendGraphQLRequest(context.Background(), client, query, &response)
-	if err != nil {
+	if _, err := SendGraphQLRequest(ctx, client, query, &response); err != nil {
 		return diag.FromErr(err)
 	}
 

internal/provider/graphql_helper.go

@@ -7,24 +7,20 @@ import (
 )
 
 // Helper method for modifying client requests appropriately for sending a GraphQL call instead of a REST call.
-func SendGraphQLRequest(ctx context.Context, client *gitlab.Client, graphQLCall GraphQLQuery, objectToParseForResponse interface{}) (interface{}, error) {
-
-	request, err := client.NewRequest("POST", "", graphQLCall, nil)
-	//Overwrite the path of the existing request, as otherwise the client appends /api/v4 instead.
-	request.URL.Path = "/api/graphql"
+func SendGraphQLRequest(ctx context.Context, client *gitlab.Client, query GraphQLQuery, response interface{}) (interface{}, error) {
+	request, err := client.NewRequest("POST", "", query, nil)
 	if err != nil {
 		return nil, err
 	}
-
-	_, err = client.Do(request, objectToParseForResponse)
-	if err != nil {
+	// Overwrite the path of the existing request, as otherwise the go-gitlab client appends /api/v4 instead.
+	request.URL.Path = "/api/graphql"
+	if _, err = client.Do(request, response); err != nil {
 		return nil, err
 	}
-
-	return objectToParseForResponse, nil
+	return response, nil
 }
 
-// Represents a GraphQL call to the API. All graphQL calls are a string passed to the "query" parameter, so they should be included here.
+// Represents a GraphQL call to the API. All GraphQL calls are a string passed to the "query" parameter, so they should be included here.
 type GraphQLQuery struct {
 	Query string `json:"query"`
 }