[bug]: cannot unmarshal response with user data

[greg0ire]

Description

When I perform a search, and that search triggers a query rule that has a userData consequence, the SDK crashes.

I believe that's because although userData in the rule is an object, userData in the response is an array, probably in case several query rules trigger.

As a consequence, this looks wrong:

algoliasearch-client-go/algolia/search/model_search_response.go

Line 58 in 96fbba7

UserData map[string]any `json:"userData,omitempty"`

I think it should be []map[string]any.

Client

Search

Version

4.13.0

Relevant log output

…
          "userData": [
            {
              "id": 2,
              "slug": "brand-2"
            }
          ],
…


`cannot decode result: failed to unmarshal response body: failed to unmarshal SearchResponse: json: cannot unmarshal array into Go struct field _SearchResponse.userData of type map[string]interface {}`

[millotp]

Hello @greg0ire, thanks for the report, indeed this fields accepts anything, it will be fixed after algolia/api-clients-automation#4702 is released

[greg0ire]

@millotp thanks! When can I expect a release?

[millotp]

@greg0ire there will be a release later in the day !

[millotp]

Hey @greg0ire, the fix is released in 4.15.3

[greg0ire]

Thank you!

[greg0ire]

@millotp I tried the fix it works, so thanks. I think that the type could be made more precise though (any vs []map[string]any). Is that correct, and if yes, should I open a new issue?

Here is the simplest way I've found (had to resort to AI though) to do this:

        userDataInterface, ok := resp.UserData.([]interface{})
        require.True(t, ok, "User data is not of type []interface{})

	var userData []map[string]interface{}
	for _, item := range userDataInterface {
		// Convert each item to map[string]interface{}
		userItem, ok := item.(map[string]interface{})
		require.True(t, ok, "Item is not of type map[string]interface{}")
		userData = append(userData, userItem)
	}

	assert.Len(t, userData, 1)
	assert.Equal(t, "brand-2", userData[0]["slug"])
	assert.Equal(t, float64(2), userData[0]["id"])

[greg0ire]

According to what you wrote in algolia/api-clients-automation#4702, I'm wrong 😓

The userData of the index settings can be anything since it's not serialized by the API, I tried with a string, an array, and a object and they are all accepted by the API.

Still, I think it might be possible to use []any rather than just any

[millotp]

Still, I think it might be possible to use []any rather than just any

Since the API allows simple json object, this would break when trying to unmarshal it, maybe a json.RawMessage would make it easier to unmarshal into the type you need ?

[greg0ire]

Even if you push a simple json object, or even a string, I think the API is going to return a slice, to account for the case when 2 rules are triggered, right?

So maybe the best would be []json.RawMessage.

[millotp]

Maybe we are not talking about the same userData, it can be returned by the GetSettings endpoint, in which case it can be something different that an object (I checked), but in your case the result is coming from the search endpoint right ?
In this case it can also return a map[string]any when only a single rule matches your query, are you sure you can't get something other that an array ?

[greg0ire]

it can be returned by the GetSettings endpoint,

TIL

but in your case the result is coming from the search endpoint right ?

Yes exactly; I'm using it in the context of query rules.

In this case it can also return a map[string]any when only a single rule matches your query, are you sure you can't get something other that an array ?

I've written an integration test where I trigger exactly one query rule, and I still get an array. And in my experience, that's always been the case. Also the docs don't mention any special treatment when only a single rule matches.

Still in the docs items.map is used, which implies this is always going to be an array.

That's also what's documented here: https://github.com/algolia/algoliasearch-client-python/blob/a8a7f086f65c14a9a7c2d009bb650a45ce55e810/algoliasearch/search/models/consequence.py#L51 (and in other SDKs)

Here you can see an access to the first item without any check: https://github.com/algolia/voice-search-widget/blob/947767b00fa0de4a1f49135443d8368dee3aa162/public/voice-widget/voice-widget.js#L115