Настройка базовых полей

81xx commented 2 years ago

В конфигуратор необходимо добавить следующий функционал:

[x] В директории инстанса, например, "ftx/1", должен лежать файл формата json - header.json в котором будут заданы базовые поля json. Под базовыми я имею ввиду следующие:
```
"event": "config",
"exchange": "ftx",
"node": "configurator",
"instance": "1",
"action": "send_full_config",
"message": null,
"algo": "spread_bot_cpp",
```
При поступлении запроса к определенному endpoint, например, ftx/1 конфигуратор заходит в этот файл и получает от туда названия полей для подготовки ответа. При этом необходимо учесть следующее:
[x] В этом файле могут быть описаны не все заголовке, а, например, только одно поле - "algo": "spread_bot_cpp". При такой ситуации гейт выставляет для всех остальных значений дефолтные значения, значения, которых можно взять из примера выше.
[x] Если при первом запуске конфигуратор или при первом обращении к endpoint такого файла нет, то конфигуратор должен создать этот файл заполнив поля дефолтными значениями.
[x] Поддержка не дефольных json-полей.
[x] После доработки внести описанные выше особенности в документацию, с примерами

khanbekov commented 2 years ago

последний пункт не очень понятен - в каком контексте слова sections configs неправильные? И на что их нужно исправить?

И, в каких случаях конфигуратор не должен проставлять дефолтные значения? Например, если в header.json только одно поле - он НЕ должен добавлять недостающие поля? А если в header.json нет полей с нужными названиями (т.е. у полей неизвестные и неправильные названия?

81xx commented 2 years ago

последний пункт не очень понятен - в каком контексте слова sections configs неправильные? И на что их нужно исправить?

Я не правильно прочитал доки.

81xx commented 2 years ago

И, в каких случаях конфигуратор не должен проставлять дефолтные значения? Например, если в header.json только одно поле - он НЕ должен добавлять недостающие поля? А если в header.json нет полей с нужными названиями (т.е. у полей неизвестные и неправильные названия?

если в header указано только одно поле, то остальные (необходимые) он должен выставить как дефолтные.
если в header указаны какие-то новые поля, которых нет в "базовом" формате обмена данных, он просто их добавляет.

Суть такая, это очередной файлик который позволяет делать настройки полей которые возвращает конфигуратор. Файл header предназначен для управления заголовочным json.

khanbekov commented 2 years ago

Разработал основной функционал. Только со случаем, когда в header указаны новые поля, Configurator пока не умеет работать. В таком случае, он сотрет это значение и оставит только дефолтные

81xx commented 2 years ago

Разработал основной функционал. Только со случаем, когда в header указаны новые поля, Configurator пока не умеет работать. В таком случае, он сотрет это значение и оставит только дефолтные

Ок, сообщи тогда как закончишь с полным функционалом.

khanbekov commented 2 years ago

Реализовал полный функционал и задокументировал его. Возможно, документация недостаточно полная, в таком случае буду рад обратной связи.

В процессе возникла пара проблем, т.к. Configurator использует pydantic для манипулирования данными, а он не предусматривает новые поля. Также были проблемы с тем, чтобы определить новые и старые поля в файлах header.json и перезаписывать только определенные поля и только в том случае, если этих полей не хватает.

Ссылка на вики

Ссылка на коммит

RoboTradeCode / configurator

Настройка базовых полей #27