Czy to API jest napisane prawidłowo?

Question

Cześć, przez jakiś czas ostatnio pracowałem nad REST API mojej aplikacji napisanym w Node.js. Pisałem je po raz pierwszy i starałem się korzystać z jak najlepszych praktyk, jednakże chciałbym się zapytać, czy te endpointy są prawidłowe, czy wszystko działa dobrze i jest poprawie skatalogowane? Z góry dziękuje. Link do kodu: https://github.com/ftasker/api

Answer 1

1. Nie podoba mi się całą logika w kontrolerze. Może warto gdzieś to poprzenosić, wydzielić? 
2. Cały plik services do refaktoryzacji i porozbijania na mniejsze funkcje. 
3. Ogarnij funkcję exec po query do Mongo, wtedy możesz dać await przed i oszczędzić sobie piekła zagnieżdżeń.
4. Mongoosem posługujesz się bezpośrednio w kontrolerach, powstaje przez to pełno ifow. Wyciąganie danych warto przenieść do innej warstwy / miejsca.
5. Zacznij pisać testy jednostkowe, to sam sobie wskażesz, które miejsca są do kitu ​​​​​​
6. A może Typescript? ​​​​​​
7. W server robisz jakieś sprawdzenia czy są parametry. Zupełnie zbędnie. Nie będzie parametrów, to apka się i tak wywali i tyle. Chcesz je koniecznie sprawdzać, ok ale na pewno nie tam.
8. Sama funkcja validateJWT trochę do kitu. Najpierw wyciągasz z Mongo a potem z niej korzystasz? Na etapie kontrolera wszystkie dane powinieneś mieć dostarczone. Znowu pojawia się temat wydzielenia miejsca czy użytkownik api ma dostęp do danego zasobu.
9. Szkoda że nie ma testów, ani dockera. Pm2 mógłby się przydać.

Comments

1. Więc co sugerujesz, wydzielenie wszystkich funkcji do różnych folderów? Zeszłym razem robiłem coś takiego i nawigowanie po takich kontrolerach było raczej mierne.
2. Rzeczywiście!
3. Też dobry pomysł.
4. Niegłupie, mógłbym to wrzucić w jakiś middleware może.
5. Okej, dobry plan na przyszłość!
6. Z ust mi to wyjąłeś.
7. Rzeczywiście!
8. Faktycznie, wrzuce to w middleware.
9. Co do testów to na pewno będą, aczkolwiek co do Dockera, to nie wiem. Pm2 to będzie już na produkcji na moim serwerze.

Dziękuje za review!

Answer 2

https://github.com/ftasker/api/blob/master/src/config/mongoconfig.js takie dane nie powinny byc wrzucane na gita

Comments

No przecież moje API będzie na takim samym serwerze co strona internetowa, więc każdy kto wie jak działa MongoDB będzie mógł wydedukować jaka jest ścieżka do bazy danych.

---

Em... no nie. a) Takie dane po prostu nie powinny być wrzucane na gita (szczególnie publicznego) b) Z tego co wiem istnieje coś takiego jak remote connection w mongo, i bazę możesz mieć pod zupełnie innym adresem.

---

W porządku, dam to do environmentów i zadbam o jakieś hasła w mojej bazie. Dziękuje za spostrzeżenie.