go-park-mail-ru / 2018_2_codeloft

Многопользовательская браузерная игра Tron Remastered

• Ссылки
• Описание
• Участники
• Frontend
• API

Приложение доступно по хостам:

• Ветка разработки
• Release ветка
• Деплой

Описание

2D игра по мотивам легендарной аркады TRON. Игра представляет собой сражение на байках, оставляющих за собой непреодолимый барьер, столкновение с которым окажется фатальным. Игроки встречаются на поле в попытках обыграть друг друга не только используя реакцию, но и интеллект. Хитрая стратегия, опыт, навыки и немного удачи в виде бонусов разбросанных по карте помогут определить кто сильнейший.

Участники

• Анохин Данил, backend
• Рязанов Максим, backend
• Дыров Игорь, frontend
• Саркисян Артур, fullstack

Frontend

• Frontend repository

API

---

/user

• Method GET: LeaderBoard ** Take: get params "page" and "page_size" ** Return: JSON with leaders

• Method POST: Registration ** Take: JSON with "login", "password", "email" ** Return: JSON with "user_id","login", "password", "email"

• Method DELETE: delete user ** Take: JSON with "login", "password" ** Return: nothing

• Method PUT: update user ** Take: JSON with "login", "password" and optional "email", "new_password", "score" ** Return: JSON with "user_id","login", "password", "email" of update user

/user/id

• Method GET: get user with id

/session

• Method GET: checkAuth with cookie

• Method POST: login. set cookie **Take: JSON with "login", "password"

• Method DELETE: logout,delete cookie **Take: JSON with "login", "password"

2018_2_codeloft's Issues

Добавить докер-сборку проекта

• Добавить докерфайл для создания образа (на том же hello.go)
• Привязать ветки testing и master к now (на разные хосты)
• В makefile добавить скрипты для сборки образа

Добавить бд в контейнер с го

Добавить базу к вашему образу с го. Временно, потому база уедет жить отдельно, но для старта так удобнее (исправить докерфайл)

Написать документацию в свагере

Написать yml конфиг или написать godoc для генерации этого yml

Чат: Не отображает свои сообщения во второй вкладке

свои сообщения не отображаются если открыть две вкладки и писать

Написать простую первую ручку

Добавить хттп сервер (не использовать библиотеки типа mux!)

Добавить лисенера на какой-то урл. Просто hello-world. И отдавать в json в объекте какие-то данные

Мультик

1. Отправлять инфу о том, что надо стереть след отключившегося игрока
2. Цвет должен быть уникальным
3. Пофиксить отжирание куска следа при коллизии

Разобраться в версиях вашего проекта

Разобраться где тестинг, где прод и где личные версии. И расписать все в readme. Сейчас непонятно что такое "релейная ветка" и что мне должно это говорить в ридми и зачем

GAME: Неверный переход на другую сторону карты

При переходе с нижнего конца в начало нужно выставлять координату не X=1 , Y=1 , а X=0, Y=0

глобальные переменные

2018_2_codeloft/database/database.go

Line 16 in b096c62

var mu *sync.Mutex = &sync.Mutex{}

глобальные переменные часто ведут к ошибкам.
Нужно во-первых, перенести мютекс внутрь объекта, который его использует. Во-вторых, вам тут не нужен синглтон: создавайте базу в пакете main и передавайте во все хендлеры, а там уже используйте. Это значительно облегчит написание тестов в будущем. В третьих, база сама должна знать, как себя инитить: сделайте один метод Init() у объекта базы, который вызовете в main после создания объекта базы.

Сделать деплой через докер

Деплоить через доке с запуском нескольких микросервисов(или настроить работу без докера)

Это очень странно

2018_2_codeloft/database/database.go

Line 129 in b096c62

for t := range c {

зачем вам делать работу, результат которой почти никогда не понадобится?
В зависимости от ожидаемой нагрузки, сортировать нужно либо при вставке (если очень мало записей в базу и много чтений), либо при отдаче данных (если наоборот, мало чтений, но много записей)

Добавить общее число страниц в ручке лидерборда

Ручка лидербордов отдает еще один параметр: сколько всего страниц

Чат, игра в отдельный сервис

Вынести чат и игру в отдельный микросевис(просто отдельные серваки, никакого gRPC)

не надо так

2018_2_codeloft/handlers/sessionhandler.go

Line 63 in b096c62

Value: u.Login + "testCookie" + u.Password,

Если кука каким-то образом попадёт к злоумышленнику, вы не сможете её инвалидировать без смены пароля (а для этого требуется действие пользователя). И вы не сможете отличить две сессии пользователя друг от друга.
В значение куки надо писать либо что-то большое и случайное, и хранить у себя соответствие сессия->пользователь
Либо шифровать логин и расшифровывать обратно при получении, но в этом варианте если утечёт алгоритм шифрования и секреты, то вы скомпрометируете всех пользователей сразу. Этот способ можно улучшить, но проще хранить соответствие.

не по REST

2018_2_codeloft/handlers/userhandler.go

Line 125 in b096c62

var u struct {

надо в урле указывать, какой объект изменяем/удаляем:
DELETE /users/10
и пароль не надо проверять, у вас есть сессия для того, чтобы проверить, что пользователь пытается удалить , или изменить себя, а не другого

теряете информацию об ошибке

2018_2_codeloft/handlers/sessionhandler.go

Line 39 in b096c62

if err != nil {

нужно писать в лог, что именно произошло. Вы смотрите на факт ошибки, но полностью теряете её суть. По проблеме, произошедшей у пользователя вы не сможете понять ничего.

Concurent WriteJSON

Иногда при подключении пользователя вылетает concurent writejson
Нужно отправлять матрицу по сигналу Signal

Добавить тесты и travis ci

https://travis-ci.org

Написать простой тест к функции (любой) из hello.go. Добавить в make запуск тестов
Подключить travis ci (пнуть ментора, если не коннектится репа с тревисом). Чтобы подключить, нужно составить конфиг yml и закомитить. В интерфейсе активировать репу. Если все хорошо, то тревис вытащит все из репы и пойдет по своему конфигу что-то делать с вашей репой (что сами укажете)

Добавить ручку для смены языка

Добавить ручку смены языка для пользователя.
По запросу вида http://backend.codeloft.ru/api/bla/updateLanguage, менять язык (поле lang) пользователя.

Тип запроса POST

Возможные значения lang:

• en
• ru

Секурные куки

Добавить на куки свойства Secure и HTTP Only (зачем обсуждали)

Проверка Куки

При проверки не авторизован ли уже пользователь убрать проверку на наличие куки.
Из-за этого после перезапуска бд у пользователя есть кука, но в базе то её нет. Пользователь не может залогиниться так как кука стоит...

Возвращать 405, если пришел неверный метод

Сейчас (в каком-то окружении) можно получать пользователей вообще по всем методам. Оставить GET, остальное отбрасывать.

Разобраться, актуальна ли данная таска или это была проблема с окружением вашим

Добавить схему бд

Определиться какую бд используете: Mongo db или psql. И записать схему для psql в виде .sql файла или накидать для себя примерный формат документа в Mongo db

Подключить MongoDB

РК3

• разрешить спецсимволы в пароли

• считать очки при завершении игры

• убрать комменты кода из кода

Генерация куки

2018_2_codeloft/services/cookie.go

Line 28 in adf7484

sha3.ShakeSum256(h, buf)

Лучше генерировать рандомную строку, вы же всё равно её в базу заносите и сверяете потом с тем, что в базе

База слишком специфична

2018_2_codeloft/database/database.go

Line 20 in b096c62

type DB struct {

У вас база данных становится слишком многофункциональной: она и хранит данные, и понимает, кто такой пользователь, и что такое сессия. И добавление новой модели приведёт к изменению пакета database.
Этот пакет должен уметь принимать любые объекты без изменения его кода.
Информацию, как достать тот или иной объект из базы, унесите в модели. Пусть база только хранит неизвестные данные (их можно разделять по названию, полученному извне, или по тегу у структуры, вариантов много).

не передавайте невалидные данные

2018_2_codeloft/handlers/userhandler.go

Line 39 in b096c62

page, err := strconv.Atoi(r.FormValue("page"))

нужно сначала проверить, что параметр есть, а потом уже передавать его функе, которая из строки прочтёт число. И вы не сможете отличить кейс, когда вам ничего не пришло (надо использовать дефолт), и кейс, когда пришли не числа (надо ответить ошибкой)

шаблон читайте из файла

2018_2_codeloft/handlers/mainpage.go

Line 7 in b096c62

<h1>Backend API</h1>

не нужно захламлять код

CHAT: cannot upgrade ws

Не получается заапгрейдить соединение вебсокета в чате

GAME: Listen player

ReadJSON выдает ошибку когда никто не пишет? Приходится делать continue

Secure cookie

Сделать в dockerfile переменную серды "production"

Настроить структуру проекта

Добавить .gitignore, конфиги нужные и папки, просто hello.go. Также добавить make файл для быстрого деплоя руками или сборки докера и деплоя