VulCode

facet

Framework webowy w stylu Rails napisany w Ruby wyłącznie na bibliotece standardowej, bez Bundlera i gemów. Własny serwer HTTP/1.1 z WebSocketami, routing i zasoby, kontrolery i szablony ERB, ORM na pliku z migracjami i asocjacjami, zadania w tle, maile i generator CLI.

TypFramework webowy
JęzykRuby 3.3 lub nowszy
ZależnościTylko biblioteka standardowa
TestyMinitest, około 1500
facet

Wprowadzenie

facet to framework webowy w Ruby napisany wyłącznie na bibliotece standardowej: bez Bundlera i bez ani jednego gemu w czasie działania. Pokrywa cały stos małej aplikacji w stylu Rails, od własnego serwera HTTP/1.1, przez routing, kontrolery i widoki, po ORM na pliku z migracjami, zadania w tle, maile, WebSockety, tłumaczenia, cache, zabezpieczenia, narzędzia do testów i generator CLI.

Do uruchomienia wystarczy Ruby 3.3 albo nowszy. Każda biblioteka, z której korzysta facet, instaluje się razem z językiem, więc aplikację da się odpalić prosto z katalogu z kodem albo zbudować i zainstalować jako gem.

Aplikacja w kilkunastu linijkach

Najprostsza aplikacja to jedna klasa. Trasy deklaruje się jak w Sinatrze, wartości ze ścieżki, z zapytania i z treści żądania trafiają do jednego params, a serwer uruchomiony na porcie 0 sam bierze od systemu wolny port.

blog.rb · ruby
require 'facet'

class Blog < Facet::Application
  enable_sessions(secret: 'change-me')
  use Facet::Middleware::Logger

  get '/' do
    html('<h1>Facet</h1>')
  end

  get '/users/:id' do
    json(id: params['id'])
  end

  group '/api' do
    get '/status' do
      json(ok: true)
    end
  end
end

server = Facet::Server.new(Blog, port: 3000).start

Większa aplikacja korzysta z warstwy w stylu Rails: kontrolerów z before_action, zasobów deklarowanych przez resources i resource z only i except, tras zagnieżdżonych oraz tras member i collection. Widok app/views/posts/index.erb jest owijany w layout, partiale leżą obok widoku z podkreślnikiem na początku nazwy, a form_for buduje formularz z błędami walidacji przy polach.

Droga żądania przez framework

Każde żądanie przechodzi przez te same warstwy, a każdą z nich da się przeczytać w osobnym pliku w lib/facet.

Serwer

własny serwer HTTP/1.1 na TCPServer przyjmuje połączenie, utrzymuje keep-alive, wysyła odpowiedzi strumieniowo i na tym samym porcie przełącza połączenie na WebSocket.

Middleware

stos w stylu Rack: logger, podpisane sesje, pliki statyczne z ETagami, assety z odciskiem w nazwie, kompresja gzip, CORS i limity żądań.

Router

dopasowuje metodę i ścieżkę, wyciąga nazwane parametry i splaty, obsługuje ograniczenia, grupy, przestrzenie nazw, filtry i nazwane trasy z url_for.

Kontroler

uruchamia filtry, akcję i rescue_from, a format odpowiedzi wybiera przez respond_to na podstawie nagłówka Accept.

Widok

szablon w stylu ERB z escapowaniem domyślnie, layoutem, partialami, content_for i cache fragmentów.

Do tego warunkowy GET z ETagiem i Last-Modified, z odpowiedziami 304 i 412, oraz zakresy bajtów dla plików statycznych.

ORM na jednym pliku

Warstwa danych zapisuje wszystko do jednego pliku PStore, który przetrwa restart procesu. Ma migracje z wycofywaniem, transakcje z savepointami, indeksy unikalne i złożone, walidacje, asocjacje z has_many :through i polimorficznym belongs_to, eager loading przez includes, blokady optymistyczne i pesymistyczne, miękkie usuwanie, szyfrowanie atrybutów AES-256-GCM i wykrywanie zapytań N+1.

models.rb · ruby
Facet::Orm.connect('db/development.pstore')
Facet::Orm.migrator('db/migrate').migrate!

class Post < Facet::Orm::Model
  validates :title, presence: true, length: { minimum: 3 }
  belongs_to :author, class_name: 'User'
end

class User < Facet::Orm::Model
  has_many :posts, foreign_key: 'author_id'
end

Post.where(title: 'Hello').order(:created_at, :desc).limit(10).offset(20)

To wybór z jasno opisaną granicą: każda transakcja kopiuje tabele, więc magazyn nadaje się do małych aplikacji i testów, a nie do dużych zbiorów danych i częstych zapisów. Adaptera SQL nie ma.

Wszystko poza routingiem

Co jeszcze jest w środku

ModułCo robi
Zadania w tletrwała kolejka w PStore, perform_later z terminem, ponowienia z odstępem liniowym albo wykładniczym, lista martwych zadań i demon facet jobs work
Maileszablony HTML i tekstowe, załączniki, wysyłka od razu albo w tle, SMTP i podgląd w przeglądarce
WebSocketyhandshake, ramki i fragmentacja, ping i pong, limity wiadomości i hub publikuj-subskrybuj
Tłumaczeniapliki JSON, liczba mnoga, języki zapasowe i język z parametru, sesji albo Accept-Language
BezpieczeństwoCSRF, strong parameters, podpisane i szyfrowane ciasteczka, logowanie z zapamiętaniem urządzenia i polityki dostępu
Limity żądańthrottle, listy blokowanych i dozwolonych oraz filtr w stylu fail2ban, w pamięci albo w PStore
CLInew, generatory modeli i migracji, db:migrate, db:rollback, routes, console i assets:precompile

Testy i ograniczenia

Zestaw Minitest liczy około 1500 testów i obejmuje każdy moduł. Testy integracyjne HTTP uruchamiają serwer na wolnym porcie, klienci WebSocket łączą się przez prawdziwe gniazda, a kolejka zadań, blokady i CLI mają testy na wielu procesach. W repozytorium są też przykłady, w tym pełna aplikacja bloga ze skryptami, które przechodzą ją przez HTTP.

Ograniczenia są opisane wprost. Serwer uruchamia jeden wątek na połączenie, mówi zwykłym HTTP/1.1 bez TLS i HTTP/2 i nie pilnuje rozmiaru ani czasu żądań, więc przy ruchu z internetu stoi za reverse proxy. Szablony nie mają trybów przycinania ERB, a WebSockety rozszerzeń takich jak permessage-deflate.

Pytania o facet

Więcej projektów

Inne realizacje z tej samej kategorii - zobacz, jak podchodzimy do podobnych wyzwań.

Masz podobny projekt?

Napisz do nas - wycena jest bezpłatna i wraca w godzinę.