Support for additional queue arguments

[klokare]

Is your feature request related to a problem? Please describe.

The Streams Documentation describes addtional queue arguments like

• x-max-length-bytes
• x-max-age
• x-stream-max-segment-size-bytes
• etc.

But the StreamQueueSpecification does not have these options.

type StreamQueueSpecification struct {
	Name               [string](https://pkg.go.dev/builtin#string)
	MaxLengthBytes     [int64](https://pkg.go.dev/builtin#int64)
	InitialClusterSize [int](https://pkg.go.dev/builtin#int)
}

Is there another way to set these options during/post Queue creation AmqpManagement.DeclareQueue? If not, may we add as a feature request?

Describe the solution you'd like

Perhaps composable QueueSpecifications that satisfy IQueueSpecification:

streamSpec := StreamQueueSpecification{Name: "mystream"}
advStreamSpec := AdvancedStreamQueueSpecification{MaxAge: 20}

queueSpec :=MakeQueueSpecification(streamSpec, advStreamSpec)

or a chained approach

streamSpec := StreamQueueSpecification{Name: "mystream"}
streamSpec = streamSpec.WithMaxAge(20) // Returns a StreamQueueSpecification with the x-max-age added to the buildArguments map.

Describe alternatives you've considered

I could use the older 0.9.1 or Streams clients to create the stream and then use this client to interact with it.

Additional context

No response

[klokare]

It would API breaking to change the struct, but would now be the good time to change the struct and buildArguments method?

type StreamQueueSpecification struct {
	Name               string
	MaxLengthBytes     int64
	MaxAge             int
	InitialClusterSize int
}

func (s *StreamQueueSpecification) name() string {
	return s.Name
}

func (s *StreamQueueSpecification) isAutoDelete() bool {
	return false
}

func (s *StreamQueueSpecification) isExclusive() bool {
	return false
}

func (s *StreamQueueSpecification) queueType() QueueType {
	return QueueType{Type: Stream}
}

func (s *StreamQueueSpecification) buildArguments() map[string]any {
	result := map[string]any{}

	if s.MaxLengthBytes != 0 {
		result["x-max-length-bytes"] = s.MaxLengthBytes
	}

	if s.InitialClusterSize != 0 {
		result["x-stream-initial-cluster-size"] = s.InitialClusterSize
	}

	if s.MaxAge != 0 {
		result["x-max-age"] = s.MaxAge
	}


	result["x-queue-type"] = s.queueType().String()

	return result
}

[mkuratczyk]

Personally I'm in favour of making some breaking changes soon. I have a refactor (vibe coded for now, just to see what it'd look like) to remove the dotNETisms from the client, which involves a lot of renaming.

Moreover, I think this library is indeed too strict - it currently doesn't allow for some queue arguments as you noticed and lacks an option to apply "unknown" arguments. This is true in other places as well - I believe a queue type of "unknown" type cannot be declared either, even though a plugin can introduce a non-standard queue type.

So yes, I think we should make some breaking changes and make this library more idiomatic and more flexible. However, keep in mind that there's A LOT of work going on in multiple libraries that mostly @Gsantomaggio maintains, so contributions would be very much appreciated.

[Gsantomaggio]

Thanks @klokare and @mkuratczyk

At the moment, you can add the Arguments you want:

rabbitmq-amqp-go-client/pkg/rabbitmqamqp/entities.go

Lines 307 to 312 in c8d3639

	type StreamQueueSpecification struct {
	Name string
	MaxLengthBytes int64
	InitialClusterSize int
	Arguments map[string]any
	}

but feel free to add the fields you need. In this library, I'd like to avoid builders like:

streamSpec := StreamQueueSpecification{Name: "mystream"}
advStreamSpec := AdvancedStreamQueueSpecification{MaxAge: 20}

queueSpec :=MakeQueueSpecification(streamSpec, advStreamSpec)

And leave the user to use the structs like:

&rmq.StreamQueueSpecification{
		Name: "myStream",
		MaxLengthBytes: rmq.CapacityGB(5),
	})

We can add builders and other helpers in some wrapper or high-level structs but not in the lib now.
Thank you!

[klokare]

I like to avoid builders and chains, too. I was just trying to think of ways not to break things. I will try switching to the branch to which you linked and use the Arguments map. Thanks!

[Gsantomaggio]

Well, you can add the missing parameters here:

type StreamQueueSpecification struct { 
 	Name               string 
 	MaxLengthBytes     int64 
 	InitialClusterSize int 
       MaxAge // <-- this 
       MaxSegmentSizeBytes // <-- this 
      /// and others :)
 	Arguments          map[string]any 
 } 

Thank you!