alternative server_method api

未关闭
#351 1 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
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. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

hyperstack-org/hyperstack 的其他 Issue

查看 hyperstack-org/hyperstack 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。