Mengeluarkan Pustaka untuk Pelaksanaan Segerak Proses Tak Segerak dalam JS/TS

Saya telah mengeluarkan pustaka yang dipanggil sync-actions yang membenarkan proses tak segerak dilaksanakan secara serentak dalam JavaScript/TypeScript. Terutamanya dalam TypeScript, anda boleh memanggil fungsi yang ditentukan dengan cara yang selamat jenis. Ia bertujuan untuk digunakan dalam kes di mana anda ingin melaksanakan proses tak segerak dalam fungsi yang anda tidak mahu (atau tidak boleh) tandakan sebagai tak segerak.

Ciri-ciri

• Menggunakan Node.js worker_threads
  • Proses tak segerak dilaksanakan dalam sub-benang dan utas utama menunggu secara serentak untuk penyiapannya.
• Panggilan fungsi selamat jenis
  • Dalam TypeScript, anda boleh menggunakan maklumat jenis fungsi yang ditentukan.
• Diterbitkan sebagai ESM Asli
  • Ia dipermudahkan dengan tidak menyokong CommonJS.

Repositori

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

Penggunaan

Pemasangan

Ia diterbitkan sebagai pakej npm, jadi sila pasangkannya menggunakan pemasangan npm atau serupa.

npm install sync-actions

Penggunaan Asas

Dengan menghantar fungsi tak segerak yang mengembalikan objek Promise kepada defineSyncWorker(), anda boleh mentakrifkan antara muka dan memulakan utas pekerja dengan launch(). Diandaikan bahawa fail yang mentakrifkan pekerja dibuat secara berasingan daripada fail pemprosesan lain.

// 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();

Panggilan Fungsi selamat jenis

Dalam TypeScript, anda boleh memanggil fungsi yang ditakrifkan dengan defineSyncWorker dengan cara yang selamat jenis.

// 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();

Latar belakang

Kandungan setakat ini adalah sama dengan README, jadi saya akan menerangkan latar belakang penciptaannya.

Saya sedang membangunkan ORM yang dipanggil Accel Record.¹ Tidak seperti ORM umum, Accel Record direka untuk melaksanakan akses DB dengan antara muka segerak.² Bahagian yang melaksanakan akses DB secara serentak telah direalisasikan dengan melaksanakan proses tak segerak dalam subproses yang dimulakan dengan child_process modul.³ Saya fikir dengan menggunakan worker_threads dan bukannya child_process, saya boleh mengurangkan overhed semasa runtime.

Accel Record juga direka bentuk agar serupa dengan Rekod Aktif Ruby on Rails dari segi kebolehgunaan, dan salah satu perkara yang saya ingin capai pada masa hadapan ialah mencipta perpustakaan seperti CarrierWave. CarrierWave membolehkan anda menyimpan imej ke perkhidmatan storan luaran (seperti AWS S3) semasa menyimpan rekod, dan untuk mencapainya dengan Accel Record, adalah perlu untuk melaksanakan proses tak segerak seperti muat naik imej secara serentak. Saya menjangkakan bahawa proses ini boleh dilaksanakan dengan lebih pantas dengan menggunakan worker_threads dan bukannya subproses.

Jadi saya pernah mencari perpustakaan yang melaksanakan proses tak segerak menggunakan worker_threads secara serentak. Saya menjumpai beberapa perpustakaan seperti synckit dan deasync, tetapi tiada satu pun daripada mereka yang berfungsi seperti yang diharapkan pada akhirnya, jadi saya memutuskan untuk mencipta sendiri. Memandangkan saya melakukannya, saya fikir saya akan membuat antara muka yang boleh digunakan dengan cara yang selamat jenis dengan TypeScript.

Lagi Butiran Dalaman

• Sehingga proses tak segerak dalam sub-benang yang dimulakan dengan worker_threads selesai, utas utama disekat menggunakan Atomic.wait().
• MessageChannel digunakan untuk komunikasi antara urutan. Kod sumber synckit sangat membantu untuk bahagian pelaksanaan ini.
• Apabila memulakan Worker dengan worker_threads, fail .ts perlu diubah ke .js. Untuk bahagian itu, saya menggunakan esbuild.
• Apabila memulakan Pekerja, saya ingin menghantar kod sumber yang ditranspil sebagai rentetan kepada Pekerja untuk dilaksanakan, tetapi ia tidak berfungsi dengan betul dalam persekitaran saya. Ini adalah bahagian di mana saya paling bergelut. Pada akhirnya, saya menulis fail di bawah node_modules dan menghantar laluannya kepada Worker. Kaedah ini ternyata paling stabil.

---

1. Pengenalan kepada "Rekod Accel": ORM TypeScript Menggunakan Corak Rekod Aktif ↩

2. Mengapa Kami Mengguna pakai API Segerak untuk TypeScript ORM Baharu ↩

3. Teknik untuk Akses DB Segerak dalam TypeScript ↩

Atas ialah kandungan terperinci Mengeluarkan Pustaka untuk Pelaksanaan Segerak Proses Tak Segerak dalam JS/TS. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!