JavaScript/TypeScript で非同期処理を同期実行できる sync-actions というライブラリを公開しました。特に TypeScript では、定義された関數(shù)をタイプセーフな方法で呼び出すことができます。これは、非同期としてマークしたくない (またはできない) 関數(shù)內(nèi)で非同期プロセスを?qū)g行する場(chǎng)合に使用することを目的としています。

特徴

• Node.jsのworker_threadsを利用します
  • 非同期プロセスはサブスレッドで実行され、メインスレッドはその完了を同期的に待機(jī)します。
• タイプセーフな関數(shù)呼び出し
  • TypeScript では、定義された関數(shù)の型情報(bào)を利用できます。
• ネイティブ ESM として公開
  • CommonJS をサポートしないことでシンプルになっています。

リポジトリ

https://github.com/koyopro/sync-actions

使用法

インストール

npmパッケージとして公開されていますので、npm install等でインストールしてください。

npm install sync-actions

基本的な使い方

Promise オブジェクトを返す非同期関數(shù)をdefineSyncWorker()に渡すことで、インターフェイスを定義し、launch()でワーカースレッドを開始できます。ワーカーを定義するファイルは他の処理ファイルとは別に作成されるものとします。

// worker.js
import { defineSyncWorker } from "sync-actions";

export const { actions, worker } = defineSyncWorker(import.meta.filename, {
  ping: async () => {
    // Execute asynchronous process,
    await new Promise((resolve) => setTimeout(resolve, 1000));
    // Return the result as a return value
    return "pong";
  }
}).launch();

// main.js
import { actions, worker } from "./worker.js";

// You can execute asynchronous functions synchronously
console.log(actions.ping()); // => "pong" is output after 1 second

worker.terminate();

タイプセーフな関數(shù)呼び出し

TypeScript では、defineSyncWorker で定義された関數(shù)をタイプセーフな方法で呼び出すことができます。

// worker.ts
import { defineSyncWorker } from "sync-actions";

export const { actions, worker } = defineSyncWorker(import.meta.filename, {
  // By specifying the types of arguments and return values, type-safe calls are possible
  add: async (a: number, b: number): Promise<number> => {
    return a + b;
  }
}).launch();

// main.ts
import { actions, worker } from "./worker.js";

// Type-safe call
actions.add(1, 2); // => 3 (number)

// @ts-expect-error
actions.add("1", 2);
// => Argument of type 'string' is not assignable to parameter of type 'number'

worker.terminate();

背景

ここまでの內(nèi)容はREADMEと同じなので、作成の背景を記載します。

Accel Record という ORM を開発しています。¹ Accel Record は一般的な ORM とは異なり、同期インターフェースで DB アクセスを行うように設(shè)計(jì)されています。² DB アクセスを同期的に実行する部分child_processで開始されるサブプロセス內(nèi)で非同期処理を?qū)g行することで実現(xiàn)しました。 module.³ child_process の代わりに worker_threads を使用することで、実行時(shí)のオーバーヘッドを削減できると考えました。

Accel Record も、使い勝手の點(diǎn)では Ruby on Rails の Active Record に似ているように設(shè)計(jì)されており、將來(lái)的には CarrierWave のようなライブラリを作成したいと考えています。 CarrierWaveではレコード保存時(shí)に畫像を外部ストレージサービス（AWS S3など）に保存できますが、Accel Recordでこれを?qū)g現(xiàn)するには畫像アップロードなどの非同期処理を同期的に実行する必要があります。このプロセスはサブプロセスの代わりにworker_threadsを使用することでより高速に実行できると期待しています。

そこで、worker_threadsを使って非同期処理を同期実行するライブラリを探したことがあります。 synckit や deasync などのライブラリをいくつか見つけましたが、どれも私の側(cè)では期待どおりに機(jī)能しなかったため、獨(dú)自のライブラリを作成することにしました。せっかくなのでTypeScriptでタイプセーフに使えるインターフェースを作ろうと思いました。

內(nèi)部詳細(xì)の詳細(xì)

• worker_threadsで起動(dòng)したサブスレッドの非同期処理が完了するまで、メインスレッドはAtomic.wait()でブロックされます。
• MessageChannel はスレッド間の通信に使用されます。 synckit のソース コードは、実裝のこの部分で非常に役立ちました。
• worker_threads でワーカーを起動(dòng)する場(chǎng)合、.ts ファイルを .js にトランスパイルする必要があります。その部分にはesbuildを使用しています。
• Worker を起動(dòng)するときに、トランスパイルされたソース コードを文字列として Worker に渡して実行したいと考えましたが、私の環(huán)境では正しく動(dòng)作しませんでした。ここが一番苦労した部分です。最終的に、node_modules の下にファイルを書き込み、そのパスをワーカーに渡しました。この方法が最も安定していることが判明しました。

1. 「Accel Record」の紹介: Active Record パターンを使用した TypeScript ORM ?

2. 新しい TypeScript ORM に同期 API を採(cǎi)用した理由 ?

3. TypeScript での同期 DB アクセスのテクニック ?

以上がJS/TSで非同期処理を同期実行するライブラリをリリースの詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國(guó)語(yǔ) Web サイトの他の関連記事を參照してください。