Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

alternative server_method api

オープン
#351 コメント 1 件 リアクション 2 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
rails, ruby
領域
api, backend

調査の方向性

まず、既存の server_methods の動作と、app/hyperstack/models および app/models の宣言がクライアントとサーバーでどのように読み込まれるかを追跡します。remote_access_to、共有セキュリティブロック、サーバー専用の定義、no_cache の範囲を定義し、その後、既存のサーバーメソッドの動作が維持されていることを確認します。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
JavaScript
スター
538
フォーク
41
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

hyperstack-org/hyperstack のほかの issue

hyperstack-org/hyperstack の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。