fix: adding middleware with options errors with "unsupported option type"

Author: jsenko

compression_handler.go

@@ -32,8 +32,8 @@ var compressKey = abstractions.RequestOptionKey{Key: "CompressionHandler"}
 
 // NewCompressionHandler creates an instance of a compression middleware
 func NewCompressionHandler() *CompressionHandler {
-	options := NewCompressionOptions(true)
-	return NewCompressionHandlerWithOptions(options)
+	options := NewCompressionOptionsReference(true)
+	return NewCompressionHandlerWithOptions(*options)
 }
 
 // NewCompressionHandlerWithOptions creates an instance of the compression middleware with
@@ -43,10 +43,22 @@ func NewCompressionHandlerWithOptions(option CompressionOptions) *CompressionHan
 }
 
 // NewCompressionOptions creates a configuration object for the CompressionHandler
+//
+// Deprecated: This function is deprecated, and superseded by NewCompressionOptionsReference,
+// which returns a pointer instead of plain value.
 func NewCompressionOptions(enableCompression bool) CompressionOptions {
 	return CompressionOptions{enableCompression: enableCompression}
 }
 
+// NewCompressionOptionsReference creates a configuration object for the CompressionHandler.
+//
+// This function supersedes the NewCompressionOptions function and returns a pointer,
+// which is expected by GetDefaultMiddlewaresWithOptions.
+func NewCompressionOptionsReference(enableCompression bool) *CompressionOptions {
+	options := CompressionOptions{enableCompression: enableCompression}
+	return &options
+}
+
 // GetKey returns CompressionOptions unique name in context object
 func (o CompressionOptions) GetKey() abstractions.RequestOptionKey {
 	return compressKey

kiota_client_factory.go

@@ -98,6 +98,9 @@ func GetDefaultMiddlewaresWithOptions(requestOptions ...abs.RequestOption) ([]Mi
 			middlewareMap[redirectKeyValue] = NewRedirectHandlerWithOptions(*v)
 		case *CompressionOptions:
 			middlewareMap[compressKey] = NewCompressionHandlerWithOptions(*v)
+		case CompressionOptions:
+			println("deprecation notice: function GetDefaultMiddlewaresWithOptions expects a pointer to CompressionOptions. Use the NewCompressionOptionsReference convenience function.")
+			middlewareMap[compressKey] = NewCompressionHandlerWithOptions(v)
 		case *ParametersNameDecodingOptions:
 			middlewareMap[parametersNameDecodingKeyValue] = NewParametersNameDecodingHandlerWithOptions(*v)
 		case *UserAgentHandlerOptions:

kiota_client_factory_test.go

@@ -20,7 +20,7 @@ func TestGetDefaultMiddleWareWithMultipleOptions(t *testing.T) {
 			return true
 		},
 	}
-	compressionOptions := NewCompressionOptions(false)
+	compressionOptions := NewCompressionOptionsReference(false)
 	parametersNameDecodingOptions := ParametersNameDecodingOptions{
 		Enable:             true,
 		ParametersToDecode: []byte{'-', '.', '~', '$'},
@@ -36,7 +36,7 @@ func TestGetDefaultMiddleWareWithMultipleOptions(t *testing.T) {
 	}
 	options, err := GetDefaultMiddlewaresWithOptions(&retryOptions,
 		&redirectHandlerOptions,
-		&compressionOptions,
+		compressionOptions,
 		&parametersNameDecodingOptions,
 		&userAgentHandlerOptions,
 		&headersInspectionOptions,
@@ -67,19 +67,28 @@ func TestGetDefaultMiddleWareWithInvalidOption(t *testing.T) {
 }
 
 func TestGetDefaultMiddleWareWithOptions(t *testing.T) {
+	compression := NewCompressionOptionsReference(false)
+	options, err := GetDefaultMiddlewaresWithOptions(compression)
+	verifyMiddlewareWithDisabledCompression(t, options, err)
+}
+
+func TestGetDefaultMiddleWareWithOptionsDeprecated(t *testing.T) {
 	compression := NewCompressionOptions(false)
-	options, err := GetDefaultMiddlewaresWithOptions(&compression)
+	options, err := GetDefaultMiddlewaresWithOptions(compression)
+	verifyMiddlewareWithDisabledCompression(t, options, err)
+}
+
+func verifyMiddlewareWithDisabledCompression(t *testing.T, options []Middleware, err error) {
 	if err != nil {
 		t.Errorf(err.Error())
 	}
 	if len(options) != 6 {
 		t.Errorf("expected 6 middleware, got %v", len(options))
 	}
-
 	for _, element := range options {
 		switch v := element.(type) {
 		case *CompressionHandler:
-			assert.Equal(t, v.options.ShouldCompress(), compression.ShouldCompress())
+			assert.Equal(t, v.options.ShouldCompress(), false)
 		}
 	}
 }