mirror of
https://codeberg.org/redict/redict.git
synced 2025-01-22 08:08:53 -05:00
4ba47d2d21
Work in progress towards implementing a reply schema as part of COMMAND DOCS, see #9845 Since ironing the details of the reply schema of each and every command can take a long time, we would like to merge this PR when the infrastructure is ready, and let this mature in the unstable branch. Meanwhile the changes of this PR are internal, they are part of the repo, but do not affect the produced build. ### Background In #9656 we add a lot of information about Redis commands, but we are missing information about the replies ### Motivation 1. Documentation. This is the primary goal. 2. It should be possible, based on the output of COMMAND, to be able to generate client code in typed languages. In order to do that, we need Redis to tell us, in detail, what each reply looks like. 3. We would like to build a fuzzer that verifies the reply structure (for now we use the existing testsuite, see the "Testing" section) ### Schema The idea is to supply some sort of schema for the various replies of each command. The schema will describe the conceptual structure of the reply (for generated clients), as defined in RESP3. Note that the reply structure itself may change, depending on the arguments (e.g. `XINFO STREAM`, with and without the `FULL` modifier) We decided to use the standard json-schema (see https://json-schema.org/) as the reply-schema. Example for `BZPOPMIN`: ``` "reply_schema": { "oneOf": [ { "description": "Timeout reached and no elements were popped.", "type": "null" }, { "description": "The keyname, popped member, and its score.", "type": "array", "minItems": 3, "maxItems": 3, "items": [ { "description": "Keyname", "type": "string" }, { "description": "Member", "type": "string" }, { "description": "Score", "type": "number" } ] } ] } ``` #### Notes 1. It is ok that some commands' reply structure depends on the arguments and it's the caller's responsibility to know which is the relevant one. this comes after looking at other request-reply systems like OpenAPI, where the reply schema can also be oneOf and the caller is responsible to know which schema is the relevant one. 2. The reply schemas will describe RESP3 replies only. even though RESP3 is structured, we want to use reply schema for documentation (and possibly to create a fuzzer that validates the replies) 3. For documentation, the description field will include an explanation of the scenario in which the reply is sent, including any relation to arguments. for example, for `ZRANGE`'s two schemas we will need to state that one is with `WITHSCORES` and the other is without. 4. For documentation, there will be another optional field "notes" in which we will add a short description of the representation in RESP2, in case it's not trivial (RESP3's `ZRANGE`'s nested array vs. RESP2's flat array, for example) Given the above: 1. We can generate the "return" section of all commands in [redis-doc](https://redis.io/commands/) (given that "description" and "notes" are comprehensive enough) 2. We can generate a client in a strongly typed language (but the return type could be a conceptual `union` and the caller needs to know which schema is relevant). see the section below for RESP2 support. 3. We can create a fuzzer for RESP3. ### Limitations (because we are using the standard json-schema) The problem is that Redis' replies are more diverse than what the json format allows. This means that, when we convert the reply to a json (in order to validate the schema against it), we lose information (see the "Testing" section below). The other option would have been to extend the standard json-schema (and json format) to include stuff like sets, bulk-strings, error-string, etc. but that would mean also extending the schema-validator - and that seemed like too much work, so we decided to compromise. Examples: 1. We cannot tell the difference between an "array" and a "set" 2. We cannot tell the difference between simple-string and bulk-string 3. we cannot verify true uniqueness of items in commands like ZRANGE: json-schema doesn't cover the case of two identical members with different scores (e.g. `[["m1",6],["m1",7]]`) because `uniqueItems` compares (member,score) tuples and not just the member name. ### Testing This commit includes some changes inside Redis in order to verify the schemas (existing and future ones) are indeed correct (i.e. describe the actual response of Redis). To do that, we added a debugging feature to Redis that causes it to produce a log of all the commands it executed and their replies. For that, Redis needs to be compiled with `-DLOG_REQ_RES` and run with `--reg-res-logfile <file> --client-default-resp 3` (the testsuite already does that if you run it with `--log-req-res --force-resp3`) You should run the testsuite with the above args (and `--dont-clean`) in order to make Redis generate `.reqres` files (same dir as the `stdout` files) which contain request-response pairs. These files are later on processed by `./utils/req-res-log-validator.py` which does: 1. Goes over req-res files, generated by redis-servers, spawned by the testsuite (see logreqres.c) 2. For each request-response pair, it validates the response against the request's reply_schema (obtained from the extended COMMAND DOCS) 5. In order to get good coverage of the Redis commands, and all their different replies, we chose to use the existing redis test suite, rather than attempt to write a fuzzer. #### Notes about RESP2 1. We will not be able to use the testing tool to verify RESP2 replies (we are ok with that, it's time to accept RESP3 as the future RESP) 2. Since the majority of the test suite is using RESP2, and we want the server to reply with RESP3 so that we can validate it, we will need to know how to convert the actual reply to the one expected. - number and boolean are always strings in RESP2 so the conversion is easy - objects (maps) are always a flat array in RESP2 - others (nested array in RESP3's `ZRANGE` and others) will need some special per-command handling (so the client will not be totally auto-generated) Example for ZRANGE: ``` "reply_schema": { "anyOf": [ { "description": "A list of member elements", "type": "array", "uniqueItems": true, "items": { "type": "string" } }, { "description": "Members and their scores. Returned in case `WITHSCORES` was used.", "notes": "In RESP2 this is returned as a flat array", "type": "array", "uniqueItems": true, "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": [ { "description": "Member", "type": "string" }, { "description": "Score", "type": "number" } ] } } ] } ``` ### Other changes 1. Some tests that behave differently depending on the RESP are now being tested for both RESP, regardless of the special log-req-res mode ("Pub/Sub PING" for example) 2. Update the history field of CLIENT LIST 3. Added basic tests for commands that were not covered at all by the testsuite ### TODO - [x] (maybe a different PR) add a "condition" field to anyOf/oneOf schemas that refers to args. e.g. when `SET` return NULL, the condition is `arguments.get||arguments.condition`, for `OK` the condition is `!arguments.get`, and for `string` the condition is `arguments.get` - https://github.com/redis/redis/issues/11896 - [x] (maybe a different PR) also run `runtest-cluster` in the req-res logging mode - [x] add the new tests to GH actions (i.e. compile with `-DLOG_REQ_RES`, run the tests, and run the validator) - [x] (maybe a different PR) figure out a way to warn about (sub)schemas that are uncovered by the output of the tests - https://github.com/redis/redis/issues/11897 - [x] (probably a separate PR) add all missing schemas - [x] check why "SDOWN is triggered by misconfigured instance replying with errors" fails with --log-req-res - [x] move the response transformers to their own file (run both regular, cluster, and sentinel tests - need to fight with the tcl including mechanism a bit) - [x] issue: module API - https://github.com/redis/redis/issues/11898 - [x] (probably a separate PR): improve schemas: add `required` to `object`s - https://github.com/redis/redis/issues/11899 Co-authored-by: Ozan Tezcan <ozantezcan@gmail.com> Co-authored-by: Hanna Fadida <hanna.fadida@redislabs.com> Co-authored-by: Oran Agra <oran@redislabs.com> Co-authored-by: Shaya Potter <shaya@redislabs.com> |
||
|---|---|---|
| .. | ||
| commands | ||
| modules | ||
| .gitignore | ||
| acl.c | ||
| adlist.c | ||
| adlist.h | ||
| ae_epoll.c | ||
| ae_evport.c | ||
| ae_kqueue.c | ||
| ae_select.c | ||
| ae.c | ||
| ae.h | ||
| anet.c | ||
| anet.h | ||
| aof.c | ||
| asciilogo.h | ||
| atomicvar.h | ||
| bio.c | ||
| bio.h | ||
| bitops.c | ||
| blocked.c | ||
| call_reply.c | ||
| call_reply.h | ||
| childinfo.c | ||
| cli_common.c | ||
| cli_common.h | ||
| cluster.c | ||
| cluster.h | ||
| commands.c | ||
| config.c | ||
| config.h | ||
| connection.c | ||
| connection.h | ||
| connhelpers.h | ||
| crc16_slottable.h | ||
| crc16.c | ||
| crc64.c | ||
| crc64.h | ||
| crcspeed.c | ||
| crcspeed.h | ||
| db.c | ||
| debug.c | ||
| debugmacro.h | ||
| defrag.c | ||
| dict.c | ||
| dict.h | ||
| endianconv.c | ||
| endianconv.h | ||
| eval.c | ||
| evict.c | ||
| expire.c | ||
| fmacros.h | ||
| function_lua.c | ||
| functions.c | ||
| functions.h | ||
| geo.c | ||
| geo.h | ||
| geohash_helper.c | ||
| geohash_helper.h | ||
| geohash.c | ||
| geohash.h | ||
| help.h | ||
| hyperloglog.c | ||
| intset.c | ||
| intset.h | ||
| latency.c | ||
| latency.h | ||
| lazyfree.c | ||
| listpack_malloc.h | ||
| listpack.c | ||
| listpack.h | ||
| localtime.c | ||
| logreqres.c | ||
| lolwut5.c | ||
| lolwut6.c | ||
| lolwut.c | ||
| lolwut.h | ||
| lzf_c.c | ||
| lzf_d.c | ||
| lzf.h | ||
| lzfP.h | ||
| Makefile | ||
| memtest.c | ||
| mkreleasehdr.sh | ||
| module.c | ||
| monotonic.c | ||
| monotonic.h | ||
| mt19937-64.c | ||
| mt19937-64.h | ||
| multi.c | ||
| networking.c | ||
| notify.c | ||
| object.c | ||
| pqsort.c | ||
| pqsort.h | ||
| pubsub.c | ||
| quicklist.c | ||
| quicklist.h | ||
| rand.c | ||
| rand.h | ||
| rax_malloc.h | ||
| rax.c | ||
| rax.h | ||
| rdb.c | ||
| rdb.h | ||
| redis-benchmark.c | ||
| redis-check-aof.c | ||
| redis-check-rdb.c | ||
| redis-cli.c | ||
| redis-trib.rb | ||
| redisassert.c | ||
| redisassert.h | ||
| redismodule.h | ||
| release.c | ||
| replication.c | ||
| resp_parser.c | ||
| resp_parser.h | ||
| rio.c | ||
| rio.h | ||
| script_lua.c | ||
| script_lua.h | ||
| script.c | ||
| script.h | ||
| sds.c | ||
| sds.h | ||
| sdsalloc.h | ||
| sentinel.c | ||
| server.c | ||
| server.h | ||
| setcpuaffinity.c | ||
| setproctitle.c | ||
| sha1.c | ||
| sha1.h | ||
| sha256.c | ||
| sha256.h | ||
| siphash.c | ||
| slowlog.c | ||
| slowlog.h | ||
| socket.c | ||
| solarisfixes.h | ||
| sort.c | ||
| sparkline.c | ||
| sparkline.h | ||
| stream.h | ||
| strl.c | ||
| syncio.c | ||
| syscheck.c | ||
| syscheck.h | ||
| t_hash.c | ||
| t_list.c | ||
| t_set.c | ||
| t_stream.c | ||
| t_string.c | ||
| t_zset.c | ||
| testhelp.h | ||
| timeout.c | ||
| tls.c | ||
| tracking.c | ||
| unix.c | ||
| util.c | ||
| util.h | ||
| valgrind.sup | ||
| version.h | ||
| ziplist.c | ||
| ziplist.h | ||
| zipmap.c | ||
| zipmap.h | ||
| zmalloc.c | ||
| zmalloc.h | ||