huacnlee (李华顺)

Ruby 3.3's YJIT Runs Shopify's Production Code 15% Faster

huacnlee — Wed, 20 Sep 2023 09:23:46 +0800

https://railsatscale.com/2023-09-18-ruby-3-3-s-yjit-runs-shopify-s-production-code-15-faster/

Ruby China Gems 镜像变更公告

huacnlee — Mon, 05 Jun 2023 17:50:27 +0800

鉴于最近不少人反馈 Ruby China 的 Gems 镜像一直不太稳定，今天做了一些架构调整，为动态内容 API 增加了境外节点，以降低回源带来的稳定性问题。

目前测试下来速度稳定，比之前有较大提升，大家可以尝试看看，有问题这里回复反馈。

$ dig gems.ruby-china.com

;; ANSWER SECTION:
gems.ruby-china.com.    267 IN  CNAME   gems.ruby-china.com.cdn.dnsv1.com.
gems.ruby-china.com.cdn.dnsv1.com. 600 IN CNAME 21gxf88f.slt.sched.intlscdn.com.
21gxf88f.slt.sched.intlscdn.com. 180 IN A   43.152.14.32

部署架构图

变更内容

在境外 QCloud CDN 上新增了节点，用于承接主要的动态 API 请求。
将可以长期缓存的文件 .gem 以 302 的方式跳转到 index.ruby-china.com 走国内 UpYun CDN 提升下载速度。
调整了一些缓存策略，尽量遵循 rubygems.org 给出的 cache-control 规则。
基于 QCloud 提供的预热功能，每 30 分钟会提前预热一些文件（例如 /versions）以确保大家访问的时候这些文件不会回源，提升速度。
2023.9.9 - 新增全球 CDN 节点，构建与境外节点之前，以减少国内网络直连香港可能发生的丢包问题（CDN to CDN 跨境更稳定）。

以上暂时这么调整，如有变化我会持续这里更新。

Ruby 3.2 带来的 YJIT 性能提升提升 ~40%

huacnlee — Thu, 22 Dec 2022 13:31:50 +0800

Overall YJIT is 38.9% faster than interpreted CRuby! On Railsbench specifically, YJIT is 38.9% faster than CRuby!

https://speed.yjit.org

开始使用 Ruby 3.2

brew upgrade ruby-build
rbenv install 3.2.0-rc1
rbenv global 3.2.0-rc1

然后设置 ENV 开启 YJIT，设置到 .bash_profile 或其他地方

export RUBY_YJIT_ENABLE=true

然后检查 YJIT 是否开启，启动 irb

irb> RubyVM::YJIT.enabled?
=> true

Towards Ruby 4 JIT / RubyKaigi 2022

huacnlee — Wed, 14 Sep 2022 10:20:27 +0800

https://speakerdeck.com/k0kubun/rubykaigi-2022

Ruby on Rust - 用 Rust 编写 RubyGem Extension 提升 600% 的性能

huacnlee — Fri, 22 Apr 2022 16:57:07 +0800

最近我发现 RubyGems 以及合并了 Cargo builder 支持的 PR，也就意味着，我们除了可以用 C 来写 RubyGem 扩展之外，也可以用 Rust 了。

https://github.com/rubygems/rubygems/pull/5175

为了吃螃蟹，我用 autocorrect 的项目测试了一下，已经完成集成上 CI Result 以及跑同，集成好以后，我一次性删除了大量之前的 Rust 实现的代码。

目前在折腾 Cross Compile 打包发布的事情。

详细内容，可以作为参考：

https://github.com/huacnlee/auto-correct/pull/17

如何编写 Rust 扩展

在 RubyGems 的 PR 里面给到的例子实现方法比较初级。我实际走下来看，这样还不够。我们需要原来 Gem 的 extconf.rb 那套流程来自动化发布。

创建类似这样的目录结构：

├── Gemfile
├── Rakefile
├── auto-correct.gemspec
├── ext
│   └── autocorrect
│       ├── Cargo.lock
│       ├── Cargo.toml
│       ├── extconf.rb
│       └── src
│           └── lib.rs
├── lib
│   ├── auto-correct
│   │   └── version.rb
│   └── auto-correct.rb

Cargo.toml 需要引入 rb-sys，我们需要用它来定义 Ruby Module, Function, Const 之类的东西，这个类似 C Extension 里面相同的方法。

[package]
edition = "2021"
name = "autocorrect"
version = "1.5.11"

[lib]
crate-type = ["cdylib"]

[dependencies]
rb-sys = {version = "0.8.0", features = ["link-ruby", "ruby-static"]}
autocorrect = "1.5.11"

src/lib.rs

extern crate rb_sys;

use rb_sys::{
    rb_define_module, rb_define_module_function, rb_string_value_cstr, rb_utf8_str_new, VALUE,
};
use std::ffi::{CStr, CString};
use std::os::raw::{c_char, c_long};

#[inline]
unsafe fn cstr_to_string(str: *const c_char) -> String {
    CStr::from_ptr(str).to_string_lossy().into_owned()
}

#[no_mangle]
unsafe extern "C" fn pub_format(_klass: VALUE, mut input: VALUE) -> VALUE {
    // 需要做类型转换，将 CString 转换成 Rust String
    let ruby_string = cstr_to_string(rb_string_value_cstr(&mut input));

    // 调用 autocorrect (Rust 那个 crate) 的 format 方法（名字有点混淆注意区分）
    // https://rubygems.org/gems/autocorrect
    let result = autocorrect::format(&ruby_string);
    let size = result.len() as c_long;

    // 再把 Rust String 类型转换成 CString
    let result_cstring = CString::new(result).unwrap();

    rb_utf8_str_new(result_cstring.as_ptr(), size)
}

// 这个是 Ruby Extension 的标准流程，你需要定义一个 `Init_xxxx` 的初始化方法。
#[allow(non_snake_case)]
#[no_mangle]
pub extern "C" fn Init_autocorrect() {
    let name = CString::new("AutoCorrect").unwrap();

    let klass = unsafe { rb_define_module(name.as_ptr()) };
    let fn_format_name = CString::new("format").unwrap();

    let format_callback = unsafe {
        std::mem::transmute::<
            unsafe extern "C" fn(VALUE, VALUE) -> VALUE,
            unsafe extern "C" fn() -> VALUE,
        >(pub_format)
    };

    unsafe {
        // 定义 AutoCorrect.format 方法
        rb_define_module_function(klass, fn_format_name.as_ptr(), Some(format_callback), 1);
    }
}

定义 extconf.rb，本身 Ruby 有提供 mkmf，但我们额外需要 rb_sys 提供的改进，所以项目需要增加依赖：

s.add_runtime_dependency "rb_sys"

NOTE: 截止目前 rb_sys v0.1.0 编译还有 Bug，我已经提 PR 改进了，等发布新版本。所以我那个 PR 里面用的是我自己临时发布的 rb_sys1。

require "mkmf"
require "rb_sys/mkmf"

create_rust_makefile("auto-correct/autocorrect")

Rakefile 改动

require "rubygems"
require "bundler/setup"
require "bundler/gem_tasks"
require "rake/testtask"
require "rake/extensiontask"
require "bundler"

Rake::ExtensionTask.new("autocorrect") do |ext|
  ext.lib_dir = "lib/auto-correct"
  ext.source_pattern = "*.{rs,toml}"
end

这样你就有 rake compile 命令了，执行它，会将 Rust 代码编译成一个 autocorrect.bundle 的文件，放到 lib/auto-correct 目录，于是我们就可以在 Ruby 里面调用 Rust 函数了。

最后效果演示和意义

之前 Ruby 实现的相同逻辑与 Rust 实现的版本基本上是完全一致的（正则、规则、处理流程基本完全），甚至在 Rust 实现的 AutoCorrect 版本里面后面我又增加了更多的细节。

Rust 实现的性能结果

Warming up --------------------------------------
     format 50 chars     1.886k i/100ms
    format 100 chars     1.060k i/100ms
    format 400 chars   342.000  i/100ms
         format_html    85.000  i/100ms
Calculating -------------------------------------
     format 50 chars     18.842k (± 1.5%) i/s -     94.300k in   5.005815s
    format 100 chars     10.357k (± 1.8%) i/s -     51.940k in   5.016770s
    format 400 chars      3.336k (± 2.2%) i/s -     16.758k in   5.026230s
         format_html    839.761  (± 2.1%) i/s -      4.250k in   5.063225s

用上面方式集成 Rust 实现以后

Warming up --------------------------------------
     format 50 chars    12.376k i/100ms
    format 100 chars     6.918k i/100ms
    format 400 chars     1.944k i/100ms
         format_html   617.000  i/100ms
Calculating -------------------------------------
     format 50 chars    120.884k (± 4.8%) i/s -    606.424k in   5.031500s
    format 100 chars     67.903k (± 3.9%) i/s -    345.900k in   5.102803s
    format 400 chars     19.024k (± 2.9%) i/s -     95.256k in   5.011560s
         format_html      6.004k (± 2.3%) i/s -     30.233k in   5.038348s

🎉 性能提升 6 - 10 倍

参考内容

目前 Rust 社区里面似乎还没有太多 Rust 集成的例子，如果也你想这么做，可以阅读以下 auto-correct 这个 Gem 这个 PR 的变更内容。

https://github.com/huacnlee/auto-correct/pull/17

VS Code 插件 - AutoCorrect 自动纠正代码中的中英文空格写法

huacnlee — Thu, 01 Jul 2021 21:56:02 +0800

基于 Rust 编写的 CLI 工具，用于自动纠正文案，给 CJK（中文、日语、韩语）与英文混写的场景，补充正确的空格，同时尝试以安全的方式自动纠正标点符号等等。

除了纯文本的自动纠正以外，AutoCorrect 基于 Parser 的方式对各种类型源代码文件支持，能自动识别文件名，并准确找到字符串、注释做自动纠正。

基本能支持所有的语言，实现逻辑简单，基于语言的方言做了 Parser，只处理字符串、注释部分，其他的忽略。

AutoCorrect 的方案最早于 2013 年出现于 Ruby China 的项目，并逐步完善规则细节，当前准确率较高（级少数异常情况），你可以放心用来辅助你完整自动纠正动作。

https://ruby-china.org/topics/20489

本来最早的时候，只是写了库，用来解决 Ruby, Go, Rust 项目里面使用，后面逐渐发现，深入一点实现，可以搞成一个 fmt 工具，自动处理，加上当前 VS Code 插件的能力，可以搞一个保存的时候自动纠正。

VS Code 插件

https://marketplace.visualstudio.com/items?itemName=huacnlee.autocorrect

AutoCorrect 设计的原则是类似 Gofmt 默认开启，在 VS Code 保存的时候会执行格式化。

效果演示

CLI 工具安装

https://github.com/huacnlee/autocorrect

希望这个小工具能帮到你改善项目中的文档、注释、文案，也期望能帮助改善中文开源社区项目的文案细节。

Standard - Ruby 风格标准

huacnlee — Fri, 05 Mar 2021 14:15:08 +0800

以前大家可能都在用 Rubocop，但实际上 Rubocop 没有标准的，并且 Rubycop 默认的规则还特别不受社区待见，比如 Rails，绝大多数项目都会又一个自己的 .rubocop.yml。

我也是在我的各种项目里面都有单独的 .rubocop.yml 来覆盖默认的 Rubocop 规则，尤其是其中“单引号”规则，及其讨厌。

关于单引号 or 双引号的问题，也有过 Issue 讨论，作者和主要贡献者认为此项依然有争议，于是问题搁置的。

实际上从统计情况来看，社区的著名项目几乎（也包括各种热门 Gem 比如：Devise、Doorkeeper、CarrierWave 以及 Rails）他们都在使用双引号。

于是有人认为我们可能需要一套标准了。

Standard Ruby 1.0

https://blog.testdouble.com/posts/2021-03-04-announcing-standard-ruby-1.0/

项目地址

https://github.com/testdouble/standard

重点特性

不需要配置，以后都是统一的标准。

2 spaces – for indentation
Double quotes for string literals - because pre-committing to whether you'll need interpolation in a string slows people down
1.9 hash syntax - When all the keys in a hash literal are symbols, Standard enforces Ruby 1.9's {hash: syntax}
Braces for single-line blocks - Require {/} for one-line blocks, but allow either braces or do/end for multiline blocks. Like using do/end for multiline blocks? Prefer {/} when chaining? A fan of expressing intent with Jim Weirich's semantic block approach? Standard lets you do you!
Leading dots on multi-line method chains - chosen for these reasons.
Spaces inside blocks, but not hash literals - In Ruby, the { and } characters do a lot of heavy lifting. To visually distinguish hash literals from blocks, Standard enforces that (like arrays), no leading or trailing spaces be added to pad hashes And a good deal more

效果演示

我用 Homeland 试了一下，下面是一些特别变化的地方：

-        render json: { ok: 1 }
+        render json: {ok: 1}

{} 在 Hash 的时候，将会去掉左右的空格，这个场景，可能我需要一段时间适应，我们在 Go 里面也是左右带空格的，它这么定义估计是保持和 []、() 一致。

- scope :popular, -> {where("likes_count > 5")}
+ scope :popular, -> { where("likes_count > 5") }

{} 在 Block 的场景，左右空格依然还保留的。

一篇很详细的 Ruby 3.0 新特性介绍

huacnlee — Fri, 25 Dec 2020 23:36:22 +0800

https://bigbinary.com/blog/ruby-3-features

Ruby with Jemalloc Docker 镜像

huacnlee — Tue, 22 Dec 2020 21:08:53 +0800

今天花点时间基于 Docker 官方的 Ruby 打包了一个带有 Jemalloc 的 Ruby Docker Image

https://hub.docker.com/r/rubychina/ruby

介绍

This is a fork of docker-library/ruby built with jemalloc.

当前已经打包的版本：

如果有需要更新，可以往这个地址提及 PR

https://github.com/ruby-china/ruby

Turbolinks 引入 prefetch 让你的网站速度起飞

huacnlee — Sat, 10 Oct 2020 00:26:46 +0800

本文分享 Turbolinks 的扩展，用于加速网页访问。

前言 / 背景

最近发现了 InstantClick 这种对网页预加载的小技巧，这种方式能有效的改进网站的访问速度。

大概原理是当用户鼠标经过链接的时候，会提前用 Ajax 的方式将网页预先加载好存入 cache，等用户点击的时候，用之前的 cache 直接渲染。

于是我还发了 Twitter 说这个事情：

Rails 内置的 Turbolinks 实际上有类似的 cache 机制，在用户来回点击页面的时候会利用 cache 提前渲染，只是没有在用户鼠标 hover 的时候进行预处理。

查了查，发现 Turblinks 的 Issue 里面也有讨论这个 turbolinks/turbolinks#313，仔细看找到了一个实现参考，于是封装了一下，并做了改进实现了一个 Turbolinks 的扩展。

https://github.com/huacnlee/turbolinks-prefetch

同时我在实现里面额外调整了 Turbolinks 的 visit 动作，如果已经有 prefetch 的动作，会直接 render 不会再次请求页面。

如你所见，目前 Ruby China 已经开启了这个功能（香港服务器），在 prefetch 产生效果的时候，基本上页面打开犹如本地网页。

Turbolinks Prefetch 的工作机制

hover --> [prefetch] --<no cache>--> [XHR fetch] -> [Turbolinks cache.put]
              |
          <exist cache / in fetching>
              |
            ignore

click --<check cache>-- exist --> [isPrefetch] -> [Turbolinks.visit advance] ---> [render page]
             |                         |                 |
             |                         |                 --async-> [fetch background] -> [render if updated]
             |                         |
             |                       <Yes>
             |                         |--- [Turbolinks.visit restore] --> render -> nothing
          No cahce
             |
             ---> [Turbolinks.visit]

Installation

$ yarn add turbolinks-prefetch

使用方式

import Turbolinks from 'turbolinks';
window.Turbolinks = Turbolinks;

import TurbolinksPrefetch from 'turbolinks-prefetch';
TurbolinksPrefetch.start();

当 Prefetch 请求的时候，将会额外发送 Purpose: prefetch 的 HTTP header，如果你需要特别忽略某些动作，你可以用到它。

比如更新阅读状态、访问量更新等动作：

class TopicsController < ApplicationController
  def show
    if request.headers["Purpose"] != "prefetch"
      # 不在 prefetch 的时候更新访问量
      @topic.increment_hit
    end
  end
end

对部分链接禁用 Prefetch

默认情况下，Turbolinks Prefetch 将会对所有的链接开启行为。

除了下面这些情况：

非同一个网站的链接 (Host / Origin 不一样)；
有新窗口打开行为的链接 target="_blank"；
有 data-remote 属性的链接;
有 data-method 属性的链接;
有 data-prefetch="false" 属性的链接;

应该说大多数的默认情况下，你不需要处理，类似 Rails UJS 这样的默认行为已经在 Turbolinks Prefetch 处理好了。

于是你可以这样来对部分链接禁用 prefetch：

<a href="https://google.com">Google</>
<a href="/topics/123" target="_blank">Open in new window</a>
<a href="/topics/123" data-method="PUT" data-remote>Put</a>
<a href="/topics/123" data-method="DELETE">Delete</a>
<a href="/topics/123" data-prefetch="false">Disable by directly</a>

项目地址

🎊 不要犹豫了，立即在你们已经有使用 Tubrolinks 的项目里面用起来吧，基本上是无缝支持。

https://github.com/huacnlee/turbolinks-prefetch

远程 - 寻一个全职 Rails 工程师 1 名，待遇 25K - 30K [已招到]

huacnlee — Mon, 07 Sep 2020 10:14:46 +0800

帮前同事发布招聘。

项目情况

工作是开发一个基于 Instagram 数据分析的系统，包括任务分发、网红管理等功能。业务核心是基于这个系统，需要长期维护。工作方式是正常工作日，按需求完成项目进度，并持续推进项目迭代。

项目要做的事情和这个项目有一些类似 https://hypetrace.com

新加坡团队都是华人，交流不是问题。

岗位要求

全职工作。
你需要有丰富的 Rails 项目开发经验，我期望是至少 3 年以上的 Rails 实际项目经验，能独立解决问题，且要求在互联网相关行业有多年经验做过各类复杂项目。
自备设备。

此岗位适合需要内陆地区定居，当地无法找到合适 Ruby 工作的同学。目前项目处于创业期，暂时只能已远程全职的方式合作，所以在待遇里面补贴进去了（也就是说待遇实际直接报高了）。

简历投递：huacnlee@gmail.com

Ruby China 已经完全升级到了 Webpacker

huacnlee — Thu, 02 Jul 2020 12:16:58 +0800

Webpacker 引入 Rails 已经很久了，实际上我已经在所有的公司项目里面用 Webpacker 来管理 Rails 项目的前端。

Homeland 项目起步比较早，老东西升级一直拖着。

做了两个步骤：

CoffeeScript 转 ES6，继续用 Sprockets 跑。
然后用 Webpacker 替代 Sprockets。

https://github.com/ruby-china/homeland/pull/1163

AuditLog - 轻松构建审查日志 / 操作日志

huacnlee — Thu, 21 May 2020 16:01:34 +0800

很多的管理后台为何安全考虑，往往会要求记录所有操作记录，以便与后期检查谁做了什么。

我们目前的系统后台就需要这样的功能，业务要求准确的记录每一个功能的使用情况。

于是在去年我就抽象出一个简单的组件 AuditLog 来实现这个功能。

AuditLog 截止目前，已经在我们系统中稳定运行了一年多，并持续记录了超过两千万条操作日志。

功能介绍

AuditLog 是一个 Rails Gem，可以让你在 Controller 里面通过 audit! 方法来实现记录用户动作，便于解决后期查询操作历史的需求。

https://github.com/rails-engine/audit-log

安装

往 Gemfile 新增

gem "audit-log"

使用

比如下面这个 Ticket 场景，分别在查阅列表、创建、更新、审核通过、删除等动作的时候，调用 audit! 方法，并传递相关参数来记录当时的情况。

class TicketsController < ApplicationController
  def index
    audit! :list_ticket, nil
  end

  def create
    if @ticket.save
      audit! :create_ticket, @ticket, payload: ticket_params
    else
      render :new
    end
  end

  def update
    if @ticket.save
      audit! :update_ticket, @ticket, payload: ticket_params
    else
      render :edit
    end
  end

  def approve
    if @ticket.approve
      audit! :approve_ticket, @ticket, payload: ticket_params
    end
  end

  def destroy
    # store original attributes for destroy for keep values
    audit! :delete_ticket, nil, @ticket.attributes
  end

  private

    def ticket_params
      params.required(:ticket).permit!(:title, :description, :status)
    end
end

除此此外，也可以在其他地方直接调用函数来记录：

AuditLog.audit!(:update_password, @user, payload: { ip: request.remote_ip })

你可以通过撰写 I18n 配置文件来对动作进行中文描述，增加 config/locales/audit-log.zh-CN.yml

zh-CN:
  audit_log:
    action:
      sign_in: 登录
      update_password: 修改密码
      create_address: 添加住址
      list_ticket: 查看工单列表
      create_ticket: 创建工单
      update_ticket: 更新工单
      delete_ticket: 删除工单
      approve_ticket: 审批工单

下面是我们系统的实际截图

列表页面，可以按操作人、日期、动作类型来查询

单个记录详情界面

项目地址

https://github.com/rails-engine/audit-log

The Practical Effects of the GVL on Scaling in Ruby

huacnlee — Fri, 15 May 2020 11:11:26 +0800

https://www.speedshop.co/2020/05/11/the-ruby-gvl-and-scaling.html

最轻量级的 Rails 异步任务方案

huacnlee — Tue, 12 May 2020 17:39:19 +0800

Sidekiq 、Resque 这类 Background Job 服务当下已成为几乎所有 Rails 应用程序的标准配置。

但某些更微小的应用场景我们会发现单独部署一个 Sidekiq 进程有些复杂的，而且因为 Sidekiq 我们还得部署一个 Redis，我们往往只需要简单的异步而已，这个时候我们很想像 Go、Node.js 里面那样直接开一个异步动作处理或者自己搞一个消息订阅，这样部署可以和 Web 服务在同一个进程，无需复杂的额外部署。

难道 Rails 应用必须标配一个额外的后台异步服务么？ 🙅🏻 不，我们有别的选择！

我分析发现，实际上 Rails ActiveJob 内置的 AsyncAdapter 是可以做到这样的。

如何使用

class AsyncJob < ActiveJob::Base
  # 为了让测试好验证，我们配置 test 环境用 inline 模式，其他时候用 AsyncAdapter
  self.queue_adapter = Rails.env.test? ? :inline : ActiveJob::QueueAdapters::AsyncAdapter.new(
    min_threads: 4,
    max_threads: 10 * Concurrent.processor_count)
end

class NotifyTopicNodeChangedJob < AsyncJob
  def perform
    # 轻量的异步逻辑
  end
end

需要注意点

关于 AsyncAdapter 的使用，Rails 官方 API 有提到

https://api.rubyonrails.org/classes/ActiveJob/QueueAdapters/AsyncAdapter.html

This is the default queue adapter. It's well-suited for dev/test since it doesn't need an external infrastructure, but it's a poor fit for production since it drops pending jobs on restart.

翻译谁都会，我说说这句我的理解，大概意思说这个本来是 ActiveJob 默认的 Adapter，它可以用在 dev/test 环境这样可以不需要额外的架构（异步服务），但不建议在生产环境用，因为重启会导致等待中 / 进行中任务丢失。

我的建议用于可以容错，能容忍微小数据丢失的场景，比如访问量 +1，重新统计数据（再次调用能修复），或者个别时候对数据不敏感的场景比如个人博客。

The adapter uses a Concurrent Ruby thread pool to schedule and execute jobs. Since jobs share a single thread pool, long-running jobs will block short-lived jobs. Fine for dev/test; bad for production.

这句意思说：此 Adapter 用 Concurrent 这个 Gem 利用 Ruby 的线程池方式来计划和执行异步任务，因为目前 ActiveJob::AsyncAdapter 的设计是所有异步任务都用的一个线程池（一个进程里面一个线程池），如果有重的异步任务，它们未结束之前会堵塞同一进程的其他任务，包括 HTTP 服务。

鉴于 Ruby GIL 的机制，上面的情况，同一个进程内，如果有重的耗费 CPU 的动作执行期间，可能会导致这段期间这个进程无法响应普通的 HTTP 请求，从而堵塞正常的 Web 服务。

在此根据我的理解，IO 类的异步任务，用于 AsyncAdapter 其实是可以的，在等待 IO 响应的期间，多线程能起作用，HTTP 服务可以继续处理，同时由于我们往往有多个 Puma worker，只要避免在 AsyncAdapter 的 Job 内出现那种非常耗费 CPU 的异步任务，对服务的影响是可以接受的。

总结

前面说那么多，我们到底能不能用 AsyncAdapter，什么场景用合适？

非数据敏感场景，能接受个别任务丢失；
数据不能丢，但再次调用，能重建；
确保部署多个 Puma worker；
个人博客，初创期的网站，需要节约内存的场景；
低 CPU 开销的任务；
比如采集动作、清理数据动作；

🌺本文只是告诉大家一个可选的方案，在资源足够的情况下，请用 Sidekiq 效果更佳！

其他选择

SuckerPunchAdapter - 它设计用来解决把异步任务泡在 Web Server 同一个进程内，我阅读了它的实现，在重启上比 AsyncAdapter 多一些优化，它会暂停重启一段时间，让异步任务有时间可以消化完。

SQLBuilder - 一个简单的 SQL 生成器

huacnlee — Fri, 03 Jan 2020 11:18:29 +0800

最近公司的 Rails 项目里面有非 ActiveRecord 的数据库需要用 SQL 查询，比如 Amazon Redshift 之类的，这些表没有 Model，实现的时候查询基本上是手写 SQL，纯字符串拼接那种。

随着业务越来越复杂，SQL 拼接也越来越复杂，于是开始质疑为何不用类似 AcitveRecord 那种 DSL 的查询方式 where("name = ?", params[:name]).where(...).limit(100)。

然而我查询了 ActiveRecord 以及 Ruby 社区现成的 Gem 发现，干这个事情的居然没一个能满足的，我一开始本以为 AcitveRecord 的 Arel 可以干这个事情，结果尝试下来看，那个查询方式和 ActiveRecord 的 DSL 用法不一样，而其他社区里面做这类事情的比如 mini_sql 也是以执行为主的，需要依赖 SQL Connection。

于是我按照我们的场景构造了一个简化的 SQL Builder，让它只干一件事情：“基于 DSL 生成 SQL 语句”

功能特点

针对纯写 SQL 的场景设计，某些复杂业务查询你可能不一定想创建出 ActiveRecord Model；
仅做 SQL Builder 的事情；
类似 ActiveRecord style 的 DSL；
用 ActiveRecord 内置的 Sanitize 函数来处理参数，确保安全；
更简单的逻辑，以适应各种奇怪的 SQL 数据库，sql-builder 没有复杂的 SQL 生成，仅仅帮你做拼接简化。

安装

往 Gemfile 增加：

gem "sql-builder"

使用

一个简单的查询

SQLBuilder.new("SELECT * FROM users")
  .where("name = ?", "hello world")
  .where("status != ?", 1)
  .order("created_at desc")
  .order("id asc")
  .page(1)
  .per(20)
  .to_sql

=> "SELECT * FROM users WHERE name = 'hello world' AND status != 1 ORDER BY created_at desc, id asc LIMIT 20 OFFSET 0"

结合实际业务场景，我们的 SQL 条件可能会很复杂：

query = SQLBuilder.new("SELECT users.name, users.age, user_profiles.bio, user_profiles.avatar FROM users INNER JOIN user_profiles ON users.id = user_profiles.user_id")

# conditions by params
query.where("age >= ?", params[:age]) unless params[:age].blank?
query.where("status = ?", params[:status]) unless params[:status].nil?
if params[:created_at_from] && params[:created_at_to]
  query.where("created_at >= ? and created_at <= ?", params[:created_at_from], params[:created_at_to])
end
query.order("id desc").limit(100).to_sql

=> "SELECT users.name, users.age, user_profiles.bio, user_profiles.avatar FROM users INNER JOIN user_profiles ON users.id = user_profiles.user_id WHERE age >= 18 AND status = 3 AND created_at >= '2020-01-03 10:54:08 +0800' and created_at <= '2020-01-03 10:54:08 +0800' ORDER BY id desc LIMIT 100 OFFSET 0"

从上面这段你可以看到，那些复杂的 SQL 依然还是你自己写的，SQLBuilder 只是在 where、order、limit 这些场景可以帮你处理复杂逻辑，因此，它几乎不会因为内部生成了某些 SQL 数据库不支持的语法。

项目地址

https://github.com/huacnlee/sql-builder

ActionText Lite - 我终于受不了 ActionText，做了一个 Lite 版本

huacnlee — Thu, 10 Oct 2019 11:49:19 +0800

关于 ActionText 的问题，我已经吐槽不止一两次了...

ActionText 内置的 HTML sanitize 带上了不少严苛的规则，比如不允许 style，就是你换了其他的所见即所得编辑器，编辑好的 HTML 输出还是会少了东西。还是没有 API，感觉可以自己实现一个 Lite 版本的 ActionText 了，只用 ActionText 存储的部分。 @huacnlee https://twitter.com/huacnlee/status/1177133855288909824

Action Text 的问题

Action Text 默认高度集成了 Trix，但实际情况是 Trix 在 90% 的项目情况下都不符合实际的需求，我们的用户、后台编辑人员不喜欢它。😩
Active Storage 为默认的附件存储，也是高度集成，难以清理干净，可它往往也不符合我们的需求，我们正文的附件、图片往往是需要公开的 URL 地址（Active Storage 目前不支持）。
Action Text 带有默认的 HTML sanitize 规则，但那个规则过于严苛，比如 style 属性不支持，图片宽度不支持等等，然而有些时候我们可能不一定需要 sanitize 因为内容可能是后台编辑自己发布的，而不是用户的（用户发布的我们可以自己做 sanitize） 🥺

我也是坚持用 ActiveText，也尝试在 Trix 和 ActionText 的基础上尝试解决以上问题，但实际情况发现做起来很繁琐，回头来看，当初用 ActionText 不就是为了那个将 RichText 独立存储到单独表的设计么，于是阅读源代码找到实现，单独剥离出来。

于是我把它整理成了 ActionText Lite。

ActionText Lite 干什么事情：

类似 ActiveText 的存储 API，兼容 ActionText 的 Model API，你可以保持那个好的东西；
数据存储依然保持在 ActionText 那个 action_text_rich_texts 表里面，所以引入它，只是会让 ActionText 没了 Trix 和 ActiveStorage 的集成；
你存什么进去，就拿什么出来，不做任何 sanitize 处理，把规则交给你自己处理。

使用

gem "actiontext-lite"

然后安装 ActionText 的 Migration 命令（如果已经有 ActionText 做过，可以不用执行）

$ rails action_text_lite:install

接下来原来使用 ActiveText (Model 里面哪些功能），你可以继续保持：

class Post < ApplicationRecord
  has_rich_text :body
end

@post = Post.new(body: "Hello world")
@post.body.to_s

然后缺失的其他部分怎么办？

附件、图片存储，你可以用 CarrierWave
所见即所得编辑器 - 可以尝试 ckeditor5-build-rails

项目地址

https://github.com/huacnlee/actiontext-lite

Rails 默认 Session 的存储方式：CookieStore

huacnlee — Tue, 24 Sep 2019 17:54:25 +0800

This cookie-based session store is the Rails default. It is dramatically faster than the alternatives.

https://api.rubyonrails.org/classes/ActionDispatch/Session/CookieStore.html

或许很多人不知道这个默认规则！

面试的时候不熟悉 Rails 的人会想当然的回答 Session 是存在服务端的，再一问存服务端哪里的，基本就蒙了 😇，有说 Redis，更有说进程内存里面。

实际上这个是一个安全的做法，CookieStore 会基于 secure_key_base 对 Session 内容进行 aes-256-cbc 加密，并将最终加密以 Base64 的结果返回作为 Cookie。

于是我们会看到 __your_app_session 这样的 Cookie 普遍在 Rails 项目里面存在：

Rails 哲学里面提倡最佳实践，CookieStore 应该算是一个，不需要依赖服务端的持久化数据库（Redis / Memcache / MySQL）既可实现。

CookieStore 的优点

简单有效，无需额外的后端存储，开箱即用；
相对与其他存储方式，它很快，只需解密，无 IO 请求；
因为 Session 加密存储在用户浏览器，所以不回因为后端存储丢失而导致 Session 失效；
我们依然可以通过改变 secure_key_base 的方式来使之前的 Session 失效；

缺点

浏览器 Cookie 限制，加密过后的内容不能超过 4K，所以我们不能在 Session 里面放过多内容；
如果你的静态资源没有独立域名的话，静态页面的请求 Header 也会多余带这个 Session 的值；
Session 存储过大内容到了客户端，会导致用户访问服务错误，切难以被发现；
如果那种验证 code 存 Session 里面，会有重现攻击（Replay attacks）风险 🚨，参考：RuCaptcha 说明；

一些提示

flash 实际上也是存储在 Session 里面的；
尽量在 session 里面存 user_id 即可，别把整个 user 对象放进去；
因为客户端实际上能拿到 Session 也可以通过请求 set-cookie header 的方式修改 Cookie，所以 secure_key_base 一定要保密，一旦发现泄漏，尽快改掉；
改掉 secure_key_base 的副作用是已经有 Session 会因为无法失败而被当成失效的，表现上看就是用户需要重新登录；
避免敏感数据存 Session 里面，以免被重现攻击；

🔖如果你掌控不了，或目前项目已有敏感数据在 Session 里面，图省事你可以换成 CacheStore (Rails >= 5.2)，Cache 存哪里 Session 就存哪里。

参考阅读

Enumize - 扩展 ActiveRecord::Enum 增加实用方法

huacnlee — Mon, 24 Jun 2019 14:32:01 +0800

Rails 4.2 (如果没记错）给我们带来了官方的 Enum 解决方案，目前大家都在使用它了。

比如：

class Book
  enum status: %i[draft published archived]
end

然而我们在使用的时候会发现，往往我们需要将 status 字段用中文或其他的方式在界面上显示，而不是一个 draft / published / archived。

于是很多人可能会这样：

class Book
  enum status: %i[draft published archived]

  def status_name
    case status
    when "draft" then "草稿"
    when "published" then "已发布"
    when "archived" then "归档"
    end
  end
end

然后随着项目的推进，你会发现你的 Model 里面大量有这种函数。

为了解决这个问题，我们最初在自己的项目里面实现了一个扩展，用于代替 enum 的定义，给它增加一些函数扩展，现在提取成一个 Gem，可以方便以后使用。

使用方法

gem "enumize"

然后你的原来的 enum 定义不需要改变，这个 Gem 已经覆盖了那个方法。

所以，你可以认为这个 Gem 的引入不会改变 ActiveRecord::Enum 的原有使用方式，你可以无缝的集成到你的项目中！

class Book
  enum status: %i[draft published archived]
end

现在你有了 status_name, status_color, status_value 以及 Book.status_options 这些方法：

#{attribute}_name - 返回 name 的 I18n 信息，用于显示
#{attribute}_color - 返回从 I18n 里面读取 color 的信息（如果你项目用不到可以忽略它）
#{attribute}_value - 返回原始的数据库值，用来代替 Book.statuses[@book.status]
Book.#{attribute}_options - 返回一个 Array，用于 select tag，比如 <%= f.select :status, Book.status_options %>.

配置 I18n:

config/locales/en.yml

en:
  activerecord:
    enums:
      book:
        status:
          draft: Drafting
          published: Published
          archived: Archived
        status_color:
          draft: "#999999"
          published: "green"
          archived: "red"

config/locales/zh-CN.yml

zh-CN:
  activerecord:
    enums:
      book:
        status:
          draft: "草稿"
          published: "已发布"
          archived: "归档"

下面是使用的演示：

irb> @book = Book.new(status: :draft)
irb> @book.status
"draft"
irb> @book.draft?
true
irb> @book.published?
false
irb> @book.status_value
0
irb> @book.status_name
"草稿"
irb> @book.status_color
"#999999"

status_options 方法用在 View 里面的演示：

<% form_for(@book) do |f| %>
  <%= f.text_field :name %>
  <%= f.select :status, Book.status_options %>
  <%= f.submit %>
<% end >

项目地址

https://github.com/huacnlee/enumize

全新 rails-settings-cached 设计 2.x 发布

huacnlee — Fri, 26 Apr 2019 14:38:32 +0800

如果你的项目内在使用 rails-settings-cached，升级请一定注意 2.0 的变化，否则将会无法运行。

rails-settings-cached 2.x 全新设计了 API，新的版本会兼容老的数据（在数据库中的），但使用方式不兼容。所以在升级之前请阅读 2.x 的使用介绍，并根据需要调整你的项目使用。

全新的 API 设计；
不在支持 scope (include RailsSettings::Extend) 的方式；

之前的这个支持以实际来看，不如 Rails 的 serialize 功能好用，2.0 不在支持这种数据读取了，如果你的项目在使用，可以尝试这样的方式兼容。

不在需要 YAML 的默认配置文件，所有都在 Setting model 指定；
除非你用 field 定义设置键，否则是无法使用的；

例如：

class Setting < RailsSettings::Base
  field :host, default: "http://example.com"
  field :readonly_item, type: :integer, default: 100, readonly: true
  field :user_limits, type: :integer, default: 1
  field :admin_emails, type: :array, default: %w[admin@rubyonrails.org]
  field :captcha_enable, type: :boolean, default: 1
  field :smtp_settings, type: :hash, default: {
    host: "foo.com",
    username: "foo@bar.com",
    password: "123456"
  }
end

新的设计对性能做了改进，以实际的项目应用经验来看，往往我们一个页面会有很多的 key 调用，所以 2.x 版本开始，cache 和 db 的载入是一次的，一条 SQL 或一次缓存的访问，同一个请求周期设置信息是可以重复利用的。

https://github.com/huacnlee/rails-settings-cached