Świeżo dostępne - tryb demo MaraDocs i architektura oprogramowania

Wykorzystaliśmy wielkanocny weekend i stworzyliśmy oraz opublikowaliśmy tryb demo dla MaraDocs.

Blog MaraDocs to połączenie platformy do ogłaszania wydarzeń związanych z MaraDocs, ale także miejsca do publikowania myśli związanych z prawem i technologią.

Jesteśmy niesamowicie dumni...

Raui i ja intensywnie pracowaliśmy nad MaraDocs w zeszłym roku. Po kilku miesiącach prac przygotowawczych z mojej strony, z pewnością spędziliśmy 8 miesięcy na czystym rozwoju produktu. Zawsze z celem przed oczami: stworzenie jednego rozwiązania do przygotowywania dokumentów dla kancelarii, które uwolni nas wszystkich od bólu coraz gorszej jakości poczty przychodzącej.

Współpracowaliśmy z kilkoma kancelariami partnerskimi (podziękowania dla RA Bafteh z BSvH!) aby upewnić się, że nie rozwijamy produktu z pominięciem użytkownika końcowego. I otrzymaliśmy wiele bardzo sensownych wskazówek: na przykład podgląd dokumentów powstał w dużej mierze na podstawie informacji zwrotnych od wczesnej użytkowniczki (radczyni prawnej z zakresu prawa rodzinnego z Fryburga, bardzo dziękujemy :)) oraz opinii pracowników sekretariatu kancelarii Kurtz & Lynen (https://kanzlei-kurtz.net).

...a jednak jest jeszcze sporo do zrobienia

Sam dobry produkt nie czyni jeszcze produktu odnoszącego sukces. MaraDocs jest doskonały i jest używany codziennie oraz uwielbiany przez tych, którzy korzystają z niego w swojej codziennej pracy. Ale ci, którzy jeszcze z niego nie korzystają, zwykle jeszcze go nie znają.

W świecie przeładowanym uwagą nie jest łatwo zdobyć uwagę potencjalnych klientów.

Droga potencjalnego klienta jest długa:

• Jest tam coś...

• Wypróbuję to...

• Faktycznie wchodzę na stronę internetową...

• Rejestruję się za pomocą mojego adresu e-mail...

• Klikam w link logowania, który otrzymałem e-mailem...

• Otwieram aplikację i dodaję załączniki e-mail do optymalizacji i zdaję sobie sprawę, że produkt jest genialny.

Skróty do aplikacji

Dzięki trybowi demo możemy drastycznie skrócić tę drogę i zaoferować potencjalnym klientom nieskomplikowane, wczesne i autentyczne doświadczenie wypróbowania MaraDocs. MaraDocs to przyjemność: przejrzysty interfejs użytkownika oraz przesuwanie i łączenie stron w nowe pliki PDF ma coś z zabawy.

Jednocześnie tryb demo nic nas nie kosztuje. Dla kontekstu należy wiedzieć, że przesyłanie prawdziwych plików i załączników e-mail generuje koszty w naszej infrastrukturze. Musimy utrzymywać pewne zasoby, aby móc szybko i reaktywnie przetwarzać zlecenia użytkowników. Tryb demo, który wysyłałby prawdziwe pliki na nasze serwery i nie wymagałby nawet rejestracji, mógłby łatwo doprowadzić do przeciążenia naszych serwerów przez wiele zapytań, co negatywnie wpłynęłoby na naszych rzeczywistych klientów.

Implementacja techniczna

W warstwie frontend używamy React / NextJs. Aplikacja React działająca w przeglądarce komunikuje się w trybie normalnym z naszymi serwerami odpowiedzialnymi za przetwarzanie plików za pomocą WebSocket (WebSocket to dwukierunkowe połączenie, w którym serwer może również samodzielnie, czyli bez odpytywania przez przeglądarkę, wysyłać wyniki do przeglądarki).

Zależało mi na tym, aby opracować tryb demo w taki sposób, aby zawsze odzwierciedlał aktualny stan rozwoju MaraDocs i nie stanowił nowego, dodatkowego systemu, który musiałby być rozwijany niezależnie.

Redux Middleware

Duża część logiki przepływu wewnątrz aplikacji jest sterowana przez middlewary Redux. Ostatecznie można sobie wyobrazić aplikację jako ogromną maszynę stanów, w której różne zdarzenia wyzwalają predefiniowane sekwencje i zmieniają wewnętrzną reprezentację danych.

Zdarzeniem jest na przykład kliknięcie przycisku (np. obróć tę stronę PDF) lub także wstawienie pliku do aplikacji, a także wiadomość WebSocket od serwera z wynikami zoptymalizowanego pliku PDF.

Zdecydowałem się zaimplementować asynchroniczne części akcji następujących po tych zdarzeniach, czyli coś takiego jak wysyłanie danych przez WebSocket do serwera, ale także niektóre z obszernych operacji na plikach PDF, które wykonujemy w przeglądarce, w logice middleware. Te middlewary nasłuchują i reagują na określone zdarzenia, a następnie wykonują logikę.

Hot-Swapping Middlewares

W trybie demo uruchamiana jest więc nasza normalna aplikacja. Jednak podczas rejestracji różnych middlewarów ten, który normalnie obsługuje komunikację WebSocket, zostaje wymieniony na middleware demo, który przy odpowiednich zdarzeniach wyświetla symulowane (przygotowane wcześniej) wyniki z niewielkim opóźnieniem.

Te pliki nie muszą więc być za każdym razem analizowane i optymalizowane przez nasze serwery, ale tylko raz. Następnie mogą być wielokrotnie ładowane z naszego statycznego cache i w ten sposób praktycznie nie generują żadnych kosztów.

Ogólne przemyślenia na temat Redux

Redux to określony sposób zarządzania stanem w aplikacjach Javascript. Leży u jego podstaw idea, że tylko tzw. akcje, które muszą być wykonywane w określony sposób, mogą modyfikować dane o stanie obecne w aplikacji. React na przykład może w ten sposób zapewnić, że widoczne części aplikacji reagują na zmiany stanu.

Biblioteka Redux, która spopularyzowała ten model oprogramowania przynajmniej w świecie frontend (Redux), jest częściowo uważana za zbyt skomplikowaną i w wielu nowszych projektach jest wypierana przez lżejsze alternatywy. My jednak starannie rozważyliśmy jej zastosowanie. W szczególności potężna struktura middleware pozwoliła nam przenieść tak złożoną aplikację jak MaraDocs do przeglądarki.

Tryb demo i łatwa obsługa włączania i wyłączania go poprzez wymianę pojedynczego "modułu" (middleware) potwierdza dla mnie, że postawiliśmy tu na właściwego konia.

Podsumowanie

Szczególnie cieszę się z koleżanek i kolegów z branży prawniczej, którzy dzielą ze mną pasję do cyfryzacji i rozwoju oprogramowania.

Dzisiejszy artykuł był nieco bardziej techniczny. Ale tak już bywa: zaczyna się bez zobowiązań, a potem jednak zagłębia się nieco głębiej w tematy.

Opinie / feedback / pytania bardzo mile widziane przez LinkedIn lub e-mail na info@maradocs.io.