alternative server_method api

Aperta
#351 1 commento 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
rails, ruby
Ambito
api, backend

Direzione di ricerca

Inizia tracciando il comportamento esistente di server_methods e il modo in cui le dichiarazioni in app/hyperstack/models e app/models vengono caricate sul client e sul server. Definisci l'ambito di remote_access_to, dei blocchi di sicurezza condivisi, delle definizioni solo server e di no_cache, quindi verifica che il comportamento esistente dei metodi server rimanga invariato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

given you have an existing model, which needs some of the methods to be defined as server_methods, it would be nice to say something like:

remote_access_to(:foo, :bar) { acting_user.admin? }

where foo and bar are existing instance methods.

or

remote_access_to(:foo, bar: 12) ...

which will give a default value of 12 to bar.

This is nice not only because it allows for existing methods to be declared as server methods without modification, but it also allows for a common security block to be provided, instead of repeating it. It also is a nicer separation of concerns.

Basic implementation is straight forward: On the client methods :foo and :bar are defined like any other server method, and will call the method with the security name prefix. On the server, the secured method calls the block, and if successfully returns true, continues on and calls the method.

There are complexities:

  1. if the remote_access_to declaration is placed BEFORE the definition of foo and bar, you have to make sure that those definitions are server only. It might be possible by redefining define_method, to check for this case...

  2. If foo and bar are server side only, then it would be nice if they could be declared in a file that is in app/models. This can be done by putting the server and client defs in app/hyperstack/models, and then putting server only defs in app/models and adding a require Rails.root.join('app', 'models', 'sample.rb') unless RUBY_ENGINE == 'opal' at the start of the file, and maybe with some hacking we could make a method called require_server_definitions that would automatically figure out the file being loaded, and then load the same file from app/models.

And a nice feature:

server_methods by default assume that they are returning a value, and thus will cache the value on the client once its retrieved. You can force a re-retrieval of the value by adding a ! to the method name. But in many cases you just want the method to be run on the server every time its called, anyway. So how about a no_cache parameter added to the server method args.

Lingua principale
JavaScript
Stelle
538
Fork
41
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di hyperstack-org/hyperstack

Tutte le issue di hyperstack-org/hyperstack

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.