fix incorrect marshalling of query parameters

Author: michaeldcanady

attachment-api/attachment_request_builder_file_query_parameters.go

@@ -5,11 +5,11 @@ type AttachmentRequestBuilderFileQueryParameters struct {
 	//Specify this parameter to allow only users with the specified encryption context to access the attachment.
 	//For additional information on encryption context records,
 	// see [Encryption Support]:https://docs.servicenow.com/csh?topicname=c_EncryptionSupport&version=vancouver&pubname=vancouver-platform-security.
-	EncryptionContext string `query:"encryption_context"`
+	EncryptionContext string `url:"encryption_context"`
 	//FileName Name to give the attachment.
-	FileName string `query:"file_name"`
+	FileName string `url:"file_name"`
 	//TableName Name of the table to attach the file to.
-	TableName string `query:"table_name"`
+	TableName string `url:"table_name"`
 	//TableSysId Sys_id of the record in the table specified in table_name that you want to attach the file to.
-	TableSysId string `query:"table_sys_id"` //nolint:stylecheck
+	TableSysId string `url:"table_sys_id"` //nolint:stylecheck
 }

attachment-api/attachment_request_builder_get_query_parameters.go

@@ -2,9 +2,9 @@ package attachmentapi
 
 type AttachmentRequestBuilderGetQueryParameters struct {
 	// Limit Limit to be applied on pagination.
-	Limit int `query:"sysparm_limit"`
+	Limit int `url:"sysparm_limit"`
 	// Offset Number of records to exclude from the query. Use this parameter to get more records than specified in sysparm_limit. For example, if sysparm_limit is set to 500, but there are additional records you want to query, you can specify a sysparm_offset value of 500 to get the second set of records.
-	Offset int `query:"sysparm_offset"`
+	Offset int `url:"sysparm_offset"`
 	// Query Encoded query. Queries for the Attachment API are relative to the Attachments [sys_attachment] table.
-	Query string `query:"sysparm_query"`
+	Query string `url:"sysparm_query"`
 }

core/helper.go

@@ -2,33 +2,57 @@ package core
 
 import (
 	"encoding/json"
+	"fmt"
 	"io"
 	"net/http"
 	"reflect"
 	"strings"
 
-	"github.com/hetiansu5/urlquery"
+	"github.com/google/go-querystring/query"
 	"github.com/yosida95/uritemplate/v3"
 )
 
+func toQueryMapFromStruct(source interface{}) (map[string]string, error) {
+	queryValues, err := query.Values(source)
+	if err != nil {
+		return nil, err
+	}
+
+	queryParams := map[string]string{}
+
+	for key, values := range queryValues {
+		queryParams[key] = strings.Join(values, ",")
+	}
+
+	return queryParams, nil
+}
+
 // ToQueryMap converts a struct to query parameter map
 func ToQueryMap(source interface{}) (map[string]string, error) {
-	if source == nil {
+	var err error
+
+	if isNil(source) {
 		return nil, ErrNilSource
 	}
 
-	queryBytes, err := urlquery.Marshal(source)
-	if err != nil {
-		return nil, err
-	}
+	queryParams := make(map[string]string)
 
-	var queryMap map[string]string
-	err = urlquery.Unmarshal(queryBytes, &queryMap)
-	if err != nil {
-		return nil, err
+	sourceType := reflect.TypeOf(source)
+
+	if sourceType.Kind() != reflect.Map {
+		source, err = toQueryMapFromStruct(source)
+		if err != nil {
+			return nil, err
+		}
 	}
 
-	return queryMap, nil
+	sourceValue := reflect.ValueOf(source)
+	for _, key := range sourceValue.MapKeys() {
+		strKey := fmt.Sprintf("%v", key.Interface())
+		strValue := fmt.Sprintf("%v", sourceValue.MapIndex(key).Interface())
+		queryParams[strKey] = strValue
+	}
+	return queryParams, nil
 }
 
 // normalizeVarNames normalizes variable names for URI template expansion.

core/helper_test.go

@@ -3,9 +3,11 @@ package core
 import (
 	"crypto/rand"
 	"errors"
+	"fmt"
 	"io"
 	"math/big"
 	"net/http"
+	"reflect"
 	"strings"
 	"testing"
 
@@ -64,16 +66,16 @@ func TestToQueryMap(t *testing.T) {
 	}{
 		{
 			Input: struct {
-				Param1 string `query:"param_1"`
-				Param2 int    `query:"param_2"`
-				Param3 bool   `query:"param_3"`
+				Param1 string `url:"param_1"`
+				Param2 int    `url:"param_2"`
+				Param3 bool   `url:"param_3"`
 			}{
 				Param1: "value1",
 				Param2: 5,
 				Param3: true,
 			},
 			ShouldError: false,
-			Expected:    map[string]string{"param_1": "value1", "param_2": "5", "param_3": "1"},
+			Expected:    map[string]string{"param_1": "value1", "param_2": "5", "param_3": "true"},
 			CheckErr:    nil,
 		},
 		{
@@ -82,6 +84,14 @@ func TestToQueryMap(t *testing.T) {
 			Expected:    nil,
 			CheckErr:    func(err error) bool { return assert.Equal(t, ErrNilSource, err) },
 		},
+		{
+			Input:       "test",
+			ShouldError: true,
+			Expected:    nil,
+			CheckErr: func(err error) bool {
+				return assert.Equal(t, fmt.Errorf("query: Values() expects struct input. Got %v", reflect.String), err)
+			},
+		},
 	}
 
 	for _, input := range inputs {

core/request_information_test.go

@@ -34,7 +34,7 @@ func TestNewRequestInformationSetStreamContenr(t *testing.T) {
 
 func TestNewRequestInformationAddQueryParameters(t *testing.T) {
 	source := struct {
-		Var1 string `query:"var_1"`
+		Var1 string `url:"var_1"`
 	}{
 		Var1: "Val1",
 	}

core/url_information_test.go

@@ -186,8 +186,8 @@ func TestUrlInformationAddQueryParameters(t *testing.T) {
 	ui := NewURLInformation()
 	ui.QueryParameters = make(map[string]string)
 	source := struct {
-		Param1 string `query:"param1"`
-		Param2 string `query:"param2"`
+		Param1 string `url:"param1"`
+		Param2 string `url:"param2"`
 	}{Param1: "value1", Param2: "value2"}
 
 	err := ui.AddQueryParameters(source)

go.mod

@@ -12,6 +12,7 @@ require (
 
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/kr/pretty v0.1.0 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	golang.org/x/net v0.19.0 // indirect

go.sum

@@ -2,6 +2,9 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/gabriel-vasile/mimetype v1.4.3 h1:in2uUcidCuFcDKtdcBxlR0rJ1+fsokWf+uqxgUFjbI0=
 github.com/gabriel-vasile/mimetype v1.4.3/go.mod h1:d8uq/6HKRL6CGdk+aubisF/M5GcPfT7nKyLpA0lbSSk=
+github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
+github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
 github.com/hetiansu5/urlquery v1.2.7 h1:jn0h+9pIRqUziSPnRdK/gJK8S5TCnk+HZZx5fRHf8K0=
 github.com/hetiansu5/urlquery v1.2.7/go.mod h1:wFpZdTHRdwt7mk0EM/DdZEWtEN4xf8HJoH/BLXm/PG0=
 github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
@@ -19,6 +22,7 @@ github.com/yosida95/uritemplate/v3 v3.0.2 h1:Ed3Oyj9yrmi9087+NczuL5BwkIc4wvTb5zI
 github.com/yosida95/uritemplate/v3 v3.0.2/go.mod h1:ILOh0sOhIJR3+L/8afwt/kE++YT040gmv5BQTMR2HP4=
 golang.org/x/net v0.19.0 h1:zTwKpTd2XuCqf8huc7Fo2iSy+4RHPd10s4KzeTnVr1c=
 golang.org/x/net v0.19.0/go.mod h1:CfAk/cbD4CthTvqiEl8NpboMuiuOYsAr/7NOjZJtv1U=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

table-api/table_item_request_builder_delete_query_parameters.go

@@ -9,5 +9,5 @@ type TableItemRequestBuilderDeleteQueryParameters struct {
 	//- false: Exclude the record if it is in a domain that the currently logged in user is not configured to access.
 	//
 	//- true: Include the record even if it is in a domain that the currently logged in user is not configured to access.
-	QueryNoDomain bool `query:"sysparm_query_no_domain"`
+	QueryNoDomain bool `url:"sysparm_query_no_domain"`
 }

table-api/table_item_request_builder_delete_query_parameters_test.go

@@ -17,7 +17,7 @@ func TestTableItemRequestBuilderDeleteQueryParameters(t *testing.T) {
 		t.Error(err)
 	}
 
-	expectedValue := map[string]string{"sysparm_query_no_domain": "1"}
+	expectedValue := map[string]string{"sysparm_query_no_domain": "true"}
 
 	assert.Equal(t, expectedValue, queryMap)
 }

table-api/table_item_request_builder_get_query_parameters.go

@@ -12,25 +12,25 @@ type TableItemRequestBuilderGetQueryParameters struct {
 	//- Encrypted text: The database value is encrypted, while the displayed value is unencrypted based on the user's encryption context.
 	//
 	//- Reference fields: The database value is sys_id, but the display value is a display field of the referenced record.
-	DisplayValue DisplayValue `query:"sysparm_display_value"`
+	DisplayValue DisplayValue `url:"sysparm_display_value"`
 	//ExcludeReferenceLink flag that indicates whether to exclude Table API links for reference fields.
 	//
 	//Valid values:
 	//
 	//- true: Exclude Table API links for reference fields.
 	//
 	//- false: Include Table API links for reference fields.
-	ExcludeReferenceLink bool `query:"sysparm_exclude_reference_link"`
+	ExcludeReferenceLink bool `url:"sysparm_exclude_reference_link"`
 	// Fields list of fields to return in the response.
-	Fields []string `query:"sysparm_fields"`
+	Fields []string `url:"sysparm_fields"`
 	//Flag that indicates whether to restrict the record search to only the domains for which the logged in user is configured.
 	//
 	//Valid values:
 	//
 	//- false: Exclude the record if it is in a domain that the currently logged in user is not configured to access.
 	//
 	//- true: Include the record even if it is in a domain that the currently logged in user is not configured to access.
-	QueryNoDomain bool `query:"sysparm_query_no_domain"`
+	QueryNoDomain bool `url:"sysparm_query_no_domain"`
 	// View	UI view for which to render the data. Determines the fields returned in the response.
 	//
 	//Valid values:
@@ -39,5 +39,5 @@ type TableItemRequestBuilderGetQueryParameters struct {
 	//- mobile
 	//- both
 	//If you also specify the sysparm_fields parameter, it takes precedent.
-	View View `query:"sysparm_view"`
+	View View `url:"sysparm_view"`
 }

table-api/table_item_request_builder_put_query_parameters.go

@@ -12,26 +12,26 @@ type TableItemRequestBuilderPutQueryParameters struct {
 	//- Encrypted text: The database value is encrypted, while the displayed value is unencrypted based on the user's encryption context.
 	//
 	//- Reference fields: The database value is sys_id, but the display value is a display field of the referenced record.
-	DisplayValue DisplayValue `query:"sysparm_display_value"`
+	DisplayValue DisplayValue `url:"sysparm_display_value"`
 	//ExcludeReferenceLink flag that indicates whether to exclude Table API links for reference fields.
 	//
 	//Valid values:
 	//
 	//- true: Exclude Table API links for reference fields.
 	//
 	//- false: Include Table API links for reference fields.
-	ExcludeReferenceLink bool `query:"sysparm_exclude_reference_link"`
+	ExcludeReferenceLink bool `url:"sysparm_exclude_reference_link"`
 	// Fields list of fields to return in the response.
-	Fields            []string `query:"sysparm_fields"`
-	InputDisplayValue bool     `query:"sysparm_input_display_value"`
+	Fields            []string `url:"sysparm_fields"`
+	InputDisplayValue bool     `url:"sysparm_input_display_value"`
 	// QueryNoDomain flag that indicates whether to restrict the record search to only the domains for which the logged in user is configured.
 	//
 	//Valid values:
 	//
 	//- false: Exclude the record if it is in a domain that the currently logged in user is not configured to access.
 	//
 	//- true: Include the record even if it is in a domain that the currently logged in user is not configured to access.
-	QueryNoDomain bool `query:"sysparm_query_no_domain"`
+	QueryNoDomain bool `url:"sysparm_query_no_domain"`
 	// View	UI view for which to render the data. Determines the fields returned in the response.
 	//
 	//Valid values:
@@ -40,5 +40,5 @@ type TableItemRequestBuilderPutQueryParameters struct {
 	//- mobile
 	//- both
 	//If you also specify the sysparm_fields parameter, it takes precedent.
-	View View `query:"sysparm_view"`
+	View View `url:"sysparm_view"`
 }

table-api/table_request_builder_get_query_parameters.go

@@ -12,25 +12,25 @@ type TableRequestBuilderGetQueryParameters struct {
 	//- Encrypted text: The database value is encrypted, while the displayed value is unencrypted based on the user's encryption context.
 	//
 	//- Reference fields: The database value is sys_id, but the display value is a display field of the referenced record.
-	DisplayValue DisplayValue `query:"sysparm_display_value"`
+	DisplayValue DisplayValue `url:"sysparm_display_value,omitempty"`
 	//Flag that indicates whether to exclude Table API links for reference fields.
 	//
 	//Valid values:
 	//
 	//- true: Exclude Table API links for reference fields.
 	//
 	//- false: Include Table API links for reference fields.
-	ExcludeReferenceLink bool `query:"sysparm_exclude_reference_link"`
+	ExcludeReferenceLink bool `url:"sysparm_exclude_reference_link,omitempty"`
 	//list of fields to return in the response.
-	Fields []string `query:"sysparm_fields"`
+	Fields []string `url:"sysparm_fields,omitempty"`
 	//Flag that indicates whether to restrict the record search to only the domains for which the logged in user is configured.
 	//
 	//Valid values:
 	//
 	//- false: Exclude the record if it is in a domain that the currently logged in user is not configured to access.
 	//
 	//- true: Include the record even if it is in a domain that the currently logged in user is not configured to access.
-	QueryNoDomain bool `query:"sysparm_query_no_domain"`
+	QueryNoDomain bool `url:"sysparm_query_no_domain,omitempty"`
 	//	UI view for which to render the data. Determines the fields returned in the response.
 	//
 	//Valid values:
@@ -39,11 +39,11 @@ type TableRequestBuilderGetQueryParameters struct {
 	//- mobile
 	//- both
 	//If you also specify the sysparm_fields parameter, it takes precedent.
-	View                     View   `query:"sysparm_view"`
-	Limit                    int    `query:"sysparm_limit"`
-	NoCount                  bool   `query:"sysparm_no_count"`
-	Offset                   int    `query:"sysparm_offset"`
-	Query                    string `query:"sysparm_query"`
-	QueryCategory            string `query:"sysparm_query_category"`
-	SuppressPaginationHeader bool   `uriparameter:"sysparm_suppress_pagination_header"`
+	View                     View   `url:"sysparm_view,omitempty"`
+	Limit                    int    `url:"sysparm_limit,omitempty"`
+	NoCount                  bool   `url:"sysparm_no_count,omitempty"`
+	Offset                   int    `url:"sysparm_offset,omitempty"`
+	Query                    string `url:"sysparm_query,omitempty"`
+	QueryCategory            string `url:"sysparm_query_category,omitempty"`
+	SuppressPaginationHeader bool   `url:"sysparm_suppress_pagination_header,omitempty"`
 }

table-api/table_request_builder_post_query_parameters.go

@@ -12,18 +12,18 @@ type TableRequestBuilderPostQueryParameters struct {
 	//- Encrypted text: The database value is encrypted, while the displayed value is unencrypted based on the user's encryption context.
 	//
 	//- Reference fields: The database value is sys_id, but the display value is a display field of the referenced record.
-	DisplayValue DisplayValue `query:"sysparm_display_value"`
+	DisplayValue DisplayValue `url:"sysparm_display_value"`
 	//Flag that indicates whether to exclude Table API links for reference fields.
 	//
 	//Valid values:
 	//
 	//- true: Exclude Table API links for reference fields.
 	//
 	//- false: Include Table API links for reference fields.
-	ExcludeReferenceLink bool `query:"sysparm_exclude_reference_link"`
+	ExcludeReferenceLink bool `url:"sysparm_exclude_reference_link"`
 	//list of fields to return in the response.
-	Fields            []string `query:"sysparm_fields"`
-	InputDisplayValue bool     `query:"sysparm_input_display_value"`
+	Fields            []string `url:"sysparm_fields"`
+	InputDisplayValue bool     `url:"sysparm_input_display_value"`
 	//	UI view for which to render the data. Determines the fields returned in the response.
 	//
 	//Valid values:
@@ -32,5 +32,5 @@ type TableRequestBuilderPostQueryParameters struct {
 	//- mobile
 	//- both
 	//If you also specify the sysparm_fields parameter, it takes precedent.
-	View View `query:"sysparm_view"`
+	View View `url:"sysparm_view"`
 }

table-api/table_request_builder_post_query_paramters.go

@@ -14,18 +14,18 @@ type TableRequestBuilderPostQueryParamters struct {
 	//- Encrypted text: The database value is encrypted, while the displayed value is unencrypted based on the user's encryption context.
 	//
 	//- Reference fields: The database value is sys_id, but the display value is a display field of the referenced record.
-	DisplayValue DisplayValue `query:"sysparm_display_value"`
+	DisplayValue DisplayValue `url:"sysparm_display_value"`
 	//Flag that indicates whether to exclude Table API links for reference fields.
 	//
 	//Valid values:
 	//
 	//- true: Exclude Table API links for reference fields.
 	//
 	//- false: Include Table API links for reference fields.
-	ExcludeReferenceLink bool `query:"sysparm_exclude_reference_link"`
+	ExcludeReferenceLink bool `url:"sysparm_exclude_reference_link"`
 	//list of fields to return in the response.
-	Fields            []string `query:"sysparm_fields"`
-	InputDisplayValue bool     `query:"sysparm_input_display_value"`
+	Fields            []string `url:"sysparm_fields"`
+	InputDisplayValue bool     `url:"sysparm_input_display_value"`
 	//	UI view for which to render the data. Determines the fields returned in the response.
 	//
 	//Valid values:
@@ -34,5 +34,5 @@ type TableRequestBuilderPostQueryParamters struct {
 	//- mobile
 	//- both
 	//If you also specify the sysparm_fields parameter, it takes precedent.
-	View View `query:"sysparm_view"`
+	View View `url:"sysparm_view"`
 }