sontixyou blog

技術まわり、ガジェット関連について

awaitとawait?について

tokio crateを使って、非同期処理を書きたい場合、ほぼほぼasync await構文を書くと思う。 私は、awaitとawait?の違い、使い分けがいまいちわからないでの、頭の整理がてら書いていく。

await

awaitは、非同期関数の結果を待つ。async関数やブロックから呼び出され、

非同期で処理が完了するまで実行を停止します。これにより、他のタスクが並行して実行されることが可能になります。

また、エラーが発生時は、自分でエラーをハンドリングする必要がある。

だが、await?より細かいエラーをハンドリングできそうな印象あるが、コード量は少し増える。

#[tokio::main]
async fn main() {
    let result = some_async_function().await;
    println!("Result: {:?}", result);
}

async fn some_async_function() -> u32 {
    42
}

いい例なのかはわからん。

use reqwest::Error;

#[tokio::main]
async fn main() -> Result<(), Option<Error>> {
    let response = make_request("https://xjsonplaceholder.typicode.com/posts/1").await?;
    println!("Response: {:?}", response);
    Ok(())
}

async fn make_request(url: &str) -> Result<String, Option<Error>> {
    let response = reqwest::get(url).await;
    match response {
        Ok(response) => {
            // レスポンスのステータスコードをチェックし、エラーハンドリング
            if response.status().is_success() {
                let body = response.text().await?;
                Ok(body)
            } else {
                // ステータスコードが成功でない場合はエラーを返す
                return Err(response.error_for_status_ref().err());
            }
        }
        Err(e) => Err(Some(e)),
    }
}

await?

非同期関数の完了を待ちつつ、Result型のエラーハンドリングも行います。

エラーが発生した場合には関数を終了し、エラーを呼び出し元に返します。

use std::error::Error;

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    let result = some_async_function().await?;
    println!("Result: {}", &result);
    Ok(())
}

async fn some_async_function() -> Result<u32, Box<dyn Error>> {
    Ok(42)
}

ほかの事例だとこんな例

use reqwest::Error;

#[tokio::main]
async fn main() -> Result<(), Option<Error>> {
    let response = make_request("https://xjsonplaceholder.typicode.com/posts/1").await?;
    println!("Response: {:?}", response);
    Ok(())
}

async fn make_request(url: &str) -> Result<String, Option<Error>> {
    let response = reqwest::get(url).await?;

    // レスポンスのステータスコードをチェックし、エラーハンドリング
   // ここでresponseがエラーかを判断するにはstatusコードを確認する。
    if response.status().is_success() {
        let body = response.text().await?;
        Ok(body)
    } else {
        // ステータスコードが成功でない場合はエラーを返す
        return Err(response.error_for_status_ref().err());
    }
}

axumで作ったAPIのテストを書く際にハマった話

背景

2024/6あたりにRustでWebアプリ作れたら、面白いかもと思い、フレームワークなんなりを探していた。

そんな中で、axum(アクサム)を見つけた。Youtubeの外国人が、アクサムと言っていたので、たぶん日本語読みはアクサムが正しい。

github.com

このaxumを使って、APIを試しに作った。そのときに、実装コードを書くだけではつまらないので、テストコードも書くことにした。

しかし、テストコードを書くときに2〜3時間くらい、どんな感じでテストを書けば良いのかわからず、ハマったので記録として残しておく。

問題

普段、私はGitHubを使って、コード管理している。

そのため、ローカル環境とGitHub ActionsのCI両方で、テストをパスする必要が出てくる。

ひよっこRustaceanのわたしは、次のようなテストコードを書いていた。

このテストコードを実行すると、ローカル環境ではパスするが、GitHub Actions上ではパスしない。

GitHub Actions上でサーバーを起動しっぱなしになるようで、テストの実行が完了するが、サーバーが起動しつづけているので、ワークフローが完了しない。

// main.rs
// 良くない例

use axum::{
    routing::get,
    Router,
};

#[tokio::main]
async fn main() {
    // build our application with a single route
    let app = Router::new().route("/", get(|| async { "Hello, World!" }));

    // run our app with hyper, listening globally on port 3000
    let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();
    axum::serve(listener, app).await.unwrap();
}

mod tests {
    use reqwest::StatusCode;
    use std::process::Command;

    #[test]
    fn test_hello_world() {
        Command::new("cargo").arg("run").output().unwrap();

        let client = reqwest::blocking::Client::new();
        let response = client.get("http://0.0.0.0:3000/").send().unwrap();

        assert_eq!(response.status(), StatusCode::OK);
        let text = response.text().unwrap();
        assert_eq!(text, "Hello, World!");
    }
}

解決

axum-testというcrateを追加することで、axumのモックサーバーを使うことができる。

github.com

axumのリポジトリには、テスト周りの記述がなく、このcrateを探すまでにとても苦労した。

また、axum-testについて紹介しているブログ記事等も少なく感じたので、紹介することにした。

Rustのmoduleとcrate

背景

私は、今までC言語Rubyくらいしかプログミング経験がなかった。 最近、Rustを書き始めたことで、初めましての概念がたくさん出てきたので、頭の整理がてらまとめる。

ここに書く内容は、Rust Programming Languageの原文を読んだことのまとめである。

doc.rust-lang.org

module

moduleには2種類ある。パブリックかプライベートかの2種類。

先頭にmodがつくかつかないかの違いだけ。

moduleはネストできるし、関数を中に定義することも可能。

crate

Rustには2種類のcrateがある。

  • binary crate
  • library crate

binary crate

これはbinary crate。

各クレートには、実行ファイルが実行されたときに何が起こるかを定義するmainと呼ばれる関数を持つ必要がある。

// main.rs
fn main {
  println!('hello rust');
}

library crate

main関数を持たず、複数のプロジェクトで供することを目的として機能、関数を指す

これはlibrary crate

// number_calculator.rs
pub fn add(a: i32, b: i32) -> i32 {
    a + b
}

package

単数または複数のcrateを束ねたものがpackage

基本的に、cargo.tomlに書いてあるnameはpackage

関係でいうと、package has many crates or one crate.

crate has many modules or one module.という感じ。

全体のイメージはこんな感じ。

github.com

RubyKaigiに行ってくる

去年に引き続き、RubyKaigi2024に行く。

セッションを聞くことにも重視したいが、他にも重視したいことがある。 書き出すとこんな感じ。要はできるだけ多くのRubyistと話して、交流したい。

  • 国内にいながら海外のエンジニアさんとも交流できる貴重な機会であるため、普段どのように開発しているのか等の情報を交換したい。
  • 海外カンファレンスとどういったことが違うのかや世界でのRuby,Railsの立場とかについて、Web業界で働いてるエンジニアさんの生の声や考えを知りたい
  • 技術、開発プロセス、普段活用しているgem周りについても意見交換したりしたい。

身の回りのRust

背景

2023~2024年の3月にかけて、自分の身の回りでRustで作られているツールが増えていると感じている。
自分が使っているツールの中でもRustで作られているものがある。これらのツールをまとめたことがなかったため、まとめる。

身の回りのRust

Ruby

RubyはJust-In-Time(JITコンパイラという機能を備えており、その中でもYJITがRustによって実装されている。

CLI

lsコマンド

今までは、Mac標準のlsコマンドを使用していた。そこから、lsdへ切り替えた。

github.com

grepコマンド

今までは、Mac標準のgrepコマンドを使用していた。そこから、ripgrepへ切り替えた。

標準のgrepコマンドより高速に動くので、とてもいい。また、Neovimで使用しているプラグインでも活用しているため、このツールは欠かせない。

github.com

ターミナルエミュレーター

私は、2年前ほどからweztermというターミナルエミュレーターを使用しています。 weztermは日本語を正常に入力できて、表示できるのでとても良いです。

github.com

プロンプト

シェルのプロンプトをカスタマイズするものとして、starshipを使用しています。

github.com

最後に

仕事で使っている言語からツールまでの各所で、私はRustのお世話になっていました。こんな状態なので、そろそろRustを使えるようになる必要があるのかなぁと考えたりしています。

Active Recordのカラムの暗号化でソートできずにハマった

背景

記事のタイトルを保存するtitleカラムがあるとします。このtitleカラムは、記事一覧ページでtitleの並び替え機能があるとします。
あるとき、Railsで文字列を保存するtitleカラムを暗号化しようと話題が出ました。

カラムの暗号化

Railsには、2種類の暗号化が用意されています。

カラムを並び替えしたい

以下のレコードをencrypted_titleカラムを指定して、並び替えしたいとします。

mysql> select id, encrypted_title, title from posts;
+----+--------------------------------------------------------------------------------------------+---------+
| id | encrypted_title                                                                          | titile |
+----+--------------------------------------------------------------------------------------------+---------+
| 38 | {"p":"PCAd","h":{"iv":"0/OwqRAVpqf4HXBP","at":"CgzTlnJnc89XS+alEZ3G7Q=="}}                 | 123     |
| 46 | {"p":"PCAd","h":{"iv":"0/OwqRAVpqf4HZGE","at":"CgzTlnJnc89XS+alEZ3G7Q=="}}                 | あかさたな     |
| 47 | {"p":"PCAd","h":{"iv":"0/OwqRAVpqf4HABC","at":"CgzTlnJnc89XS+alEZ3G7Q=="}}                 | 一覧     |
| 48 | {"p":"PCAd","h":{"iv":"0/OwqRAVpqf4HABC","at":"CgzTlnJnc89XS+alEZ3G7Q=="}}                 | 一蘭     |
+----+--------------------------------------------------------------------------------------------+---------+

普段なら、次のようなコードで並び替えをします。

Post.all.order(encrypted_title: :desc) # titleカラムを降順で並び替えた結果と同じになってほしい。

このコードを実行しても、titleカラムを降順で並び替えた結果と同じにはなりません。
なぜなら、encrypted_titleの暗号化された文字列で並び替えをされてしまうため。上のコードを実行したタイミングでは、encrypted_titileは復号化されていません。。。

並び替えするには。。。

次のようなコードを実行する必要があります。自分が求めている並び替えをSQLでできないため、Rubyの世界で並び替えをやります。

Post.all.sort_by { |p| p.encrypted_title }

しかし、この手法にはパフォーマンス悪化の懸念があります。 例えば、postsテーブルに10万件レコードあるとき、Rubyの世界での並び替えはSQLでの並び替えより速度が劣るはず。
なので、どうしようもないときの最終手段で用いたほうがいいと考えています。

最後に

今までカラムの暗号化するのは、センシティブな情報を含むパスワード等しかやったことがなかったです。
今回の事例で暗号化の理解や並び替えについての知識を身につけられたのはよかよかです!

Neovimにtypoを検知する仕組みを追加した

背景

Neovimには、デフォルトでスペルチェックする機能があります。
しかし、このスペルチェックはマークダウンファイルに対しては有効ですが、コード内の英単語をチェックしてくれません。
そこでコード内の英単語もスペルチェックしてくれる仕組みを導入することにしました。

typoを検知する仕組みをどうやるか調査

Neovimで使用できるプラグインを探すところからです。
私が探した結果は選択肢は2つありました。

① 次のプラグインを導入すること github.com

② LSPを利用して、typoを検知する ※ LSPの設定が必要 github.com

私のNeovimの設定では、Masonプラグインを既に利用していました。 さらに、LSPを利用してtypo検知できたほうが作業しやすそうな気がしたので、②を採用しました。

導入

Neovim上で次のコマンドを実行するだけです。

:MasonInstall typos-lsp

ここのページのコマンドを参考にしました。

mason-registry.dev

動作確認

canceledのつづりを間違えると、次のように指摘してくれます。やったぜ🎉

最後に

さらば、すべてのtypoよ!!!!!!