Giter Club home page Giter Club logo

dataedo's Introduction

Cześć, poniżej znajduję parę szybkich uwag odnośnie przedstawionego rozwiązania. Część z nich jest również zależna od konwencji przyjętej w kodzie, a część jest dyskusyjna pod względem jej "krytyczności" o czym chętnie rozwinę temat w ramach dalszych etapów rekrutacji.

Critical

  • Brak authoryzacji tego kontrolera. Aktualnie dowolna osoba podająca id wskazanego użytkownika jest w stanie usunąć dany zasób. Można to rozwiąć na przykład przy użyciu modelu RBAC lub ABAC
  • Brakuje również kontroli błędów. W przypadku nie znalezienia użytkownika operacja powinna zostać przerwana i zwrócony kod błędu (Http404) czy wyjątek ( z tym ostrożnie bo wyjątki są kosztowne)
  • Dopisanie testów integracyjnych do kontrolera, przetestowanie E2E z poziomu aplikacji czy Postmanem

Important

  • Zamiana POST na DELETE gdyż zachowujemy wtedy idempotentność takiej operacji. Przy użyciu metody delete jesteśmy również w stanie skrócić ścieżkę naszego zapytania z „delete/{id}” na „{id:uint}” unikając redundancji.
  • Zmiana metody na asynchroniczną wraz zamienieniem używanych metod na asynchroniczne odpowiedniki jak poniżej:
public async Task Delete(...)
{
   .FirstOrDefaultAsync(...)
   ...
   .SaveChangesAsync();  
}
  • Idealnie w kontrolerze nie powinna znajdować się logika biznesowa. Można tutaj pomyśleć o przeniesieniu logiki do osobnego serwisu czy zastosowania wzorca mediatora
  • W ramach logowania informacji Id usuniętego użytkownika jest bardziej przydatne od jego użytkownika. Brak w zadaniu również wskazania czy ten log jest prostym debug info pozostawionym przez programiste w ramach testowania czy istotny aspekt biznesowy (np. konieczność przechowywania wszystkich logów w celach audytowych), możliwe że konieczne byłoby nawet dopisanie transakcji na operacje usunięcia rekordu jak i logowania
  • Ostatecznie metoda powinna zwrócić zamiast Http200 -> Http204

Nice to have

  • User user -> var user, kwestia preferencji
  • Fajnym dodatkiem było również dodanie CancelationTokena
  • W ramach dobrej praktyki warto dodać również response code'y, ułatwia to szybkie zapoznawanie się z działaniem metody bez wnikania do kodu
  [ProducesResponseType(StatusCodes.Status204NoContent)]
  • Ze względów bezpieczeństwa można również pokusić się o zastanowienie nad użyciem GUID zamiast Uint. Zależy to oczywiście od tego większej ilości czynników: czy aplikacja została już wdrożona produkcyjnie, zastosowania aplikacji itd

dataedo's People

Contributors

damiry0 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.