SearchResponse.Documents throws null reference exception on successful call

[stromblom]

Elastic.Clients.Elasticsearch version:
8.15.5

Description of the problem including expected versus actual behavior:
SearchResponse.Documents throws a null ref exception because HitsMetadata is null (and/or possibly HitsMetadata.Hits).

Stacktrace:
at Elastic.Clients.Elasticsearch.SearchResponse`1.get_Documents() in /_/src/Elastic.Clients.Elasticsearch.Shared/Api/SearchResponse.cs:line 21

Expected behavior
Should not throw an exception. HitsMetadata/Hits being null should be handled gracefully.
The Documents property and also Hits property should handle HitsMetadata being null and also declare correct nullability.

[lucacremonesi]

From Microsoft's Property Design - Framework Design Guidelines:

❌ AVOID throwing exceptions from property getters.
Property getters should be simple operations and should not have any preconditions. If a getter can throw an exception, it should probably be redesigned to be a method.

[flobernd]

Thanks @lucacremonesi but not sure what your intention is with posting this quote?

This issue is marked as "bug" which should make it clear that this exception is not thrown by design 😉

[flobernd]

@stromblom @lucacremonesi Would it be possible for you to send me the JSON request and response that triggers this behavior?

We are currently investigating this issue, since HitsMetadata is not expected to be null.

[flobernd]

@stromblom @lucacremonesi We were not able to reproduce this behavior. It would be great, if you could provide a reproducer.

[github-actions]

This issue is stale because it has been open 5 days with no activity. Remove stale label or comment or this will be closed in 2 days.

[github-actions]

This issue was closed because it has been stalled for 2 days with no activity.