Skip to content

[2pt] feedback: Binary protocol | Incorrect description of a greeting #2467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Tracked by #2646
TarantoolBot opened this issue Nov 25, 2021 · 0 comments · Fixed by #3151
Closed
Tracked by #2646

[2pt] feedback: Binary protocol | Incorrect description of a greeting #2467

TarantoolBot opened this issue Nov 25, 2021 · 0 comments · Fixed by #3151
Labels
factual error Factual error in functionality description reference [location] Tarantool manual, Reference part server [area] Task relates to Tarantool's server (core) functionality

Comments

@TarantoolBot
Copy link
Collaborator

TarantoolBot commented Nov 25, 2021

Product: Tarantool
Audience/target: developers
Root document: https://www.tarantool.io/en/doc/latest/dev_guide/internals/box_protocol/#box-protocol-illustration
SME: @ locker

Details

The instance's greeting message is described incorrectly.

Below is a correct detailed description from @ locker. We don't need to cite all of it in the docs, but we need to fix the existing factual errors.

Строки в приветствии две:

Консоль 1:

$ tarantool
Tarantool 2.10.0-beta1-281-g403a9799f78e
type 'help' for interactive help
tarantool> box.cfg{listen = 3301, log_level = 4}
2021-11-29 11:34:41.758 [406007] main/103/interactive C> Tarantool 2.10.0-beta1-281-g403a9799f78e
2021-11-29 11:34:41.758 [406007] main/103/interactive C> log level 4
2021-11-29 11:34:41.790 [406007] main/103/interactive C> leaving orphan mode
---
...

Консоль 2:

$ nc localhost 3301
Tarantool 2.10.0 (Binary) 29b74bed-fdc5-454c-a828-1d4bf42c639a
QK2HoFZGXTXBq2vFj7soCsHqTo6PGTF575ssUBAJLAI=

^^^ В консоли 2 появляется приветствие.

В первой строке приветствия: Tarantool <version> (<protocol>) <instance-uuid>
Во второй строке: <salt>
Соль вообще говоря необязательно фиксированного размера. Это хэш в base64 кодировке. Он может быть и больше или меньше 44 байт, но сейчас 44 байта
Обе строки добиваются до 64 байт нулями. В консоли их не видно.


<…> message, not in MsgPack format:
64-byte Greeting text line 1 Это
|64-byte Greeting text line 2 |
44-byte
base64-encoded salt
20-byte NULL

https://www.tarantool.io/en/doc/latest/dev_guide/internals/box_protocol/#box-protocol-illustration

It's just one greeting line, not two.

@patiencedaur patiencedaur added this to the Estimate [@patiencedaur] milestone Nov 26, 2021
@patiencedaur patiencedaur added factual error Factual error in functionality description reference [location] Tarantool manual, Reference part server [area] Task relates to Tarantool's server (core) functionality labels Nov 26, 2021
@patiencedaur patiencedaur changed the title feedback: Binary protocol | Tarantool feedback: Binary protocol | Incorrect description of a greeting Nov 26, 2021
@patiencedaur patiencedaur changed the title feedback: Binary protocol | Incorrect description of a greeting [2pt] feedback: Binary protocol | Incorrect description of a greeting Nov 29, 2021
@patiencedaur patiencedaur removed this from the Estimate [@patiencedaur] milestone Dec 3, 2021
patiencedaur added a commit that referenced this issue Sep 19, 2022
patiencedaur added a commit that referenced this issue Oct 4, 2022
patiencedaur added a commit that referenced this issue Oct 10, 2022
patiencedaur added a commit that referenced this issue Nov 3, 2022
Resolves #1662
Resolves #2422
Resolves #2442
Resolves #2467
Resolves #2526
Part of #2416

* Split the Binary protocol page into several sections
* Move examples to How-to
* Correct the description of the greeting
  Resolves #2467
* Elaborate on IPROTO_OPS and the different uses of IPROTO_TUPLE
* Provide missing info on keys
* Clarify Replication items in terms of whether they are a request,
  response, map, key, etc. Groom the structure accordingly
* Add PROMOTE and DEMOTE descriptions
* Bring all SQL-related info into one document
* Clarify that IPROTO_REQUEST_TYPE is used in requests and responses alike
* Improve formatting
* Add tables for uniformity
* Add UML diagram illustrations in the SVG format

Co-authored-by: Kseniia Antonova <[email protected]>
Co-authored-by: Serge Petrenko <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
factual error Factual error in functionality description reference [location] Tarantool manual, Reference part server [area] Task relates to Tarantool's server (core) functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants