apache / druid

Apache Druid: a high performance real-time analytics database.
https://druid.apache.org/
Apache License 2.0
13.52k stars 3.71k forks source link

Fix Map Lookup Introspection Endpoints and update doc for Globally Cached Lookups #17436

Closed ashwintumma23 closed 3 weeks ago

ashwintumma23 commented 3 weeks ago

Fixes #17361.

Description

jq: parse error: Invalid numeric literal at line 1, column 4

  *  `/values` returns 

curl -X GET http://localhost:8888/druid/v1/lookups/introspect/sampleMapLookup/values | jq

jq: parse error: Invalid numeric literal at line 1, column 12

  * `/` returns

curl -X GET http://localhost:8888/druid/v1/lookups/introspect/sampleMapLookup | jq { "CA": "California", "NY": "New York", "WA": "Washington" }

* This shows that only the `/` returns a valid JSON object. `/keys` and `/values` do not return a valid JSON object.
<!-- Describe the goal of this PR, what problem are you fixing. If there is a corresponding issue (referenced above), it's not necessary to repeat the description here, however, you may choose to keep one summary sentence. -->

<!-- Describe your patch: what did you change in code? How did you fix the problem? -->

<!-- If there are several relatively logically separate changes in this PR, create a mini-section for each of them. For example: -->

#### Fixed the bug ...
* Fixed the return values for `/keys` and `/values` endpoints to return a valid JSON object
* As seen in the test case updates, the return values are valid JSON objects

$ echo '["key","key2"]' | jq [ "key", "key2" ]

$ echo '["value","value2"]' | jq [ "value", "value2" ]


* Additionally, in this PR, we are also updating the documentation for Globally cached lookups `/version` endpoint. 
  * As discussed in the linked issue, we are explicitly stating that the `/version` endpoint returns the internal cache scheduler's version and not the user facing version for the lookup.
  * It is also helpful to the reader to note that the version is returned only for Globally cached lookups (`cachedNamespace`)  and not for map lookup.
<!--
In each section, please describe design decisions made, including:
 - Choice of algorithms
 - Behavioral aspects. What configuration values are acceptable? How are corner cases and error conditions handled, such as when there are insufficient resources?
 - Class organization and design (how the logic is split between classes, inheritance, composition, design patterns)
 - Method organization and design (how the logic is split between methods, parameters and return types)
 - Naming (class, method, API, configuration, HTTP endpoint, names of emitted metrics)
-->

<!-- It's good to describe an alternative design (or mention an alternative name) for every design (or naming) decision point and compare the alternatives with the designs that you've implemented (or the names you've chosen) to highlight the advantages of the chosen designs and names. -->

<!-- If there was a discussion of the design of the feature implemented in this PR elsewhere (e. g. a "Proposal" issue, any other issue, or a thread in the development mailing list), link to that discussion from this PR description and explain what have changed in your final design compared to your original proposal or the consensus version in the end of the discussion. If something hasn't changed since the original discussion, you can omit a detailed discussion of those aspects of the design here, perhaps apart from brief mentioning for the sake of readability of this PR description. -->
#### Release note

Fixed: Map Lookup Introspection API endpoints `/keys` and `/values` no longer return an invalid JSON object. 

<!-- Some of the aspects mentioned above may be omitted for simple and small changes. -->

<!-- Give your best effort to summarize your changes in a couple of sentences aimed toward Druid users. 

If your change doesn't have end user impact, you can skip this section.

For tips about how to write a good release note, see [Release notes](https://github.com/apache/druid/blob/master/CONTRIBUTING.md#release-notes).

-->

<hr>

##### Key changed/added classes in this PR
 * `MapLookupExtractorFactory.java`
 * `LookupIntrospectionResourceTest.java`

<hr>

<!-- Check the items by putting "x" in the brackets for the done things. Not all of these items apply to every PR. Remove the items which are not done or not relevant to the PR. None of the items from the checklist below are strictly necessary, but it would be very helpful if you at least self-review the PR. -->

This PR has:

- [X] been self-reviewed.
   - [ ] using the [concurrency checklist](https://github.com/apache/druid/blob/master/dev/code-review/concurrency.md) (Remove this item if the PR doesn't have any relation to concurrency.)
- [X] added documentation for new or modified features or behaviors.
- [ ] a release note entry in the PR description.
- [ ] added Javadocs for most classes and all non-trivial methods. Linked related entities via Javadoc links.
- [ ] added or updated version, license, or notice information in [licenses.yaml](https://github.com/apache/druid/blob/master/dev/license.md)
- [ ] added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
- [X] added unit tests or modified existing tests to cover new code paths, ensuring the threshold for [code coverage](https://github.com/apache/druid/blob/master/dev/code-review/code-coverage.md) is met.
- [ ] added integration tests.
- [X] been tested in a test Druid cluster.