Pełen REST czy messages via POST - event sourcing

Pełen REST czy messages via POST - event sourcing
Maciej Cąderek
Maciej Cąderek
Maciej Cąderek
Maciej Cąderek
  • Rejestracja:ponad 9 lat
  • Ostatnio:ponad 3 lata
  • Lokalizacja:Warszawa
  • Postów:1264
0

Robię sobie dla sportu collaborative todo app z wykorzystaniem Reduksa i event sourcingu. Apka działa tak, że każda akcja modyfikująca state jest odpalana jako akcja reduksowa (dodatkowo jest zrobiony middleware reduksowy, który zrzuca wszystkie akcje do event loga). Zastanawiam się czy stosować RESTa czy go olać i wysyłać wszystko POSTem jako gotowe message. Docelowo apka będzie pewnie na Socket.io, no ale aktualnie rozważam przypadek z "klasycznym" backendem. Konkrety:

  • mam na backendzie podefiniowane akcje w stylu:
Kopiuj
export const ADD_TODO = 'ADD_TODO'
export const REMOVE_TODO = 'REMOVE_TODO'
export const DELETE_TODO = 'DELETE_TODO'

// i dalej action creatory w stylu:
export const addTodo = (title, description) => ({
  type: ADD_TODO,
  payload: {
    id: uuid(),
    title,
    description
  }
})

export const removeTodo = (id) => ({
  type: REMOVE_TODO,
  payload: {
    id
  }
})
  • pominę reducery bo sa nieistotne dla przykładu, routing teraz wygląda mniej więcej tak (orginalna apka jest w Koa, ale pokazuję Expressa bo więcej osób go zna):
Kopiuj
router
  .get('/todos', (req, res) => {
    res.send(store.getState().todos)
  })
  .post('/todos', (req, res) => {
    store.dispatch(addTodo(req.body.title, req.body.description))
    res.statusStatus(201)
  })
  .delete('/todos/:id', (req, res) => {
    store.dispatch(removeTodo(req.params.id))
    res.sendStatus(200)
  })

Alternatywnie mógłbym praktycznie pozbyć się action creatorów z backendu i wysyłać POSTem gotowe akcje na backend, wtedy routing ograniczyłby się do POSTa i GETa, coś w stylu:

Kopiuj
router
  .get('/todos', (req, res) => {
    res.send(store.getState().todos)
  })
  .post('/', (req, res) => {
    store.dispatch(req.body) // body zawiera gotową akcję
    res.sendStatus(200)
  })

Pomijam powyżej obsługę błedów itp

Które podejście wydaje się Wam lepsze? Pełen REST czy GETy dla kolekcji i pojedynczy POST rozpakowujący przesłaną z frontendu akcję? Może jeszcze coś innego?

edytowany 9x, ostatnio: Maciej Cąderek
Maciej Cąderek
Maciej Cąderek
Wołam @jarekr000000 ;)
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
Krzysztof Bogdan
Krzysztof Bogdan
Krzysztof Bogdan
Krzysztof Bogdan
  • Rejestracja:ponad 9 lat
  • Ostatnio:2 dni
  • Postów:37
1

https://en.wikipedia.org/wiki/Representational_state_transfer

Kopiuj
POST - Create a new entry in the collection. The new entry's URI is assigned automatically and is usually returned by the operation

2 przypadek nie jest ok, jeżeli chodzi również o założenia z "Architectural properties":

  1. Performance
  2. Scalability

W kolekcji może być wiele elementów, przy małej aplikacji TODO to przejdzie. Przy paru milionach rekordach w kolekcji może być problem.

edytowany 2x, ostatnio: Krzysztof Bogdan
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
Maciej Cąderek
Maciej Cąderek
Maciej Cąderek
Maciej Cąderek
  • Rejestracja:ponad 9 lat
  • Ostatnio:ponad 3 lata
  • Lokalizacja:Warszawa
  • Postów:1264
0

@Krzysztof Bogdan:
To, że nie jest to zgodne z REST to wiem, tego dotyczy pytanie ;) Taki GraphQL też nie jest zgodny z REST i nie musi być.

Mógłbyś rozwinąć kwestię performance i scalability?

edytowany 1x, ostatnio: Maciej Cąderek
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
Krzysztof Bogdan
Krzysztof Bogdan
Krzysztof Bogdan
Krzysztof Bogdan
  • Rejestracja:ponad 9 lat
  • Ostatnio:2 dni
  • Postów:37
1

Trochę źle zrozumiałem, myślałem że chcesz wysyłać wszystkie elementy kolekcji jako POST żeby serwer sobie zaktualizował stan po swojej stronie.
W związku z tym można wykreślić problemy z performance i scalability.

Jeżeli rozumiem body.action ma w sobie 2 informacje: 1. co zrobić; 2. dane; czyli takie coś ala JSON-RPC.

Nie ważne czy się zrobi to RESTowo czy RPC, postarałbym się nie mixować tych sposobów czyli

  • albo tego get`a też zrobił jako RPC
  • albo zrezygnował z RPC

Jakbym tworzył API dla kogoś to trzymałbym się jak podejścia REST`owego, dużo osób wie o co chodzi i jest dobry tooling

Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
Maciej Cąderek
Maciej Cąderek
Maciej Cąderek
Maciej Cąderek
  • Rejestracja:ponad 9 lat
  • Ostatnio:ponad 3 lata
  • Lokalizacja:Warszawa
  • Postów:1264
0

Tak, dobrze rozumiesz - req.body zawierałoby standardową reduksową akcję typu:

Kopiuj
{
  "type": "ADD_TODO",
  "payload": {
    "title": "Some todo",
    "description": "Some description..."
  }
}

Słuszna uwaga na temat jednolitego API - pobieranie przez GET /collection zastosowałem ze względu na wygodę - nie chcę pobierania danych rejestrować w event logu bo nie zmienia to stanu aplikacji i w przy obecnej implementacji podczas restore aplikacji niepotrzebnie się te akcje wykonają.
Z drugiej strony informacja o tym kto i jak często pobiera jakieś dane może być bardzo cenna - a w sumie o to chodzi by nie tracić żadnych danych. Wymaga to przeróbki restora, ale ma sens (no i api jest jenolite przy okazji tak jak sugerujesz).
Dzięki!

edytowany 1x, ostatnio: Maciej Cąderek
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
jarekr000000
jarekr000000
jarekr000000
jarekr000000
  • Rejestracja:ponad 8 lat
  • Ostatnio:około 4 godziny
  • Lokalizacja:U krasnoludów - pod górą
  • Postów:4707
2

W kwestii RESTa - to mniej tyle wiem co ateista rozwikłujący zagadnienie pochodzenia ducha świętego.

Ale jeśli bawisz się ES - to opcja z wysyłaniem całej akcji wychodzi mi naturalnie - dokładnie tak czasem robię - wpakowujesz od razu akcję jako event - piękny skrót.
Szczególnie dobrze działa wtedy kiedy masz współdzielony kod na serwerze i kliencie (np,. reducery możesz mieć dokładnie te same).
Jeszcze gorzej, potem te same akcje można wysyłać socketem innym klientom :-), i w ten sposób w zasadzie nie potrzebujemy RESTowego GETa Można wykorzystać niby do stanu początkowego ... ale czemu by miał serwer tego nie wysłać jako serię akcji?... (na pewno jest to mniej wydajne, za to przynajmniej zabawne...).

jeden i pół terabajta powinno wystarczyć każdemu
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
Maciej Cąderek
Maciej Cąderek
Maciej Cąderek
Maciej Cąderek
  • Rejestracja:ponad 9 lat
  • Ostatnio:ponad 3 lata
  • Lokalizacja:Warszawa
  • Postów:1264
0

@jarekr000000:
No myślę, że do czegoś takiego właśnie zmierzam ;)

DE
Czyli masz też reduxa na backendzie? Fajna sprawa, musze spróbować :)
Maciej Cąderek
Maciej Cąderek
@Desu Tak, projekt na wczesnym etapie, ale jak na razie wygląda fajnie ;) Nie wychodziłem z założenia, że go użyję, ale jak zacząłem klepać to jakoś tak o dziwo naturalnie mi się nasunął do event-sourcingu. Jaram się :D
jarekr000000
Też się tym zajarałem jakiś czas temu. Skręciłem w stronę serverless (czyli serwer działa tylko jako hub). Ale na razie ugrzęzłem (brak czasu).
Udostępnij
Kopiuj link do postu Kopiuj link do postu jako Markdown
Komentuj
Treść
Podgląd
Kliknij, aby dodać treść...
Kliknij, aby dodać załącznik lub wklej ze schowka.
Instrukcja obsługi Markdown
Pomoc 1.18.8

Typografia

Edytor obsługuje składnie Markdown, w której pojedynczy akcent *kursywa* oraz _kursywa_ to pochylenie. Z kolei podwójny akcent **pogrubienie** oraz __pogrubienie__ to pogrubienie. Dodanie znaczników ~~strike~~ to przekreślenie.

Możesz dodać formatowanie komendami , , oraz .

Ponieważ dekoracja podkreślenia jest przeznaczona na linki, markdown nie zawiera specjalnej składni dla podkreślenia. Dlatego by dodać podkreślenie, użyj <u>underline</u>.

Komendy formatujące reagują na skróty klawiszowe: Ctrl+B, Ctrl+I, Ctrl+U oraz Ctrl+S.

Linki

By dodać link w edytorze użyj komendy lub użyj składni [title](link). URL umieszczony w linku lub nawet URL umieszczony bezpośrednio w tekście będzie aktywny i klikalny.

Jeżeli chcesz, możesz samodzielnie dodać link: <a href="link">title</a>.

Wewnętrzne odnośniki

Możesz umieścić odnośnik do wewnętrznej podstrony, używając następującej składni: [[Delphi/Kompendium]] lub [[Delphi/Kompendium|kliknij, aby przejść do kompendium]]. Odnośniki mogą prowadzić do Forum 4programmers.net lub np. do Kompendium.

Wspomnienia użytkowników

By wspomnieć użytkownika forum, wpisz w formularzu znak @. Zobaczysz okienko samouzupełniające nazwy użytkowników. Samouzupełnienie dobierze odpowiedni format wspomnienia, zależnie od tego czy w nazwie użytkownika znajduje się spacja.

Znaczniki HTML

Dozwolone jest używanie niektórych znaczników HTML: <a>, <b>, <i>, <kbd>, <del>, <strong>, <dfn>, <pre>, <blockquote>, <hr/>, <sub>, <sup> oraz <img/>.

Skróty klawiszowe

Dodaj kombinację klawiszy komendą notacji klawiszy lub skrótem klawiszowym Alt+K.

Reprezentuj kombinacje klawiszowe używając taga <kbd>. Oddziel od siebie klawisze znakiem plus, np <kbd>Alt+Tab</kbd>.

Indeks górny oraz dolny

Przykład: wpisując H<sub>2</sub>O i m<sup>2</sup> otrzymasz: H2O i m2.

Składnia Tex

By precyzyjnie wyrazić działanie matematyczne, użyj składni Tex.

<tex>arcctg(x) = argtan(\frac{1}{x}) = arcsin(\frac{1}{\sqrt{1+x^2}})</tex>

Kod źródłowy

Krótkie fragmenty kodu

Wszelkie jednolinijkowe instrukcje języka programowania powinny być zawarte pomiędzy obróconymi apostrofami: `kod instrukcji` lub ``console.log(`string`);``.

Kod wielolinijkowy

Dodaj fragment kodu komendą . Fragmenty kodu zajmujące całą lub więcej linijek powinny być umieszczone w wielolinijkowym fragmencie kodu. Znaczniki ``` lub ~~~ umożliwiają kolorowanie różnych języków programowania. Możemy nadać nazwę języka programowania używając auto-uzupełnienia, kod został pokolorowany używając konkretnych ustawień kolorowania składni:

```javascript
document.write('Hello World');
```

Możesz zaznaczyć również już wklejony kod w edytorze, i użyć komendy  by zamienić go w kod. Użyj kombinacji Ctrl+`, by dodać fragment kodu bez oznaczników języka.

Tabelki

Dodaj przykładową tabelkę używając komendy . Przykładowa tabelka składa się z dwóch kolumn, nagłówka i jednego wiersza.

Wygeneruj tabelkę na podstawie szablonu. Oddziel komórki separatorem ; lub |, a następnie zaznacz szablonu.

nazwisko;dziedzina;odkrycie
Pitagoras;mathematics;Pythagorean Theorem
Albert Einstein;physics;General Relativity
Marie Curie, Pierre Curie;chemistry;Radium, Polonium

Użyj komendy by zamienić zaznaczony szablon na tabelkę Markdown.

Lista uporządkowana i nieuporządkowana

Możliwe jest tworzenie listy numerowanych oraz wypunktowanych. Wystarczy, że pierwszym znakiem linii będzie * lub - dla listy nieuporządkowanej oraz 1. dla listy uporządkowanej.

Użyj komendy by dodać listę uporządkowaną.

1. Lista numerowana
2. Lista numerowana

Użyj komendy by dodać listę nieuporządkowaną.

* Lista wypunktowana
* Lista wypunktowana
** Lista wypunktowana (drugi poziom)

Składnia Markdown

Edytor obsługuje składnię Markdown, która składa się ze znaków specjalnych. Dostępne komendy, jak formatowanie , dodanie tabelki lub fragmentu kodu są w pewnym sensie świadome otaczającej jej składni, i postarają się unikać uszkodzenia jej.

Dla przykładu, używając tylko dostępnych komend, nie możemy dodać formatowania pogrubienia do kodu wielolinijkowego, albo dodać listy do tabelki - mogłoby to doprowadzić do uszkodzenia składni.

W pewnych odosobnionych przypadkach brak nowej linii przed elementami markdown również mógłby uszkodzić składnie, dlatego edytor dodaje brakujące nowe linie. Dla przykładu, dodanie formatowania pochylenia zaraz po tabelce, mogłoby zostać błędne zinterpretowane, więc edytor doda oddzielającą nową linię pomiędzy tabelką, a pochyleniem.

Skróty klawiszowe

Skróty formatujące, kiedy w edytorze znajduje się pojedynczy kursor, wstawiają sformatowany tekst przykładowy. Jeśli w edytorze znajduje się zaznaczenie (słowo, linijka, paragraf), wtedy zaznaczenie zostaje sformatowane.

  • Ctrl+B - dodaj pogrubienie lub pogrub zaznaczenie
  • Ctrl+I - dodaj pochylenie lub pochyl zaznaczenie
  • Ctrl+U - dodaj podkreślenie lub podkreśl zaznaczenie
  • Ctrl+S - dodaj przekreślenie lub przekreśl zaznaczenie

Notacja Klawiszy

  • Alt+K - dodaj notację klawiszy

Fragment kodu bez oznacznika

  • Alt+C - dodaj pusty fragment kodu

Skróty operujące na kodzie i linijkach:

  • Alt+L - zaznaczenie całej linii
  • Alt+, Alt+ - przeniesienie linijki w której znajduje się kursor w górę/dół.
  • Tab/⌘+] - dodaj wcięcie (wcięcie w prawo)
  • Shit+Tab/⌘+[ - usunięcie wcięcia (wycięcie w lewo)

Dodawanie postów:

  • Ctrl+Enter - dodaj post
  • ⌘+Enter - dodaj post (MacOS)