erius/shad-go
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
shad-go/distbuild/pkg/api
History
Arseny Balobanov 28564b4257 go fix old build tags.
2022-03-15 23:49:56 +03:00
..
mock Finish distbuild/api 2020-04-04 19:21:47 +03:00
build.go Improve tests 2020-04-04 23:11:21 +03:00
build_client.go go fix old build tags. 2022-03-15 23:49:56 +03:00
build_handler.go go fix old build tags. 2022-03-15 23:49:56 +03:00
build_test.go distbuild/pkg/api/build_test.go TestBuildRunning - fix order in require.Equal 2022-02-15 13:29:36 +03:00
heartbeat.go fix distbuild/pkg/api heartbeat.go 2022-02-15 13:33:35 +03:00
heartbeat_client.go go fix old build tags. 2022-03-15 23:49:56 +03:00
heartbeat_handler.go go fix old build tags. 2022-03-15 23:49:56 +03:00
heartbeat_test.go Finish distbuild/api 2020-04-04 19:21:47 +03:00
README.md fix typo in distbuild/pkg/api 2022-03-08 18:58:18 +03:00

README.md

api

Пакет api реализует протокол, по которому общаются компоненты системы.

Этот пакет не занимается передачей файлов и артефактов, соответствующие функции находятся в пакетах filecache и artifact.

Worker <-> Coordinator

  • Worker и Coordinator общаются через один запрос POST /heartbeat.
  • Worker посылает HeartbeatRequest и получает в ответ HeartbeatResponse.
  • Запрос и ответ передаются в формате json.
  • Ошибка обработки heartbeat передаётся как текстовая строка.

Client <-> Coordinator

Client и Coordinator общаются через два вызова.

  • POST /build - стартует новый билд.

    • Client посылает в Body запроса json c описанием сборки.
    • Coordinator стримит в body ответа json сообщения, описывающие прогресс сборки.
    • Первым сообщением в ответе Coordinator присылает buildID.
    • Тут можно было бы использовать websocket, но нас устраивает более простое решение.

  • POST /signal?build_id=12345 - посылает сигнал бегущему билду.

    • Запрос и ответ передаются в формате json.

Замечания

  • Конструкторы клиентов и хендлеров принимают первым параметром *zap.Logger. Запишите в лог события получения/отправки запроса и все ошибки. Это поможет вам отлаживать интеграционные тесты в следующей части задания.

  • Все методы должны "пробрасывать" контекст.

    • Контекст на клиенте нужно передать в функцию http.NewRequestWithContext.
    • Контекст на сервере нужно получить из r.Context() и передать в Service.

  • Код в этом пакете не должен запускать новые горутины.

  • Ошибку из Service.StartBuild нужно посылать клиенту. Если эта ошибка произошла после того, как хендлер начал писать body, то ошибку нужно передавать в потоке json-ов в поле StatusUpdate.BuildFailed.

  • Код всех вызовов в этом пакете работает одинаково:

    1. Пользователь вызывает метод *Client.
    2. Метод делает HTTP запрос к серверу.
    3. *Handler принимает запрос, декодирует его и передает в *Service.
    4. (*) В случае вызова /build, сервис пишет обновления в StatusWriter, а клиентский код читает эти обновления из StatusReader.
    5. Ответ или ошибка из *Service возвращается пользователю.