[Rust]自作マクロ定義の中で外部クレートを使う場合、別のプロジェクトからそのマクロを使っても、再度同じ外部クレートの依存関係をCargo.tomlに記述しなくて済むような方法がわからない

Question

前提

Rustでの質問で、前提の話になります。

ブラウザ上で動作するwasmに、wasm_bindgen_futuresクレートの関数spawn_localを使っています。

非同期処理(async、await)を要求するメソッドをasyncブロックに仕込んでこの関数に引数で与えたいとした場合に起きた話です。

ライフタイムの短い参照はasyncブロック内に入れられません。

例えばeguiクレートの頻出のパラメータui: &mut Uiをasyncブロック内部に入れようと思ってui.label()などを使ってreqwest::get()の結果の値を非同期にスクリーンに表示したいと考えた場合など、そういうときにライフタイムの問題が言われ、コンパイルできません。

wasmで典型的なパターンの問題と思われます。

fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
    egui::TopBottomPanel::top("select_tab").show(ctx, |ui| {
        wasm_bindgen_futures::spawn_local(async {
            let ip = reqwest::get("http://httpbin.org/ip")
                .await
                .unwrap()
                .text()
                .await
                .unwrap();
            // ui.label(ip); // 'staticなFuture内部にライフタイムの短い参照uiを入れられない
        });
    });
}

解決策として次のように考えました。

build_perform!(ip, i32, String);

fn display(&self, ui: &mut Ui) -> Option<()> {
    let f = async {
        reqwest::get("http://httpbin.org/ip")
            .await
            .unwrap()
            .text()
            .await
            .unwrap()
    };
    ip::perform::set_begin(1, f);
    let ip = ip::perform::try_fetch(1)?;
    ui.label(ip);
    Some(())
}

Futureトレイト内で非同期処理を行なった結果の値を外に出そうと考えました。

この関数は普通に使うには、与えられる引数のトレイト境界条件がFuture<Output = ()> + 'staticであることにより戻り値が()であることもあって、簡単にasyncブロックから外に値を取り出せないところあるためが使いづらいです。

これを解決しようとしてみています。

本題

創作したマクロのGitHubはこちらになります。
https://github.com/kano1101/perform-wasm/tree/3e4a68f0135baa8b5873826685ee810a314c993b

また、創作したマクロを使うコードもGitHubに保存しました。
https://github.com/kano1101/reexport/tree/1d1cb4651e92393a78235301f3c2acf3a436384f

今回は、これらのコードを使いたい場合に設定する「依存関係」についてが解決したい問題です。

実現したいこと

創作したマクロのプロジェクトはperform_wasmと名付けました。

perform_wasm中のマクロ内では、以下のクレートのモジュールをuseしています。

• once_cell
• tokio
• wasm_bindgen_futures

今の状況では、新たなプロジェクトでこのマクロを使用したい場合、上にリストした3つのクレートをそのプロジェクトでふたたび同じようにCargo.tomlに追加する必要があります。これが問題です！

perform_wasmを新たなプロジェクトが使うたびに毎回、同じ依存関係を記述しなければならないのが不便なのでこれをしなくてもコンパイルできるようにというのが今回実現したいことです。

GitHubでも確認いただけますが参考までにマクロのコードを掲載します。

perform_wasm/src/lib.rs

 #[macro_export]
 macro_rules! build_perform {
     ($space:ident, $key:ty, $value:ty) => {
         mod $space {
             pub mod perform {
                 use once_cell::sync::OnceCell;
                 use std::collections::HashMap;
                 use std::future::Future;
                 use std::hash::Hash;
                 use tokio::sync::Mutex;
                 use wasm_bindgen_futures::spawn_local;
                 static STORE: OnceCell<Mutex<HashMap<$key, $value>>> = OnceCell::new();

                 fn global_data() -> &'static Mutex<HashMap<$key, $value>>
                 where
                     $key: Hash,
                     $value: Default,
                 {
                     STORE.get_or_init(|| {
                         let hash_map = HashMap::new();
                         Mutex::new(hash_map)
                     })
                 }

                 async fn lock_and_do_mut<F>(f: F) -> Option<$value>
                 where
                     F: FnOnce(&mut HashMap<$key, $value>) -> Option<$value>,
                     $key: Hash,
                 {
                     let mut hash_map = global_data().lock().await;
                     f(&mut *hash_map)
                 }

                 async fn lock_and_do<F>(f: F) -> Option<$value>
                 where
                     F: Fn(&HashMap<$key, $value>) -> Option<$value>,
                 {
                     let hash_map = global_data().lock().await;
                     f(&*hash_map)
                 }
                 #[allow(dead_code)]
                 fn try_lock_and_do<F>(f: F) -> Option<$value>
                 where
                     F: Fn(&HashMap<$key, $value>) -> Option<$value>,
                 {
                     let hash_map = global_data().try_lock().ok()?;
                     f(&*hash_map)
                 }

                 fn get_and_clone(key: $key, hash_map: &HashMap<$key, $value>) -> Option<$value>
                 where
                     $value: Clone,
                 {
                     hash_map.get(&key).map(|v| v.clone())
                 }

                 pub async fn set_async<Fut>(key: $key, f: Fut)
                 where
                     Fut: Future<Output = $value> + 'static,
                 {
                     let value = f.await;
                     lock_and_do_mut(|hash_map| hash_map.insert(key, value)).await;
                 }
                 #[allow(dead_code)]
=                pub fn set_begin<Fut>(key: $key, f: Fut)
                 where
                     Fut: Future<Output = $value> + 'static,
                 {
                     spawn_local(async move {
                         let value = f.await;
                         lock_and_do_mut(|hash_map| hash_map.insert(key, value)).await;
                     });
                 }
                 pub async fn fetch_async(key: $key) -> Option<$value> {
                     lock_and_do(|hash_map| get_and_clone(key, hash_map)).await
                 }
                 #[allow(dead_code)]
                 pub fn try_fetch(key: $key) -> Option<$value> {
                     let value = try_lock_and_do(|hash_map| get_and_clone(key, hash_map))?;
                     Some(value)
                 }
             }
         }
     };
 }

発生している問題・エラーメッセージ

perform_wasmを利用する側の別の新たなプロジェクトにもCargo.tomlの依存関係に前述でリストした3つの依存クレートを含めなければコンパイルが通りません。

error[E0433]: failed to resolve: use of undeclared crate or module `once_cell`
  --> src/main.rs:11:5
   |
11 |     perform_wasm::build_perform!(namespace, i32, String);
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ use of undeclared crate or module `once_cell`
   |
   = note: this error originates in the macro `perform_wasm::build_perform` (in Nightly builds, run with -Z macro-backtrace for more info)

error[E0433]: failed to resolve: use of undeclared crate or module `tokio`
  --> src/main.rs:11:5
   |
11 |     perform_wasm::build_perform!(namespace, i32, String);
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ use of undeclared crate or module `tokio`
   |
   = note: this error originates in the macro `perform_wasm::build_perform` (in Nightly builds, run with -Z macro-backtrace for more info)

error[E0432]: unresolved import `wasm_bindgen_futures`
  --> src/main.rs:11:5
   |
11 |     perform_wasm::build_perform!(namespace, i32, String);
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ use of undeclared crate or module `wasm_bindgen_futures`
   |
   = note: this error originates in the macro `perform_wasm::build_perform` (in Nightly builds, run with -Z macro-backtrace for more info)

Some errors have detailed explanations: E0432, E0433.
For more information about an error, try `rustc --explain E0432`.
error: could not compile `reexport` due to 3 previous errors
Serving HTTP on :: port 8080 (http://[::]:8080/) ...

逆に、含めればコンパイルは通ります。

該当のソースコード

reexport/Cargo.toml

[package]
name = "reexport"
version = "0.1.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
console_error_panic_hook = "0.1.7"
log = "0.4.17"
reqwest = "0.11.13"
wasm-logger = "0.2.0"

perform_wasm = { git = "https://github.com/kano1101/perform-wasm.git", branch = "main" }
# 以下のコメントアウトを外すとちゃんと動作する！
# once_cell = "1.16.0"
# tokio = { version = "1.23.0", default-features = false, features = ["sync"] }
# wasm-bindgen-futures = "0.4.33"

reexport/src/main.rs

fn main() {
    console_error_panic_hook::set_once();
    wasm_logger::init(wasm_logger::Config::default());

    log::trace!("some trace log");
    log::debug!("some debug log");
    log::info!("some info log");
    log::warn!("some warn log");
    log::error!("some error log");

    perform_wasm::build_perform!(namespace, i32, String);
}

試したこと

reexport/run.sh

(
    cd `dirname $0`
    cargo build --target wasm32-unknown-unknown
    wasm-bindgen ./target/wasm32-unknown-unknown/debug/$(basename `pwd`).wasm --out-dir . --web
    python -m http.server 8080
)

実行したコマンド

% pwd
/Users/a.kano/development/temp/reexport
% ./run.sh

補足情報（FW/ツールのバージョンなど）

% zsh --version
zsh 5.8.1 (x86_64-apple-darwin22.0)
% python --version
Python 3.11.0
% wasm-pack --version
wasm-pack 0.10.3
% wasm-bindgen --version
wasm-bindgen 0.2.83
% cargo --version
cargo 1.65.0 (4bc8f24d3 2022-10-20)

論点を戻すと、毎回依存クレートをdependenciesに記述すれば動作はしますので、それで解決ということにもしても良いところかもしれませんが、プロジェクトを作るたびに余分なクレートを依存関係に含めなければならないとなると、せっかく良い機能をクレートとしてブラックボックス化しているのに意味がないと思います。

perform_wasmに修正を入れなければならないのか、reexportの修正で済むのか、どう修正すると解決できるのかがわかりません。

この現象の解決方法をご存知の方、もしいらっしゃいましたらご教示願えますと幸いです。

よろしくお願いします。

Answer 1

再エクスポートの形式を取ればよいようです。 とりあえず差分の形で提示します。

diff --git a/src/lib.rs b/src/lib.rs
index 7709dfa..1f37adf 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,24 +1,26 @@
+pub use once_cell::sync::OnceCell;
+pub use tokio::sync::Mutex;
+pub use wasm_bindgen_futures::spawn_local;
+
 #[macro_export]
 macro_rules! build_perform {
     ($space:ident, $key:ty, $value:ty) => {
         mod $space {
             pub mod perform {
-                use once_cell::sync::OnceCell;
                 use std::collections::HashMap;
                 use std::future::Future;
                 use std::hash::Hash;
-                use tokio::sync::Mutex;
-                use wasm_bindgen_futures::spawn_local;
-                static STORE: OnceCell<Mutex<HashMap<$key, $value>>> = OnceCell::new();
 
-                fn global_data() -> &'static Mutex<HashMap<$key, $value>>
+                static STORE: $crate::OnceCell<$crate::Mutex<HashMap<$key, $value>>> = $crate::OnceCell::new();
+
+                fn global_data() -> &'static $crate::Mutex<HashMap<$key, $value>>
                 where
                     $key: Hash,
                     $value: Default,
                 {
                     STORE.get_or_init(|| {
                         let hash_map = HashMap::new();
-                        Mutex::new(hash_map)
+                        $crate::Mutex::new(hash_map)
                     })
                 }
 
@@ -66,7 +68,7 @@ macro_rules! build_perform {
                 where
                     Fut: Future<Output = $value> + 'static,
                 {
-                    spawn_local(async move {
+                    $crate::spawn_local(async move {
                         let value = f.await;
                         lock_and_do_mut(|hash_map| hash_map.insert(key, value)).await;
                     });

こうすることで OnceCell などは形式的には perform_wasm に属する名前になるので依存先として perform_wasm を書いておけば (perform_wasm を経由する形で) 必要な名前解決は行われます。

Comments

[akira_kano1101]

SaitoAtsushi様

ご回答ありがとうございます。

なるほど、`$crate`で、思う形が作れるんですね！

これで開発が進みます。非常に助かりました。

また機会がありましたら、よろしくお願いします。